rdstation-ruby-client 2.1.0 → 2.5.0

data/lib/rdstation/error_handler/invalid_refresh_token.rb

@@ -0,0 +1,24 @@
+module RDStation
+  class ErrorHandler
+    class InvalidRefreshToken
+      attr_reader :errors
+
+      ERROR_CODE = 'INVALID_REFRESH_TOKEN'.freeze
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def raise_error
+        return if invalid_refresh_token_error.empty?
+        raise RDStation::Error::InvalidRefreshToken, invalid_refresh_token_error
+      end
+
+      private
+
+      def invalid_refresh_token_error
+        errors.find { |error| error['error_type'] == ERROR_CODE }
+      end
+    end
+  end
+end

data/lib/rdstation/error_handler/unauthorized.rb

@@ -1,6 +1,7 @@
 require_relative 'expired_access_token'
 require_relative 'expired_code_grant'
 require_relative 'invalid_credentials'
+require_relative 'invalid_refresh_token'
 
 module RDStation
   class ErrorHandler
@@ -9,6 +10,7 @@ module RDStation
         ErrorHandler::ExpiredAccessToken,
         ErrorHandler::ExpiredCodeGrant,
         ErrorHandler::InvalidCredentials,
+        ErrorHandler::InvalidRefreshToken,
       ].freeze
 
       def initialize(array_of_errors)

data/lib/rdstation/events.rb

@@ -1,24 +1,19 @@
 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
-    end
-
-    private
-
-    def errors?(response_body)
-      response_body.is_a?(Array) || response_body['errors']
+      retryable_request(@authorization) do |authorization|
+        response = self.class.post(EVENTS_ENDPOINT, headers: authorization.headers, body: payload.to_json)
+        ApiResponse.build(response)
+      end
     end
   end
 end

data/lib/rdstation/fields.rb

@@ -1,19 +1,48 @@
 # encoding: utf-8
 module RDStation
-  # More info: https://developers.rdstation.com/pt-BR/reference/contacts
+  # More info: https://developers.rdstation.com/pt-BR/reference/fields
   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
+
+    def create(payload)
+      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)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.patch(base_url(uuid), headers: authorization.headers, body: payload.to_json)
+        ApiResponse.build(response)
+      end
     end
 
+    def delete(uuid)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.delete(base_url(uuid), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
+    end
+
+    private
+
+    def base_url(path = '')
+      "#{BASE_URL}/#{path}"
+    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.5.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
@@ -158,19 +217,63 @@ RSpec.describe RDStation::Authentication do
     end
 
     context 'when the refresh token is invalid' do
+      let(:invalid_refresh_token_response) do
+        {
+          status: 401,
+          headers: { 'Content-Type' => 'application/json' },
+          body: {
+            errors: {
+              error_type: 'INVALID_REFRESH_TOKEN',
+              error_message: 'The provided refresh token is invalid or was revoked.'
+            }
+          }.to_json
+        }
+      end
+
       before do
         stub_request(:post, token_endpoint)
           .with(
             headers: request_headers,
             body: token_request_with_invalid_refresh_token.to_json
           )
-          .to_return(invalid_code_response)
+          .to_return(invalid_refresh_token_response)
       end
 
       it 'returns an auth error' do
         expect do
           authentication.update_access_token('invalid_refresh_token')
-        end.to raise_error(RDStation::Error::InvalidCredentials)
+        end.to raise_error(RDStation::Error::InvalidRefreshToken)
+      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

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/builder/field_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RDStation::Builder::Field do
+  def valid_builder
+    described_class.new('cf_identifier')
+  end
+
+  describe 'when create a builder' do
+    context 'valid' do
+      let(:initial_parameters) do
+        'cf_api_identifier'
+      end
+
+      let(:builder) { described_class.new(initial_parameters) }
+
+      let(:expected_result) do
+        {
+          'api_identifier' => 'cf_api_identifier',
+          'data_type' => 'STRING',
+          'presentation_type' => 'TEXT_INPUT',
+          'label' => { 'pt-BR' => 'My label' },
+          'name' => { 'pt-BR' => 'My name' }
+        }
+      end
+
+      it 'returns an hash of required values' do
+        builder.label 'pt-BR', 'My label'
+        builder.name 'pt-BR', 'My name'
+        builder.data_type 'STRING'
+        builder.presentation_type 'TEXT_INPUT'
+
+        result = builder.build
+        expect(result).to eq(expected_result)
+      end
+    end
+    
+    context 'invalid' do
+      it 'using invalid api_identifier ' do
+        expect { described_class.new('invald_identifier') }.to raise_error(
+          'api_identifier is not in a valid format, need start with "cf_"'
+        )
+      end
+
+      it 'using invalid data_type ' do
+        expect { valid_builder.data_type('invalid_data_type') }.to raise_error(
+          'Not valid data_type - ["STRING", "INTEGER", "BOOLEAN", "STRING[]"]'
+        )
+      end
+
+      it 'using invalid presentation_type ' do
+        expect { valid_builder.presentation_type('invalid presentation_type') }.to raise_error(
+          'Not valid presentation_type - ["TEXT_INPUT", "TEXT_AREA", "URL_INPUT", "PHONE_INPUT", "EMAIL_INPUT", "CHECK_BOX", "NUMBER_INPUT", "COMBO_BOX", "RADIO_BUTTON", "MULTIPLE_CHOICE"]'
+        )
+      end
+
+      it 'without api_identifier' do
+        expect { described_class.new(nil) }.to raise_error('api_identifier required')
+      end
+
+      it 'without required fields' do
+        expect { valid_builder.build }.to raise_error(
+          'Required fields are missing - ["data_type", "presentation_type", "label", "name"]'
+        )
+      end
+    end
+  end
+end