rdstation-ruby-client 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ec6b63514d59fdb9636ddb0b47fd90e05e748a9b24178f752759517f488f80
-  data.tar.gz: a595c4bbb8072465e682c0984d2ed325a02d765f9580608657e0f7801f6af5a7
+  metadata.gz: eeaf9150717e1481fce77233ad549b2cd9a7d573f7c9f1e180a2c228c05ef374
+  data.tar.gz: 79c04cb05e857cadb56d6b201ac12e22c30c35920fb1ddf473ea30700168c4fa
 SHA512:
-  metadata.gz: 0c79824e536efc20f694d6a2b13fe1a4f1456db6aff0a3f2172320e67a2d18196fab72b5e8057b9f8b3e72e9bbf19d27dfa2363091e581a96a72c5dfdc38243f
-  data.tar.gz: 85990fc3fcc31d67424d7c59bb9cdeeb7d9519e5d170a27fcca6782e4f9165ec3cf77f4968622024c0a3fbe5a95af66f0690a07a18cef36c15d9d5e333629b49
+  metadata.gz: e7e70fb319205bc1ae61cb7567e82f6c7dae6050fedb403689589ea1b19dc9ca8d8699daa0287bb38f12797c41cb6bfbe20bf832989f2020c70673e4e9f655d9
+  data.tar.gz: 4ab3bc836989453fd41cedebd1fc3aea0d6720fb390b62be913af5029e619c61484cf8c29f20c5228f050304d7cb4dcb641404fb899cdcd1878c0028f1b42fa4

data/.gitignore

@@ -11,6 +11,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock
 
 # YARD artifacts
 .yardoc

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 2.6.0
+
+### Additions
+
+#### 1. New Emails client
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.emails.all
+```
+
+#### 2. New Segmentations client
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.segmentations.all
+```
+
 ## 2.5.1
 
 - Fixed checking `empty?` for nil values inside of InvalidRefreshToken class

data/README.md

@@ -16,7 +16,9 @@ Upgrading? Check the [migration guide](#Migration-guide) before bumping to a new
    4. [Events](#Events)
    5. [Fields](#Fields)
    6. [Webhooks](#Webhooks)
-   7. [Errors](#Errors)
+   7. [Emails](#Emails)
+   8. [Segmentations](#Segmentations)
+   9. [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)
@@ -302,6 +304,46 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.webhooks.delete('WEBHOOK_UUID')
 ```
 
+### Emails
+Endpoints to [Email](https://developers.rdstation.com/reference/get_platform-emails) information in your RD Station account.
+
+#### List all emails
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.emails.all
+```
+
+#### List emails using query params
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+query_params = {page_size: 10, page: 1}
+client.emails.all(query_params)
+```
+
+#### Get email by id
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.emails.by_id(id)
+```
+
+### Segmentations
+Endpoints to [Segmentation](https://developers.rdstation.com/reference/segmenta%C3%A7%C3%B5es) information in your RD Station account.
+#### List all segmentations
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.segmentations.all
+```
+
+#### Get the contact list with a specific segmentation
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.segmentations.contacts(segmentation_id)
+```
+
 ### Errors
 
 Each endpoint may raise errors accoording to the HTTP response code from RDStation:

data/lib/rdstation/authentication.rb

@@ -3,9 +3,7 @@ module RDStation
   class Authentication
     include HTTParty
 
-    AUTH_TOKEN_URL = "#{RDStation.host}/auth/token".freeze
     DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
-    REVOKE_URL = "#{RDStation.host}/auth/revoke".freeze
 
     def initialize(client_id = nil, client_secret = nil)
       warn_deprecation if client_id || client_secret
@@ -51,7 +49,7 @@ module RDStation
 
     def self.revoke(access_token:)
       response = self.post(
-        REVOKE_URL,
+        "#{RDStation.host}/auth/revoke",
         body: revoke_body(access_token),
         headers: revoke_headers(access_token)
       )
@@ -79,7 +77,7 @@ module RDStation
       body = default_body.merge(params)
 
       self.class.post(
-        AUTH_TOKEN_URL,
+        "#{RDStation.host}/auth/token",
         body: body.to_json,
         headers: DEFAULT_HEADERS
       )

data/lib/rdstation/client.rb

@@ -24,6 +24,14 @@ module RDStation
       @webhooks ||= RDStation::Webhooks.new(authorization: @authorization)
     end
 
+    def segmentations
+      @segmentations ||= RDStation::Segmentations.new(authorization: @authorization)
+    end
+
+    def emails
+      @emails ||= RDStation::Emails.new(authorization: @authorization)
+    end
+
     private
 
     def warn_deprecation

data/lib/rdstation/emails.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RDStation
+  class Emails
+    include HTTParty
+    include ::RDStation::RetryableRequest
+
+    def initialize(authorization:)
+      @authorization = authorization
+    end
+
+    def all(query_params={})
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url, headers: authorization.headers, query: query_params)
+        ApiResponse.build(response)
+      end
+    end
+
+    def by_id(id)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url(id), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
+    end
+
+    private
+
+    def base_url(path='')
+      "#{RDStation.host}/platform/emails/#{path}"
+    end
+  end
+end

data/lib/rdstation/events.rb

@@ -1,19 +1,25 @@
+# frozen_string_literal: true
+
 module RDStation
   class Events
     include HTTParty
     include ::RDStation::RetryableRequest
 
-    EVENTS_ENDPOINT = "#{RDStation.host}/platform/events".freeze
-
     def initialize(authorization:)
       @authorization = authorization
     end
 
     def create(payload)
       retryable_request(@authorization) do |authorization|
-        response = self.class.post(EVENTS_ENDPOINT, headers: authorization.headers, body: payload.to_json)
+        response = self.class.post(base_url, headers: authorization.headers, body: payload.to_json)
         ApiResponse.build(response)
       end
     end
+
+    private
+
+    def base_url
+      "#{RDStation.host}/platform/events"
+    end
   end
 end

data/lib/rdstation/fields.rb

@@ -1,26 +1,25 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RDStation
   # More info: https://developers.rdstation.com/pt-BR/reference/fields
   class Fields
     include HTTParty
     include ::RDStation::RetryableRequest
 
-    BASE_URL = "#{RDStation.host}/platform/contacts/fields".freeze
-
     def initialize(authorization:)
       @authorization = authorization
     end
 
     def all
       retryable_request(@authorization) do |authorization|
-        response = self.class.get(BASE_URL, headers: authorization.headers)
+        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)
+        response = self.class.post(base_url, headers: authorization.headers, body: payload.to_json)
         ApiResponse.build(response)
       end
     end
@@ -42,7 +41,7 @@ module RDStation
     private
 
     def base_url(path = '')
-      "#{BASE_URL}/#{path}"
+      "#{RDStation.host}/platform/contacts/fields/#{path}"
     end
   end
 end

data/lib/rdstation/segmentations.rb

@@ -0,0 +1,30 @@
+module RDStation
+  class Segmentations
+    include HTTParty
+    include ::RDStation::RetryableRequest
+
+    def initialize(authorization:)
+      @authorization = authorization
+    end
+
+    def all
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url, headers: authorization.headers)
+        ApiResponse.build(response)
+      end
+    end
+
+    def contacts(segmentation_id)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url("#{segmentation_id}/contacts"), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
+    end
+
+    private
+
+    def base_url(path = '')
+      "#{RDStation.host}/platform/segmentations/#{path}"
+    end
+  end
+end

data/lib/rdstation/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RDStation
-  VERSION = '2.5.2'.freeze
+  VERSION = '2.6.0'
 end

data/lib/rdstation-ruby-client.rb

@@ -13,6 +13,8 @@ require 'rdstation/contacts'
 require 'rdstation/events'
 require 'rdstation/fields'
 require 'rdstation/webhooks'
+require 'rdstation/segmentations'
+require 'rdstation/emails'
 
 # Error handling
 require 'rdstation/error'

data/spec/lib/rdstation/emails_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::Emails do
+  let(:emails_client) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: 'access_token'))
+  end
+
+  let(:emails_endpoint) { 'https://api.rd.services/platform/emails/' }
+
+  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 '#all' do
+    let(:emails_list) do
+      {
+        items: [
+          {
+            id: 123,
+            name: 'Marketing email',
+            created_at: '2017-11-21T20:00:00-02:00',
+            updated_at: '2017-11-21T20:00:00-02:00',
+            send_at: '2017-11-21T20:00:00-02:00',
+            leads_count: 55_000,
+            status: 'FINISHED',
+            type: 'email_model',
+            is_predictive_sending: false,
+            sending_is_imminent: false,
+            behavior_score_info: {
+              disengaged: false,
+              engaged: false,
+              indeterminate: false
+            },
+            campaign_id: 123,
+            component_template_id: 123
+          }
+        ],
+        total: 1
+      }.to_json
+    end
+
+    it 'calls retryable_request' do
+      expect(emails_client).to receive(:retryable_request)
+      emails_client.all
+    end
+
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, emails_endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: emails_list.to_json)
+      end
+
+      it 'returns all emails' do
+        response = emails_client.all
+        expect(response).to eq(emails_list)
+      end
+    end
+
+    context 'when the request contains query params' do
+      let(:query_params) do
+        {
+          page: 1,
+          page_size: 10,
+          query: 'Test',
+          ids: '123, 456',
+          types: 'CAMPAIGN_EMAIL'
+        }
+      end
+
+      before do
+        stub_request(:get, emails_endpoint)
+          .with(headers: headers, query: query_params)
+          .to_return(status: 200, body: emails_list.to_json)
+      end
+
+      it 'returns emails filtered by the query params' do
+        response = emails_client.all(query_params)
+        expect(response).to eq(emails_list)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, emails_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        emails_client.all
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+
+  describe '#by_id' do
+    let(:id) { 123 }
+    let(:emails_endpoint_by_id) { emails_endpoint + id.to_s }
+
+    it 'calls retryable_request' do
+      expect(emails_client).to receive(:retryable_request)
+      emails_client.by_id(id)
+    end
+
+    context 'when the request is successful' do
+      let(:email) do
+        {
+          id: 123,
+          name: 'Marketing email',
+          created_at: '2017-11-21T20:00:00-02:00',
+          updated_at: '2017-11-21T20:00:00-02:00',
+          send_at: '2017-11-21T20:00:00-02:00',
+          leads_count: 55_000,
+          status: 'FINISHED',
+          type: 'email_model',
+          is_predictive_sending: false,
+          sending_is_imminent: false,
+          behavior_score_info: {
+            disengaged: false,
+            engaged: false,
+            indeterminate: false
+          },
+          campaign_id: 123,
+          component_template_id: 123
+        }.to_json
+      end
+
+      before do
+        stub_request(:get, emails_endpoint_by_id)
+          .with(headers: headers)
+          .to_return(status: 200, body: email.to_json)
+      end
+
+      it 'returns the email' do
+        response = emails_client.by_id(id)
+        expect(response).to eq(email)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, emails_endpoint_by_id)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        emails_client.by_id(id)
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+end

data/spec/lib/rdstation/fields_spec.rb

@@ -1,6 +1,14 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe RDStation::Fields do
+  before do
+    RDStation.configure do |config|
+      config.base_host = 'https://sample.rd.services'
+    end
+  end
+
   let(:valid_access_token) { 'valid_access_token' }
   let(:rdstation_fields_with_valid_token) do
     described_class.new(authorization: RDStation::Authorization.new(access_token: valid_access_token))
@@ -14,7 +22,7 @@ RSpec.describe RDStation::Fields do
   end
 
   describe '#all' do
-    let(:fields_endpoint) { 'https://api.rd.services/platform/contacts/fields' }
+    let(:fields_endpoint) { 'https://sample.rd.services/platform/contacts/fields/' }
     let(:all_account_fields) do
       {
         'fields' => [

data/spec/lib/rdstation/segmentations_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::Segmentations do
+  let(:segmentations_client) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: 'access_token'))
+  end
+
+  let(:segmentations_endpoint) { 'https://api.rd.services/platform/segmentations/' }
+
+  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 '#all' do
+    it 'calls retryable_request' do
+      expect(segmentations_client).to receive(:retryable_request)
+      segmentations_client.all
+    end
+
+    context 'when the request is successful' do
+      let(:segmentations) do
+        {
+          segmentations: [
+            {
+              id: 1,
+              name: 'Todos os contatos da base',
+              standard: true,
+              created_at: '2021-09-24T14:14:04.510-03:00',
+              updated_at: '2021-09-24T14:14:04.510-03:00',
+              process_status: 'processed',
+              links: [
+                {
+                  rel: 'SELF',
+                  href: 'https://api.rd.services/platform/segmentations/1/contacts',
+                  media: 'application/json',
+                  type: 'GET'
+                }
+              ]
+            }
+          ]
+        }.to_json
+      end
+
+      before do
+        stub_request(:get, segmentations_endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: segmentations.to_json)
+      end
+
+      it 'returns all segmentations' do
+        response = segmentations_client.all
+        expect(response).to eq(segmentations)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, segmentations_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        segmentations_client.all
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+
+  describe '#contacts' do
+    let(:segmentation_id) { 123 }
+    let(:segmentations_endpoint_by_contacts) { segmentations_endpoint + "#{segmentation_id}/contacts" }
+
+    it 'calls retryable_request' do
+      expect(segmentations_client).to receive(:retryable_request)
+      segmentations_client.contacts(segmentation_id)
+    end
+
+    context 'when the request is successful' do
+      let(:contact) do
+        {
+          contacts: [
+            {
+              uuid: '5408c5a3-4711-4f2e-8d0b-13407a3e30f3',
+              name: 'Lead Example 1',
+              email: 'leadexample1@example.com',
+              last_conversion_date: '2021-09-13T15:01:06.325-03:00',
+              created_at: '2021-09-13T15:01:06.325-03:00',
+              links: [
+                {
+                  rel: 'SELF',
+                  href: 'https://api.rd.services/platform/contacts/5408c5a3-4711-4f2e-8d0b-13407a3e30f3',
+                  media: 'application/json',
+                  type: 'GET'
+                }
+              ]
+            }
+          ]
+        }.to_json
+      end
+
+      before do
+        stub_request(:get, segmentations_endpoint_by_contacts)
+          .with(headers: headers)
+          .to_return(status: 200, body: contact.to_json)
+      end
+
+      it 'returns the contact' do
+        response = segmentations_client.contacts(segmentation_id)
+        expect(response).to eq(contact)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, segmentations_endpoint_by_contacts)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        segmentations_client.contacts(segmentation_id)
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.6.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,7 @@ files:
 - lib/rdstation/builder/field.rb
 - lib/rdstation/client.rb
 - lib/rdstation/contacts.rb
+- lib/rdstation/emails.rb
 - lib/rdstation/error.rb
 - lib/rdstation/error/format.rb
 - lib/rdstation/error/formatter.rb
@@ -162,6 +163,7 @@ files:
 - lib/rdstation/events.rb
 - lib/rdstation/fields.rb
 - lib/rdstation/retryable_request.rb
+- lib/rdstation/segmentations.rb
 - lib/rdstation/version.rb
 - lib/rdstation/webhooks.rb
 - rdstation-ruby-client.gemspec
@@ -172,6 +174,7 @@ files:
 - spec/lib/rdstation/builder/field_spec.rb
 - spec/lib/rdstation/client_spec.rb
 - spec/lib/rdstation/contacts_spec.rb
+- spec/lib/rdstation/emails_spec.rb
 - spec/lib/rdstation/error/format_spec.rb
 - spec/lib/rdstation/error/formatter_spec.rb
 - spec/lib/rdstation/error_handler/conflicting_field_spec.rb
@@ -186,6 +189,7 @@ files:
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
 - spec/lib/rdstation/retryable_request_spec.rb
+- spec/lib/rdstation/segmentations_spec.rb
 - spec/lib/rdstation/webhooks_spec.rb
 - spec/lib/rdstation_spec.rb
 - spec/spec_helper.rb
@@ -220,6 +224,7 @@ test_files:
 - spec/lib/rdstation/builder/field_spec.rb
 - spec/lib/rdstation/client_spec.rb
 - spec/lib/rdstation/contacts_spec.rb
+- spec/lib/rdstation/emails_spec.rb
 - spec/lib/rdstation/error/format_spec.rb
 - spec/lib/rdstation/error/formatter_spec.rb
 - spec/lib/rdstation/error_handler/conflicting_field_spec.rb
@@ -234,6 +239,7 @@ test_files:
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
 - spec/lib/rdstation/retryable_request_spec.rb
+- spec/lib/rdstation/segmentations_spec.rb
 - spec/lib/rdstation/webhooks_spec.rb
 - spec/lib/rdstation_spec.rb
 - spec/spec_helper.rb