Skip to content

Latest commit

 

History

History
137 lines (87 loc) · 7.56 KB

README.md

File metadata and controls

137 lines (87 loc) · 7.56 KB
Raw

MyL3-External-Data

GSoC 2018 project

This project aims to import useful data about learners from external sources (By taking their permission). Data sources that will be researched and prototyped include:

  • Import Weather data
  • Import Map, Location data
  • Import Google Fit data
  • Import Facebook Status

For more info visit MyL3 page of the Fluid wiki

Steps to run this project locally:

  • How to get API keys:

    Don't restrict Goolge Map API key. Under Key restrictions > Application restrictions select "None". Restricting this key causes error sometimes during development and testing.

    • We have to use "Geocoding API" to provide location information. Enable Geocoding API for Google map as well. Remember the API key will be same for both "Maps JavaScript API" and "Geocoding API".
    • To get fitness API key and client ID visit the same google cloud project which you have set up for Google Map key.

      • Visit APIs and Services > Library

      • search for Fitness API, enable it

      • Go to APIs and Services > Credentials > OAuth 2.0 client IDs

        You'll get client ID and API key (client secret) by clicking on web project which you have set up for MyL3

      • Goto credentials, now select web client for this project. Under Restriction > Authorized JavaScript origins

      • Add links to localhost urls where you'll run you project locally (Only specified URLs will be able to access Fitness API through your API credentials) e.g. http://localhost:3000 and https://developers.google.com . You can add more than one websites urls.

      • More about fitness API is explained in Google Fit API documentation

  • Clone repo and open project folder in terminal

    git clone https://github.com/jeevan-jp/MyL3-External-Data.git

  • Once you have all the keys and client id ready, create a new file named apiKeys.js within "scripts" folder. Copy contents from apiKeysTemplate.js into newly created file. add all the keys corresponding to the names. Variables in the file have following meanings-

    • openweathermapKey: Key from Open weather map API.
    • googleMapKey: Goolgle Map API key form Google Cloud Platfrom.
    • OAuthKey: OAuth 2.0 web client secret.
    • clientId: OAuth 2.0 web client ID.
    • airVisualKey: Key for Air Visual API.

    Make sure you provide right key to the right variable in the apiKeys.js

  • A local webserver is needed (for error free viewing), http-server is a good option. Install http-server globally using the following command:

    npm install http-server -g

    Mac and Linux users may need to add sudo at the beginning:

    sudo npm install http-server -g

    If npm isn't working download and install node. Remember it is not mandatory to use http-server you can set up according to your choice.

  • After installation run following command in terminal:

    http-server -p 3000

  • Visit http://localhost:3000 in your browser.

Important libraries used to provide google fit data:

  • Google OAuth 2.0 : Name of script file used is api.js and this is the link to it.

    <script src="https://apis.google.com/js/api.js"></script>

  • Chart.js to show fitness history in the form of line or bar graph. CDN used for chart.js

    <script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.7.2/Chart.min.js"></script>

Type of OAuth 2.0 used:

How to use OAuth 2.0 Playground (optional)

GET or POST request to the fitness API can be made simply through Google OAuth 2.0 Playground: https://developers.google.com/oauthplayground/ Using OAuth playground is one of easiest way to visualise the response and make changes to our requests accordingly.

Access of OAuth 2.0 should be given to https://developers.google.com as I explained in fitness key set up part.

Few Global Variables explained

Upto this point our global object "myL3" contains 4 API keys 1 client_id(OAuth), a variable named myL3.oneTimeWeatherData.

myL3.oneTimeWeatherData stores the weather data retrieved so that, it can be used in other parts without making the API call again.

Disconnect users:

To test OAuth prompt which is shown to take api permission more than once: Don’t clear browser history and data. Instead you should use GoogleAuth.signOut() or GoogleAuth.disconnect() in browser console to sign out the user from MyL3. Because GoogleAuth is a global variable.

About Openweathermap:

OpenWeatherMap weather service is based on the VANE Geospatial Data Science platform for collecting, processing, and distributing information about our planet through easy to use tools and APIs. Ideology is inspired by OpenStreetMap and Wikipedia that make information free and available for everybody. OpenWeatherMap provides wide range of weather data such as map with current weather, week forecast, precipitation, wind, clouds, data from weather Stations and many others. Weather data is received from global Meteorological broadcast services and more than 40,000 weather stations. (courtesy: Stack overflow)

Reverse Geocoding

Reverse geocoding is the process of back coding of a point location to a readable address or place name. This permits the identification of nearby street addresses, places, and/or areal subdivisions such as neighbourhoods, county, state, or country.

We have used Geocoding API of Google Maps JavaScript API to implement reverse geocoding. Refer to Geocoding API documentation for more. Link to make JSON request:

https://maps.googleapis.com/maps/api/js?key={{YOUR_API_KEY}}

Air Pollution API used:

In the beginning we tried to using openaq API because it was free and open source. But it does not provode us current air pollution data and also they have very limited coverage as well. That’s why we used Air Visual.

Airvisual is one of the trusted APIs which provide us free API (with restriction on API calls) and it has more coverage than openaq. You’ll have to register and get free API key to see documentation.

REST API endpoint used:

https://api.airvisual.com/v2/nearest_city?lat={LATITUDE}&lon={LONGITUDE}&key={YOUR_API_KEY}

Reddit OAuth setup

Youtube

It is highly recommended to watch how to deal with Google FIt Rest API: https://youtu.be/YMRhBPGLgmE