Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2017/final T1701

2017-05-04T23:16:09Z

Kmishra: /* Running Tests */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || [https://docs.pytest.org/en/latest/ '''pytest'''] and [https://pypi.python.org/pypi/requests-mock '''requests-mock''']
This requests-mock module stubs out HTTP request part of the testing code.
|-
| '''Services Module''' || [[File:Services unit.png]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request is hijacked by the requests-mock stubs.
# Response returned and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request is hijacked by the requests-mock stubs.
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Test Type''' || '''Integration Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to Third-party API server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the unit and integration tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set environment variable
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-05-04T23:13:18Z

Kmishra: /* Test Plan */ adding images for services and extra module unit tests.

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || [https://docs.pytest.org/en/latest/ '''pytest'''] and [https://pypi.python.org/pypi/requests-mock '''requests-mock''']
This requests-mock module stubs out HTTP request part of the testing code.
|-
| '''Services Module''' || [[File:Services unit.png]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request is hijacked by the requests-mock stubs.
# Response returned and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request is hijacked by the requests-mock stubs.
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Test Type''' || '''Integration Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to Third-party API server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the unit test and integration tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set environment variable
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

File:Extra unit.png

2017-05-04T23:12:05Z

Kmishra:

File:Services unit.png

2017-05-04T23:11:28Z

Kmishra:

CSC/ECE 517 Spring 2017/final T1701

2017-05-04T22:54:56Z

Kmishra: /* Test Plan */ updating testing tool explanation.

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || [https://docs.pytest.org/en/latest/ '''pytest'''] and [https://pypi.python.org/pypi/requests-mock '''requests-mock''']
This requests-mock module stubs out HTTP request part of the testing code.
|-
| '''Services Module''' ||
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request is hijacked by the requests-mock stubs.
# Response returned and message asserted with the correct expected value
|-
| '''Extra Module''' ||
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request is hijacked by the requests-mock stubs.
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Test Type''' || '''Integration Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to Third-party API server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the unit test and integration tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set environment variable
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

File:Extra unit tests.png

2017-05-04T22:50:47Z

Kmishra: uploaded a new version of "File:Extra unit tests.png"

CSC/ECE 517 Spring 2017/final T1701

2017-05-04T22:50:00Z

Kmishra: /* Test Plan */ updating unit test and adding integration tests.

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || The [https://pypi.python.org/pypi/requests-mock requests-mock] module was used to unit test services module classes.
This modules stubs out HTTP request port of the testing code.
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request is hijacked by the requests-mock stubs.
# Response returned and message asserted with the correct expected value
|-
| '''Extra Module''' || The [https://pypi.python.org/pypi/requests-mock requests-mock] module was used to unit test extra module classes.
This modules stubs out HTTP request port of the testing code.
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request is hijacked by the requests-mock stubs.
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Test Type''' || '''Integration Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to Third-party API server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the unit test and integration tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set environment variable
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-05-04T21:54:30Z

Kmishra: /* Running Tests */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the unit test and integration tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set environment variable
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-05-04T21:53:52Z

Kmishra: /* Running Tests */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set environment variable
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-05-01T17:27:31Z

Kmishra: /* Test Plan */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_uml_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

====mqtt====
The mqtt class should provide a simple way to publish some data to the Tago broker.

'''Method'''
* publish
** This method is used by the client to publish to the Tago broker. Check out [http://mqtt.org/ MQTT] and [http://sdk.js.tago.io/en/latest/analysis.html#mqtt MQTT in Tago] for more information on how it works.
** '''Arguments'''
***message
***[http://docs.tago.io/en/latest/concepts.html#bucket bucket]

====socket====
The socket class should provide support to send some data to a bucket via an HTTP POST call.

'''Method'''
* send
** This method is used to send some JSON data to the bucket.
** '''Arguments'''
***bucket_id
***data_entry

====console====
The console class should provide support to send some logged data to the Tago server.

'''Method'''
* send
** This method is used to send some message with a time-stamp to the server.
** '''Arguments'''
***message
***timestamp

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

=== Running Tests ===
In order to run the tests on your system, follow these steps:
* Clone the repo:
** git clone https://github.com/aapatel8/tago-sdk-python.git
* Then set two environment variables
** export TAGO_TOKEN_DEVICE=6ea148d0-e75c-11e6-a091-5756b91044c4
* From the top folder run
** python setup.py test

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-16T03:05:17Z

Kmishra: /* Design */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represents a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_class_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-15T08:02:54Z

Kmishra: /* Services */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represent a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_class_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous to API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-15T08:02:40Z

Kmishra: /* Services */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represent a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_class_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token (token is analogous API key) needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-15T08:00:48Z

Kmishra: /* Third Party APIs (Extra) */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represent a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_class_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token(API Key) that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-15T07:57:15Z

Kmishra: /* Design */ adding content in design.

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app. The main goal of the project is to port the current SDK written in NodeJS to one that supports Python.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
The SDK is broken into several modules, each of which represent a class. The class diagram shown below represents each of these classes and their methods. This project deals with the '''services''' and the '''extra''' modules.

The SDK provides '''services''' module to enhance support for the application. These services can be triggered when the customer application wants to send an alert or update the customer about the status of the IoT system.

The '''extra''' module provides some 3rd party functionalities which the customer can use in their application. Like the geolocation feature can be used along with GPS sensor to pin point a location on the map.

[[File:Tago_class_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Description''' ||
Each of the classes and function in the Services module will be tested in the following manner (eg. function testing SMS.send):
# Object created with appropriate token parameter (eg. SMS s = new SMS("123456"))
# Function called with appropriate parameters (eg. s.send("+9195550100", "Temperature over 100 degrees Celsius"))
# Request sent to tago server
# Response returned (as SMS) and message asserted with the correct expected value
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
Each of the classes and function in the Extra module will be tested in the following manner (eg. function testing Weather.forecast):
# Object created with appropriate API key (eg. Weather w = new Weather("123abc"))
# Function called with appropriate parameters (eg. w.forecast("27516"))
# Request sent to tago server
# Response returned (Promise - success) and asserted with the correct expected value(s)
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

File:Extra unit tests.png

2017-04-13T03:41:37Z

Kmishra: uploaded a new version of "File:Extra unit tests.png": Reverted to version as of 03:40, 13 April 2017

File:Extra unit tests.png

2017-04-13T03:41:25Z

Kmishra: uploaded a new version of "File:Extra unit tests.png"

File:Extra unit tests.png

2017-04-13T03:40:55Z

Kmishra: uploaded a new version of "File:Extra unit tests.png"

File:Unit test service.jpg

2017-04-13T03:39:54Z

Kmishra: uploaded a new version of "File:Unit test service.jpg": Reverted to version as of 03:38, 13 April 2017

File:Unit test service.jpg

2017-04-13T03:39:14Z

Kmishra: uploaded a new version of "File:Unit test service.jpg"

File:Unit test service.jpg

2017-04-13T03:38:37Z

Kmishra: uploaded a new version of "File:Unit test service.jpg"

File:Unit test service.jpg

2017-04-13T03:37:42Z

Kmishra: uploaded a new version of "File:Unit test service.jpg"

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T03:32:46Z

Kmishra: /* Implementation */

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014,[https://tago.io/ Tago] is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago has a [https://github.com/tago-io/tago-sdk-js node.js-SDK], but they have begun work on a [https://github.com/tago-io/tago-sdk-python Python SDK]. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality. It is worth noting that we are building a Python interface for interacting with Tago’s RESTful API, not a web-based UI or a web-app.

[[File:PythonAPI usage diagram.png|center]]
<div align="center">'''Tago Client - SDK - Server Workflow'''</div>

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.
[[File:Tago dashboard.png|center]]
<div align="center">'''Tago Dashboard'''</div>


==Design==
[[File:Tago_class_diagram.png|center|alt=Class diagram|Class diagram for tago-python SDK]]
<div align="center">'''Tago-SDK Class Diagram'''</div>

==Implementation==
As can be seen in the design, there are plenty of modules in tago-sdk. The '''services''' and '''extra''' API modules are being implemented in Python (currently implemented using NodeJS) as a part of this project. These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

In the following, a '''Promise''' is simply an object used for asynchronous computations, which represents the resulting status of the operation (success or failure), with each scenario having an appropriate callback function.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** '''Arguments'''
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** '''Arguments'''
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** '''Arguments'''
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** '''Arguments'''
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** '''Arguments'''
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** '''Arguments'''
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** '''Arguments'''
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** '''Arguments'''
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Unit Test'''
|-
| '''Testing Tool''' || '''pytest'''
|-
| '''Services Module''' || [[File:Unit test service.jpg]]
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Service Module''' || The manual testing will be done by providing example scripts.
For sms method, the tester can add his/her number and run the script and test whether sms is being sent or not.

Similarly, for the email method the tester can add his/her email address and test whether email is sent or not after running the script.
|-
| '''Extra Module''' || Example scripts will be provided which will use the third party API calls using the SDK and print the response on console.
|}

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:28:14Z

Kmishra: /* Design */

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:27:59Z

Kmishra: /* Design */ adding caption

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:27:17Z

Kmishra: /* What are we doing? */ adding caption to diagram

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:25:59Z

Kmishra: /* Why are we doing it? */ adding tago dashboard

File:Tago dashboard.png

2017-04-13T00:22:57Z

Kmishra: uploaded a new version of "File:Tago dashboard.png"

File:Tago dashboard.png

2017-04-13T00:22:05Z

Kmishra: uploaded a new version of "File:Tago dashboard.png"

File:Tago dashboard.png

2017-04-13T00:21:17Z

Kmishra: uploaded a new version of "File:Tago dashboard.png"

File:Tago dashboard.png

2017-04-13T00:20:07Z

Kmishra:

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:11:59Z

Kmishra: /* Implementation */ argument in bold

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:10:56Z

Kmishra: /* Implementation */

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:10:26Z

Kmishra: /* Implementation */ Adding extra info in implementation

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T00:06:26Z

Kmishra: /* Test Plan */ adding the test plan.

File:Extra unit tests.png

2017-04-13T00:00:35Z

Kmishra:

File:Unit test service.jpg

2017-04-12T23:52:41Z

Kmishra:

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T21:56:00Z

Kmishra: /* What are we doing? */ adding diagram

File:PythonAPI usage diagram.png

2017-04-12T21:51:39Z

Kmishra:

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T21:26:00Z

Kmishra: /* What are we doing? */

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T21:18:51Z

Kmishra: adding class diagram

File:Tago class diagram.png

2017-04-12T21:18:05Z

Kmishra: uploaded a new version of "File:Tago class diagram.png"

File:Tago class diagram.png

2017-04-12T21:07:58Z

Kmishra:

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T20:32:57Z

Kmishra: /* What are we doing? */ updating python-sdk link

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T20:31:42Z

Kmishra: /* What are we doing? */

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T20:30:50Z

Kmishra: /* What are we doing? */ updating js-sdk link

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T20:29:43Z

Kmishra: /* What is Tago? */ update tago link

CSC/ECE 517 Spring 2017/final T1701

2017-04-12T01:46:02Z

Kmishra: adding requirements

[https://goo.gl/fw2fK4 '''Requirements''']

==Introduction==
===What is Tago?===
Founded in 2014, Tago is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago’s SDK is only developed for NodeJS, but they have begun work on a Python SDK. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality.

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.



==Implementation==
The following are API modules that will be implemented in Python (currently implemented using NodeJS). These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** Arguments
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** Arguments
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** Arguments
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** Arguments
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** Arguments
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** Arguments
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** Arguments
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==
In progress

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T04:03:50Z

Kmishra: /* References */

==Introduction==
===What is Tago?===
Founded in 2014, Tago is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago’s SDK is only developed for NodeJS, but they have begun work on a Python SDK. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality.

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.



==Implementation==
The following are API modules that will be implemented in Python (currently implemented using NodeJS). These modules will interact with Tago servers and third-party vendors to serve HTTP requests to clients.

=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.

'''Method'''
* send
** This method is used to send SMS.
** Arguments
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.

'''Method'''
* send
** This method is used to send email.
** Arguments
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** Arguments
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** Arguments
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** Arguments
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** Arguments
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** Arguments
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

==Test Plan==
In progress

==References==
* [https://tago.io/ Official Tago Website]
* [http://docs.tago.io/en/latest/ Tago official document]
* [https://github.com/tago-io/tago-sdk-js Tago JS SDK]
* [https://github.com/tago-io/tago-sdk-python Tago Python SDK]
* [http://community.tago.io/ Tago Community]

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T03:22:29Z

Kmishra: removing methods from toc

==Introduction==
===What is Tago?===
Founded in 2014, Tago is startup based out of Centennial Campus. They have created a service that allows users to craft dashboards that are used by Internet of Things (IoT) devices for a variety of purposes. These include storing/visualizing data, running triggers that send emails, SMS messages, or data to other devices/http endpoints, and initiating custom analysis scripts to manipulate and analyze data. Along with the dashboard, Tago has developed an SDK that developers can utilize when programming on the IoT devices in order to make these various requests.

===What are we doing?===
Currently, Tago’s SDK is only developed for NodeJS, but they have begun work on a Python SDK. We have decided to assist in order to speed up the the development and delivery of their Python SDK. We have broken down the project into two teams, T1701 and T1702, and split the work by assigning different subsets of functionality.

===Why are we doing it?===
Tago currently has customers with needs for a Python SDK including Texas Instruments and Tesla. The sooner the SDK is developed, the sooner these companies can utilize them. Python has a number of advantages over NodeJS, particularly around the communities. The Python community has implemented a vast number of scientific and other niche libraries that could be useful in IoT sensors and measurement equipment.





==Implementation==
=== Services ===
As a part of services, Tago should provide some functions that can greatly help your application. When setting up a service, an analysis-token needs to be passed. For convenience, the context returns a property token that you can use to setup a service object.

====sms====
The sms class should provide support to send a sms directly to tago admins or customers from analysis. SMS costs incurred depend on the country of operation.
'''Method'''
* send
** This method is used to send SMS.
** Arguments
*** Phone number. (With the country code if not in the US)
*** Message to be sent

====email====
The email class should provide support to send a email with analysis details or any other info.
'''Method'''
* send
** This method is used to send email.
** Arguments
***Email address
***Subject of the email
***Message to be sent
***E-mail address for the receiver to reply to

===Third Party APIs (Extra) ===
Tago supports third-party API’s, like Google Maps and Weather service. All third-party services are free to use, with a free token that can obtained from the third party website.

====geocoding====
This class is used to get a geolocation (latitude/longitude) for a valid address, or vice versa. To make use of this functionality, a google geocoding API key needs to be provided while creating a new object.
[https://developers.google.com/maps/documentation/geocoding/start Geocoding API provider] documentation.

'''Methods'''
*getGeolocation
** Convert the address to a valid geolocation, if it exists
** Arguments
*** address(string) A valid address
** Returns
*** (Promise)

*getAddress
** Convert a valid geolocation to an address, if it exists.
** Arguments
*** geolocation(string) A valid geolocation
** Returns
*** (Promise)

====currency====
This class checks several currencies in real-time, and the historical exchange rates for over 168 countries.
[https://currencylayer.com/ Currency API provider]

'''Methods'''
*convert
**Returns the current exchange rate of one currency to another one
** Arguments
*** from(string) convert from. See [https://currencylayer.com/currencies supported currencies] for more information
** Returns
*** (Promise)

====distance====
This class helps to calculate the distance between two points. [https://developers.google.com/maps/documentation/distance-matrix/intro Google Distance API]

'''Methods'''
* measure
** Measure is a service that provides the travel distance and time for a matrix of origins and destinations.
** Arguments
*** origins(array) An array of origins, can be string location or [http://geojson.org/ geojson].
*** destinations(array) An array of destinations, can be string location or [http://geojson.org/ geojson].
*** language(string) Set a language. Default is ‘EN’. See [https://developers.google.com/maps/faq#languagesupport language support] for more information. (optional)
*** mode(string) For the calculation of distances, you may specify the transportation mode to use. By default, distances are calculated for driving mode. See the [https://developers.google.com/maps/documentation/distance-matrix/intro#travel_modes travel modes] supported for more information
** Returns
*** (Promise)

====weather====
Whenever you need to get weather conditions around the world, use weather service APIs. This class defines helper methods to achieve this and talk to tago server. [https://www.wunderground.com/weather/api/ Wunderground API]

'''Methods'''
*current
** Get the current weather conditions.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*forecast
** Returns a summary of the weather forecast for the next 10 days. This includes high and low temperatures, a string text forecast and other conditions.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get the response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See `language support [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional)
** Returns
*** (Promise)

*history
** Returns a summary of the weather conditions for the last 10 days. This includes high and low temperatures, a string text and other weather conditions.
** Arguments
*** date(string) a past date.
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set the language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)

*alert
**Returns the short name description, expiration time and a long text description of a severe alert, if one has been issued for the searched location.
** Arguments
*** query(string) It can be address, zipcode or geojson.
*** full(boolean) Set to get response with full description. Default is false. (optional)
*** language(string) Set a language. Default is ‘EN’. See [https://www.wunderground.com/weather/api/d/docs?d=language-support language support] for more information. (optional).
** Returns
*** (Promise)