tangocard-raas 1.1.2 → 2.2.1

data/lib/raas/exceptions/raas_generic_exception.rb

@@ -1,7 +1,9 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 require 'date'
 module Raas
+  # RaaS API Generic Exception
   class RaasGenericException < APIException
     # Request timestamp
     # @return [DateTime]
@@ -28,21 +30,19 @@ module Raas
     attr_accessor :message
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @param [String] The reason for raising an exception.
     # @param [HttpContext] The HttpContext of the API call.
     def initialize(reason, context)
       super(reason, context)
-      begin
-        hash = APIHelper.json_deserialize(@context.response.raw_body)
-        unbox(hash)
-      rescue TypeError
-      end
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the response body.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
     def unbox(hash)
-      @timestamp = DateTime.rfc3339(hash['timestamp']) if hash['timestamp']
+      @timestamp = APIHelper.rfc3339(hash['timestamp']) if hash['timestamp']
       @request_id = hash['requestId']
       @path = hash['path']
       @http_code = hash['httpCode']

data/lib/raas/exceptions/raas_server_exception.rb

@@ -1,7 +1,9 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 require 'date'
 module Raas
+  # RaaS API 5xx Exception
   class RaasServerException < APIException
     # Request timestamp
     # @return [DateTime]
@@ -28,30 +30,30 @@ module Raas
     attr_accessor :errors
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @param [String] The reason for raising an exception.
     # @param [HttpContext] The HttpContext of the API call.
     def initialize(reason, context)
       super(reason, context)
-      begin
-        hash = APIHelper.json_deserialize(@context.response.raw_body)
-        unbox(hash)
-      rescue TypeError
-      end
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the response body.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
     def unbox(hash)
-      @timestamp = DateTime.rfc3339(hash['timestamp']) if hash['timestamp']
+      @timestamp = APIHelper.rfc3339(hash['timestamp']) if hash['timestamp']
       @request_id = hash['requestId']
       @path = hash['path']
       @http_code = hash['httpCode']
       @http_phrase = hash['httpPhrase']
       # Parameter is an array, so we need to iterate through it
       @errors = nil
-      if hash['errors'] != nil
-        @errors = Array.new
-        hash['errors'].each{|structure| @errors << (RaasServerErrorModel.from_hash(structure) if structure)}
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (RaasServerErrorModel.from_hash(structure) if structure)
+        end
       end
     end
   end

data/lib/raas/http/auth/basic_auth.rb

@@ -1,17 +1,20 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
-require "base64"
+require 'base64'
 
 module Raas
+  # Utility class for basic authorization.
   class BasicAuth
     # Add basic authentication to the request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will be added.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
     def self.apply(http_request)
       username = Configuration.platform_name
       password = Configuration.platform_key
       value = Base64.strict_encode64("#{username}:#{password}")
       header_value = "Basic #{value}"
-      http_request.headers["Authorization"] = header_value
+      http_request.headers['Authorization'] = header_value
     end
   end
 end

data/lib/raas/http/faraday_client.rb

@@ -1,10 +1,13 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 require 'faraday/http_cache'
 
 module Raas
+  # An implementation of HttpClient.
   class FaradayClient < HttpClient
     # The constructor.
-    def initialize(timeout: nil, cache: false, max_retries: nil, retry_interval: nil)
+    def initialize(timeout: nil, cache: false,
+                   max_retries: nil, retry_interval: nil)
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.request :multipart
@@ -13,26 +16,35 @@ module Raas
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:open_timeout] = timeout if timeout
-        faraday.request :retry, max: max_retries, interval: retry_interval if (max_retries && retry_interval)
+        faraday.request :retry, max: max_retries, interval: if max_retries &&
+                                                               retry_interval
+                                                              retry_interval
+                                                            end
       end
     end
 
     # Method overridden from HttpClient.
     def execute_as_string(http_request)
-      response = @connection.send(http_request.http_method.downcase, http_request.query_url) do |request|
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
         request.headers = http_request.headers
         request.body = http_request.parameters
       end
-      return convert_response(response)
+      convert_response(response)
     end
 
     # Method overridden from HttpClient.
     def execute_as_binary(http_request)
-      response = @connection.send(http_request.http_method.downcase, http_request.query_url) do |request|
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
         request.headers = http_request.headers
         request.body = http_request.parameters
       end
-      return convert_response(response)
+      convert_response(response)
     end
 
     # Method overridden from HttpClient.

data/lib/raas/http/http_call_back.rb

@@ -1,17 +1,22 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack
     # A controller will call this method before making an HTTP Request.
-    # @param [HttpRequest] The HttpRequest object which the HttpClient will execute.
-    def on_before_request(http_request)
-      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
 
     # A controller will call this method after making an HTTP Request.
     # @param [HttpContext] The HttpContext of the API call.
-    def on_after_response(http_context)
-      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    def on_after_response(_http_context)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
   end
 end

data/lib/raas/http/http_client.rb

@@ -1,23 +1,31 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
   class HttpClient
     # Execute an HttpRequest when the response is expected to be a string.
     # @param [HttpRequest] The HttpRequest to be executed.
-    def execute_as_string(http_request)
-      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
-    
+
     # Execute an HttpRequest when the response is expected to be binary.
     # @param [HttpRequest] The HttpRequest to be executed.
-    def execute_as_binary(http_request)
-      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
-    
+
     # Converts the HTTP Response from the client to an HttpResponse object.
     # @param [Dynamic] The response object received from the client.
-    def convert_response(response)
-      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
 
     # Get a GET HttpRequest object.
@@ -25,11 +33,21 @@ module Raas
     # @param [Hash, Optional] The headers for the HTTP Request.
     def get(query_url,
             headers: {})
-      return HttpRequest.new(HttpMethodEnum::GET,
-                             query_url,
-                             headers: headers)
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
     end
-    
+
     # Get a POST HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
@@ -37,12 +55,12 @@ module Raas
     def post(query_url,
              headers: {},
              parameters: {})
-      return HttpRequest.new(HttpMethodEnum::POST,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
-    
+
     # Get a PUT HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
@@ -50,12 +68,12 @@ module Raas
     def put(query_url,
             headers: {},
             parameters: {})
-      return HttpRequest.new(HttpMethodEnum::PUT,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
-    
+
     # Get a PATCH HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
@@ -63,22 +81,22 @@ module Raas
     def patch(query_url,
               headers: {},
               parameters: {})
-      return HttpRequest.new(HttpMethodEnum::PATCH,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
-    
+
     # Get a DELETE HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     def delete(query_url,
                headers: {},
                parameters: {})
-      return HttpRequest.new(HttpMethodEnum::DELETE,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
   end
 end

data/lib/raas/http/http_context.rb

@@ -1,12 +1,15 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # Represents an Http call in context.
   class HttpContext
     attr_accessor :request, :response
 
     # The constructor.
     # @param [HttpRequest] An HttpRequest object representing the HTTP request.
-    # @param [HttpResponse] An HttpResponse object representing the HTTP response.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
     def initialize(request, response)
       @request = request
       @response = response

data/lib/raas/http/http_method_enum.rb

@@ -1,7 +1,11 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # HTTP Methods Enumeration.
   class HttpMethodEnum
-    HTTPMETHODENUM = [GET = 'GET', POST = 'POST', PUT = 'PUT', PATCH = 'PATCH', DELETE = 'DELETE']
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
   end
 end

data/lib/raas/http/http_request.rb

@@ -1,8 +1,11 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # Represents a single Http Request.
   class HttpRequest
-    attr_accessor :http_method, :query_url, :headers, :parameters, :username, :password
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
 
     # The constructor.
     # @param [HttpMethodEnum] The HTTP method.
@@ -37,7 +40,8 @@ module Raas
     # @param [String] The name of the query parameter.
     # @param [String] The value of the query parameter.
     def add_query_parameter(name, value)
-      @query_url = APIHelper.append_url_with_query_parameters(@query_url, name => value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
       @query_url = APIHelper.clean_url(@query_url)
     end
   end

data/lib/raas/http/http_response.rb

@@ -1,6 +1,8 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # Http response received.
   class HttpResponse
     attr_accessor :status_code, :headers, :raw_body
 

data/lib/raas/models/account_model.rb

@@ -1,52 +1,58 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 require 'date'
 module Raas
+  # Represents an Account
   class AccountModel < BaseModel
-    # Account Identifier
+    # An account identifier
     # @return [String]
     attr_accessor :account_identifier
 
-    # Display Name
+    # An account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # A display name
     # @return [String]
     attr_accessor :display_name
 
-    # Currency Code
+    # The currency code for the account
     # @return [String]
     attr_accessor :currency_code
 
-    # Current Balance
+    # The current balance of the account
     # @return [Float]
     attr_accessor :current_balance
 
-    # Date Created
+    # The date the account was created
     # @return [DateTime]
     attr_accessor :created_at
 
-    # Status
+    # The status of the account
     # @return [String]
     attr_accessor :status
 
-    # Contact Email
+    # The contact email on file for the account
     # @return [String]
     attr_accessor :contact_email
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["account_identifier"] = "accountIdentifier"
-        @_hash["display_name"] = "displayName"
-        @_hash["currency_code"] = "currencyCode"
-        @_hash["current_balance"] = "currentBalance"
-        @_hash["created_at"] = "createdAt"
-        @_hash["status"] = "status"
-        @_hash["contact_email"] = "contactEmail"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['account_identifier'] = 'accountIdentifier'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['display_name'] = 'displayName'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['current_balance'] = 'currentBalance'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['status'] = 'status'
+      @_hash['contact_email'] = 'contactEmail'
       @_hash
     end
 
     def initialize(account_identifier = nil,
+                   account_number = nil,
                    display_name = nil,
                    currency_code = 'USD',
                    current_balance = nil,
@@ -54,6 +60,7 @@ module Raas
                    status = nil,
                    contact_email = nil)
       @account_identifier = account_identifier
+      @account_number = account_number
       @display_name = display_name
       @currency_code = currency_code
       @current_balance = current_balance
@@ -62,21 +69,23 @@ module Raas
       @contact_email = contact_email
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       account_identifier = hash['accountIdentifier']
+      account_number = hash['accountNumber']
       display_name = hash['displayName']
       currency_code = hash['currencyCode'] ||= 'USD'
       current_balance = hash['currentBalance']
-      created_at = DateTime.rfc3339(hash['createdAt']) if hash['createdAt']
+      created_at = APIHelper.rfc3339(hash['createdAt']) if hash['createdAt']
       status = hash['status']
       contact_email = hash['contactEmail']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       AccountModel.new(account_identifier,
+                       account_number,
                        display_name,
                        currency_code,
                        current_balance,