south_african_air_quality_index 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d697dae6b8a2a2239caa16f7107edfca19a6fe4ca3b13dbdf35ed2cd1220a55
+  data.tar.gz: cbb4c1a357e70556c6a1e778a24e740ac853de86f0a7780469fb240ab87a9f3f
+SHA512:
+  metadata.gz: 7b94a2be9950e13b4f8b363e297a236271144801b436cb02e0b9ef55b011eea2714c85427bdd8df476f71e1839297b46689a4687492fc762200ffb1bc4959cbb
+  data.tar.gz: 15583299e9d8660eb9391642cc64f8d0495e1287368225e35c651c9b6d703cb681e6ab67ef46b0a6b6f79409c9d20641a23a76f838dcd24a842612f7724aa535

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

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/south_african_air_quality_index" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    south_african_air_quality_index (0.0.1)
+      active_attr (~> 0.15)
+      httparty (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.3)
+      actionview (= 7.0.3)
+      activesupport (= 7.0.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.3)
+      activesupport (= 7.0.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.4)
+      actionpack (>= 3.0.2, < 7.1)
+      activemodel (>= 3.0.2, < 7.1)
+      activesupport (>= 3.0.2, < 7.1)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    erubi (1.10.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
+    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.13.6-arm64-darwin)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    racc (1.6.0)
+    rack (2.2.3.1)
+    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.4.2)
+      loofah (~> 2.3)
+    rake (13.0.6)
+    rexml (3.2.5)
+    ruby-progressbar (1.11.0)
+    timecop (0.9.5)
+    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)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.3.5)
+  minitest (~> 5.0)
+  minitest-focus (~> 1.1.2)
+  minitest-reporters (~> 1.4.2)
+  mocha (~> 1.11.2)
+  pry (~> 0.14.1)
+  rake (~> 13.0)
+  south_african_air_quality_index!
+  timecop (~> 0.9.1)
+  webmock (~> 3.8.3)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 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/README.md

@@ -0,0 +1,91 @@
+#  South African Air Quality Index
+A client for the South African Air Quality Index (SAAQIS)
+This is an unofficial project and still a work in progress (WIP) ... more to come soon.
+
+Based on this website: https://saaqis.environment.gov.za/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'south_african_air_quality_index'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install south_african_air_quality_index
+
+## Usage
+
+```ruby
+  require 'south_african_air_quality_index'
+  client  = SouthAfricanAirQualityIndex::Client.new
+
+  # To list stations and available monitors:
+  client.stations
+
+  # To get the correct list of info for reports
+  station_names = ['City of Johannesburg', 'City of Ekurhuleni', 'City of Cape Town']
+  client.selected_stations(station_names, build_for_response: true)
+
+  # To get a report from one stations
+  # Some defaults that are used:
+  # interval: DEFAULT_INTERVAL (60)
+  # report_type: REPORT_TYPE (average)
+  #
+  # station_name - will do a best match to the name
+  # start_date - can be a Time, DateTime or string 30/01/2022 00:00
+  # end_date - can be a Time, DateTime or string 30/01/2022 00:00
+  station_name = 'City of Ekurhuleni'
+  start_date = Time.now - (60 * 60)
+  end_date = Time.now
+  client.station_report(station_name, start_date, end_date)
+
+  # To get a report from multiple stations at once
+  # Some defaults that are used:
+  # interval: DEFAULT_INTERVAL (60)
+  # report_type: REPORT_TYPE (average)
+  #
+  # station_names - will do a best match to the name
+  # start_date - can be a Time, DateTime or string 30/01/2022 00:00
+  # end_date - can be a Time, DateTime or string 30/01/2022 00:00
+  station_names = ['City of Johannesburg', 'City of Ekurhuleni', 'City of Cape Town']
+  start_date = Time.now - (60 * 60)
+  end_date = Time.now
+  client.multi_station_report(station_names, start_date, end_date)
+```
+
+### Endpoints
+- Stations
+- GetStationReportData
+- GetMultiStationReportData
+
+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/south_african_air_quality_index. 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 SouthAfricanAirQualityIndex: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trex22/south_african_air_quality_index/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 "south_african_air_quality_index"
+
+# 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/lib/south_african_air_quality_index/client.rb

@@ -0,0 +1,177 @@
+module SouthAfricanAirQualityIndex
+  class Client
+    include ::SouthAfricanAirQualityIndex::Constants
+
+    attr_reader :base_path, :port, :stations
+
+    def initialize(base_path: BASE_PATH, port: 80)
+      @base_path = base_path
+      @port = port
+    end
+
+    def self.compatible_api_version
+      'v1'
+    end
+
+    # This is the version of the API docs this client was built off-of
+    def self.api_version
+      'v1 2022-06-08'
+    end
+
+    # Endpoints
+
+    # Memoize stations as they are unlikely to change often
+    def stations
+      @stations ||= send(http_method: :get, path: 'ajax/getAllStationsNew')
+    end
+
+    def stations_from_code(codes, build_for_response: false)
+      stations['body']['Stations'].select do |station|
+        codes.map(&:to_s).include?(station["serialCode"].to_s)
+      end
+    end
+
+    def selected_stations(station_names)
+      stations['body']['Stations'].select do |station|
+        station_matches?(station_names, station)
+      end
+    end
+
+    def station_report(station_name, start_date, end_date, interval: DEFAULT_INTERVAL, report_type: REPORT_TYPE)
+      station = selected_stations([station_name]).first
+      return if station.empty?
+
+      monitor_ids = fetch_monitor_ids(station)
+
+      body = {
+        "StationId": station['serialCode'],
+        "MonitorsChannels": monitor_ids,
+        "reportName": STATION_REPORT,
+        "startDateAbsolute": start_date.to_s,
+        "endDateAbsolute": end_date.to_s,
+        "startDate": start_date.to_s,
+        "endDate": end_date.to_s,
+        "reportType": report_type,
+        "fromTb": 60,
+        "toTb": 60
+      }.to_json
+
+      send(http_method: :get, path: 'report/GetStationReportData', body: body, params: { 'InPopUp': false })
+    end
+
+    def multi_station_report(station_names, start_date, end_date, interval: DEFAULT_INTERVAL, report_type: REPORT_TYPE)
+      extracted_stations = selected_stations(station_names)
+
+      monitor_channels_by_station_id = extracted_stations.map { |station|
+        [station['serialCode'].to_s, fetch_monitor_ids(station)]
+      }.to_h
+
+      body = {
+        "monitorChannelsByStationId": monitor_channels_by_station_id,
+        "reportName": HOURLY_REPORT,
+        "startDateAbsolute": start_date.to_s,
+        "endDateAbsolute": end_date.to_s,
+        "startDate": "/Date(#{Time.parse(start_date.to_s).to_i})/",
+        "endDate": "/Date(#{Time.parse(end_date.to_s).to_i})/",
+        "reportType": REPORT_TYPE,
+        "fromTb": DEFAULT_INTERVAL,
+        "toTb": DEFAULT_INTERVAL
+      }
+
+      monitor_channels_by_station_id.each.with_index do |pair, index|
+        hsh = {
+          "monitorChannelsByStationId[#{index}].Key": pair[0],
+          "monitorChannelsByStationId[#{index}].Value": pair[1]
+        }
+
+        body = body.merge(hsh)
+      end
+
+      send(http_method: :get, path: 'report/GetMultiStationReportData', body: body.to_json)
+    end
+
+    private
+
+    def send(http_method:, path:, body: {}, params: {})
+      start_time = micro_second_time
+
+      response = HTTParty.send(
+        http_method.to_sym,
+        construct_base_path(path, params),
+        body: body,
+        headers: { 'Content-Type': 'application/json' },
+        port: port,
+        format: :json
+      )
+
+      end_time = 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 micro_second_time
+      (Time.now.to_f * 1_000_000).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 parse_body(response, path)
+      JSON.parse(response.body) # Purposely not using HTTParty
+    rescue JSON::ParserError => _e
+      response.body
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
+    end
+
+    def station_matches?(station_names, station)
+      station_names
+        .compact
+        .any? do |station_name|
+          processed_name = process_station(station_name)
+
+          process_station(station['city']) == processed_name ||
+            process_station(station['DisplayName']) == processed_name ||
+            process_station(station['name']) == processed_name ||
+            process_station(station['owner']) == processed_name ||
+            process_station(station['location']) == processed_name # TODO: Each monitor has a name too
+        end
+    end
+
+    def fetch_monitor_ids(station)
+      station['monitors'].map do |monitor|
+        monitor['channel']
+      end
+    end
+
+    def process_station(name)
+      name.downcase.gsub('  ', ' ')
+    end
+  end
+end

data/lib/south_african_air_quality_index/constants.rb

@@ -0,0 +1,27 @@
+module SouthAfricanAirQualityIndex
+  module Constants
+    BASE_PATH = 'https://saaqis.environment.gov.za'
+
+    DEFAULT_INTERVAL = 60
+    STATION_REPORT = 'station report'.freeze
+    HOURLY_REPORT = 'hourly report'.freeze
+    REPORT_TYPE = 'Average'.freeze
+
+    # 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.' }
+    }
+
+    def calculate_aqi_range(key)
+      value = AQI_INDEX[:key]
+      (value.lowest_level..value.highest_level).to_a
+    end
+  end
+end

data/lib/south_african_air_quality_index/version.rb

@@ -0,0 +1,3 @@
+module SouthAfricanAirQualityIndex
+  VERSION = "0.0.1"
+end

data/lib/south_african_air_quality_index.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+require 'south_african_air_quality_index/constants'
+require 'south_african_air_quality_index/version'
+
+require 'south_african_air_quality_index/client'
+
+module SouthAfricanAirQualityIndex
+  class Error < StandardError; end
+end

data/notes.txt

@@ -0,0 +1,176 @@
+https://aqicn.org/city/south-africa/ekurhuleni/bedfordview/
+https://saaqis.environment.gov.za/
+
+https://saaqis.environment.gov.zacurl 'https://saaqis.environment.gov.za/report/MultiStationTable' \ -H 'authority: saaqis.environment.gov.za' \ -H 'accept: */*' \ -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'content-type: application/json; charset=UTF-8' \ -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \ -H 'dnt: 1' \ -H 'origin: https://saaqis.environment.gov.za' \ -H 'referer: https://saaqis.environment.gov.za/' \ -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'sec-gpc: 1' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \ -H 'x-requested-with: XMLHttpRequest' \ --data-raw '{"reportConfig":{"reportName":"hourly report","reportType":"Average","startDate":"08/06/2022 01:00","endDate":"09/06/2022 00:00","startDateAbsolute":"08/06/2022 01:00","endDateAbsolute":"09/06/2022 00:00","fromTb":60,"toTb":60,"monitorChannelsByStationId[0].Key":"34","monitorChannelsByStationId[0].Value":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"monitorChannelsByStationId[1].Key":"93","monitorChannelsByStationId[1].Value":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"monitorChannelsByStationId[2].Key":"161","monitorChannelsByStationId[2].Value":[28,27,25,23,11,14,31,35,1,29,12,26],"monitorChannelsByStationId[3].Key":"168","monitorChannelsByStationId[3].Value":[30,28,27,25,23,29]},"InPopUp":true,"isSummaryOnBottomTable":true}' \ --compressed
+
+# Single Station
+curl 'https://saaqis.environment.gov.za/report/GetStationReportData' \
+  -H 'authority: saaqis.environment.gov.za' \
+  -H 'accept: */*' \
+  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
+  -H 'content-type: application/json; charset=UTF-8' \
+  -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \
+  -H 'dnt: 1' \
+  -H 'origin: https://saaqis.environment.gov.za' \
+  -H 'referer: https://saaqis.environment.gov.za/' \
+  -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
+  -H 'sec-ch-ua-mobile: ?0' \
+  -H 'sec-ch-ua-platform: "macOS"' \
+  -H 'sec-fetch-dest: empty' \
+  -H 'sec-fetch-mode: cors' \
+  -H 'sec-fetch-site: same-origin' \
+  -H 'sec-gpc: 1' \
+  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \
+  -H 'x-requested-with: XMLHttpRequest' \
+  --data-raw '{"StationId":168,"MonitorsChannels":[23,25,27,28,29,30],"reportName":"station report","startDateAbsolute":"08/06/2022 00:01","endDateAbsolute":"09/06/2022 00:00","startDate":"08/06/2022 00:01","endDate":"09/06/2022 23:01","reportType":"Average","fromTb":60,"toTb":60}' \
+  --compressed
+
+# Hourly reports info
+https://saaqis.environment.gov.za/Report/HourlyReports?InPopUp=True
+
+curl 'https://saaqis.environment.gov.za/Report/HourlyReports?InPopUp=True' \
+  -H 'authority: saaqis.environment.gov.za' \
+  -H 'accept: */*' \
+  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
+  -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \
+  -H 'dnt: 1' \
+  -H 'referer: https://saaqis.environment.gov.za/' \
+  -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
+  -H 'sec-ch-ua-mobile: ?0' \
+  -H 'sec-ch-ua-platform: "macOS"' \
+  -H 'sec-fetch-dest: empty' \
+  -H 'sec-fetch-mode: cors' \
+  -H 'sec-fetch-site: same-origin' \
+  -H 'sec-gpc: 1' \
+  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \
+  -H 'x-requested-with: XMLHttpRequest' \
+  --compressed
+
+# Returns HTML with names etc ...
+require 'httparty'
+response = HTTParty.get('https://saaqis.environment.gov.za/Report/HourlyReports?InPopUp=False', headers: {'Content-Type' => 'application/json'});
+
+response.body.split("\r\n").select { |row| row.include?("let")}
+
+region_info = response.body.split("\r\n").select { |row| row.include?("let m_Regions =")}.first.delete!(';').delete!("        let m_Regions =").gsub('ru,', '"ru",').gsub('u,', '"u",').gsub('u}', '"u"}').gsub('fa,', '"fa",');
+ru
+
+puts region_info
+JSON.parse(region_info)
+
+# Multi Station Table (not useful)
+curl 'https://saaqis.environment.gov.za/report/MultiStationTable' \
+  -H 'authority: saaqis.environment.gov.za' \
+  -H 'accept: */*' \
+  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
+  -H 'content-type: application/json; charset=UTF-8' \
+  -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \
+  -H 'dnt: 1' \
+  -H 'origin: https://saaqis.environment.gov.za' \
+  -H 'referer: https://saaqis.environment.gov.za/' \
+  -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
+  -H 'sec-ch-ua-mobile: ?0' \
+  -H 'sec-ch-ua-platform: "macOS"' \
+  -H 'sec-fetch-dest: empty' \
+  -H 'sec-fetch-mode: cors' \
+  -H 'sec-fetch-site: same-origin' \
+  -H 'sec-gpc: 1' \
+  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \
+  -H 'x-requested-with: XMLHttpRequest' \
+  --data-raw '{"reportConfig":{"reportName":"hourly report","reportType":"Average","startDate":"08/06/2022 01:00","endDate":"09/06/2022 00:00","startDateAbsolute":"08/06/2022 01:00","endDateAbsolute":"09/06/2022 00:00","fromTb":60,"toTb":60,"monitorChannelsByStationId[0].Key":"34","monitorChannelsByStationId[0].Value":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"monitorChannelsByStationId[1].Key":"93","monitorChannelsByStationId[1].Value":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"monitorChannelsByStationId[2].Key":"161","monitorChannelsByStationId[2].Value":[28,27,25,23,11,14,31,35,1,29,12,26],"monitorChannelsByStationId[3].Key":"168","monitorChannelsByStationId[3].Value":[30,28,27,25,23,29]},"InPopUp":true,"isSummaryOnBottomTable":true}' \
+  --compressed
+
+require 'httparty'
+response = HTTParty.get('https://saaqis.environment.gov.za/report/MultiStationTable', headers: {'Content-Type' => 'application/json'});
+
+# Multi Station report Data
+curl 'https://saaqis.environment.gov.za/report/GetMultiStationReportData' \
+  -H 'authority: saaqis.environment.gov.za' \
+  -H 'accept: */*' \
+  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
+  -H 'content-type: application/json; charset=UTF-8' \
+  -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \
+  -H 'dnt: 1' \
+  -H 'origin: https://saaqis.environment.gov.za' \
+  -H 'referer: https://saaqis.environment.gov.za/' \
+  -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
+  -H 'sec-ch-ua-mobile: ?0' \
+  -H 'sec-ch-ua-platform: "macOS"' \
+  -H 'sec-fetch-dest: empty' \
+  -H 'sec-fetch-mode: cors' \
+  -H 'sec-fetch-site: same-origin' \
+  -H 'sec-gpc: 1' \
+  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \
+  -H 'x-requested-with: XMLHttpRequest' \
+  --data-raw '{"monitorChannelsByStationId":{"34":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"93":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"161":[28,27,25,23,11,14,31,35,1,29,12,26],"168":[30,28,27,25,23,29]},"reportName":"hourly report","startDateAbsolute":"08/06/2022 01:00","endDateAbsolute":"09/06/2022 00:00","startDate":"08/06/2022 01:00","endDate":"10/06/2022 00:00","reportType":"Average","fromTb":60,"toTb":60,"monitorChannelsByStationId[0].Key":"34","monitorChannelsByStationId[0].Value":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"monitorChannelsByStationId[1].Key":"93","monitorChannelsByStationId[1].Value":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"monitorChannelsByStationId[2].Key":"161","monitorChannelsByStationId[2].Value":[28,27,25,23,11,14,31,35,1,29,12,26],"monitorChannelsByStationId[3].Key":"168","monitorChannelsByStationId[3].Value":[30,28,27,25,23,29]}' \
+  --compressed
+
+# List Stations
+curl 'https://saaqis.environment.gov.za/ajax/getAllStationsNew?_=1654684287297' \
+  -H 'authority: saaqis.environment.gov.za' \
+  -H 'accept: */*' \
+  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
+  -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \
+  -H 'dnt: 1' \
+  -H 'referer: https://saaqis.environment.gov.za/' \
+  -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
+  -H 'sec-ch-ua-mobile: ?0' \
+  -H 'sec-ch-ua-platform: "macOS"' \
+  -H 'sec-fetch-dest: empty' \
+  -H 'sec-fetch-mode: cors' \
+  -H 'sec-fetch-site: same-origin' \
+  -H 'sec-gpc: 1' \
+  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \
+  -H 'x-requested-with: XMLHttpRequest' \
+  --compressed
+
+require 'httparty'
+response2 = HTTParty.get('https://saaqis.environment.gov.za/ajax/getAllStationsNew', headers: {'Content-Type' => 'application/json'});
+
+stations = JSON.parse(response2.body);
+stations["Irregularity"].size
+stations["Stations"].size
+
+r = stations["Stations"].first
+stations["Stations"].map { |r| r.size }
+
+
+# Multi stations report summary
+curl 'https://saaqis.environment.gov.za/report/GetMultiStationReportSummary' \
+  -H 'authority: saaqis.environment.gov.za' \
+  -H 'accept: */*' \
+  -H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
+  -H 'content-type: application/json; charset=UTF-8' \
+  -H 'cookie: ASP.NET_SessionId=z4v3us4hod3anuee0cpv0sn4' \
+  -H 'dnt: 1' \
+  -H 'origin: https://saaqis.environment.gov.za' \
+  -H 'referer: https://saaqis.environment.gov.za/' \
+  -H 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
+  -H 'sec-ch-ua-mobile: ?0' \
+  -H 'sec-ch-ua-platform: "macOS"' \
+  -H 'sec-fetch-dest: empty' \
+  -H 'sec-fetch-mode: cors' \
+  -H 'sec-fetch-site: same-origin' \
+  -H 'sec-gpc: 1' \
+  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36' \
+  -H 'x-requested-with: XMLHttpRequest' \
+  --data-raw '{"monitorChannelsByStationId":{"34":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"93":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"161":[28,27,25,23,11,14,31,35,1,29,12,26],"168":[30,28,27,25,23,29]},"reportName":"hourly report","startDateAbsolute":"08/06/2022 01:00","endDateAbsolute":"09/06/2022 00:00","startDate":"/Date(1654642800000)/","endDate":"/Date(1654725600000)/","reportType":"Average","fromTb":60,"toTb":60,"monitorChannelsByStationId[0].Key":"34","monitorChannelsByStationId[0].Value":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"monitorChannelsByStationId[1].Key":"93","monitorChannelsByStationId[1].Value":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"monitorChannelsByStationId[2].Key":"161","monitorChannelsByStationId[2].Value":[28,27,25,23,11,14,31,35,1,29,12,26],"monitorChannelsByStationId[3].Key":"168","monitorChannelsByStationId[3].Value":[30,28,27,25,23,29]}' \
+  --compressed
+
+require 'httparty'
+
+body = '{"monitorChannelsByStationId":{"34":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"93":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"161":[28,27,25,23,11,14,31,35,1,29,12,26],"168":[30,28,27,25,23,29]},"reportName":"hourly report","startDateAbsolute":"08/06/2022 01:00","endDateAbsolute":"09/06/2022 00:00","startDate":"/Date(1654642800000)/","endDate":"/Date(1654725600000)/","reportType":"Average","fromTb":60,"toTb":60,"monitorChannelsByStationId[0].Key":"34","monitorChannelsByStationId[0].Value":[30,28,27,25,23,11,6,3,2,4,5,14,9,8,7,31,35,1,29,12],"monitorChannelsByStationId[1].Key":"93","monitorChannelsByStationId[1].Value":[30,28,27,25,23,11,6,15,3,2,4,5,14,8,7,31,35,1,29,12,13],"monitorChannelsByStationId[2].Key":"161","monitorChannelsByStationId[2].Value":[28,27,25,23,11,14,31,35,1,29,12,26],"monitorChannelsByStationId[3].Key":"168","monitorChannelsByStationId[3].Value":[30,28,27,25,23,29]}'
+
+response = HTTParty.get('https://saaqis.environment.gov.za/report/GetMultiStationReportData', body: JSON.parse(body).to_json, headers: {'Content-Type' => 'application/json'});
+
+
+Types of SA Air Quality reports
+- Analyze single station
+- Analyse multi station
+- Analyse Multiple Params
+- Hourly monitoring data (Multiple stations, time ranges and multiple sensors)
+- Wind / Pollution Roses (Wind direct and pollution graphs)
+- Index Report (AQI)
+- Matrix Report (1 station 1 metric gives stats)
+
+

data/south_african_air_quality_index.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "south_african_air_quality_index/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "south_african_air_quality_index"
+  spec.version       = SouthAfricanAirQualityIndex::VERSION
+  spec.authors       = ["trex22"]
+  spec.email         = ["contact@jasonchalom.com"]
+
+  spec.summary       = "A client for using the South African Air Quality Index API in Ruby."
+  spec.description   = "A client for using the South African Air Quality Index API in Ruby. This is an unofficial project."
+  spec.homepage      = "https://github.com/TRex22/south_african_air_quality_index"
+  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.20"
+  spec.add_dependency "active_attr", "~> 0.15"
+
+  # Development dependancies
+  spec.add_development_dependency "bundler", "~> 2.3.5"
+  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.14.1"
+  spec.add_development_dependency "webmock", "~> 3.8.3"
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: south_african_air_quality_index
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- trex22
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-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.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+description: A client for using the South African Air Quality Index API in Ruby. This
+  is an unofficial project.
+email:
+- contact@jasonchalom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/south_african_air_quality_index.rb
+- lib/south_african_air_quality_index/client.rb
+- lib/south_african_air_quality_index/constants.rb
+- lib/south_african_air_quality_index/version.rb
+- notes.txt
+- south_african_air_quality_index.gemspec
+homepage: https://github.com/TRex22/south_african_air_quality_index
+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.3.4
+signing_key:
+specification_version: 4
+summary: A client for using the South African Air Quality Index API in Ruby.
+test_files: []