moneykit 0.0.3 → 0.0.5

data/lib/plaid_compatible/money_kit_plaid_compatible/api_error.rb

@@ -10,48 +10,48 @@
 
 module MoneyKit
   module PlaidCompatible
-  class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body, :data
+    class ApiError < StandardError
+      attr_reader :code, :response_headers, :response_body, :data
 
-    # Usage examples:
-    #   ApiError.new
-    #   ApiError.new("message")
-    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
-    #   ApiError.new(:code => 404, :message => "Not Found")
-    def initialize(arg = nil)
-      if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
+      # Usage examples:
+      #   ApiError.new
+      #   ApiError.new("message")
+      #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+      #   ApiError.new(:code => 404, :message => "Not Found")
+      def initialize(arg = nil)
+        if arg.is_a? Hash
+          if arg.key?(:message) || arg.key?('message')
+            super(arg[:message] || arg['message'])
+          else
+            super arg
+          end
+
+          arg.each do |k, v|
+            instance_variable_set "@#{k}", v
+          end
         else
           super arg
         end
-
-        arg.each do |k, v|
-          instance_variable_set "@#{k}", v
-        end
-      else
-        super arg
       end
-    end
 
-    # Override to_s to display a friendly error message
-    def to_s
-      message
-    end
+      # Override to_s to display a friendly error message
+      def to_s
+        message
+      end
 
-    def message
-      msg = if @message.nil?
-              'Error message: the server returns an error'
-            else
-              @message
-            end
+      def message
+        msg = if @message.nil?
+                'Error message: the server returns an error'
+              else
+                @message
+              end
 
-      msg += "\nHTTP status code: #{code}" if code
-      msg += "\nResponse headers: #{response_headers}" if response_headers
-      msg += "\nResponse body: #{response_body}" if response_body
+        msg += "\nHTTP status code: #{code}" if code
+        msg += "\nResponse headers: #{response_headers}" if response_headers
+        msg += "\nResponse body: #{response_body}" if response_body
 
-      msg
+        msg
+      end
     end
   end
-  end
 end

data/lib/plaid_compatible/money_kit_plaid_compatible/configuration.rb

@@ -10,276 +10,276 @@
 
 module MoneyKit
   module PlaidCompatible
-  class Configuration
-    # Plaid Environment mapping
-    # production, development, sandbox
-    Environment = { 'production' => 0, 'sandbox' => 1 }
-
-    # Defines url scheme
-    attr_accessor :scheme
-
-    # Defines url host
-    attr_accessor :host
-
-    # Defines url base path
-    attr_accessor :base_path
-
-    # Define server configuration index
-    attr_accessor :server_index
-
-    # Define server operation configuration index
-    attr_accessor :server_operation_index
-
-    # Default server variables
-    attr_accessor :server_variables
-
-    # Default server operation variables
-    attr_accessor :server_operation_variables
-
-    # Defines API keys used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: parameter value (API key)
-    #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
-
-    # Defines API key prefixes used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: API key prefix
-    #
-    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-    #   config.api_key_prefix['api_key'] = 'Token'
-    attr_accessor :api_key_prefix
-
-    # Defines the username used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :username
-
-    # Defines the password used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :password
-
-    # Defines the access token (Bearer) used with OAuth2.
-    attr_accessor :access_token
-
-    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
-    # details will be logged with `logger.debug` (see the `logger` attribute).
-    # Default to false.
-    #
-    # @return [true, false]
-    attr_accessor :debugging
-
-    # Defines the logger used for debugging.
-    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-    #
-    # @return [#debug]
-    attr_accessor :logger
-
-    # Defines the temporary folder to store downloaded files
-    # (for API endpoints that have file response).
-    # Default to use `Tempfile`.
-    #
-    # @return [String]
-    attr_accessor :temp_folder_path
-
-    # The time limit for HTTP request in seconds.
-    attr_accessor :timeout
-
-    # Set this to false to skip client side validation in the operation.
-    # Default to true.
-    # @return [true, false]
-    attr_accessor :client_side_validation
-
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL certificate when calling API from https server.
-    # Default to true.
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    # @return [true, false]
-    attr_accessor :ssl_verify
-
-    ### TLS/SSL setting
-    # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    attr_accessor :ssl_verify_mode
-
-    ### TLS/SSL setting
-    # Set this to customize the certificate file to verify the peer.
-    #
-    # @return [String] the path to the certificate file
-    attr_accessor :ssl_ca_file
-
-    ### TLS/SSL setting
-    # Client certificate file (for client certificate)
-    attr_accessor :ssl_client_cert
-
-    ### TLS/SSL setting
-    # Client private key file (for client certificate)
-    attr_accessor :ssl_client_key
-
-    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
-    # Default to nil.
-    #
-    # @see The params_encoding option of Ethon. Related source code:
-    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
-    attr_accessor :params_encoding
-
-    attr_accessor :inject_format, :force_ending_format
-
-    def initialize
-      @scheme = 'https'
-      @host = 'production.moneykit.com'
-      @base_path = '/plaid-compatible'
-      @server_index = 0
-      @server_operation_index = {}
-      @server_variables = {}
-      @server_operation_variables = {}
-      @api_key = {
-        'Plaid-Version' => ''
-      }
-      @api_key_prefix = {}
-      @timeout = 60
-      @client_side_validation = true
-      @ssl_verify = true
-      @ssl_verify_mode = nil
-      @ssl_ca_file = nil
-      @ssl_client_cert = nil
-      @ssl_client_key = nil
-      @debugging = false
-      @inject_format = false
-      @force_ending_format = false
-      @logger = defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : Logger.new(STDOUT)
-
-      yield(self) if block_given?
-    end
+    class Configuration
+      # Plaid Environment mapping
+      # production, development, sandbox
+      Environment = { 'production' => 0, 'sandbox' => 1 }
+
+      # Defines url scheme
+      attr_accessor :scheme
+
+      # Defines url host
+      attr_accessor :host
+
+      # Defines url base path
+      attr_accessor :base_path
+
+      # Define server configuration index
+      attr_accessor :server_index
+
+      # Define server operation configuration index
+      attr_accessor :server_operation_index
+
+      # Default server variables
+      attr_accessor :server_variables
+
+      # Default server operation variables
+      attr_accessor :server_operation_variables
+
+      # Defines API keys used with API Key authentications.
+      #
+      # @return [Hash] key: parameter name, value: parameter value (API key)
+      #
+      # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+      #   config.api_key['api_key'] = 'xxx'
+      attr_accessor :api_key
+
+      # Defines API key prefixes used with API Key authentications.
+      #
+      # @return [Hash] key: parameter name, value: API key prefix
+      #
+      # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+      #   config.api_key_prefix['api_key'] = 'Token'
+      attr_accessor :api_key_prefix
+
+      # Defines the username used with HTTP basic authentication.
+      #
+      # @return [String]
+      attr_accessor :username
+
+      # Defines the password used with HTTP basic authentication.
+      #
+      # @return [String]
+      attr_accessor :password
+
+      # Defines the access token (Bearer) used with OAuth2.
+      attr_accessor :access_token
+
+      # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+      # details will be logged with `logger.debug` (see the `logger` attribute).
+      # Default to false.
+      #
+      # @return [true, false]
+      attr_accessor :debugging
+
+      # Defines the logger used for debugging.
+      # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+      #
+      # @return [#debug]
+      attr_accessor :logger
+
+      # Defines the temporary folder to store downloaded files
+      # (for API endpoints that have file response).
+      # Default to use `Tempfile`.
+      #
+      # @return [String]
+      attr_accessor :temp_folder_path
+
+      # The time limit for HTTP request in seconds.
+      attr_accessor :timeout
+
+      # Set this to false to skip client side validation in the operation.
+      # Default to true.
+      # @return [true, false]
+      attr_accessor :client_side_validation
+
+      ### TLS/SSL setting
+      # Set this to false to skip verifying SSL certificate when calling API from https server.
+      # Default to true.
+      #
+      # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+      #
+      # @return [true, false]
+      attr_accessor :ssl_verify
+
+      ### TLS/SSL setting
+      # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
+      #
+      # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+      #
+      attr_accessor :ssl_verify_mode
+
+      ### TLS/SSL setting
+      # Set this to customize the certificate file to verify the peer.
+      #
+      # @return [String] the path to the certificate file
+      attr_accessor :ssl_ca_file
+
+      ### TLS/SSL setting
+      # Client certificate file (for client certificate)
+      attr_accessor :ssl_client_cert
+
+      ### TLS/SSL setting
+      # Client private key file (for client certificate)
+      attr_accessor :ssl_client_key
+
+      # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+      # Default to nil.
+      #
+      # @see The params_encoding option of Ethon. Related source code:
+      # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+      attr_accessor :params_encoding
+
+      attr_accessor :inject_format, :force_ending_format
+
+      def initialize
+        @scheme = 'https'
+        @host = 'production.moneykit.com'
+        @base_path = '/plaid-compatible'
+        @server_index = 0
+        @server_operation_index = {}
+        @server_variables = {}
+        @server_operation_variables = {}
+        @api_key = {
+          'Plaid-Version' => ''
+        }
+        @api_key_prefix = {}
+        @timeout = 60
+        @client_side_validation = true
+        @ssl_verify = true
+        @ssl_verify_mode = nil
+        @ssl_ca_file = nil
+        @ssl_client_cert = nil
+        @ssl_client_key = nil
+        @debugging = false
+        @inject_format = false
+        @force_ending_format = false
+        @logger = defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : Logger.new(STDOUT)
+
+        yield(self) if block_given?
+      end
 
-    # The default Configuration object.
-    def self.default
-      @@default ||= Configuration.new
-    end
+      # The default Configuration object.
+      def self.default
+        @@default ||= Configuration.new
+      end
 
-    def configure
-      yield(self) if block_given?
-    end
+      def configure
+        yield(self) if block_given?
+      end
 
-    def scheme=(scheme)
-      # remove :// from scheme
-      @scheme = scheme.sub(%r{://}, '')
-    end
+      def scheme=(scheme)
+        # remove :// from scheme
+        @scheme = scheme.sub(%r{://}, '')
+      end
 
-    def host=(host)
-      # remove http(s):// and anything after a slash
-      @host = host.sub(%r{https?://}, '').split('/').first
-    end
+      def host=(host)
+        # remove http(s):// and anything after a slash
+        @host = host.sub(%r{https?://}, '').split('/').first
+      end
 
-    def base_path=(base_path)
-      # Add leading and trailing slashes to base_path
-      @base_path = "/#{base_path}".gsub(%r{/+}, '/')
-      @base_path = '' if @base_path == '/'
-    end
+      def base_path=(base_path)
+        # Add leading and trailing slashes to base_path
+        @base_path = "/#{base_path}".gsub(%r{/+}, '/')
+        @base_path = '' if @base_path == '/'
+      end
 
-    # Returns base URL for specified operation based on server settings
-    def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(%r{/+}, '/')}".sub(%r{/+\z}, '') if index.nil?
+      # Returns base URL for specified operation based on server settings
+      def base_url(operation = nil)
+        index = server_operation_index.fetch(operation, server_index)
+        return "#{scheme}://#{[host, base_path].join('/').gsub(%r{/+}, '/')}".sub(%r{/+\z}, '') if index.nil?
 
-      server_url(index, server_operation_variables.fetch(operation, server_variables),
-                 operation_server_settings[operation])
-    end
+        server_url(index, server_operation_variables.fetch(operation, server_variables),
+                   operation_server_settings[operation])
+      end
 
-    # Gets API key (with prefix if set).
-    # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
-      if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
-      else
-        @api_key[param_name]
+      # Gets API key (with prefix if set).
+      # @param [String] param_name the parameter name of API key auth
+      def api_key_with_prefix(param_name)
+        if @api_key_prefix[param_name]
+          "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        else
+          @api_key[param_name]
+        end
       end
-    end
 
-    # Gets Basic Auth token string
-    def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-    end
+      # Gets Basic Auth token string
+      def basic_auth_token
+        'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+      end
 
-    # Returns Auth Settings hash for api client.
-    def auth_settings
-      {
-        'clientId' =>
+      # Returns Auth Settings hash for api client.
+      def auth_settings
+        {
+          'clientId' =>
+            {
+              type: 'api_key',
+              in: 'header',
+              key: 'PLAID-CLIENT-ID',
+              value: api_key_with_prefix('PLAID-CLIENT-ID')
+            },
+          'secret' =>
+            {
+              type: 'api_key',
+              in: 'header',
+              key: 'PLAID-SECRET',
+              value: api_key_with_prefix('PLAID-SECRET')
+            }
+        }
+      end
+
+      # Returns an array of Server setting
+      def server_settings
+        [
           {
-            type: 'api_key',
-            in: 'header',
-            key: 'PLAID-CLIENT-ID',
-            value: api_key_with_prefix('PLAID-CLIENT-ID')
+            url: 'https://production.moneykit.com/plaid-compatible',
+            description: 'MoneyKit production environment (Live institution data)'
           },
-        'secret' =>
           {
-            type: 'api_key',
-            in: 'header',
-            key: 'PLAID-SECRET',
-            value: api_key_with_prefix('PLAID-SECRET')
+            url: 'https://sandbox.moneykit.com/plaid-compatible',
+            description: 'MoneyKit sandbox environment (Unrestricted environment with fake institution data)'
           }
-      }
-    end
-
-    # Returns an array of Server setting
-    def server_settings
-      [
-        {
-          url: 'https://production.moneykit.com/plaid-compatible',
-          description: 'MoneyKit production environment (Live institution data)'
-        },
-        {
-          url: 'https://sandbox.moneykit.com/plaid-compatible',
-          description: 'MoneyKit sandbox environment (Unrestricted environment with fake institution data)'
-        }
-      ]
-    end
+        ]
+      end
 
-    def operation_server_settings
-      {}
-    end
+      def operation_server_settings
+        {}
+      end
 
-    # Returns URL based on server settings
-    #
-    # @param index array index of the server settings
-    # @param variables hash of variable and the corresponding value
-    def server_url(index, variables = {}, servers = nil)
-      servers = server_settings if servers.nil?
+      # Returns URL based on server settings
+      #
+      # @param index array index of the server settings
+      # @param variables hash of variable and the corresponding value
+      def server_url(index, variables = {}, servers = nil)
+        servers = server_settings if servers.nil?
 
-      # check array index out of bound
-      if index < 0 || index >= servers.size
-        raise ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
-      end
+        # check array index out of bound
+        if index < 0 || index >= servers.size
+          raise ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+        end
 
-      server = servers[index]
-      url = server[:url]
+        server = servers[index]
+        url = server[:url]
 
-      return url unless server.key? :variables
+        return url unless server.key? :variables
 
-      # go through variable and assign a value
-      server[:variables].each do |name, _variable|
-        if variables.key?(name)
-          if !server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name])
-            url.gsub! '{' + name.to_s + '}', variables[name]
+        # go through variable and assign a value
+        server[:variables].each do |name, _variable|
+          if variables.key?(name)
+            if !server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name])
+              url.gsub! '{' + name.to_s + '}', variables[name]
+            else
+              raise ArgumentError,
+                    "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+            end
           else
-            raise ArgumentError,
-                  "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+            # use default value
+            url.gsub! '{' + name.to_s + '}', server[:variables][name][:default_value]
           end
-        else
-          # use default value
-          url.gsub! '{' + name.to_s + '}', server[:variables][name][:default_value]
         end
-      end
 
-      url
+        url
+      end
     end
   end
-  end
 end