rdstation-ruby-client 1.2.0 → 2.3.0

data/spec/lib/rdstation/retryable_request_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+class DummyClass
+  include ::RDStation::RetryableRequest
+end
+
+RSpec.describe RDStation::RetryableRequest do
+  let(:subject) { DummyClass.new }
+  describe '.retryable_request' do
+    context 'when authorization has a valid refresh_token and config is provided' do
+      let (:access_token) { 'access_token' }
+      let (:new_access_token) { 'new_access_token' }
+      let (:refresh_token) { 'refresh_token' }
+      let (:auth) do
+         ::RDStation::Authorization.new(access_token: access_token, 
+                                        refresh_token: refresh_token
+                                        )
+      end
+      context 'original request was successful' do
+        it 'yields control to the given block' do
+          expect do |block|
+            subject.retryable_request(auth, &block)
+          end.to yield_with_args(auth)
+        end
+      end
+
+      context 'original request raised a retryable exception' do
+        let (:auth_new_access_token) do
+          ::RDStation::Authorization.new(access_token: new_access_token, 
+                                         refresh_token: refresh_token
+                                         )
+        end 
+
+        let(:new_credentials) do
+          {
+            'access_token' => new_access_token,
+            'expires_in' => 86_400,
+            'refresh_token' => refresh_token
+          }
+        end
+        let(:authentication_client) {instance_double(::RDStation::Authentication) }
+
+        before do
+          RDStation.configure do |config|
+            config.client_id = "123"
+            config.client_secret = "312"
+            config.on_access_token_refresh do
+              'callback code'
+            end
+          end
+          allow(::RDStation::Authentication).to receive(:new)
+                                            .with(no_args)
+                                            .and_return(authentication_client)
+          allow(authentication_client).to receive(:update_access_token)
+                                            .with(auth.refresh_token).
+                                            and_return(new_credentials)
+        end
+
+        it 'refreshes the access_token and retries the request' do
+          dummy_request = double("dummy_request")
+          expect(dummy_request).to receive(:call).twice do |auth|
+            expired_token = ::RDStation::Error::ExpiredAccessToken.new({'error_message' => 'x'})
+            raise expired_token unless auth.access_token == new_access_token
+          end
+        
+          expect(RDStation.configuration.access_token_refresh_callback)
+            .to receive(:call)
+            .once do |authorization|
+              expect(authorization.access_token).to eq new_access_token
+            end
+
+          expect do
+            subject.retryable_request(auth) { |yielded_auth| dummy_request.call(yielded_auth) }
+          end.not_to raise_error
+        end
+
+        context 'and keeps raising retryable exception event after token refreshed' do
+          it 'retries only once' do
+            dummy_request = double("dummy_request")
+            expect(dummy_request).to receive(:call).twice do |_|
+              raise ::RDStation::Error::ExpiredAccessToken.new({'error_message' => 'x'})
+            end
+          
+            expect do
+              subject.retryable_request(auth) { |yielded_auth| dummy_request.call(yielded_auth) }
+            end.to raise_error ::RDStation::Error::ExpiredAccessToken
+          end
+        end
+
+        context 'and access token refresh callback is not set' do
+          before do
+            RDStation.configure do |config|
+              config.on_access_token_refresh(&nil)
+            end
+          end
+
+          it 'executes the refresh and retry without raising an error' do
+            dummy_request = double("dummy_request")
+            expect(dummy_request).to receive(:call).twice do |auth|
+              expired_token = ::RDStation::Error::ExpiredAccessToken.new({'error_message' => 'x'})
+              raise expired_token unless auth.access_token == new_access_token
+            end
+
+            expect do
+              subject.retryable_request(auth) { |yielded_auth| dummy_request.call(yielded_auth) }
+            end.not_to raise_error
+          end
+        end
+      end
+
+      context 'original request raised a non retryable exception' do
+        it 'raises error' do
+          dummy_request = double("dummy_request")
+          expect(dummy_request).to receive(:call).once do |_|
+            raise RuntimeError.new("a non retryable error")
+          end
+        
+          expect do
+            subject.retryable_request(auth) { |yielded_auth| dummy_request.call(yielded_auth) }
+          end.to raise_error RuntimeError
+        end
+      end
+    end
+
+    context 'all legacy scenarios' do
+      let (:access_token) { 'access_token' }
+      let (:auth) { ::RDStation::Authorization.new(access_token: access_token) }
+
+      it 'implement me' do
+        dummy_request = double("dummy_request")
+        expect(dummy_request).to receive(:call).once do |_|
+          raise ::RDStation::Error::ExpiredAccessToken.new({'error_message' => 'x'})
+        end
+      
+        expect do
+          subject.retryable_request(auth) { |yielded_auth| dummy_request.call(yielded_auth) }
+        end.to raise_error ::RDStation::Error::ExpiredAccessToken
+      end
+    end
+
+  end
+end

data/spec/lib/rdstation/webhooks_spec.rb

@@ -1,18 +1,21 @@
 require 'spec_helper'
 
 RSpec.describe RDStation::Webhooks do
-  let(:webhooks_client) { described_class.new('auth_token') }
+  let(:webhooks_client) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: 'access_token'))
+  end
+
   let(:webhooks_endpoint) { 'https://api.rd.services/integrations/webhooks/' }
 
   let(:headers) do
     {
-      'Authorization' => 'Bearer auth_token',
+      'Authorization' => 'Bearer access_token',
       'Content-Type' => 'application/json'
     }
   end
 
   let(:error_handler) do
-    instance_double(RDStation::ErrorHandler, raise_errors: 'mock raised errors')
+    instance_double(RDStation::ErrorHandler, raise_error: 'mock raised errors')
   end
 
   before do
@@ -20,6 +23,11 @@ RSpec.describe RDStation::Webhooks do
   end
 
   describe '#all' do
+    it 'calls retryable_request' do
+      expect(webhooks_client).to receive(:retryable_request)
+      webhooks_client.all
+    end
+
     context 'when the request is successful' do
       let(:webhooks) do
         {
@@ -63,9 +71,9 @@ RSpec.describe RDStation::Webhooks do
           .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
       end
 
-      it 'calls raise_errors on error handler' do
+      it 'calls raise_error on error handler' do
         webhooks_client.all
-        expect(error_handler).to have_received(:raise_errors)
+        expect(error_handler).to have_received(:raise_error)
       end
     end
   end
@@ -74,6 +82,11 @@ RSpec.describe RDStation::Webhooks do
     let(:uuid) { '5408c5a3-4711-4f2e-8d0b-13407a3e30f3' }
     let(:webhooks_endpoint_by_uuid) { webhooks_endpoint + uuid }
 
+    it 'calls retryable_request' do
+      expect(webhooks_client).to receive(:retryable_request)
+      webhooks_client.by_uuid('uuid')
+    end
+
     context 'when the request is successful' do
       let(:webhook) do
         {
@@ -105,9 +118,9 @@ RSpec.describe RDStation::Webhooks do
           .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
       end
 
-      it 'calls raise_errors on error handler' do
+      it 'calls raise_error on error handler' do
         webhooks_client.by_uuid(uuid)
-        expect(error_handler).to have_received(:raise_errors)
+        expect(error_handler).to have_received(:raise_error)
       end
     end
   end
@@ -123,6 +136,11 @@ RSpec.describe RDStation::Webhooks do
       }
     end
 
+    it 'calls retryable_request' do
+      expect(webhooks_client).to receive(:retryable_request)
+      webhooks_client.create('payload')
+    end
+
     context 'when the request is successful' do
       let(:webhook) do
         {
@@ -154,9 +172,9 @@ RSpec.describe RDStation::Webhooks do
           .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
       end
 
-      it 'calls raise_errors on error handler' do
+      it 'calls raise_error on error handler' do
         webhooks_client.create(payload)
-        expect(error_handler).to have_received(:raise_errors)
+        expect(error_handler).to have_received(:raise_error)
       end
     end
   end
@@ -174,6 +192,11 @@ RSpec.describe RDStation::Webhooks do
       }
     end
 
+    it 'calls retryable_request' do
+      expect(webhooks_client).to receive(:retryable_request)
+      webhooks_client.update('uuid', 'payload')
+    end
+
     context 'when the request is successful' do
       let(:updated_webhook) do
         {
@@ -205,9 +228,9 @@ RSpec.describe RDStation::Webhooks do
           .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
       end
 
-      it 'calls raise_errors on error handler' do
+      it 'calls raise_error on error handler' do
         webhooks_client.update(uuid, new_payload)
-        expect(error_handler).to have_received(:raise_errors)
+        expect(error_handler).to have_received(:raise_error)
       end
     end
   end
@@ -216,6 +239,11 @@ RSpec.describe RDStation::Webhooks do
     let(:uuid) { '5408c5a3-4711-4f2e-8d0b-13407a3e30f3' }
     let(:webhooks_endpoint_by_uuid) { webhooks_endpoint + uuid }
 
+    it 'calls retryable_request' do
+      expect(webhooks_client).to receive(:retryable_request)
+      webhooks_client.delete('uuid')
+    end
+
     context 'when the request is successful' do
       before do
         stub_request(:delete, webhooks_endpoint_by_uuid).with(headers: headers).to_return(status: 204)
@@ -234,9 +262,9 @@ RSpec.describe RDStation::Webhooks do
           .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
       end
 
-      it 'calls raise_errors on error handler' do
+      it 'calls raise_error on error handler' do
         webhooks_client.delete(uuid)
-        expect(error_handler).to have_received(:raise_errors)
+        expect(error_handler).to have_received(:raise_error)
       end
     end
   end

data/spec/lib/rdstation_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe RDStation do
+  describe '.configure' do
+    let(:client_id) { 'client_id' }
+    let(:client_secret) { 'client_secret' }
+
+    it 'sets the configuration' do
+      RDStation.configure do |config|
+        config.client_id = client_id
+        config.client_secret = client_secret
+      end
+
+      expect(RDStation.configuration.client_id).to eq client_id
+      expect(RDStation.configuration.client_secret).to eq client_secret
+    end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -116,52 +130,61 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/rdsm-ruby-client-issue-template.md"
 - ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/rdstation-ruby-client.rb
+- lib/rdstation.rb
 - lib/rdstation/api_response.rb
 - lib/rdstation/authentication.rb
+- lib/rdstation/authorization.rb
+- lib/rdstation/builder/field.rb
 - lib/rdstation/client.rb
 - lib/rdstation/contacts.rb
 - lib/rdstation/error.rb
 - lib/rdstation/error/format.rb
 - lib/rdstation/error/formatter.rb
 - lib/rdstation/error_handler.rb
+- lib/rdstation/error_handler/bad_request.rb
 - lib/rdstation/error_handler/conflicting_field.rb
-- lib/rdstation/error_handler/default.rb
 - lib/rdstation/error_handler/expired_access_token.rb
 - lib/rdstation/error_handler/expired_code_grant.rb
 - lib/rdstation/error_handler/invalid_credentials.rb
 - lib/rdstation/error_handler/invalid_event_type.rb
-- lib/rdstation/error_handler/resource_not_found.rb
 - lib/rdstation/error_handler/unauthorized.rb
 - lib/rdstation/events.rb
 - lib/rdstation/fields.rb
+- lib/rdstation/retryable_request.rb
 - lib/rdstation/version.rb
 - lib/rdstation/webhooks.rb
 - rdstation-ruby-client.gemspec
 - spec/lib/rdstation-ruby-client_spec.rb
+- spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
+- spec/lib/rdstation/authorization_spec.rb
+- spec/lib/rdstation/builder/field_spec.rb
+- spec/lib/rdstation/client_spec.rb
 - spec/lib/rdstation/contacts_spec.rb
 - spec/lib/rdstation/error/format_spec.rb
 - spec/lib/rdstation/error/formatter_spec.rb
 - spec/lib/rdstation/error_handler/conflicting_field_spec.rb
-- spec/lib/rdstation/error_handler/default_spec.rb
 - spec/lib/rdstation/error_handler/expired_access_token_spec.rb
 - spec/lib/rdstation/error_handler/expired_code_grant_spec.rb
 - spec/lib/rdstation/error_handler/invalid_credentials_spec.rb
 - spec/lib/rdstation/error_handler/invalid_event_type_spec.rb
-- spec/lib/rdstation/error_handler/resource_not_found_spec.rb
 - spec/lib/rdstation/error_handler/unauthorized_spec.rb
 - spec/lib/rdstation/error_handler_spec.rb
 - spec/lib/rdstation/error_spec.rb
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
+- spec/lib/rdstation/retryable_request_spec.rb
 - spec/lib/rdstation/webhooks_spec.rb
+- spec/lib/rdstation_spec.rb
 - spec/spec_helper.rb
 homepage: http://resultadosdigitais.com.br
 licenses:
@@ -175,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -183,27 +206,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby API wrapper for RD Station
 test_files:
 - spec/lib/rdstation-ruby-client_spec.rb
+- spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
+- spec/lib/rdstation/authorization_spec.rb
+- spec/lib/rdstation/builder/field_spec.rb
+- spec/lib/rdstation/client_spec.rb
 - spec/lib/rdstation/contacts_spec.rb
 - spec/lib/rdstation/error/format_spec.rb
 - spec/lib/rdstation/error/formatter_spec.rb
 - spec/lib/rdstation/error_handler/conflicting_field_spec.rb
-- spec/lib/rdstation/error_handler/default_spec.rb
 - spec/lib/rdstation/error_handler/expired_access_token_spec.rb
 - spec/lib/rdstation/error_handler/expired_code_grant_spec.rb
 - spec/lib/rdstation/error_handler/invalid_credentials_spec.rb
 - spec/lib/rdstation/error_handler/invalid_event_type_spec.rb
-- spec/lib/rdstation/error_handler/resource_not_found_spec.rb
 - spec/lib/rdstation/error_handler/unauthorized_spec.rb
 - spec/lib/rdstation/error_handler_spec.rb
 - spec/lib/rdstation/error_spec.rb
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
+- spec/lib/rdstation/retryable_request_spec.rb
 - spec/lib/rdstation/webhooks_spec.rb
+- spec/lib/rdstation_spec.rb
 - spec/spec_helper.rb