china_aqi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5629478b4a11380f5cf5768d6e93381dcef35081
-  data.tar.gz: 73938de2bcb5dcbd52b3607f391759823dccdc6b
+  metadata.gz: e3feada665c53c16d850f1046b9b3e4fbe124720
+  data.tar.gz: 9d13fbabc8af55eb04b19550aab1f1d9ab26a507
 SHA512:
-  metadata.gz: 54948bc0de829400be061cda90c2b810f87440cfb2d390dfc1188a0763186ad4744341fe6da42061f91c90399a02cda896d94b70e5532a77f1fbd5a678082ce5
-  data.tar.gz: 53c0da5802bc59812543ada719f660d20a47ab24e8d40eeee438fe41b6da8a936b48ac48d5f80900ba9755a4e21087af83fa0f57b10b930d139140da7fabfb43
+  metadata.gz: 4e40d15d2d7b14a24ad8e4c969c50dd5cc7fcba26cd406def4d29bb6afaf0fe006c9c34294e5af4f188b2be3047c7466590b496c72b01442ea9f4916ae9a3a66
+  data.tar.gz: d6a9ed650f69ccaabd803da5af8ce86a2573fad1de0df1454b808c7e4f4f00e6246a495fa1ad68eeac793e31ac6949d2dfaecb257d770a55960cb408de002268

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.versions.conf

data/.rubocop.yml

@@ -0,0 +1,60 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "bin/*"
+    - "tmp/**/*"
+    - Gemfile
+    - Guardfile
+    - Rakefile
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+Style/AsciiComments:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.2
+  - 2.3
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## v0.0.5 (Sep 17, 2016)
+
+* New api for get available cities:
+  ```ruby
+  ChinaAqi.available_cities # or ChinaAqi::AvailableCities.new.get
+  # {"cities"=>["七台河", "三亚", "三明", "三门峡" ...
+  ```
+
+* Compatibility improvements.

data/Gemfile

@@ -1,8 +1,16 @@
-source 'https://rubygems.org'
-# source 'http://ruby.taobao.org'
+# source 'https://rubygems.org'
+source 'https://gems.ruby-china.org'
 
 # Specify your gem's dependencies in china_aqi.gemspec
 gemspec
 
-gem 'rake', group: :test
+if RUBY_VERSION < '2'
+  gem 'json', '1.8.3'
+  gem 'tins', '1.6.0'
+end
+gem 'rspec', '~> 3.5.0'
+gem 'webmock', require: 'webmock/rspec'
+gem 'vcr', '~> 3.0', '>= 3.0.3'
 gem 'coveralls', require: false
+gem 'rubocop', require: false
+gem 'rubocop-rspec', '1.4.1'

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/china_aqi.png)](http://badge.fury.io/rb/china_aqi)
 [![Build Status](https://travis-ci.org/Xuhao/china_aqi.png?branch=master)](https://travis-ci.org/Xuhao/china_aqi)
 [![Code Climate](https://codeclimate.com/github/Xuhao/china_aqi.png)](https://codeclimate.com/github/Xuhao/china_aqi)
+[![Dependency Status](https://gemnasium.com/Xuhao/china_aqi.png)](https://gemnasium.com/Xuhao/china_aqi)
 [![Coverage Status](https://coveralls.io/repos/Xuhao/china_aqi/badge.png?branch=master)](https://coveralls.io/r/Xuhao/china_aqi?branch=master)
 
 China Air Quality Index API for Ruby. Thanks [pm25.in][pm25_in] for provide all the AQI sources for us as free, all the data is form China's official sector. it's a reall gread work! ChinaAqi gem provide some interface base on Ruby On Rails, before to use it, you need ask for a token form [pm25.in][pm25_in_api].
@@ -16,6 +17,19 @@ All monitoring stations in most cities of China are available, most AQI data are
   - **PM2.5**: 颗粒物（粒径小于等于2.5μm）
   - **SO2**: 二氧化硫
 
+### Chinese PM2.5 reporting from U.S. Consulate
+
+About PM2.5 reporting from U.S. Consulate please check out: [pm25
+](https://github.com/ekohe/pm25)
+
+## Compatibility
+  CRuby 1.9.3 or greater, 2.2+ recommended. JRuby not sure.
+
+  Support for Rails:
+  * Rails 3 (not sure)
+  * Rails 4 (tested)
+  * Rails 5 (tested)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,6 +44,8 @@ Or install it yourself as:
 
     $ gem install china_aqi
 
+### For Rails app
+
 Run install generator:
 
     $ rails generate china_aqi:install
@@ -39,8 +55,18 @@ It will add a new line in config/application.rb:
 ```ruby
 config.china_aqi_token = 'you_token_here'
 ```
+Put your token there.
+
+### For non-Rails app
 
-Put you token there.
+Just require `china_aqi` and then assign a valid token for it:
+
+```ruby
+require 'rubygems'
+require 'china_aqi'
+
+ChinaAqi.token = 'you_token_here'
+```
 
 ## Usage
 
@@ -51,7 +77,7 @@ As we mention at the beginning, we must get a token form [pm25.in][pm25_in_api]
 Most APIs accept three params:
 
 - `city`: city name can be chinese characters, pinyin and area code('上海' or 'shanghai' or '021')
-- `avg`: true/false, optional, if true,return average for all monitoring stations, default is true.
+- `avg`: true/false, optional, if true, return average for all monitoring stations, default is true.
 - `stations`: yes/no, optional, if yes, return data for all monitoring stations; if no, just return average without stations data, default is yes.
 
 `avg` and `stations` params is optional, it will use defaut value if not set them.
@@ -152,7 +178,11 @@ ChinaAqi.get_stations_for_city('shanghai')
 ChinaAqi.get_stations_for_city('021')
 # same as:
 ChinaAqi::CityStations.get('上海/shanghai/021')
-# {"city"=>"上海", "stations"=>[{"station_name"=>"普陀" ..
+# {"city"=>"上海", "stations"=>[{"station_name"=>"普陀" ...
+
+# Get the list for cities which have AQI data.
+ChinaAqi.available_cities
+# {"cities"=>["七台河", "三亚", "三明", "三门峡" ...
 ```
 
 ## Contributing
@@ -165,4 +195,4 @@ ChinaAqi::CityStations.get('上海/shanghai/021')
 
 
 [pm25_in]: http://www.pm25.in
-[pm25_in_api]: http://www.pm25.in/api_doc
+[pm25_in_api]: http://www.pm25.in/api_doc

data/china_aqi.gemspec

@@ -1,26 +1,30 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'china_aqi/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "china_aqi"
+  spec.name          = 'china_aqi'
   spec.version       = ChinaAqi::VERSION
-  spec.authors       = ["Xuhao"]
-  spec.email         = ["xuhao@rubyfans.com"]
-  spec.description   = %q{China AQI API from PM25.in}
-  spec.summary       = %q{China AQI API from PM25.in}
-  spec.homepage      = "https://github.com/Xuhao/china_aqi"
-  spec.license       = "MIT"
+  spec.authors       = ['Xuhao']
+  spec.email         = ['xuhao@rubyfans.com']
+  spec.description   = 'China AQI API from PM25.in'
+  spec.summary       = 'China AQI API from PM25.in'
+  spec.homepage      = 'https://github.com/Xuhao/china_aqi'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($RS)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_dependency 'activesupport'
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  if RUBY_VERSION < '2.2.2'
+    spec.add_dependency 'activesupport', '~> 4.0'
+  else
+    spec.add_dependency 'activesupport'
+  end
   spec.add_dependency 'httparty'
 end

data/lib/china_aqi.rb

@@ -1,4 +1,4 @@
-require "china_aqi/version"
+require 'china_aqi/version'
 module ChinaAqi
   def self.token
     @token ||= begin
@@ -15,4 +15,5 @@ end
 
 require 'china_aqi/base'
 require 'china_aqi/exceptions'
-require 'china_aqi/helper/city_stations'
+require 'china_aqi/helper/city_stations'
+require 'china_aqi/helper/available_cities'

data/lib/china_aqi/aqi/dynamic/city.rb

@@ -3,4 +3,4 @@ module ChinaAqi
   class City < DynamicBase
     self.method = :only_aqi
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/city_pro.rb

@@ -3,4 +3,4 @@ module ChinaAqi
   class CityPro < DynamicBase
     self.method = :aqi_details
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/co.rb

@@ -2,4 +2,4 @@ module ChinaAqi
   class CO < DynamicBase
     self.method = :co
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/no2.rb

@@ -2,4 +2,4 @@ module ChinaAqi
   class NO2 < DynamicBase
     self.method = :no2
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/o3.rb

@@ -2,4 +2,4 @@ module ChinaAqi
   class O3 < DynamicBase
     self.method = :o3
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/pm10.rb

@@ -2,4 +2,4 @@ module ChinaAqi
   class PM10 < DynamicBase
     self.method = :pm10
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/pm25.rb

@@ -2,4 +2,4 @@ module ChinaAqi
   class PM25 < DynamicBase
     self.method = :pm2_5
   end
-end
+end

data/lib/china_aqi/aqi/dynamic/so2.rb

@@ -2,4 +2,4 @@ module ChinaAqi
   class SO2 < DynamicBase
     self.method = :so2
   end
-end
+end

data/lib/china_aqi/aqi/static/global.rb

@@ -5,4 +5,4 @@ module ChinaAqi
   class Global < StaticBase
     self.method = :all_cities
   end
-end
+end

data/lib/china_aqi/aqi/static/ranking.rb

@@ -3,4 +3,4 @@ module ChinaAqi
   class Ranking < StaticBase
     self.method = :aqi_ranking
   end
-end
+end

data/lib/china_aqi/aqi/station.rb

@@ -30,4 +30,4 @@ module ChinaAqi
       @parmas = { station_code: station_code, token: ChinaAqi.token }
     end
   end
-end
+end

data/lib/china_aqi/base.rb

@@ -1,7 +1,7 @@
 require 'china_aqi/utility'
 module ChinaAqi
   # Fetch data with different method
-  # 
+  #
   # Pass city name and params those API accept.
   #
   #  shanghai = ChinaAqi::PM25.new('city_name', params = { avg: true/false, stations: :yes/:no })
@@ -37,8 +37,8 @@ module ChinaAqi
     include ChinaAqi::Utility
     attr_accessor :token
 
-    def initialize(*args)
-      raise TokenMissingError, %~
+    def initialize(*_)
+      raise TokenMissingError, %Q(
         #{'*' * 66}
         Token is missing!
 
@@ -51,12 +51,12 @@ module ChinaAqi
           # config/application.rb
           config.china_aqi_token = "you_token"
 
-        #{'*' * 66}~ unless ChinaAqi.token
+        #{'*' * 66}) unless ChinaAqi.token
       @token = ChinaAqi.token
     end
 
     def self.get(*args)
-      self.new(*args).get
+      new(*args).get
     end
   end
 
@@ -64,7 +64,7 @@ module ChinaAqi
   class DynamicBase < Base
     attr_accessor :city
 
-    def initialize(city, querys = {avg: true, stations: :yes})
+    def initialize(city, querys={ avg: true, stations: :yes })
       super
       @city = city
       @parmas = querys.merge(city: city, token: ChinaAqi.token)
@@ -92,4 +92,4 @@ require 'china_aqi/aqi/dynamic/so2'
 require 'china_aqi/aqi/static/global'
 require 'china_aqi/aqi/static/ranking'
 
-require 'china_aqi/aqi/station'
+require 'china_aqi/aqi/station'

data/lib/china_aqi/exceptions.rb

@@ -1,4 +1,4 @@
 module ChinaAqi
   class TokenMissingError < StandardError; end
   class NotImplementedError < StandardError; end
-end
+end

data/lib/china_aqi/helper/available_cities.rb

@@ -0,0 +1,11 @@
+module ChinaAqi
+  class AvailableCities < StaticBase
+    self.method = '/querys'
+  end
+
+  def available_cities
+    AvailableCities.new.get
+  end
+
+  module_function :available_cities
+end

data/lib/china_aqi/helper/city_stations.rb

@@ -1,4 +1,3 @@
-require 'china_aqi/utility'
 module ChinaAqi
   # All monitoring station names in one city
   class CityStations < DynamicBase
@@ -9,6 +8,6 @@ module ChinaAqi
   def get_stations_for_city(city)
     CityStations.new(city).get
   end
-  
+
   module_function :get_stations_for_city
-end
+end

data/lib/china_aqi/utility.rb

@@ -2,6 +2,7 @@ require 'httparty'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/json/decoding'
 require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/object/blank'
 require 'active_support/concern'
 module ChinaAqi
   module Utility
@@ -11,7 +12,7 @@ module ChinaAqi
       include HTTParty
       attr_accessor :parmas
       class_attribute :base_uri, :method
-      self.base_uri = URI::HTTP.build({host: 'www.pm25.in'})
+      self.base_uri = URI::HTTP.build(host: 'www.pm25.in')
     end
 
     def get
@@ -20,7 +21,8 @@ module ChinaAqi
 
     def uri
       raise NotImplementedError, "Please set value for 'method' class attributes in '#{self.class.name}' class." unless self.class.method
-      self.class.base_uri.path = "/api/querys/#{self.class.method.to_s}.json"
+      method = self.class.method.to_s.include?('/') ? self.class.method : "/querys/#{self.class.method}"
+      self.class.base_uri.path = "/api#{method}.json"
       self.class.base_uri.query = @parmas.to_query
       self.class.base_uri
     end
@@ -29,4 +31,4 @@ module ChinaAqi
       uri.to_s
     end
   end
-end
+end