api_object 0.6.0 → 0.7.1

data/README.md

@@ -94,12 +94,12 @@ stations = data.map {|d| Station.new(d)}
 
 6) Getting location based data by ip.
 
+A) Getting location using ipinfodb.com (requires api key)
+
 This gem uses [geo_ip gem](https://github.com/jeroenj/geo_ip) and [ipinfodb.com](http://ipinfodb.com/) webservice to retrieve location based on ip. 
 
 The service requires an API key, in order to get it [register](http://ipinfodb.com/register.php) at the web site. 
 
-Consider making a donation to [ipinfodb.com](http://ipinfodb.com/) at [http://ipinfodb.com/donate.php](http://ipinfodb.com/donate.php).
-
 The [geo_ip gem](https://github.com/jeroenj/geo_ip) retrieves location as:
 
 ```
@@ -125,6 +125,40 @@ data = Weather.get_results_by_ip('99.156.82.20', :key => <KEY>, :weather => :zip
 
 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')
+```
+*This service is allowed to be used only for internal business purposes.* Please, verify with the Terms and Conditions when registering for a key. 
+
+
+B) Getting location using freegeoip.net (requires no key)
+
+As the ipinfodb.com service has limitations in the terms of use, the gem [freegeoip gem](https://github.com/ezkl/freegeoip) is used whenever no api key is provided. Unfortunatelly, their database last update was April 29, 2011. 
+
+The [freegeoip gem](https://github.com/ezkl/freegeoip) retrieves location as:
+
+```
+{
+	"city" => "Round Rock"
+	"region_code" => "TX"
+	"region_name" => "Texas"
+	"metrocode" => "635"
+	"zipcode" => "78681"
+	"longitude" => "-97.7286"
+	"latitude" => "30.5321"
+	"country_code" => "US"
+	"ip" => "99.156.82.20"
+	"country_name" => "United States"
+}
+```
+To get the data, call "get_results_by_ip" instead of "get_results":
+
+```
+data = Weather.get_results_by_ip('99.156.82.20', :weather => :zipcode)
+```
+
+The function takes parameters to define what fields from the location object are passed as what parameter. In this case, "zipcode" field is passed as "weather" parameter and the original function is:
+
 ```
 data = Weather.get_results(:weather => '99.156.82.20')
 ```
@@ -142,7 +176,7 @@ errors = station.errors
 
 The gem has been tested on BART, Google Weather and NextBus APIs. 
 
-To run test by ip location, please, [register](http://ipinfodb.com/register.php) for an API key.
+To run tests by ip location for ipinfodb.com service, please, [register](http://ipinfodb.com/register.php) for an API key.  
 
 The key should be either placed into the test/data/keys/ipinfodb_key.txt file or passed as an environment variable:
 
@@ -152,6 +186,8 @@ API_KEY='<your key>' rake test
 
 There is no existing api key provided with this gem as per the Terms and Conditions of the ipinfodb service. 
 
+If there is no key provided, those tests will be avoided. 
+
 9) Limitations
 
 * Api data must be presented either in XML or in JSON format. The distinction between XML and JSON is determinted automatically. 

data/api_object.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |s|
   s.add_dependency('nori', '>=1.1')
   s.add_dependency('rest-client', '>= 1.6')
   s.add_dependency 'geo_ip'
+  s.add_dependency 'freegeoip'
   
 end

data/lib/api_object.rb

@@ -2,6 +2,7 @@ require "api_object/version"
 require "api_object/query"
 require "active_support/all"
 require "geo_ip"
+require 'freegeoip'
 
 module ActiveApi
         
@@ -19,13 +20,18 @@ module ActiveApi
             
           
              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]]) }
+                self.api_key = arguments.delete(:key) if arguments.include?(:key)
+                if self.api_key
+                  location = GeoIp.geolocation(ip)
+                  raise unless location[:status_code] == "OK"
+                  return get_results [*arguments.keys].inject({}) { |opts, a| opts.merge(a.to_sym => location[arguments[a.to_sym]]) }
+                else
+                  location = FreeGeoIP.locate(ip)
+                  get_results [*arguments.keys].inject({}) { |opts, a| opts.merge(a.to_sym => location[arguments[a.to_sym].to_s]) }
+                end
                 rescue
-                  puts "ERROR: Cannot get results or location by ip. Verify that you have a valid key for the ipinfodb.com service"
-                  return ApiObjectError.new(:class => self, :errors => invalid_loc_msg)
+                  puts "ERROR: Cannot get results or location by ip. Verify that you have a valid key for the location service"
+                 return ApiObjectError.new(:class => self, :errors => invalid_loc_msg)
              end
           
              def get_results options = {}

data/lib/api_object/version.rb

@@ -1,3 +1,3 @@
 module ApiObject
-  VERSION = "0.6.0" 
+  VERSION = "0.7.1" 
 end

data/test/data/weather/round_rock.xml

@@ -0,0 +1,49 @@
+<xml_api_reply version="1">
+	<weather module_id="0" tab_id="0" mobile_row="0" mobile_zipped="1" row="0" section="0">
+		<forecast_information>
+			<city data="Round Rock, TX"/>
+			<postal_code data="78681"/>
+			<latitude_e6 data=""/>
+			<longitude_e6 data=""/>
+			<forecast_date data="2012-06-20"/>
+			<current_date_time data="2012-06-20 22:47:00 +0000"/>
+			<unit_system data="US"/>
+		</forecast_information>
+		<current_conditions>
+			<condition data="Clear"/>
+			<temp_f data="84"/>
+			<temp_c data="29"/>
+			<humidity data="Humidity: 55%"/>
+			<icon data="/ig/images/weather/sunny.gif"/>
+			<wind_condition data="Wind: S at 12 mph"/>
+		</current_conditions>
+		<forecast_conditions>
+			<day_of_week data="Wed"/>
+			<low data="75"/>
+			<high data="90"/>
+			<icon data="/ig/images/weather/chance_of_storm.gif"/>
+			<condition data="Chance of Storm"/>
+			</forecast_conditions>
+		<forecast_conditions>
+			<day_of_week data="Thu"/>
+			<low data="73"/>
+			<high data="95"/>
+			<icon data="/ig/images/weather/chance_of_storm.gif"/>
+			<condition data="Chance of Storm"/>
+		</forecast_conditions>
+		<forecast_conditions>
+			<day_of_week data="Fri"/>
+			<low data="73"/>
+			<high data="97"/>
+			<icon data="/ig/images/weather/mostly_sunny.gif"/>
+			<condition data="Mostly Sunny"/>
+		</forecast_conditions>
+		<forecast_conditions>
+			<day_of_week data="Sat"/>
+			<low data="75"/>
+			<high data="99"/>
+			<icon data="/ig/images/weather/sunny.gif"/>
+			<condition data="Clear"/>
+		</forecast_conditions>
+	</weather>
+</xml_api_reply>

data/test/unit/api_object_test.rb

@@ -24,6 +24,7 @@ class ApiObjectTest < MiniTest::Unit::TestCase
   
   @@weather_mv = Weather.load_from_xml(File.read(@@weather_directory + '/mountain_view.xml'))
   @@weather_au = Weather.load_from_xml(File.read(@@weather_directory + '/austin.xml'))
+  @@weather_rr = Weather.load_from_xml(File.read(@@weather_directory + '/round_rock.xml'))
   @@ip_key = File.read(@@key_directory + "/ipinfodb_key.txt") rescue ENV['API_KEY']
   
   @@muni_routes = Route.load_from_xml(File.read(@@bus_directory + "/muni_routes.xml"))
@@ -53,7 +54,6 @@ class ApiObjectTest < MiniTest::Unit::TestCase
     end
   end
   
-
   def test_should_get_correct_weather
     weather_mv = Weather.new(Weather.get_results(:weather => 'Mountain+View'))
     assert_equal(weather_mv, @@weather_mv)
@@ -62,27 +62,31 @@ class ApiObjectTest < MiniTest::Unit::TestCase
   end
   
   
-  def test_should_get_correct_weather_by_ip
-    unless @@ip_key.nil?
+  # Note that the 2 services give slightly different location
+  def test_should_get_correct_weather_by_ip_with_no_key
+    GeoIp.api_key = nil
+    weather_rr = Weather.new(Weather.get_results_by_ip(IP, :key => nil, :weather => :zipcode))
+    assert_equal(weather_rr, @@weather_rr)
+    refute_has_errors(weather_rr)
+  end
+   
+  def test_should_get_correct_weather_with_key
+    unless @@ip_key.nil? 
       weather_au = Weather.new(Weather.get_results_by_ip(IP, :key => @@ip_key, :weather => :zip_code))
       assert_equal(weather_au, @@weather_au)
       refute_has_errors(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)
-    refute_has_errors(weather_au)
+    unless @@ip_key.nil? 
+      GeoIp.api_key = @@ip_key
+      weather_au = Weather.new(Weather.get_results_by_ip(IP, :weather => :zip_code))
+      assert_equal(weather_au, @@weather_au)
+      refute_has_errors(weather_au)
+    end
   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)
-    assert_has_errors(weather_au)
-  end
 
   def test_should_get_correct_bus_routes
     routes = Route.get_results(:a => 'sf-muni', :command => 'routeList').map {|r| Route.new(r)}
@@ -111,7 +115,7 @@ class ApiObjectTest < MiniTest::Unit::TestCase
     assert(routes.errors, Route.invalid_url_msg)
   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.6.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &76922910 !ruby/object:Gem::Requirement
+  requirement: &80888390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76922910
+  version_requirements: *80888390
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &76922660 !ruby/object:Gem::Requirement
+  requirement: &80888180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76922660
+  version_requirements: *80888180
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &77001800 !ruby/object:Gem::Requirement
+  requirement: &80887970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *77001800
+  version_requirements: *80887970
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &77001550 !ruby/object:Gem::Requirement
+  requirement: &80887760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *77001550
+  version_requirements: *80887760
 - !ruby/object:Gem::Dependency
   name: nori
-  requirement: &77001240 !ruby/object:Gem::Requirement
+  requirement: &80887510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *77001240
+  version_requirements: *80887510
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &77000930 !ruby/object:Gem::Requirement
+  requirement: &80887260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *77000930
+  version_requirements: *80887260
 - !ruby/object:Gem::Dependency
   name: geo_ip
-  requirement: &77000700 !ruby/object:Gem::Requirement
+  requirement: &80886970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *77000700
+  version_requirements: *80886970
+- !ruby/object:Gem::Dependency
+  name: freegeoip
+  requirement: &80886190 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80886190
 description: An interface to load objects from external APIs provided in XML and JSON
   formats
 email:
@@ -113,6 +124,7 @@ files:
 - test/data/estimate/twenty_fourth.xml
 - test/data/weather/austin.xml
 - test/data/weather/mountain_view.xml
+- test/data/weather/round_rock.xml
 - test/unit/api_object_test.rb
 - test/unit/load_from_xml.rb
 - test/unit/route.rb