api_cache 0.2.1 → 0.2.2

data/api_cache.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "api_cache"
-  s.version     = "0.2.1"
+  s.version     = "0.2.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Martyn Loughran"]
   s.email       = ["me@mloughran.com"]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency('rspec', "~> 1.0")
-  s.add_development_dependency('fakeweb')
+  s.add_development_dependency('webmock')
   s.add_development_dependency('rake')
   s.add_development_dependency('moneta', "~> 0.6.0")
   s.add_development_dependency('dalli')

data/lib/api_cache.rb

@@ -101,6 +101,7 @@ class APICache
     cache_state = cache.state
 
     if cache_state == :current
+      APICache.logger.debug "APICache #{@key}: Returning from cache"
       cache.get
     else
       begin
@@ -108,15 +109,15 @@ class APICache
         cache.set(value)
         value
       rescue => e
-        APICache.logger.info "Failed to fetch from API - Exception: " \
-          "#{e.class}: #{e.message}"
+        APICache.logger.info "APICache #{@key}: Exception raised (#{e.message} - #{e.class})" \
+
         # No point outputting backgraces for internal APICache errors
         APICache.logger.debug "Backtrace:\n#{e.backtrace.join("\n")}" unless e.kind_of?(APICacheError)
 
         if cache_state == :refetch
           cache.get
         else
-          APICache.logger.warn "Data not available in the cache or from API for key #{@key}"
+          APICache.logger.warn "APICache #{@key}: Data not available in the cache or from API"
           if options.has_key?(:fail)
             fail = options[:fail]
             fail.respond_to?(:call) ? fail.call : fail

data/lib/api_cache/api.rb

@@ -33,7 +33,7 @@ class APICache
     #
     def get
       check_queryable!
-      APICache.logger.debug "Fetching data from the API"
+      APICache.logger.debug "APICache #{@key}: Calling API"
       set_queried_at
       Timeout::timeout(@timeout) do
         if @block
@@ -44,7 +44,7 @@ class APICache
         end
       end
     rescue Timeout::Error => e
-      raise APICache::TimeoutError, "Timed out when calling API (timeout #{@timeout}s)"
+      raise APICache::TimeoutError, "APICache #{@key}: Request timed out (timeout #{@timeout}s)"
     end
 
     private
@@ -56,8 +56,12 @@ class APICache
         # 2xx response code
         response.body
       else
-        raise APICache::InvalidResponse, "InvalidResponse http response: #{response.code}"
+        raise APICache::InvalidResponse, "APICache #{@key}: InvalidResponse http response: #{response.code}"
       end
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+           Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+           Net::ProtocolError, Errno::ECONNREFUSED, SocketError => e
+      raise APICache::InvalidResponse, "APICache #{@key}: Net::HTTP error (#{e.message} - #{e.class})"
     end
 
     def redirecting_get(url)
@@ -71,14 +75,14 @@ class APICache
     def check_queryable!
       if previously_queried?
         if Time.now - queried_at > @period
-          APICache.logger.debug "Queryable: true - retry_time has passed"
+          APICache.logger.debug "APICache #{@key}: Is queryable - retry_time has passed"
         else
-          APICache.logger.debug "Queryable: false - queried too recently"
+          APICache.logger.debug "APICache #{@key}: Not queryable - queried too recently"
           raise APICache::CannotFetch,
             "Cannot fetch #{@key}: queried too recently"
         end
       else
-        APICache.logger.debug "Queryable: true - never used API before"
+        APICache.logger.debug "APICache #{@key}: Is queryable - first query"
       end
     end
 

data/spec/api_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe APICache::API do
   before :each do
-    FakeWeb.register_uri(:get, "http://www.google.com/", :body => "Google")
-    FakeWeb.register_uri(:get, "http://froogle.google.com/", :status => 302, :location => "http://products.google.com")
-    FakeWeb.register_uri(:get, "http://products.google.com/", :body => "Google Product Search")
+    stub_request(:get, "http://www.google.com/").to_return(:body => "Google")
+    stub_request(:get, "http://froogle.google.com/").to_return(:status => 302, :headers => {:location => "http://products.google.com"})
+    stub_request(:get, "http://products.google.com/").to_return(:body => "Google Product Search")
 
     @options = {
       :period => 1,
@@ -41,6 +41,14 @@ describe APICache::API do
       api.get.should =~ /Google Product Search/
     end
 
+    it "should rescue errors thrown by Net::HTTP and raise APICache::InvalidResponse" do
+      stub_request(:get, "http://example.com/").to_raise(Errno::ECONNREFUSED)
+      api = APICache::API.new('http://example.com/', @options)
+      lambda {
+        api.get
+      }.should raise_error(APICache::InvalidResponse, "APICache http://example.com/: Net::HTTP error (Connection refused - Exception from WebMock - Errno::ECONNREFUSED)")
+    end
+
   end
 
   describe "with a block" do

data/spec/integration_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "api_cache" do
   before :each do
-    FakeWeb.register_uri(:get, "http://www.google.com/", :body => "Google")
+    stub_request(:get, "http://www.google.com/").to_return(:body => "Google")
 
     APICache.store = nil
   end
@@ -40,7 +40,7 @@ describe "api_cache" do
       APICache.get('foo', :timeout => 1) do
         sleep 1.1
       end
-    }.should raise_error APICache::TimeoutError, 'Timed out when calling API (timeout 1s)'
+    }.should raise_error APICache::TimeoutError, 'APICache foo: Request timed out (timeout 1s)'
 
     APICache.get('foo', :period => 0) do
       'bar'

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require "spec"
-require "fakeweb"
+require 'webmock/rspec'
 
 $:.push File.join(File.dirname(__FILE__), '..', 'lib')
 require "api_cache"

metadata

@@ -2,7 +2,7 @@
 name: api_cache
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Martyn Loughran
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 +00:00
+date: 2011-03-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: webmock
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false