mx-platform-ruby 0.1.0 → 0.1.1

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::MemberStatus do
+  let(:member_status_attributes) do
+    {
+      aggregated_at: '2016-10-13T18:07:57.000Z',
+      challenges: [
+        {
+          field_name: 'Who is this guy?',
+          guid: 'CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5',
+          image_data: 'Who is this guy?',
+          image_options: [
+            {
+              data_uri: 'data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...',
+              label: 'IMAGE_1',
+              value: 'image_data'
+            }
+          ],
+          label: 'Who is this guy?',
+          options: [
+            {
+              label: 'IMAGE_1',
+              value: 'image_data'
+            }
+          ],
+          type: 'IMAGE_DATA'
+        }
+      ],
+      connection_status: 'CONNECTED',
+      guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      has_processed_accounts: true,
+      has_processed_transactions: false,
+      is_authenticated: false,
+      is_being_aggregated: false,
+      successfully_aggregated_at: '2016-10-13T17:57:38.000Z'
+    }
+  end
+  let(:read_member_status_options) do
+    {
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+
+  describe 'read_member_status' do
+    let(:read_member_status_response) { { 'member' => member_status_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_member_status_response) }
+
+    it 'returns member_status' do
+      response = described_class.read_member_status
+
+      expect(response).to be_kind_of(::MXPlatformRuby::MemberStatus)
+      expect(response.aggregated_at).to eq(member_status_attributes[:aggregated_at])
+      expect(response.challenges).to eq(member_status_attributes[:challenges])
+      expect(response.connection_status).to eq(member_status_attributes[:connection_status])
+      expect(response.guid).to eq(member_status_attributes[:guid])
+      expect(response.has_processed_accounts).to eq(member_status_attributes[:has_processed_accounts])
+      expect(response.has_processed_transactions).to eq(member_status_attributes[:has_processed_transactions])
+      expect(response.is_authenticated).to eq(member_status_attributes[:is_authenticated])
+      expect(response.is_being_aggregated).to eq(member_status_attributes[:is_being_aggregated])
+      expect(response.successfully_aggregated_at).to eq(member_status_attributes[:successfully_aggregated_at])
+    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/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status',
+          http_method: :get
+        }
+      )
+      described_class.read_member_status(read_member_status_options)
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Merchant do
+  let(:merchant_attributes) do
+    {
+      created_at: '2017-04-20T19:30:12.000Z',
+      guid: 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b',
+      logo_url: 'https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png',
+      name: 'Comcast',
+      updated_at: '2018-09-28T21:13:53.000Z',
+      website_url: 'https://www.xfinity.com'
+    }
+  end
+  let(:list_merchants_options) do
+    {
+      page: 1,
+      records_per_page: 10
+    }
+  end
+  let(:read_merchant_options) do
+    {
+      merchant_guid: 'MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b'
+    }
+  end
+  let(:pagination_attributes) do
+    {
+      'current_page' => 1,
+      'per_page' => 25,
+      'total_pages' => 1,
+      'total_entries' => 1
+    }
+  end
+
+  context 'list_merchants endpoints' do
+    let(:list_merchants_response) do
+      {
+        'merchants' => [merchant_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_merchants_response) }
+
+    describe 'list_merchants' do
+      it 'returns a list of merchants' do
+        response = described_class.list_merchants
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Merchant)
+        expect(response.first.created_at).to eq(merchant_attributes[:created_at])
+        expect(response.first.guid).to eq(merchant_attributes[:guid])
+        expect(response.first.logo_url).to eq(merchant_attributes[:logo_url])
+        expect(response.first.name).to eq(merchant_attributes[:name])
+        expect(response.first.updated_at).to eq(merchant_attributes[:updated_at])
+        expect(response.first.website_url).to eq(merchant_attributes[:website_url])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_merchant' do
+    let(:read_merchant_response) { { 'merchant' => merchant_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_merchant_response) }
+
+    it 'returns merchant' do
+      response = described_class.read_merchant
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Merchant)
+      expect(response.created_at).to eq(merchant_attributes[:created_at])
+      expect(response.guid).to eq(merchant_attributes[:guid])
+      expect(response.logo_url).to eq(merchant_attributes[:logo_url])
+      expect(response.name).to eq(merchant_attributes[:name])
+      expect(response.updated_at).to eq(merchant_attributes[:updated_at])
+      expect(response.website_url).to eq(merchant_attributes[:website_url])
+    end
+
+    it 'makes a client request with the expected params' do
+      expect(::MXPlatformRuby.client).to receive(:make_request).with(
+        {
+          endpoint: '/merchants/MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b',
+          http_method: :get
+        }
+      )
+      described_class.read_merchant(read_merchant_options)
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::OAuthWindow do
+  let(:oauth_window_attributes) do
+    {
+      guid: 'MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f',
+      oauth_window_uri: 'int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/zgknnw5k7dmztn2njmwlgz574mZlnft6vdrv7kzn9ptj325th6c5p0w6c7j83Ap1bqg01mhsr1bqjgf2fry3ly9wff497c6fcczbyrfgj7s39cygw95Akl7vlpmcAy2kmvh1mlkytg7jA1z3vnw1w3zx2r1wt65s6f6r3ryqqrysl9qA1kr6cAj6vhr1zl325Azz6hx52j1ll3vwbvvbv5xzy7d6csplyw25brA7147vAfq29ArjjAj4qmc6r6h457hkcj2946m0kjp2xzpkz6hz55lsp3Avmdb8dsq4xzqmzzqk68s6bp5tj9jsskw4wvcb95vm4fwh9w8phgp67hfj2flrtwcy5bxbtk74?skip_aggregation=false'
+    }
+  end
+  let(:request_oauth_window_options) do
+    {
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      referral_source: 'APP',
+      ui_message_webview_url_scheme: 'mx',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+
+  describe 'request_oauth_window' do
+    let(:request_oauth_window_response) { { 'member' => oauth_window_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(request_oauth_window_response) }
+
+    it 'returns oauth_window' do
+      response = described_class.request_oauth_window
+
+      expect(response).to be_kind_of(::MXPlatformRuby::OAuthWindow)
+      expect(response.guid).to eq(oauth_window_attributes[:guid])
+      expect(response.oauth_window_uri).to eq(oauth_window_attributes[:oauth_window_uri])
+    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/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth_window_uri',
+          http_method: :get,
+          query_params: {
+            referral_source: 'APP',
+            ui_message_webview_url_scheme: 'mx'
+          }.compact
+        }
+      )
+      described_class.request_oauth_window(request_oauth_window_options)
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class Record
+  extend ::MXPlatformRuby::Pageable
+  include ::ActiveAttr::Model
+  attribute :record_attribute
+end
+
+RSpec.describe ::MXPlatformRuby::Pageable do
+  subject { ::Record }
+
+  let(:accept_header) { { 'Accept' => 'application/json' } }
+  let(:empty_response) do
+    {
+      'records' => [],
+      'pagination' => {
+        'current_page' => 1,
+        'per_page' => per_page,
+        'total_entries' => 0,
+        'total_pages' => 1
+      }
+    }
+  end
+  let(:first) { 1 }
+  let(:first_page) { ::MXPlatformRuby::Page.new(2, record) }
+  let(:first_page_response) do
+    {
+      'records' => ::Array.new(2, record_response),
+      'pagination' => {
+        'current_page' => first,
+        'per_page' => per_page,
+        'total_entries' => total_entries,
+        'total_pages' => total_pages
+      }
+    }
+  end
+  let(:options) do
+    {
+      accept_header: 'application/json',
+      endpoint: '/records',
+      resource: 'records'
+    }
+  end
+  let(:record) { ::Record.new('record_attribute' => 'record_value') }
+  let(:record_response) { { 'record_attribute' => 'record_value' } }
+  let(:per_page) { 2 }
+  let(:total_entries) { 3 }
+  let(:total_pages) { 2 }
+
+  before do
+    allow(::MXPlatformRuby.client).to receive(:make_request).with({ accept_header: 'application/json', endpoint: '/records', resource: 'records' })
+                                                            .and_return(first_page_response)
+  end
+
+  describe '.paginate' do
+    it 'returns the first Page' do
+      page = subject.paginate(options)
+      expect(page).to eq(first_page)
+      expect(page.current_page).to eq(first)
+      expect(page.per_page).to eq(per_page)
+      expect(page.total_entries).to eq(total_entries)
+      expect(page.total_pages).to eq(total_pages)
+    end
+
+    context 'with no results' do
+      it 'returns an empty Page' do
+        allow(::MXPlatformRuby.client).to receive(:make_request).and_return(empty_response)
+        page = subject.paginate(options)
+        expect(page).to eq(::MXPlatformRuby::Page.new)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Statement do
+  let(:statement_attributes) do
+    {
+      account_guid: 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1',
+      content_hash: 'ca53785b812d00ef821c3d94bfd6e5bbc0020504410589b7ea8552169f021981',
+      created_at: '2016-10-13T18:08:00+00:00',
+      guid: 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1',
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      updated_at: '2016-10-13T18:09:00+00:00',
+      uri: 'uri/to/statement',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:download_statement_pdf_options) do
+    {
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      statement_guid: 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:list_statements_by_member_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(:read_statement_by_member_options) do
+    {
+      member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      statement_guid: 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1',
+      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
+
+  describe 'download_statement_pdf' do
+    let(:statement_file) { ::Tempfile.new('spec/sample.pdf') }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(statement_file) }
+
+    it 'returns statement file' do
+      response = described_class.download_statement_pdf
+
+      expect(response).to be(statement_file)
+    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/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/statements/STA-737a344b-caae-0f6e-1384-01f52e75dcb1.pdf',
+          headers: {
+            'Accept': 'application/vnd.mx.api.v1+pdf'
+          },
+          http_method: :get
+        }
+      )
+      described_class.download_statement_pdf(download_statement_pdf_options)
+    end
+  end
+
+  context 'list_statements_by_member endpoints' do
+    let(:list_statements_by_member_response) do
+      {
+        'statements' => [statement_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_statements_by_member_response) }
+
+    describe 'list_statements_by_member' do
+      it 'returns a list of statements' do
+        response = described_class.list_statements_by_member
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Statement)
+        expect(response.first.account_guid).to eq(statement_attributes[:account_guid])
+        expect(response.first.content_hash).to eq(statement_attributes[:content_hash])
+        expect(response.first.created_at).to eq(statement_attributes[:created_at])
+        expect(response.first.guid).to eq(statement_attributes[:guid])
+        expect(response.first.member_guid).to eq(statement_attributes[:member_guid])
+        expect(response.first.updated_at).to eq(statement_attributes[:updated_at])
+        expect(response.first.uri).to eq(statement_attributes[:uri])
+        expect(response.first.user_guid).to eq(statement_attributes[:user_guid])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_statement_by_member' do
+    let(:read_statement_by_member_response) { { 'statement' => statement_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_statement_by_member_response) }
+
+    it 'returns statement' do
+      response = described_class.read_statement_by_member
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Statement)
+      expect(response.account_guid).to eq(statement_attributes[:account_guid])
+      expect(response.content_hash).to eq(statement_attributes[:content_hash])
+      expect(response.created_at).to eq(statement_attributes[:created_at])
+      expect(response.guid).to eq(statement_attributes[:guid])
+      expect(response.member_guid).to eq(statement_attributes[:member_guid])
+      expect(response.updated_at).to eq(statement_attributes[:updated_at])
+      expect(response.uri).to eq(statement_attributes[:uri])
+      expect(response.user_guid).to eq(statement_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/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/statements/STA-737a344b-caae-0f6e-1384-01f52e75dcb1',
+          http_method: :get
+        }
+      )
+      described_class.read_statement_by_member(read_statement_by_member_options)
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Tag do
+  let(:tag_attributes) do
+    {
+      guid: 'TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+      name: 'MY TAG',
+      user_guid: 'USR-11141024-90b3-1bce-cac9-c06ced52ab4c'
+    }
+  end
+  let(:create_tag_options) do
+    {
+      name: 'MY TAG',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:delete_tag_options) do
+    {
+      tag_guid: 'TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:list_tags_options) do
+    {
+      page: 1,
+      records_per_page: 10,
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:read_tag_options) do
+    {
+      tag_guid: 'TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:update_tag_options) do
+    {
+      name: 'MY TAG',
+      tag_guid: 'TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+      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
+
+  describe 'create_tag' do
+    let(:create_tag_response) { { 'tag' => tag_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(create_tag_response) }
+
+    it 'returns tag' do
+      response = described_class.create_tag
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Tag)
+      expect(response.guid).to eq(tag_attributes[:guid])
+      expect(response.name).to eq(tag_attributes[:name])
+      expect(response.user_guid).to eq(tag_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/tags',
+          http_method: :post,
+          request_body: {
+            tag: {
+              name: 'MY TAG'
+            }
+          }
+        }
+      )
+      described_class.create_tag(create_tag_options)
+    end
+  end
+
+  describe 'delete_tag' do
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(nil) }
+
+    it 'returns nil' do
+      response = described_class.delete_tag
+
+      expect(response).to be(nil)
+    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/tags/TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+          http_method: :delete
+        }
+      )
+      described_class.delete_tag(delete_tag_options)
+    end
+  end
+
+  context 'list_tags endpoints' do
+    let(:list_tags_response) do
+      {
+        'tags' => [tag_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_tags_response) }
+
+    describe 'list_tags' do
+      it 'returns a list of tags' do
+        response = described_class.list_tags
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Tag)
+        expect(response.first.guid).to eq(tag_attributes[:guid])
+        expect(response.first.name).to eq(tag_attributes[:name])
+        expect(response.first.user_guid).to eq(tag_attributes[:user_guid])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_tag' do
+    let(:read_tag_response) { { 'tag' => tag_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_tag_response) }
+
+    it 'returns tag' do
+      response = described_class.read_tag
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Tag)
+      expect(response.guid).to eq(tag_attributes[:guid])
+      expect(response.name).to eq(tag_attributes[:name])
+      expect(response.user_guid).to eq(tag_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/tags/TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+          http_method: :get
+        }
+      )
+      described_class.read_tag(read_tag_options)
+    end
+  end
+
+  describe 'update_tag' do
+    let(:update_tag_response) { { 'tag' => tag_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(update_tag_response) }
+
+    it 'returns tag' do
+      response = described_class.update_tag
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Tag)
+      expect(response.guid).to eq(tag_attributes[:guid])
+      expect(response.name).to eq(tag_attributes[:name])
+      expect(response.user_guid).to eq(tag_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/tags/TAG-aef36e72-6294-4c38-844d-e573e80aed52',
+          http_method: :put,
+          request_body: {
+            tag: {
+              name: 'MY TAG'
+            }
+          }
+        }
+      )
+      described_class.update_tag(update_tag_options)
+    end
+  end
+end