api_object 0.4.1 → 0.5.1

data/README.md

@@ -120,10 +120,10 @@ The [geo_ip gem](https://github.com/jeroenj/geo_ip) retrieves location as:
 To get the data, call "get_results_by_ip" instead of "get_results":
 
 ```
-data = Weather.get_results_by_ip('99.156.82.20', KEY, :weather => :zip_code)
+data = Weather.get_results_by_ip('99.156.82.20', :key => <KEY>, :weather => :zip_code)
 ```
 
-The third parameter in the function is to define what fields from the location object are passed as what parameter. In this case, the original function is:
+The function takes parameters to define what fields from the location object are passed as what parameter. In this case, "zip_code" field is passed as "weather" parameter and the original function is:
 
 ```
 data = Weather.get_results(:weather => '99.156.82.20')

data/lib/api_object/version.rb

@@ -1,3 +1,3 @@
 module ApiObject
-  VERSION = "0.4.1" 
+  VERSION = "0.5.1" 
 end

data/lib/api_object.rb

@@ -16,13 +16,14 @@ module ActiveApi
           self.url, self.action, self.key, self.mode, self.url_options, self.data_tags, self.object_name = [options[:url], options[:action], options[:key], options[:mode], (options[:url_options] || {}), ([*options[:data_tags]] || []), (options[:object_name] || self.to_s.downcase.gsub(/^(.+::)(.+)$/, '\2'))]
           instance_eval do
           
-             def get_results_by_ip ip, key, arguments = {}
-                self.api_key = key
+             def get_results_by_ip ip, arguments = {}
+                self.api_key = arguments.delete(:key) if arguments[:key]
                 location = GeoIp.geolocation(ip)
                 raise unless location[:status_code] == "OK"
                 get_results [*arguments.keys].inject({}) { |opts, a| opts.merge(a.to_sym => location[arguments[a.to_sym]]) }
                 rescue
                   puts "WARNING: Cannot get results or location by ip. Verify that you have a valid key for the ipinfodb.com service"
+                  return {}
              end
           
              def get_results options = {}
@@ -39,6 +40,10 @@ module ActiveApi
                 GeoIp.api_key = key
              end
              
+             def api_key
+                GeoIp.api_key
+             end
+                       
              def warning_invalid_url url
                "The request url is #{url}, please, check if it's invalid of there is no connectivity." unless url.nil?
              end

data/test/unit/api_object_test.rb

@@ -22,6 +22,7 @@ class ApiObjectTest < MiniTest::Unit::TestCase
   @@weather_au = Weather.load_from_xml(File.read(@@weather_directory + '/austin.xml'))
   @@ip_key = File.read(@@key_directory + "/ipinfodb_key.txt") rescue ENV['API_KEY']
   IP = '99.156.82.20'
+  GeoIp.api_key = nil
   
   @@muni_routes = Route.load_from_xml(File.read(@@bus_directory + "/muni_routes.xml"))
   @@muni_F = Route.load_from_xml(File.read(@@bus_directory + "/muni_F.xml"))
@@ -58,12 +59,25 @@ class ApiObjectTest < MiniTest::Unit::TestCase
     assert_equal(weather_au, @@weather_au)
   end
   
+  
   def test_should_get_correct_weather_by_ip
     unless @@ip_key.nil?
-      weather_au = Weather.new(Weather.get_results_by_ip(IP, @@ip_key, :weather => :zip_code))
+      weather_au = Weather.new(Weather.get_results_by_ip(IP, :key => @@ip_key, :weather => :zip_code))
       assert_equal(weather_au, @@weather_au)
     end
   end
+   
+  def test_should_get_correct_weather_with_key_preset
+    GeoIp.api_key = @@ip_key
+    weather_au = Weather.new(Weather.get_results_by_ip(IP, :weather => :zip_code))
+    assert_equal(weather_au, @@weather_au)
+  end
+  
+  def test_should_not_get_correct_weather_with_no_key
+    GeoIp.api_key = nil
+    weather_au = Weather.new(Weather.get_results_by_ip(IP, :weather => :zip_code))
+    assert_empty(weather_au)
+  end
 
   def test_should_get_correct_bus_routes
     routes = Route.get_results(:a => 'sf-muni', :command => 'routeList').map {|r| Route.new(r)}
@@ -84,7 +98,6 @@ class ApiObjectTest < MiniTest::Unit::TestCase
     assert(routes.empty?, "Routes should be an empty object")
   end
   
-  
 private  
   
   #ensure that the estimates of the first station include the sample

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_object
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &74590500 !ruby/object:Gem::Requirement
+  requirement: &74735810 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74590500
+  version_requirements: *74735810
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74590190 !ruby/object:Gem::Requirement
+  requirement: &74735560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74590190
+  version_requirements: *74735560
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &74589880 !ruby/object:Gem::Requirement
+  requirement: &74735340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74589880
+  version_requirements: *74735340
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &74589580 !ruby/object:Gem::Requirement
+  requirement: &74735110 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74589580
+  version_requirements: *74735110
 - !ruby/object:Gem::Dependency
   name: nori
-  requirement: &74589270 !ruby/object:Gem::Requirement
+  requirement: &74734810 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *74589270
+  version_requirements: *74734810
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &74589020 !ruby/object:Gem::Requirement
+  requirement: &74734530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *74589020
+  version_requirements: *74734530
 - !ruby/object:Gem::Dependency
   name: geo_ip
-  requirement: &74588820 !ruby/object:Gem::Requirement
+  requirement: &74734330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74588820
+  version_requirements: *74734330
 description: An interface to load objects from external APIs provided in XML and JSON
   formats
 email: