rdstation-ruby-client 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49d611a1dd83c95db29c6fd6abaf5e174d0cfaab
-  data.tar.gz: 47644e5e101c69feeacd833935dae34764a915e5
+  metadata.gz: c632e94efb06e81ab00f5272d042b0c5b26cf55f
+  data.tar.gz: c947e738844beb8671118a0d76df0468f8361528
 SHA512:
-  metadata.gz: f9d6ddc90bab5f0ba6a9403a10f4cd6efad29f31c2998f2ea1cbac80996caf1e97bcccc6c59a27a3723c311ba505b7f4fef3f45685fe7fd1d99115b64736731f
-  data.tar.gz: 628b0e48df49f7082784d6a84e4d6a31590237f9140198bed8206d7e1a12c545f87dfcb0512f418af785735b10719fee8f4736391ad4ffebdf6a5c2d5827b975
+  metadata.gz: edc33857fcf8af5535d2446da9d0cd3327cd2a092b47d722cb1107887ff649f127a65c301cb80e45c4fae9997713e568eb88b81cfe72498971bbc348f07e6a4e
+  data.tar.gz: cd2315fe944d7790336f50586ad68ef9240092550ca75e2b8327863f880d59ba36ccb8a0012cf9d9fefda4901d2d2ab348a033a51812488136d38c463f7d94de

data/Gemfile.lock

@@ -1,23 +1,24 @@
 PATH
   remote: .
   specs:
-    rdstation-ruby-client (0.0.5)
+    rdstation-ruby-client (1.0.0)
       httparty (~> 0.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     ansi (1.5.0)
-    crack (0.4.2)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    httparty (0.13.5)
-      json (~> 1.8)
+    hashdiff (0.3.7)
+    httparty (0.16.2)
       multi_xml (>= 0.5.2)
-    json (1.8.3)
     minitest (4.7.5)
-    multi_xml (0.5.5)
+    multi_xml (0.6.0)
+    public_suffix (3.0.2)
     rake (10.1.0)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
@@ -35,10 +36,10 @@ GEM
     turn (0.9.7)
       ansi
       minitest (~> 4)
-    vcr (2.9.3)
-    webmock (1.20.4)
+    webmock (2.3.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
@@ -49,8 +50,7 @@ DEPENDENCIES
   rdstation-ruby-client!
   rspec
   turn
-  vcr
-  webmock
+  webmock (~> 2.1)
 
 BUNDLED WITH
-   1.13.2
+   1.16.1

data/README.md

@@ -49,7 +49,7 @@ rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value:
 
 ### Authentication
 
-#### Getting authentication URL 
+#### Getting authentication URL
 
 ```ruby
 rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret')
@@ -58,7 +58,7 @@ redirect_url = 'https://yourapp.org/auth/callback'
 rdstation_authentication.auth_url(redirect_url)
 ```
 
-#### Getting access_token 
+#### Getting access_token
 
 You will need the code param that is returned from RD Station to your application after the user confirms the access at the authorization dialog.
 
@@ -67,7 +67,7 @@ rdstation_authentication = RDStation::Authentication.new('client_id', 'client_se
 rdstation_authentication.authenticate(code_returned_from_rdstation)
 ```
 
-#### Updating access_token 
+#### Updating access_token
 
 ```ruby
 rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret')
@@ -81,8 +81,8 @@ rdstation_authentication.update_access_token('refresh_token')
 Returns data about a specific Contact
 
 ```ruby
-rdstation_contacts = RDStation::Contacts.new('auth_token')
-rdstation_contacts.get_contact('uuid')
+contact = RDStation::Contacts.new('auth_token')
+contact.by_uuid('uuid')
 ```
 
 More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsuuid
@@ -92,23 +92,23 @@ More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDe
 Returns data about a specific Contact
 
 ```ruby
-rdstation_contacts = RDStation::Contacts.new('auth_token')
-rdstation_contacts.get_contact_by_email('email')
+contact = RDStation::Contacts.new('auth_token')
+contact.by_email('email')
 ```
 
 More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsemail
 
 #### Update a Contact by UUID
 
-Updates the properties of a Contact. 
+Updates the properties of a Contact.
 
 ```ruby
 contact_info = {
   name: "Joe Foo"
 }
 
-rdstation_contacts = RDStation::Contacts.new('auth_token')
-rdstation_contacts.update_contact('uuid', contact_info)
+contact = RDStation::Contacts.new('auth_token')
+contact.update('uuid', contact_info)
 ```
 Contact Default Parameters
  - email
@@ -127,7 +127,7 @@ More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatch
 
 #### Upsert a Contact by identifier and value
 
-With an UPSERT like behavior, this method is capable of both updating the properties of a Contact or creating a new Contact. Whatever is used as an identifier cannot appear in the request payload as a field. This will result in a [BAD_REQUEST error](https://developers.rdstation.com/pt-BR/error-states#conflicting). 
+With an UPSERT like behavior, this method is capable of both updating the properties of a Contact or creating a new Contact. Whatever is used as an identifier cannot appear in the request payload as a field. This will result in a [BAD_REQUEST error](https://developers.rdstation.com/pt-BR/error-states#conflicting).
 
 ```ruby
 contact_info = {
@@ -137,8 +137,8 @@ contact_info = {
 identifier = "email"
 identifier_value = "joe@foo.bar"
 
-rdstation_contacts = RDStation::Contacts.new('auth_token')
-rdstation_contacts.upsert_contact(identifier, identifier_value, contact_info)
+contact = RDStation::Contacts.new('auth_token')
+contact.upsert(identifier, identifier_value, contact_info)
 ```
 
 More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchUpsertDetails

data/lib/rdstation-ruby-client.rb

@@ -1,4 +1,11 @@
-require "httparty"
-require "rdstation/client"
-require "rdstation/contacts"
-require "rdstation/authentication"
+require 'httparty'
+
+# API requests
+require 'rdstation/authentication'
+require 'rdstation/client'
+require 'rdstation/contacts'
+require 'rdstation/fields'
+
+# Error handling
+require 'rdstation/error'
+require 'rdstation/error_handler'

data/lib/rdstation/authentication.rb

@@ -3,6 +3,9 @@ module RDStation
   class Authentication
     include HTTParty
 
+    AUTH_TOKEN_URL = 'https://api.rd.services/auth/token'.freeze
+    DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+
     def initialize(client_id, client_secret)
       @client_id = client_id
       @client_secret = client_secret
@@ -11,44 +14,54 @@ module RDStation
     #
     # param redirect_url
     #  URL that the user will be redirected
-    #  after confirming application authorization 
+    #  after confirming application authorization
     #
     def auth_url(redirect_url)
       "https://api.rd.services/auth/dialog?client_id=#{@client_id}&redirect_url=#{redirect_url}"
     end
 
+    # Public: Get the credentials from RD Station API
+    #
+    # code  - The code String sent by RDStation after the user confirms authorization.
+    #
+    # Examples
     #
-    # param code
-    #   parameter sent by RDStation after user confirms authorization  
+    #   authenticate("123")
+    #   # => { 'access_token' => '54321', 'expires_in' => 86_400, 'refresh_token' => 'refresh' }
     #
+    # Returns the credentials Hash.
+    # Raises RDStation::Error::ExpiredCodeGrant if the code has expired
+    # Raises RDStation::Error::InvalidCredentials if the client_id, client_secret
+    # or code is invalid.
     def authenticate(code)
-      post_to_auth_endpoint({ :code => code })
+      response = post_to_auth_endpoint(code: code)
+      parsed_body = JSON.parse(response.body)
+      return parsed_body unless parsed_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
     end
 
     #
     # param refresh_token
-    #   parameter sent by RDStation after authenticate  
+    #   parameter sent by RDStation after authenticate
     #
     def update_access_token(refresh_token)
-      post_to_auth_endpoint({ :refresh_token => refresh_token })
+      response = post_to_auth_endpoint(refresh_token: refresh_token)
+      parsed_body = JSON.parse(response.body)
+      return parsed_body unless parsed_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
     end
 
     private
 
-      def auth_token_url
-        "https://api.rd.services/auth/token"
-      end
-
-      def post_to_auth_endpoint(params)
-        default_body = { :client_id => @client_id, :client_secret => @client_secret }
-
-        self.class.post(
-          auth_token_url,
-          :headers => {
-            "Accept-Encoding": "identity"
-          },
-          :body => default_body.merge(params)
-        )
-      end
+    def post_to_auth_endpoint(params)
+      default_body = { client_id: @client_id, client_secret: @client_secret }
+      body = default_body.merge(params)
+
+      self.class.post(
+        AUTH_TOKEN_URL,
+        body: body.to_json,
+        headers: DEFAULT_HEADERS
+      )
+    end
   end
 end

data/lib/rdstation/contacts.rb

@@ -12,12 +12,18 @@ module RDStation
     # param uuid:
     #   The unique uuid associated to each RD Station Contact.
     #
-    def get_contact(uuid)
-      self.class.get(base_url(uuid), :headers => required_headers)
+    def by_uuid(uuid)
+      response = self.class.get(base_url(uuid), headers: required_headers)
+      response_body = JSON.parse(response.body)
+      return response_body unless response_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
     end
 
-    def get_contact_by_email(email)
-      self.class.get(base_url("email:#{email}"), :headers => required_headers)
+    def by_email(email)
+      response = self.class.get(base_url("email:#{email}"), headers: required_headers)
+      response_body = JSON.parse(response.body)
+      return response_body unless response_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
     end
 
     # The Contact hash may contain the following parameters:
@@ -31,8 +37,11 @@ module RDStation
     # :mobile_phone
     # :website
     # :tags
-    def update_contact(uuid, contact_hash)
-      self.class.patch(base_url(uuid), :body => contact_hash.to_json, :headers => required_headers)
+    def update(uuid, contact_hash)
+      response = self.class.patch(base_url(uuid), :body => contact_hash.to_json, :headers => required_headers)
+      response_body = JSON.parse(response.body)
+      return response_body unless response_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
     end
 
     #
@@ -43,19 +52,22 @@ module RDStation
     # param contact_hash:
     #   Contact data
     #
-    def upsert_contact(identifier, identifier_value, contact_hash)
+    def upsert(identifier, identifier_value, contact_hash)
       path = "#{identifier}:#{identifier_value}"
-      self.class.patch(base_url(path), :body => contact_hash.to_json, :headers => required_headers)
+      response = self.class.patch(base_url(path), body: contact_hash.to_json, headers: required_headers)
+      response_body = JSON.parse(response.body)
+      return response_body unless response_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
     end
 
     private
 
-      def base_url(path = "")
-        "https://api.rd.services/platform/contacts/#{path}"
-      end
+    def base_url(path = "")
+      "https://api.rd.services/platform/contacts/#{path}"
+    end
 
-      def required_headers
-        { "Authorization" => "Bearer #{@auth_token}", "Content-Type" => "application/json" }
-      end
+    def required_headers
+      { "Authorization" => "Bearer #{@auth_token}", "Content-Type" => "application/json" }
+    end
   end
 end

data/lib/rdstation/error.rb

@@ -0,0 +1,21 @@
+module RDStation
+
+  class Error < StandardError
+    attr_reader :http_status, :headers, :body
+
+    def initialize(message, api_response_error)
+      @http_status = api_response_error.code
+      @headers = api_response_error.headers
+      @body = JSON.parse(api_response_error.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 ResourceNotFound < Error; end
+    class Unauthorized < Error; end
+  end
+end

data/lib/rdstation/error_handler.rb

@@ -0,0 +1,38 @@
+require_relative 'error_handler/conflicting_field'
+require_relative 'error_handler/default'
+require_relative 'error_handler/expired_access_token'
+require_relative 'error_handler/expired_code_grant'
+require_relative 'error_handler/invalid_credentials'
+require_relative 'error_handler/resource_not_found'
+require_relative 'error_handler/unauthorized'
+
+module RDStation
+  class ErrorHandler
+    ERROR_TYPES = [
+      ErrorHandler::ConflictingField,
+      ErrorHandler::ExpiredAccessToken,
+      ErrorHandler::ExpiredCodeGrant,
+      ErrorHandler::InvalidCredentials,
+      ErrorHandler::ResourceNotFound,
+      ErrorHandler::Unauthorized,
+      ErrorHandler::Default
+    ].freeze
+
+    def initialize(response)
+      @response = response
+    end
+
+    def raise_errors
+      errors.each(&:raise_error)
+      # Raise only the exception message when the error is not recognized
+      unrecognized_error = @response['errors']
+      raise unrecognized_error['error_message']
+    end
+
+    private
+
+    def errors
+      ERROR_TYPES.map { |error| error.new(@response) }
+    end
+  end
+end

data/lib/rdstation/error_handler/conflicting_field.rb

@@ -0,0 +1,26 @@
+module RDStation
+  class ErrorHandler
+    class ConflictingField
+      attr_reader :api_response, :response_body, :error
+
+      ERROR_CODE = 'CONFLICTING_FIELD'.freeze
+      EXCEPTION_CLASS = RDStation::Error::ConflictingField
+
+      def initialize(api_response)
+        @api_response = api_response
+        @error = JSON.parse(api_response.body)['errors']
+      end
+
+      def raise_error
+        return unless conflicting_field?
+        raise EXCEPTION_CLASS.new(error['error_message'], api_response)
+      end
+
+      private
+
+      def conflicting_field?
+        error['error_type'] == ERROR_CODE
+      end
+    end
+  end
+end

data/lib/rdstation/error_handler/default.rb

@@ -0,0 +1,19 @@
+module RDStation
+  class ErrorHandler
+    class Default
+      attr_reader :api_response
+      EXCEPTION_CLASS = RDStation::Error::Default
+
+      def initialize(api_response)
+        @api_response = api_response
+      end
+
+      def raise_error
+        raise RDStation::Error::Default.new(
+          'An unrecognized error has occurred.',
+          api_response
+        )
+      end
+    end
+  end
+end

data/lib/rdstation/error_handler/expired_access_token.rb

@@ -0,0 +1,30 @@
+module RDStation
+  class ErrorHandler
+    class ExpiredAccessToken
+      attr_reader :api_response, :response_headers, :error
+
+      EXCEPTION_CLASS = RDStation::Error::ExpiredAccessToken
+
+      def initialize(api_response)
+        @api_response = api_response
+        @error = JSON.parse(api_response.body)['errors']
+        @response_headers = api_response.headers
+      end
+
+      def raise_error
+        return unless expired_token?
+        raise EXCEPTION_CLASS.new(error['error_message'], api_response)
+      end
+
+      private
+
+      def expired_token?
+        auth_header = response_headers['x-amzn-remapped-www-authenticate'] ||
+                      response_headers['www-authenticate']
+
+        return unless auth_header
+        auth_header.include?('error="expired_token"')
+      end
+    end
+  end
+end