pm25 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ab93196de911f044eddb954a668c5d22d4a91db
-  data.tar.gz: e95313819d4b17c7c1000fed8b5edd53803541fd
+  metadata.gz: dc572dc7b0470481bf49d0af5120410fbcbdd331
+  data.tar.gz: cf76f74f9da3fb29c51d2bd74aa68a9bf7e08a0b
 SHA512:
-  metadata.gz: da1aa51442b263b4f2bb552da55317207598817d0ba3386d3a5beec3122eb377960f0477f581bd9f34b843f2aefacb653beaa0a34e2b8ff4e5a87b83445cfceb
-  data.tar.gz: 4baf7cf46b287ce60cd211b78f3187f59156e2b710443b55ecdf94d1fd1ba51290925ff921d941b8455848be96ab2fd10b56b59a8e7016fa6c8796e28d476c1e
+  metadata.gz: ef22e986f06fbece1d130fcb98ee0dcada03544fb621e8fa39e8df1d07b6512c9afc0cb6143bbf28ead2d3ce43896160205ede70aa6081fdc7768fc870197960
+  data.tar.gz: 048130ad1ac1f10a20dca49436173e32fc6ff9fef3dd6eaec442a72bc6bfdfc187551d0cf27f12af452b9eb9e960076a5fb8de4383993dfd885886905457ce60

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.versions.conf
 Gemfile.lock
 InstalledFiles
 _yardoc

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in pm25.gemspec
 gemspec
 
-gem 'rake', group: :test
+gem 'rake', group: :test
+gem 'coveralls', require: false

data/README.md

@@ -1,11 +1,12 @@
 # PM25
 
+[![Gem Version](https://badge.fury.io/rb/pm25.png)](http://badge.fury.io/rb/pm25)
 [![Build Status](https://www.travis-ci.org/ekohe/pm25.png?branch=master)](https://www.travis-ci.org/ekohe/pm25)
 [![Code Climate](https://codeclimate.com/github/ekohe/pm25.png)](https://codeclimate.com/github/ekohe/pm25)
+[![Dependency Status](https://gemnasium.com/ekohe/pm25.png)](https://gemnasium.com/ekohe/pm25)
+[![Coverage Status](https://coveralls.io/repos/ekohe/pm25/badge.png)](https://coveralls.io/r/ekohe/pm25)
 
-PM2.5 and ozone readings Data From U.S. Consulate.
-
-Include below cities of China:
+China PM2.5 and ozone readings Data From U.S. Consulate. Include below cities of China:
 
 - Beijing
 - Shanghai
@@ -13,6 +14,8 @@ Include below cities of China:
 - Guangzhou
 - Shenyang
 
+Another gem about Air Quality Index of China available here [ChinaAqi][china_aqi], all monitoring stations in most cities of China are available, most AQI data are available, all the data is form China's official sector. Check it out!
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -103,3 +106,5 @@ PM25::Shenyang.last
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[china_aqi]: https://github.com/Xuhao/china_aqi

data/lib/pm25/base.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/slice'
 module PM25
   class Base
     include HTTParty
@@ -35,10 +36,12 @@ module PM25
     end
 
     def self.parse(data)
-      data['Conc'] = data['Conc'].to_f
-      data['AQI'] = data['AQI'].to_i
-      data['ReadingDateTime'] = DateTime.strptime(data['ReadingDateTime'], '%m/%d/%Y %I:%M:%S %p')
-      data
+      parsed_data = {}
+      parsed_data['Conc'] = data['Conc'].to_f
+      parsed_data['AQI'] = data['AQI'].to_i
+      parsed_data['Desc'] = data['Desc'].to_s
+      parsed_data['ReadingDateTime'] = DateTime.strptime(data['ReadingDateTime'], '%m/%d/%Y %I:%M:%S %p')
+      parsed_data
     end
   end
 end

data/lib/pm25/version.rb

@@ -1,3 +1,3 @@
-module Pm25
-  VERSION = "0.0.3"
+module PM25
+  VERSION = "0.0.4"
 end

data/pm25.gemspec

@@ -5,7 +5,7 @@ require 'pm25/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "pm25"
-  spec.version       = Pm25::VERSION
+  spec.version       = PM25::VERSION
   spec.authors       = ["Xuhao"]
   spec.email         = ["xuhao@rubyfans.com"]
   spec.description   = %q{PM2.5 reporting from U.S. Consulate}

data/spec/pm25/base_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'pm25/base'
+
+describe PM25::Base  do
+  shared_examples "raise NotImplementedError" do |class_method_name|
+    it "should raise NotImplementedError when call #{class_method_name} class method" do
+      expect { PM25::Base.__send__ class_method_name }.to raise_error(NotImplementedError, "Please set value for 'city_id' class attributes in 'PM25::Base' class.")
+    end
+  end
+
+  shared_examples 'helper methods' do |_class|
+    let(:hash_a) do
+      {"Conc" => '125.0', "AQI" => '187', "Desc" => "Unhealthy (at 24-hour exposure at this level)", "ReadingDateTime" => "06/04/2013 6:00:00 PM", 'a' => 'a value', 'b' => 'b value'}
+    end
+
+    it 'should slice a hash with ATTRS when call `slice` method' do
+      hash_b = _class.slice(hash_a)
+      hash_b.should be_a(Hash)
+      _class::ATTRS.all?{|x| hash_b.key?(x)}.should eq(true)
+      hash_b.key?('a').should eq(false)
+      hash_b.key?('b').should eq(false)
+    end
+
+    it 'should parse hash values to ruby data type when call `parse` method' do
+      hash_b = _class.parse(hash_a)
+      hash_b.should be_a(Hash)
+      hash_b.key?('a').should eq(false)
+      hash_b.key?('b').should eq(false)
+
+      hash_b['Conc'].should be_a(Float)
+      hash_b['Conc'].should eq(125.0)
+      hash_b['AQI'].should be_a(Integer)
+      hash_b['AQI'].should eq(187)
+      hash_b['ReadingDateTime'].should be_a(DateTime)
+      hash_b['ReadingDateTime'].should eq(DateTime.strptime(hash_a['ReadingDateTime'], '%m/%d/%Y %I:%M:%S %p'))
+    end
+  end
+
+  context 'Class attributes and constant' do
+    it 'should have constant ATTRS with array values' do
+      PM25::Base::ATTRS.should eq(%w(Conc AQI Desc ReadingDateTime))
+    end
+
+    it 'should not have city_id' do
+      PM25::Base.city_id.should be_nil
+    end
+
+    it 'should have base_uri with host "ww.stateair.net"' do
+      PM25::Base.base_uri.should be_a(URI::HTTP)
+      PM25::Base.base_uri.host.should eq('www.stateair.net')
+    end
+  end
+
+  context 'Class methods' do
+    include_examples "raise NotImplementedError", 'uri'
+    include_examples "raise NotImplementedError", 'get'
+    include_examples "raise NotImplementedError", 'all'
+    include_examples "raise NotImplementedError", 'last'
+    include_examples "raise NotImplementedError", 'url'
+
+    include_examples "helper methods", PM25::Base
+  end
+end

data/spec/pm25/cities_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'pm25/base'
+
+shared_examples "city common examples" do |city_class, city_id|
+  include_examples "helper methods", city_class
+  context 'class attribute' do
+    it "should has city_id equal to #{city_id}" do
+      city_class.city_id.should_not be_nil
+      city_class.city_id.should eq(city_id)
+    end
+  end
+
+  context 'class methods' do
+    it 'should return an array with pollution data from remote when call `get` method' do
+      data = city_class.get
+      data.should be_a(Array)
+      data.any? {|measure| measure.key? 'AQI'}.should be_true
+    end
+
+    it 'should return an array with clean parsed data clice by ATTRS from remote when call `all` method' do
+      data = city_class.all
+      measure = data.first
+      data.should be_a(Array)
+      measure.keys.should eq(city_class::ATTRS)
+      measure['Conc'].should be_a(Float)
+      measure['AQI'].should be_a(Integer)
+      measure['Desc'].should be_a(String)
+      measure['ReadingDateTime'].should be_a(DateTime)
+    end
+
+    it 'should return the latest parsed data clice by ATTRS from remote when call `last` method' do
+      data = city_class.last
+      data.should be_a(Hash)
+      data.keys.should eq(city_class::ATTRS)
+      data['Conc'].should be_a(Float)
+      data['AQI'].should be_a(Integer)
+      data['Desc'].should be_a(String)
+      data['ReadingDateTime'].should be_a(DateTime)
+    end
+
+    it 'should return URI::HTTP object own context when call `uri` method' do
+      uri = city_class.uri
+      uri.should be_a(URI::HTTP)
+      uri.host.should eq('www.stateair.net')
+      uri.path.should eq("/web/rss/1/#{city_id}.xml")
+    end
+
+    it 'should return url string with own context when call `url` method' do
+      city_class.url.should be_a(String)
+      city_class.url.should eq("http://www.stateair.net/web/rss/1/#{city_id}.xml")
+    end
+  end
+end
+
+
+describe PM25::Beijing do
+  include_examples "city common examples", PM25::Beijing, '1'
+end
+
+describe PM25::Chengdu do
+  include_examples "city common examples", PM25::Chengdu, '2'
+end
+
+describe PM25::Guangzhou do
+  include_examples "city common examples", PM25::Guangzhou, '3'
+end
+
+describe PM25::Shanghai do
+  include_examples "city common examples", PM25::Shanghai, '4'
+end
+
+describe PM25::Shenyang do
+  include_examples "city common examples", PM25::Shenyang, '5'
+end

data/spec/pm25_spec.rb

@@ -1,11 +1,7 @@
 require 'spec_helper'
 
-describe Pm25 do
+describe PM25 do
   it 'should have a version number' do
-    Pm25::VERSION.should_not be_nil
-  end
-
-  it 'should do something useful' do
-    false.should be_false
+    PM25::VERSION.should_not be_nil
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'pm25'
+require 'rspec/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pm25
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Xuhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,8 @@ files:
 - lib/pm25/exceptions.rb
 - lib/pm25/version.rb
 - pm25.gemspec
+- spec/pm25/base_spec.rb
+- spec/pm25/cities_spec.rb
 - spec/pm25_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -131,5 +133,7 @@ signing_key:
 specification_version: 4
 summary: PM2.5 reporting from U.S. Consulate
 test_files:
+- spec/pm25/base_spec.rb
+- spec/pm25/cities_spec.rb
 - spec/pm25_spec.rb
 - spec/spec_helper.rb