rdstation-ruby-client 2.8.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 365408ab365bf2acacec98dfa4765b19b642a90a1d6fce3edccd09db8e10e0e3
-  data.tar.gz: 9296202984e88f88c38114be6fca87e68f4d87a3693fc7d4f2765c5f63b4821c
+  metadata.gz: c3de60aebf7582be38403250a4d049f3428241b66a18acb085cdd71f542cb8a0
+  data.tar.gz: '0829e4b85cae5dd80c64395f6e460ebb315fee92853d81a5feb263adaa2e3efe'
 SHA512:
-  metadata.gz: 324fc169085b6b89ef45d509807f4286b8358f8f72e35a944659fef19623bb3280a316d1f3d50178275f2a8c0e39b6d15621ac7e7b01b9fc90ff0bac10601944
-  data.tar.gz: 7ea2fc324339bcd68c22a0d9b0560e00fdd2289e7feda605819c22e516c566b6a2d80af0f14ef57b02de044a1f451a159ee727cc17457dd9197e44f255aaa2fc
+  metadata.gz: 1206caba197401915572f9bb66dd2c45ad2c019d8ce5899d0667753043066cce96edfc39207054549de900cf57e3eb1179c6e4bcf58bed5bac459ef37d49cc12
+  data.tar.gz: c27a1e2c5d5d3ef4ddc3cfc1f0369f9be0cf09c040147fe1409bcc6d77a3c4d2fc7f697f3d40db2f83fbc2a0c79cad61e9378d4cbc3eedc9df0fe9ec9eaa91ef

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 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

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)
@@ -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:

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RDStation
-  VERSION = '2.8.2'
+  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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-02 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
@@ -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