rdstation-ruby-client 1.2.1 → 2.3.1

data/lib/rdstation-ruby-client.rb

@@ -4,7 +4,10 @@ require 'httparty'
 require 'rdstation/api_response'
 
 # API requests
+require 'rdstation'
+require 'rdstation/retryable_request'
 require 'rdstation/authentication'
+require 'rdstation/authorization'
 require 'rdstation/client'
 require 'rdstation/contacts'
 require 'rdstation/events'
@@ -14,3 +17,6 @@ require 'rdstation/webhooks'
 # Error handling
 require 'rdstation/error'
 require 'rdstation/error_handler'
+
+# Builders
+require 'rdstation/builder/field'

data/lib/rdstation.rb

@@ -0,0 +1,19 @@
+module RDStation
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+  
+  class Configuration
+    attr_accessor :client_id, :client_secret
+    attr_reader :access_token_refresh_callback
+
+    def on_access_token_refresh(&block)
+      @access_token_refresh_callback = block
+    end
+  end
+end

data/lib/rdstation/api_response.rb

@@ -1,9 +1,9 @@
 module RDStation
   module ApiResponse
     def self.build(response)
-      response_body = JSON.parse(response.body)
-      return response_body unless response_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      return JSON.parse(response.body) if response.code.between?(200, 299)
+
+      RDStation::ErrorHandler.new(response).raise_error
     end
   end
 end

data/lib/rdstation/authentication.rb

@@ -5,10 +5,12 @@ module RDStation
 
     AUTH_TOKEN_URL = 'https://api.rd.services/auth/token'.freeze
     DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+    REVOKE_URL = 'https://api.rd.services/auth/revoke'.freeze
 
-    def initialize(client_id, client_secret)
-      @client_id = client_id
-      @client_secret = client_secret
+    def initialize(client_id = nil, client_secret = nil)
+      warn_deprecation if client_id || client_secret
+      @client_id = client_id || RDStation.configuration&.client_id
+      @client_secret = client_secret || RDStation.configuration&.client_secret
     end
 
     #
@@ -47,8 +49,31 @@ module RDStation
       ApiResponse.build(response)
     end
 
+    def self.revoke(access_token:)
+      response = self.post(
+        REVOKE_URL,
+        body: revoke_body(access_token),
+        headers: revoke_headers(access_token)
+      )
+      ApiResponse.build(response)
+    end
+
     private
 
+    def self.revoke_body(access_token)
+      URI.encode_www_form({
+        token: access_token,
+        token_type_hint: 'access_token'
+      })
+    end
+
+    def self.revoke_headers(access_token)
+      {
+        "Authorization" => "Bearer #{access_token}",
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }
+    end
+
     def post_to_auth_endpoint(params)
       default_body = { client_id: @client_id, client_secret: @client_secret }
       body = default_body.merge(params)
@@ -59,5 +84,9 @@ module RDStation
         headers: DEFAULT_HEADERS
       )
     end
+
+    def warn_deprecation
+      warn "DEPRECATION WARNING: Providing client_id and client_secret directly to RDStation::Authentication.new is deprecated and will be removed in future versions. Use RDStation.configure instead."
+    end
   end
 end

data/lib/rdstation/authorization.rb

@@ -0,0 +1,24 @@
+module RDStation
+  class Authorization
+    attr_reader :refresh_token
+    attr_accessor :access_token, :access_token_expires_in
+    def initialize(access_token:, refresh_token: nil, access_token_expires_in: nil)
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @access_token_expires_in = access_token_expires_in
+      validate_access_token access_token
+    end
+
+    def headers
+      { "Authorization" => "Bearer #{@access_token}", "Content-Type" => "application/json" }
+    end
+
+    private
+
+    def validate_access_token(access_token)
+      access_token_msg = ':access_token is required'
+      raise ArgumentError, access_token_msg unless access_token
+    end
+
+  end
+end

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

@@ -1,90 +1,33 @@
-# encoding: utf-8
 module RDStation
-  #
-  # Mais informações em http://ajuda.rdstation.com.br/hc/pt-br/articles/204526429-Guia-de-integra%C3%A7%C3%B5es-com-o-RD-Station
-  #
   class Client
-    include HTTParty
-
-    def initialize(rdstation_token, auth_token, identifier="integração")
-      warn "DEPRECATION WARNING: all methods in this class has been deprecated because the version 1.x is no longer under active development and will be removed in version 2.0.0. See more details about the new version here: https://developers.rdstation.com/en/overview"
-      @identificador = identifier
-      @rdstation_token = rdstation_token
-      @auth_token = auth_token
-    end
-
-    #
-    # A hash do Lead pode conter os seguintes parâmetros:
-    # (obrigatório) :email
-    #               :identificador
-    #               :nome
-    #               :empresa
-    #               :cargo
-    #               :telefone
-    #               :celular
-    #               :website
-    #               :twitter
-    #               :c_utmz
-    #               :created_at
-    #               :tags
-    #
-    # Caso algum parâmetro não seja identificado como campo padrão ou como
-    # campo personalizado, este parâmetro desconhecido será gravado nos
-    # "Detalhes do Lead".
-    #
-    def create_lead(lead_hash)
-      warn "DEPRECATION WARNING: create_lead has been deprecated because the version 1.x is no longer under active development and will be removed in version 2.0.0. See more details about the new version here: https://developers.rdstation.com/en/overview"
-      lead_hash = rdstation_token_hash.merge(lead_hash)
-      lead_hash = lead_hash.merge(identifier_hash) unless lead_hash.has_key?(:identificador)
-      post_with_body("/conversions", {:body => lead_hash})
-    end
-    alias_method :update_lead_info, :create_lead
-
-    #
-    # param lead:
-    #   id ou email do Lead a ser alterado
-    #
-    # param lead_hash:
-    #   Hash contendo:
-    #     :lifecycle_stage
-    #       0 - Lead; 1 - Lead Qualificado; 2 - Cliente
-    #     :opportunity
-    #       true ou false
-    #
-    def change_lead(lead, lead_hash)
-      warn "DEPRECATION WARNING: change_lead has been deprecated because the version 1.x is no longer under active development and will be removed in version 2.0.0. See more details about the new version here: https://developers.rdstation.com/en/overview"
-      lead_hash = auth_token_hash.merge({:lead => lead_hash})
-      put_with_body("/leads/#{lead}", :body => lead_hash.to_json, :headers => {'Content-Type' => 'application/json'})
-    end
-
-    def change_lead_status(lead_hash)
-      warn "DEPRECATION WARNING: change_lead_status has been deprecated because the version 1.x is no longer under active development and will be removed in version 2.0.0. See more details about the new version here: https://developers.rdstation.com/en/overview"
-      post_with_body("/services/#{@auth_token}/generic", :body => lead_hash )
+    def initialize(access_token:, refresh_token: nil)
+      warn_deprecation unless refresh_token
+      @authorization = Authorization.new(
+        access_token: access_token,
+        refresh_token: refresh_token
+      )
     end
 
-  private
-    def base_url
-      "https://www.rdstation.com.br/api/1.2"
+    def contacts
+      @contacts ||= RDStation::Contacts.new(authorization: @authorization)
     end
 
-    def rdstation_token_hash
-      { :token_rdstation => @rdstation_token }
+    def events
+      @events ||= RDStation::Events.new(authorization: @authorization)
     end
 
-    def auth_token_hash
-      { :auth_token => @auth_token }
+    def fields
+      @fields ||= RDStation::Fields.new(authorization: @authorization)
     end
 
-    def identifier_hash
-      { :identificador => @identificador }
+    def webhooks
+      @webhooks ||= RDStation::Webhooks.new(authorization: @authorization)
     end
 
-    def post_with_body(path, opts)
-      self.class.post("#{base_url}#{path}", opts)
-    end
+    private
 
-    def put_with_body(path, opts)
-      self.class.put("#{base_url}#{path}", opts)
+    def warn_deprecation
+      warn "DEPRECATION WARNING: Specifying refresh_token in RDStation::Client.new(access_token: 'at', refresh_token: 'rt') is optional right now, but will be mandatory in future versions. "
     end
   end
 end

data/lib/rdstation/contacts.rb

@@ -3,9 +3,10 @@ module RDStation
   # More info: https://developers.rdstation.com/pt-BR/reference/contacts
   class Contacts
     include HTTParty
+    include ::RDStation::RetryableRequest
 
-    def initialize(auth_token)
-      @auth_token = auth_token
+    def initialize(authorization:)
+      @authorization = authorization
     end
 
     #
@@ -13,13 +14,17 @@ module RDStation
     #   The unique uuid associated to each RD Station Contact.
     #
     def by_uuid(uuid)
-      response = self.class.get(base_url(uuid), headers: required_headers)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url(uuid), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
     def by_email(email)
-      response = self.class.get(base_url("email:#{email}"), headers: required_headers)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.get(base_url("email:#{email}"), headers: authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
     # The Contact hash may contain the following parameters:
@@ -34,8 +39,10 @@ module RDStation
     # :website
     # :tags
     def update(uuid, contact_hash)
-      response = self.class.patch(base_url(uuid), :body => contact_hash.to_json, :headers => required_headers)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        response = self.class.patch(base_url(uuid), :body => contact_hash.to_json, :headers => authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
     #
@@ -47,19 +54,17 @@ module RDStation
     #   Contact data
     #
     def upsert(identifier, identifier_value, contact_hash)
-      path = "#{identifier}:#{identifier_value}"
-      response = self.class.patch(base_url(path), body: contact_hash.to_json, headers: required_headers)
-      ApiResponse.build(response)
+      retryable_request(@authorization) do |authorization|
+        path = "#{identifier}:#{identifier_value}"
+        response = self.class.patch(base_url(path), body: contact_hash.to_json, headers: authorization.headers)
+        ApiResponse.build(response)
+      end
     end
 
     private
 
-    def base_url(path = "")
+    def base_url(path = '')
       "https://api.rd.services/platform/contacts/#{path}"
     end
-
-    def required_headers
-      { "Authorization" => "Bearer #{@auth_token}", "Content-Type" => "application/json" }
-    end
   end
 end

data/lib/rdstation/error.rb

@@ -1,5 +1,4 @@
 module RDStation
-
   class Error < StandardError
     attr_reader :details, :http_status, :headers, :body
 
@@ -8,23 +7,32 @@ module RDStation
       message = details['error_message']
       raise ArgumentError, 'The details hash must contain an error message' unless message
 
-      # Those three arguments are kept only for compatibility reasons.
-      # They aren't needed since we can get them directly in the details hash.
-      # Consider removing them when update the major version.
-      @http_status = details['http_status']
-      @headers = details['headers']
-      @body = details['body']
-
       super(message)
     end
 
-    class ConflictingField < Error; end
-    class Default < Error; end
-    class ExpiredAccessToken < Error; end
-    class ExpiredCodeGrant < Error; end
-    class InvalidCredentials < Error; end
-    class InvalidEventType < Error; end
-    class ResourceNotFound < Error; end
+    class BadRequest < Error; end
     class Unauthorized < Error; end
+    class Forbidden < Error; end
+    class NotFound < Error; end
+    class MethodNotAllowed < Error; end
+    class NotAcceptable < Error; end
+    class Conflict < Error; end
+    class UnsupportedMediaType < Error; end
+    class UnprocessableEntity < Error; end
+    class InternalServerError < Error; end
+    class NotImplemented < Error; end
+    class BadGateway < Error; end
+    class ServiceUnavailable < Error; end
+    class ServerError < Error; end
+    class UnknownError < Error; end
+
+    # 400 - Bad Request
+    class ConflictingField < BadRequest; end
+    class InvalidEventType < BadRequest; end
+
+    # 401 - Unauthorized
+    class ExpiredAccessToken < Unauthorized; end
+    class ExpiredCodeGrant < Unauthorized; end
+    class InvalidCredentials < Unauthorized; 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