waqi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c007eefec0933a9ee71b23f34d1e10fb8ab735c
+  data.tar.gz: e42046b21152bf858860b241a2ae7e69506c1621
+SHA512:
+  metadata.gz: f28fab63e0a514ecf219ead617a9e66beb8d01cec590fec892978fd4b2636265f54169578308366555ab577f90116554e4a5fd7f00f3e45f3dc77553226c1e8a
+  data.tar.gz: 9f2886682a72158aa1af31d4addfa8d2bfbe2e07f3fdd3cd0177f8a98016a26ff5e4cfeef0b91eb92e6d0d33ddd94c8c4b4d39e48df5175aa5616ac9264c4641

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+before_install: gem install bundler -v 1.13.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in waqi.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Luis Ezcurdia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Waqi
+[![Build Status](https://travis-ci.org/3zcurdia/waqi.svg?branch=master)](https://travis-ci.org/3zcurdia/waqi)
+
+Air Quality Open Data Platform gem wrapper
+
+## Installation
+
+```ruby
+gem 'waqi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install waqi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/3zcurdia/waqi

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'waqi'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/waqi/client.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'waqi/services'
+
+module Waqi
+  class Client
+    def initialize(token:)
+      @token = token
+    end
+
+    def city_feed(city_name)
+      response = Service::City.new(city_name).get(token: @token)
+      StationData.parse(response)
+    end
+
+    def geo_feed(lat, lon)
+      response = Service::Geolocation.new(lat,lon).get(token: @token)
+      StationData.parse(response)
+    end
+
+    def local_feed
+      response = Service::City.new().get(token: @token)
+      StationData.parse(response)
+    end
+
+    def map_stations(*bounds)
+      response = Service::Map.new(*bounds).get(token: @token)
+      response.map { |data| StationPin.parse(data) }
+    end
+
+    def search(keyword)
+      response = Service::Search.new(keyword).get(token: @token)
+      response.map { |data| StationData.parse(data) }
+    end
+  end
+end

data/lib/waqi/models/attribution.rb

@@ -0,0 +1,7 @@
+module Waqi
+  class Attribution < Struct.new(:name, :url)
+    def self.parse(hash)
+      new(*hash.values_at(*members))
+    end
+  end
+end

data/lib/waqi/models/city.rb

@@ -0,0 +1,7 @@
+module Waqi
+  class City < Struct.new(:name, :geo, :url)
+    def self.parse(hash)
+      new(*hash.values_at(*self.members))
+    end
+  end
+end

data/lib/waqi/models/station.rb

@@ -0,0 +1,15 @@
+module Waqi
+  class Station
+    attr_reader :city, :attributions
+    def self.parse(hash)
+      city = hash[:city] ? City.parse(hash[:city]) : (hash[:name] ? City.parse(hash) : {})
+      attributions = hash[:attributions] ? hash[:attributions] : []
+      new(city: city, attributions: attributions.map { |a| Attribution.parse(a) })
+    end
+
+    def initialize(city: nil, attributions: nil)
+      @city = city
+      @attributions = attributions
+    end
+  end
+end

data/lib/waqi/models/station_data.rb

@@ -0,0 +1,28 @@
+module Waqi
+  class StationData
+    attr_reader :aqi, :idx, :uid, :station, :dominant_pollution, :weather_condition, :timestamp
+    def self.parse(data)
+      wheather_condition = data[:iaqi] ? WeatherCondition.new(data[:iaqi]) : {}
+      station = data[:station] ? Station.parse(data[:station]) : Station.parse(data)
+      new(
+        aqi: data[:aqi],
+        idx: data[:idx],
+        uid: data[:uid],
+        dominant_pollution: data[:dominentpol],
+        station: station,
+        weather_condition: wheather_condition,
+        timestamp: DateTime.parse("#{data[:time][:s] || data[:time][:stime]}#{data[:time][:tz]}")
+      )
+    end
+
+    def initialize(aqi: nil, idx: nil, uid: nil, station: nil, dominant_pollution: nil, weather_condition: nil, timestamp: nil)
+      @aqi = aqi
+      @idx = idx
+      @uid = uid
+      @station = station
+      @dominant_pollution = dominant_pollution
+      @weather_condition = weather_condition
+      @timestamp = timestamp
+    end
+  end
+end

data/lib/waqi/models/station_pin.rb

@@ -0,0 +1,7 @@
+module Waqi
+  class StationPin < Struct.new(:lat, :lon, :uid, :aqi)
+    def self.parse(hash)
+      new(*hash.values_at(*self.members))
+    end
+  end
+end

data/lib/waqi/models/weather_condition.rb

@@ -0,0 +1,22 @@
+module Waqi
+  class WeatherCondition
+    attr_reader :carbon_monoxyde, :dew, :relative_humidity, :nitrogen_dioxide,
+                :ozone, :atmospheric_pressure, :pm10, :pm25, :sulphur_dioxide,
+                :temperature, :wind
+
+    def initialize(data)
+      @carbon_monoxyde      = data.dig(:co, :v)
+      @dew                  = data.dig(:d, :v)
+      @relative_humidity    = data.dig(:h, :v)
+      @nitrogen_dioxide     = data.dig(:no2, :v)
+      @ozone                = data.dig(:o3, :v)
+      @atmospheric_pressure = data.dig(:p, :v)
+      @pm10                 = data.dig(:pm10, :v)
+      @pm25                 = data.dig(:pm25, :v)
+      @sulphur_dioxide      = data.dig(:so2, :v)
+      @temperature          = data.dig(:t, :v)
+      @wind                 = data.dig(:w, :v)
+      # @wind_direction      = data.dig(:wd, :v) # unkown value?
+    end
+  end
+end

data/lib/waqi/models.rb

@@ -0,0 +1,6 @@
+require 'waqi/models/attribution'
+require 'waqi/models/city'
+require 'waqi/models/station'
+require 'waqi/models/station_data'
+require 'waqi/models/station_pin'
+require 'waqi/models/weather_condition'

data/lib/waqi/services/base.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'json'
+module Waqi
+  module Service
+    class Base
+      BASE_URL = 'https://api.waqi.info'.freeze
+
+      def initialize(params = {})
+        @connection = Faraday.new(url: BASE_URL)
+        @params = params
+      end
+
+      def get(options = {})
+        parse(@connection.get(self.path, @params.merge(options)))
+      end
+
+      def path
+        raise "path has not beed defined"
+      end
+
+      private
+
+      def parse(response)
+        parsed_response = JSON.parse(response.body, symbolize_names: true)
+        raise "API Error: #{parsed_response[:data]}" if parsed_response[:status] == 'error'
+        parsed_response[:data]
+      end
+    end
+  end
+end

data/lib/waqi/services/city.rb

@@ -0,0 +1,14 @@
+module Waqi
+  module Service
+    class City < Base
+      def initialize(name = 'here')
+        super()
+        @name = name
+      end
+
+      def path
+        "/feed/#{@name}/"
+      end
+    end
+  end
+end

data/lib/waqi/services/geolocation.rb

@@ -0,0 +1,14 @@
+module Waqi
+  module Service
+    class Geolocation < Base
+      def initialize(lat, lon)
+        super()
+        @lat, @lon = lat, lon
+      end
+
+      def path
+        "/feed/geo:#{@lat};#{@lon}/"
+      end
+    end
+  end
+end

data/lib/waqi/services/map.rb

@@ -0,0 +1,13 @@
+module Waqi
+  module Service
+    class Map < Base
+      def initialize(*bounds)
+        super(latlng: bounds.take(4).join(','))
+      end
+
+      def path
+        '/map/bounds/'.freeze
+      end
+    end
+  end
+end

data/lib/waqi/services/search.rb

@@ -0,0 +1,13 @@
+module Waqi
+  module Service
+    class Search < Base
+      def initialize(keyword)
+        super(keyword: keyword)
+      end
+
+      def path
+        '/search/'.freeze
+      end
+    end
+  end
+end

data/lib/waqi/services.rb

@@ -0,0 +1,5 @@
+require 'waqi/services/base'
+require 'waqi/services/city'
+require 'waqi/services/geolocation'
+require 'waqi/services/map'
+require 'waqi/services/search'

data/lib/waqi/version.rb

@@ -0,0 +1,3 @@
+module Waqi
+  VERSION = '0.0.1'.freeze
+end

data/lib/waqi.rb

@@ -0,0 +1,6 @@
+require 'waqi/version'
+require 'waqi/models'
+require 'waqi/client'
+
+module Waqi
+end

data/waqi.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'waqi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'waqi'
+  spec.version       = Waqi::VERSION
+  spec.authors       = ['Luis Ezcurdia']
+  spec.email         = ['ing.ezcurdia@gmail.com']
+  spec.license       = 'MIT'
+  spec.summary       = 'World Air Quality ruby wrapper'
+  spec.description   = 'Air Quality Open Data Platform ruby wrapper'
+  spec.homepage      = 'https://github.com/3zcurdia/waqi'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry', '~> 0.10.3'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+
+  spec.add_dependency 'faraday', '~>  0.10'
+  spec.add_dependency 'json', '~> 2.0'
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: waqi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luis Ezcurdia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Air Quality Open Data Platform ruby wrapper
+email:
+- ing.ezcurdia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/waqi.rb
+- lib/waqi/client.rb
+- lib/waqi/models.rb
+- lib/waqi/models/attribution.rb
+- lib/waqi/models/city.rb
+- lib/waqi/models/station.rb
+- lib/waqi/models/station_data.rb
+- lib/waqi/models/station_pin.rb
+- lib/waqi/models/weather_condition.rb
+- lib/waqi/services.rb
+- lib/waqi/services/base.rb
+- lib/waqi/services/city.rb
+- lib/waqi/services/geolocation.rb
+- lib/waqi/services/map.rb
+- lib/waqi/services/search.rb
+- lib/waqi/version.rb
+- waqi.gemspec
+homepage: https://github.com/3zcurdia/waqi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: World Air Quality ruby wrapper
+test_files: []