Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2017/final T1701

2017-04-28T02:01:57Z

Aapatel8: /* 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 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.
|}

==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-28T01:18:24Z

Aapatel8: /* 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_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

===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]

File:Tago uml diagram.png

2017-04-28T01:17:58Z

Aapatel8: uploaded a new version of "File:Tago uml diagram.png"

CSC/ECE 517 Spring 2017/final T1701

2017-04-28T01:15:31Z

Aapatel8: /* 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_uml_diagram.png|200px|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-28T01:13:37Z

Aapatel8: /* 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_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

===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]

File:Tago uml diagram.png

2017-04-28T01:12:51Z

Aapatel8:

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T04:21:32Z

Aapatel8: /* What are we doing? */

[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==
[[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]

CSC/ECE 517 Spring 2017/final T1701

2017-04-13T04:07:19Z

Aapatel8: /* 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.

[[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]]
|-
| '''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-13T03:34:59Z

Aapatel8: /* 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.

[[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]]
|-
| '''Description''' ||
|-
| '''Extra Module''' || [[File:Extra unit tests.png]]
|-
| '''Description''' ||
|-
| '''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-13T03:25:57Z

Aapatel8: /* 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-13T03:25:13Z

Aapatel8: /* 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. It 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-08T03:42:27Z

Aapatel8: /* 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://github.com/tago-io/tago-sdk-js
* https://www.npmjs.com/package/tago

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T03:42:10Z

Aapatel8: /* 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://github.com/tago-io/tago-sdk-js

https://www.npmjs.com/package/tago

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T03:41:56Z

Aapatel8:

==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://github.com/tago-io/tago-sdk-js
https://www.npmjs.com/package/tago

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T03:37:30Z

Aapatel8: /* Implementation */

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T03:35:54Z

Aapatel8: /* Implementation */

==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)

CSC/ECE 517 Spring 2017/final T1701

2017-04-08T03:31:14Z

Aapatel8: /* Introduction */

==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)

CSC/ECE 517 Spring 2017/oss E1729

2017-04-01T03:12:22Z

Aapatel8: /* Test Plan */

==Introduction==

This project is an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called [https://github.com/kkushagra/expertiza/tree/exportdetail : ''''exportdetail'''']

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fills out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews are stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So that is why our assignment is to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==
So the reason we implemented our feature a certain way is because there was already previous code for exporting an aggregate csv so we designed our feature in the same fashion. An export controller already existed so we added a new method in that for exporting details and modeled it based on the already existing export method. Assignment.rb already had the methods for setting columns/fields and getting aggregate export info so we added our implementations corresponding methods in that class as well. For the view, we simply added our code, that linked to the new controller method, in the same view where the other csv feature was implemented. No specific design pattern was used, but our feature was simply modeled after previously existing similar features.

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

<code>
def self.export_details(csv, parent_id, detail_options)
return csv unless detail_options.value?('true')

@assignment = Assignment.find(parent_id)
@answers = {} # Contains all answer objects for this assignment
# Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
# Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
# create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
@answers = generate_answer(@answers, @assignment)
# Loop through each round and response type and construct a new row to be pushed in CSV
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
round_type = check_empty_rounds(@answers, round_num, res_type)
unless round_type.nil?
csv << [round_type, '---', '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
csv << csv_row(detail_options, answer)
end
end
end
end
</code>

This method checks nil while populating a csv field headers to only add headers which the user selected from the checkboxes.

def self.handle_nil(csv_field)
return ' ' if csv_field.nil?
csv_field
end

This method generates a CSV row by looping through the answers.

# Generates a single row based on the detail_options selected
def self.csv_row(detail_options, answer)
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
@reviewee = Participant.find_by_id(ans.reviewee_id).user if @reviewee.nil?
reviewer = Participant.find_by_id(ans.reviewer_id).user
tcsv << handle_nil(@reviewee.id) if detail_options['team_id'] == 'true'
tcsv << handle_nil(@reviewee.name) if detail_options['team_name'] == 'true'
tcsv << handle_nil(reviewer.name) if detail_options['reviewer'] == 'true'
tcsv << handle_nil(answer.question.txt) if detail_options['question'] == 'true'
tcsv << handle_nil(answer.question.id) if detail_options['question_id'] == 'true'
tcsv << handle_nil(answer.id) if detail_options['comment_id'] == 'true'
tcsv << handle_nil(answer.comments) if detail_options['comments'] == 'true'
tcsv << handle_nil(answer.answer) if detail_options['score'] == 'true'
tcsv
end

This method generates a hash of answers, which is used to populate the CSV.

# Populate answers will review information
def self.generate_answer(answers, assignment)
# get all response maps for this assignment
@response_maps_for_assignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{assignment.id}"])
# for each map, get the response & answer associated with it
@response_maps_for_assignment.each do |map|
@response_for_this_map = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
# for this response, get the answer associated with it
@response_for_this_map.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
answers[res_map.round][map.type].push(ans)
end
end
end
answers
end

This method checks for number of answers in a particular round/response type and returns nil if there are none since the csv doesn't need to output any header for this round/response type. If this round has some answers then the round number header is generated along with the response type. If the round number is nil, then we simply make the header say 'Round Nill' instead.

# Checks if there are rounds with no reviews
def self.check_empty_rounds(answers, round_num, res_type)
unless answers[round_num][res_type].empty?
round_type =
if round_num.nil?
"Round Nill - " + res_type
else
"Round " + round_num.to_s + " - " + res_type.to_s
end
return round_type
end
nil
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

Flow Chart

When exporting a detailed CSV, an instructor can choose to include all, some, or none of the headers and the assignment may or may not include answers. The chart below details possible scenarios.

[[File:OSSTestChart.PNG]]

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end
'''The expected CSV file is read in as a text file to simplify string comparison with the generated CSV string.'''

The assignment details and all field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and all field headers should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-04-01T03:07:20Z

Aapatel8: /* Test Plan */

==Introduction==

This project is an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called [https://github.com/kkushagra/expertiza/tree/exportdetail : ''''exportdetail'''']

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fills out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews are stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So that is why our assignment is to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==
So the reason we implemented our feature a certain way is because there was already previous code for exporting an aggregate csv so we designed our feature in the same fashion. An export controller already existed so we added a new method in that for exporting details and modeled it based on the already existing export method. Assignment.rb already had the methods for setting columns/fields and getting aggregate export info so we added our implementations corresponding methods in that class as well. For the view, we simply added our code, that linked to the new controller method, in the same view where the other csv feature was implemented. No specific design pattern was used, but our feature was simply modeled after previously existing similar features.

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

<code>
def self.export_details(csv, parent_id, detail_options)
return csv unless detail_options.value?('true')

@assignment = Assignment.find(parent_id)
@answers = {} # Contains all answer objects for this assignment
# Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
# Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
# create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
@answers = generate_answer(@answers, @assignment)
# Loop through each round and response type and construct a new row to be pushed in CSV
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
round_type = check_empty_rounds(@answers, round_num, res_type)
unless round_type.nil?
csv << [round_type, '---', '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
csv << csv_row(detail_options, answer)
end
end
end
end
</code>

This method checks nil while populating a csv field headers to only add headers which the user selected from the checkboxes.

def self.handle_nil(csv_field)
return ' ' if csv_field.nil?
csv_field
end

This method generates a CSV row by looping through the answers.

# Generates a single row based on the detail_options selected
def self.csv_row(detail_options, answer)
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
@reviewee = Participant.find_by_id(ans.reviewee_id).user if @reviewee.nil?
reviewer = Participant.find_by_id(ans.reviewer_id).user
tcsv << handle_nil(@reviewee.id) if detail_options['team_id'] == 'true'
tcsv << handle_nil(@reviewee.name) if detail_options['team_name'] == 'true'
tcsv << handle_nil(reviewer.name) if detail_options['reviewer'] == 'true'
tcsv << handle_nil(answer.question.txt) if detail_options['question'] == 'true'
tcsv << handle_nil(answer.question.id) if detail_options['question_id'] == 'true'
tcsv << handle_nil(answer.id) if detail_options['comment_id'] == 'true'
tcsv << handle_nil(answer.comments) if detail_options['comments'] == 'true'
tcsv << handle_nil(answer.answer) if detail_options['score'] == 'true'
tcsv
end

This method generates a hash of answers, which is used to populate the CSV.

# Populate answers will review information
def self.generate_answer(answers, assignment)
# get all response maps for this assignment
@response_maps_for_assignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{assignment.id}"])
# for each map, get the response & answer associated with it
@response_maps_for_assignment.each do |map|
@response_for_this_map = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
# for this response, get the answer associated with it
@response_for_this_map.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
answers[res_map.round][map.type].push(ans)
end
end
end
answers
end

This method checks for number of answers in a particular round/response type and returns nil if there are none since the csv doesn't need to output any header for this round/response type. If this round has some answers then the round number header is generated along with the response type. If the round number is nil, then we simply make the header say 'Round Nill' instead.

# Checks if there are rounds with no reviews
def self.check_empty_rounds(answers, round_num, res_type)
unless answers[round_num][res_type].empty?
round_type =
if round_num.nil?
"Round Nill - " + res_type
else
"Round " + round_num.to_s + " - " + res_type.to_s
end
return round_type
end
nil
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

Flow Chart

When exporting a detailed CSV, an instructor can choose to include all, some, or none of the headers and the assignment may or may not include answers. The chart below details possible scenarios.

[[File:http://wiki.expertiza.ncsu.edu/index.php/File:OSSTestChart.PNG]]

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end
'''The expected CSV file is read in as a text file to simplify string comparison with the generated CSV string.'''

The assignment details and all field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and all field headers should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

File:OSSTestChart.PNG

2017-04-01T03:06:10Z

Aapatel8: 2017 Spring OSS E1729 Test Flow Chart.

2017 Spring OSS E1729 Test Flow Chart.

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T19:12:48Z

Aapatel8: /* Test Plan */

==Introduction==

This project was an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called ''''exportdetail''''

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fill out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews is stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So it was our assignment to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

def self.export_details(csv, parent_id, detail_options)
@assignment = Assignment.find(parent_id)
@answers = {} # Contails all answer objects for this assignment
#Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
#Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
#create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
#get all response maps for this assignment
@responseMapsForAssignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{@assignment.id}"])
#for each map, get the response & answer associated with it
@responseMapsForAssignment.each do |map|
@responseForThisMap = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
#for this response, get the answer associated with it
@responseForThisMap.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
@answers[res_map.round][map.type].push(ans)
end
end
end
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
if @answers[round_num][res_type].size > 0
if round_num.nil?
round_type = "Round Nill - " + res_type
else
round_type = "Round " + round_num.to_s + " - " + res_type.to_s
end
csv << [round_type, '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
row = []
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
if @reviewee.nil?
@reviewee = Participant.find_by_id(ans.reviewee_id).user
end
reviewer = Participant.find_by_id(ans.reviewer_id).user
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_id'] == 'true'
tcsv << @reviewee.id
end
end
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_name'] == 'true'
tcsv << @reviewee.name
end
end
if reviewer.nil?
tcsv << ' '
else
if detail_options['reviewer'] == 'true'
tcsv << reviewer.name
end
end
if answer.question.txt.nil?
tcsv << ' '
else
if detail_options['question'] == 'true'
tcsv << answer.question.txt
end
end
if answer.question.id.nil?
tcsv << ' '
else
if detail_options['question_id'] == 'true'
tcsv << answer.question.id
end
end
if answer.id.nil?
tcsv << ' '
else
if detail_options['comment_id'] == 'true'
tcsv << answer.id
end
end
if answer.comments.nil?
tcsv << ' '
else
if detail_options['comments'] == 'true'
tcsv << answer.comments
end
end
if answer.answer.nil?
tcsv << ' '
else
if detail_options['score'] == 'true'
tcsv << answer.answer
end
end
csv << tcsv
end
end
end
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end
'''The expected CSV file is read in as a text file to simplify string comparison with the generated CSV string.'''

The assignment details and all field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and all field headers should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T18:39:43Z

Aapatel8: /* Test Plan */

==Introduction==

This project was an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called ''''exportdetail''''

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fill out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews is stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So it was our assignment to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

def self.export_details(csv, parent_id, detail_options)
@assignment = Assignment.find(parent_id)
@answers = {} # Contails all answer objects for this assignment
#Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
#Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
#create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
#get all response maps for this assignment
@responseMapsForAssignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{@assignment.id}"])
#for each map, get the response & answer associated with it
@responseMapsForAssignment.each do |map|
@responseForThisMap = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
#for this response, get the answer associated with it
@responseForThisMap.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
@answers[res_map.round][map.type].push(ans)
end
end
end
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
if @answers[round_num][res_type].size > 0
if round_num.nil?
round_type = "Round Nill - " + res_type
else
round_type = "Round " + round_num.to_s + " - " + res_type.to_s
end
csv << [round_type, '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
row = []
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
if @reviewee.nil?
@reviewee = Participant.find_by_id(ans.reviewee_id).user
end
reviewer = Participant.find_by_id(ans.reviewer_id).user
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_id'] == 'true'
tcsv << @reviewee.id
end
end
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_name'] == 'true'
tcsv << @reviewee.name
end
end
if reviewer.nil?
tcsv << ' '
else
if detail_options['reviewer'] == 'true'
tcsv << reviewer.name
end
end
if answer.question.txt.nil?
tcsv << ' '
else
if detail_options['question'] == 'true'
tcsv << answer.question.txt
end
end
if answer.question.id.nil?
tcsv << ' '
else
if detail_options['question_id'] == 'true'
tcsv << answer.question.id
end
end
if answer.id.nil?
tcsv << ' '
else
if detail_options['comment_id'] == 'true'
tcsv << answer.id
end
end
if answer.comments.nil?
tcsv << ' '
else
if detail_options['comments'] == 'true'
tcsv << answer.comments
end
end
if answer.answer.nil?
tcsv << ' '
else
if detail_options['score'] == 'true'
tcsv << answer.answer
end
end
csv << tcsv
end
end
end
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end
'''The expected CSV file is read in as a text file to simplify string comparison with the generated CSV string.'''

The assignment details and all field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and all field headers should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T18:39:12Z

Aapatel8: /* Test Plan */

==Introduction==

This project was an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called ''''exportdetail''''

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fill out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews is stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So it was our assignment to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

def self.export_details(csv, parent_id, detail_options)
@assignment = Assignment.find(parent_id)
@answers = {} # Contails all answer objects for this assignment
#Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
#Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
#create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
#get all response maps for this assignment
@responseMapsForAssignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{@assignment.id}"])
#for each map, get the response & answer associated with it
@responseMapsForAssignment.each do |map|
@responseForThisMap = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
#for this response, get the answer associated with it
@responseForThisMap.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
@answers[res_map.round][map.type].push(ans)
end
end
end
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
if @answers[round_num][res_type].size > 0
if round_num.nil?
round_type = "Round Nill - " + res_type
else
round_type = "Round " + round_num.to_s + " - " + res_type.to_s
end
csv << [round_type, '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
row = []
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
if @reviewee.nil?
@reviewee = Participant.find_by_id(ans.reviewee_id).user
end
reviewer = Participant.find_by_id(ans.reviewer_id).user
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_id'] == 'true'
tcsv << @reviewee.id
end
end
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_name'] == 'true'
tcsv << @reviewee.name
end
end
if reviewer.nil?
tcsv << ' '
else
if detail_options['reviewer'] == 'true'
tcsv << reviewer.name
end
end
if answer.question.txt.nil?
tcsv << ' '
else
if detail_options['question'] == 'true'
tcsv << answer.question.txt
end
end
if answer.question.id.nil?
tcsv << ' '
else
if detail_options['question_id'] == 'true'
tcsv << answer.question.id
end
end
if answer.id.nil?
tcsv << ' '
else
if detail_options['comment_id'] == 'true'
tcsv << answer.id
end
end
if answer.comments.nil?
tcsv << ' '
else
if detail_options['comments'] == 'true'
tcsv << answer.comments
end
end
if answer.answer.nil?
tcsv << ' '
else
if detail_options['score'] == 'true'
tcsv << answer.answer
end
end
csv << tcsv
end
end
end
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end
'''The expected CSV file is read in as a text file to simplify string comparison with generated CSV string.'''

The assignment details and all field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and all field headers should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T18:38:43Z

Aapatel8: /* Test Plan */

==Introduction==

This project was an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called ''''exportdetail''''

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fill out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews is stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So it was our assignment to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

def self.export_details(csv, parent_id, detail_options)
@assignment = Assignment.find(parent_id)
@answers = {} # Contails all answer objects for this assignment
#Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
#Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
#create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
#get all response maps for this assignment
@responseMapsForAssignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{@assignment.id}"])
#for each map, get the response & answer associated with it
@responseMapsForAssignment.each do |map|
@responseForThisMap = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
#for this response, get the answer associated with it
@responseForThisMap.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
@answers[res_map.round][map.type].push(ans)
end
end
end
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
if @answers[round_num][res_type].size > 0
if round_num.nil?
round_type = "Round Nill - " + res_type
else
round_type = "Round " + round_num.to_s + " - " + res_type.to_s
end
csv << [round_type, '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
row = []
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
if @reviewee.nil?
@reviewee = Participant.find_by_id(ans.reviewee_id).user
end
reviewer = Participant.find_by_id(ans.reviewer_id).user
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_id'] == 'true'
tcsv << @reviewee.id
end
end
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_name'] == 'true'
tcsv << @reviewee.name
end
end
if reviewer.nil?
tcsv << ' '
else
if detail_options['reviewer'] == 'true'
tcsv << reviewer.name
end
end
if answer.question.txt.nil?
tcsv << ' '
else
if detail_options['question'] == 'true'
tcsv << answer.question.txt
end
end
if answer.question.id.nil?
tcsv << ' '
else
if detail_options['question_id'] == 'true'
tcsv << answer.question.id
end
end
if answer.id.nil?
tcsv << ' '
else
if detail_options['comment_id'] == 'true'
tcsv << answer.id
end
end
if answer.comments.nil?
tcsv << ' '
else
if detail_options['comments'] == 'true'
tcsv << answer.comments
end
end
if answer.answer.nil?
tcsv << ' '
else
if detail_options['score'] == 'true'
tcsv << answer.answer
end
end
csv << tcsv
end
end
end
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end
*The expected CSV file is read in as a text file to simplify string comparison with generated CSV string.

The assignment details and all field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID field headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and all field headers should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T18:33:42Z

Aapatel8: /* Test Plan */

==Introduction==

This project was an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called ''''exportdetail''''

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fill out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews is stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So it was our assignment to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

def self.export_details(csv, parent_id, detail_options)
@assignment = Assignment.find(parent_id)
@answers = {} # Contails all answer objects for this assignment
#Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
#Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
#create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
#get all response maps for this assignment
@responseMapsForAssignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{@assignment.id}"])
#for each map, get the response & answer associated with it
@responseMapsForAssignment.each do |map|
@responseForThisMap = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
#for this response, get the answer associated with it
@responseForThisMap.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
@answers[res_map.round][map.type].push(ans)
end
end
end
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
if @answers[round_num][res_type].size > 0
if round_num.nil?
round_type = "Round Nill - " + res_type
else
round_type = "Round " + round_num.to_s + " - " + res_type.to_s
end
csv << [round_type, '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
row = []
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
if @reviewee.nil?
@reviewee = Participant.find_by_id(ans.reviewee_id).user
end
reviewer = Participant.find_by_id(ans.reviewer_id).user
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_id'] == 'true'
tcsv << @reviewee.id
end
end
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_name'] == 'true'
tcsv << @reviewee.name
end
end
if reviewer.nil?
tcsv << ' '
else
if detail_options['reviewer'] == 'true'
tcsv << reviewer.name
end
end
if answer.question.txt.nil?
tcsv << ' '
else
if detail_options['question'] == 'true'
tcsv << answer.question.txt
end
end
if answer.question.id.nil?
tcsv << ' '
else
if detail_options['question_id'] == 'true'
tcsv << answer.question.id
end
end
if answer.id.nil?
tcsv << ' '
else
if detail_options['comment_id'] == 'true'
tcsv << answer.id
end
end
if answer.comments.nil?
tcsv << ' '
else
if detail_options['comments'] == 'true'
tcsv << answer.comments
end
end
if answer.answer.nil?
tcsv << ' '
else
if detail_options['score'] == 'true'
tcsv << answer.answer
end
end
csv << tcsv
end
end
end
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with some options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "false", "comment_id" => "false",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_some_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

The assignment details and all non-ID headers should be displayed with one answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team Name / Author Name,Reviewer,Question / Dimension Name,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
team1,student1,Test question:,Test comment,1

|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with no data" do
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_data_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details and header should be displayed.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score

|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
The following test case is run to check this scenario:

it "checks csv with data and no options" do
create(:answer, comments: "Test comment")
options = {"team_id" => "false", "team_name" => "false",
"reviewer" => "false", "question" => "false",
"question_id" => "false", "comment_id" => "false",
"comments" => "false", "score" => "false"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_no_options_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

Only the assignment details should be displayed along with no headers and no answer.
A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6

|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T18:04:24Z

Aapatel8: /* Test Plan */

==Introduction==

This project was an addendum to the bigger Expertiza project. The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

The requirement for this OSS project was to ''''Export Scores In Detail''''

==Deployment Link==

http://152.46.16.143:3000

==Branch on Git==
The branch on which we developed this project on is called ''''exportdetail''''

==Problem Statement==
Expertiza provides a the ability for an instructor to export scores for an assignment. Whenever a user fill out teammate reviews, peer reviews, feedback reviews, and etc. the scores for each question on those reviews is stored in the database. Currently however Expertiza only exports a csv with aggregated scores which are computed as weighted averages of the scores given in reviews. This is not the most helpful for visualizing the score data by question, individual team/user, reviewer. So it was our assignment to implement the ability to export a more detailed csv that contained all the scores for each question for each review and review type within a specific assignment.

After talking with our project contact, Ferry, it was decided that the csv would be organized by round and within each round by response type. Part of the implementation was to also include the ability to choose the delimiter for the csv and specify which columns they wanted to include.

==Design==

==Implementation==
===Files Updated===
*app/controllers/export_file_controller.rb
*app/models/assignment.rb
*app/views/export_file/start.html.erb

===Files Added===
*app/views/export_file/_export_details.html.erb
*spec/controllers/export_file_controller_spec.rb
*spec/features/assignment_export_details/expected_details_csv.txt

===Code Snippets===
*export_file_controller_spec.rb

This method is called when the 'Export Details' button is clicked and selects the delimiter and generates the csv with selected columns. It then passes the CSV into the assignment models method to populate it.

def exportdetails
@delim_type = params[:delim_type2]
if @delim_type == "comma"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = ","
elsif @delim_type == "space"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = " "
elsif @delim_type == "tab"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = "\t"
elsif @delim_type == "other"
filename = params[:model] + params[:id] + "_Details.csv"
delimiter = other_char2
end
allowed_models = ['Assignment']
csv_data = CSV.generate(col_sep: delimiter) do |csv|
if allowed_models.include? params[:model]
csv << Object.const_get(params[:model]).export_Headers(params[:id])
csv << Object.const_get(params[:model]).export_details_fields(params[:details])
Object.const_get(params[:model]).export_details(csv, params[:id], params[:details])
end
end

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}"

end

*app/models/assignment.rb

This method is called to populate it the csv and is where the majority of our implementation lies. It finds all the ResponseMaps associated with this assignment, then finds all the Responses associated with that each ResponseMap. Then for each response it saves the Answer objects associated with it into an array that is stored in a hash that is indexed by round and response type (teammate review/feedback review/etc).

def self.export_details(csv, parent_id, detail_options)
@assignment = Assignment.find(parent_id)
@answers = {} # Contails all answer objects for this assignment
#Find all unique response types
@uniq_response_type = ResponseMap.uniq.pluck(:type)
#Find all unique round numbers
@uniq_rounds = Response.uniq.pluck(:round)
#create the nested hash that holds all the answers organized by round # and response type
@uniq_rounds.each do |round_num|
@answers[round_num] = {}
@uniq_response_type.each do |res_type|
@answers[round_num][res_type] = []
end
end
#get all response maps for this assignment
@responseMapsForAssignment = ResponseMap.find_by_sql(["SELECT * FROM response_maps WHERE reviewed_object_id = #{@assignment.id}"])
#for each map, get the response & answer associated with it
@responseMapsForAssignment.each do |map|
@responseForThisMap = Response.find_by_sql(["SELECT * FROM responses WHERE map_id = #{map.id}"])
#for this response, get the answer associated with it
@responseForThisMap.each do |res_map|
@answer = Answer.find_by_sql(["SELECT * FROM answers WHERE response_id = #{res_map.id}"])
@answer.each do |ans|
@answers[res_map.round][map.type].push(ans)
end
end
end
@uniq_rounds.each do |round_num|
@uniq_response_type.each do |res_type|
if @answers[round_num][res_type].size > 0
if round_num.nil?
round_type = "Round Nill - " + res_type
else
round_type = "Round " + round_num.to_s + " - " + res_type.to_s
end
csv << [round_type, '---', '---', '---', '---', '---', '---']
end
@answers[round_num][res_type].each do |answer|
row = []
tcsv = []
@response = Response.find_by_id(answer.response_id)
ans = ResponseMap.find_by_id(@response.map_id)
@reviewee = Team.find_by_id(ans.reviewee_id)
if @reviewee.nil?
@reviewee = Participant.find_by_id(ans.reviewee_id).user
end
reviewer = Participant.find_by_id(ans.reviewer_id).user
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_id'] == 'true'
tcsv << @reviewee.id
end
end
if @reviewee.nil?
tcsv << ' '
else
if detail_options['team_name'] == 'true'
tcsv << @reviewee.name
end
end
if reviewer.nil?
tcsv << ' '
else
if detail_options['reviewer'] == 'true'
tcsv << reviewer.name
end
end
if answer.question.txt.nil?
tcsv << ' '
else
if detail_options['question'] == 'true'
tcsv << answer.question.txt
end
end
if answer.question.id.nil?
tcsv << ' '
else
if detail_options['question_id'] == 'true'
tcsv << answer.question.id
end
end
if answer.id.nil?
tcsv << ' '
else
if detail_options['comment_id'] == 'true'
tcsv << answer.id
end
end
if answer.comments.nil?
tcsv << ' '
else
if detail_options['comments'] == 'true'
tcsv << answer.comments
end
end
if answer.answer.nil?
tcsv << ' '
else
if detail_options['score'] == 'true'
tcsv << answer.answer
end
end
csv << tcsv
end
end
end
end

This method is called by the controller to set the columns in the csv.

# This method is used for export detailed contents. - Akshit, Kushagra, Vaibhav
def self.export_details_fields(detail_options)
fields = []
fields << 'Team ID / Author ID' if detail_options['team_id'] == 'true'
fields << 'Team Name / Author Name' if detail_options['team_name'] == 'true'
fields << 'Reviewer' if detail_options['reviewer'] == 'true'
fields << 'Question / Dimension Name' if detail_options['question'] == 'true'
fields << 'Question ID / Dimension' if detail_options['question_id'] == 'true'
fields << 'Comment ID' if detail_options['comment_id'] == 'true'
fields << 'Comments' if detail_options['comments'] == 'true'
fields << 'Score' if detail_options['score'] == 'true'
fields
end

This method is called by the controller to set the headers in the csv (including Assignment Name and Instructor)

# This method is used to set the headers for the csv like Assignment Name and Assignment Instructor
def self.export_Headers(parent_id)
@assignment = Assignment.find(parent_id)
fields = []
fields << "Assignment Name: " + @assignment.name.to_s
fields << "Assignment Instructor: " + User.find(@assignment.instructor_id).name.to_s
fields
end

==Test Plan==

{| class="wikitable"
|-
| '''Test Type''' || '''Feature/Integration Test'''
|-
| '''Testing Tool''' || '''Rspec'''
|-
| '''Scenario 1''' ||
Export to CSV with all field options enabled and data contains an answer
|-
| '''Test Process Description''' ||
Before each test case is run, the following factories are created:

before(:each) do
@assignment = create(:assignment)
create(:assignment_team, name: "team1")
@student = create(:student, name: "student1")
create(:participant, user: @student)
create(:questionnaire)
create(:question)
create(:review_response_map)
create(:response)
end

The following test case is run to check this scenario:

it "checks_if_csv has the correct data" do
create(:answer, comments: "Test comment")
options = {"team_id" => "true", "team_name" => "true",
"reviewer" => "true", "question" => "true",
"question_id" => "true", "comment_id" => "true",
"comments" => "true", "score" => "true"}
expected_csv = File.read('spec/features/assignment_export_details/expected_details_csv.txt')
generated_csv = CSV.generate(col_sep: delimiter) do |csv|
csv << Assignment.export_headers(@assignment.id)
csv << Assignment.export_details_fields(options)
Assignment.export_details(csv, @assignment.id, options)
end
expect(generated_csv).to eq(expected_csv)
end

A CSV file with the following content is to be expected:

Assignment Name: final2,Assignment Instructor: instructor6
Team ID / Author ID,Team Name / Author Name,Reviewer,Question / Dimension Name,Question ID / Dimension,Comment ID,Comments,Score
Round 1 - ReviewResponseMap,---,---,---,---,---,---
1,team1,student1,Test question:,1,1,Test comment,1

|-
| '''Scenario 2''' ||
Export to CSV with some field options enabled and data contains an answer
|-
| '''Test Process Description''' || < add content >
|-
| '''Scenario 3''' ||
Export to CSV with all field options enabled and data contains no answer
|-
| '''Test Process Description''' || < add content >
|-
| '''Scenario 4''' ||
Export to CSV with no field options enabled and data contains an answer
|-
| '''Test Process Description''' || < add content >
|-
| '''Test Type''' || '''Functional Testing'''
|-
| '''Testing Tool''' || '''Manual Testing'''
|-
| '''Scenario 5''' ||

* Go to the deployment link (http://152.46.16.143:3000)
* Log in as an instructor (we used username: instructor6 and password: password)
* Click Manage -> Assignments
* Click on 'View Score' for an assignment (the magnifying glass and star icon)
* Let the page load
* Click 'Export Grade' at the bottom of the page
* The export grades page will load
* Select which columns you want the csv to output and what kind of delimiter
* Click 'Export Details' (CSV should take 1-2 minutes to generate, so please be patient)

'''HINT WHEN TESTING:''' When you click the 'View Score' icon for an assignment, <br>
some assignments take FOREVER to load on the VCL, so please be patient. <br>
However here is a helpful link that will go straight to the export grades page for <br>
Assignment ID 754 Aka Wikipedia Contribution. <br>

http://152.46.16.143:3000/export_file/start?id=754&model=Assignment <br>

|}

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T17:56:38Z

Aapatel8: /* Test Plan */

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T17:54:00Z

Aapatel8: /* Test Plan */

CSC/ECE 517 Spring 2017/oss E1729

2017-03-23T17:34:19Z

Aapatel8: /* Test Plan */