sunwatch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc61d157134686bb9e81364c4e6256c8c19cfa76
+  data.tar.gz: cbd1035338fb569bff8d9b19f978eed5f6ed65b2
+SHA512:
+  metadata.gz: b0fde179369635f18a32b9f6bf381d067f0dc953c9d45ff8fedcfe1a623193a18016c5ef09acb3f06280e0d1550fff6eefa06d9ba27382f3125e40f33fc2801c
+  data.tar.gz: fe3c0d01527cfd07b15ef4da21eae03902816cbd4728871d0b146a92247e622e2b2353c02ee44804f2b97449a24bb944fbdb3e16622f5db863ab1364d4641e5a

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason Stenhouse
+
+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,40 @@
+## Sunwatch
+
+Provides daily or hourly UV information for the US by zipcode or city/state. UV data is provided by the EPA.
+
+### Usage
+
+Daily UV info:
+
+    require 'sunwatch'
+
+    Sunwatch.daily_uv_info_for(city: 'Seattle', state: 'WA')
+    # or
+    Sunwatch.daily_uv_info_for(zipcode: '98103')
+
+    # return type
+    uv_info = Sunwatch.daily_uv_info_for(zipcode: '98103')
+    uv_info.zipcode  # => 98103
+    uv_info.uv_index # => 3
+    uv_info.uv_alert # => 1
+
+Hourly UV info:
+
+    require 'sunwatch'
+
+    Sunwatch.hourly_uv_info_for(city: 'Seattle', state: 'WA')
+    Sunwatch.hourly_uv_info_for(zipcode: '98103')
+
+    # return type
+    uv_info = Sunwatch.hourly_uv_info_for(zipcode: '98103')
+    uv_info.zipcode # => 98103
+    
+    uv_info.hours.each do |hour|
+
+## Contributing
+
+1. [Fork it](https://github/jstenhouse/sunwatch/fork)
+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 a new Pull Request

data/lib/sunwatch.rb

@@ -0,0 +1,5 @@
+require 'sunwatch/version'
+require 'sunwatch/errors'
+require 'sunwatch/response'
+require 'sunwatch/client'
+require 'sunwatch/sunwatch'

data/lib/sunwatch/client.rb

@@ -0,0 +1,70 @@
+require 'httparty'
+require 'json'
+
+module Sunwatch
+  class Client
+
+    EPA_UV_URI = 'http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUV'
+
+    def self.uv_info_for(opts)
+      url = build_url(opts)
+      response = HTTParty.get(url)
+      raise_unavailable_error if response.code != 200
+      build_response(JSON.parse(response.body))
+    rescue HTTParty::Error => e
+      raise_unavailable_error(e.message)
+    end
+
+    private
+
+    def self.build_response(response)
+      if response.size == 1
+        build_daily_response(response.first)
+      else
+        build_hourly_response(response)
+      end
+    end
+
+    def self.build_daily_response(response)
+      Sunwatch::Response.new(city: response['CITY'],
+                             state: response['STATE'],
+                             zipcode: response['ZIP_CODE'],
+                             uv_index: response['UV_INDEX'],
+                             uv_alert: response['UV_ALERT'])
+    end
+
+    def self.build_hourly_response(response)
+      hours = []
+      response.each do |hour|
+        hours << { datetime: hour['DATE_TIME'], uv_value: hour['UV_VALUE'] }
+      end
+      Sunwatch::Response.new(city: response.first['CITY'],
+                             state: response.first['STATE'],
+                             zipcode: response.first['ZIP'], # wat. API uses ZIP for hourly, and ZIP_CODE for daily
+                             hours: hours)
+    end
+
+    def self.raise_unavailable_error(msg = '')
+      raise Sunwatch::UnavailableError.new("UV Index info is unavailable: #{msg}")
+    end
+
+    def self.build_url(opts)
+      uri_timewindow = build_url_timewindow(opts)
+      uri_location = build_url_location(opts)
+      "#{EPA_UV_URI}#{uri_timewindow}/#{uri_location}/json"
+    end
+
+    def self.build_url_timewindow(opts)
+      opts[:timewindow] == :daily ? 'DAILY' : 'HOURLY'
+    end
+
+    def self.build_url_location(opts)
+      if opts[:zipcode]
+        "ZIP/#{opts[:zipcode]}"
+      else
+        "CITY/#{opts[:city]}/STATE/#{opts[:state]}"
+      end
+    end
+
+  end
+end

data/lib/sunwatch/errors.rb

@@ -0,0 +1,4 @@
+module Sunwatch
+  class ConfigurationError < StandardError; end
+  class UnavailableError < StandardError; end
+end

data/lib/sunwatch/response.rb

@@ -0,0 +1,46 @@
+module Sunwatch
+  class Response
+    Hour = Struct.new(:datetime, :uv_value)
+
+    attr_accessor :city, :state, :zipcode, :uv_index, :uv_alert, :hours
+
+    def initialize(opts)
+      @city     = opts[:city]
+      @state    = opts[:state]
+      @zipcode  = opts[:zipcode]
+      @uv_index = opts[:uv_index]
+      @uv_alert = opts[:uv_alert]
+      if opts[:hours]
+        @hours = []
+        opts[:hours].each do |hour|
+          @hours << Hour.new(to_datetime(hour[:datetime]), hour[:uv_value])
+        end
+      end
+    end
+
+    def hourly?
+      @hours != nil
+    end
+
+    def daily?
+      @hours == nil
+    end
+
+    def ==(other)
+      self.class == other.class &&
+      @city == other.city &&
+      @state == other.state &&
+      @zipcode == other.zipcode &&
+      @uv_index == other.uv_index &&
+      @uv_alert == other.uv_alert &&
+      @hours == other.hours
+    end
+
+    private
+
+    def to_datetime(str_datetime)
+      # OCT/19/2014 05 AM
+      DateTime.strptime(str_datetime, "%b/%d/%Y %I %p")
+    end
+  end
+end

data/lib/sunwatch/sunwatch.rb

@@ -0,0 +1,40 @@
+module Sunwatch
+  def self.daily_uv_info_for(opts = {})
+    validate_opts!(opts)
+    opts[:zipcode] = opts[:zipcode].to_s if opts[:zipcode] # allow integers
+    opts[:timewindow] = :daily
+    Sunwatch::Client.uv_info_for(opts)
+  end
+
+  def self.hourly_uv_info_for(opts = {})
+    validate_opts!(opts)
+    opts[:zipcode] = opts[:zipcode].to_s if opts[:zipcode] # allow integers
+    opts[:timewindow] = :hourly
+    Sunwatch::Client.uv_info_for(opts)
+  end
+
+  private
+
+  def self.validate_opts!(opts)
+    if opts[:zipcode]
+      validate_string_or_number!(:zipcode, opts[:zipcode])
+    elsif opts[:city] && opts[:state]
+      validate_string!(:city, opts[:city])
+      validate_string!(:state, opts[:state])
+    else
+      raise ConfigurationError.new('city/state or zipcode must be provided')
+    end
+  end
+
+  def self.validate_string!(opt, value)
+    unless value.respond_to?(:to_str)
+      raise ConfigurationError.new("#{opt.to_s} must be a string")
+    end
+  end
+
+  def self.validate_string_or_number!(opt, value)
+    unless value.respond_to?(:to_str) || value.respond_to?(:to_int)
+      raise ConfigurationError.new("#{opt.to_s} must be a string or integer")
+    end
+  end
+end

data/lib/sunwatch/version.rb

@@ -0,0 +1,3 @@
+module Sunwatch
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'webmock/rspec'
+require 'sunwatch'

data/spec/sunwatch/client_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Sunwatch::Client do
+  
+  describe '.uv_info_for' do
+
+    let(:daily_zipcode_json_response) { '[{"ZIP_CODE":12345,"UV_INDEX":2,"UV_ALERT":0}]' }
+    let(:daily_zipcode_response) { Sunwatch::Response.new(zipcode: 12345, uv_index: 2, uv_alert: 0) }
+
+    let(:daily_citystate_json_response) { '[{"CITY":"WASHINGTON","STATE":"DC","UV_INDEX":3,"UV_ALERT":1}]' }
+    let(:daily_citystate_response) { Sunwatch::Response.new(city: 'WASHINGTON', state: 'DC', uv_index: 3, uv_alert: 1) }
+
+    let(:hourly_zipcode_json_response) { '[{"ORDER":1,"ZIP":12345,"DATE_TIME":"OCT/18/2014 04 AM","UV_VALUE":0},{"ORDER":2,"ZIP":12345,"DATE_TIME":"OCT/18/2014 05 AM","UV_VALUE":1}]' }
+    let(:hourly_zipcode_response) { Sunwatch::Response.new(zipcode: 12345, hours: [{datetime: 'OCT/18/2014 04 AM', uv_value: 0}, {datetime: 'OCT/18/2014 05 AM', uv_value: 1}]) }
+    
+    let(:hourly_citystate_json_response) { '[{"SEQUENCE":1,"CITY":"SEATTLE","STATE":"WA","DATE_TIME":"OCT/19/2014 04 AM","UV_VALUE":0},{"SEQUENCE":2,"CITY":"SEATTLE","STATE":"WA","DATE_TIME":"OCT/19/2014 05 AM","UV_VALUE":1}]' }
+    let(:hourly_citystate_response) { Sunwatch::Response.new(city: 'SEATTLE', state: 'WA', hours: [{datetime: 'OCT/19/2014 04 AM', uv_value: 0}, {datetime: 'OCT/19/2014 05 AM', uv_value: 1}]) }
+
+    before do
+      stub_request(:get, 'http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/ZIP/12345/json').to_return(body: daily_zipcode_json_response)
+      stub_request(:get, 'http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/CITY/Seattle/STATE/WA/json').to_return(body: daily_citystate_json_response)
+      stub_request(:get, 'http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/ZIP/12345/json').to_return(body: hourly_zipcode_json_response)
+      stub_request(:get, 'http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/CITY/Seattle/STATE/WA/json').to_return(body: hourly_citystate_json_response)
+    end
+
+    context 'a daily timewindow' do
+      context 'with zipcode' do
+        it 'fetches uv index info' do
+          response = Sunwatch::Client.uv_info_for(timewindow: :daily, zipcode: '12345')
+          expect(response).to eq(daily_zipcode_response)
+        end
+      end
+
+      context 'with city/state' do
+        it 'fetches uv index info' do
+          response = Sunwatch::Client.uv_info_for(timewindow: :daily, city: 'Seattle', state: 'WA')
+          expect(response).to eq(daily_citystate_response)
+        end
+      end
+    end
+
+    context 'an hourly timewindow' do
+      context 'with zipcode' do
+        it 'fetches uv index info' do
+          response = Sunwatch::Client.uv_info_for(timewindow: :hourly, zipcode: '12345')
+          expect(response).to eq(hourly_zipcode_response)
+        end
+      end
+
+      context 'with city/state' do
+        it 'fetches uv index info' do
+          response = Sunwatch::Client.uv_info_for(timewindow: :hourly, city: 'Seattle', state: 'WA')
+          expect(response).to eq(hourly_citystate_response)
+        end
+      end
+    end
+
+    context 'service unavailable' do
+
+      before do
+        stub_request(:get, 'http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/ZIP/12345/json').to_return( 
+                     :status => ["503", "Temporarily Unavailable"])
+      end
+
+      it 'raises a service unavailable error' do
+        expect { Sunwatch::Client.uv_info_for(timewindow: :hourly, zipcode: '12345') }.to raise_error Sunwatch::UnavailableError
+      end
+    end
+
+  end
+
+  describe '.build_url' do
+    context 'a daily timewindow' do
+      context 'with zipcode' do
+        it 'builds a daily timewindow with zipcode url' do
+          url = Sunwatch::Client.build_url(timewindow: :daily, zipcode: '12345')
+          expect(url).to eq('http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/ZIP/12345/json')
+        end
+      end
+
+      context 'with city/state' do
+        it 'builds a daily timewindow with city/state url' do
+          url = Sunwatch::Client.build_url(timewindow: :daily, city: 'Seattle', state: 'WA')
+          expect(url).to eq('http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVDAILY/CITY/Seattle/STATE/WA/json')
+        end
+      end
+    end
+
+    context 'an hourly timewindow' do
+      context 'with zipcode' do
+        it 'builds an hourly timewindow with zipcode url' do
+          url = Sunwatch::Client.build_url(timewindow: :hourly, zipcode: '12345')
+          expect(url).to eq('http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/ZIP/12345/json')
+        end
+      end
+
+      context 'with city/state' do
+        it 'builds an hourly timewindow with city/state url' do
+          url = Sunwatch::Client.build_url(timewindow: :hourly, city: 'Seattle', state: 'WA')
+          expect(url).to eq('http://iaspub.epa.gov/enviro/efservice/getEnvirofactsUVHOURLY/CITY/Seattle/STATE/WA/json')
+        end
+      end
+    end
+  end
+
+end

data/spec/sunwatch/sunwatch_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Sunwatch do
+
+  describe '.daily_uv_info_for' do
+
+    context 'invalid options' do
+      context 'with only city' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.daily_uv_info_for(city: 'Seattle') }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with only state' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.daily_uv_info_for(state: 'WA') }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with non-string/non-number zipcode' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.daily_uv_info_for(zipcode: Object.new) }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with non-string city' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.daily_uv_info_for(city: 1) }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with non-string state' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.daily_uv_info_for(state: 1) }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+    end
+
+    context 'valid options' do
+      context 'with city and state' do
+        let(:valid_options) { { city: 'Seattle', state: 'WA' } }
+
+        it 'will send appropriate options to client' do
+          expect(Sunwatch::Client).to receive(:uv_info_for) { valid_options.merge(timewindow: :daily) }
+          Sunwatch.daily_uv_info_for(valid_options)
+        end
+      end
+
+      context 'with zipcode' do
+        let(:valid_options) { { zipcode: '12345' } }
+
+        it 'will send appropriate options to client' do
+          expect(Sunwatch::Client).to receive(:uv_info_for) { valid_options.merge(timewindow: :daily) }
+          Sunwatch.daily_uv_info_for(valid_options)
+        end
+      end
+    end
+  end
+
+  describe '.hourly_uv_info_for' do
+
+    context 'invalid options' do
+      context 'with only city' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.hourly_uv_info_for(city: 'Seattle') }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with only state' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.hourly_uv_info_for(state: 'WA') }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with non-string/non-number zipcode' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.hourly_uv_info_for(zipcode: Object.new) }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with non-string city' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.hourly_uv_info_for(city: 1) }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+
+      context 'with non-string state' do
+        it 'raises a configuration error' do
+          expect { Sunwatch.hourly_uv_info_for(state: 1) }.to raise_error Sunwatch::ConfigurationError
+        end
+      end
+    end
+
+    context 'valid options' do
+      context 'with city and state' do
+        let(:valid_options) { { city: 'Seattle', state: 'WA' } }
+
+        it 'will send appropriate options to client' do
+          expect(Sunwatch::Client).to receive(:uv_info_for) { valid_options.merge(timewindow: :hourly) }
+          Sunwatch.hourly_uv_info_for(valid_options)
+        end
+      end
+
+      context 'with zipcode' do
+        let(:valid_options) { { zipcode: '12345' } }
+
+        it 'will send appropriate options to client' do
+          expect(Sunwatch::Client).to receive(:uv_info_for) { valid_options.merge(timewindow: :hourly) }
+          Sunwatch.hourly_uv_info_for(valid_options)
+        end
+      end
+    end
+  end
+
+end

data/sunwatch.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'sunwatch/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'sunwatch'
+  spec.version     = Sunwatch::VERSION
+  spec.summary     = 'Provides EPA UV index information for the US'
+  spec.description = 'Provides EPA UV index information for the US'
+  spec.authors     = ['jstenhouse']
+  spec.email       = 'jason.stenhouse@gmail.com'
+  spec.homepage    = 'https://github.com/jstenhouse/sunwatch'
+  spec.licenses    = ['MIT']
+
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: sunwatch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jstenhouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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'
+description: Provides EPA UV index information for the US
+email: jason.stenhouse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/sunwatch.rb
+- lib/sunwatch/client.rb
+- lib/sunwatch/errors.rb
+- lib/sunwatch/response.rb
+- lib/sunwatch/sunwatch.rb
+- lib/sunwatch/version.rb
+- spec/spec_helper.rb
+- spec/sunwatch/client_spec.rb
+- spec/sunwatch/sunwatch_spec.rb
+- sunwatch.gemspec
+homepage: https://github.com/jstenhouse/sunwatch
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides EPA UV index information for the US
+test_files:
+- spec/spec_helper.rb
+- spec/sunwatch/client_spec.rb
+- spec/sunwatch/sunwatch_spec.rb