RubyGems - rdstation-ruby-client - Versions diffs - 1.2.0 → 2.3.0 - Mend

rdstation-ruby-client 1.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

checksums.yaml +5 -5
data/.github/ISSUE_TEMPLATE/rdsm-ruby-client-issue-template.md +49 -0
data/.rspec +2 -0
data/CHANGELOG.md +163 -0
data/README.md +243 -43
data/lib/rdstation-ruby-client.rb +6 -0
data/lib/rdstation.rb +19 -0
data/lib/rdstation/api_response.rb +3 -3
data/lib/rdstation/authentication.rb +32 -3
data/lib/rdstation/authorization.rb +24 -0
data/lib/rdstation/builder/field.rb +70 -0
data/lib/rdstation/client.rb +17 -70
data/lib/rdstation/contacts.rb +21 -16
data/lib/rdstation/error.rb +22 -15
data/lib/rdstation/error/format.rb +21 -3
data/lib/rdstation/error/formatter.rb +53 -7
data/lib/rdstation/error_handler.rb +29 -26
data/lib/rdstation/error_handler/bad_request.rb +30 -0
data/lib/rdstation/error_handler/unauthorized.rb +17 -9
data/lib/rdstation/events.rb +7 -19
data/lib/rdstation/fields.rb +31 -7
data/lib/rdstation/retryable_request.rb +35 -0
data/lib/rdstation/version.rb +1 -1
data/lib/rdstation/webhooks.rb +25 -17
data/rdstation-ruby-client.gemspec +4 -1
data/spec/lib/rdstation-ruby-client_spec.rb +1 -1
data/spec/lib/rdstation/api_response_spec.rb +34 -0
data/spec/lib/rdstation/authentication_spec.rb +164 -0
data/spec/lib/rdstation/authorization_spec.rb +24 -0
data/spec/lib/rdstation/builder/field_spec.rb +69 -0
data/spec/lib/rdstation/client_spec.rb +37 -0
data/spec/lib/rdstation/contacts_spec.rb +54 -41
data/spec/lib/rdstation/error/format_spec.rb +46 -0
data/spec/lib/rdstation/error/formatter_spec.rb +83 -0
data/spec/lib/rdstation/error_handler/unauthorized_spec.rb +0 -29
data/spec/lib/rdstation/error_handler_spec.rb +153 -26
data/spec/lib/rdstation/events_spec.rb +20 -9
data/spec/lib/rdstation/fields_spec.rb +10 -3
data/spec/lib/rdstation/retryable_request_spec.rb +142 -0
data/spec/lib/rdstation/webhooks_spec.rb +41 -13
data/spec/lib/rdstation_spec.rb +18 -0
metadata +40 -13
data/Gemfile.lock +0 -59
data/lib/rdstation/error_handler/default.rb +0 -15
data/lib/rdstation/error_handler/resource_not_found.rb +0 -24
data/spec/lib/rdstation/error_handler/default_spec.rb +0 -14
data/spec/lib/rdstation/error_handler/resource_not_found_spec.rb +0 -54

data/rdstation-ruby-client.gemspec CHANGED

@@ -18,12 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.required_ruby_version = '>= 2.0.0'
+  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-ruby-client_spec.rb CHANGED

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe RDStation do
     let(:rdstation_client) { RDStation::Client.new('token','private' ) }
     let(:lead_email) { "iginosms@gmail.com" }
-    let(:amount) { 300}
+    let(:amount) { 300 }
   context "#change_lead_status" do

data/spec/lib/rdstation/api_response_spec.rb ADDED

@@ -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 CHANGED

@@ -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,5 +232,110 @@ 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
+    let(:revoke_endpoint) { 'https://api.rd.services/auth/revoke' }
+    let(:request_headers) do
+      {
+        "Authorization" => "Bearer #{access_token}",
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }
+    end
+    context "valid access_token" do
+      let(:access_token) { "valid_access_token" }
+      let(:ok_response) do
+        {
+          status: 200,
+          headers: { 'Content-Type' => 'application/json' },
+          body: {}.to_json
+        }
+      end
+      before do
+        stub_request(:post, revoke_endpoint)
+          .with(
+            headers: request_headers,
+            body: URI.encode_www_form({
+              token: access_token,
+              token_type_hint: 'access_token'
+            })
+          )
+          .to_return(ok_response)
+      end
+      it "returns 200 code with an empty hash in the body" do
+        request_response = RDStation::Authentication.revoke(access_token: access_token)
+        expect(request_response).to eq({})
+      end
+    end
+    context "invalid access token" do
+      let(:access_token) { "invalid_access_token" }
+      let(:unauthorized_response) do
+        {
+          status: 401,
+          headers: { 'Content-Type' => 'application/json' },
+          body: {
+            errors: {
+              error_type: 'UNAUTHORIZED',
+              error_message: 'Invalid token.'
+            }
+          }.to_json
+        }
+      end
+      before do
+        stub_request(:post, revoke_endpoint)
+          .with(
+            headers: request_headers,
+            body: URI.encode_www_form({
+              token: access_token,
+              token_type_hint: 'access_token'
+            })
+          )
+          .to_return(unauthorized_response)
+      end
+      it "raises unauthorized" do
+        expect do
+          RDStation::Authentication.revoke(access_token: access_token)
+        end.to raise_error(RDStation::Error::Unauthorized)
+      end
+    end
   end
 end

data/spec/lib/rdstation/authorization_spec.rb ADDED

@@ -0,0 +1,24 @@
+require 'spec_helper'
+RSpec.describe RDStation::Authorization do
+  describe ".initialize" do
+    context "when access_token is nil" do
+      it "raises an error" do
+        expect do
+          described_class.new(access_token: nil)
+        end.to raise_error(ArgumentError)
+      end
+    end
+  end
+  describe "#headers" do
+    let(:access_token) { 'access_token' }
+    it "generates the correct header" do
+      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
+  end
+end

data/spec/lib/rdstation/builder/field_spec.rb ADDED

@@ -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

data/spec/lib/rdstation/client_spec.rb ADDED

@@ -0,0 +1,37 @@
+require 'spec_helper'
+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) { double(RDStation::Authorization) }
+    before { allow(RDStation::Authorization).to receive(:new).and_return mock_authorization }
+    it 'returns Contacts endpoint' do
+      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: 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: 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: mock_authorization }).and_call_original
+      expect(client.webhooks).to be_instance_of RDStation::Webhooks
+    end
+  end
+  context "when access_token isn't given" do
+    it "raises an ArgumentError exception" do
+      expect{ described_class.new(access_token: nil) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/lib/rdstation/contacts_spec.rb CHANGED

@@ -11,31 +11,38 @@ RSpec.describe RDStation::Contacts do
   let(:endpoint_with_valid_email) { "https://api.rd.services/platform/contacts/email:#{valid_email}" }
   let(:endpoint_with_invalid_email) { "https://api.rd.services/platform/contacts/email:#{invalid_email}" }
-  let(:valid_auth_token) { 'valid_auth_token' }
-  let(:invalid_auth_token) { 'invalid_auth_token' }
-  let(:expired_auth_token) { 'expired_auth_token' }
+  let(:valid_access_token) { 'valid_access_token' }
+  let(:invalid_access_token) { 'invalid_access_token' }
+  let(:expired_access_token) { 'expired_access_token' }
+  let(:contact_with_valid_token) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: valid_access_token))
+  end
+  let(:contact_with_expired_token) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: expired_access_token))
+  end
+  let(:contact_with_invalid_token) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: invalid_access_token))
+  end
-  let(:contact_with_valid_token) { described_class.new(valid_auth_token) }
-  let(:contact_with_expired_token) { described_class.new(expired_auth_token) }
-  let(:contact_with_invalid_token) { described_class.new(invalid_auth_token) }
   let(:valid_headers) do
     {
-      'Authorization' => "Bearer #{valid_auth_token}",
+      'Authorization' => "Bearer #{valid_access_token}",
       'Content-Type' => 'application/json'
     }
   end
   let(:invalid_token_headers) do
     {
-      'Authorization' => "Bearer #{invalid_auth_token}",
+      'Authorization' => "Bearer #{invalid_access_token}",
       'Content-Type' => 'application/json'
     }
   end
   let(:expired_token_headers) do
     {
-      'Authorization' => "Bearer #{expired_auth_token}",
+      'Authorization' => "Bearer #{expired_access_token}",
       'Content-Type' => 'application/json'
     }
   end
@@ -102,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
@@ -130,7 +142,7 @@ RSpec.describe RDStation::Contacts do
         it 'raises a not found error' do
           expect do
             contact_with_valid_token.by_uuid(invalid_uuid)
-          end.to raise_error(RDStation::Error::ResourceNotFound)
+          end.to raise_error(RDStation::Error::NotFound)
         end
       end
     end
@@ -165,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
@@ -193,7 +210,7 @@ RSpec.describe RDStation::Contacts do
         it 'raises a not found error' do
           expect do
             contact_with_valid_token.by_email(invalid_email)
-          end.to raise_error(RDStation::Error::ResourceNotFound)
+          end.to raise_error(RDStation::Error::NotFound)
         end
       end
     end
@@ -228,11 +245,16 @@ RSpec.describe RDStation::Contacts do
   end
   describe '#update' do
-    context 'with a valid auth_token' do
-      let(:valid_auth_token) { 'valid_auth_token' }
+    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
         {
-          'Authorization' => "Bearer #{valid_auth_token}",
+          'Authorization' => "Bearer #{valid_access_token}",
           'Content-Type' => 'application/json'
         }
       end
@@ -264,16 +286,16 @@ RSpec.describe RDStation::Contacts do
         it 'raises a not found error' do
           expect do
             contact_with_valid_token.update(invalid_uuid, {})
-          end.to raise_error(RDStation::Error::ResourceNotFound)
+          end.to raise_error(RDStation::Error::NotFound)
         end
       end
     end
     context 'with an invalid auth token' do
-      let(:invalid_auth_token) { 'invalid_auth_token' }
+      let(:invalid_access_token) { 'invalid_access_token' }
       let(:headers) do
         {
-          'Authorization' => "Bearer #{invalid_auth_token}",
+          'Authorization' => "Bearer #{invalid_access_token}",
           'Content-Type' => 'application/json'
         }
       end
@@ -292,10 +314,10 @@ RSpec.describe RDStation::Contacts do
     end
     context 'with an expired auth token' do
-      let(:expired_auth_token) { 'expired_auth_token' }
+      let(:expired_access_token) { 'expired_access_token' }
       let(:headers) do
         {
-          'Authorization' => "Bearer #{expired_auth_token}",
+          'Authorization' => "Bearer #{expired_access_token}",
           'Content-Type' => 'application/json'
         }
       end
@@ -315,12 +337,17 @@ RSpec.describe RDStation::Contacts do
   end
   describe '#upsert' do
-    context 'with a valid auth_token' do
-      let(:valid_auth_token) { 'valid_auth_token' }
+    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' }
       let(:headers) do
         {
-          'Authorization' => "Bearer #{valid_auth_token}",
+          'Authorization' => "Bearer #{valid_access_token}",
           'Content-Type' => 'application/json'
         }
       end
@@ -352,7 +379,7 @@ RSpec.describe RDStation::Contacts do
         it 'raises a not found error' do
           expect do
             contact_with_valid_token.upsert('email', invalid_email, {})
-          end.to raise_error(RDStation::Error::ResourceNotFound)
+          end.to raise_error(RDStation::Error::NotFound)
         end
       end
@@ -371,27 +398,13 @@ RSpec.describe RDStation::Contacts do
           end.to raise_error(RDStation::Error::ConflictingField)
         end
       end
-      context 'when an unrecognized error occurs' do
-        before do
-          stub_request(:patch, endpoint_with_valid_email)
-            .with(headers: headers)
-            .to_return(unrecognized_error)
-        end
-        it 'raises an default error' do
-          expect do
-            contact_with_valid_token.upsert('email', valid_email, {})
-          end.to raise_error(RDStation::Error::Default)
-        end
-      end
     end
     context 'with an invalid auth token' do
-      let(:invalid_auth_token) { 'invalid_auth_token' }
+      let(:invalid_access_token) { 'invalid_access_token' }
       let(:headers) do
         {
-          'Authorization' => "Bearer #{invalid_auth_token}",
+          'Authorization' => "Bearer #{invalid_access_token}",
           'Content-Type' => 'application/json'
         }
       end
@@ -410,10 +423,10 @@ RSpec.describe RDStation::Contacts do
     end
     context 'with an expired auth token' do
-      let(:expired_auth_token) { 'expired_auth_token' }
+      let(:expired_access_token) { 'expired_access_token' }
       let(:headers) do
         {
-          'Authorization' => "Bearer #{expired_auth_token}",
+          'Authorization' => "Bearer #{expired_access_token}",
           'Content-Type' => 'application/json'
         }
       end