epa_uv_index 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in epa_uv_index.gemspec
+gemspec
+
+gem 'httparty'
+
+group :development, :test do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Greg Gershman
+
+MIT License
+
+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,47 @@
+# EpaUvIndex
+
+This is a really simple Ruby client library for accessing the U.S. EPA's UV Index REST API (information here: http://www.epa.gov/enviro/facts/services.html#uvindex)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'epa_uv_index'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install epa_uv_index
+
+## Usage
+
+Retrieve UV indexes for:
+
+Hourly, by zip code
+
+    $ EpaUvIndex::Client.hourly_for(:zip => 21209)
+
+Hourly, by city/state
+
+    $ EpaUvIndex::Client.hourly_for(:city => 'Baltimore', :state => 'md')
+    
+Daily, by zip code
+
+    $ EpaUvIndex::Client.daily_for(:zip => 21209)
+
+Daily, by city/state
+
+    $ EpaUvIndex::Client.daily_for(:city => 'Baltimore', :state => 'md')
+    
+Missing parameters or bad HTTP responses result in Exceptions being raised.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+
+  desc "Run all examples"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w[--color]
+    t.pattern = 'spec/*_spec.rb'
+  end
+rescue LoadError
+end

data/epa_uv_index.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epa_uv_index/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "epa_uv_index"
+  gem.version       = EpaUvIndex::VERSION
+  gem.authors       = ["Greg Gershman"]
+  gem.email         = ["greg@shelrick.com"]
+  gem.description   = %q{Ruby client library for accessing the U.S. EPA's UV Index API (http://www.epa.gov/enviro/facts/services.html#uvindex)'}
+  gem.summary       = %q{Get UV Index values by daily and hourly for zip code or city/state}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/epa_uv_index/version.rb

@@ -0,0 +1,3 @@
+module EpaUvIndex
+  VERSION = "0.0.1"
+end

data/lib/epa_uv_index.rb

@@ -0,0 +1,56 @@
+require "epa_uv_index/version"
+require 'httparty'
+require 'json'
+
+module EpaUvIndex
+  class Client
+    
+    HOURLY_BASE_URL = "http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY"
+    DAILY_BASE_URL = "http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY"
+    
+    def self.hourly_for(params)
+      begin
+        do_request(HOURLY_BASE_URL, params)
+      rescue Exception => e
+        raise e
+      end
+    end
+  
+    def self.daily_for(params)
+      begin
+        do_request(DAILY_BASE_URL, params)
+      rescue Exception => e
+        raise e
+      end
+    end
+  
+    protected
+  
+    def self.do_request(base_url, params)
+      raise Exception("Please provide either a city/state or a zip code.") unless params[:zip] or (params[:city] and params[:state])
+      request_url = build_request_url(base_url, params)
+      http_response = HTTParty.get(request_url)
+      begin
+        evaluate_response(http_response)
+      rescue Exception => e
+        raise e
+      end      
+    end
+  
+    def self.build_request_url(base_url, params)
+      if params[:zip]
+        "#{base_url}/ZIP/#{params[:zip]}/json"
+      else
+        "#{base_url}/CITY/#{params[:city]}/STATE/#{params[:state]}/json"
+      end
+    end
+  
+    def self.evaluate_response(http_response)
+      if http_response.code == 200
+        return JSON.parse(http_response.body)
+      else
+        raise http_response.message
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,206 @@
+require 'spec_helper'
+
+describe EpaUvIndex::Client do
+  
+  describe "#daily_for" do
+    context "when querying for a daily UV index for a zip code" do
+      context "when the response is good" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[{"ZIP_CODE":21209,"UV_INDEX":3,"UV_ALERT":0}]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/ZIP/21209/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.daily_for(:zip => '21209')
+          response.is_a?(Array).should be_true
+          response.first["ZIP_CODE"].should == 21209
+          response.first["UV_INDEX"].should == 3
+          response.first["UV_ALERT"].should == 0
+        end
+      end
+    
+      context "when the response is empty" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/ZIP/21209/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.daily_for(:zip => '21209')
+          response.is_a?(Array).should be_true
+          response.should be_empty
+        end
+      end
+    
+      context "when the status code is not 200" do
+        before do
+          response = mock(Object)
+          response.stub!(:code).and_return 406
+          response.stub!(:message).and_return "Error Message"
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/ZIP/21209/json").and_return response
+        end
+      
+        it "should raise an exception" do
+          lambda { EpaUvIndex::Client.daily_for(:zip => '21209')}.should raise_error "Error Message"
+        end
+      end
+    end
+
+    context "when querying for a daily UV index for a city/state" do
+      context "when the response is good" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[{"CITY":"BALTIMORE","STATE":"MD","UV_INDEX":4,"UV_ALERT":0}]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/CITY/Baltimore/STATE/md/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.daily_for(:city => 'Baltimore', :state => 'md')
+          response.is_a?(Array).should be_true
+          response.first["CITY"].should == "BALTIMORE"
+          response.first["STATE"].should == "MD"
+          response.first["UV_INDEX"].should == 4
+          response.first["UV_ALERT"].should == 0
+        end
+      end
+    
+      context "when the response is empty" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/CITY/Baltimore/STATE/md/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.daily_for(:city => 'Baltimore', :state => 'md')
+          response.is_a?(Array).should be_true
+          response.should be_empty
+        end
+      end
+    
+      context "when the status code is not 200" do
+        before do
+          response = mock(Object)
+          response.stub!(:code).and_return 406
+          response.stub!(:message).and_return "Error Message"
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/CITY/baltimore/STATE/md/json").and_return response
+        end
+      
+        it "should raise an exception" do
+          lambda { EpaUvIndex::Client.daily_for(:city => 'baltimore', :state => 'md')}.should raise_error "Error Message"
+        end
+      end    
+    end
+  end
+  
+  describe "#hourly_for" do
+    context "when querying for an hourly UV index for a zip code" do
+      context "when the response is good" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[{"ORDER":1,"ZIP":21209,"DATE_TIME":"OCT/09/2012 06 AM","UV_VALUE":0},{"ORDER":2,"ZIP":21209,"DATE_TIME":"OCT/09/2012 07 AM","UV_VALUE":0},{"ORDER":3,"ZIP":21209,"DATE_TIME":"OCT/09/2012 08 AM","UV_VALUE":0},{"ORDER":4,"ZIP":21209,"DATE_TIME":"OCT/09/2012 09 AM","UV_VALUE":0},{"ORDER":5,"ZIP":21209,"DATE_TIME":"OCT/09/2012 10 AM","UV_VALUE":2},{"ORDER":6,"ZIP":21209,"DATE_TIME":"OCT/09/2012 11 AM","UV_VALUE":1},{"ORDER":7,"ZIP":21209,"DATE_TIME":"OCT/09/2012 12 PM","UV_VALUE":2},{"ORDER":8,"ZIP":21209,"DATE_TIME":"OCT/09/2012 01 PM","UV_VALUE":2},{"ORDER":9,"ZIP":21209,"DATE_TIME":"OCT/09/2012 02 PM","UV_VALUE":1},{"ORDER":10,"ZIP":21209,"DATE_TIME":"OCT/09/2012 03 PM","UV_VALUE":1},{"ORDER":11,"ZIP":21209,"DATE_TIME":"OCT/09/2012 04 PM","UV_VALUE":0},{"ORDER":12,"ZIP":21209,"DATE_TIME":"OCT/09/2012 05 PM","UV_VALUE":0},{"ORDER":13,"ZIP":21209,"DATE_TIME":"OCT/09/2012 06 PM","UV_VALUE":0},{"ORDER":14,"ZIP":21209,"DATE_TIME":"OCT/09/2012 07 PM","UV_VALUE":0},{"ORDER":15,"ZIP":21209,"DATE_TIME":"OCT/09/2012 08 PM","UV_VALUE":0},{"ORDER":16,"ZIP":21209,"DATE_TIME":"OCT/09/2012 09 PM","UV_VALUE":0},{"ORDER":17,"ZIP":21209,"DATE_TIME":"OCT/09/2012 10 PM","UV_VALUE":0},{"ORDER":18,"ZIP":21209,"DATE_TIME":"OCT/09/2012 11 PM","UV_VALUE":0},{"ORDER":19,"ZIP":21209,"DATE_TIME":"OCT/09/2012 12 AM","UV_VALUE":0},{"ORDER":20,"ZIP":21209,"DATE_TIME":"OCT/09/2012 01 AM","UV_VALUE":0},{"ORDER":21,"ZIP":21209,"DATE_TIME":"OCT/09/2012 02 AM","UV_VALUE":0}]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/ZIP/21209/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.hourly_for(:zip => '21209')
+          response.is_a?(Array).should be_true
+          response.size.should == 21
+          response.each_with_index do |value, index|
+            value["ORDER"].should == index + 1
+            value["ZIP"].should == 21209
+            value["DATE_TIME"].should =~ /OCT\/09\/2012/
+            value["UV_VALUE"].is_a?(Integer).should be_true
+          end
+        end
+      end
+    
+      context "when the response is empty" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/ZIP/21209/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.hourly_for(:zip => '21209')
+          response.is_a?(Array).should be_true
+          response.should be_empty
+        end
+      end
+    
+      context "when the status code is not 200" do
+        before do
+          response = mock(Object)
+          response.stub!(:code).and_return 406
+          response.stub!(:message).and_return "Error Message"
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/ZIP/21209/json").and_return response
+        end
+      
+        it "should raise an exception" do
+          lambda { EpaUvIndex::Client.hourly_for(:zip => '21209')}.should raise_error "Error Message"
+        end
+      end      
+    end
+    
+    context "when query for an hourly UV index for a city/state" do
+      context "when the response is good" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[{"SEQUENCE":1,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 06 AM","UV_VALUE":0},{"SEQUENCE":2,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 07 AM","UV_VALUE":0},{"SEQUENCE":3,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 08 AM","UV_VALUE":0},{"SEQUENCE":4,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 09 AM","UV_VALUE":0},{"SEQUENCE":5,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 10 AM","UV_VALUE":1},{"SEQUENCE":6,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 11 AM","UV_VALUE":1},{"SEQUENCE":7,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 12 PM","UV_VALUE":2},{"SEQUENCE":8,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 01 PM","UV_VALUE":2},{"SEQUENCE":9,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 02 PM","UV_VALUE":1},{"SEQUENCE":10,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 03 PM","UV_VALUE":1},{"SEQUENCE":11,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 04 PM","UV_VALUE":0},{"SEQUENCE":12,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 05 PM","UV_VALUE":0},{"SEQUENCE":13,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 06 PM","UV_VALUE":0},{"SEQUENCE":14,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 07 PM","UV_VALUE":0},{"SEQUENCE":15,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 08 PM","UV_VALUE":0},{"SEQUENCE":16,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 09 PM","UV_VALUE":0},{"SEQUENCE":17,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 10 PM","UV_VALUE":0},{"SEQUENCE":18,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 11 PM","UV_VALUE":0},{"SEQUENCE":19,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 12 AM","UV_VALUE":0},{"SEQUENCE":20,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 01 AM","UV_VALUE":0},{"SEQUENCE":21,"CITY":"BALTIMORE","STATE":"MD","DATE_TIME":"OCT/09/2012 02 AM","UV_VALUE":0}]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/CITY/Baltimore/STATE/md/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.hourly_for(:city => 'Baltimore', :state => 'md')
+          response.is_a?(Array).should be_true
+          response.size.should == 21
+          response.each_with_index do |value, index|
+            value["SEQUENCE"].should == index + 1
+            value["CITY"].should == "BALTIMORE"
+            value["STATE"].should == "MD"
+            value["DATE_TIME"].should =~ /OCT\/09\/2012/
+            value["UV_VALUE"].is_a?(Integer).should be_true
+          end
+        end
+      end
+    
+      context "when the response is empty" do
+        before do
+          response = mock(Object)
+          response.stub!(:body).and_return '[]'
+          response.stub!(:code).and_return 200
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/CITY/Baltimore/STATE/md/json").and_return response
+        end
+
+        it "should return an array for a daily zip code request" do
+          response = EpaUvIndex::Client.hourly_for(:city => 'Baltimore', :state => 'md')
+          response.is_a?(Array).should be_true
+          response.should be_empty
+        end
+      end
+    
+      context "when the status code is not 200" do
+        before do
+          response = mock(Object)
+          response.stub!(:code).and_return 406
+          response.stub!(:message).and_return "Error Message"
+          HTTParty.should_receive(:get).with("http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/CITY/baltimore/STATE/md/json").and_return response
+        end
+      
+        it "should raise an exception" do
+          lambda { EpaUvIndex::Client.hourly_for(:city => 'baltimore', :state => 'md')}.should raise_error "Error Message"
+        end
+      end      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'rubygems'
+require 'bundler/setup'
+require 'epa_uv_index'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: epa_uv_index
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Greg Gershman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client library for accessing the U.S. EPA's UV Index API (http://www.epa.gov/enviro/facts/services.html#uvindex)'
+email:
+- greg@shelrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- epa_uv_index.gemspec
+- lib/epa_uv_index.rb
+- lib/epa_uv_index/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Get UV Index values by daily and hourly for zip code or city/state
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb