tangocard-raas 1.1.2 → 2.2.1

data/lib/raas/controllers/accounts_controller.rb

@@ -1,98 +1,70 @@
-# 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
+  # AccountsController
   class AccountsController < BaseController
-    @@instance = AccountsController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = AccountsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Gets a list of accounts for a given customer
-    # @param [String] customer_identifier Required parameter: Customer Identifier
+    # Retrieves a list of accounts for a given customer
+    # @param [String] customer_identifier Required parameter: Customer
+    # Identifier
     # @return List of AccountSummaryModel response from the API call
     def get_accounts_by_customer(customer_identifier)
       begin
         @logger.info("get_accounts_by_customer called.")
-  
-        # validate required parameters
+        # Validate required parameters.
         @logger.info("Validating required parameters for get_accounts_by_customer.")
-        validate_parameters({
+        validate_parameters(
           'customer_identifier' => customer_identifier
-        })
-  
-        # prepare query url
+        )
+        # Prepare query url.
         @logger.info("Preparing query URL for get_accounts_by_customer.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/customers/{customerIdentifier}/accounts'
-        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
           'customerIdentifier' => customer_identifier
-        }
+        )
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for get_accounts_by_customer.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_accounts_by_customer.')
-        _request = @http_client.get _query_url, headers: _headers
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'get_accounts_by_customer')
-        validate_response(_context)
   
-        # return appropriate response type
-        @logger.info("Returning response for get_accounts_by_customer.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return decoded.map{|element| AccountSummaryModel.from_hash(element)}
-
-      rescue Exception => e
-        @logger.error(e)
-        raise e
-      end
-    end
-
-    # Get an account
-    # @param [String] account_identifier Required parameter: Account Identifier
-    # @return AccountModel response from the API call
-    def get_account(account_identifier)
-      begin
-        @logger.info("get_account called.")
-  
-        # validate required parameters
-        @logger.info("Validating required parameters for get_account.")
-        validate_parameters({
-          'account_identifier' => account_identifier
-        })
-  
-        # prepare query url
-        @logger.info("Preparing query URL for get_account.")
-        _query_builder = Configuration.get_base_uri()
-        _query_builder << '/accounts/{accountIdentifier}'
-        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
-          'accountIdentifier' => account_identifier
-        }
-        _query_url = APIHelper.clean_url _query_builder
-  
-        # prepare headers
-        @logger.info("Preparing headers for get_account.")
-        _headers = {
-          'accept' => 'application/json'
-        }
-  
-        # prepare and execute HttpRequest
-        @logger.info('Preparing and executing HttpRequest for get_account.')
-        _request = @http_client.get _query_url, headers: _headers
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_account')
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_accounts_by_customer.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
-        @logger.info("Returning response for get_account.")
+        # Return appropriate response type.
+        @logger.info("Returning response for get_accounts_by_customer.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return AccountModel.from_hash(decoded)
+        decoded.map { |element| AccountSummaryModel.from_hash(element) }
 
       rescue Exception => e
         @logger.error(e)
@@ -100,49 +72,62 @@ module Raas
       end
     end
 
-    # Create an account under a given customer
-    # @param [String] customer_identifier Required parameter: Customer Identifier
+    # Creates an account under a given customer
+    # @param [String] customer_identifier Required parameter: Customer
+    # Identifier
     # @param [CreateAccountRequestModel] body Required parameter: Request Body
     # @return AccountModel response from the API call
     def create_account(customer_identifier,
                        body)
       begin
         @logger.info("create_account called.")
-  
-        # validate required parameters
+        # Validate required parameters.
         @logger.info("Validating required parameters for create_account.")
-        validate_parameters({
+        validate_parameters(
           'customer_identifier' => customer_identifier,
           'body' => body
-        })
-  
-        # prepare query url
+        )
+        # Prepare query url.
         @logger.info("Preparing query URL for create_account.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/customers/{customerIdentifier}/accounts'
-        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
           'customerIdentifier' => customer_identifier
-        }
+        )
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for create_account.")
         _headers = {
           'accept' => 'application/json',
           'content-type' => 'application/json; charset=utf-8'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for create_account.')
-        _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
+        _request = @http_client.post(
+          _query_url,
+          headers: _headers,
+          parameters: body.to_json
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'create_account')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for create_account.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for create_account.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return AccountModel.from_hash(decoded)
+        AccountModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -150,35 +135,104 @@ module Raas
       end
     end
 
-    # Gets all accounts under the platform
+    # Retrieves all accounts under the platform
     # @return List of AccountModel response from the API call
     def get_all_accounts
       begin
         @logger.info("get_all_accounts called.")
-  
-        # prepare query url
+        # Prepare query url.
         @logger.info("Preparing query URL for get_all_accounts.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/accounts'
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for get_all_accounts.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_all_accounts.')
-        _request = @http_client.get _query_url, headers: _headers
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'get_all_accounts')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_all_accounts.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for get_all_accounts.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return decoded.map{|element| AccountModel.from_hash(element)}
+        decoded.map { |element| AccountModel.from_hash(element) }
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+
+    # Retrieves a single account
+    # @param [String] account_identifier Required parameter: Account
+    # Identifier
+    # @return AccountModel response from the API call
+    def get_account(account_identifier)
+      begin
+        @logger.info("get_account called.")
+        # Validate required parameters.
+        @logger.info("Validating required parameters for get_account.")
+        validate_parameters(
+          'account_identifier' => account_identifier
+        )
+        # Prepare query url.
+        @logger.info("Preparing query URL for get_account.")
+        _query_builder = Configuration.get_base_uri
+        _query_builder << '/accounts/{accountIdentifier}'
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
+          'accountIdentifier' => account_identifier
+        )
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # Prepare headers.
+        @logger.info("Preparing headers for get_account.")
+        _headers = {
+          'accept' => 'application/json'
+        }
+  
+        # Prepare and execute HttpRequest.
+        @logger.info('Preparing and executing HttpRequest for get_account.')
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'get_account')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_account.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
+        validate_response(_context)
+  
+        # Return appropriate response type.
+        @logger.info("Returning response for get_account.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        AccountModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)

data/lib/raas/controllers/base_controller.rb

@@ -1,18 +1,18 @@
-# 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
+  # Base controller.
   class BaseController
     attr_accessor :http_client, :http_call_back
 
-    @@http_client = FaradayClient.new(timeout: 15)
-
-    @@global_headers = {
-      'user-agent' => 'TangoCardv2NGSDK'
-    }
-
     def initialize(http_client: nil, http_call_back: nil)
-      @http_client = http_client ||= @@http_client
+      @http_client = http_client || FaradayClient.new(timeout: 60)
       @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'V2NGSDK'
+      }
       @logger = Logging.logger[self]
       @logger.info("Instantiated controller class.")
     end
@@ -20,7 +20,7 @@ module Raas
     def validate_parameters(args)
       args.each do |_name, value|
         if value.nil?
-          raise ArgumentError.new 'Required parameter #{name} cannot be nil.'
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
         end
       end
     end
@@ -31,10 +31,14 @@ module Raas
 
       @logger.info("Merging global headers with endpoint headers for #{name}.")
       APIHelper.clean_hash(request.headers)
-      request.headers = @@global_headers.clone.merge(request.headers)
+      request.headers = @global_headers.clone.merge(request.headers)
 
       @logger.debug("Raw request for #{name} is: #{request.inspect}")
-      response = binary ? @http_client.execute_as_binary(request) : @http_client.execute_as_string(request)
+      response = if binary
+                   @http_client.execute_as_binary(request)
+                 else
+                   @http_client.execute_as_string(request)
+                 end
       @logger.debug("Raw response for #{name} is: #{response.inspect}")
       @logger.info("Wrapping request and response in a context object for #{name}.")
       context = HttpContext.new(request, response)
@@ -42,27 +46,26 @@ module Raas
       @logger.info("Calling on_after_response method of http_call_back for #{name}.") if @http_call_back
       @http_call_back.on_after_response(context) if @http_call_back
 
-      return context
+      context
     end
 
     def validate_response(context)
-      if context.response.status_code == 400
-        raise RaasClientException.new 'Bad Request', context
-      elsif context.response.status_code == 401
-        raise RaasGenericException.new 'Unauthorized - Invalid Credentials', context
-      elsif context.response.status_code == 403
-        raise RaasClientException.new 'Forbidden', context
-      elsif context.response.status_code == 404
-        raise RaasGenericException.new 'Not Found', context
-      elsif context.response.status_code == 409
-        raise RaasClientException.new 'Conflict', context
-      elsif context.response.status_code == 500
-        raise RaasServerException.new 'Internal Server Error - Retry Later', context
-      elsif context.response.status_code == 503
-        raise RaasServerException.new 'Service Unavailable - Retry Later', context
-      elsif !context.response.status_code.between?(200, 208) #[200,208] = HTTP OK
-        raise RaasGenericException.new 'API Error', context
-      end
+      raise RaasClientException.new 'Bad Request', context if
+      context.response.status_code == 400
+      raise RaasGenericException.new 'Unauthorized - Invalid Credentials', context if
+      context.response.status_code == 401
+      raise RaasClientException.new 'Forbidden', context if
+      context.response.status_code == 403
+      raise RaasGenericException.new 'Not Found', context if
+      context.response.status_code == 404
+      raise RaasClientException.new 'Conflict', context if
+      context.response.status_code == 409
+      raise RaasServerException.new 'Internal Server Error - Retry Later', context if
+      context.response.status_code == 500
+      raise RaasServerException.new 'Service Unavailable - Retry Later', context if
+      context.response.status_code == 503
+      raise RaasGenericException.new 'API Error', context unless
+        context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
     end
   end
 end

data/lib/raas/controllers/catalog_controller.rb

@@ -1,42 +1,59 @@
-# 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
+  # CatalogController
   class CatalogController < BaseController
-    @@instance = CatalogController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = CatalogController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Get Catalog
+    # Retrieves a platform's catalog
     # @return CatalogModel response from the API call
     def get_catalog
       begin
         @logger.info("get_catalog called.")
-  
-        # prepare query url
+        # Prepare query url.
         @logger.info("Preparing query URL for get_catalog.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/catalogs'
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for get_catalog.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_catalog.')
-        _request = @http_client.get _query_url, headers: _headers
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'get_catalog')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_catalog.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for get_catalog.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return CatalogModel.from_hash(decoded)
+        CatalogModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)