iqair_airvisual 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f53ab5c26949b0daefe71ea9614791499dc5e471d405916220d2300a1f5fbb0
-  data.tar.gz: 213ee33988de1887c9ef2fe6ae1b1a270463136a2685ef62bbfa272fed02facd
+  metadata.gz: 77142172023bfce6f9454c937c14d0078d47a2f0765823d565fae636c86182d4
+  data.tar.gz: be8177bd771b1d00aa468fea3e4aac0f19bbcca212934eeb7949edc3b19a4090
 SHA512:
-  metadata.gz: 599530882000d4b0a27b12cf3c5ffcbe75f5eaef5ce1a59a29569ef69467520a105af3dd4818894107491d7eef04556a157cf32483f6f251c826dd76bdcef0c0
-  data.tar.gz: ebdd805f1170a1415e94ae38266fcb6f539089933cc45eacb7df798ecd48b4994ed8b70f2cac1804995b23ac1e4761db995c393eb9c9fd93a88e07a9746514fd
+  metadata.gz: 977db9b50ea308cfa1c1c840c202b637414382bb5a5617c6ee2cb28c90c3e619e7bf058401127c427ca6a33437d594c7b954990fd763ad89ad666515d60e5b32
+  data.tar.gz: 424416e63b418036fe52869c35db598745ff2d1ccfc8a3510b16cc567996dde336e256c38c9a2fcb243066505f6e9d78538d43e44219793f3d4c848d6646d189

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+* The use of sexualised language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviours that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the project team at contact@jasonchalom.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/TRex22/IQAir_AirVisual" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    iqair_airvisual (0.0.2)
+      active_attr (~> 0.15)
+      httparty (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.3)
+      actionpack (>= 3.0.2, < 7.0)
+      activemodel (>= 3.0.2, < 7.0)
+      activesupport (>= 3.0.2, < 7.0)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    erubi (1.10.0)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.11.2)
+    multi_xml (0.6.0)
+    nokogiri (1.11.3-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rake (13.0.3)
+    rexml (3.2.5)
+    ruby-progressbar (1.11.0)
+    timecop (0.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2.16)
+  iqair_airvisual!
+  minitest (~> 5.0)
+  minitest-focus (~> 1.1.2)
+  minitest-reporters (~> 1.4.2)
+  mocha (~> 1.11.2)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  timecop (~> 0.9.1)
+  webmock (~> 3.8.3)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jason Chalom
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 trex22
+
+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,65 @@
+#  IQAir_AirVisual
+A client for the IQAir AirVisual API.
+
+This is an unofficial project and still a work in progress (WIP) ... more to come soon.
+
+For API documentation see: https://api-docs.iqair.com/?version=latest
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iqair_airvisual'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iqair_airvisual
+
+## Usage
+
+```ruby
+  require 'iqair_airvisual'
+  client  = IQAir_AirVisual::Client.new(api_key: 'API key from website')
+
+  client.countries()
+```
+
+### Endpoints
+#### Community
+  - Countries
+  - States
+  - Cities
+  - Nearest City (IP Geo-locate)
+  - Nearest City (GPS Coordinates)
+  - Nearest City (Name)
+
+Other endpoints have not been implemented.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Tests
+To run tests execute:
+
+    $ rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/vodacom-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IQAir_AirVisual: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trex22/IQAir_AirVisual/blob/master/CODE_OF_CONDUCT.md).

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,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iqair_airvisual"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+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/iqair_airvisual.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "iqair_airvisual/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "iqair_airvisual"
+  spec.version       = IqairAirvisual::VERSION
+  spec.authors       = ["trex22"]
+  spec.email         = ["contact@jasonchalom.com"]
+
+  spec.summary       = "A client for using the IQAir_AirVisual API in Ruby."
+  spec.description   = "A client for using the IQAir_AirVisual API in Ruby. This is an unofficial project."
+  spec.homepage      = "https://github.com/TRex22/IQAir_AirVisual"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.18"
+  spec.add_dependency "active_attr", "~> 0.15"
+
+  # Development dependancies
+  spec.add_development_dependency "bundler", "~> 2.2.16"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-focus", "~> 1.1.2"
+  spec.add_development_dependency "minitest-reporters", "~> 1.4.2"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+  spec.add_development_dependency "mocha", "~> 1.11.2"
+  spec.add_development_dependency "pry", "~> 0.13"
+  spec.add_development_dependency "webmock", "~> 3.8.3"
+end

data/lib/iqair_airvisual.rb

@@ -0,0 +1,11 @@
+require 'httparty'
+
+require 'iqair_airvisual/constants'
+require 'iqair_airvisual/version'
+
+require 'iqair_airvisual/community'
+require 'iqair_airvisual/client'
+
+module IqairAirvisual
+  class Error < StandardError; end
+end

data/lib/iqair_airvisual/client.rb

@@ -0,0 +1,144 @@
+module IqairAirvisual
+  class Client
+    include ::IqairAirvisual::Constants
+    include ::IqairAirvisual::Community
+
+    # TODO: Air quality guidelines
+    # TODO: Units breakdown
+    # TODO: Return codes
+    # https://api-docs.iqair.com/?version=latest
+    # Below are a few example of return codes you may get. This list is not exhaustive.
+    # success: returned when JSON file was generated successfully.
+    # call_limit_reached: returned when minute/monthly limit is reached.
+    # api_key_expired: returned when API key is expired.
+    # incorrect_api_key: returned when using wrong API key.
+    # ip_location_failed: returned when service is unable to locate IP address of request.
+    # no_nearest_station: returned when there is no nearest station within specified radius.
+    # feature_not_available: returned when call requests a feature that is not available in chosen subscription plan.
+    # too_many_requests: returned when more than 10 calls per second are made.
+
+    attr_reader :api_key,
+      :base_path,
+      :port,
+      :login_response,
+      :raw_cookie,
+      :expiry
+
+    def initialize(api_key:, base_path: BASE_PATH, port: 80)
+      @api_key = api_key
+      @base_path = base_path
+      @port = port
+    end
+
+    def self.compatible_api_version
+      'v2'
+    end
+
+    # This is the version of the API docs this client was built off-of
+    def self.api_version
+      'v2 2021-04-18'
+    end
+
+    private
+
+    def authorise_and_send(http_method:, path:, payload: {}, params: {})
+      params.merge!({ key: api_key })
+
+      start_time = get_micro_second_time
+
+      response = HTTParty.send(
+        http_method.to_sym,
+        construct_base_path(path, params),
+        body: payload,
+        headers: { 'Content-Type': 'application/json' },
+        port: port,
+        format: :json
+      )
+
+      end_time = get_micro_second_time
+      construct_response_object(response, path, start_time, end_time)
+    end
+
+    def construct_response_object(response, path, start_time, end_time)
+      {
+        'body' => parse_body(response, path),
+        'headers' => response.headers,
+        'metadata' => construct_metadata(response, start_time, end_time)
+      }
+    end
+
+    def construct_metadata(response, start_time, end_time)
+      total_time = end_time - start_time
+
+      {
+        'start_time' => start_time,
+        'end_time' => end_time,
+        'total_time' => total_time
+      }
+    end
+
+    def body_is_present?(response)
+      !body_is_missing?(response)
+    end
+
+    def body_is_missing?(response)
+      response.body.nil? || response.body.empty?
+    end
+
+    def parse_body(response, path)
+      parsed_response = JSON.parse(response.body) # Purposely not using HTTParty
+
+      if parsed_response.dig(path.to_s)
+        parsed_response.dig(path.to_s)
+      else
+        parsed_response
+      end
+    rescue JSON::ParserError => _e
+      response.body
+    end
+
+    def parse_cookie(set_cookie_str, key)
+      value = nil
+      expiry = nil
+
+      set_cookie_str.each do |item|
+        if item.include?(key)
+          value = item.split('; ').first.split('=').last
+
+          if item.include?('Expires') || item.include?('expires')
+            item.split('; ').each do |sub_item|
+              if sub_item.include?('Expires') || sub_item.include?('expires')
+                expiry = Time.parse(sub_item.gsub('expires=', '').gsub('Expires=', ''))
+              end
+            end
+          end
+        end
+      end
+
+      [value, expiry]
+    end
+
+    def process_cookies
+      # Cookies are always a single string separated by spaces
+      raw_cookie.map { |item| item.split('; ').first }.join('; ')
+    end
+
+    def get_micro_second_time
+      (Time.now.to_f * 1000000).to_i
+    end
+
+    def construct_base_path(path, params)
+      constructed_path = "#{base_path}/#{path}"
+
+      if params == {}
+        constructed_path
+      else
+        "#{constructed_path}?#{process_params(params)}"
+      end
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
+    end
+  end
+end

data/lib/iqair_airvisual/community.rb

@@ -0,0 +1,50 @@
+module IqairAirvisual
+  module Community
+    def countries
+      path = 'countries'
+      authorise_and_send(http_method: :get, path: path)
+    end
+
+    def states(country_name)
+      path = 'states'
+      params = { country: country_name }
+      authorise_and_send(http_method: :get, path: path, params: params)
+    end
+
+    def cities(country_name, state_name)
+      path = 'cities'
+      params = {
+        country: country_name,
+        state: state_name
+      }
+      authorise_and_send(http_method: :get, path: path, params: params)
+    end
+
+    # IP Geo-locate
+    def nearest_city(latitude: nil, longitude: nil)
+      if (latitude && !longitude) || (!latitude && longitude)
+        raise 'Both latitude and longitude are required if GPS co-ordinates specified.'
+      end
+
+      path = 'nearest_city'
+
+      params = {}
+      if (latitude && longitude)
+        params = { lat: latitude, lon: longitude }
+      end
+
+      authorise_and_send(http_method: :get, path: path, params: params)
+    end
+
+    def city(country_name, state_name, city_name)
+      path = 'city'
+      params = {
+        country: country_name,
+        state: state_name,
+        city: city_name
+      }
+
+      authorise_and_send(http_method: :get, path: path, params: params)
+    end
+  end
+end

data/lib/iqair_airvisual/constants.rb

@@ -0,0 +1,69 @@
+module IqairAirvisual
+  module Constants
+    BASE_PATH = 'https://api.airvisual.com/v2'
+    IMAGES_PATH = 'https://airvisual.com/images/'
+
+    # https://api-docs.iqair.com/?version=latest#important-notes
+    # https://www.airnow.gov/aqi/aqi-basics/
+    # https://www.weather.gov/safety/airquality-aqindex
+    AQI_INDEX = {
+      good: { lowest_level: 0, highest_level: 50, colour: 'green', description: 'Air quality is satisfactory, and air pollution poses little or no risk.' },
+      moderate: { lowest_level: 51, highest_level: 100, colour: 'yellow', description: 'Air quality is acceptable. However, there may be a risk for some people, particularly those who are unusually sensitive to air pollution.' },
+      unhealthy_for_sensitive_groups: { lowest_level: 101, highest_level: 150, colour: 'orange', description: 'Members of sensitive groups may experience health effects. The general public is less likely to be affected.' },
+      unhealthy: { lowest_level: 151, highest_level: 200, colour: 'red', description: 'Some members of the general public may experience health effects; members of sensitive groups may experience more serious health effects.' },
+      very_unhealthy: { lowest_level: 201, highest_level: 300, colour: 'purple', description: 'Health alert: The risk of health effects is increased for everyone.' },
+      hazardous: { lowest_level: 301, highest_level: 1000, colour: 'maroon', description: 'Health warning of emergency conditions: everyone is more likely to be affected.' }
+    }
+
+    WEATHER_ICON_INDEX = {
+      "01d": { filename: '01d.png', url: 'https://airvisual.com/images/01d.png', description: 'clear sky (day)' },
+      "01n": { filename: '01n.png', url: 'https://airvisual.com/images/01n.png', description: 'clear sky (night)' },
+      "02d": { filename: '02d.png', url: 'https://airvisual.com/images/02d.png', description: 'few clouds (day)' },
+      "02n": { filename: '02n.png', url: 'https://airvisual.com/images/02n.png', description: 'few clouds (night)' },
+      "03d": { filename: '03d.png', url: 'https://airvisual.com/images/03d.png', description: 'scattered clouds' },
+      "04d": { filename: '04d.png', url: 'https://airvisual.com/images/04d.png', description: 'broken clouds' },
+      "09d": { filename: '09d.png', url: 'https://airvisual.com/images/09d.png', description: 'shower rain' },
+      "10d": { filename: '10d.png', url: 'https://airvisual.com/images/10d.png', description: 'rain (day time)' },
+      "10n": { filename: '10n.png', url: 'https://airvisual.com/images/10n.png', description: 'rain (night time)' },
+      "11d": { filename: '11d.png', url: 'https://airvisual.com/images/11d.png', description: 'thunderstorm' },
+      "13d": { filename: '13d.png', url: 'https://airvisual.com/images/13d.png', description: 'snow' },
+      "50d": { filename: '50d.png', url: 'https://airvisual.com/images/50d.png', description: 'mist' }
+    }
+
+    WEATHER_CODES = {
+      ts:     "timestamp",
+      aqius:  "AQI value based on US EPA standard",
+      aqicn:  "AQI value based on China MEP standard",
+      tp:     "temperature in Celsius",
+      tp_min: "minimum temperature in Celsius",
+      pr:     "atmospheric pressure in hPa",
+      hu:     "humidity %",
+      ws:     "wind speed (m/s)",
+      wd:     "wind direction, as an angle of 360° (N=0, E=90, S=180, W=270)",
+      ic:     "weather icon code, see below for icon index",
+      p:      "pollutant details",
+      pn:     "pollutant details",
+      p1:     "pollutant details",
+      p2:     "pollutant details",
+      p3:     "pollutant details",
+      p4:     "pollutant details",
+      conc:   "concentration",
+      o3:     "Ozone O3",
+      n2:     "Nitrogen dioxide NO2",
+      s2:     "Sulfur dioxide SO2",
+      co:     "Carbon monoxide CO"
+    }
+
+    # object containing units information
+    UNITS = {
+      ugm3: "ug/m, Micrograms per Cubic Meter of Air",
+      ppb:  "Parts per billion",
+      ppm:  "Parts per million"
+    }
+
+    def calculate_aqi_range(key)
+      value = AQI_INDEX[:key]
+      (value.lowest_level..value.highest_level).to_a
+    end
+  end
+end

data/lib/iqair_airvisual/version.rb

@@ -0,0 +1,3 @@
+module IqairAirvisual
+  VERSION = "0.0.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iqair_airvisual
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - trex22
@@ -171,7 +171,22 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iqair_airvisual.gemspec
+- lib/iqair_airvisual.rb
+- lib/iqair_airvisual/client.rb
+- lib/iqair_airvisual/community.rb
+- lib/iqair_airvisual/constants.rb
+- lib/iqair_airvisual/version.rb
 homepage: https://github.com/TRex22/IQAir_AirVisual
 licenses:
 - MIT