spyke 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25dd79a32574d3585c1f3823b1306458bc1b389b
-  data.tar.gz: a644d3fba35342f673d257bea9e1ce2f1f324ca0
+  metadata.gz: 2a430604d1097764cd8add4c5b0f44161e5939d4
+  data.tar.gz: af8c8efb25d69ee8555510408edc393b5f8d1e5d
 SHA512:
-  metadata.gz: a796e6db458d43dc92511cbc877493fa43a7280ced8d843f4150bf3fabb3f598fd433f949fc310c34489e709d02f94564e8fe52d34f6f7e07912ab77595c4a4f
-  data.tar.gz: a6fe1f3e863c4aa305cff5b4cde884e9666c0ea0bbf90c3a4f103d220a9f42114af1061bae3fcf20ba956a2f301a648a06d04af6a3d3894c8c3cd5312046abd3
+  metadata.gz: 805690aac305cad08aeb0d8f34a63ca17aab8296080d42c51cb9f23117679592c3e8e1addf867595e2d1f82e19ad7607a06b1e2b6c8adf99b7dd4c2a3625d551
+  data.tar.gz: 8337033aea0abef30be2ce84d83e80c947ee643eb3a0214fb6637f8a1404b36c5f1f67c7d02e06b0429aa027010d737aa8a705f9bf92c6cc87d6a199b886892b

data/README.md

@@ -167,6 +167,24 @@ remap it in Faraday to match the above. Doing this will allow you to
 show errors returned from the server in forms and f.ex using
 `@post.errors.full_messages` just like ActiveRecord.
 
+### Error handling and fallbacks
+
+Should the API fail to connect or time out, a `Spyke::ConnectionError` will be raised.
+If you need to recover gracefully from connection problems, you can
+either rescue that exception or use the `with_fallback` feature:
+
+```ruby
+# API is down
+Article.all # => Spyke::ConnectionError
+Article.with_fallback.all # => []
+
+Article.find(1) # => Spyke::ConnectionError
+Article.with_fallback.find(1) # => nil
+
+article = Article.with_fallback(Article.new(title: "Dummy")).find(1)
+article.title # => "Dummy"
+```
+
 ### Attributes-wrapping
 
 Spyke, like Rails, by default wraps sent attributes in a root element,

data/circle.yml

@@ -1,3 +1,3 @@
 machine:
   ruby:
-    version: 2.1.5
+    version: 2.2.2

data/lib/spyke/exceptions.rb

@@ -1,3 +1,4 @@
 module Spyke
   class ResourceNotFound < StandardError; end
+  class ConnectionError < StandardError; end
 end

data/lib/spyke/http.rb

@@ -22,14 +22,7 @@ module Spyke
 
       def request(method, path, params = {})
         ActiveSupport::Notifications.instrument('request.spyke', method: method) do |payload|
-          response = connection.send(method) do |request|
-            if method == :get
-              request.url path.to_s, params
-            else
-              request.url path.to_s
-              request.body = params
-            end
-          end
+          response = send_request(method, path, params)
           payload[:url], payload[:status] = response.env.url, response.status
           Result.new_from_response(response)
         end
@@ -49,6 +42,19 @@ module Spyke
 
       private
 
+        def send_request(method, path, params)
+          connection.send(method) do |request|
+            if method == :get
+              request.url path.to_s, params
+            else
+              request.url path.to_s
+              request.body = params
+            end
+          end
+          rescue Faraday::ConnectionFailed, Faraday::TimeoutError
+            raise ConnectionError
+        end
+
         def scoped_request(method)
           uri = new.uri
           params = current_scope.params.except(*uri.variables)

data/lib/spyke/relation.rb

@@ -9,7 +9,10 @@ module Spyke
     delegate :to_ary, :[], :any?, :empty?, :last, :size, :metadata, to: :find_some
 
     def initialize(klass, options = {})
-      @klass, @options, @params = klass, options, {}
+      @klass = klass
+      @options = options
+      @params = {}
+      @should_fallback = false
     end
 
     def where(conditions = {})
@@ -27,6 +30,12 @@ module Spyke
       where
     end
 
+    def with_fallback(fallback = nil)
+      @should_fallback = true
+      @fallback = fallback
+      where
+    end
+
     # Overrides Enumerable find
     def find(id)
       scoping { klass.find(id) }
@@ -34,10 +43,14 @@ module Spyke
 
     def find_one
       @find_one ||= klass.new_instance_from_result(fetch)
+    rescue ConnectionError => error
+      fallback_or_reraise(error, default: nil)
     end
 
     def find_some
       @find_some ||= klass.new_collection_from_result(fetch)
+    rescue ConnectionError => error
+      fallback_or_reraise(error, default: [])
     end
 
     def each(&block)
@@ -65,5 +78,17 @@ module Spyke
       ensure
         klass.current_scope = previous
       end
+
+      def fallback_or_reraise(error, default:)
+        if should_fallback?
+          @fallback || default
+        else
+          raise error
+        end
+      end
+
+      def should_fallback?
+        @should_fallback
+      end
   end
 end

data/lib/spyke/scoping.rb

@@ -7,7 +7,7 @@ module Spyke
 
     module ClassMethods
       delegate :where, :build, :any?, :empty?, to: :all
-      delegate :with, to: :all
+      delegate :with, :with_fallback, to: :all
 
       def all
         current_scope || Relation.new(self, uri: uri)

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '4.1.1'
+  VERSION = '5.0.0'
 end

data/test/fallbacks_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+module Spyke
+  class FallbacksTest < MiniTest::Test
+    def setup
+      stub_request(:get, "http://sushi.com/recipes/1").to_timeout
+      stub_request(:get, "http://sushi.com/recipes?published=true").to_timeout
+    end
+
+    def test_find_with_default_fallback
+      assert_raises ResourceNotFound do
+        Recipe.with_fallback.find(1)
+      end
+    end
+
+    def test_find_with_custom_fallback
+      dummy_recipe = Recipe.new(title: "Dummy Recipe")
+
+      result = Recipe.with_fallback(dummy_recipe).find(1)
+
+      assert_equal "Dummy Recipe", result.title
+    end
+
+    def test_find_one_with_default_fallback
+      recipe = Recipe.with_fallback.where(id: 1).find_one
+
+      assert_equal nil, recipe
+    end
+
+    def test_find_some_with_default_fallback
+      assert_equal [], Recipe.where(published: true).with_fallback.all.to_a
+    end
+
+    def test_find_some_with_custom_fallback
+      dummy_result = [Recipe.new(title: "Dummy Recipe")]
+
+      result = Recipe.where(published: true).with_fallback(dummy_result).all
+
+      assert_equal "Dummy Recipe", result.first.title
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -293,6 +293,7 @@ files:
 - test/attributes_test.rb
 - test/callbacks_test.rb
 - test/custom_request_test.rb
+- test/fallbacks_test.rb
 - test/orm_test.rb
 - test/path_test.rb
 - test/scopes_test.rb
@@ -319,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Interact with REST services in an ActiveRecord-like manner
@@ -328,6 +329,7 @@ test_files:
 - test/attributes_test.rb
 - test/callbacks_test.rb
 - test/custom_request_test.rb
+- test/fallbacks_test.rb
 - test/orm_test.rb
 - test/path_test.rb
 - test/scopes_test.rb