rdstation-ruby-client 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440807bc5aafd6c15cb69ad4c7ef4b50fbdcbddfac9e3441f4fff97675cf4ee3
-  data.tar.gz: 3c419ba39fd059e44d072c19b595147099f90295e69a946c02da95e4e856103e
+  metadata.gz: c3de60aebf7582be38403250a4d049f3428241b66a18acb085cdd71f542cb8a0
+  data.tar.gz: '0829e4b85cae5dd80c64395f6e460ebb315fee92853d81a5feb263adaa2e3efe'
 SHA512:
-  metadata.gz: c75f8c5d1957ccef3016093d1768e64b27e71ff7e47274efc9c6ee013cecb88befebfd2c38a476d4aecf68f1d92709747b882542ce9ea5bcd16cbc0faa7eee85
-  data.tar.gz: b66553b5cf10bc85f3f6c40704ebc999b3bd61ece59ef431bd903803e60cd29f27f88ea55750f4b650016c0173c88001ead4f305cfc313338fc1849d4b1fc05b
+  metadata.gz: 1206caba197401915572f9bb66dd2c45ad2c019d8ce5899d0667753043066cce96edfc39207054549de900cf57e3eb1179c6e4bcf58bed5bac459ef37d49cc12
+  data.tar.gz: c27a1e2c5d5d3ef4ddc3cfc1f0369f9be0cf09c040147fe1409bcc6d77a3c4d2fc7f697f3d40db2f83fbc2a0c79cad61e9378d4cbc3eedc9df0fe9ec9eaa91ef

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 2.9.0
+
+### Additions
+
+#### 1. New Account client
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.account.info
+```
+
+
+## 2.8.2
+
+- Fix TooManyRequest handler
+
 ## 2.8.1
 
 - Makes the retryable_request method also retry when a `RDStation::Error::Unauthorized` error happen

data/README.md

@@ -20,7 +20,8 @@ Upgrading? Check the [migration guide](#Migration-guide) before bumping to a new
    8. [Segmentations](#Segmentations)
    9. [Analytics](#Analytics)
    10.[LandingPages](#LandingPages)
-   11.[Errors](#Errors)
+   11.[Account](#Account)
+   12.[Errors](#Errors)
 3. [Changelog](#Changelog)
 4. [Migration guide](#Migration-guide)
    1. [Upgrading from 1.2.x to 2.0.0](#Upgrading-from-1.2.x-to-2.0.0)
@@ -55,7 +56,7 @@ RDStation.configure do |config|
 end
 ```
 
-For details on what `client_id` and `client_secret` are, check the [developers portal](https://developers.rdstation.com/en/authentication).
+For details on what `client_id` and `client_secret` are, check the [developers portal](https://developers.rdstation.com/reference/autenticacao).
 
 ### Authentication
 
@@ -123,7 +124,7 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.contacts.by_uuid('uuid')
 ```
 
-More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsuuid
+More info: https://developers.rdstation.com/reference/get_platform-contacts-identifier-value
 
 #### Getting a Contact by Email
 
@@ -134,7 +135,7 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.contacts.by_email('email')
 ```
 
-More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsemail
+More info:  https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsuuid
 
 #### Update a Contact by UUID
 
@@ -160,7 +161,7 @@ Contact Default Parameters
  - website
  - tags
 
-More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchDetails
+More info: https://developers.rdstation.com/reference/patch_platform-contacts-identifier-value
 
 
 #### Upsert a Contact by identifier and value
@@ -179,7 +180,7 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.contacts.upsert(identifier, identifier_value, contact_info)
 ```
 
-More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchUpsertDetails
+More info: https://developers.rdstation.com/reference/patch_platform-contacts-identifier-value
 
 ### Events
 
@@ -189,7 +190,7 @@ The events endpoint are responsible for receiving different event types in which
 
 It is possible to send default events to RD Station such as conversion events, lifecycle events and won and lost events. Also, RD Station supports the possibility of receiving different event types, for instance, chat events, ecommerce ones and others.
 
-Check the [developers portal](https://developers.rdstation.com/en/reference/events) to learn about the required payload structure and which events are available.
+Check the [developers portal](https://developers.rdstation.com/reference/eventos) to learn about the required payload structure and which events are available.
 
 This creates a new event on RDSM:
 
@@ -201,7 +202,7 @@ client.events.create(payload)
 
 ### Fields
 
-Endpoints to [manage Contact Fields](https://developers.rdstation.com/en/reference/fields) information in your RD Station account.
+Endpoints to [manage Contact Fields](https://developers.rdstation.com/reference/get_platform-contacts-fields) information in your RD Station account.
 
 #### List all fields
 
@@ -287,7 +288,7 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.webhooks.create(payload)
 ```
 
-The required strucutre of the payload is [described here](https://developers.rdstation.com/en/reference/webhooks#methodPostDetails).
+The required strucutre of the payload is [described here](https://developers.rdstation.com/reference/post_integrations-webhooks).
 
 #### Updating a webhook
 
@@ -297,7 +298,7 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.webhooks.create('WEBHOOK_UUID', payload)
 ```
 
-The required strucutre of the payload is [described here](https://developers.rdstation.com/en/reference/webhooks#methodPutDetails).
+The required strucutre of the payload is [described here](https://developers.rdstation.com/reference/put_integrations-webhooks-uuid)
 
 #### Deleting a webhook
 
@@ -377,6 +378,16 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.landing_pages.all
 ```
 
+### Account
+
+Returns the account information.
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.account.info
+=> {"name"=>"www.rdstation.com"}
+```
+
 ### Errors
 
 Each endpoint may raise errors accoording to the HTTP response code from RDStation:
@@ -434,8 +445,7 @@ So, here is a step-by-step guide on how to upgrade your app:
 
 ## Maintainers
 
-- [Filipe Nascimento](mailto:filipe.nascimento@resultadosdigitais.com.br)
-- [João Hornburg](mailto:joao@rdstation.com)
+- [EcoSystem API Team](mailto:ecosystem@rdstation.com)
 
 ## Reference
 

data/lib/rdstation/account.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RDStation
+  class Account
+    include HTTParty
+    include ::RDStation::RetryableRequest
+
+    def initialize(authorization:)
+      @authorization = authorization
+    end
+
+    def info
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url, headers: authorization.headers)
+        ApiResponse.build(response)
+      end
+    end
+
+    private
+
+    def base_url(_path = '')
+      "#{RDStation.host}/marketing/account_info"
+    end
+  end
+end

data/lib/rdstation/client.rb

@@ -8,6 +8,10 @@ module RDStation
       )
     end
 
+    def account
+      @account ||= RDStation::Account.new(authorization: @authorization)
+    end
+
     def contacts
       @contacts ||= RDStation::Contacts.new(authorization: @authorization)
     end

data/lib/rdstation/error/format.rb

@@ -29,7 +29,7 @@ module RDStation
       def single_hash?
         return unless @errors.is_a?(Hash)
 
-        @errors.key?('error')
+        @errors.key?('error') || @errors.key?('message')
       end
 
       def flat_hash?

data/lib/rdstation/error/formatter.rb

@@ -5,8 +5,9 @@ require_relative './format'
 module RDStation
   class Error
     class Formatter
-      def initialize(error_response)
+      def initialize(error_response, headers = {})
         @error_response = error_response
+        @headers = headers
       end
 
       def to_array
@@ -30,13 +31,13 @@ module RDStation
 
       def from_single_hash
         error_hash = @error_response.dup
-        error_message = error_hash.delete('error')
+        error_message = error_hash.delete('error') || error_hash.delete('message')
 
         [
           {
             'error_type' => 'TOO_MANY_REQUESTS',
             'error_message' => error_message,
-            'details' => error_hash
+            'details' => error_hash.key?('max') ? error_hash : error_details
           }
         ]
       end
@@ -102,6 +103,14 @@ module RDStation
           array_of_errors.push(*errors)
         end
       end
+
+      def error_details
+        {
+          max: @headers.fetch('ratelimit-limit-quotas', 0),
+          usage: @headers.fetch('ratelimit-limit-quotas', 0),
+          remaining_time: @headers.fetch('retry-after-quotas', 0)
+        }
+      end
     end
   end
 end

data/lib/rdstation/error_handler.rb

@@ -54,7 +54,7 @@ module RDStation
     end
 
     def error_formatter
-      @error_formatter = RDStation::Error::Formatter.new(response_errors)
+      @error_formatter = RDStation::Error::Formatter.new(response_errors, response.headers)
     end
 
     def additional_error_attributes

data/lib/rdstation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RDStation
-  VERSION = '2.8.1'
+  VERSION = '2.9.0'
 end

data/lib/rdstation-ruby-client.rb

@@ -9,6 +9,7 @@ require 'rdstation/retryable_request'
 require 'rdstation/authentication'
 require 'rdstation/authorization'
 require 'rdstation/client'
+require 'rdstation/account'
 require 'rdstation/contacts'
 require 'rdstation/events'
 require 'rdstation/fields'

data/rdstation-ruby-client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["paulo.casaretto@resultadosdigitais.com.br"]
   spec.description   = "Ruby API wrapper for RD Station"
   spec.summary       = "Ruby API wrapper for RD Station"
-  spec.homepage      = "http://resultadosdigitais.com.br"
+  spec.homepage      = "https://github.com/ResultadosDigitais/rdstation-ruby-client"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/lib/rdstation/account_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::Account do
+  let(:client) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: 'access_token'))
+  end
+
+  let(:endpoint) { 'https://api.rd.services/marketing/account_info' }
+
+  let(:headers) do
+    {
+      'Authorization' => 'Bearer access_token',
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  let(:error_handler) do
+    instance_double(RDStation::ErrorHandler, raise_error: 'mock raised errors')
+  end
+
+  before do
+    allow(RDStation::ErrorHandler).to receive(:new).and_return(error_handler)
+  end
+
+  describe '#info' do
+    it 'calls retryable_request' do
+      expect(client).to receive(:retryable_request)
+      client.info
+    end
+
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: {name: 'www.rdstation.com'}.to_json)
+      end
+
+      it 'return RDSM account information' do
+        response = client.info
+        expect(response).to eq({ 'name' => 'www.rdstation.com'})
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, endpoint)
+          .with(headers: headers)
+          .to_return(status: 404, body: { 'errors' => ['not found'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        client.info
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+end

data/spec/lib/rdstation/client_spec.rb

@@ -27,6 +27,11 @@ RSpec.describe RDStation::Client do
       expect(RDStation::Webhooks).to receive(:new).with({ authorization: mock_authorization }).and_call_original
       expect(client.webhooks).to be_instance_of RDStation::Webhooks
     end
+
+    it 'returns Account endpoint' do
+      expect(RDStation::Account).to receive(:new).with({ authorization: mock_authorization }).and_call_original
+      expect(client.account).to be_instance_of RDStation::Account
+    end
   end
 
   context "when access_token isn't given" do

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

@@ -218,31 +218,60 @@ RSpec.describe RDStation::Error::Formatter do
 
     context 'when receives a single hash of errors' do
       let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::SINGLE_HASH) }
-
-      let(:error_response) do
-        {
-          'error' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key",
-          'max' => 24,
-          'usage' => 55,
-          'remaining_time' => 20745
-        }
-      end
-
       let(:error_formatter) { described_class.new(error_response) }
 
-      let(:expected_result) do
-        [
+      context 'when response comes from RDSM' do
+        let(:error_response) do
           {
-            'error_type' => 'TOO_MANY_REQUESTS',
-            'error_message' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key",
-            'details' => { 'max' => 24, 'usage' => 55, 'remaining_time' => 20745 }
+            'error' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key",
+            'max' => 24,
+            'usage' => 55,
+            'remaining_time' => 20745
           }
-        ]
+        end
+
+        let(:expected_result) do
+          [
+            {
+              'error_type' => 'TOO_MANY_REQUESTS',
+              'error_message' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key",
+              'details' => { 'max' => 24, 'usage' => 55, 'remaining_time' => 20745 }
+            }
+          ]
+        end
+
+        it 'returns an array of errors' do
+          result = error_formatter.to_array
+          expect(result).to eq(expected_result)
+        end
       end
 
-      it 'returns an array of errors' do
-        result = error_formatter.to_array
-        expect(result).to eq(expected_result)
+      context 'when response comes from API Gateway' do
+        let(:error_formatter) { described_class.new(error_response, response_headers) }
+        let(:error_response) do
+          { 'message' => 'API rate limit exceeded' }
+        end
+        let(:response_headers) do
+          {
+            'ratelimit-limit-quotas' => 120,
+            'retry-after-quotas' => 20745
+          }
+        end
+
+        let(:expected_result) do
+          [
+            {
+              'error_type' => 'TOO_MANY_REQUESTS',
+              'error_message' => 'API rate limit exceeded',
+              'details' => { max: 120, usage: 120, remaining_time: 20745 }
+            }
+          ]
+        end
+
+        it 'returns an array of errors' do
+          result = error_formatter.to_array
+          expect(result).to eq(expected_result)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - Rakefile
 - lib/rdstation-ruby-client.rb
 - lib/rdstation.rb
+- lib/rdstation/account.rb
 - lib/rdstation/analytics.rb
 - lib/rdstation/api_response.rb
 - lib/rdstation/authentication.rb
@@ -170,6 +171,7 @@ files:
 - lib/rdstation/webhooks.rb
 - rdstation-ruby-client.gemspec
 - spec/lib/rdstation-ruby-client_spec.rb
+- spec/lib/rdstation/account_spec.rb
 - spec/lib/rdstation/analytics_spec.rb
 - spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
@@ -197,7 +199,7 @@ files:
 - spec/lib/rdstation/webhooks_spec.rb
 - spec/lib/rdstation_spec.rb
 - spec/spec_helper.rb
-homepage: http://resultadosdigitais.com.br
+homepage: https://github.com/ResultadosDigitais/rdstation-ruby-client
 licenses:
 - MIT
 metadata: {}
@@ -222,6 +224,7 @@ specification_version: 4
 summary: Ruby API wrapper for RD Station
 test_files:
 - spec/lib/rdstation-ruby-client_spec.rb
+- spec/lib/rdstation/account_spec.rb
 - spec/lib/rdstation/analytics_spec.rb
 - spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb