atrium-ruby 1.3.2 → 2.0.0

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle
-/.yardoc
-/Gemfile.lock
-/_yardoc
-/coverage
-/doc
-/pkg
-/spec/reports
-/tmp
-*.gem

data/.rubocop.yml

@@ -1,12 +0,0 @@
-# inherit_from: .rubocop_todo.yml
-inherit_gem:
-  mad_rubocop: .rubocop.yml
-AllCops:
-  TargetRubyVersion: 2.3
-  Include:
-    - 'Gemfile'
-    - 'Rakefile'
-Style/FileName:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
- - 2.4
- - 2.3
-sudo: false
-cache: bundler
-before_script:
-  - bundle exec rubocop
-notifications:
-  email:
-    on_success: never
-    on_failure: always

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "atrium"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/demo

@@ -1,49 +0,0 @@
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "atrium"
-require "pry"
-require "yaml"
-
-def load_settings
-  if ::File.exist?("tmp/settings.yml")
-    puts "=> Using key and ID in tmp/settings.yml ¬"
-    ::YAML.safe_load(::File.read("tmp/settings.yml"))
-  else
-    settings = {}
-    puts "What is your MX-API-KEY?"
-    settings[:mx_api_key] = gets.chomp
-
-    puts "What is your Client ID?"
-    settings[:mx_client_id] = gets.chomp
-
-    puts "Would you like to save API key and client ID for future use?"
-    case gets.chomp
-    when /y/i
-      ::File.open("tmp/settings.yml", "w") { |f| f.write(settings.to_yaml) }
-      puts "Settings written to tmp/settings.yml ¬"
-      settings
-    when /n/i
-      puts "One-time use settings ¬"
-      settings
-    end
-  end
-end
-
-settings = load_settings
-settings.each { |k, v| puts "\t#{k}: #{v}" }
-
-::Atrium.configure do |config|
-  config.mx_client_id = settings[:mx_client_id]
-  config.mx_api_key = settings[:mx_api_key]
-end
-
-## Example flow
-#
-# 1. Create a User
-# 2. Read that user data via GUID
-# 3. List Institutions
-# 4. Get credentials for institution
-# 5. Create member on user
-# 6. Check member aggregation status
-# 7. Read other user data (accounts, members, transactions)
-#

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/accounts_and_transactions.rb

@@ -1,49 +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 *"
-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] = "password"
-
-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* Aggregating Member *"
-member.aggregate
-
-sleep(4)
-puts "Member aggregation status: " + member.status
-
-puts "\n* Listing all member accounts and transactions *"
-accounts = member.accounts
-accounts.each do |account|
-  puts "\nType: " + account.type + "\tName: " + account.name + "\tAvailable Balance: " + account.available_balance.to_s + "\tAvailable Credit: " + account.available_credit.to_s
-  puts "Transactions"
-  transactions = account.transactions
-  transactions.each do |transaction|
-    puts "\tDate: " + transaction.date + "\tDescription: " + transaction.description + "\tAmount: " + transaction.amount.to_s
-  end
-end
-
-puts "\n* Deleting test user *"
-user.delete
-puts "Deleted user: " + user.guid

data/examples/all_endpoints.rb

@@ -1,226 +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************************** Create User **************************"
-user = ::Atrium::User.create :identifier => nil, :is_disabled => "", :metadata => "{\"first_name\": \"Steven\"}"
-puts user.attributes
-user_guid = user.guid
-
-puts "\n************************** Read User **************************"
-user = ::Atrium::User.read :guid => user_guid
-puts user.attributes
-
-puts "\n************************** Update User **************************"
-user = ::Atrium::User.read :guid => user_guid
-user = user.update :metadata => "{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}"
-puts user.attributes
-
-puts "\n************************** List Users **************************"
-users = ::Atrium::User.list
-users.each do |a_user|
-  puts a_user.attributes
-end
-
-puts "\n************************** List Institutions **************************"
-name = "bank"
-params = { :name => name }
-institutions = ::Atrium::Institution.list :query_params => params
-institutions.each do |institution|
-  puts institution.attributes
-end
-
-puts "\n************************** Read Institution **************************"
-institution = ::Atrium::Institution.read :institution_code => "mxbank"
-puts institution.attributes
-
-puts "\n************************** Read Institution Credentials ************************** "
-credentials = ::Atrium::Institution.credentials "mxbank"
-credentials.each do |credential|
-  puts credential.attributes
-end
-
-puts "\n************************** Create Member **************************"
-# Create credential JSON object
-credential_one = {}
-credential_one[:guid] = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1"
-credential_one[:value] = "test_atrium1"
-
-# Create another credential JSON object
-credential_two = {}
-credential_two[:guid] = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d"
-credential_two[:value] = "challenge1"
-
-# 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.attributes
-member_guid = member.guid
-
-puts "\n************************** Read Member **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-puts member.attributes
-
-puts "\n************************** Update Member **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-
-username_credential = {}
-username_credential[:guid] = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1"
-username_credential[:value] = "test_atrium"
-
-password_credential = {}
-password_credential[:guid] = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d"
-password_credential[:value] = "challenge"
-
-updated_credentials = []
-updated_credentials.push(username_credential)
-updated_credentials.push(password_credential)
-
-member = member.update(:metadata => "{\"credentials_last_refreshed_at\": \"2015-10-16\"}", :credentials => updated_credentials)
-puts member.attributes
-
-puts "\n************************** List Members **************************"
-members = ::Atrium::Member.list :user_guid => user_guid
-members.each do |a_member|
-  puts a_member.attributes
-end
-
-puts "\n************************** Aggregate Member **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-member = member.aggregate
-puts member.attributes
-
-puts "\n************************** Read Member Status **************************"
-sleep(5)
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-member = member.aggregation_status
-puts member.attributes
-
-puts "\n************************** List Member MFA Challenges **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-challenges = member.mfa_challenges
-challenges.each do |challenge|
-  puts challenge.attributes
-end
-challenge_guid = challenges[0].guid
-
-puts "\n************************** Resume Aggregation **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-
-credential_one = {}
-credential_one[:guid] = challenge_guid
-credential_one[:value] = "correct"
-
-challenge_responses = []
-challenge_responses.push(credential_one)
-
-member = member.resume challenge_responses
-puts member.attributes
-
-puts "\n************************** List Member Credentials **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-credentials = member.credentials
-credentials.each do |credential|
-  puts credential.attributes
-end
-
-puts "\n************************** List Member Accounts **************************"
-sleep(5)
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-accounts = member.accounts
-accounts.each do |account|
-  puts account.attributes
-end
-account_guid = accounts[0].guid
-
-puts "\n************************** List Member Transactions **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-transactions = member.transactions
-transactions.each do |transaction|
-  puts transaction.attributes
-end
-
-puts "\n************************** Read Account **************************"
-account = ::Atrium::Account.read :user_guid => user_guid, :account_guid => account_guid
-puts account.attributes
-
-puts "\n************************** List Accounts for User **************************"
-user_guid = user_guid
-params = { :user_guid => user_guid }
-accounts = ::Atrium::Account.list params
-accounts.each do |an_account|
-  puts an_account.attributes
-end
-
-puts "\n************************** List Account Transactions **************************"
-account = ::Atrium::Account.read :user_guid => user_guid, :account_guid => account_guid
-
-user_guid = user_guid
-guid = account_guid
-params = { :user_guid => user_guid, :guid => guid }
-
-transactions = account.transactions params
-transactions.each do |transaction|
-  puts transaction.attributes
-end
-transaction_guid = transactions[0].guid
-
-puts "\n************************** Read a Transaction **************************"
-transaction = ::Atrium::Transaction.read :user_guid => user_guid, :transaction_guid => transaction_guid
-puts transaction.attributes
-
-puts "\n************************** List Transactions **************************"
-user_guid = user_guid
-account_guid = account_guid
-params = { :user_guid => user_guid, :account_guid => account_guid }
-
-transactions = ::Atrium::Transaction.list params
-transactions.each do |a_transaction|
-  puts a_transaction.attributes
-end
-
-puts "\n*********************** Categorize Transactions ***********************"
-transactions_to_categorize = ::JSON.parse('[
-        {
-            "amount": 11.22,
-            "description": "BEER BAR 65000000764SALT LAKE C",
-            "id": "12",
-            "type": "DEBIT"
-        },
-        {
-            "amount": 21.33,
-            "description": "IN-N-OUT BURGER #239AMERICAN FO",
-            "id": "13",
-            "type": "DEBIT"
-        },
-        {
-            "amount": 1595.33,
-            "description": "ONLINE PAYMENT - THANK YOU",
-            "id": "14",
-            "type": "CREDIT"
-        }
-    ]')
-
-transactions = ::Atrium::Transaction.categorize_and_describe transactions_to_categorize
-transactions.each do |a_transaction|
-  puts a_transaction.attributes
-end
-
-puts "\n************************** Connect Widget **************************"
-widget = ::Atrium::Connect.create :user_guid => user_guid
-puts widget.attributes
-
-puts "\n************************** Delete Member **************************"
-member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-puts member.delete
-
-puts "\n************************** Delete User **************************"
-user = ::Atrium::User.read :guid => user_guid
-puts user.delete

data/examples/example_workflow.rb

@@ -1,176 +0,0 @@
-#!/usr/bin/env ruby
-require "atrium"
-
-def check_job_status(user_guid, member_guid, counter)
-  puts "\n2 second delay..."
-  sleep(2)
-
-  member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-  member_response = member.aggregation_status
-  status = member_response.status
-
-  puts "\nJOB STATUS: " + status
-  case status
-  when "COMPLETED"
-    read_aggregation_data(user_guid, member_guid)
-  when "HALTED", "FAILED"
-    current_time = Time.now.utc.iso8601.chomp("Z") + "+00:00"
-
-    member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-    last_success_time = member.aggregation_status
-
-    # Check if last successful aggregation over 3 days aggregation
-    if !last_success_time.nil? && ((current_time[8, 2] - last_success_time[8, 2]).abs > 3 || (current_time[5, 2] - last_success_time[5, 2]).abs > 0 || (current_time[0, 4] - last_success_time[0, 4]).abs > 0)
-      puts "\nClient should contact MX Support to resolve issue."
-    else
-      puts "\nAn update is currently unavailable. Please try again tomorrow"
-    end
-  when "CREATED", "UPDATED", "RESUMED", "CONNECTED", "DEGRADED", "DELAYED", "INITIATED", "REQUESTED", "AUTHENTICATED", "RECEIVED", "TRANSFERRED"
-    check_job_status(user_guid, member_guid, counter)
-  when "PREVENTED", "DENIED", "IMPAIRED"
-    member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-    institution_code = member.institution_code
-
-    puts "\nPlease update credentials"
-    credentials = ::Atrium::Institution.credentials institution_code
-    updated_credentials = []
-    credentials.each do |credential|
-      puts "\nPlease enter in " + credential.label + ":"
-      response = gets.chomp
-      cred_pair = {}
-      cred_pair[:guid] = credential.guid
-      cred_pair[:value] = response
-      updated_credentials.push(cred_pair)
-    end
-
-    member.update(:credentials => updated_credentials)
-
-    check_job_status(user_guid, member_guid, counter)
-  when "CHALLENGED"
-    member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-    puts "\nPlease answer the following challenges:"
-    challenges = member.challenges
-    challenge_array = []
-    challenges.each do |challenge|
-      puts challenge.label
-      answer = gets.chomp
-      cred_pair = {}
-      cred_pair[:guid] = challenge.guid
-      cred_pair[:value] = answer
-      challenge_array.push(cred_pair)
-    end
-
-    member.resume challenge_array
-
-    check_job_status(user_guid, member_guid, counter)
-  when "REJECTED"
-    member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-    member.aggregate
-
-    check_job_status(user_guid, member_guid, counter)
-  when "EXPIRED"
-    puts "\nUser did not answer MFA in time. Please try again tomorrow."
-  when "LOCKED"
-    puts "\nUser's account is locked at FI"
-  when "IMPEDED"
-    puts "\nUser's attention is required at FI website in order for aggregation to complete"
-  when "DISCONTINUED"
-    puts "\nConnection to institution is no longer available."
-  when "CLOSED", "DISABLED"
-    puts "\nAggregation is purposely turned off for this user."
-  when "TERMINATED", "ABORTED", "STOPPED", "THROTTLED", "SUSPENDED", "ERRORED"
-    if counter < 3
-      counter += 1
-      check_job_status(user_guid, member_guid, counter)
-    else
-      puts "\nAn update is currently unavailable. Please try again tomorrow and contact support if unsuccessful after 3 days."
-    end
-  else
-    puts status
-  end
-end
-
-def read_aggregation_data(user_guid, member_guid)
-  member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-
-  puts "\n* Listing all member accounts and transactions *"
-  accounts = member.accounts
-  accounts.each do |account|
-    puts "\nType: " + account.type + "\tName: " + account.name + "\tAvailable Balance: " + account.available_balance.to_s + "\tAvailable Credit: " + account.available_credit.to_s
-    puts "Transactions"
-    transactions = account.transactions
-    transactions.each do |transaction|
-      puts "\tDate: " + transaction.date + "\tDescription: " + transaction.description + "\tAmount: " + transaction.amount.to_s
-    end
-  end
-end
-
-::Atrium.configure do |config|
-  config.mx_client_id = "YOUR_MX_CLIENT_ID"
-  config.mx_api_key = "YOUR_MX_API_KEY"
-end
-
-counter = 0
-
-puts "Please enter in user GUID. If not yet created just press enter key: "
-user_guid = gets.chomp
-
-puts "\nPlease enter in member GUID. If not yet created just press enter key: "
-member_guid = gets.chomp
-
-puts "\nPlease enter in if end user is present (true or false): "
-end_user_present = gets.chomp
-
-if user_guid == "" && member_guid != ""
-  puts "\nMust include user GUID when member GUID is entered."
-  exit
-end
-
-if user_guid == "" && end_user_present == "true"
-  puts "\n* Creating user *"
-
-  puts "\nPlease enter in an unique id: "
-  identifier = gets.chomp
-
-  user = ::Atrium::User.create :identifier => identifier, :is_disabled => nil, :metadata => nil
-  user_guid = user.guid
-  puts "\nCreated user: " + user_guid
-end
-
-if member_guid != "" && end_user_present == "true"
-  member = ::Atrium::Member.read :user_guid => user_guid, :member_guid => member_guid
-  member.aggregate
-  check_job_status(user_guid, member_guid, counter)
-elsif member_guid != ""
-  read_aggregation_data(user_guid, member_guid)
-elsif end_user_present == "true"
-  puts "\n* Creating member *"
-
-  institutions = ::Atrium::Institution.list
-  institutions.each do |institution|
-    puts institution.name + " : institution code = " + institution.code
-  end
-
-  puts "\nPlease enter in desired institution code: "
-  institution_code = gets.chomp
-
-  credentials = ::Atrium::Institution.credentials institution_code
-  credential_array = []
-  credentials.each do |credential|
-    puts "\nPlease enter in " + credential.label + ":"
-    response = gets.chomp
-    cred_pair = {}
-    cred_pair[:guid] = credential.guid
-    cred_pair[:value] = response
-    credential_array.push(cred_pair)
-  end
-
-  member = ::Atrium::Member.create :user_guid => user_guid, :institution_code => institution_code, :credentials => credential_array
-  member_guid = member.guid
-  puts "\nCreated member: " + member_guid
-
-  check_job_status(user_guid, member_guid, counter)
-else
-  puts "\nEnd user must be present to create a new member"
-  exit
-end