rdstation-ruby-client 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea20e4d5e37030b98d697da5b71892ff892a3204
-  data.tar.gz: 027a431a05b01d94279b40d194d334d8a5235cf4
+  metadata.gz: e3abd8cbbff8541804f9098ccf8076025404e9fd
+  data.tar.gz: 303aed653c2a72f186bdbfc2b1dea8f56c7ff55d
 SHA512:
-  metadata.gz: 7a1bedc3f94bd5f532ab9073d0abc9651ef1a9159e0b339b13b9061e8c476967683b5a66bb659a12a6848fc7396a854be6153655acab97bef9f205ad50ada11b
-  data.tar.gz: ebbf843ae9cc9293850070b0b40cf638a8e1a7e61655f2022def1d01e3987b78dd2a4227e43ccb403a28d3e941f3813238595b542b6978433ecc86e1462fdd20
+  metadata.gz: 752ad7a2b479d064dfc176f2299f31035a51bfff11dbf71f3bf96fd813ac840524125789a035880a613b1c77b79ca8698b0b40687afb9ef28eee4ab4da1f6807
+  data.tar.gz: 1494b26e7d0867b640e8ea4deab9e57b8fb716417a194c821a9e77f7a9ebc8bce1057910be8e10908afde16b1ab347b28add6feacbb1f8b49818adb76019aace

data/lib/rdstation-ruby-client.rb

@@ -4,6 +4,7 @@ require 'httparty'
 require 'rdstation/authentication'
 require 'rdstation/client'
 require 'rdstation/contacts'
+require 'rdstation/events'
 require 'rdstation/fields'
 
 # Error handling

data/lib/rdstation/error.rb

@@ -23,6 +23,7 @@ module RDStation
     class ExpiredAccessToken < Error; end
     class ExpiredCodeGrant < Error; end
     class InvalidCredentials < Error; end
+    class InvalidEventType < Error; end
     class ResourceNotFound < Error; end
     class Unauthorized < Error; end
   end

data/lib/rdstation/error/formatter.rb

@@ -3,27 +3,29 @@ require_relative './format'
 module RDStation
   class Error
     class Formatter
-      def initialize(errors)
-        @errors = errors
+      def initialize(error_response)
+        @error_response = error_response
       end
 
       def to_array
+        return @error_response unless @error_response.is_a?(Hash)
+
         case error_format.format
         when RDStation::Error::Format::FLAT_HASH
-          from_flat_hash
+          return from_flat_hash
         when RDStation::Error::Format::HASH_OF_ARRAYS
-          from_hash_of_arrays
-        else
-          @errors
+          return from_hash_of_arrays
         end
+
+        errors
       end
 
       def from_flat_hash
-        [@errors]
+        [errors]
       end
 
       def from_hash_of_arrays
-        @errors.each_with_object([]) do |errors, array_of_errors|
+        errors.each_with_object([]) do |errors, array_of_errors|
           attribute_name = errors.first
           attribute_errors = errors.last
           path = { 'path' => "body.#{attribute_name}" }
@@ -33,7 +35,11 @@ module RDStation
       end
 
       def error_format
-        @error_format ||= RDStation::Error::Format.new(@errors)
+        @error_format ||= RDStation::Error::Format.new(errors)
+      end
+
+      def errors
+        @errors ||= @error_response['errors']
       end
     end
   end

data/lib/rdstation/error_handler.rb

@@ -4,6 +4,7 @@ require_relative 'error_handler/default'
 require_relative 'error_handler/expired_access_token'
 require_relative 'error_handler/expired_code_grant'
 require_relative 'error_handler/invalid_credentials'
+require_relative 'error_handler/invalid_event_type'
 require_relative 'error_handler/resource_not_found'
 require_relative 'error_handler/unauthorized'
 
@@ -14,6 +15,7 @@ module RDStation
       ErrorHandler::ExpiredAccessToken,
       ErrorHandler::ExpiredCodeGrant,
       ErrorHandler::InvalidCredentials,
+      ErrorHandler::InvalidEventType,
       ErrorHandler::ResourceNotFound,
       ErrorHandler::Unauthorized,
       ErrorHandler::Default
@@ -42,7 +44,7 @@ module RDStation
     end
 
     def response_errors
-      JSON.parse(response.body)['errors']
+      JSON.parse(response.body)
     end
 
     def error_formatter

data/lib/rdstation/error_handler/invalid_event_type.rb

@@ -0,0 +1,27 @@
+module RDStation
+  class ErrorHandler
+    class InvalidEventType
+      attr_reader :errors
+
+      ERROR_CODE = 'INVALID_OPTION'.freeze
+      PATH = '$.event_type'.freeze
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def raise_error
+        return if invalid_event_type_error.empty?
+        raise RDStation::Error::InvalidEventType, invalid_event_type_error.first
+      end
+
+      private
+
+      def invalid_event_type_error
+        errors.select do |error|
+          error.values_at('error_type', 'path') == [ERROR_CODE, PATH]
+        end
+      end
+    end
+  end
+end

data/lib/rdstation/events.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module RDStation
+  # More info: https://developers.rdstation.com/pt-BR/reference/contacts
+  class Events
+    include HTTParty
+
+    EVENTS_ENDPOINT = 'https://api.rd.services/platform/events'.freeze
+
+    def initialize(auth_token)
+      @auth_token = auth_token
+    end
+
+    def create(payload)
+      response = self.class.post(EVENTS_ENDPOINT, headers: required_headers, body: payload.to_json)
+      response_body = JSON.parse(response.body)
+      return response_body unless errors?(response_body)
+      RDStation::ErrorHandler.new(response).raise_errors
+    end
+
+    private
+
+    def errors?(response_body)
+      response_body.is_a?(Array) || response_body['errors']
+    end
+
+    def required_headers
+      {
+        'Authorization' => "Bearer #{@auth_token}",
+        'Content-Type'  => 'application/json'
+      }
+    end
+  end
+end

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/lib/rdstation/error/formatter_spec.rb

@@ -9,14 +9,16 @@ RSpec.describe RDStation::Error::Formatter do
     context 'when receives a flat hash of errors' do
       let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::FLAT_HASH) }
 
-      let(:errors) do
+      let(:error_response) do
         {
-          'error_type' => 'CONFLICTING_FIELD',
-          'error_message' => 'The payload contains an attribute that was used to identify the lead'
+          'errors' => {
+            'error_type' => 'CONFLICTING_FIELD',
+            'error_message' => 'The payload contains an attribute that was used to identify the lead'
+          }
         }
       end
 
-      let(:error_formatter) { described_class.new(errors) }
+      let(:error_formatter) { described_class.new(error_response) }
 
       let(:expected_result) do
         [
@@ -27,7 +29,7 @@ RSpec.describe RDStation::Error::Formatter do
         ]
       end
 
-      it 'returns an array of errors including the status code and headers' do
+      it 'returns an array of errors' do
         result = error_formatter.to_array
         expect(result).to eq(expected_result)
       end
@@ -36,18 +38,20 @@ RSpec.describe RDStation::Error::Formatter do
     context 'when receives a hash of arrays of errors' do
       let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::HASH_OF_ARRAYS) }
 
-      let(:errors) do
+      let(:error_response) do
         {
-          'name' => [
-            {
-              'error_type' => 'MUST_BE_STRING',
-              'error_message' => 'Name must be string.'
-            }
-          ]
+          'errors' => {
+            'name' => [
+              {
+                'error_type' => 'MUST_BE_STRING',
+                'error_message' => 'Name must be string.'
+              }
+            ]
+          }
         }
       end
 
-      let(:error_formatter) { described_class.new(errors) }
+      let(:error_formatter) { described_class.new(error_response) }
 
       let(:expected_result) do
         [
@@ -59,16 +63,49 @@ RSpec.describe RDStation::Error::Formatter do
         ]
       end
 
-      it 'returns an array of errors including the status code and headers' do
+      it 'returns an array of errors' do
         result = error_formatter.to_array
         expect(result).to eq(expected_result)
       end
     end
 
-    context 'when receives an array of errors' do
+    context 'when receives an array of errors inside the "errors" key' do
       let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::ARRAY_OF_HASHES) }
 
-      let(:errors) do
+      let(:error_response) do
+        {
+          'errors' => [
+            {
+              'error_type' => 'CANNOT_BE_NULL',
+              'error_message' => 'Cannot be null.',
+              'path' => 'body.client_secret'
+            }
+          ]
+        }
+      end
+
+      let(:error_formatter) { described_class.new(error_response) }
+
+      let(:expected_result) do
+        [
+          {
+            'error_type' => 'CANNOT_BE_NULL',
+            'error_message' => 'Cannot be null.',
+            'path' => 'body.client_secret'
+          }
+        ]
+      end
+
+      it 'returns an array of errors' do
+        result = error_formatter.to_array
+        expect(result).to eq(expected_result)
+      end
+    end
+
+    context 'when receives a pure array of errors' do
+      let(:error_format) { '' }
+
+      let(:error_response) do
         [
           {
             'error_type' => 'CANNOT_BE_NULL',
@@ -78,7 +115,7 @@ RSpec.describe RDStation::Error::Formatter do
         ]
       end
 
-      let(:error_formatter) { described_class.new(errors) }
+      let(:error_formatter) { described_class.new(error_response) }
 
       let(:expected_result) do
         [
@@ -90,7 +127,7 @@ RSpec.describe RDStation::Error::Formatter do
         ]
       end
 
-      it 'returns an array of errors including the status code and headers' do
+      it 'returns an array of errors' do
         result = error_formatter.to_array
         expect(result).to eq(expected_result)
       end

data/spec/lib/rdstation/error_handler/invalid_event_type_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::ErrorHandler::InvalidEventType do
+  describe '#raise_error' do
+    subject(:invalid_event_type_error) { described_class.new(errors) }
+
+    context 'when there is a invalid event type error' do
+      let(:errors) do
+        [
+          {
+            'error_message' => 'Error Message',
+            'error_type' => 'INVALID_OPTION',
+            'path' => '$.event_type'
+          }
+        ]
+      end
+
+      it 'raises an InvalidEventType error' do
+        expect do
+          invalid_event_type_error.raise_error
+        end.to raise_error(RDStation::Error::InvalidEventType, 'Error Message')
+      end
+    end
+
+    context 'when none of the errors are invalid event type errors' do
+      let(:errors) do
+        [
+          {
+            'error_message' => 'Error Message',
+            'error_type' => 'RANDOM_ERROR_TYPE'
+          },
+          {
+            'error_message' => 'Another Error Message',
+            'error_type' => 'ANOTHER_RANDOM_ERROR_TYPE'
+          }
+        ]
+      end
+
+      it 'does not raise an InvalidEventType error' do
+        result = invalid_event_type_error.raise_error
+        expect(result).to be_nil
+      end
+    end
+
+    context 'when there are no errors' do
+      let(:errors) { [] }
+
+      it 'does not raise an InvalidEventType error' do
+        result = invalid_event_type_error.raise_error
+        expect(result).to be_nil
+      end
+    end
+  end
+end

data/spec/lib/rdstation/events_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::Events do
+  let(:valid_auth_token) { 'valid_auth_token' }
+  let(:invalid_auth_token) { 'invalid_auth_token' }
+  let(:expired_auth_token) { 'expired_auth_token' }
+
+  let(:event_with_valid_token) { described_class.new(valid_auth_token) }
+  let(:event_with_expired_token) { described_class.new(expired_auth_token) }
+  let(:event_with_invalid_token) { described_class.new(invalid_auth_token) }
+
+  let(:events_endpoint) { 'https://api.rd.services/platform/events' }
+
+  let(:valid_event_types) do
+    %w[
+      OPPORTUNITY_LOST
+      EMAIL_DELIVERED
+      DOUBLE_OPT_IN_EMAIL_CONFIRMED
+      OPPORTUNITY
+      CART_ABANDONED_ITEM
+      FUNNEL_STAGE_CHANGED
+      MEDIA_PLAYBACK_STOPPED
+      CONVERSION
+      MEDIA_PLAYBACK_STARTED
+      SALE
+      WORKFLOW_STARTED
+      EMAIL_SPAM_REPORTED
+      ORDER_PLACED
+      EMAIL_SOFT_BOUNCED
+      CART_ABANDONED
+      EMAIL_OPENED
+      EMAIL_DROPPED
+      EMAIL_HARD_BOUNCED
+      WORKFLOW_FINISHED
+      WORKFLOW_CANCELED
+      EMAIL_CLICKED
+      ORDER_PLACED_ITEM
+      CHAT_STARTED
+      CHAT_FINISHED
+      EMAIL_UNSUBSCRIBED
+      PAGE_VISITED
+      CALL_FINISHED
+    ]
+  end
+
+  let(:valid_headers) do
+    {
+      'Authorization' => "Bearer #{valid_auth_token}",
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  let(:invalid_token_headers) do
+    {
+      'Authorization' => "Bearer #{invalid_auth_token}",
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  let(:expired_token_headers) do
+    {
+      'Authorization' => "Bearer #{expired_auth_token}",
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  let(:invalid_token_response) do
+    {
+      status: 401,
+      body: {
+        errors: {
+          error_type: 'UNAUTHORIZED',
+          error_message: 'Invalid token.'
+        }
+      }.to_json
+    }
+  end
+
+  let(:expired_token_response) do
+    {
+      status: 401,
+      headers: { 'WWW-Authenticate' => 'Bearer realm="https://api.rd.services/", error="expired_token", error_description="The access token expired"' },
+      body: {
+        errors: {
+          error_type: 'UNAUTHORIZED',
+          error_message: 'Invalid token.'
+        }
+      }.to_json
+    }
+  end
+
+  describe '#create' do
+    let(:event) do
+      {
+        'event_type' => 'OPPORTUNITY_LOST',
+        'event_family' => 'CDP',
+        'payload' => {
+          'email' => 'email@email.com',
+          'funnel_name' => 'default',
+          'reason' => 'Lost reason'
+        }
+      }
+    end
+
+    context 'with a valid auth token' do
+      before do
+        stub_request(:post, events_endpoint)
+          .with(headers: valid_headers)
+          .to_return(status: 200, body: event.to_json)
+      end
+
+      it 'returns the event uuid' do
+        # {"event_uuid":"830eacd4-6859-43b5-82ef-d2989db38604"}
+        response = event_with_valid_token.create(event)
+        expect(response).to eq(event)
+      end
+    end
+
+    context 'with an invalid auth token' do
+      before do
+        stub_request(:post, events_endpoint)
+          .with(headers: invalid_token_headers)
+          .to_return(invalid_token_response)
+      end
+
+      it 'raises an invalid token error' do
+        expect do
+          event_with_invalid_token.create(event)
+        end.to raise_error(RDStation::Error::Unauthorized)
+      end
+    end
+
+    context 'with an expired auth token' do
+      before do
+        stub_request(:post, events_endpoint)
+          .with(headers: expired_token_headers)
+          .to_return(expired_token_response)
+      end
+
+      it 'raises a expired token error' do
+        expect do
+          event_with_expired_token.create(event)
+        end.to raise_error(RDStation::Error::ExpiredAccessToken)
+      end
+    end
+
+    context 'when the event type is incorrect' do
+      let(:invalid_event_type_response) do
+        {
+          status: 400,
+          body: [
+            {
+              'error_type' => 'INVALID_OPTION',
+              'error_message' => 'Must be one of the valid options.',
+              'validation_rules' => { 'valid_options' => valid_event_types },
+              'path' => '$.event_type'
+            }
+          ].to_json
+        }
+      end
+
+      before do
+        stub_request(:post, events_endpoint)
+          .with(headers: valid_headers)
+          .to_return(invalid_event_type_response)
+      end
+
+      it 'raises an invalid event type error' do
+        expect do
+          event_with_valid_token.create(event)
+        end.to raise_error(RDStation::Error::InvalidEventType)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,8 +120,10 @@ files:
 - 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/version.rb
 - rdstation-ruby-client.gemspec
@@ -135,10 +137,12 @@ files:
 - 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/spec_helper.rb
 homepage: http://resultadosdigitais.com.br
@@ -176,9 +180,11 @@ test_files:
 - 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/spec_helper.rb