ale_air 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a35e5053e3d933d5b7eb69d1584745685ea3fdc
-  data.tar.gz: bbfbe540eb33fd389185e31fea87e46764363a8d
+SHA256:
+  metadata.gz: f60580661ac1dae4b860d496130df098215ec3514a14aba785ccb12b651da6ea
+  data.tar.gz: cc5816589710c9d61e224099776f42b0485797d0f2774ad67c694385becc6eff
 SHA512:
-  metadata.gz: 06fe6626332fd4ae0d0fb3ec1b2f3a43e723e51221378a68cbd4a48449f351d0342bdc40e539cb4f94fb1efb97cb2222d198c32ae1088202cbd3ae5d2a27e28a
-  data.tar.gz: d2813ec13feee278cb1f668111fb3bfe9e75d412e3a873e6f35cb9e266132ae6bcc234bcca5e2b772f5970ddfc682ec3860aab3ea31c4ac3cbafa74c38c854c2
+  metadata.gz: 05c6364bdb707eff52e160a633f713e020140d7d81eb59fb2d3bd65ce6e1f9f0924d046f0c0b51958d47af3b88448065c685e4f25e3e47c8e927099749d82f62
+  data.tar.gz: ece5caf157b032b0b4ac6585cbd28921cade0e72d39eb5e70b2197483009875e40a1117b4011a44331e5b393699b98343802f80603a57f54c45790d47eedf888

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    registries: "*"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "20:00"

data/.gitignore

@@ -21,3 +21,5 @@ tmp
 *.a
 *.swp
 mkmf.log
+config/key.yml
+.idea/

data/.rspec

@@ -1,6 +1,6 @@
 --color
 --require spec_helper
---format progress
+--format documentation
 --profile
 --no-fail-fast
 --order define

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in testGem.gemspec
 gemspec
+
+gem 'rubocop'

data/README.md

@@ -33,13 +33,13 @@ Now you can get the air quality where you wish. This will return true if succesf
 
 Then you can just use the results
 
-    air_results.status        -- will return "ok" or "error"
-    air_results.message       -- what kind of error occured
-    air_results.location      -- the measurement station location
-    air_results.quality       -- Air Quality Index scale as defined by the US-EPA 2016
-    air_results.time_measured -- time of measurement
-    air_results.danger_level  -- level
-    air_results.irc_string    -- Ready string with all the info for IRC for example
+    air_results.status              -- will return "ok" or "error"
+    air_results.message             -- what kind of error occured
+    air_results.location            -- the measurement station location
+    air_results.quality             -- Air Quality Index scale as defined by the US-EPA 2016
+    air_results.time_measured       -- time of measurement
+    air_results.danger_level        -- level
+    air_results.descriptive_text    -- Ready string with all the info for IRC for example
 ## Development
 
 Install on locally and start developing. 

data/ale_air.gemspec

@@ -6,6 +6,7 @@ require 'ale_air/version'
 Gem::Specification.new do |s|
   s.name        = 'ale_air'
   s.version     = AleAir::VERSION
+  s.required_ruby_version = '>= 3.2.2'
   s.summary     = "Air Quality of Major Cities"
   s.description = "Easy to use air quality of major cities. Everything has been parsed for you and ready to use."
   s.authors     = ["FistOfTheNorthStar"]
@@ -19,7 +20,7 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rest-client'
+  s.add_dependency "rest-client"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
   s.add_development_dependency "bundler"

data/config/key.sample.yml

@@ -0,0 +1 @@
+api_key: 'XXX'

data/lib/ale_air/fetch_json.rb

@@ -1,89 +1,95 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'rest-client'
 
 module AleAir
+  # Fetches JSON from Waqi API
   class FetchJSON
     attr_writer :secret_token
-    attr_reader :status, :message, :time_measured, :location, :quality, :danger_level, :irc_string
+    attr_reader :status, :message, :time_measured, :location, :quality, :danger_level, :descriptive_text
 
-    def initialize(token = nil)
-      @secret_token = token
+    def initialize(secret_token = '')
+      @secret_token = secret_token
     end
 
-    def air_quality(city = nil)
-      unless @secret_token.nil?
-        document = JSON.parse(RestClient.get 'https://api.waqi.info/search/?keyword=' + cleaned(city) + '&token=' + @secret_token)
-        get_info(document)
-      end 
+    def air_quality(city = '')
+      return if @secret_token.nil?
+
+      response = RestClient.get("https://api.waqi.info/search/?keyword=#{cleaned(city)}&token=#{@secret_token}")
+      document = JSON.parse(response.body)
+
+      get_info(document)
+    rescue RestClient::ExceptionWithResponse => e
+      @message = e.response&.body || 'Unknown Error'
+      false
     end
 
     private
-    def cleaned(chars = "")
-      URI.encode(chars.downcase.strip)
+
+    def cleaned(chars = '')
+      CGI.escape(chars.downcase.strip)
     end
 
-    def get_info(document = nil)
-      @status = "error"
-      unless document.nil?
-        if document["status"] == "ok"
-	  if document["data"].length > 0
-            document["data"].each do |air|
-	      if !air["aqi"].nil? || !air["aqi"].empty?
-		unless is_int(air["aqi"])
-	          @message = "Invalid Airquality Value"
-		  return false
-	        end	  
-		@status = "ok"
-		@message = "Air Quality"
-		@quality = air["aqi"]
-		@time_measured = air["time"]["stime"] + ' ' + air["time"]["tz"]
-		@location = air["station"]["name"]
-		@danger_level = danger_lev(air["aqi"].to_i)
-		@irc_string = "Air quality: " + air["aqi"] + " AQI " + danger_lev(air["aqi"].to_i) + " @ " + air["station"]["name"] + " " + @time_measured 
-	        return true
-	      else
-		@message = "No Data Available"
-              end
-            end
-	  else
-	    @message = "No Stations Found"
-	  end
-	else
-          
-	  if !document["data"].nil?
-	    @message = document["data"]
-	  else
-            @message = "Unknown Error"
-	    @message = document
-          end
-	end	  
+    def get_info(document)
+      if document['status'] == 'ok' && document['data'].any?
+        air = document['data'].first
+        aqi = air['aqi']
+
+        return false unless check_aqi(aqi)
+
+        information_message(aqi, air)
+      else
+        no_data_available_message(document)
       end
+    end
+
+    def check_aqi(aqi)
+      return true if integer?(aqi)
+
+      @status = 'error'
+      @message = 'Invalid Air Quality Value'
       false
     end
 
-    def danger_lev(aqi=0)
-      case aqi
-      when 0..50
-        "Good"
-      when 51..100
-        "Moderate"
-      when 101..150
-        "Unhealthy for Sensitive Groups"
-      when 151..200
-	"Unhealthy"
-      when 201..300
-        "Very Unhealthy"
-      else
-	"Hazardous"
-      end
+    def information_message(aqi, air)
+      @status = 'ok'
+      @message = 'Air Quality'
+      @quality = aqi
+      @time_measured = "#{air.dig('time', 'stime')} #{air.dig('time', 'tz')}"
+      @location = air.dig('station', 'name')
+      @danger_level = danger_lev(aqi)
+      @descriptive_text = "Air quality: #{aqi} AQI #{danger_lev(aqi)} @ #{air.dig('station',
+                                                                                  'name')} #{@time_measured}"
+      true
     end
 
-    def is_int(string)
-      Integer(string).is_a?(Integer)
-    rescue ArgumentError, TypeError
+    def no_data_available_message(document)
+      @status = 'error'
+      @message = case document['data']
+                 when String then document['data']
+                 else 'No Data Available'
+                 end
       false
     end
 
+    def danger_lev(aqi)
+      case aqi.to_i
+      when 0..50 then 'Good'
+      when 51..100 then 'Moderate'
+      when 101..150 then 'Unhealthy for Sensitive Groups'
+      when 151..200 then 'Unhealthy'
+      when 201..300 then 'Very Unhealthy'
+      else 'Hazardous'
+      end
+    end
+
+    def integer?(aqi)
+      Integer(aqi)
+    rescue ArgumentError
+      false
+    else
+      true
+    end
   end
 end
-

data/lib/ale_air/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AleAir
-  VERSION = "0.0.6"
+  VERSION = '0.1.0'
 end

data/lib/ale_air.rb

@@ -1,5 +1,8 @@
-require "ale_air/version"
+# frozen_string_literal: true
+
+require 'ale_air/version'
 require 'ale_air/fetch_json'
 
+# Air quality of major cities
 module AleAir
 end

data/spec/fetch_json_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+describe 'FetchJSON' do
+  describe '#danger_lev' do
+    let(:fetch_json) { AleAir::FetchJSON.new }
+
+    it 'returns danger level of air according to aqi' do
+      levels = [0, 51, 101, 151, 201, 301]
+      danger_array = ['Good', 'Moderate', 'Unhealthy for Sensitive Groups', 'Unhealthy', 'Very Unhealthy', 'Hazardous']
+      danger_array_append = []
+      levels.each do |level|
+        danger_array_append << fetch_json.send(:danger_lev, level)
+      end
+      expect(danger_array).to match_array(danger_array_append)
+    end
+  end
+
+  describe '#integer?' do
+    fetch_json = AleAir::FetchJSON.new
+    it 'returns false on a string without value to convert' do
+      temp_val = 'this is just a string'
+      expect(fetch_json.send(:integer?, temp_val)).to be false
+    end
+
+    it 'returns int from a string' do
+      expect(fetch_json.send(:integer?, '100')).to be true
+    end
+  end
+
+  describe '#get_info' do
+    before(:example) do
+      @fetch_json = AleAir::FetchJSON.new
+    end
+
+    it 'send correctly formatted hash with status ok' do
+      hash_correct = { 'status' => 'ok', 'message' => 'all good test',
+                       'data' => [{ 'aqi' => '100', 'time' => { 'stime' => '19:00', 'tz' => '+2' },
+                                    'station' => { 'name' => 'test place' } }] }
+      correct_array = ['100', '19:00 +2', 'Air Quality', 'Air quality: 100 AQI Moderate @ test place 19:00 +2',
+                       'Moderate', 'ok', 'test place']
+      response = @fetch_json.send(:get_info, hash_correct)
+      back_array = [@fetch_json.status, @fetch_json.message, @fetch_json.quality, @fetch_json.location,
+                    @fetch_json.danger_level, @fetch_json.time_measured, @fetch_json.descriptive_text]
+      expect(response).to be true
+      expect(correct_array).to match_array(back_array)
+    end
+
+    it 'send nil hash should receive false' do
+      hash_correct = ''
+      expect(@fetch_json.send(:get_info, hash_correct)).to be false
+    end
+
+    it 'send error receive false' do
+      hash_correct = { 'status' => 'error' }
+      expect(@fetch_json.send(:get_info, hash_correct)).to be false
+    end
+  end
+
+  describe '#air_quality' do
+    it 'returns false with nil key with correct city' do
+      fetch_json = AleAir::FetchJSON.new
+      expect(fetch_json.air_quality('Helsinki')).to be false
+      sleep(5)
+    end
+
+    it 'returns false with incorrect key with correct city' do
+      fetch_json = AleAir::FetchJSON.new('ABCDSLJ')
+      expect(fetch_json.air_quality('Helsinki')).to be false
+      sleep(5)
+    end
+
+    it 'returns false with nonexisting name correct key' do
+      fetch_json = AleAir::FetchJSON.new(api_key['api_key'])
+      expect(fetch_json.air_quality('lkjlkjlkjlkjlkj')).to be false
+      sleep(5)
+    end
+
+    it 'returns true with correct place name correct key' do
+      fetch_json = AleAir::FetchJSON.new(api_key['api_key'])
+      expect(fetch_json.air_quality('Helsinki')).to be true
+    end
+  end
+
+  protected
+
+  def api_key
+    @config = YAML.load_file('./config/key.yml')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+Dir['./lib/**/*.rb'].each { |file| require file }
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ale_air
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - FistOfTheNorthStar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -74,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
@@ -81,9 +82,12 @@ files:
 - README.md
 - Rakefile
 - ale_air.gemspec
+- config/key.sample.yml
 - lib/ale_air.rb
 - lib/ale_air/fetch_json.rb
 - lib/ale_air/version.rb
+- spec/fetch_json_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/FistOfTheNorthStar/ale_air
 licenses:
 - MIT
@@ -96,16 +100,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Air Quality of Major Cities
-test_files: []
+test_files:
+- spec/fetch_json_spec.rb
+- spec/spec_helper.rb