IstSOS Web API

From OSGeo
Jump to navigation Jump to search

Currently in progress...

Introduction

istSOS[1][2] is an OGC SOS server implementation written in Python. istSOS allows managing and dispatch observations from monitoring sensors according to the Sensor Observation Service standard.

istSOS Web API is one of the accepted project ideas for Google Summer of Code 2016.

Building of istSOS Web API is focused on two parts:

  • development of the JavaScript core library, that will expose in JavaScript language, communication with the istSOS REST API interface.
  • building the easy-to-use Web framework, which will use JavaScript core library to enable creation of feature-rich Web widget, that will be easily embeddable into existing Web sites.

Development process can be checked at the following links:

Student working on istSOS Web API: Luka Glušica
Mentors: Milan Antonovic, Massimiliano Cannata


[1] https://wiki.osgeo.org/wiki/IstSOS
[2] http://istsos.org

Implementation details

istSOS JavaScript Core

istSOS core Javascript class structure

istSOS JavaScript core library exposes communication with the istSOS Rest API interface. Idea was to identify all rest API HTTP requests and implement them as methods of newly implemented classes. Most important request for developers and users is getObservations request, because it returns actual measurements collected by the sensors and istSOS Javascript core library is focused on several ways to get observation data from the server. Class structure describes the conceptual logic of the istSOS core library and it's based on couple of "container" classes. Every class has a defined namespace "istsos" before it's actual name (example: istsos.Server) and library starts with IstSOS class as a container of Server instances.

  • IstSOS class - contain list of Server instances
  • Server class - contain list of Service instances
  • Service class - contain Procedure instance, VirtualProcedure instance, Offering instance, ObservedProperty instance, DataQuality instance and UnitOfMeasure instance lists.


There are classes like Database and Configuration, that are related to Server class as default and to Service class as service specific.
Rest of the classes:

  • Date clas - used for converting time and date integer inputs to valid istSOS format.
  • ProcedureBase class - class from which Procedure and VirtualProcedure classes inherit properties and methods.
  • Output class - used to simplify use of Procedure and VirtualProcedure instances. Holds ObservedProperty and UnitOfMeasure instances.


Other than mentioned, istSOS JavaScript core has a special way of event handling with lots of custom event types like (PROCEDURE, NEW_PROCEDURE, SERVICES, DELETE_SERVICE etc). It has 2 global methods for interacting with tha data that came asynchronously from the server:

  • istsos.on()
  • istsos.once()

Both methods, take event type as a parameter and the data is to be manipulated through callback function. Here is the getObservations usage example, which also explains event handling in istSOS JavaScript core library.

istSOS Online Web Widget Creator

Schedule

Development of istSOS Web API consists of two parts:

  • JavaScript Core Library
  • Web App for creating Web Widgets, based on previosly developed core library

Working schedule presented below, is arranged in consultance with the mentors and other students working on the istSOS projects. The planning isn't strict for "in-between" deadlines, because of varying nature of our projects, but it is strict for two major parts, mentioned above (June 20 and August 22).

Timeline planning for istSOS JavaScript Core

Task From To
Requirements analysis May 23 May 30
Coding May 30 June 13
Testing, bug fix, release June 13 June 20

Timeline planning for istSOS Online Web Widget Creator

Task From To
Design and Requirements analysis June 20 June 27
Coding June 27 July 18
Coding(VistSOS Web Component Integration) July 18 August 8
Coding, Testing, Bug Fixing, Documentation August 8 August 22

Reports

Week 1

What did you get done this week?

This week, I’ve been indentifying all the admin HTTP requests to the server, that are targeting the istSOS RESTful API. By identifying, I mean writting down:

  • URL
  • type of request (GET, POST, PUT, DELETE)
  • response data
  • request payload

Also, I’ve started designing the class structure, for the purpose of developing JavaScript core library. All of the mentioned work, I’m doing in partnership with a GsoC student Florin-Daniel Cioloboc, who’s working on an Java core library for istSOS and our work overlaps in this section.

What do you plan on doing next week?

Next week, I will be finishing the class structure and begin with the actual development/coding of JavaScript core library. I will be also creating some test pages along the way, to check for possible errors.

Are you blocked on anything?

Currently, everything is going according to plan.


Week 2

What did you get done this week?

This week, I've been continuosly working on class structure design for JavaScript core library and also started commiting some code. The was to implement IstSOS, Server and Database classes, but let's say that 90% of it is done.

What do you plan on doing next week?

Next week, I will be completing the class structure and will try to implement more classes like Service, Offering, Procedure.

Are you blocked on anything?

Actually, the reason why 90% of mentioned classes were done, is that I was unable to store JSON response object into an outside variable. For the information, I've been using Google Closure library for executing AJAX requests.


Week 3

What did you get done this week?

This week, I’ve implemented Configuration, Service, Offering, ObservedProperty, DataQuality, UnitOfMeasure and Date classes. Service class is partially implemented, because it depends on other classes that should be implemented soon. Also, I’ve created an html and JavaScript file for testing and I’ve already tested some of the previously implemented classes, but the new ones are about to be tested. Appart from mentioned, I’ve updated OSgeo wiki page with timeline and weekly reports, also you can take a look at README file in my GitHub forked repository, because I’ve started with creating API documentation for the core library I’ve been working on.

What do you plan on doing next week?

Next week, I plan to implement last two classes (Procedure, VirtualProcedure) and to do all the testing, bug fixes and refining the code and documentation. Hopefully, by June 20-th, I will be releasing istSOS JavaScript core library.

Are you blocked on anything?

Currently, everything is fine. I solved the issue with AJAX requests in consultance with my mentors.


Week 4

What did you get done this week?

I have implemented all the classes and did the testing of all the GET requests, which can be checked if you take a lok at istsos-test.html and istsos-test.js ( GitHub forked repository).
I have also updated the GitHub wiki page with the API documentation and the class structure of the library.

What do you plan on doing next week?

I plan to test all requests (POST/PUT/DELETE). Hopefully, this part will go easier and quicker, because I already fixed most of the minor problems during GET request tests.
Also, I will be updating documentation along the way.
We have regular meetengs with our mentors every Tuesday, so If everything goes as planned, I will prepare the first version of a library until then.

Are you blocked on anything?

Currently, everything is going according to plan.


Week 5

What did you get done this week?

It's a midterm evaluation period and I did a lot of testing of the library, there is a test html and test js on my GitHub forked repository. Also, I've been updating the API documentation and Class structure on the GitHub wiki page. Next part of my job is to develop JavaScript Framework based on previously developed library, so I started thinking about how it should be implemented, how should interface look like etc.

What do you plan on doing next week?

I plan to finish the documentation in the next few days, do some more testing of a library and generate a compiled version of a library, so other people can use it easily. Also, I will work on conceptual design of JavaScript Framework, I will be working together with GSoC student Felipe Poveda, because I need to integrate his implementation into my project and he needs to use my library for his own project.

Are you blocked on anything?

Currently, everything is fine.


Week 6

What did you get done this week?

I've been working on a design of the JavaScript Framework. No coding this week, more thinking and drawing on a piece of paper. Also, I started writing into a sreadsheet, every functionallity that should be implemented with description, so I can better organize my self, when the coding starts.

What do you plan on doing next week?

I plan to finish conceptual design and start implementing/coding the features. Of course, updates&fixes of the previously developed library along the way, is inevitable.

Are you blocked on anything?

Currently, everything is fine.


Week 7

What did you get done this week?

I've been designing home page, with some of the tools (without functionality, just visual aspect) . Usage of Bootstrap helped with the page repsonsivness. Code can be checked and tested here.

What do you plan on doing next week?

Next week, I plan to finish with design and implement a lot of tools, like Map creator tools, Admin tools for creating, updating and deleting data etc. I will be thinking and adding some new tools allong the way. Of course, fixing of design errors may be necessary, depending on the feature requirements.

Are you blocked on anything?

Currently, everything is fine.


Week 8

What did you get done this week?

This week, in consultance with my mentors, I've reduced number of tools that I've had planned to implement, because they seem irrelevant. Also, I changed approach a little bit, so I needed to start over with implementation. New plan is to develop small library for creating widgets. So far, I have implemented istsos.widget.Widget base class and partially istsos.widget.Map class. Code can be checked here.

What do you plan on doing next week?

Next week, I plan to improve Widget base class and finish the Map class implementation. Also, I will start with developing Box class and working on a way to integrate this project as a Chart class.

Are you blocked on anything?

Currently, everything is fine.


Week 9

What did you get done this week?

This week, I finished with the implementation of Map creator tool. Of course, further improvements will be made along the way, but the main functionality is covered and tested. I also started with the implementation of a Box creator tool. Also I've been updating and fixing the istsos core library with some changes regarding the getObservations method and compatibility issues with Internet Explorer 11. All variations of getObservations method can now pass multiple procedures as parameter. Code can be checked at following links:

What do you plan on doing next week?

Next week, I plan to improve Map creator tool with some styling settings and to finish the Box creator tool. Also, I will be taking a closer look at VistSOS data visualization framework project and hopefully start integrating it as a Chart creator tool. Also, I'm kinda slow with the documentation updates, so I will be focusing on that also starting tomorrow.

Are you blocked on anything?

Currently, everything is fine.


Who will use results of this project

Student's biography

My name is Luka Glušica and I'm a MSc student at the Faculty of Civil Engineering, Department of Geodesy and Geoinformatics, University of Belgrade, Serbia. Master's degree program, that I'm currently enrolled in, is oriented towards GIS (including programming), Web Cartography and Remote Sensing.

I'm familiar with Windows and Linux (Ubuntu, Linux Mint) operating system environments, including Microsoft Office (Word, Excel, Access) and Libre Office (Writter, Calc, Base) solutions, and I'm using them on daily basis.

During my studies, I've developed the set of skills listed below:

  • Web development - HTML, CSS, JavaScript (Jquery, OpenLayers 3), Bootstrap
  • Object oriented programming - Java, Python
  • CAD solution - Certified Professional in AutoCAD 2014 2D Drafting
  • GIS - QGIS, ArcGIS, Manifold System, Idrisi, SAGA
  • Database systems - PostgreSQL/PostGIS

Some of my practice work:

Retrieved from "http://wiki.osgeo.org/w/index.php?title=IstSOS_Web_API&oldid=101380"