airly-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e77d91f6aea92ad07f54d29100bef9c1551ca4b067011d0df318b0079c1eb22
+  data.tar.gz: e6f204f4a04fd461e37c8bdfbf19561d0508f31d66a72ec474bf1e9b974ea83f
+SHA512:
+  metadata.gz: 89f18b4a71cee866878661f173da4ca9453a34018b74a901c7fa6e025fba9ab5ab50bcf4c6aa11eac785b3c924bebf46ff541b88e7e2faa19820e24d01007071
+  data.tar.gz: 71ac3c7cfc11622905de62a069f8b265c9d3bd6cb478b5b0200bcdd223692831fc41e88d361188fd8117fb40b0b4614d81e6bfbc0c6be342f718b4f58ee0bf6f

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'httparty', '~> 0.17.1'

data/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0904)
+    multi_xml (0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (~> 0.17.1)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,12 @@
+# AirlyClient
+
+AirlyClient is a ruby client for [airly.eu](https://airly.eu/) API.
+
+## Usage
+
+```
+AirlyClient.set_api_key(key) # Setup API key
+AirlyClient.nearest_installation(latitude, longtitude, max_distance_km: distance, max_results: results) # Find nearest installations
+AirlyClient.installation(id) # Get installation data by id
+AirlyClient.measurements(installation_id) # Get measurements for station
+```

data/airly-client.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+    s.name          = 'airly-client'
+    s.version       = '0.0.1'
+    s.date          = '2019-10-08'
+    s.summary       = "Client for airly.eu api"
+    s.description   = "Simple client for fetching information from airly.eu"
+    s.authors       = ["kuskoman"]
+    s.email         = 'kubasurdej@gmail.com'
+    s.files         = `git ls-files -z`.split("\x0")
+    s.require_paths = ["lib"]
+    s.homepage      =
+      'https://github.com/kuskoman/airly-client'
+    s.license       = 'MIT'
+
+    s.add_dependency 'httparty', '~> 0.17.1'
+  end

data/lib/airly-client.rb

@@ -0,0 +1,53 @@
+require_relative 'api/client'
+require_relative 'api/entity'
+require_relative 'api/installation'
+require_relative 'api/measurements'
+
+require 'httparty'
+require 'uri'
+
+module AirlyClient
+    class << self
+        def api
+            @client ||= ApiClient.new
+        end
+
+        def set_api_key(api_key)
+            api.api_key = api_key
+        end
+
+        def nearest_installation(latitude, longtitude, max_distance_km: 5, max_results: 1)
+            res = api.make_request("installations/nearest",
+                {
+                    "lat" => latitude,
+                    "lng" => longtitude,
+                    "maxDistanceKM" => max_distance_km,
+                    "maxResults" => max_results
+                })
+
+            installations = []
+
+            res.each do |raw|
+                installations << Installation.new(raw)
+            end
+
+            installations
+        end
+
+        def installation(id)
+            res = api.make_request("installations/#{id}")
+
+            Installation.new(res)
+        end
+
+        def measurements(installation_id, index_type = 'AIRLY_CAQI')
+            res = api.make_request("measurements/installation",
+                {
+                    "installationId" => installation_id,
+                    "indexType" => index_type
+                })
+
+            Measurements.new(res)
+        end
+    end
+end

data/lib/api/address.rb

@@ -0,0 +1,27 @@
+module AirlyClient
+    class Address < Entity
+        def country
+            @raw['country']
+        end
+
+        def city
+            @raw['city']
+        end
+
+        def street
+            @raw['street']
+        end
+
+        def number
+            @raw['number']
+        end
+
+        def display_address1
+            @raw['displayAddress1']
+        end
+
+        def display_address2
+            @raw['displayAddress2']
+        end
+    end
+end

data/lib/api/client.rb

@@ -0,0 +1,39 @@
+module AirlyClient
+    class ApiClient
+        attr_writer :api_key
+        def initialize(api_key = nil, base_url = "https://airapi.airly.eu/v2/")
+            @api_key = api_key
+            @base_url = base_url
+        end
+
+        def make_request(resource, params = {})
+            res = fetch(resource, params)
+            JSON.parse(res.body)
+        end
+
+        private
+
+            def fetch(resource, params)
+                HTTParty.get(
+                    @base_url + resource + stringify_params(params),
+                    headers: headers
+                )
+            end
+
+            def headers
+                {
+                    'Accept' => 'application/json',
+                    'Accept-Language' => 'en',
+                    'apikey' => @api_key
+                }
+            end
+
+            def stringify_params(params)
+                if params.nil?
+                    ""
+                else
+                    "?" + URI.encode_www_form(params)
+                end
+            end
+    end
+end

data/lib/api/entity.rb

@@ -0,0 +1,6 @@
+class Entity
+    attr_reader :raw
+    def initialize(raw)
+        @raw = raw
+    end
+end

data/lib/api/installation.rb

@@ -0,0 +1,31 @@
+require_relative 'location'
+require_relative 'address'
+require_relative 'sponsor'
+
+module AirlyClient
+    class Installation < Entity
+        def id
+            @raw['id']
+        end
+
+        def location
+            @location ||= Location.new(@raw['location'])
+        end
+
+        def elevation
+            @raw['elevation']
+        end
+
+        def address
+            @address ||= Address.new(@raw['address'])
+        end
+        
+        def airly
+            @raw['airly']
+        end
+
+        def sponsor
+            @sponsor ||= Sponsor.new(@raw['sponsor'])
+        end
+    end
+end

data/lib/api/location.rb

@@ -0,0 +1,11 @@
+module AirlyClient
+    class Location < Entity
+        def latitude
+            @raw['latitude']
+        end
+
+        def longtitude
+            @raw['longtitude']
+        end
+    end
+end

data/lib/api/measurements.rb

@@ -0,0 +1,29 @@
+require_relative 'single_measurement'
+
+module AirlyClient
+    class Measurements < Entity
+        def current
+            @current ||= SingleMeasurement.new(@raw['current'])
+        end
+
+        def history
+            @history ||= parse_array_of_measurements(@raw['history'])
+        end
+
+        def forecast
+            @forecast ||= parse_array_of_measurements(@raw['forecast'])
+        end
+
+        private 
+        
+            def parse_array_of_measurements(array)
+                parsed = []
+
+                array.each do |measurement|
+                    parsed << SingleMeasurement.new(measurement)
+                end
+
+                parsed
+            end
+    end
+end

data/lib/api/single_measurement.rb

@@ -0,0 +1,50 @@
+module AirlyClient
+    class SingleMeasurement < Entity
+        def initialize(raw)
+            super
+            parse_values
+        end
+
+        def from_date_time
+            @raw['fromDateTime']
+        end
+
+        def till_date_time
+            @raw['tillDatetime']
+        end
+
+        def pm1
+            @values['PM1']
+        end
+
+        def pm10
+            @values['PM10']
+        end
+
+        def pm25
+            @values['PM25']
+        end
+
+        def pressure
+            @values['PRESSURE']
+        end
+
+        def humidity
+            @values['HUMIDITY']
+        end
+
+        def temperature
+            @values['TEMPERATURE']
+        end
+
+        private
+
+            def parse_values
+                @values = {}
+                @raw['values'].each do |value|
+                    name = value['name']
+                    @values[name] = value['value']
+                end
+            end
+    end
+end

data/lib/api/sponsor.rb

@@ -0,0 +1,23 @@
+module AirlyClient
+    class Sponsor < Entity
+        def id
+            @raw['id']
+        end
+
+        def name
+            @raw['name']
+        end
+
+        def description
+            @raw['description']
+        end
+
+        def logo
+            @raw['logo']
+        end
+
+        def link
+            @raw['link']
+        end
+    end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: airly-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kuskoman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Simple client for fetching information from airly.eu
+email: kubasurdej@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- airly-client.gemspec
+- lib/airly-client.rb
+- lib/api/address.rb
+- lib/api/client.rb
+- lib/api/entity.rb
+- lib/api/installation.rb
+- lib/api/location.rb
+- lib/api/measurements.rb
+- lib/api/single_measurement.rb
+- lib/api/sponsor.rb
+homepage: https://github.com/kuskoman/airly-client
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Client for airly.eu api
+test_files: []