wunderground_ruby 0.2.0 → 0.3.0

data/README.markdown

@@ -36,13 +36,16 @@ Check out below and test file for more examples.
 
 Standard request breakdown:
 
-	wrapper_object.get_[feature]_and_[another feature]_for(optional_hash,"and/or location string")
+	wrapper_instance.get_[feature]_and_[another feature]_for("location string",optional: "hash", values: "at the end")
 	
 ##Optional Hash
 
-This ugly little guy handles the nonconformists in Wunderground's API request structure. Luckily there are only two of these baddies, and only if you need them. (details below)
+This ugly little guy handles the nonconformists in Wunderground's API request structure and the pervasive request timeout option.
+Luckily there are only three of these baddies, and only if you need them. (details below)
 
-	optional_hash = {lang: "FR", geo_ip:"127.0.0.1"}
+	optional_hash = {lang: "FR", geo_ip:"127.0.0.1", timeout: 20}
+	
+Note: If needing to use these options, please place them as the last parameter(s) to the method call.
 	
 Can you think of a better way to handle these? Pull requests welcome.
 
@@ -72,7 +75,7 @@ Any location string that Wunderground accepts will pass straight through this wr
 	
 For geocoding a specific ip address as the location, just provide an IP like this:
 	
-	w_api.get_alerts_for({geo_ip: "127.0.0.1"})
+	w_api.get_alerts_for(geo_ip: "127.0.0.1")
 	
 This was the quickest workaround to the non-conformity of the auto_ip request format.
 	
@@ -81,14 +84,14 @@ This was the quickest workaround to the non-conformity of the auto_ip request fo
 
 Because the Language modifier in Wunderground's request structure uses a colon, which doesn't jive with the method_missing design, adding a specific language to one request can be done like this:
 
-	w_api.get_forecast_for({lang:"FR"},"France","Paris")
+	w_api.get_forecast_for("France","Paris", lang 'FR')
 
 Also, you can set the default language in the constructor or with a setter.
 
-	w_api = Wunderground.new("apikey",{language: "FR"})
+	w_api = Wunderground.new("apikey",language: "FR")
 	w_api.language = 'FR'
 	w_api.get_forecast_for("France","Paris") #automatically includes /lang:FR/ in the request url, so results will be in French
-	w_api.get_forecast_for({lang:"DE"},"France","Paris") #this will override the French(FR) default with German(DE)
+	w_api.get_forecast_for("France","Paris",lang: 'DE') #this will override the French(FR) default with German(DE)
 	
 ##History and Planner Helpers
 
@@ -101,21 +104,22 @@ to get the history/planner data for this date/location. You may enjoy more flexi
 
 	w_api.get_history_for("20101010","AL","Birmingham")
 	w_api.get_history_for(1.year.ago,"33909")
-	w_api.get_history_for(Date.now, {lang: "FR"}, "France/Paris")
-	w_api.get_history_for(Date.now, {lang: "DE", geo_ip:"123.4.5.6"})
+	w_api.get_history_for(Date.now, "France/Paris",lang: "FR")
+	w_api.get_history_for(Date.now, geo_ip:"123.4.5.6", lang: "FR")
 	w_api.get_planner_for("03150323","AL","Gulf Shores")
-	w_api.get_planner_for(Time.now,Time.now+7.days,{geo_ip: "10.0.0.1"})
+	w_api.get_planner_for(Time.now,Time.now+7.days, geo_ip: "10.0.0.1")
 	w_api.get_planner_for(Time.now,Time.now+7.days,"33030")
 
-.get_history_for and .get_planner_for accepts a string or any Date/Time/DateTime-like object that responds to .strftime("%Y%m%d") to auto-format the date.
+.get_history_for and .get_planner_for accepts a preformatted string or any Date/Time/DateTime-like object that responds to .strftime to auto-format the date.
 
 
-### Other Stuff
+### Request Timeout
 
-wunderground_ruby defaults to a 30 second timeout. You can optionally set your own timeout (in seconds) like so:
+wunderground_ruby defaults to a 30 second timeout. You can optionally set your own timeout (in seconds) in three ways like so:
 
-	w_api = Wunderground.new("apikey",{timeout: 60})
+	w_api = Wunderground.new("apikey",timeout: 60)
     w_api.timeout = 5
+	w_api.get_history_for(1.year.ago, geo_ip: '127.0.0.1', timeout:60)
 
 
 ### Error Handling

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/wunderground.rb

@@ -36,9 +36,9 @@ class Wunderground
 
 protected
 
-  def call(method, params = {})
+  def call(method, timeout)
     raise MissingAPIKey if @api_key.nil?
-    response = self.class.get(base_api_url << method, :timeout => @timeout)
+    response = self.class.get(base_api_url << method, :timeout => (timeout || @timeout))
     begin
       response = JSON.parse(response.body)
     rescue
@@ -56,12 +56,13 @@ protected
     raise NoMethodError, "undefined method: #{method} for Wunderground" unless method.to_s.start_with?("get_") and method.to_s.end_with?("_for") 
     url = method.to_s.gsub("get_","").gsub("_for","").gsub("_and_","/")
     url << "/lang:#{@language}" if @language
-    if args[0].class == Hash
-      url = url.sub(/\/lang:.*/,'') and url << "/lang:#{args[0][:lang]}" if args[0][:lang] 
-      ip_address = args[0][:geo_ip] and args.push("autoip") if args[0][:geo_ip]
-      args.delete_at(0) 
+    if args.last.instance_of? Hash
+      opts = args.pop 
+      url = url.sub(/\/lang:.*/,'') and url << "/lang:#{opts[:lang]}" if opts[:lang] 
+      ip_address = opts[:geo_ip] and args.push("autoip") if opts[:geo_ip]
+      timeout = opts[:timeout]
     end
-    call(url <<'/q/'<< args.join('/') << ".json" << (ip_address.nil? ? '': "?geo_ip=#{ip_address}"))
+    call(url <<'/q/'<< args.join('/') << ".json" << (ip_address ? "?geo_ip=#{ip_address}" : ''),timeout)
   end
 
   class << self

data/test/test_wunderground.rb

@@ -20,15 +20,11 @@ class TestWunderground < Test::Unit::TestCase
       @wunderground = Wunderground.new(@api_key)
       assert_equal(@api_key, @wunderground.api_key)
     end
-    should 'set timeout in constructor' do
-      @wunderground = Wunderground.new(@api_key,{timeout: 60})
+    should 'set timeout and language in constructor' do
+      @wunderground = Wunderground.new(@api_key,timeout: 60, language: 'FR')
       assert_equal(60,@wunderground.timeout)
-    end
-    should 'set language in constructor' do
-      @wunderground = Wunderground.new(@apikey,{language:"FR"})
       assert_equal('FR',@wunderground.language)
     end
-
     should "set an API key from the 'WUNDERGROUND_API_KEY' ENV variable" do
       ENV['WUNDERGROUND_API_KEY'] = @api_key
       @wunderground = Wunderground.new
@@ -59,9 +55,8 @@ class TestWunderground < Test::Unit::TestCase
 
   context "api url" do
     setup do
-      @wunderground = Wunderground.new
-      @wunderground.api_key = '123'
-      @url = "http://api.wunderground.com/api/"
+      @wunderground = Wunderground.new("123")
+      @url = "http://api.wunderground.com/api/123/"
     end
     should "raise exception at empty api key" do
       @wunderground.api_key=nil
@@ -72,83 +67,94 @@ class TestWunderground < Test::Unit::TestCase
     end
 
     should "contain api key" do
-      expect_get(@url+"123/forecast/q/ME/Portland.json",{timeout:30})
+      expect_get(@url+"forecast/q/ME/Portland.json",{timeout:30})
       @wunderground.get_forecast_for("ME","Portland")
     end
     should 'contain multiple Wunderground methods from ruby method' do
-      expect_get(@url+"123/forecast/conditions/q/.json",{timeout: 30})
+      expect_get(@url+"forecast/conditions/q/.json",{timeout: 30})
       @wunderground.get_forecast_and_conditions_for()
     end
     should 'contain language modifier for method with {lang:"code"} hash' do
-      expect_get(@url+"123/forecast/lang:FR/q/ME/Portland.json",{timeout: 30})
-      @wunderground.get_forecast_for({lang:'FR'},"ME","Portland")
+      expect_get(@url+"forecast/lang:FR/q/ME/Portland.json",{timeout: 30})
+      @wunderground.get_forecast_for("ME","Portland", lang: 'FR')
     end
     context 'location parameter' do
       should 'formats query of type array' do
-        expect_get(@url+"123/forecast/q/ME/Portland.json",{timeout: 30})
+        expect_get(@url+"forecast/q/ME/Portland.json",{timeout: 30})
         @wunderground.get_forecast_for("ME","Portland")
       end
       should 'formats query of type string' do
-        expect_get(@url+"123/forecast/q/1234.1234,-1234.1234.json",{timeout: 30})
+        expect_get(@url+"forecast/q/1234.1234,-1234.1234.json",{timeout: 30})
         @wunderground.get_forecast_for("1234.1234,-1234.1234")
-        expect_get(@url+"123/forecast/q/pws:WHAT.json",{timeout: 30})
+        expect_get(@url+"forecast/q/pws:WHAT.json",{timeout: 30})
         @wunderground.get_forecast_for("pws:WHAT")
       end
       should 'formats query of type geo_ip' do
-        expect_get(@url+"123/forecast/q/autoip.json?geo_ip=127.0.0.1",{timeout: 30})
-        @wunderground.get_forecast_for({geo_ip: "127.0.0.1"})
+        expect_get(@url+"forecast/q/autoip.json?geo_ip=127.0.0.1",{timeout: 30})
+        @wunderground.get_forecast_for(geo_ip: "127.0.0.1")
       end
     end
     context 'language support' do
       setup {@wunderground.language = "FR"}
       should 'automatically set language for all location types' do
-        expect_get(@url+"123/forecast/lang:FR/q/pws:KCATAHOE2.json",{timeout: 30})
+        expect_get(@url+"forecast/lang:FR/q/pws:KCATAHOE2.json",{timeout: 30})
         @wunderground.get_forecast_for("pws:KCATAHOE2")
       end
       should 'have optional language override on call' do
-        expect_get(@url+"123/forecast/lang:DE/q/ME/Portland.json",{timeout: 30})
-        @wunderground.get_forecast_for({lang: "DE"},"ME","Portland")
+        expect_get(@url+"forecast/lang:DE/q/ME/Portland.json",{timeout: 30})
+        @wunderground.get_forecast_for("ME","Portland", lang: 'DE')
       end
       should 'pass language through history helper' do
-        expect_get(@url+"123/history_#{Time.now.strftime("%Y%m%d")}/lang:DE/q/ME/Portland.json",{timeout: 30})
-        @wunderground.get_history_for(Time.now,{lang: "DE"},"ME","Portland")
+        expect_get(@url+"history_#{Time.now.strftime("%Y%m%d")}/lang:DE/q/ME/Portland.json",{timeout: 30})
+        @wunderground.get_history_for(Time.now,"ME","Portland",lang: 'DE')
       end
       should 'pass language through planner helper' do
-        expect_get(@url+"123/planner_#{Time.now.strftime("%m%d")}#{(Time.now + 700000).strftime('%m%d')}/lang:DE/q/ME/Portland.json",{timeout: 30})
-        @wunderground.get_planner_for(Time.now,(Time.now+700000),{lang: "DE"},"ME","Portland")
+        expect_get(@url+"planner_#{Time.now.strftime("%m%d")}#{(Time.now + 700000).strftime('%m%d')}/lang:DE/q/ME/Portland.json",{timeout: 30})
+        @wunderground.get_planner_for(Time.now,(Time.now+700000),"ME","Portland", lang: 'DE')
       end
       should 'pass language through planner helper with IP' do
-        expect_get(@url+"123/planner_#{Time.now.strftime('%m%d')}#{(Time.now +  
+        expect_get(@url+"planner_#{Time.now.strftime('%m%d')}#{(Time.now +  
               700000).strftime('%m%d')}/lang:DE/q/autoip.json?geo_ip=127.0.0.1",{timeout: 30})
-        @wunderground.get_planner_for(Time.now,(Time.now+700000),{lang: "DE",geo_ip: "127.0.0.1"})
+        @wunderground.get_planner_for(Time.now,(Time.now+700000),lang: "DE",geo_ip: "127.0.0.1")
       end
     end
     context 'for get_history_for(date,location) helper' do
       should 'pass string dates straight to URL' do
-        expect_get(@url+"123/history_20110121/q/ME/Portland.json",{timeout: 30})
+        expect_get(@url+"history_20110121/q/ME/Portland.json",{timeout: 30})
         @wunderground.get_history_for("20110121","ME","Portland")
       end
       should 'accept Time objects' do
-        expect_get(@url+"123/history_#{Time.now.strftime("%Y%m%d")}/q/ME/Portland.json",{timeout: 30})
+        expect_get(@url+"history_#{Time.now.strftime("%Y%m%d")}/q/ME/Portland.json",{timeout: 30})
         @wunderground.get_history_for(Time.now,"ME","Portland")
       end
       should 'accept Date objects' do
-        expect_get(@url+"123/history_#{Time.now.strftime("%Y%m%d")}/q/ME/Portland.json",{timeout: 30})
+        expect_get(@url+"history_#{Time.now.strftime("%Y%m%d")}/q/ME/Portland.json",{timeout: 30})
         @wunderground.get_history_for(Time.now.to_date,"ME","Portland")
       end
       should 'accept Date object and pass optional hash object' do
-        expect_get(@url+"123/history_#{Time.now.strftime("%Y%m%d")}/q/autoip.json?geo_ip=127.0.0.1",{timeout: 30})
-        @wunderground.get_history_for(Time.now.to_datetime,{geo_ip: '127.0.0.1'})
+        expect_get(@url+"history_#{Time.now.strftime("%Y%m%d")}/lang:FR/q/autoip.json?geo_ip=127.0.0.1",{timeout: 30})
+        @wunderground.get_history_for(Time.now.to_datetime,geo_ip: '127.0.0.1',lang: 'FR')
       end
     end
     context 'for get_planner_for helper' do
       should 'pass string date ranges through' do
-        expect_get(@url+"123/planner_03130323/q/ME/Portland.json",{timeout: 30})
+        expect_get(@url+"planner_03130323/q/ME/Portland.json",timeout: 30)
         @wunderground.get_planner_for("03130323","ME","Portland")
       end
       should 'turn two date objects into a properly formatted string' do
-        expect_get(@url+"123/planner_#{Time.now.strftime('%m%d')}#{(Time.now + 700000).strftime('%m%d')}/q/autoip.json?geo_ip=127.0.0.1",{timeout: 30})
-        @wunderground.get_planner_for(Time.now,(Time.now + 700000),{geo_ip: '127.0.0.1'})
+        expect_get(@url+"planner_#{Time.now.strftime('%m%d')}#{(Time.now +
+         700000).strftime('%m%d')}/lang:FR/q/autoip.json?geo_ip=127.0.0.1",timeout: 30)
+        @wunderground.get_planner_for(Time.now,(Time.now + 700000),geo_ip: '127.0.0.1',lang:'FR')
+      end
+    end
+    context 'timeout passed through optional hash' do
+      should 'work for helper' do
+       expect_get(@url+"planner_#{Time.now.strftime('%m%d')}#{(Time.now+700000).strftime('%m%d')}/lang:FR/q/autoip.json?geo_ip=127.0.0.1",timeout: 60)
+        @wunderground.get_planner_for(Time.now,(Time.now + 700000),geo_ip: '127.0.0.1',lang:'FR',timeout: 60)
+      end
+      should 'work for regular calls' do
+        expect_get(@url+"forecast/q/pws:WHAT.json",timeout: 60)
+        @wunderground.get_forecast_for("pws:WHAT", timeout: 60)
       end
     end
   end
@@ -181,7 +187,7 @@ class TestWunderground < Test::Unit::TestCase
 
   private
 
-    def expect_get(expected_url,expected_options)
+    def expect_get(expected_url,expected_options={})
       Wunderground.expects(:get).with{|url, opts|
         url == expected_url &&
         opts[:timeout] == expected_options[:timeout]

data/wunderground_ruby.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "wunderground_ruby"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Winfred Nadeau"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wunderground_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70237028968260 !ruby/object:Gem::Requirement
+  requirement: &70230066419980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70237028968260
+  version_requirements: *70230066419980
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70237028967400 !ruby/object:Gem::Requirement
+  requirement: &70230066417940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70237028967400
+  version_requirements: *70230066417940
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70237028966500 !ruby/object:Gem::Requirement
+  requirement: &70230066416940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70237028966500
+  version_requirements: *70230066416940
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70237028965620 !ruby/object:Gem::Requirement
+  requirement: &70230066416140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70237028965620
+  version_requirements: *70230066416140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70237028964540 !ruby/object:Gem::Requirement
+  requirement: &70230066415280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70237028964540
+  version_requirements: *70230066415280
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70237028963480 !ruby/object:Gem::Requirement
+  requirement: &70230066414380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *70237028963480
+  version_requirements: *70230066414380
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70237028960840 !ruby/object:Gem::Requirement
+  requirement: &70230066413400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70237028960840
+  version_requirements: *70230066413400
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70237028960200 !ruby/object:Gem::Requirement
+  requirement: &70230066412420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -98,10 +98,10 @@ dependencies:
         version: 0.9.11
   type: :development
   prerelease: false
-  version_requirements: *70237028960200
+  version_requirements: *70230066412420
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70237028959400 !ruby/object:Gem::Requirement
+  requirement: &70230066409800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70237028959400
+  version_requirements: *70230066409800
 - !ruby/object:Gem::Dependency
   name: ruby-debug
-  requirement: &70237028958340 !ruby/object:Gem::Requirement
+  requirement: &70230066409120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70237028958340
+  version_requirements: *70230066409120
 description: A simple ruby API wrapper for interacting with the Wunderground API
 email: winfred.nadeau@gmail.com
 executables: []
@@ -153,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -306578686232459491
+      hash: -2893557894893877548
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: