rdstation-ruby-client 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeaf9150717e1481fce77233ad549b2cd9a7d573f7c9f1e180a2c228c05ef374
-  data.tar.gz: 79c04cb05e857cadb56d6b201ac12e22c30c35920fb1ddf473ea30700168c4fa
+  metadata.gz: f9c55a165bdad7cd10471e913f2f531d429e4200c7180b291d55695e5370c585
+  data.tar.gz: f88b126bc80b46bb3b7ffd5f5d424190251f8d93f3c787aeefb291c6ccdec544
 SHA512:
-  metadata.gz: e7e70fb319205bc1ae61cb7567e82f6c7dae6050fedb403689589ea1b19dc9ca8d8699daa0287bb38f12797c41cb6bfbe20bf832989f2020c70673e4e9f655d9
-  data.tar.gz: 4ab3bc836989453fd41cedebd1fc3aea0d6720fb390b62be913af5029e619c61484cf8c29f20c5228f050304d7cb4dcb641404fb899cdcd1878c0028f1b42fa4
+  metadata.gz: bc9a5c11adcc7d45451b2b069b3634c08bb3a47a9af4b473f7d2a39222969764cf80cd746d4d74cf723a6ff46b03f3983a1257f72f5a6a6f88085d2bc7929785
+  data.tar.gz: 17df3fc0b5abaa008377680764ef12a9fadb99a1d44a1fdbc3d76ea656776f07a51da3a348c00fc2982691b517f89d596d0d6e1fd1ca553bb5fd8e007c80ccac

data/.circleci/config.yml

@@ -22,7 +22,7 @@ jobs:
       # Download and cache dependencies
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          - v1-dependencies-{{ checksum "rdstation-ruby-client.gemspec" }}
           # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
 
@@ -34,7 +34,7 @@ jobs:
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+          key: v1-dependencies-{{ checksum "rdstation-ruby-client.gemspec" }}
         
       # run tests!
       - run:

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+## 2.8.0
+
+### Additions
+
+#### 1. New Analytics client: conversions
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+query_params =  { start_date:'2022-11-13', end_date:'2022-11-15', assets_type:['LandingPage'] }
+client.analytics.conversions(query_params)
+```
+
+#### 2. New landing_pages client
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.landing_pages.all
+```
+
+## 2.7.0
+
+### Additions
+
+#### 1. New Analytics client
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+query_params =  { start_date:'2022-11-02', end_date:'2022-11-08' }
+client.analytics.email_marketing(query_params)
+```
+
 ## 2.6.0
 
 ### Additions

data/README.md

@@ -18,7 +18,9 @@ Upgrading? Check the [migration guide](#Migration-guide) before bumping to a new
    6. [Webhooks](#Webhooks)
    7. [Emails](#Emails)
    8. [Segmentations](#Segmentations)
-   9. [Errors](#Errors)
+   9. [Analytics](#Analytics)
+   10.[LandingPages](#LandingPages)
+   11.[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)
@@ -343,6 +345,37 @@ client.segmentations.all
 client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
 client.segmentations.contacts(segmentation_id)
 ```
+### Analytics
+Endpoints to [Analytics](https://developers.rdstation.com/reference/estatisticas) information in your RD Station account.
+
+#### => List all EMAIL MARKETING analytics data
+Endpoints to [Analytics - Email marketing](https://developers.rdstation.com/reference/get_platform-analytics-emails) information in your RD Station account.
+- NOTE: The query params `start_date`(yyyy-mm-dd)  and `end_date`(yyyy-mm-dd) are required
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+query_params =  { start_date:'2022-11-02', end_date:'2022-11-08' }
+client.analytics.email_marketing(query_params)
+```
+
+#### => List CONVERSIONS analytics data
+Endpoints to [Analytics - Conversions](https://developers.rdstation.com/reference/get_platform-analytics-conversions) information in your RD Station account.
+- NOTE: The query params `start_date`(yyyy-mm-dd) and `end_date`(yyyy-mm-dd) are required.
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+query_params =  { start_date:'2022-11-13', end_date:'2022-11-15', assets_type:['LandingPage'] }
+client.analytics.conversions(query_params)
+```
+
+### LandingPages
+Endpoints to [LandingPages](https://developers.rdstation.com/reference/get_platform-landing-pages) information in your RD Station account.
+#### List all landing_pages
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.landing_pages.all
+```
 
 ### Errors
 

data/lib/rdstation/analytics.rb

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

data/lib/rdstation/client.rb

@@ -32,6 +32,14 @@ module RDStation
       @emails ||= RDStation::Emails.new(authorization: @authorization)
     end
 
+    def analytics
+      @analytics ||= RDStation::Analytics.new(authorization: @authorization)
+    end
+
+    def landing_pages
+      @landing_pages ||= RDStation::LandingPages.new(authorization: @authorization)
+    end
+
     private
 
     def warn_deprecation

data/lib/rdstation/landing_pages.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RDStation
+  class LandingPages
+    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
+
+    private
+
+    def base_url(path='')
+      "#{RDStation.host}/platform/landing_pages/#{path}"
+    end
+  end
+end

data/lib/rdstation/version.rb

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

data/lib/rdstation-ruby-client.rb

@@ -15,6 +15,8 @@ require 'rdstation/fields'
 require 'rdstation/webhooks'
 require 'rdstation/segmentations'
 require 'rdstation/emails'
+require 'rdstation/analytics'
+require 'rdstation/landing_pages'
 
 # Error handling
 require 'rdstation/error'

data/spec/lib/rdstation/analytics_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::Analytics do
+  let(:analytics_client) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: 'access_token'))
+  end
+
+  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 '#email_marketing' do
+    let(:analytics_endpoint) { 'https://api.rd.services/platform/analytics/emails' }
+    let(:analytics_list) do
+      {
+        account_id: 1,
+        query_date: {
+          start_date: "2022-11-08",
+          end_date: "2022-11-08"
+        },
+        emails: [
+          {
+            campaign_id: 6061281,
+            campaign_name: "Desconto",
+            send_at: "2021-08-06T17:26:39-03:00",
+            contacts_count: 1000,
+            email_dropped_count: 3,
+            email_delivered_count: 997,
+            email_bounced_count: 5,
+            email_opened_count: 500,
+            email_clicked_count: 500,
+            email_unsubscribed_count: 4,
+            email_spam_reported_count: 1,
+            email_delivered_rate: 98.7,
+            email_opened_rate: 46.9,
+            email_clicked_rate: 36.5,
+            email_spam_reported_rate: 0
+          }
+        ]
+      }.to_json
+    end
+
+    it 'calls retryable_request' do
+      expect(analytics_client).to receive(:retryable_request)
+      analytics_client.email_marketing
+    end
+
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, analytics_endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: analytics_list.to_json)
+      end
+
+      it 'returns all email marketing analytics data' do
+        response = analytics_client.email_marketing
+        expect(response).to eq(analytics_list)
+      end
+    end
+
+    context 'when the request contains query params' do
+      let(:query_params) do
+        {
+          start_date:'2022-11-2',
+          end_date:'2022-11-8',
+          campaign_id: '6061281'
+        }
+      end
+
+      before do
+        stub_request(:get, analytics_endpoint)
+          .with(headers: headers, query: query_params)
+          .to_return(status: 200, body: analytics_list.to_json)
+      end
+
+      it 'returns email marketing analytics data filtered by the query params' do
+        response = analytics_client.email_marketing(query_params)
+        expect(response).to eq(analytics_list)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, analytics_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        analytics_client.email_marketing
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+
+  describe '#conversions' do
+    let(:analytics_endpoint) { 'https://api.rd.services/platform/analytics/conversions' }
+    let(:analytics_list) do
+      {
+        account_id: 3127612,
+        query_date: {
+          start_date: "2022-11-17",
+          end_date: "2022-11-17"
+        },
+        assets_type: "[LandingPage]",
+        conversions: [
+          {
+            asset_id: 1495004,
+            asset_identifier: "Como aumentar suas taxas de conversão",
+            asset_type: "LandingPage",
+            asset_created_at: "2022-06-30T19:11:05.191Z",
+            asset_updated_at: "2022-06-30T20:11:05.191Z",
+            visits_count: 1500,
+            conversions_count: 150,
+            conversion_rate: 10
+          }
+        ]
+      }.to_json
+    end
+
+    it 'calls retryable_request' do
+      expect(analytics_client).to receive(:retryable_request)
+      analytics_client.conversions
+    end
+
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, analytics_endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: analytics_list.to_json)
+      end
+
+      it 'returns all email marketing analytics data' do
+        response = analytics_client.conversions
+        expect(response).to eq(analytics_list)
+      end
+    end
+
+    context 'when the request contains query params' do
+      let(:query_params) do
+        {
+          start_date:'2022-11-17',
+          end_date:'2022-11-17',
+          asset_id: '1495004'
+        }
+      end
+
+      before do
+        stub_request(:get, analytics_endpoint)
+          .with(headers: headers, query: query_params)
+          .to_return(status: 200, body: analytics_list.to_json)
+      end
+
+      it 'returns conversions analytics data filtered by the query params' do
+        response = analytics_client.conversions(query_params)
+        expect(response).to eq(analytics_list)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, analytics_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        analytics_client.conversions
+        expect(error_handler).to have_received(:raise_error)
+      end
+    end
+  end
+end

data/spec/lib/rdstation/fields_spec.rb

@@ -9,6 +9,12 @@ RSpec.describe RDStation::Fields do
     end
   end
 
+  after do
+    RDStation.configure do |config|
+      config.base_host = 'https://api.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))

data/spec/lib/rdstation/landing_pages_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::LandingPages do
+  let(:landing_pages_client) do
+    described_class.new(authorization: RDStation::Authorization.new(access_token: 'access_token'))
+  end
+  let(:landing_pages_endpoint) { 'https://api.rd.services/platform/landing_pages/' }
+
+  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(:landing_pages_list) do
+      [
+        {
+          id: 1,
+          title: "Minha Primeira Landing Page",
+          created_at: "2021-09-22T14:14:04.510-03:00",
+          upated_at: "2021-09-24T14:14:04.510-03:00",
+          conversion_identifier: "dia-das-mães-2022",
+          status: "PUBLISHED",
+          has_active_experiment: false,
+          had_experiment: false
+        }
+      ].to_json
+    end
+
+    it 'calls retryable_request' do
+      expect(landing_pages_client).to receive(:retryable_request)
+      landing_pages_client.all
+    end
+
+    context 'when the request is successful' do
+      before do
+        stub_request(:get, landing_pages_endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: landing_pages_list.to_json)
+      end
+
+      it 'returns all email marketing analytics data' do
+        response = landing_pages_client.all
+        expect(response).to eq(landing_pages_list)
+      end
+    end
+
+    context 'when the request contains query params' do
+      let(:query_params) { { page: 1 } }
+
+      before do
+        stub_request(:get, landing_pages_endpoint)
+          .with(headers: headers, query: query_params)
+          .to_return(status: 200, body: landing_pages_list.to_json)
+      end
+
+      it 'returns email marketing analytics data filtered by the query params' do
+        response = landing_pages_client.all(query_params)
+        expect(response).to eq(landing_pages_list)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, landing_pages_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_error on error handler' do
+        landing_pages_client.all
+        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.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-11-18 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/analytics.rb
 - lib/rdstation/api_response.rb
 - lib/rdstation/authentication.rb
 - lib/rdstation/authorization.rb
@@ -162,12 +163,14 @@ files:
 - lib/rdstation/error_handler/unauthorized.rb
 - lib/rdstation/events.rb
 - lib/rdstation/fields.rb
+- lib/rdstation/landing_pages.rb
 - lib/rdstation/retryable_request.rb
 - lib/rdstation/segmentations.rb
 - lib/rdstation/version.rb
 - lib/rdstation/webhooks.rb
 - rdstation-ruby-client.gemspec
 - spec/lib/rdstation-ruby-client_spec.rb
+- spec/lib/rdstation/analytics_spec.rb
 - spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
 - spec/lib/rdstation/authorization_spec.rb
@@ -188,6 +191,7 @@ files:
 - spec/lib/rdstation/error_spec.rb
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
+- spec/lib/rdstation/landing_pages_spec.rb
 - spec/lib/rdstation/retryable_request_spec.rb
 - spec/lib/rdstation/segmentations_spec.rb
 - spec/lib/rdstation/webhooks_spec.rb
@@ -218,6 +222,7 @@ specification_version: 4
 summary: Ruby API wrapper for RD Station
 test_files:
 - spec/lib/rdstation-ruby-client_spec.rb
+- spec/lib/rdstation/analytics_spec.rb
 - spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
 - spec/lib/rdstation/authorization_spec.rb
@@ -238,6 +243,7 @@ test_files:
 - spec/lib/rdstation/error_spec.rb
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
+- spec/lib/rdstation/landing_pages_spec.rb
 - spec/lib/rdstation/retryable_request_spec.rb
 - spec/lib/rdstation/segmentations_spec.rb
 - spec/lib/rdstation/webhooks_spec.rb