rdstation-ruby-client 2.1.0 → 2.2.0

data/lib/rdstation/error_handler.rb

@@ -13,6 +13,8 @@ module RDStation
       raise error_class, array_of_errors.first if error_class < RDStation::Error
 
       error_class.new(array_of_errors).raise_error
+    rescue JSON::ParserError => error
+      raise error_class, { 'error_message' => response.body }
     end
 
     private

data/lib/rdstation/events.rb

@@ -1,18 +1,21 @@
 module RDStation
   class Events
     include HTTParty
+    include ::RDStation::RetryableRequest
 
     EVENTS_ENDPOINT = 'https://api.rd.services/platform/events'.freeze
 
-    def initialize(authorization_header:)
-      @authorization_header = authorization_header
+    def initialize(authorization:)
+      @authorization = authorization
     end
 
     def create(payload)
-      response = self.class.post(EVENTS_ENDPOINT, headers: @authorization_header.to_h, body: payload.to_json)
-      response_body = JSON.parse(response.body)
-      return response_body unless errors?(response_body)
-      RDStation::ErrorHandler.new(response).raise_error
+      retryable_request(@authorization) do |authorization|
+        response = self.class.post(EVENTS_ENDPOINT, headers: authorization.headers, body: payload.to_json)
+        response_body = JSON.parse(response.body)
+        return response_body unless errors?(response_body)
+        RDStation::ErrorHandler.new(response).raise_error
+      end
     end
 
     private

data/lib/rdstation/fields.rb

@@ -3,16 +3,19 @@ module RDStation
   # More info: https://developers.rdstation.com/pt-BR/reference/contacts
   class Fields
     include HTTParty
+    include ::RDStation::RetryableRequest
 
     BASE_URL = 'https://api.rd.services/platform/contacts/fields'.freeze
     
-    def initialize(authorization_header:)
-      @authorization_header = authorization_header
+    def initialize(authorization:)
+      @authorization = authorization
     end
 
     def all
-      response = self.class.get(BASE_URL, headers: @authorization_header.to_h)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(BASE_URL, headers: authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
   end

data/lib/rdstation/retryable_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RDStation
+  module RetryableRequest
+    MAX_RETRIES = 1
+    def retryable_request(authorization)
+      retries = 0
+      begin
+        yield authorization
+      rescue ::RDStation::Error::ExpiredAccessToken => e
+        raise if !retry_possible?(authorization) || retries >= MAX_RETRIES
+
+        retries += 1
+        refresh_access_token(authorization)
+        retry
+      end
+    end
+
+    def retry_possible?(authorization)
+      [
+        RDStation.configuration&.client_id,
+        RDStation.configuration&.client_secret,
+        authorization.refresh_token
+      ].all?
+    end
+
+    def refresh_access_token(authorization)
+      client = RDStation::Authentication.new
+      response = client.update_access_token(authorization.refresh_token)
+      authorization.access_token = response['access_token']
+      authorization.access_token_expires_in = response['expires_in']
+      RDStation.configuration&.access_token_refresh_callback&.call(authorization)
+    end
+  end
+end

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/rdstation/webhooks.rb

@@ -1,35 +1,47 @@
 module RDStation
   class Webhooks
     include HTTParty
+    include ::RDStation::RetryableRequest
 
-    def initialize(authorization_header:)
-      @authorization_header = authorization_header
+    def initialize(authorization:)
+      @authorization = authorization
     end
 
     def all
-      response = self.class.get(base_url, headers: @authorization_header.to_h)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url, headers: authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
     def by_uuid(uuid)
-      response = self.class.get(base_url(uuid), headers: @authorization_header.to_h)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url(uuid), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
     def create(payload)
-      response = self.class.post(base_url, headers: @authorization_header.to_h, body: payload.to_json)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.post(base_url, headers: authorization.headers, body: payload.to_json)
+        ApiResponse.build(response)
+      end
     end
 
     def update(uuid, payload)
-      response = self.class.put(base_url(uuid), headers: @authorization_header.to_h, body: payload.to_json)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.put(base_url(uuid), headers: authorization.headers, body: payload.to_json)
+        ApiResponse.build(response)
+      end
     end
 
     def delete(uuid)
-      response = self.class.delete(base_url(uuid), headers: @authorization_header.to_h)
-      return webhook_deleted_message unless response.body
-      RDStation::ErrorHandler.new(response).raise_error
+      retryable_request(@authorization) do |authorization|
+        response = self.class.delete(base_url(uuid), headers: authorization.headers)
+        return webhook_deleted_message unless response.body
+
+        RDStation::ErrorHandler.new(response).raise_error
+      end
     end
 
     private

data/rdstation-ruby-client.gemspec

@@ -20,12 +20,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock', '~> 2.1'
   spec.add_development_dependency 'turn'
   spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'pry'
 
   spec.add_dependency "httparty", "~> 0.12"
 end

data/spec/lib/rdstation/api_response_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::ApiResponse do
+  describe ".build" do
+    context "when the response HTTP status is 2xx" do
+      let(:response) { OpenStruct.new(code: 200, body: '{}') }
+
+      it "returns the response body" do
+        expect(RDStation::ApiResponse.build(response)).to eq({})
+      end
+    end
+
+    shared_examples_for 'call_error_handler' do
+      it "calls error handler" do
+        error_handler = instance_double(RDStation::ErrorHandler)
+        allow(error_handler).to receive(:raise_error)
+        expect(RDStation::ErrorHandler).to receive(:new).with(response).and_return(error_handler)
+        RDStation::ApiResponse.build(response)
+      end
+    end
+
+    context "when the response is not in the 2xx range" do
+      let(:response) { OpenStruct.new(code: 404, body: '{}') }
+
+      it_behaves_like 'call_error_handler'
+    end
+
+    context "when the response body is not JSON-parseable" do
+      let(:response) { OpenStruct.new(code: 504, body: '<html><head></head><body></body></html>') }
+
+      it_behaves_like 'call_error_handler'
+    end
+  end
+end

data/spec/lib/rdstation/authentication_spec.rb

@@ -88,6 +88,34 @@ RSpec.describe RDStation::Authentication do
 
   let(:authentication) { described_class.new('client_id', 'client_secret') }
 
+  describe '#auth_url' do
+    let(:configuration_client_id) { 'configuration_client_id' }
+    let(:configuration_client_secret) { 'configuration_client_secret' }
+    let(:redirect_url) { 'redirect_url' }
+    before do
+      RDStation.configure do |config|
+        config.client_id = configuration_client_id
+        config.client_secret = configuration_client_secret
+      end
+    end
+
+    context 'when client_id and client_secret are specified in initialization' do
+      it 'uses those specified in initialization' do
+        auth = described_class.new('initialization_client_id', 'initialization_client_secret')
+        expected = "https://api.rd.services/auth/dialog?client_id=initialization_client_id&redirect_url=#{redirect_url}"
+        expect(auth.auth_url(redirect_url)).to eq expected
+      end
+    end
+
+    context 'when client_id and client_secret are specified only in configuration' do
+      it 'uses those specified in configuration' do
+        auth = described_class.new
+        expected = "https://api.rd.services/auth/dialog?client_id=#{configuration_client_id}&redirect_url=#{redirect_url}"
+        expect(auth.auth_url(redirect_url)).to eq expected
+      end
+    end
+  end
+
   describe '#authenticate' do
     context 'when the code is valid' do
       before do
@@ -138,6 +166,37 @@ RSpec.describe RDStation::Authentication do
         end.to raise_error(RDStation::Error::ExpiredCodeGrant)
       end
     end
+
+    context 'when client_id and client_secret are specified only in configuration' do
+      let(:authentication) { described_class.new }
+      let(:configuration_client_id) { 'configuration_client_id' }
+      let(:configuration_client_secret) { 'configuration_client_secret' }
+      let(:token_request_with_valid_code_secrets_from_config) do
+        {
+          client_id: configuration_client_id,
+          client_secret: configuration_client_secret,
+          code: 'valid_code'
+        }
+      end
+      before do
+        RDStation.configure do |config|
+          config.client_id = configuration_client_id
+          config.client_secret = configuration_client_secret
+        end
+
+        stub_request(:post, token_endpoint)
+          .with(
+            headers: request_headers,
+            body: token_request_with_valid_code_secrets_from_config.to_json
+          )
+          .to_return(credentials_response)
+      end
+
+      it 'returns the credentials' do
+        credentials_request = authentication.authenticate('valid_code')
+        expect(credentials_request).to eq(credentials)
+      end
+    end
   end
 
   describe '#update_access_token' do
@@ -173,6 +232,37 @@ RSpec.describe RDStation::Authentication do
         end.to raise_error(RDStation::Error::InvalidCredentials)
       end
     end
+
+    context 'when client_id and client_secret are specified only in configuration' do
+      let(:authentication) { described_class.new }
+      let(:configuration_client_id) { 'configuration_client_id' }
+      let(:configuration_client_secret) { 'configuration_client_secret' }
+      let(:token_request_with_valid_refresh_code_secrets_from_config) do
+        {
+          client_id: configuration_client_id,
+          client_secret: configuration_client_secret,
+          refresh_token: 'valid_refresh_token'
+        }
+      end
+      before do
+        RDStation.configure do |config|
+          config.client_id = configuration_client_id
+          config.client_secret = configuration_client_secret
+        end
+
+        stub_request(:post, token_endpoint)
+          .with(
+            headers: request_headers,
+            body: token_request_with_valid_refresh_code_secrets_from_config.to_json
+          )
+          .to_return(credentials_response)
+      end
+
+      it 'returns the credentials' do
+        credentials_request = authentication.update_access_token('valid_refresh_token')
+        expect(credentials_request).to eq(credentials)
+      end
+    end
   end
 
   describe ".revoke" do

data/spec/lib/rdstation/{authorization_header_spec.rb → authorization_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe RDStation::AuthorizationHeader do
+RSpec.describe RDStation::Authorization do
   
   describe ".initialize" do
     context "when access_token is nil" do
@@ -12,11 +12,11 @@ RSpec.describe RDStation::AuthorizationHeader do
     end
   end
   
-  describe "#to_h" do
+  describe "#headers" do
     let(:access_token) { 'access_token' }
     
     it "generates the correct header" do
-      header = described_class.new(access_token: access_token).to_h
+      header = described_class.new(access_token: access_token).headers
       expect(header['Authorization']).to eq "Bearer #{access_token}"
       expect(header['Content-Type']).to eq "application/json"
     end

data/spec/lib/rdstation/client_spec.rb

@@ -4,27 +4,27 @@ RSpec.describe RDStation::Client do
   context "when access_token is given" do
     let(:access_token) { 'access_token' }
     let(:client) { described_class.new(access_token: access_token) }
-    let(:mock_authorization_header) { double(RDStation::AuthorizationHeader) }
+    let(:mock_authorization) { double(RDStation::Authorization) }
 
-    before { allow(RDStation::AuthorizationHeader).to receive(:new).and_return mock_authorization_header }
+    before { allow(RDStation::Authorization).to receive(:new).and_return mock_authorization }
 
     it 'returns Contacts endpoint' do
-      expect(RDStation::Contacts).to receive(:new).with({ authorization_header: mock_authorization_header }).and_call_original
+      expect(RDStation::Contacts).to receive(:new).with({ authorization: mock_authorization }).and_call_original
       expect(client.contacts).to be_instance_of RDStation::Contacts
     end
 
     it 'returns Events endpoint' do
-      expect(RDStation::Events).to receive(:new).with({ authorization_header: mock_authorization_header }).and_call_original
+      expect(RDStation::Events).to receive(:new).with({ authorization: mock_authorization }).and_call_original
       expect(client.events).to be_instance_of RDStation::Events
     end
 
     it 'returns Fields endpoint' do
-      expect(RDStation::Fields).to receive(:new).with({ authorization_header: mock_authorization_header }).and_call_original
+      expect(RDStation::Fields).to receive(:new).with({ authorization: mock_authorization }).and_call_original
       expect(client.fields).to be_instance_of RDStation::Fields
     end
 
     it 'returns Webhooks endpoint' do
-      expect(RDStation::Webhooks).to receive(:new).with({ authorization_header: mock_authorization_header }).and_call_original
+      expect(RDStation::Webhooks).to receive(:new).with({ authorization: mock_authorization }).and_call_original
       expect(client.webhooks).to be_instance_of RDStation::Webhooks
     end
   end

data/spec/lib/rdstation/contacts_spec.rb

@@ -16,13 +16,13 @@ RSpec.describe RDStation::Contacts do
   let(:expired_access_token) { 'expired_access_token' }
 
   let(:contact_with_valid_token) do
-    described_class.new(authorization_header: RDStation::AuthorizationHeader.new(access_token: valid_access_token))
+    described_class.new(authorization: RDStation::Authorization.new(access_token: valid_access_token))
   end
   let(:contact_with_expired_token) do
-    described_class.new(authorization_header: RDStation::AuthorizationHeader.new(access_token: expired_access_token))
+    described_class.new(authorization: RDStation::Authorization.new(access_token: expired_access_token))
   end
   let(:contact_with_invalid_token) do
-    described_class.new(authorization_header: RDStation::AuthorizationHeader.new(access_token: invalid_access_token))
+    described_class.new(authorization: RDStation::Authorization.new(access_token: invalid_access_token))
   end
 
 
@@ -109,6 +109,11 @@ RSpec.describe RDStation::Contacts do
   end
 
   describe '#by_uuid' do
+    it 'calls retryable_request' do
+      expect(contact_with_valid_token).to receive(:retryable_request)
+      contact_with_valid_token.by_uuid('valid_uuid')
+    end
+
     context 'with a valid auth token' do
       context 'when the contact exists' do
         let(:contact) do
@@ -172,6 +177,11 @@ RSpec.describe RDStation::Contacts do
   end
 
   describe '#by_email' do
+    it 'calls retryable_request' do
+      expect(contact_with_valid_token).to receive(:retryable_request)
+      contact_with_valid_token.by_email('x@xpto.com')
+    end
+
     context 'with a valid auth token' do
       context 'when the contact exists' do
         let(:contact) do
@@ -235,6 +245,11 @@ RSpec.describe RDStation::Contacts do
   end
 
   describe '#update' do
+    it 'calls retryable_request' do
+      expect(contact_with_valid_token).to receive(:retryable_request)
+      contact_with_valid_token.update('valid_uuid', {})
+    end
+
     context 'with a valid access_token' do
       let(:valid_access_token) { 'valid_access_token' }
       let(:headers) do
@@ -322,6 +337,11 @@ RSpec.describe RDStation::Contacts do
   end
 
   describe '#upsert' do
+    it 'calls retryable_request' do
+      expect(contact_with_valid_token).to receive(:retryable_request)
+      contact_with_valid_token.upsert('email', 'valid@email.com', {})
+    end
+
     context 'with a valid access_token' do
       let(:valid_access_token) { 'valid_access_token' }