rdstation-ruby-client 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeaf9150717e1481fce77233ad549b2cd9a7d573f7c9f1e180a2c228c05ef374
-  data.tar.gz: 79c04cb05e857cadb56d6b201ac12e22c30c35920fb1ddf473ea30700168c4fa
+  metadata.gz: f95c666afffacdbac2a2903c5b8909999bb24bba716f89d4646ee19c165bc262
+  data.tar.gz: 1beded8e2c402f5bb89523e3e20d5ee8ed485f6687819317f558f958bdd90353
 SHA512:
-  metadata.gz: e7e70fb319205bc1ae61cb7567e82f6c7dae6050fedb403689589ea1b19dc9ca8d8699daa0287bb38f12797c41cb6bfbe20bf832989f2020c70673e4e9f655d9
-  data.tar.gz: 4ab3bc836989453fd41cedebd1fc3aea0d6720fb390b62be913af5029e619c61484cf8c29f20c5228f050304d7cb4dcb641404fb899cdcd1878c0028f1b42fa4
+  metadata.gz: 4803cf2a2f16e6982c84d84d9109c03130f8df4ff4d92ecfc9b5500e96383afdf6527b7dd834d7d1256d9947ab67f4aeed6d70591a2a86c3edf9b10ad7cced70
+  data.tar.gz: 344733aa7473f0d0db3391e26fc4a00648b9123ded0a5713549ab67462fdc528ef1a3256774d728aa2df6490cbdc989e65c2538e9a81c3f9829ab6f0622c303f

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,17 @@
+## 2.7.0
+
+### Additions
+
+#### 1. New Analytics client
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+query_parms =  { 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,8 @@ 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. [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,7 +344,17 @@ 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/get_platform-analytics-emails) information in your RD Station account.
 
+#### List all email marketing analytics data
+- 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_parms =  { start_date:'2022-11-02', end_date:'2022-11-08' }
+client.analytics.email_marketing(query_params)
+```
 ### Errors
 
 Each endpoint may raise errors accoording to the HTTP response code from RDStation:

data/lib/rdstation/analytics.rb

@@ -0,0 +1,25 @@
+# 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, headers: authorization.headers, query: query_params)
+        ApiResponse.build(response)
+      end
+    end
+
+    private
+
+    def base_url
+      "#{RDStation.host}/platform/analytics/emails"
+    end
+  end
+end

data/lib/rdstation/client.rb

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

data/lib/rdstation/version.rb

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

data/lib/rdstation-ruby-client.rb

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

data/spec/lib/rdstation/analytics_spec.rb

@@ -0,0 +1,107 @@
+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(:analytics_endpoint) { 'https://api.rd.services/platform/analytics/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 '#email_marketing' do
+    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
+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))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.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-09 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
@@ -168,6 +169,7 @@ files:
 - 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
@@ -218,6 +220,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