atrium-ruby 1.3.2 → 2.0.0

data/examples/multi_factor_authentication.rb

@@ -1,57 +0,0 @@
-#!/usr/bin/env ruby
-require "atrium"
-
-::Atrium.configure do |config|
-  config.mx_client_id = "YOUR_MX_CLIENT_ID"
-  config.mx_api_key = "YOUR_MX_API_KEY"
-end
-
-puts "\n* Creating test user and member with \"CHALLENGED\" aggregation status *"
-user = ::Atrium::User.create :identifier => nil, :is_disabled => nil, :metadata => nil
-puts "Created user: " + user.guid
-
-credential_one = {}
-credential_one[:guid] = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1"
-credential_one[:value] = "test_atrium"
-
-credential_two = {}
-credential_two[:guid] = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d"
-credential_two[:value] = "challenge"
-
-credential_array = []
-credential_array.push(credential_one)
-credential_array.push(credential_two)
-
-member = ::Atrium::Member.create :user_guid => user.guid, :institution_code => "mxbank", :credentials => credential_array
-puts "Created member: " + member.guid
-
-sleep(1)
-
-puts "\n* Retrieving member aggregation status *"
-aggregation_response = member.aggregation_status
-puts "Member aggregation status: " + aggregation_response.status
-
-puts "\n* MFA Challenge *"
-challenges = member.mfa_challenges
-challenges.each do |challenge|
-  puts challenge.label
-end
-
-credential = {}
-credential[:guid] = challenges[0].guid
-credential[:value] = "correct"
-challenge_responses = []
-challenge_responses.push(credential)
-
-puts "\n* MFA answered correctly, resuming aggregation *"
-member.resume challenge_responses
-
-sleep(1)
-
-puts "\n* Retrieving member aggregation status *"
-aggregation_response = member.aggregation_status
-puts "Member aggregation status: " + aggregation_response.status
-
-puts "\n* Deleting test user *"
-user.delete
-puts "Deleted user: " + user.guid

data/examples/update_credentials.rb

@@ -1,58 +0,0 @@
-#!/usr/bin/env ruby
-require "atrium"
-
-::Atrium.configure do |config|
-  config.mx_client_id = "YOUR_MX_CLIENT_ID"
-  config.mx_api_key = "YOUR_MX_API_KEY"
-end
-
-puts "\n* Creating user and member with \"DENIED\" aggregation status *"
-user = ::Atrium::User.create :identifier => nil, :is_disabled => nil, :metadata => nil
-puts "Created user: " + user.guid
-
-credential_one = {}
-credential_one[:guid] = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1"
-credential_one[:value] = "test_atrium"
-
-credential_two = {}
-credential_two[:guid] = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d"
-credential_two[:value] = "INVALID"
-
-credential_array = []
-credential_array.push(credential_one)
-credential_array.push(credential_two)
-
-member = ::Atrium::Member.create :user_guid => user.guid, :institution_code => "mxbank", :credentials => credential_array
-puts "Created member: " + member.guid
-
-sleep(1)
-
-puts "\n* Retrieving member aggregation status *"
-aggregation_response = member.aggregation_status
-puts "Member aggregation status: " + aggregation_response.status
-
-puts "\n* Updating credentials *"
-credentials = ::Atrium::Institution.credentials "mxbank"
-
-username_credential = {}
-username_credential[:guid] = credentials[0].guid
-username_credential[:value] = "test_atrium"
-
-password_credential = {}
-password_credential[:guid] = credentials[1].guid
-password_credential[:value] = "password"
-
-updated_credentials = []
-updated_credentials.push(username_credential)
-updated_credentials.push(password_credential)
-
-member.update(:credentials => updated_credentials)
-sleep(1)
-
-puts "\n* Retrieving member aggregation status *"
-aggregation_response = member.aggregation_status
-puts "Member aggregation status: " + aggregation_response.status
-
-puts "\n* Deleting test user *"
-user.delete
-puts "Deleted user: " + user.guid

data/examples/user_and_member_creation.rb

@@ -1,53 +0,0 @@
-#!/usr/bin/env ruby
-require "atrium"
-
-::Atrium.configure do |config|
-  config.mx_client_id = "YOUR_MX_CLIENT_ID"
-  config.mx_api_key = "YOUR_MX_API_KEY"
-end
-
-puts "\n* Creating user *"
-user = ::Atrium::User.create :identifier => nil, :is_disabled => nil, :metadata => nil
-puts user.guid
-
-puts "\n* Listing institutions with query string \"bank\" *"
-name = "bank"
-params = { :name => name }
-institutions = ::Atrium::Institution.list :query_params => params
-institutions.each do |institution|
-  puts institution.name + " : institution code = " + institution.code
-end
-
-puts "\n* Reading institution \"mxbank\" *"
-institution = ::Atrium::Institution.read :institution_code => "mxbank"
-puts institution.name
-
-puts "\n* Reading institution credentials \"mxbank\" *"
-credentials = ::Atrium::Institution.credentials "chase"
-credentials.each do |credential|
-  puts credential.guid
-end
-
-puts "\n* Creating member *"
-
-# Create credential JSON object
-credential_one = {}
-credential_one[:guid] = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1"
-credential_one[:value] = "test_atrium"
-
-# Create another credential JSON object
-credential_two = {}
-credential_two[:guid] = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d"
-credential_two[:value] = "password"
-
-# Create credential array from credential JSON Objects
-credential_array = []
-credential_array.push(credential_one)
-credential_array.push(credential_two)
-
-member = ::Atrium::Member.create :user_guid => user.guid, :institution_code => "mxbank", :credentials => credential_array
-puts member.guid
-
-puts "\n* Deleting test user *"
-user.delete
-puts "Deleted user: " + user.guid

data/lib/atrium.rb

@@ -1,40 +0,0 @@
-require "active_attr"
-require "httpclient"
-require "json"
-require "atrium/pageable"
-require "atrium/paginate"
-
-require "atrium/account"
-require "atrium/account_number"
-require "atrium/account_owner"
-require "atrium/client"
-require "atrium/connect"
-require "atrium/credential"
-require "atrium/error"
-require "atrium/institution"
-require "atrium/challenge"
-require "atrium/member"
-require "atrium/transaction"
-require "atrium/user"
-require "atrium/version"
-
-module Atrium
-  ##
-  # mx-api-key and mx-client-id are required for Atrium
-  #
-  # Atrium.configure do |config|
-  #   config.mx_api_key = generated_api_key
-  #   config.mx_client_id = generated_client_id
-  #   config.base_url = "https://atrium.mx.com" # for production URL. this will default to vestibule
-  #   config.verify_ssl = false # Defaults to true
-  # end
-  #
-  class << self
-    attr_reader :client
-
-    def configure
-      @client = ::Atrium::Client.new
-      yield @client
-    end
-  end
-end

data/lib/atrium/account.rb

@@ -1,100 +0,0 @@
-module Atrium
-  class Account
-    extend ::Atrium::Pageable
-    include ::ActiveAttr::Model
-
-    # ATTRIBUTES
-    attribute :apr
-    attribute :apy
-    attribute :available_balance
-    attribute :available_credit
-    attribute :balance
-    attribute :created_at
-    attribute :credit_limit
-    attribute :day_payment_is_due
-    attribute :guid
-    attribute :institution_code
-    attribute :interest_rate
-    attribute :is_closed
-    attribute :last_payment
-    attribute :last_payment_at
-    attribute :matures_on
-    attribute :member_guid
-    attribute :minimum_balance
-    attribute :minimum_payment
-    attribute :name
-    attribute :original_balance
-    attribute :payment_due_at
-    attribute :payoff_balance
-    attribute :started_on
-    attribute :subtype
-    attribute :total_account_value
-    attribute :type
-    attribute :updated_at
-    attribute :user_guid
-
-    def self.list(options = {})
-      options = _account_pagination_options(options)
-      paginate(options)
-    end
-
-    def self.list_each(options = {})
-      options = _account_pagination_options(options)
-      paginate_each(options) { |account| yield account }
-    end
-
-    def self.list_in_batches(options = {})
-      options = _account_pagination_options(options)
-      paginate_in_batches(options) { |batch| yield batch }
-    end
-
-    def self.read(user_guid:, account_guid:)
-      endpoint = "/users/#{user_guid}/accounts/#{account_guid}"
-      account_response = ::Atrium.client.make_request(:get, endpoint)
-
-      account_params = account_response["account"]
-      ::Atrium::Account.new(account_params)
-    end
-
-    def account_numbers
-      endpoint = "/users/#{user_guid}/accounts/#{guid}/account_numbers"
-      account_numbers_response = ::Atrium.client.make_request(:get, endpoint)
-
-      return nil if account_numbers_response.nil?
-
-      account_numbers_params = account_numbers_response["account_numbers"]
-
-      account_numbers_params.map do |account_number|
-        ::Atrium::AccountNumber.new(account_number)
-      end
-    end
-
-    def transactions(options = {})
-      options = _transaction_pagination_options(options)
-      self.class.paginate(options)
-    end
-
-    def each_transaction(options = {})
-      options = _transaction_pagination_options(options)
-      self.class.paginate_each(options) { |account| yield account }
-    end
-
-    def transactions_in_batches(options = {})
-      options = _transaction_pagination_options(options)
-      self.class.paginate_in_batches(options) { |batch| yield batch }
-    end
-
-    def self._account_pagination_options(options)
-      user_guid = options.fetch(:user_guid)
-      endpoint = "/users/#{user_guid}/accounts"
-      options.merge(:endpoint => endpoint, :resource => "accounts")
-    end
-
-  private
-
-    def _transaction_pagination_options(options)
-      endpoint = "/users/#{user_guid}/accounts/#{guid}/transactions"
-      options.merge(:endpoint => endpoint, :resource => "transactions", :klass => ::Atrium::Transaction)
-    end
-  end
-end

data/lib/atrium/account_number.rb

@@ -1,13 +0,0 @@
-module Atrium
-  class AccountNumber
-    include ::ActiveAttr::Model
-    include ::ActiveAttr::Attributes
-
-    attribute :guid
-    attribute :user_guid
-    attribute :member_guid
-    attribute :account_guid
-    attribute :account_number
-    attribute :routing_number
-  end
-end

data/lib/atrium/account_owner.rb

@@ -1,19 +0,0 @@
-module Atrium
-  class AccountOwner
-    include ::ActiveAttr::Model
-    include ::ActiveAttr::Attributes
-
-    attribute :guid
-    attribute :user_guid
-    attribute :member_guid
-    attribute :account_guid
-    attribute :owner_name
-    attribute :address
-    attribute :city
-    attribute :state
-    attribute :postal_code
-    attribute :country
-    attribute :email
-    attribute :phone
-  end
-end

data/lib/atrium/challenge.rb

@@ -1,13 +0,0 @@
-module Atrium
-  class Challenge
-    include ::ActiveAttr::Model
-    include ::ActiveAttr::Attributes
-
-    attribute :field_name
-    attribute :guid
-    attribute :label
-    attribute :type
-    attribute :image_data
-    attribute :options
-  end
-end

data/lib/atrium/client.rb

@@ -1,51 +0,0 @@
-module Atrium
-  class Client
-    DEVELOPMENT_URL = "https://vestibule.mx.com".freeze
-    attr_accessor :mx_api_key, :mx_client_id, :base_url, :verify_ssl
-
-    def initialize(api_key = nil, client_id = nil, base_url = DEVELOPMENT_URL, verify_ssl = true)
-      @mx_api_key   = api_key
-      @mx_client_id = client_id
-      @base_url     = base_url
-      @verify_ssl   = verify_ssl
-    end
-
-    def make_request(method, endpoint, body = nil, headers = {})
-      headers = default_headers.merge(headers)
-      url     = "#{base_url}#{endpoint}"
-      body    = ::JSON.dump(body) if body
-
-      response = http_client.public_send(method, url, body, headers)
-
-      handle_response(response)
-    end
-
-    def http_client
-      @http_client ||= begin
-                         client = ::HTTPClient.new
-                         client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @verify_ssl
-                         client
-                       end
-    end
-
-  private
-
-    def default_headers
-      {
-        "Accept"       => "application/vnd.mx.atrium.v1+json",
-        "Content-Type" => "application/json",
-        "MX-API-KEY"   => mx_api_key,
-        "MX-CLIENT-ID" => mx_client_id
-      }
-    end
-
-    def handle_response(response)
-      # Handle 200-206 responses as acceptable
-      unless response.status.between?(200, 206)
-        raise ::Atrium::Error, "#{response.status}: #{response.body}"
-      end
-
-      ::JSON.parse(response.body) unless response.body.empty?
-    end
-  end
-end

data/lib/atrium/connect.rb

@@ -1,34 +0,0 @@
-require "set"
-
-module Atrium
-  class Connect
-    include ::ActiveAttr::Model
-
-    PERMITTED_CONNECT_CREATE_OPTIONS = ::Set.new([
-                                                   "current_institution_code",
-                                                   "current_member_guid",
-                                                   "is_mobile_webview",
-                                                   "update_credentials",
-                                                 ]).freeze
-    SCRIPT_SOURCE = "https://atrium.mx.com/connect.js".freeze
-
-    # ATTRIBUTES
-    attribute :connect_widget_url
-    attribute :guid
-
-    ##
-    # CLASS METHODS
-    #
-    def self.create(user_guid:, options: {})
-      options.each_key do |key|
-        fail ArgumentError, "An invalid option was provided: #{key}" unless PERMITTED_CONNECT_CREATE_OPTIONS.include?(key.to_s)
-      end
-
-      endpoint = "/users/#{user_guid}/connect_widget_url"
-      connect_response = ::Atrium.client.make_request(:post, endpoint, options)
-
-      connect_params = connect_response["user"]
-      ::Atrium::Connect.new(connect_params)
-    end
-  end
-end