api_object 0.5.1 → 0.6.0

data/README.md

@@ -129,7 +129,16 @@ The function takes parameters to define what fields from the location object are
 data = Weather.get_results(:weather => '99.156.82.20')
 ```
 
-7) Testing
+7) Error handling
+
+In case data cannot be retrived (possible causes might be a wrong url or service downtime), the object returned is empty. Error messages could be checked using functions errors and has_errors?
+
+```
+station.has_errors? 
+errors = station.errors
+```
+
+8) Testing
 
 The gem has been tested on BART, Google Weather and NextBus APIs. 
 
@@ -143,9 +152,10 @@ 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. 
 
-8) Limitations
+9) Limitations
 
 * Api data must be presented either in XML or in JSON format. The distinction between XML and JSON is determinted automatically. 
+* Location by ip service uses a free database which is not always reliable. 
 * When using this gem with external APIs, check Terms and Conditions of the API usage. 
 * If something is not working, feel free to submit bugs and or/contribute. 
   

data/lib/api_object/version.rb

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

data/lib/api_object.rb

@@ -4,17 +4,19 @@ require "active_support/all"
 require "geo_ip"
 
 module ActiveApi
-      
+        
     module ClassMethods 
-    
+          
       def self.extended(base)
         base.send(:extend, Query)     
       end
               
       def initialize_from_api options = {}
+        
           class_attribute :url, :action, :key, :mode, :url_options, :data_tags, :object_name
           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, arguments = {}
                 self.api_key = arguments.delete(:key) if arguments[:key]
@@ -22,8 +24,8 @@ module ActiveApi
                 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 {}
+                  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)
              end
           
              def get_results options = {}
@@ -32,8 +34,8 @@ module ActiveApi
                result = query_api(self.url, self.action, self.mode, self.url_options.merge(options))
                process_result result
                rescue
-                 puts "WARNING: The request returned no valid data. #{warning_invalid_url result[:url]}"
-                 return {}
+                 puts "ERROR: The request returned no valid data. #{error_invalid_url result[:url]}"
+                 return ApiObjectError.new(:class => self, :errors => invalid_url_msg)
              end 
              
              def api_key=(key)
@@ -44,9 +46,21 @@ module ActiveApi
                 GeoIp.api_key
              end
                        
-             def warning_invalid_url url
+             def error_invalid_url url
                "The request url is #{url}, please, check if it's invalid of there is no connectivity." unless url.nil?
              end
+             
+             def invalid_url_msg
+               "Cannot get results from the url"
+             end
+             
+             def invalid_loc_msg
+               "Cannot obtain results by ip, check the location"
+             end
+             
+             def invalid_data_msg
+               "Cannot initialize the object"
+             end
                                           
              private
              def process_result result
@@ -74,9 +88,10 @@ module ActiveApi
    end
    
    module InstanceMethods
-            
+                
       def initialize(*args)
           url = args.first.delete(:url)
+          errors = args.first.delete(:errors)
           tags = respond_to?('data_tags') ? self.data_tags : args.last[:tags]
           args.first.each do |k, v| 
              k = k.gsub(/@/, '')
@@ -87,11 +102,18 @@ module ActiveApi
                 instance_variable_set("@#{k.to_s}", result)
              end
           end if args.first.is_a?(Hash)
-          puts "WARNING: data passed for #{self.class} initialization was invalid. #{self.class.warning_invalid_url url}" if self.empty?
+          if self.empty?
+            puts "ERROR: data passed for #{self.class} initialization was invalid. #{self.class.error_invalid_url url}" 
+            @errors = errors || self.class.invalid_data_msg
+          end
       end
       
       def empty?
-          self.instance_variables.empty?
+          (self.instance_variables - [:@errors]).empty?
+      end
+      
+      def has_errors?
+        self.instance_variables.include?(:@errors)
       end
             
             
@@ -142,8 +164,41 @@ module ActiveApi
        class_attribute :columns, :assoc 
        self.columns, self.assoc = [{}, {}]
        
-    end
+       attr_reader :errors
+       
+    end 
     
-      
+    class ApiObjectError < Hash
+        attr_reader :errors, :klass
+        
+        def initialize *args
+          options = args.extract_options!
+          @errors = options.delete(:errors)
+          @klass = options.delete(:class)
+        end
+                
+        def keys
+          [:errors]
+        end
+        
+        def [](key)
+          eval("self.#{key.to_s}") if keys.include?(key)
+        end
+        
+        def map &block
+          klass.new({:errors => @errors})
+        end
+        
+        alias_method :collect, :map
+        
+        def inspect
+          "ApiObjectError: #{@errors}"
+        end
+        
+        def to_s
+          inspect
+        end
+    end 
+       
   end
-             
+          

data/test/unit/api_object_test.rb

@@ -8,11 +8,15 @@ class ApiObjectTest < MiniTest::Unit::TestCase
   include ActiveApi
   include TestObjects
   
+  IP = '99.156.82.20'
+  GeoIp.api_key = nil 
+  
   @@data_directory = File.expand_path('../../data', __FILE__)
   @@estimate_directory = @@data_directory + "/estimate"
   @@weather_directory = @@data_directory + "/weather"
   @@bus_directory = @@data_directory + "/bus"
   @@key_directory = @@data_directory +"/keys"
+  
 
   @@glen_estimate = Station.load_from_xml(File.read(@@estimate_directory + '/glen.xml'))    
   @@sixteenth_estimate = Station.load_from_xml(File.read(@@estimate_directory + '/sixteenth.xml'))
@@ -21,8 +25,6 @@ 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'))
   @@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"))
@@ -64,6 +66,7 @@ class ApiObjectTest < MiniTest::Unit::TestCase
     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
    
@@ -71,33 +74,44 @@ class ApiObjectTest < MiniTest::Unit::TestCase
     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
-  
+   
   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)}
     assert_equal_route_list(routes, @@muni_routes)
+    routes.map {|r| refute_has_errors(r)}
   end
-  
+
   def test_should_get_correct_route_information
     route_F = Route.new(Route.get_results(:a => 'sf-muni', :command => 'routeConfig', :r => 'F', :mode => 'terse'))
     assert_equal(route_F, @@muni_F)
+    refute_has_errors(route_F)
   end
-   
+
   def test_should_handle_invalid_url
-    estimate = Station.new(Station.get_results(:orig => 'YES'))
+    estimate = Station.new(Station.get_results(:orig => 'YES'))  
     assert(estimate.empty?, "Estimate should be an empty object")
+    assert_has_errors(estimate)
+    assert(estimate.errors, Station.invalid_url_msg)
     weather = Weather.new(Weather.get_results(:weather => "Here"))
     assert(weather.empty?, "Weather should be an empty object")
-    routes = Route.get_results(:a => 'sffg').map {|r| Route.new(r)}
+    assert_has_errors(weather)
+    assert(weather.errors, Weather.invalid_data_msg)
+    routes = Route.get_results(:a => 'sffg').collect {|r| Route.new(r)}
     assert(routes.empty?, "Routes should be an empty object")
+    assert_has_errors(routes)
+    assert(routes.errors, Route.invalid_url_msg)
   end
   
+  
 private  
   
   #ensure that the estimates of the first station include the sample
@@ -119,6 +133,14 @@ private
     return assert(route_list.include_all?(sample_route_list), "Route list should include all the sample routes")
   end
   
+  def assert_has_errors obj
+    return assert(obj.has_errors?, "Object should have errors")
+  end
+  
+  def refute_has_errors obj
+    return refute(obj.has_errors?, "Object shouldn't have errors")
+  end
+  
     
   def business_time? now
     unless now.to_date.sunday? 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_object
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000 Z
+date: 2012-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &74735810 !ruby/object:Gem::Requirement
+  requirement: &76922910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74735810
+  version_requirements: *76922910
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74735560 !ruby/object:Gem::Requirement
+  requirement: &76922660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74735560
+  version_requirements: *76922660
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &74735340 !ruby/object:Gem::Requirement
+  requirement: &77001800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74735340
+  version_requirements: *77001800
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &74735110 !ruby/object:Gem::Requirement
+  requirement: &77001550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74735110
+  version_requirements: *77001550
 - !ruby/object:Gem::Dependency
   name: nori
-  requirement: &74734810 !ruby/object:Gem::Requirement
+  requirement: &77001240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *74734810
+  version_requirements: *77001240
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &74734530 !ruby/object:Gem::Requirement
+  requirement: &77000930 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *74734530
+  version_requirements: *77000930
 - !ruby/object:Gem::Dependency
   name: geo_ip
-  requirement: &74734330 !ruby/object:Gem::Requirement
+  requirement: &77000700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74734330
+  version_requirements: *77000700
 description: An interface to load objects from external APIs provided in XML and JSON
   formats
 email: