rdstation-ruby-client 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ade7306767c00b8d39afdeb149d4aaebe84dfd35b389e2bf1435e623dfabfb7
-  data.tar.gz: 3bdc3dc84ff1395fa65dc86e172b5ca967696e88b60bf9774723fcd33c785fbe
+  metadata.gz: 93cdc7036300cb21cf4609bb92042f47e280a864f84cfaba3b5a9e6181274aad
+  data.tar.gz: 349d48fb5a969953c3e637b0cf73aef037328aafff3aeb779c7f217c0ac1e537
 SHA512:
-  metadata.gz: fddd4b51c76c965cbd44bda5e36712f26f694fbabd59a7c0b008174cfcacd4225b73ce7640b32e9aeaed2495950ff0c19b70a555b5d8bf0dab79eaf2ce060136
-  data.tar.gz: 90d96ef3c8d917deb7adbfe0aff6e2625b7f4f1d925d6b54e806df9aa3fd3de6378358521bbfce024eb32af06695f0974ca0f0dd8b9684ed1c537f2d228c97de
+  metadata.gz: 8cfa5e1cd4d75f9a30536b99055075e92a7bdb3630ed8b71cfc66f4032983677079d78663d9eaadc4fcfb88875665281e271b270c6a584e93a81b5065bd7f005
+  data.tar.gz: 7e64c0b2983ce2d081d4236c42d432a7c994f2927f17e766020067b512a2ed47b1988acdc5c1a8d81edaf3cd0acc43f96209e1a0192abb11d0f52074758a1989

data/CHANGELOG.md

@@ -1,3 +1,54 @@
+## 2.3.0
+
+### Additions
+
+#### 1. New Field methods
+
+The following methods were added to "Fields" client:
+
+- create
+- update
+- delete
+
+Besides reading, this client is now capable of create, update or delete a field.
+
+Usage example:
+
+```ruby
+client = RDStation::Client.new(access_token: 'ACCESS_TOKEN', refresh_token: 'REFRESH_TOKEN')
+client.fields.delete('FIELD_UUID')
+```
+
+#### 2. New format of errors supported
+
+Two new formats of errors are now supported by the error handler:
+
+##### `HASH_OF_HASHES`
+
+When the error message is a hash containing other hashes as values, for example:
+
+```ruby
+{
+  'error' => {
+    'field1' => {...},
+    'field2' => {...}
+  }
+}
+```
+
+##### `HASH_OF_MULTIPLE_TYPES`
+
+When the error message is a hash that could contain multiple data types as values, for example:
+
+```ruby
+{
+  'error' => {
+    'field1' => [...] # Array,
+    'field2' => {...} # Hash
+  }
+}
+```
+
 ## 2.2.0
 
 ### Additions
@@ -37,7 +88,7 @@ end
 
 Providing `client_id` and `client_secret` directly to `RDStation::Authentication.new` is deprecated and will be removed in future versions. Use `RDStation.configure` instead.
 
-Specifying refresh_token in `RDStation::Client.new(access_token: 'at', refresh_token: 'rt')` is optional right now, but will be mandatory in future versions. 
+Specifying refresh_token in `RDStation::Client.new(access_token: 'at', refresh_token: 'rt')` is optional right now, but will be mandatory in future versions.
 
 ## 2.1.1
 
@@ -94,7 +145,7 @@ In case of a Bad Request (400), the following specific errors may be raised (tho
 - `RDStation::Error::ConflictingField`
 - `RDStation::Error::InvalidEventType`
 
-In cause of Unahtorized (401), the following specific errors may be raised (those are subclasses of `RDStation::Error::Unauthorized`):
+In cause of Unauthorized (401), the following specific errors may be raised (those are subclasses of `RDStation::Error::Unauthorized`):
 - `RDStation::Error::ExpiredAccessToken`
 - `RDStation::Error::ExpiredCodeGrant`
 - `RDStation::Error::InvalidCredentials`

data/README.md

@@ -206,6 +206,55 @@ client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'ref
 client.fields.all
 ```
 
+#### Create a field
+
+```ruby
+payload = {} # hash representing the payload
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.fields.create payload
+```
+Or you can use the new `RDStation::Builder::Field`
+
+```ruby
+payload = {} # hash representing the payload
+builder = RDStation::Builder::Field.new payload['api_identifier']
+builder.data_type(payload['data_type'])
+builder.presentation_type(payload['presentation_type'])
+builder.name('pt-BR', payload['name'])
+builder.label('pt-BR', payload['label'])
+
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.fields.create builder.build
+```
+
+#### Update a field
+
+```ruby
+payload = {} # hash representing the payload
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.fields.update('FIELD_UUID', payload) 
+```
+Or you can use the new `RDStation::Builder::Field`
+
+```ruby
+payload = {} # hash representing the payload
+builder = RDStation::Builder::Field.new payload['api_identifier']
+builder.data_type(payload['data_type'])
+builder.presentation_type(payload['presentation_type'])
+builder.name('pt-BR', payload['name'])
+builder.label('pt-BR', payload['label'])
+
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.fields.update('FIELD_UUID', builder.build)
+```
+#### Deleting a field
+
+```ruby
+client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
+client.fields.delete('FIELD_UUID')
+```
+
+
 ### Webhooks
 
 Webhooks provide the ability to receive real-time data updates about your contact activity.

data/lib/rdstation-ruby-client.rb

@@ -17,3 +17,6 @@ require 'rdstation/webhooks'
 # Error handling
 require 'rdstation/error'
 require 'rdstation/error_handler'
+
+# Builders
+require 'rdstation/builder/field'

data/lib/rdstation/builder/field.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RDStation
+  class Builder
+    # More info: https://developers.rdstation.com/pt-BR/reference/fields#methodPostDetails
+    class Field
+      DATA_TYPES = %w(STRING INTEGER BOOLEAN STRING[]).freeze
+      PRESENTATION_TYPES = %w[TEXT_INPUT TEXT_AREA URL_INPUT PHONE_INPUT
+                              EMAIL_INPUT CHECK_BOX NUMBER_INPUT COMBO_BOX
+                              RADIO_BUTTON MULTIPLE_CHOICE].freeze
+
+      REQUIRED_FIELDS = %w[api_identifier data_type presentation_type label name].freeze
+
+      def initialize(api_identifier)
+        raise 'api_identifier required' unless api_identifier
+        unless valid_identifier(api_identifier)
+          raise 'api_identifier is not in a valid format, need start with "cf_"'
+        end
+
+        @values = {}
+        @values['api_identifier'] = api_identifier
+      end
+
+      def data_type(data_type)
+        raise "Not valid data_type - #{DATA_TYPES}" unless DATA_TYPES.include? data_type
+
+        @values['data_type'] = data_type
+      end
+
+      def presentation_type(presentation_type)
+        unless PRESENTATION_TYPES.include? presentation_type
+          raise "Not valid presentation_type - #{PRESENTATION_TYPES}"
+        end
+
+        @values['presentation_type'] = presentation_type
+      end
+
+      def label(language, label)
+        @values['label'] = { language.to_s => label }
+      end
+
+      def name(language, name)
+        @values['name'] = { language.to_s => name }
+      end
+
+      def validation_rules(validation_rules)
+        @values['validation_rules'] = validation_rules
+      end
+
+      def valid_options(valid_options)
+        @values['valid_options'] = valid_options
+      end
+
+      def build
+        empty_fields = REQUIRED_FIELDS.select { |field| @values[field].nil? }
+        unless empty_fields.empty?
+          raise "Required fields are missing - #{empty_fields}"
+        end
+
+        @values
+      end
+
+      private
+
+      def valid_identifier(api_identifier)
+        api_identifier.start_with? 'cf_'
+      end
+    end
+  end
+end

data/lib/rdstation/error/format.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module RDStation
   class Error
     class Format
-      FLAT_HASH = 'FLAT_HASH'.freeze
-      HASH_OF_ARRAYS = 'HASH_OF_ARRAYS'.freeze
-      ARRAY_OF_HASHES = 'ARRAY_OF_HASHES'.freeze
+      FLAT_HASH = 'FLAT_HASH'
+      HASH_OF_ARRAYS = 'HASH_OF_ARRAYS'
+      ARRAY_OF_HASHES = 'ARRAY_OF_HASHES'
+      HASH_OF_MULTIPLE_TYPES = 'HASH_OF_MULTIPLE_TYPES'
+      HASH_OF_HASHES = 'HASH_OF_HASHES'
 
       def initialize(errors)
         @errors = errors
@@ -12,6 +16,9 @@ module RDStation
       def format
         return FLAT_HASH if flat_hash?
         return HASH_OF_ARRAYS if hash_of_arrays?
+        return HASH_OF_HASHES if hash_of_hashes?
+        return HASH_OF_MULTIPLE_TYPES if hash_of_multiple_types?
+
         ARRAY_OF_HASHES
       end
 
@@ -19,12 +26,23 @@ module RDStation
 
       def flat_hash?
         return unless @errors.is_a?(Hash)
+
         @errors.key?('error_type')
       end
 
       def hash_of_arrays?
         @errors.is_a?(Hash) && @errors.values.all? { |error| error.is_a? Array }
       end
+
+      def hash_of_hashes?
+        @errors.is_a?(Hash) && @errors.values.all? { |error| error.is_a? Hash }
+      end
+
+      def hash_of_multiple_types?
+        @errors.is_a?(Hash) &&
+          @errors.values.any? { |error| error.is_a? Hash } &&
+          @errors.values.any? { |error| error.is_a? Array }
+      end
     end
   end
 end

data/lib/rdstation/error/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './format'
 
 module RDStation
@@ -15,6 +17,10 @@ module RDStation
           return from_flat_hash
         when RDStation::Error::Format::HASH_OF_ARRAYS
           return from_hash_of_arrays
+        when RDStation::Error::Format::HASH_OF_HASHES
+          return from_hash_of_hashes
+        when RDStation::Error::Format::HASH_OF_MULTIPLE_TYPES
+          return from_hash_of_multiple_types
         end
 
         errors
@@ -24,14 +30,29 @@ module RDStation
         [errors]
       end
 
-      def from_hash_of_arrays
-        errors.each_with_object([]) do |errors, array_of_errors|
-          attribute_name = errors.first
-          attribute_errors = errors.last
-          path = { 'path' => "body.#{attribute_name}" }
-          errors = attribute_errors.map { |error| error.merge(path) }
-          array_of_errors.push(*errors)
+      def from_hash_of_multiple_types
+        array_of_errors = []
+        errors.each do |attribute_name, errors|
+          if errors.is_a? Array
+            result = build_error_from_array(attribute_name, errors)
+          end
+          if errors.is_a? Hash
+            result = build_error_from_multilingual_hash(attribute_name, errors)
+          end
+          array_of_errors.push(*result)
         end
+
+        array_of_errors
+      end
+
+      def from_hash_of_hashes
+        array_of_errors = []
+        errors.each do |attribute_name, errors|
+          result = build_error_from_multilingual_hash(attribute_name, errors)
+          array_of_errors.push(*result)
+        end
+
+        array_of_errors
       end
 
       def error_format
@@ -41,6 +62,31 @@ module RDStation
       def errors
         @errors ||= @error_response['errors']
       end
+
+      private
+
+      def build_error_from_array(attribute_name, attribute_errors)
+        path = { 'path' => "body.#{attribute_name}" }
+        attribute_errors.map { |error| error.merge(path) }
+      end
+
+      def build_error_from_multilingual_hash(attribute_name, errors_by_language)
+        array_of_errors = []
+        errors_by_language.each do |language, errors|
+          result = build_error_from_array("#{attribute_name}.#{language}", errors)
+          array_of_errors.push(*result)
+        end
+        array_of_errors
+      end
+
+      def from_hash_of_arrays
+        errors.each_with_object([]) do |errors, array_of_errors|
+          attribute_name = errors.first
+          attribute_errors = errors.last
+          errors = build_error_from_array(attribute_name, attribute_errors)
+          array_of_errors.push(*errors)
+        end
+      end
     end
   end
 end

data/lib/rdstation/events.rb

@@ -12,16 +12,8 @@ module RDStation
     def create(payload)
       retryable_request(@authorization) do |authorization|
         response = self.class.post(EVENTS_ENDPOINT, headers: authorization.headers, body: payload.to_json)
-        response_body = JSON.parse(response.body)
-        return response_body unless errors?(response_body)
-        RDStation::ErrorHandler.new(response).raise_error
+        ApiResponse.build(response)
       end
     end
-
-    private
-
-    def errors?(response_body)
-      response_body.is_a?(Array) || response_body['errors']
-    end
   end
 end

data/lib/rdstation/fields.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 module RDStation
-  # More info: https://developers.rdstation.com/pt-BR/reference/contacts
+  # More info: https://developers.rdstation.com/pt-BR/reference/fields
   class Fields
     include HTTParty
     include ::RDStation::RetryableRequest
 
     BASE_URL = 'https://api.rd.services/platform/contacts/fields'.freeze
-    
+
     def initialize(authorization:)
       @authorization = authorization
     end
@@ -18,5 +18,31 @@ module RDStation
       end
     end
 
+    def create(payload)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.post(BASE_URL, headers: authorization.headers, body: payload.to_json)
+        ApiResponse.build(response)
+      end
+    end
+
+    def update(uuid, payload)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.patch(base_url(uuid), headers: authorization.headers, body: payload.to_json)
+        ApiResponse.build(response)
+      end
+    end
+
+    def delete(uuid)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.delete(base_url(uuid), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
+    end
+
+    private
+
+    def base_url(path = '')
+      "#{BASE_URL}/#{path}"
+    end
   end
 end

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/spec/lib/rdstation/builder/field_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RDStation::Builder::Field do
+  def valid_builder
+    described_class.new('cf_identifier')
+  end
+
+  describe 'when create a builder' do
+    context 'valid' do
+      let(:initial_parameters) do
+        'cf_api_identifier'
+      end
+
+      let(:builder) { described_class.new(initial_parameters) }
+
+      let(:expected_result) do
+        {
+          'api_identifier' => 'cf_api_identifier',
+          'data_type' => 'STRING',
+          'presentation_type' => 'TEXT_INPUT',
+          'label' => { 'pt-BR' => 'My label' },
+          'name' => { 'pt-BR' => 'My name' }
+        }
+      end
+
+      it 'returns an hash of required values' do
+        builder.label 'pt-BR', 'My label'
+        builder.name 'pt-BR', 'My name'
+        builder.data_type 'STRING'
+        builder.presentation_type 'TEXT_INPUT'
+
+        result = builder.build
+        expect(result).to eq(expected_result)
+      end
+    end
+    
+    context 'invalid' do
+      it 'using invalid api_identifier ' do
+        expect { described_class.new('invald_identifier') }.to raise_error(
+          'api_identifier is not in a valid format, need start with "cf_"'
+        )
+      end
+
+      it 'using invalid data_type ' do
+        expect { valid_builder.data_type('invalid_data_type') }.to raise_error(
+          'Not valid data_type - ["STRING", "INTEGER", "BOOLEAN", "STRING[]"]'
+        )
+      end
+
+      it 'using invalid presentation_type ' do
+        expect { valid_builder.presentation_type('invalid presentation_type') }.to raise_error(
+          'Not valid presentation_type - ["TEXT_INPUT", "TEXT_AREA", "URL_INPUT", "PHONE_INPUT", "EMAIL_INPUT", "CHECK_BOX", "NUMBER_INPUT", "COMBO_BOX", "RADIO_BUTTON", "MULTIPLE_CHOICE"]'
+        )
+      end
+
+      it 'without api_identifier' do
+        expect { described_class.new(nil) }.to raise_error('api_identifier required')
+      end
+
+      it 'without required fields' do
+        expect { valid_builder.build }.to raise_error(
+          'Required fields are missing - ["data_type", "presentation_type", "label", "name"]'
+        )
+      end
+    end
+  end
+end

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

@@ -52,5 +52,51 @@ RSpec.describe RDStation::Error::Format do
         expect(result).to eq(RDStation::Error::Format::ARRAY_OF_HASHES)
       end
     end
+
+    context 'when receives a mixed type of errors' do
+      let(:errors) do
+        {
+          'label': {
+            'pt-BR': [
+              {
+                'error_type': 'CANNOT_BE_BLANK',
+                'error_message': 'cannot be blank'
+              }
+            ]
+          },
+          'api_identifier': [
+            {
+              'error_type': 'CANNOT_BE_BLANK',
+              'error_message': 'cannot be blank'
+            }
+          ]
+        }
+      end
+
+      it 'returns the HASH_OF_MULTIPLE_TYPES format' do
+        result = error_format.format
+        expect(result).to eq(RDStation::Error::Format::HASH_OF_MULTIPLE_TYPES)
+      end
+    end
+
+    context 'when receives a hash of hashes errors' do
+      let(:errors) do
+        {
+          label: {
+            'pt-BR': [
+              {
+                'error_type': 'CANNOT_BE_BLANK',
+                'error_message': 'cannot be blank'
+              }
+            ]
+          }
+        }
+      end
+
+      it 'returns the HASH_OF_MULTILINGUAL format' do
+        result = error_format.format
+        expect(result).to eq(RDStation::Error::Format::HASH_OF_HASHES)
+      end
+    end
   end
 end

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

@@ -132,5 +132,88 @@ RSpec.describe RDStation::Error::Formatter do
         expect(result).to eq(expected_result)
       end
     end
+
+    context 'when receives a hash of multiple type errors' do
+      let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::HASH_OF_MULTIPLE_TYPES) }
+
+      let(:error_response) do
+        {
+          'errors' => {
+            'label' => {
+              'pt-BR' => [
+                {
+                  'error_type' => 'CANNOT_BE_BLANK',
+                  'error_message' => 'cannot be blank'
+                }
+              ]
+            },
+            'api_identifier' => [
+              {
+                'error_type' => 'CANNOT_BE_BLANK',
+                'error_message' => 'cannot be blank'
+              }
+            ]
+          }
+        }
+      end
+
+      let(:error_formatter) { described_class.new(error_response) }
+
+      let(:expected_result) do
+        [
+          {
+            'error_type' => 'CANNOT_BE_BLANK',
+            'error_message' => 'cannot be blank',
+            'path' => 'body.label.pt-BR'
+          },
+          {
+            'error_type' => 'CANNOT_BE_BLANK',
+            'error_message' => 'cannot be blank',
+            'path' => 'body.api_identifier'
+          }
+        ]
+      end
+
+      it 'returns an array of errors' do
+        result = error_formatter.to_array
+        expect(result).to eq(expected_result)
+      end
+    end
+
+    context 'when receives a hash of hashes type errors' do
+      let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::HASH_OF_HASHES) }
+
+      let(:error_response) do
+        {
+          'errors' => {
+            'label' => {
+              'pt-BR' => [
+                {
+                  'error_type' => 'CANNOT_BE_BLANK',
+                  'error_message' => 'cannot be blank'
+                }
+              ]
+            }
+          }
+        }
+      end
+
+      let(:error_formatter) { described_class.new(error_response) }
+
+      let(:expected_result) do
+        [
+          {
+            'error_type' => 'CANNOT_BE_BLANK',
+            'error_message' => 'cannot be blank',
+            'path' => 'body.label.pt-BR'
+          }
+        ]
+      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.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ files:
 - lib/rdstation/api_response.rb
 - lib/rdstation/authentication.rb
 - lib/rdstation/authorization.rb
+- lib/rdstation/builder/field.rb
 - lib/rdstation/client.rb
 - lib/rdstation/contacts.rb
 - lib/rdstation/error.rb
@@ -166,6 +167,7 @@ files:
 - spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
 - spec/lib/rdstation/authorization_spec.rb
+- spec/lib/rdstation/builder/field_spec.rb
 - spec/lib/rdstation/client_spec.rb
 - spec/lib/rdstation/contacts_spec.rb
 - spec/lib/rdstation/error/format_spec.rb
@@ -203,7 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby API wrapper for RD Station
@@ -212,6 +215,7 @@ test_files:
 - spec/lib/rdstation/api_response_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
 - spec/lib/rdstation/authorization_spec.rb
+- spec/lib/rdstation/builder/field_spec.rb
 - spec/lib/rdstation/client_spec.rb
 - spec/lib/rdstation/contacts_spec.rb
 - spec/lib/rdstation/error/format_spec.rb