mx-platform-ruby 0.1.0 → 0.1.1

data/spec/lib/mx-platform-ruby/credential_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Credential do
+  let(:credential_attributes) do
+    {
+      display_order: 1,
+      field_name: 'LOGIN',
+      field_type: 'TEXT',
+      guid: 'CRD-1ec152cd-e628-e81a-e852-d1e7104624da',
+      label: 'Username'
+    }
+  end
+  let(:list_institution_required_credentials_options) do
+    {
+      institution_code: 'chase',
+      page: 1,
+      records_per_page: 10
+    }
+  end
+  let(:list_member_credentials_options) do
+    {
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      page: 1,
+      records_per_page: 10,
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:pagination_attributes) do
+    {
+      'current_page' => 1,
+      'per_page' => 25,
+      'total_pages' => 1,
+      'total_entries' => 1
+    }
+  end
+
+  context 'list_institution_required_credentials endpoints' do
+    let(:list_institution_required_credentials_response) do
+      {
+        'credentials' => [credential_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_institution_required_credentials_response) }
+
+    describe 'list_institution_required_credentials' do
+      it 'returns a list of credentials' do
+        response = described_class.list_institution_required_credentials
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Credential)
+        expect(response.first.display_order).to eq(credential_attributes[:display_order])
+        expect(response.first.field_name).to eq(credential_attributes[:field_name])
+        expect(response.first.field_type).to eq(credential_attributes[:field_type])
+        expect(response.first.guid).to eq(credential_attributes[:guid])
+        expect(response.first.label).to eq(credential_attributes[:label])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  context 'list_member_credentials endpoints' do
+    let(:list_member_credentials_response) do
+      {
+        'credentials' => [credential_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_member_credentials_response) }
+
+    describe 'list_member_credentials' do
+      it 'returns a list of credentials' do
+        response = described_class.list_member_credentials
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Credential)
+        expect(response.first.display_order).to eq(credential_attributes[:display_order])
+        expect(response.first.field_name).to eq(credential_attributes[:field_name])
+        expect(response.first.field_type).to eq(credential_attributes[:field_type])
+        expect(response.first.guid).to eq(credential_attributes[:guid])
+        expect(response.first.label).to eq(credential_attributes[:label])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+end

data/spec/lib/mx-platform-ruby/enhanced_transaction_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::EnhancedTransaction do
+  let(:enhanced_transaction_attributes) do
+    {
+      amount: 21.33,
+      category: 'Fast Food',
+      description: 'IN-N-OUT BURGER',
+      id: 'ID-123',
+      is_bill_pay: false,
+      is_direct_deposit: false,
+      is_expense: false,
+      is_fee: false,
+      is_income: false,
+      is_international: false,
+      is_overdraft_fee: false,
+      is_payroll_advance: false,
+      merchant_category_code: 5411,
+      merchant_guid: 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b',
+      original_description: 'IN-N-OUT BURGER',
+      type: 'DEBIT'
+    }
+  end
+  let(:enhance_transactions_options) do
+    {
+      transactions: [
+        {
+          amount: 21.33,
+          description: 'IN-N-OUT BURGER',
+          id: 'ID-123',
+          merchant_category_code: 123,
+          type: 'DEBIT'
+        }
+      ]
+    }
+  end
+
+  describe 'enhance_transactions' do
+    let(:enhance_transactions_response) { { 'transactions' => [enhanced_transaction_attributes] } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(enhance_transactions_response) }
+
+    it 'returns an array of enhanced_transactions' do
+      response = described_class.enhance_transactions
+
+      expect(response).to be_kind_of(::Array)
+      expect(response.first).to be_kind_of(::MXPlatformRuby::EnhancedTransaction)
+      expect(response.first.amount).to eq(enhanced_transaction_attributes[:amount])
+      expect(response.first.category).to eq(enhanced_transaction_attributes[:category])
+      expect(response.first.description).to eq(enhanced_transaction_attributes[:description])
+      expect(response.first.id).to eq(enhanced_transaction_attributes[:id])
+      expect(response.first.is_bill_pay).to eq(enhanced_transaction_attributes[:is_bill_pay])
+      expect(response.first.is_direct_deposit).to eq(enhanced_transaction_attributes[:is_direct_deposit])
+      expect(response.first.is_expense).to eq(enhanced_transaction_attributes[:is_expense])
+      expect(response.first.is_fee).to eq(enhanced_transaction_attributes[:is_fee])
+      expect(response.first.is_income).to eq(enhanced_transaction_attributes[:is_income])
+      expect(response.first.is_international).to eq(enhanced_transaction_attributes[:is_international])
+      expect(response.first.is_overdraft_fee).to eq(enhanced_transaction_attributes[:is_overdraft_fee])
+      expect(response.first.is_payroll_advance).to eq(enhanced_transaction_attributes[:is_payroll_advance])
+      expect(response.first.merchant_category_code).to eq(enhanced_transaction_attributes[:merchant_category_code])
+      expect(response.first.merchant_guid).to eq(enhanced_transaction_attributes[:merchant_guid])
+      expect(response.first.original_description).to eq(enhanced_transaction_attributes[:original_description])
+      expect(response.first.type).to eq(enhanced_transaction_attributes[:type])
+      expect(response.length).to eq(1)
+    end
+
+    it 'makes a client request with the expected params' do
+      expect(::MXPlatformRuby.client).to receive(:make_request).with(
+        {
+          endpoint: '/transactions/enhance',
+          http_method: :post,
+          request_body: {
+            transactions: [
+              {
+                amount: 21.33,
+                description: 'IN-N-OUT BURGER',
+                id: 'ID-123',
+                merchant_category_code: 123,
+                type: 'DEBIT'
+              }
+            ]
+          }
+        }
+      )
+      described_class.enhance_transactions(enhance_transactions_options)
+    end
+  end
+end

data/spec/lib/mx-platform-ruby/holding_spec.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Holding do
+  let(:holding_attributes) do
+    {
+      account_guid: 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2',
+      cost_basis: 827.0,
+      created_at: '2015-04-13T18:01:23.000Z',
+      currency_code: 'USD',
+      cusip: '18383M878',
+      daily_change: 2.5,
+      description: 'Guggenheim Defensive Equity ETF',
+      guid: 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2',
+      holding_type: 'MONEY_MARKET',
+      id: 'ID-123',
+      market_value: 989.5,
+      member_guid: 'MBR-d65683e8-9eab-26bb-bcfd-ced159c9abe',
+      metadata: 'metadata',
+      purchase_price: 26.3,
+      shares: 6.0,
+      symbol: 'DEF',
+      updated_at: '2015-04-13T18:01:23.000Z',
+      user_guid: 'USR-743e5d7f-1116-28fa-5de1-d3ba02e41d8d'
+    }
+  end
+  let(:list_holdings_by_member_options) do
+    {
+      from_date: '2015-09-20',
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      page: 1,
+      records_per_page: 10,
+      to_date: '2019-10-20',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:list_holdings_by_user_options) do
+    {
+      from_date: '2015-09-20',
+      page: 1,
+      records_per_page: 10,
+      to_date: '2019-10-20',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:read_holding_options) do
+    {
+      holding_guid: 'HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:pagination_attributes) do
+    {
+      'current_page' => 1,
+      'per_page' => 25,
+      'total_pages' => 1,
+      'total_entries' => 1
+    }
+  end
+
+  context 'list_holdings_by_member endpoints' do
+    let(:list_holdings_by_member_response) do
+      {
+        'holdings' => [holding_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_holdings_by_member_response) }
+
+    describe 'list_holdings_by_member' do
+      it 'returns a list of holdings' do
+        response = described_class.list_holdings_by_member
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Holding)
+        expect(response.first.account_guid).to eq(holding_attributes[:account_guid])
+        expect(response.first.cost_basis).to eq(holding_attributes[:cost_basis])
+        expect(response.first.created_at).to eq(holding_attributes[:created_at])
+        expect(response.first.currency_code).to eq(holding_attributes[:currency_code])
+        expect(response.first.cusip).to eq(holding_attributes[:cusip])
+        expect(response.first.daily_change).to eq(holding_attributes[:daily_change])
+        expect(response.first.description).to eq(holding_attributes[:description])
+        expect(response.first.guid).to eq(holding_attributes[:guid])
+        expect(response.first.holding_type).to eq(holding_attributes[:holding_type])
+        expect(response.first.id).to eq(holding_attributes[:id])
+        expect(response.first.market_value).to eq(holding_attributes[:market_value])
+        expect(response.first.member_guid).to eq(holding_attributes[:member_guid])
+        expect(response.first.metadata).to eq(holding_attributes[:metadata])
+        expect(response.first.purchase_price).to eq(holding_attributes[:purchase_price])
+        expect(response.first.shares).to eq(holding_attributes[:shares])
+        expect(response.first.symbol).to eq(holding_attributes[:symbol])
+        expect(response.first.updated_at).to eq(holding_attributes[:updated_at])
+        expect(response.first.user_guid).to eq(holding_attributes[:user_guid])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  context 'list_holdings_by_user endpoints' do
+    let(:list_holdings_by_user_response) do
+      {
+        'holdings' => [holding_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_holdings_by_user_response) }
+
+    describe 'list_holdings_by_user' do
+      it 'returns a list of holdings' do
+        response = described_class.list_holdings_by_user
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Holding)
+        expect(response.first.account_guid).to eq(holding_attributes[:account_guid])
+        expect(response.first.cost_basis).to eq(holding_attributes[:cost_basis])
+        expect(response.first.created_at).to eq(holding_attributes[:created_at])
+        expect(response.first.currency_code).to eq(holding_attributes[:currency_code])
+        expect(response.first.cusip).to eq(holding_attributes[:cusip])
+        expect(response.first.daily_change).to eq(holding_attributes[:daily_change])
+        expect(response.first.description).to eq(holding_attributes[:description])
+        expect(response.first.guid).to eq(holding_attributes[:guid])
+        expect(response.first.holding_type).to eq(holding_attributes[:holding_type])
+        expect(response.first.id).to eq(holding_attributes[:id])
+        expect(response.first.market_value).to eq(holding_attributes[:market_value])
+        expect(response.first.member_guid).to eq(holding_attributes[:member_guid])
+        expect(response.first.metadata).to eq(holding_attributes[:metadata])
+        expect(response.first.purchase_price).to eq(holding_attributes[:purchase_price])
+        expect(response.first.shares).to eq(holding_attributes[:shares])
+        expect(response.first.symbol).to eq(holding_attributes[:symbol])
+        expect(response.first.updated_at).to eq(holding_attributes[:updated_at])
+        expect(response.first.user_guid).to eq(holding_attributes[:user_guid])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_holding' do
+    let(:read_holding_response) { { 'holding' => holding_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_holding_response) }
+
+    it 'returns holding' do
+      response = described_class.read_holding
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Holding)
+      expect(response.account_guid).to eq(holding_attributes[:account_guid])
+      expect(response.cost_basis).to eq(holding_attributes[:cost_basis])
+      expect(response.created_at).to eq(holding_attributes[:created_at])
+      expect(response.currency_code).to eq(holding_attributes[:currency_code])
+      expect(response.cusip).to eq(holding_attributes[:cusip])
+      expect(response.daily_change).to eq(holding_attributes[:daily_change])
+      expect(response.description).to eq(holding_attributes[:description])
+      expect(response.guid).to eq(holding_attributes[:guid])
+      expect(response.holding_type).to eq(holding_attributes[:holding_type])
+      expect(response.id).to eq(holding_attributes[:id])
+      expect(response.market_value).to eq(holding_attributes[:market_value])
+      expect(response.member_guid).to eq(holding_attributes[:member_guid])
+      expect(response.metadata).to eq(holding_attributes[:metadata])
+      expect(response.purchase_price).to eq(holding_attributes[:purchase_price])
+      expect(response.shares).to eq(holding_attributes[:shares])
+      expect(response.symbol).to eq(holding_attributes[:symbol])
+      expect(response.updated_at).to eq(holding_attributes[:updated_at])
+      expect(response.user_guid).to eq(holding_attributes[:user_guid])
+    end
+
+    it 'makes a client request with the expected params' do
+      expect(::MXPlatformRuby.client).to receive(:make_request).with(
+        {
+          endpoint: '/users/USR-fa7537f3-48aa-a683-a02a-b18940482f54/holdings/HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2',
+          http_method: :get
+        }
+      )
+      described_class.read_holding(read_holding_options)
+    end
+  end
+end

data/spec/lib/mx-platform-ruby/institution_spec.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Institution do
+  let(:institution_attributes) do
+    {
+      code: 'chase',
+      medium_logo_url: 'https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png',
+      name: 'Chase Bank',
+      small_logo_url: 'https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png',
+      supports_account_identification: true,
+      supports_account_statement: true,
+      supports_account_verification: true,
+      supports_oauth: true,
+      supports_transaction_history: true,
+      url: 'https://www.chase.com'
+    }
+  end
+  let(:list_favorites_options) do
+    {
+      page: 1,
+      records_per_page: 10
+    }
+  end
+  let(:list_institutions_options) do
+    {
+      name: 'chase',
+      supports_account_identification: true,
+      supports_account_statement: true,
+      supports_account_verification: true,
+      supports_transaction_history: true
+    }
+  end
+  let(:read_institution_options) do
+    {
+      institution_code: 'chase'
+    }
+  end
+  let(:pagination_attributes) do
+    {
+      'current_page' => 1,
+      'per_page' => 25,
+      'total_pages' => 1,
+      'total_entries' => 1
+    }
+  end
+
+  context 'list_favorites endpoints' do
+    let(:list_favorites_response) do
+      {
+        'institutions' => [institution_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_favorites_response) }
+
+    describe 'list_favorites' do
+      it 'returns a list of institutions' do
+        response = described_class.list_favorites
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Institution)
+        expect(response.first.code).to eq(institution_attributes[:code])
+        expect(response.first.medium_logo_url).to eq(institution_attributes[:medium_logo_url])
+        expect(response.first.name).to eq(institution_attributes[:name])
+        expect(response.first.small_logo_url).to eq(institution_attributes[:small_logo_url])
+        expect(response.first.supports_account_identification).to eq(institution_attributes[:supports_account_identification])
+        expect(response.first.supports_account_statement).to eq(institution_attributes[:supports_account_statement])
+        expect(response.first.supports_account_verification).to eq(institution_attributes[:supports_account_verification])
+        expect(response.first.supports_oauth).to eq(institution_attributes[:supports_oauth])
+        expect(response.first.supports_transaction_history).to eq(institution_attributes[:supports_transaction_history])
+        expect(response.first.url).to eq(institution_attributes[:url])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  context 'list_institutions endpoints' do
+    let(:list_institutions_response) do
+      {
+        'institutions' => [institution_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_institutions_response) }
+
+    describe 'list_institutions' do
+      it 'returns a list of institutions' do
+        response = described_class.list_institutions
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Institution)
+        expect(response.first.code).to eq(institution_attributes[:code])
+        expect(response.first.medium_logo_url).to eq(institution_attributes[:medium_logo_url])
+        expect(response.first.name).to eq(institution_attributes[:name])
+        expect(response.first.small_logo_url).to eq(institution_attributes[:small_logo_url])
+        expect(response.first.supports_account_identification).to eq(institution_attributes[:supports_account_identification])
+        expect(response.first.supports_account_statement).to eq(institution_attributes[:supports_account_statement])
+        expect(response.first.supports_account_verification).to eq(institution_attributes[:supports_account_verification])
+        expect(response.first.supports_oauth).to eq(institution_attributes[:supports_oauth])
+        expect(response.first.supports_transaction_history).to eq(institution_attributes[:supports_transaction_history])
+        expect(response.first.url).to eq(institution_attributes[:url])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_institution' do
+    let(:read_institution_response) { { 'institution' => institution_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_institution_response) }
+
+    it 'returns institution' do
+      response = described_class.read_institution
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Institution)
+      expect(response.code).to eq(institution_attributes[:code])
+      expect(response.medium_logo_url).to eq(institution_attributes[:medium_logo_url])
+      expect(response.name).to eq(institution_attributes[:name])
+      expect(response.small_logo_url).to eq(institution_attributes[:small_logo_url])
+      expect(response.supports_account_identification).to eq(institution_attributes[:supports_account_identification])
+      expect(response.supports_account_statement).to eq(institution_attributes[:supports_account_statement])
+      expect(response.supports_account_verification).to eq(institution_attributes[:supports_account_verification])
+      expect(response.supports_oauth).to eq(institution_attributes[:supports_oauth])
+      expect(response.supports_transaction_history).to eq(institution_attributes[:supports_transaction_history])
+      expect(response.url).to eq(institution_attributes[:url])
+    end
+
+    it 'makes a client request with the expected params' do
+      expect(::MXPlatformRuby.client).to receive(:make_request).with(
+        {
+          endpoint: '/institutions/chase',
+          http_method: :get
+        }
+      )
+      described_class.read_institution(read_institution_options)
+    end
+  end
+end