restful_resource 0.9.7 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d61d5fddf5237bc8ecc817ecbcd12e62ed2a2d3
-  data.tar.gz: 6c09b612c6aeef9038616b10f0fd71f504f0da07
+  metadata.gz: b226b8051b7fd554302f9bd01818e989ed038b82
+  data.tar.gz: 1fc72ed03e190e72dd6d2218c002f09a8cc97486
 SHA512:
-  metadata.gz: 4b670c8eb7a54839ebacc287b232b556e18e18ab34366e2e7de1cf983c70fd8decca035e04cb29dc15329a8c6e91fbabb2d59df61f2edbcb9f5c95b09a251c00
-  data.tar.gz: 8b003a527dda9636ff65bece04dd3ca1b57c89b7fe5b9dc46734f199c933dbefe7fef43e73a40a13cd3e9c928bc424c689976d744c54b53bedc061fc2606d998
+  metadata.gz: 7c1ee3d6f785bef9ef6e02960413dfa8b7ab58be0894c6dd50ec8446559a24b1d17f7da83ae70480fff36e42bc763f24074953a5e6cdada66204afc3f90dfdd6
+  data.tar.gz: e1df5b650b4e77f65b775b760537aaa42d7820a6757a84c77ab3c21ddcd92f6a42062cf5260b84c60954d0421f5a5997411a3d0da797492cb29cc7f12331a9b9

data/lib/restful_resource.rb

@@ -18,5 +18,5 @@ require_relative 'restful_resource/response'
 require_relative 'restful_resource/http_client'
 require_relative 'restful_resource/associations'
 require_relative 'restful_resource/rails_validations'
+require_relative 'restful_resource/redirections'
 require_relative 'restful_resource/base'
-

data/lib/restful_resource/base.rb

@@ -2,17 +2,17 @@ module RestfulResource
   class Base < OpenObject
     extend RestfulResource::Associations
 
-    def self.configure(base_url: nil, 
-                       username: nil, 
-                       password: nil, 
-                       logger: nil, 
+    def self.configure(base_url: nil,
+                       username: nil,
+                       password: nil,
+                       logger: nil,
                        cache_store: nil)
 
       @base_url = URI.parse(base_url)
 
-      @http = RestfulResource::HttpClient.new(username: username, 
-                                              password: password, 
-                                              logger: logger, 
+      @http = RestfulResource::HttpClient.new(username: username,
+                                              password: password,
+                                              logger: logger,
                                               cache_store: cache_store)
     end
 
@@ -51,6 +51,7 @@ module RestfulResource
       url = collection_url(params)
 
       response = http.post(url, data: data)
+
       self.new(parse_json(response.body))
     end
 
@@ -73,7 +74,7 @@ module RestfulResource
         next_page = 1
         begin
           resources = self.where(conditions.merge(page: next_page))
-          resources.each do |resource| 
+          resources.each do |resource|
             y << resource
           end
           next_page = resources.next_page
@@ -95,6 +96,11 @@ module RestfulResource
       result
     end
 
+    def self.collection_url(params)
+      url = merge_url_paths(base_url, @resource_path, @action_prefix)
+      replace_parameters(url, params)
+    end
+
     private
     def self.merge_url_paths(uri, *paths)
       uri.merge(paths.compact.join('/')).to_s
@@ -106,11 +112,6 @@ module RestfulResource
       replace_parameters(url, params)
     end
 
-    def self.collection_url(params)
-      url = merge_url_paths(base_url, @resource_path, @action_prefix)
-      replace_parameters(url, params)
-    end
-
     def self.new_collection(json)
       json.map do |element|
         self.new(element)

data/lib/restful_resource/http_client.rb

@@ -46,8 +46,6 @@ module RestfulResource
         b.response :encoding
         b.use :gzip
 
-        b.use FaradayMiddleware::FollowRedirects
-
         b.adapter :net_http
       end
     end

data/lib/restful_resource/redirections.rb

@@ -0,0 +1,48 @@
+module RestfulResource
+  class MaximumAttemptsReached < StandardError
+    def message
+      "The maximum attempts limit was reached before the resource was ready"
+    end
+  end
+
+  module Redirections
+    def self.included(base)
+      base.instance_eval do
+        def post(data: {}, delay: 0.5, max_attempts: 10, **params)
+          url = collection_url(params)
+
+          response = self.accept_redirected_result(response: http.post(url, data: data), delay: delay, max_attempts: max_attempts)
+
+          self.new(parse_json(response.body))
+        end
+
+        private
+        def self.accept_redirected_result(response:, delay:, max_attempts:)
+          new_response = response
+          if response.status == 303
+            attempts = 0
+            resource_location = response.headers[:location]
+
+            RestfulResource::Redirections.wait(delay)
+            new_response = http.get(resource_location)
+
+            while (new_response.status == 202) && (attempts < max_attempts)
+              attempts += 1
+              RestfulResource::Redirections.wait(delay)
+              new_response = http.get(resource_location)
+            end
+
+            if attempts == max_attempts
+              raise RestfulResource::MaximumAttemptsReached
+            end
+          end
+          response = new_response
+        end
+      end
+    end
+
+    def self.wait(seconds)
+      Kernel.sleep(seconds)
+    end
+  end
+end

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '0.9.7'
+  VERSION = '0.10.0'
 end

data/spec/fixtures.rb

@@ -28,6 +28,12 @@ class TestB < BaseB
   self.resource_path "testb"
 end
 
+class ModelWithRedirections < RestfulResource::Base
+  include RestfulResource::Redirections
+
+  resource_path 'model_with_redirections'
+end
+
 module ComplicatedModule
   class Parent < BaseA
     resource_path "parent"

data/spec/restful_resource/redirections_spec.rb

@@ -0,0 +1,88 @@
+require_relative '../spec_helper'
+
+describe RestfulResource::Redirections do
+  before :each do
+    @mock_http = double("mock_http")
+    allow(RestfulResource::Base).to receive(:http).and_return(@mock_http)
+    RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/')
+  end
+
+  describe "#post" do
+    let(:data) { {data: 123} }
+
+    subject { ModelWithRedirections.post(data: data) }
+
+    context 'with a 200 response' do
+      it 'should behave as usual' do
+        expected_response = RestfulResource::Response.new(body: {test_data: 42}.to_json)
+        expect_post("http://api.carwow.co.uk/model_with_redirections", expected_response, data: data)
+
+        expect(subject.test_data).to eq 42
+      end
+    end
+
+    context 'with a redirect to resource location' do
+      let(:redirect_target) { 'http://api.carwow.co.uk/model_with_redirections/123' }
+
+      before(:each) do
+        allow(RestfulResource::Redirections).to receive(:wait)
+        expected_redirect_response = RestfulResource::Response.new(body: 'You are being redirected', status: 303, headers: { location: redirect_target})
+        expect_post("http://api.carwow.co.uk/model_with_redirections", expected_redirect_response, data: data)
+      end
+
+      it 'should get the resource from the new location' do
+        expected_get_response = RestfulResource::Response.new(body: {test_data: 42}.to_json, status: 200)
+        expect_get(redirect_target, expected_get_response)
+
+        expect(subject.test_data).to eq 42
+      end
+
+      it 'should wait 0.5 seconds after first redirect' do
+        expected_get_response = RestfulResource::Response.new(body: {test_data: 42}.to_json, status: 200)
+
+        expect(RestfulResource::Redirections).to receive(:wait).with(0.5).ordered
+        expect_get(redirect_target, expected_get_response).ordered
+
+        expect(subject.test_data).to eq 42
+      end
+
+      it 'should wait 0.5 between retries' do
+        resource_not_ready_get_response = RestfulResource::Response.new(body: 'pending', status: 202)
+        resource_ready_get_response = RestfulResource::Response.new(body: {test_data: 42}.to_json, status: 200)
+
+        expect(RestfulResource::Redirections).to receive(:wait).with(0.5).ordered
+        expect_get(redirect_target, resource_not_ready_get_response).ordered
+        expect(RestfulResource::Redirections).to receive(:wait).with(0.5).ordered
+        expect_get(redirect_target, resource_ready_get_response).ordered
+
+        expect(subject.test_data).to eq 42
+      end
+
+      it 'should retry 10 times by default' do
+        resource_not_ready_get_response = RestfulResource::Response.new(body: 'pending', status: 202)
+        resource_ready_get_response = RestfulResource::Response.new(body: {test_data: 42}.to_json, status: 200)
+
+        9.times do
+          expect(RestfulResource::Redirections).to receive(:wait).with(0.5).ordered
+          expect_get(redirect_target, resource_not_ready_get_response).ordered
+        end
+        expect(RestfulResource::Redirections).to receive(:wait).with(0.5).ordered
+        expect_get(redirect_target, resource_ready_get_response).ordered
+
+        expect(subject.test_data).to eq 42
+      end
+
+      it 'raise after max_retries value is reached' do
+        resource_not_ready_get_response = RestfulResource::Response.new(body: 'pending', status: 202)
+        resource_ready_get_response = RestfulResource::Response.new(body: {test_data: 42}.to_json, status: 200)
+
+        11.times do
+          expect(RestfulResource::Redirections).to receive(:wait).with(0.5).ordered
+          expect_get(redirect_target, resource_not_ready_get_response).ordered
+        end
+
+        expect{subject}.to raise_error(RestfulResource::MaximumAttemptsReached)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.10.0
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,6 +174,7 @@ files:
 - lib/restful_resource/paginated_array.rb
 - lib/restful_resource/parameter_missing_error.rb
 - lib/restful_resource/rails_validations.rb
+- lib/restful_resource/redirections.rb
 - lib/restful_resource/resource_id_missing_error.rb
 - lib/restful_resource/response.rb
 - lib/restful_resource/version.rb
@@ -185,6 +186,7 @@ files:
 - spec/restful_resource/http_client_spec.rb
 - spec/restful_resource/open_object_spec.rb
 - spec/restful_resource/rails_validations_spec.rb
+- spec/restful_resource/redirections_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.github.com/carwow/restful_resource
 licenses:
@@ -219,4 +221,5 @@ test_files:
 - spec/restful_resource/http_client_spec.rb
 - spec/restful_resource/open_object_spec.rb
 - spec/restful_resource/rails_validations_spec.rb
+- spec/restful_resource/redirections_spec.rb
 - spec/spec_helper.rb