flexirest 1.5.7 → 1.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fff6bddbbfc146aed6bdf17b6cf1e209147828a
-  data.tar.gz: cc6acc2caf6b830ec87453d59d7f0aa7a2aecfbd
+  metadata.gz: 4a4a35ab648cec73d9c6681c296fce8059d39a44
+  data.tar.gz: b5f0ab3f9487c346565cd093993636c10e6f13f8
 SHA512:
-  metadata.gz: 518b298ccea323da131c0d576cce46769f4fb7a98d2e1e4e6a3ec5826f1ef4c5c1804b93ac492c25050c310e680a2919dd3116af11794f9d29fd856a04f9959e
-  data.tar.gz: 05bf183436c1ce77024cebc855229c21d174ee2175472ab8c56ec964c19bef6ebe392f4f2e82dd379f2bcbc3425f4dda6acc9764c8b0bef9dbf109066319088c
+  metadata.gz: 597d1639f2408ae3b5e05676d55ca8ef77a3e5082f62c9b0f11576537cd4314acd5d5cf21456620ede4da36fb8d64fe01040347ebf5e71f115af2909a88437bd
+  data.tar.gz: 6ae9f6fecd5e11adaa70608ce88e717d32aeab7c9d4730912de3f1d1694dd476999e854e657f783a39b877cd926d4ee7f9a51e2b87165c79dc45a2023a531621

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.5.8
+
+Feature:
+
+- Allow retrying after a failure in an `after_request` callback
+
 ## 1.5.7
 
 Bugfix:

data/README.md

@@ -566,6 +566,26 @@ 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.
+
+```ruby
+class Person < Flexirest::Base
+  get :all, "/people"
+
+  after_request :fix_invalid_request
+
+  private
+
+  def fix_invalid_request(name, response)
+    if response.status == 401
+      # Do something to fix the state of caches/variables used in the 
+      # before_request, etc
+      return :retry
+    end
+  end
+end
+```
+
 ### Lazy Loading
 
 Flexirest supports lazy loading (delaying the actual API call until the response is actually used, so that views can be cached without still causing API calls).

data/lib/flexirest/callbacks.rb

@@ -27,13 +27,16 @@ module Flexirest
         callbacks.each do |callback|
           if callback.is_a? Symbol
             if self.respond_to?(callback)
-              self.send(callback, name, param)
+              result = self.send(callback, name, param)
             else
               instance = self.new
-              instance.send(callback, name, param)
+              result = instance.send(callback, name, param)
             end
           else
-            callback.call(name, param)
+            result = callback.call(name, param)
+          end
+          if result == :retry
+            return :retry
           end
         end
       end

data/lib/flexirest/request.rb

@@ -8,7 +8,7 @@ module Flexirest
   class Request
     include AttributeParsing
     include JsonAPIProxy
-    attr_accessor :post_params, :get_params, :url, :path, :headers, :method, :object, :body, :forced_url, :original_url
+    attr_accessor :post_params, :get_params, :url, :path, :headers, :method, :object, :body, :forced_url, :original_url, :retrying
 
     def initialize(method, object, params = {})
       @method                     = method
@@ -211,9 +211,16 @@ module Flexirest
             @object.record_response(self.url, response_env)
           end
           if object_is_class?
-            @object.send(:_callback_request, :after, @method[:name], response_env)
+            callback_result = @object.send(:_callback_request, :after, @method[:name], response_env)
           else
-            @object.class.send(:_callback_request, :after, @method[:name], response_env)
+            callback_result = @object.class.send(:_callback_request, :after, @method[:name], response_env)
+          end
+
+          if callback_result == :retry
+            if self.retrying != true
+              self.retrying = true
+              return call()
+            end
           end
 
           result = handle_response(response_env, cached)

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.5.7"
+  VERSION = "1.5.8"
 end

data/spec/lib/request_spec.rb

@@ -71,6 +71,30 @@ describe Flexirest::Request do
       end)
     end
 
+    class RetryingExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+
+      after_request :handle_retries
+
+      def self.incr_retries
+        @retries ||= 0
+        @retries += 1
+      end
+
+      def self.retries
+        @retries
+      end
+
+      def handle_retries(name, response)
+        if name == :do_me_twice
+          self.class.incr_retries
+          return :retry
+        end
+      end
+
+      get :do_me_twice, "/do_me_twice"
+    end
+
     class LazyLoadedExampleClient < ExampleClient
       base_url "http://www.example.com"
       lazy_load!
@@ -803,6 +827,14 @@ describe Flexirest::Request do
     expect(obj.test).to eq(1)
   end
 
+  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.do_me_twice
+    expect(RetryingExampleClient.retries).to eq(2)
+  end
+
+
   context "Direct URL requests" do
     class SameServerExampleClient < Flexirest::Base
       URL = "http://www.example.com/some/url"

metadata

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