tangocard-raas 1.1.2

data/lib/raas.rb

@@ -0,0 +1,61 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'raas/api_helper.rb'
+require_relative 'raas/raas_client.rb'
+
+# Http
+require_relative 'raas/http/http_call_back.rb'
+require_relative 'raas/http/http_client.rb'
+require_relative 'raas/http/http_method_enum.rb'
+require_relative 'raas/http/http_request.rb'
+require_relative 'raas/http/http_response.rb'
+require_relative 'raas/http/http_context.rb'
+require_relative 'raas/http/faraday_client.rb'
+require_relative 'raas/http/auth/basic_auth.rb'
+
+# Models
+require_relative 'raas/models/base_model.rb'
+require_relative 'raas/models/account_summary_model.rb'
+require_relative 'raas/models/customer_model.rb'
+require_relative 'raas/models/account_model.rb'
+require_relative 'raas/models/create_customer_request_model.rb'
+require_relative 'raas/models/create_account_request_model.rb'
+require_relative 'raas/models/raas_server_error_model.rb'
+require_relative 'raas/models/system_status_response_model.rb'
+require_relative 'raas/models/catalog_model.rb'
+require_relative 'raas/models/brand_model.rb'
+require_relative 'raas/models/item_model.rb'
+require_relative 'raas/models/order_model.rb'
+require_relative 'raas/models/currency_breakdown_model.rb'
+require_relative 'raas/models/name_email_model.rb'
+require_relative 'raas/models/exchange_rate_response_model.rb'
+require_relative 'raas/models/get_orders_response_model.rb'
+require_relative 'raas/models/resend_order_response_model.rb'
+require_relative 'raas/models/create_order_request_model.rb'
+require_relative 'raas/models/reward_model.rb'
+require_relative 'raas/models/reward_credential_model.rb'
+require_relative 'raas/models/exchange_rate_model.rb'
+require_relative 'raas/models/page_model.rb'
+require_relative 'raas/models/raas_client_error_model.rb'
+
+# Exceptions
+require_relative 'raas/exceptions/api_exception.rb'
+require_relative 'raas/exceptions/raas_generic_exception.rb'
+require_relative 'raas/exceptions/raas_client_exception.rb'
+require_relative 'raas/exceptions/raas_server_exception.rb'
+
+require_relative 'raas/configuration.rb'
+
+# Controllers
+require_relative 'raas/controllers/base_controller.rb'
+require_relative 'raas/controllers/accounts_controller.rb'
+require_relative 'raas/controllers/orders_controller.rb'
+require_relative 'raas/controllers/catalog_controller.rb'
+require_relative 'raas/controllers/exchange_rates_controller.rb'
+require_relative 'raas/controllers/status_controller.rb'
+require_relative 'raas/controllers/customers_controller.rb'

data/lib/raas/api_helper.rb

@@ -0,0 +1,181 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Raas
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs)
+    # @param [String] The name of the parameter
+    # @param [Array] The value of the parameter
+    # @param [String] The format of the serialization
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index { |element, index| ["#{key}[#{index}]", element] }
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Hash] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      return query_builder if parameters.nil?
+
+      # iterate and append parameters
+      parameters.each do |key, value|
+        replace_value = ''
+
+        if value.nil?
+          replace_value = ''
+        elsif value.instance_of? Array
+          value.map! { |element| CGI.escape(element.to_s) }
+          replace_value = value.join('/')
+        else
+          replace_value = CGI.escape(value.to_s)
+        end
+
+        # find the template parameter and replace it with its value
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to add the query parameters to
+    # @param [Hash] The parameters to append
+    # @param [String] The format of array parameter serialization
+    def self.append_url_with_query_parameters(query_builder, parameters, array_serialization: 'indexed')
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, value|
+        seperator = (query_builder.include? '?') ? '&' : '?'
+        if not value.nil?
+          if value.instance_of? Array
+            value.compact!
+            if array_serialization == 'csv'
+              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join(',')}"
+            elsif array_serialization == 'psv'
+              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join('|')}"
+            elsif array_serialization == 'tsv'
+              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join('\t')}"
+            else
+              query_builder += "#{seperator}#{APIHelper.serialize_array(key, value, formatting: array_serialization).
+                map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')}"
+            end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # return processed url
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key))
+      end
+      encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = {}
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' + index.to_s + ']'))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' + key + ']'))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end

data/lib/raas/configuration.rb

@@ -0,0 +1,72 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Raas
+
+  Logging.logger.root.appenders = Logging.appenders.stdout
+  Logging.logger.root.level = :info
+
+  class Configuration
+    # Set the array parameter serialization method
+    # (allowed: indexed, unindexed, plain, csv, tsv, psv)
+    @array_serialization = 'indexed'
+
+    # An enum for SDK environments
+    class Environment
+      #SANDBOX: Sandbox (Fake) Environment
+      #PRODUCTION: Production (Live) Environment
+      #QA: Tango Card Internal Use Only
+      #GAMMA: Tango Card Internal Use Only
+      #LOCAL: Tango Card Internal Use Only
+      ENVIRONMENT = [SANDBOX = 0, PRODUCTION = 1, QA = 2, GAMMA = 3, LOCAL = 4]
+    end
+
+    # An enum for API servers
+    class Server
+      SERVER = [DEFAULT = 0]
+    end
+
+    # The environment in which the SDK is running
+    @environment = Environment::SANDBOX
+
+    # RaaS v2 API Platform Name
+    @platform_name = 'QAPlatform2'
+
+    # RaaS v2 API Platform Key
+    @platform_key = 'apYPfT6HNONpDRUj3CLGWYt7gvIHONpDRUYPfT6Hj'
+
+    # All the environments the SDK can run in
+    @environments = {
+      Environment::SANDBOX => {
+        Server::DEFAULT => 'https://integration-api.tangocard.com/raas/v2',
+      },
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.tangocard.com/raas/v2',
+      },
+      Environment::QA => {
+        Server::DEFAULT => 'https://qa-api.tangocard.com/raas/v2',
+      },
+      Environment::GAMMA => {
+        Server::DEFAULT => 'https://gamma-api.tangocard.com/raas/v2',
+      },
+      Environment::LOCAL => {
+        Server::DEFAULT => 'http://raastango.cc:8080/v2',
+      },
+    }
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] The server enum for which the base URI is required.
+    # @return [String] The base URI.
+    def self.get_base_uri(server = Server::DEFAULT)
+      environments[environment][server]
+    end
+
+    # The attribute accessors for public properties
+    class << self
+      attr_accessor :array_serialization
+      attr_accessor :environment
+      attr_accessor :environments
+      attr_accessor :platform_name
+      attr_accessor :platform_key
+    end
+  end
+end

data/lib/raas/controllers/accounts_controller.rb

@@ -0,0 +1,189 @@
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+
+module Raas
+  class AccountsController < BaseController
+    @@instance = AccountsController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Gets 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
+        @logger.info("Validating required parameters for get_accounts_by_customer.")
+        validate_parameters({
+          'customer_identifier' => customer_identifier
+        })
+  
+        # prepare query url
+        @logger.info("Preparing query URL for get_accounts_by_customer.")
+        _query_builder = Configuration.get_base_uri()
+        _query_builder << '/customers/{customerIdentifier}/accounts'
+        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+          'customerIdentifier' => customer_identifier
+        }
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # prepare headers
+        @logger.info("Preparing headers for get_accounts_by_customer.")
+        _headers = {
+          'accept' => 'application/json'
+        }
+  
+        # prepare and execute HttpRequest
+        @logger.info('Preparing and executing HttpRequest for get_accounts_by_customer.')
+        _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(_context)
+  
+        # return appropriate response type
+        @logger.info("Returning response for get_account.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        return AccountModel.from_hash(decoded)
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+
+    # Create 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
+        @logger.info("Validating required parameters for create_account.")
+        validate_parameters({
+          'customer_identifier' => customer_identifier,
+          'body' => body
+        })
+  
+        # prepare query url
+        @logger.info("Preparing query URL for create_account.")
+        _query_builder = Configuration.get_base_uri()
+        _query_builder << '/customers/{customerIdentifier}/accounts'
+        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+          'customerIdentifier' => customer_identifier
+        }
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # prepare headers
+        @logger.info("Preparing headers for create_account.")
+        _headers = {
+          'accept' => 'application/json',
+          'content-type' => 'application/json; charset=utf-8'
+        }
+  
+        # 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
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'create_account')
+        validate_response(_context)
+  
+        # return appropriate response type
+        @logger.info("Returning response for create_account.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        return AccountModel.from_hash(decoded)
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+
+    # Gets 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
+        @logger.info("Preparing query URL for get_all_accounts.")
+        _query_builder = Configuration.get_base_uri()
+        _query_builder << '/accounts'
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # prepare headers
+        @logger.info("Preparing headers for get_all_accounts.")
+        _headers = {
+          'accept' => 'application/json'
+        }
+  
+        # prepare and execute HttpRequest
+        @logger.info('Preparing and executing HttpRequest for get_all_accounts.')
+        _request = @http_client.get _query_url, headers: _headers
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'get_all_accounts')
+        validate_response(_context)
+  
+        # 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)}
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+  end
+end