atrium-ruby 1.3.2 → 2.0.0

data/lib/atrium-ruby/api_error.rb

@@ -0,0 +1,34 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+module Atrium
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # 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
+    end
+  end
+end

data/lib/atrium-ruby/configuration.rb

@@ -0,0 +1,212 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+require 'uri'
+
+module Atrium
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # 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.
+    # Default to 0 (never times out).
+    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 :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # 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 :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # 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
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'vestibule.mx.com'
+      @base_path = ''
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    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]
+      end
+    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
+      {
+        'apiKey' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'MX-API-Key',
+            value: api_key_with_prefix('MX-API-Key')
+          },
+        'clientID' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'MX-Client-ID',
+            value: api_key_with_prefix('MX-Client-ID')
+          },
+      }
+    end
+  end
+end

data/lib/atrium-ruby/models/account.rb

@@ -0,0 +1,422 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+require 'date'
+
+module Atrium
+  class Account
+    attr_accessor :apr
+
+    attr_accessor :apy
+
+    attr_accessor :available_balance
+
+    attr_accessor :available_credit
+
+    attr_accessor :balance
+
+    attr_accessor :created_at
+
+    attr_accessor :credit_limit
+
+    attr_accessor :currency_code
+
+    attr_accessor :day_payment_is_due
+
+    attr_accessor :guid
+
+    attr_accessor :institution_code
+
+    attr_accessor :interest_rate
+
+    attr_accessor :is_closed
+
+    attr_accessor :last_payment
+
+    attr_accessor :matures_on
+
+    attr_accessor :member_guid
+
+    attr_accessor :minimum_balance
+
+    attr_accessor :minimum_payment
+
+    attr_accessor :name
+
+    attr_accessor :original_balance
+
+    attr_accessor :payment_due_at
+
+    attr_accessor :payoff_balance
+
+    attr_accessor :started_on
+
+    attr_accessor :subtype
+
+    attr_accessor :total_account_value
+
+    attr_accessor :type
+
+    attr_accessor :updated_at
+
+    attr_accessor :user_guid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'apr' => :'apr',
+        :'apy' => :'apy',
+        :'available_balance' => :'available_balance',
+        :'available_credit' => :'available_credit',
+        :'balance' => :'balance',
+        :'created_at' => :'created_at',
+        :'credit_limit' => :'credit_limit',
+        :'currency_code' => :'currency_code',
+        :'day_payment_is_due' => :'day_payment_is_due',
+        :'guid' => :'guid',
+        :'institution_code' => :'institution_code',
+        :'interest_rate' => :'interest_rate',
+        :'is_closed' => :'is_closed',
+        :'last_payment' => :'last_payment',
+        :'matures_on' => :'matures_on',
+        :'member_guid' => :'member_guid',
+        :'minimum_balance' => :'minimum_balance',
+        :'minimum_payment' => :'minimum_payment',
+        :'name' => :'name',
+        :'original_balance' => :'original_balance',
+        :'payment_due_at' => :'payment_due_at',
+        :'payoff_balance' => :'payoff_balance',
+        :'started_on' => :'started_on',
+        :'subtype' => :'subtype',
+        :'total_account_value' => :'total_account_value',
+        :'type' => :'type',
+        :'updated_at' => :'updated_at',
+        :'user_guid' => :'user_guid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.mx_types
+      {
+        :'apr' => :'Float',
+        :'apy' => :'Float',
+        :'available_balance' => :'Float',
+        :'available_credit' => :'Float',
+        :'balance' => :'Float',
+        :'created_at' => :'String',
+        :'credit_limit' => :'Float',
+        :'currency_code' => :'String',
+        :'day_payment_is_due' => :'Integer',
+        :'guid' => :'String',
+        :'institution_code' => :'String',
+        :'interest_rate' => :'Float',
+        :'is_closed' => :'BOOLEAN',
+        :'last_payment' => :'Float',
+        :'matures_on' => :'String',
+        :'member_guid' => :'String',
+        :'minimum_balance' => :'Float',
+        :'minimum_payment' => :'Float',
+        :'name' => :'String',
+        :'original_balance' => :'Float',
+        :'payment_due_at' => :'String',
+        :'payoff_balance' => :'Float',
+        :'started_on' => :'String',
+        :'subtype' => :'String',
+        :'total_account_value' => :'Float',
+        :'type' => :'String',
+        :'updated_at' => :'String',
+        :'user_guid' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'apr')
+        self.apr = attributes[:'apr']
+      end
+
+      if attributes.has_key?(:'apy')
+        self.apy = attributes[:'apy']
+      end
+
+      if attributes.has_key?(:'available_balance')
+        self.available_balance = attributes[:'available_balance']
+      end
+
+      if attributes.has_key?(:'available_credit')
+        self.available_credit = attributes[:'available_credit']
+      end
+
+      if attributes.has_key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
+      if attributes.has_key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.has_key?(:'credit_limit')
+        self.credit_limit = attributes[:'credit_limit']
+      end
+
+      if attributes.has_key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.has_key?(:'day_payment_is_due')
+        self.day_payment_is_due = attributes[:'day_payment_is_due']
+      end
+
+      if attributes.has_key?(:'guid')
+        self.guid = attributes[:'guid']
+      end
+
+      if attributes.has_key?(:'institution_code')
+        self.institution_code = attributes[:'institution_code']
+      end
+
+      if attributes.has_key?(:'interest_rate')
+        self.interest_rate = attributes[:'interest_rate']
+      end
+
+      if attributes.has_key?(:'is_closed')
+        self.is_closed = attributes[:'is_closed']
+      end
+
+      if attributes.has_key?(:'last_payment')
+        self.last_payment = attributes[:'last_payment']
+      end
+
+      if attributes.has_key?(:'matures_on')
+        self.matures_on = attributes[:'matures_on']
+      end
+
+      if attributes.has_key?(:'member_guid')
+        self.member_guid = attributes[:'member_guid']
+      end
+
+      if attributes.has_key?(:'minimum_balance')
+        self.minimum_balance = attributes[:'minimum_balance']
+      end
+
+      if attributes.has_key?(:'minimum_payment')
+        self.minimum_payment = attributes[:'minimum_payment']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'original_balance')
+        self.original_balance = attributes[:'original_balance']
+      end
+
+      if attributes.has_key?(:'payment_due_at')
+        self.payment_due_at = attributes[:'payment_due_at']
+      end
+
+      if attributes.has_key?(:'payoff_balance')
+        self.payoff_balance = attributes[:'payoff_balance']
+      end
+
+      if attributes.has_key?(:'started_on')
+        self.started_on = attributes[:'started_on']
+      end
+
+      if attributes.has_key?(:'subtype')
+        self.subtype = attributes[:'subtype']
+      end
+
+      if attributes.has_key?(:'total_account_value')
+        self.total_account_value = attributes[:'total_account_value']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.has_key?(:'user_guid')
+        self.user_guid = attributes[:'user_guid']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          apr == o.apr &&
+          apy == o.apy &&
+          available_balance == o.available_balance &&
+          available_credit == o.available_credit &&
+          balance == o.balance &&
+          created_at == o.created_at &&
+          credit_limit == o.credit_limit &&
+          currency_code == o.currency_code &&
+          day_payment_is_due == o.day_payment_is_due &&
+          guid == o.guid &&
+          institution_code == o.institution_code &&
+          interest_rate == o.interest_rate &&
+          is_closed == o.is_closed &&
+          last_payment == o.last_payment &&
+          matures_on == o.matures_on &&
+          member_guid == o.member_guid &&
+          minimum_balance == o.minimum_balance &&
+          minimum_payment == o.minimum_payment &&
+          name == o.name &&
+          original_balance == o.original_balance &&
+          payment_due_at == o.payment_due_at &&
+          payoff_balance == o.payoff_balance &&
+          started_on == o.started_on &&
+          subtype == o.subtype &&
+          total_account_value == o.total_account_value &&
+          type == o.type &&
+          updated_at == o.updated_at &&
+          user_guid == o.user_guid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [apr, apy, available_balance, available_credit, balance, created_at, credit_limit, currency_code, day_payment_is_due, guid, institution_code, interest_rate, is_closed, last_payment, matures_on, member_guid, minimum_balance, minimum_payment, name, original_balance, payment_due_at, payoff_balance, started_on, subtype, total_account_value, type, updated_at, user_guid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.mx_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Atrium.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end