ale_air 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30a9b15792a12c6c8cdd6b82055d379fa25404ac
+  data.tar.gz: b0b754805b2c9832e1a761ee9a8cdef907ca3399
+SHA512:
+  metadata.gz: 2131f08b3fa76c9a92971cd45c2e947a035e6b6b33dbda9eb291503526655356dc7159b609eaf6aa37bf35f6a12cf07dd9aafe937790ca6b6f3f00fb9ded51f2
+  data.tar.gz: 7381160866c562fdf33cb713201f79ad199ee7b06bd55cae11cfcc1b042c39861b49cce3340a9535253f50d29071074f451092ff4026bfd3a406fa5e9c57cac8

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 eric-an
+
+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,54 @@
+# Easy Air Quality Ruby Gem for Major Cities
+
+This is an easy to use Gem for your Ruby projects when you wish to add air quality parameters. It uses World Air Quality Projects open api and parses the responses for ease of use. To use it go to [Air Quality Project](aqicn.org) and apply for a token (you will need it).
+
+## Installation
+
+Add this to Gemfile:
+
+```ruby
+gem 'ale_air'
+```
+
+And then execute:
+
+    $ bundle install
+ 
+Or
+
+    $ gem install ale_air
+
+## Usage
+Add
+
+    require 'ale_air'
+
+Just initialize first with your token
+
+    air_results = AleAir::FetchJSON.new('YOUR_TOKEN')
+
+Now you can get the air quality where you wish. This will return true if succesful and false if some error occured
+
+    air_results.air_quality('Helsinki')
+
+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
+
+## Development
+
+Install on locally and start developing. 
+
+## License
+
+MIT License.
+
+## Contributing
+
+Report bugs and pull requests on GitHub at https://github.com/FistOfTheNorthStar/ale_air 
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ale_air.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ale_air/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ale_air'
+  s.version     = AleAir::VERSION
+  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"]
+  s.email       = ["k.kulvik@gmail.com"]
+  s.homepage    =
+    'https://github.com/FistOfTheNorthStar/ale_air'
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files -z`.split("\x0")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('json', '~> 2.1', '>= 2.1.0')
+  s.add_development_dependency('rest-client', '~> 2.0', '>= 2.0.2')
+  s.add_development_dependency('rspec', '~> 3.7', '>= 3.7.0')
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler", "~> 1.6"
+end

data/lib/ale_air/fetch_json.rb

@@ -0,0 +1,86 @@
+require 'json'
+require 'rest-client'
+
+module AleAir
+  class FetchJSON
+    attr_writer :secret_token
+    attr_reader :status, :message, :time_measured, :location, :quality, :danger_level
+
+    def initialize(token = nil)
+      @secret_token = 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 
+    end
+
+    private
+    def cleaned(chars = "")
+      URI.encode(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)
+	        return true
+	      else
+		@message = "No Data Available"
+              end
+            end
+	  else
+	    @message = "No Stations Found"
+	  end
+	else
+          if document["message"]
+	    @message = document["message"]
+	  else
+            @message = "Unknown Error"
+          end
+	end	  
+      end
+      return 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
+    end
+
+    def is_int(string)
+      Integer(string).is_a?(Integer)
+    rescue ArgumentError, TypeError
+      false
+    end
+
+  end
+end
+

data/lib/ale_air/version.rb

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

data/lib/ale_air.rb

@@ -0,0 +1,5 @@
+require "ale_air/version"
+require 'ale_air/fetch_json'
+
+module AleAir
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: ale_air
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- FistOfTheNorthStar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Easy to use air quality of major cities. Everything has been parsed for
+  you and ready to use.
+email:
+- k.kulvik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ale_air.gemspec
+- lib/ale_air.rb
+- lib/ale_air/fetch_json.rb
+- lib/ale_air/version.rb
+homepage: https://github.com/FistOfTheNorthStar/ale_air
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Air Quality of Major Cities
+test_files: []