flexirest 1.7.3 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4588448f89d5370f5b208ad7185537c4c70fac4d
-  data.tar.gz: b496d2852fdacc8ef9656656e96a5a469419de4e
+  metadata.gz: 5c923ce76f5b90c0bdb2fba0090bf7f7c0e9a8b3
+  data.tar.gz: deb9b3f6c36c9507fbba1a0bd98a485dd1828124
 SHA512:
-  metadata.gz: 055f11c39ba735be43fdb5bebabb77d9c1912fded9cfe0040c06dfe4b12b33f093b8dc60295cb8abf7ccd8bac4ffd40b0729e6b47bd179b262818848e12490d6
-  data.tar.gz: c131e203c28350206d3f18ddaeb0c6610b099f192e8c85d7f29756343da06bdcd1875636067465ff136d750a12ed23d7690bc7bcadead01cc7380f85fe7f2a89
+  metadata.gz: 430b70a85bf6b8d5cd77eb6d6440e55245ef9915ca8adfd5c76d26bde7c4a6c36ecdbc4e7bc5ed9bdb8176191ecf5b1c2c0f9e63a51da0f2f16cf092f2d66f16
+  data.tar.gz: 500dbc7e0637b9f48c9476f6a099fd12815ab21a49fc69357cd30d110378020d1e9710354c21a11215d621e48719ac8f18817be07883e7d818b6d3dcbadcaafd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.7.4
+
+Feature:
+
+- Returning `:retry` or now raising `Flexirest::CallbackRetryRequestException` from a callback will retry the current request.
+
 ## 1.7.3
 
 Bugfix:

data/docs/using-callbacks.md

@@ -88,7 +88,7 @@ end
 
 **Note:** since v1.3.21 the empty response trick above isn't necessary, empty responses for 204 are accepted normally (the method returns `true`), but this is here to show an example of an `after_request` callback adjusting the body. The `cache_all_people` example shows how to cache a response even if the server doesn't send the correct headers.
 
-If you want to trap an error in an `after_request` callback and retry the request, this can be done - but retries will only happen once for each request (so we'd recommend checking all conditions in a single `after_request` and then retrying after fixing them all). You achieve this by returning `:retry` from the callback.
+If you want to trap an error in an `after_request` callback and retry the request, this can be done - but retries will only happen once for each request (so we'd recommend checking all conditions in a single `after_request` and then retrying after fixing them all). You achieve this by raising a `Flexirest::CallbackRetryRequestException` from the callback.
 
 ```ruby
 class Person < Flexirest::Base
@@ -102,7 +102,7 @@ class Person < Flexirest::Base
     if response.status == 401
       # Do something to fix the state of caches/variables used in the 
       # before_request, etc
-      return :retry
+      raise Flexirest::CallbackRetryRequestException.new
     end
   end
 end

data/lib/flexirest/callbacks.rb

@@ -39,7 +39,7 @@ module Flexirest
             return false
           end
           if result == :retry
-            return :retry
+            raise Flexirest::CallbackRetryRequestException.new
           end
         end
       end
@@ -66,4 +66,6 @@ module Flexirest
     end
 
   end
+
+  class CallbackRetryRequestException < Exception ; end
 end

data/lib/flexirest/request.rb

@@ -239,13 +239,14 @@ module Flexirest
           if object_is_class? && @object.record_response?
             @object.record_response(self.url, response_env)
           end
-          if object_is_class?
-            callback_result = @object.send(:_callback_request, :after, @method[:name], response_env)
-          else
-            callback_result = @object.class.send(:_callback_request, :after, @method[:name], response_env)
-          end
 
-          if callback_result == :retry
+          begin
+            if object_is_class?
+              callback_result = @object.send(:_callback_request, :after, @method[:name], response_env)
+            else
+              callback_result = @object.class.send(:_callback_request, :after, @method[:name], response_env)
+            end
+          rescue Flexirest::CallbackRetryRequestException
             if self.retrying != true
               self.retrying = true
               return call()

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.7.3"
+  VERSION = "1.7.4"
 end

data/spec/lib/request_spec.rb

@@ -96,6 +96,11 @@ describe Flexirest::Request do
       base_url "http://www.example.com"
 
       after_request :handle_retries
+      after_request :inner_call
+
+      def self.reset_retries
+        @retries = 0
+      end
 
       def self.incr_retries
         @retries ||= 0
@@ -113,7 +118,17 @@ describe Flexirest::Request do
         end
       end
 
+      def inner_call(name, response)
+        if name == :first_call
+          self.class.incr_retries
+          self.second_call
+          raise Flexirest::CallbackRetryRequestException.new
+        end
+      end
+
       get :do_me_twice, "/do_me_twice"
+      get :first_call, "/first_call"
+      get :second_call, "/second_call"
     end
 
     class LazyLoadedExampleClient < ExampleClient
@@ -908,10 +923,21 @@ describe Flexirest::Request do
   it "should retry if an after_request callback returns :retry" do
     stub_request(:get, "http://www.example.com/do_me_twice").
       to_return(:status => 200, :body => "", :headers => {})
+    RetryingExampleClient.reset_retries
     RetryingExampleClient.do_me_twice
     expect(RetryingExampleClient.retries).to eq(2)
   end
 
+  it "should allow a second call and then retry if an after_request callback returns :retry" do
+    stub_request(:get, "http://www.example.com/first_call").
+      to_return(:status => 200, :body => "", :headers => {})
+    stub_request(:get, "http://www.example.com/second_call").
+      to_return(:status => 200, :body => "", :headers => {})
+    RetryingExampleClient.reset_retries
+    RetryingExampleClient.first_call
+    expect(RetryingExampleClient.retries).to eq(2)
+  end
+
 
   context "Direct URL requests" do
     class SameServerExampleClient < Flexirest::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.7.4
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler