china_aqi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca4d41542b8602aa534e099a19393fdd74ff74e6
-  data.tar.gz: 1622846a24168d2ca7724a0f8ea981a2d46e4b2f
+  metadata.gz: 8557f12eec57ca0e6a707ff5578d1a19317a7d7d
+  data.tar.gz: f7c6adfeffe1020eb8632aebeef0da4dbd2864ef
 SHA512:
-  metadata.gz: 5f47c648c382a4258f1ce0cf8d74e2a57e0c0e6b13e5c3b6ea38448fd9455798f5416c4a7ff75f10383850227e1d6ace422e660f56002fc821e259e54b5fc875
-  data.tar.gz: ea802169eb2a35232b3e58e06480b4cb52a7634103d2d08c8a657b748d3b2ef37616cf9ca3b74d548534ec2823b5a209c46b87b7ba42fbbfa33db345b85e921a
+  metadata.gz: 6cc29f3ef3d23ae6195a11e1d909125e0507b0c3009d6e9deff423ce2f19290fe685e00eacd3f1692a4756cabba14f96b03bee3e6a332fdd02dbbd172f06c19b
+  data.tar.gz: e87708752855e36a58c35873e4d2f787c5ca649285afef97bedc44852c78314b75000d682b182a307899c92d723a3602fd89a699fc04d04acbfab18a41ec75e2

data/README.md

@@ -1,11 +1,11 @@
 # ChinaAqi
 
- [![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)
+[![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)
+[![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].
+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].
 
 All monitoring stations in most cities of China are available, most AQI data are available, they are:
 
@@ -34,14 +34,18 @@ Run install generator:
 
     $ rails generate china_aqi:install
 
-It will create file: config/initializers/china_aqi.rb
+It will add a new line in config/application.rb:
+
+```ruby
+config.china_aqi_token = 'you_token_here'
+```
+
+Put you token there.
 
 ## Usage
 
 As we mention at the beginning, we must get a token form [pm25.in][pm25_in_api] before we use their APIs, it's free!
 
-Once you get the token, put it in config/initializers/china_aqi.rb, then enjoy!
-
 ### Parameters
 
 Most APIs accept three params:
@@ -113,6 +117,14 @@ ChinaAqi::CityPro.new('shanghai').get  # or ChinaAqi::CityPro.get('shanghai')
 # => [{"aqi"=>57, "area"=>"上海", "co"=>0.0, "co_24h"=>0.0, "no2"=>0, "no2_24h"=>0, ...
 ```
 
+##### Detail data for one monitoring station
+
+```ruby
+ChinaAqi::Station.new('1141A').get  # or ChinaAqi::Station.get('1141A')
+# => [{"aqi"=>57, "area"=>"上海", "co"=>0.0, "co_24h"=>0.0, "no2"=>0, "no2_24h"=>0, ...
+```
+
+
 ##### Fetch all data
 
 ```ruby

data/lib/china_aqi/aqi/station.rb

@@ -7,11 +7,11 @@ module ChinaAqi
   #
   # same as:
   #
-  #   ChinaAqi::CityStations.get(station_code)
+  #   ChinaAqi::Station.get(station_code)
   #
   # You can get all station codes for one city like this:
   #
-  #   ChinaAqi::CityStations.new(station_code).get
+  #   ChinaAqi::Station.new(station_code).get
   #
   # or like this:
   #
@@ -19,7 +19,7 @@ module ChinaAqi
   #
   # and like this:
   #
-  #   ChinaAqi::CityStations.get(city)
+  #   ChinaAqi::Station.get(city)
   class Station < Base
     self.method = :aqis_by_station
     attr_accessor :station_code

data/lib/china_aqi/base.rb

@@ -54,10 +54,6 @@ module ChinaAqi
         #{'*' * 66}~ unless ChinaAqi.token
       @token = ChinaAqi.token
     end
-
-    def self.get(*args)
-      self.new(*args).get
-    end
   end
 
   # APIs with some parameters

data/lib/china_aqi/utility.rb

@@ -14,6 +14,12 @@ module ChinaAqi
       self.base_uri = URI::HTTP.build({host: 'www.pm25.in'})
     end
 
+    module ClassMethods
+      def get(*args)
+        self.new(*args).get
+      end
+    end
+
     def get
       ::ActiveSupport::JSON.decode(HTTParty.get(url).body)
     end

data/lib/china_aqi/version.rb

@@ -1,3 +1,3 @@
 module ChinaAqi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/china_aqi/aqi/dynamic_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ChinaAqi do
+  before(:each) { ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq' }
+
+  ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq'
+
+  describe ChinaAqi::City do
+    include_examples "common dynamic examples", ChinaAqi::City
+    include_examples "class attribute", ChinaAqi::City, :only_aqi
+  end
+
+  describe ChinaAqi::CityPro do
+    include_examples "common dynamic examples", ChinaAqi::CityPro
+    include_examples "class attribute", ChinaAqi::CityPro, :aqi_details
+  end
+
+  describe ChinaAqi::CO do
+    include_examples "common dynamic examples", ChinaAqi::CO
+    include_examples "class attribute", ChinaAqi::CO, :co
+  end
+
+  describe ChinaAqi::NO2 do
+    include_examples "common dynamic examples", ChinaAqi::NO2
+    include_examples "class attribute", ChinaAqi::NO2, :no2
+  end
+
+  describe ChinaAqi::O3 do
+    include_examples "common dynamic examples", ChinaAqi::O3
+    include_examples "class attribute", ChinaAqi::O3, :o3
+  end
+
+  describe ChinaAqi::PM10 do
+    include_examples "common dynamic examples", ChinaAqi::PM10
+    include_examples "class attribute", ChinaAqi::PM10, :pm10
+  end
+
+  describe ChinaAqi::PM25 do
+    include_examples "common dynamic examples", ChinaAqi::PM25
+    include_examples "class attribute", ChinaAqi::PM25, :pm2_5
+  end
+
+  describe ChinaAqi::SO2 do
+    include_examples "common dynamic examples", ChinaAqi::SO2
+    include_examples "class attribute", ChinaAqi::SO2, :so2
+  end
+end

data/spec/china_aqi/aqi/static_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ChinaAqi do
+  before(:each) { ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq' }
+
+  ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq'
+
+  describe ChinaAqi::Global do
+    include_examples "common static examples", ChinaAqi::Global
+    include_examples "class attribute", ChinaAqi::Global, :all_cities
+  end
+
+  describe ChinaAqi::Ranking do
+    include_examples "common static examples", ChinaAqi::Ranking
+    include_examples "class attribute", ChinaAqi::Ranking, :aqi_ranking
+  end
+end

data/spec/china_aqi/aqi/station_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe ChinaAqi::Station do
+  before(:each) { ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq' }
+
+  ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq'
+  obj = ChinaAqi::Station.new('1141A')
+
+  include_examples "common examples", ChinaAqi::Station, obj
+  include_examples "class attribute", ChinaAqi::Station, :aqis_by_station
+
+  it 'should have station_code instance variable' do
+    obj = ChinaAqi::Station.new('1141A')
+    obj.instance_variable_defined?(:@station_code).should be_true
+  end
+end

data/spec/china_aqi/base_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe ChinaAqi do
+  let(:token) { '5j1znBVAsnSf5xQyNQyq' }
+
+  describe ChinaAqi::Base do
+    before(:each) { ChinaAqi.token = nil }
+
+    shared_examples "raise NotImplementedError" do |instance_method_name|
+      it "should raise NotImplementedError when call #{instance_method_name} method" do
+        ChinaAqi.token = token
+        expect { ChinaAqi::Base.new.send instance_method_name }.to raise_error(ChinaAqi::NotImplementedError, "Please set value for 'method' class attributes in 'ChinaAqi::Base' class.")
+      end
+    end
+
+    context 'Instace variable' do
+      it 'should raise error when initial a object if there is no token' do
+        expect { ChinaAqi::Base.new }.to raise_error(ChinaAqi::TokenMissingError)
+      end
+
+      it 'should have instance variable to store token if token was seted' do
+        ChinaAqi.token = 'token_sample'
+        obj = ChinaAqi::Base.new
+        obj.instance_variable_defined?(:@token).should be_true
+        obj.token.should eq('token_sample')
+      end
+    end
+
+    context 'Instace methods' do
+      include_examples "raise NotImplementedError", 'uri'
+      include_examples "raise NotImplementedError", 'get'
+      include_examples "raise NotImplementedError", 'url'
+    end
+
+    context 'Class methods' do
+      it "should raise error when call get class method" do
+        expect { ChinaAqi::Base.get('Shanghai') }.to raise_error
+      end
+    end
+  end
+
+  describe ChinaAqi::DynamicBase do
+    it 'should have city and parmas instance variable' do
+      ChinaAqi.token = token
+      obj = ChinaAqi::DynamicBase.new('Shanghai')
+      obj.instance_variable_defined?(:@city).should be_true
+      obj.instance_variable_defined?(:@parmas).should be_true
+    end
+  end
+
+  describe ChinaAqi::StaticBase do
+    it 'should have parmas instance variable' do
+      ChinaAqi.token = token
+      obj = ChinaAqi::StaticBase.new
+      obj.instance_variable_defined?(:@parmas).should be_true
+    end
+  end
+end

data/spec/china_aqi/helper/city_stations_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ChinaAqi do
+  describe ChinaAqi::CityStations do
+    include_examples "common dynamic examples", ChinaAqi::CityStations
+    include_examples "class attribute", ChinaAqi::CityStations, :station_names
+
+    before(:each) { ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq' }
+
+    it 'should have module function called get_stations_for_city to get stations for one city' do
+      ChinaAqi.respond_to?(:get_stations_for_city).should be_true
+      stations = ChinaAqi.get_stations_for_city('Shanghai')
+      stations.should be_a(Hash)
+      stations.key?('city').should be_true
+      stations.key?('stations').should be_true
+      stations['stations'].should be_a(Array)
+      stations['city'].should eq('上海')
+    end
+
+    it 'should return a hash with aqi data when call "get" instance method' do
+      stations = ChinaAqi::CityStations.new('Shanghai').get
+      stations.should be_a(Hash)
+      stations.key?('city').should be_true
+      stations.key?('stations').should be_true
+      stations['stations'].should be_a(Array)
+      stations['city'].should eq('上海')
+    end
+  end
+end

data/spec/china_aqi/shared_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ChinaAqi do
+  shared_examples "common examples" do |klass, obj|
+    it 'should return URI::HTTP object own context when call "uri" method' do
+      uri = obj.uri
+      uri.should be_a(URI::HTTP)
+      uri.host.should eq('www.pm25.in')
+      uri.path.should eq("/api/querys/#{klass.method.to_s}.json")
+    end
+
+    it 'should return url string with own context when call "url" method' do
+      obj.url.should be_a(String)
+      obj.url.include?("http://www.pm25.in/api/querys/#{klass.method.to_s}.json").should be_true
+    end
+  end
+
+  shared_examples 'class attribute' do |klass, value|
+    it "should have class attribute 'method' equal #{value}" do
+      klass.method.should eq(value)
+    end
+  end
+
+  shared_examples 'get array' do |klass|
+    before(:each) { ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq' }
+    let(:obj) { klass.new('Shanghai') }
+
+    it 'should return an array with aqi data when call "get" method' do
+      data = obj.get
+      data.should be_a(Array)
+      data.all? {|aqi| aqi.key? 'aqi'}.should be_true
+    end
+  end
+
+  shared_examples "common dynamic examples" do |klass|
+    ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq'
+    obj = klass.new('Shanghai')
+
+    include_examples "common examples", klass, obj
+
+  end
+
+  shared_examples "common static examples" do |klass|
+    ChinaAqi.token = '5j1znBVAsnSf5xQyNQyq'
+    obj = klass.new
+
+    include_examples "common examples", klass, obj
+  end
+end

data/spec/china_aqi_spec.rb

@@ -1,11 +1,15 @@
 require 'spec_helper'
 
 describe ChinaAqi do
+  before(:each) { ChinaAqi.token = nil }
+
   it 'should have a version number' do
     ChinaAqi::VERSION.should_not be_nil
   end
 
-  it 'should do something useful' do
-    false.should be_false
+  it 'should return token which defined in rails application configuration file.' do
+    stub_const('Rails', Module.new)
+    Rails.stub_chain('application.config.china_aqi_token') { 'chian_aqi_token_test_sample' }
+    ChinaAqi.token.should eq('chian_aqi_token_test_sample')
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'china_aqi'
 require 'coveralls'
 Coveralls.wear!
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'china_aqi'
+
+require 'china_aqi/shared_spec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: china_aqi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Xuhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,12 @@ files:
 - lib/china_aqi/version.rb
 - lib/generators/china_aqi/install/USAGE
 - lib/generators/china_aqi/install/install_generator.rb
+- spec/china_aqi/aqi/dynamic_spec.rb
+- spec/china_aqi/aqi/static_spec.rb
+- spec/china_aqi/aqi/station_spec.rb
+- spec/china_aqi/base_spec.rb
+- spec/china_aqi/helper/city_stations_spec.rb
+- spec/china_aqi/shared_spec.rb
 - spec/china_aqi_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Xuhao/china_aqi
@@ -141,5 +147,11 @@ signing_key:
 specification_version: 4
 summary: China AQI API from PM25.in
 test_files:
+- spec/china_aqi/aqi/dynamic_spec.rb
+- spec/china_aqi/aqi/static_spec.rb
+- spec/china_aqi/aqi/station_spec.rb
+- spec/china_aqi/base_spec.rb
+- spec/china_aqi/helper/city_stations_spec.rb
+- spec/china_aqi/shared_spec.rb
 - spec/china_aqi_spec.rb
 - spec/spec_helper.rb