mx-platform-ruby 0.1.0 → 0.1.1

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

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Category do
+  let(:category_attributes) do
+    {
+      created_at: '2015-04-13T18:01:23.000Z',
+      guid: 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+      is_default: true,
+      is_income: false,
+      metadata: 'some metadata',
+      name: 'Auto Insurance',
+      parent_guid: 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+      updated_at: '2015-05-13T18:01:23.000Z'
+    }
+  end
+  let(:create_category_options) do
+    {
+      metadata: 'some metadata',
+      name: 'Online Shopping',
+      parent_guid: 'CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:delete_category_options) do
+    {
+      category_guid: 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:list_categories_options) do
+    {
+      page: 1,
+      records_per_page: 10,
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:list_default_categories_options) do
+    {
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:read_category_options) do
+    {
+      category_guid: 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:update_category_options) do
+    {
+      category_guid: 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+      metadata: 'some metadata',
+      name: 'Web shopping',
+      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_category' do
+    let(:create_category_response) { { 'category' => category_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(create_category_response) }
+
+    it 'returns category' do
+      response = described_class.create_category
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Category)
+      expect(response.created_at).to eq(category_attributes[:created_at])
+      expect(response.guid).to eq(category_attributes[:guid])
+      expect(response.is_default).to eq(category_attributes[:is_default])
+      expect(response.is_income).to eq(category_attributes[:is_income])
+      expect(response.metadata).to eq(category_attributes[:metadata])
+      expect(response.name).to eq(category_attributes[:name])
+      expect(response.parent_guid).to eq(category_attributes[:parent_guid])
+      expect(response.updated_at).to eq(category_attributes[:updated_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/categories',
+          http_method: :post,
+          request_body: {
+            category: {
+              metadata: 'some metadata',
+              name: 'Online Shopping',
+              parent_guid: 'CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f'
+            }
+          }
+        }
+      )
+      described_class.create_category(create_category_options)
+    end
+  end
+
+  describe 'delete_category' do
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(nil) }
+
+    it 'returns nil' do
+      response = described_class.delete_category
+
+      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/categories/CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+          http_method: :delete
+        }
+      )
+      described_class.delete_category(delete_category_options)
+    end
+  end
+
+  context 'list_categories endpoints' do
+    let(:list_categories_response) do
+      {
+        'categories' => [category_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_categories_response) }
+
+    describe 'list_categories' do
+      it 'returns a list of categorys' do
+        response = described_class.list_categories
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Category)
+        expect(response.first.created_at).to eq(category_attributes[:created_at])
+        expect(response.first.guid).to eq(category_attributes[:guid])
+        expect(response.first.is_default).to eq(category_attributes[:is_default])
+        expect(response.first.is_income).to eq(category_attributes[:is_income])
+        expect(response.first.metadata).to eq(category_attributes[:metadata])
+        expect(response.first.name).to eq(category_attributes[:name])
+        expect(response.first.parent_guid).to eq(category_attributes[:parent_guid])
+        expect(response.first.updated_at).to eq(category_attributes[:updated_at])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  context 'list_default_categories endpoints' do
+    let(:list_default_categories_response) do
+      {
+        'categories' => [category_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_default_categories_response) }
+
+    describe 'list_default_categories' do
+      it 'returns a list of categorys' do
+        response = described_class.list_default_categories
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Category)
+        expect(response.first.created_at).to eq(category_attributes[:created_at])
+        expect(response.first.guid).to eq(category_attributes[:guid])
+        expect(response.first.is_default).to eq(category_attributes[:is_default])
+        expect(response.first.is_income).to eq(category_attributes[:is_income])
+        expect(response.first.metadata).to eq(category_attributes[:metadata])
+        expect(response.first.name).to eq(category_attributes[:name])
+        expect(response.first.parent_guid).to eq(category_attributes[:parent_guid])
+        expect(response.first.updated_at).to eq(category_attributes[:updated_at])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_category' do
+    let(:read_category_response) { { 'category' => category_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_category_response) }
+
+    it 'returns category' do
+      response = described_class.read_category
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Category)
+      expect(response.created_at).to eq(category_attributes[:created_at])
+      expect(response.guid).to eq(category_attributes[:guid])
+      expect(response.is_default).to eq(category_attributes[:is_default])
+      expect(response.is_income).to eq(category_attributes[:is_income])
+      expect(response.metadata).to eq(category_attributes[:metadata])
+      expect(response.name).to eq(category_attributes[:name])
+      expect(response.parent_guid).to eq(category_attributes[:parent_guid])
+      expect(response.updated_at).to eq(category_attributes[:updated_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/categories/CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+          http_method: :get
+        }
+      )
+      described_class.read_category(read_category_options)
+    end
+  end
+
+  describe 'update_category' do
+    let(:update_category_response) { { 'category' => category_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(update_category_response) }
+
+    it 'returns category' do
+      response = described_class.update_category
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Category)
+      expect(response.created_at).to eq(category_attributes[:created_at])
+      expect(response.guid).to eq(category_attributes[:guid])
+      expect(response.is_default).to eq(category_attributes[:is_default])
+      expect(response.is_income).to eq(category_attributes[:is_income])
+      expect(response.metadata).to eq(category_attributes[:metadata])
+      expect(response.name).to eq(category_attributes[:name])
+      expect(response.parent_guid).to eq(category_attributes[:parent_guid])
+      expect(response.updated_at).to eq(category_attributes[:updated_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/categories/CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874',
+          http_method: :put,
+          request_body: {
+            category: {
+              metadata: 'some metadata',
+              name: 'Web shopping'
+            }
+          }
+        }
+      )
+      described_class.update_category(update_category_options)
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Challenge do
+  let(:challenge_attributes) do
+    {
+      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'
+    }
+  end
+  let(:list_member_challenges_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_member_challenges endpoints' do
+    let(:list_member_challenges_response) do
+      {
+        'challenges' => [challenge_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_member_challenges_response) }
+
+    describe 'list_member_challenges' do
+      it 'returns a list of challenges' do
+        response = described_class.list_member_challenges
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::Challenge)
+        expect(response.first.field_name).to eq(challenge_attributes[:field_name])
+        expect(response.first.guid).to eq(challenge_attributes[:guid])
+        expect(response.first.image_data).to eq(challenge_attributes[:image_data])
+        expect(response.first.image_options).to eq(challenge_attributes[:image_options])
+        expect(response.first.label).to eq(challenge_attributes[:label])
+        expect(response.first.options).to eq(challenge_attributes[:options])
+        expect(response.first.type).to eq(challenge_attributes[:type])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Client do
+  let(:client_custom_params) { described_class.new('base_url', 'password', 'username') }
+  let(:client_default_params) { described_class.new }
+  let(:error_response) { ::OpenStruct.new('status' => 500, 'body' => 'error_message') }
+  let(:file_response) { ::OpenStruct.new('status' => 200, 'body' => sample_pdf_binary) }
+  let(:ok_response) { ::OpenStruct.new('status' => 200, 'body' => '{ "key": "value" }') }
+  let(:sample_pdf) { ::File.open('spec/sample.pdf') }
+  let(:sample_pdf_binary) { ::IO.binread(sample_pdf) }
+
+  describe '#http_client' do
+    it 'returns a HTTPClient' do
+      expect(client_custom_params.http_client).to be_a(::HTTPClient)
+    end
+  end
+
+  describe '#initialize' do
+    context 'with default params' do
+      it 'sets password to param default' do
+        expect(client_default_params.password).to eq(nil)
+      end
+
+      it 'sets username to param default' do
+        expect(client_default_params.username).to eq(nil)
+      end
+
+      it 'sets base_url to param default' do
+        expect(client_default_params.base_url).to eq('https://int-api.mx.com')
+      end
+    end
+
+    context 'with params' do
+      it 'sets password to param' do
+        expect(client_custom_params.password).to eq('password')
+      end
+
+      it 'sets username to param' do
+        expect(client_custom_params.username).to eq('username')
+      end
+
+      it 'sets base_url to param' do
+        expect(client_custom_params.base_url).to eq('base_url')
+      end
+    end
+  end
+
+  describe '#make_request' do
+    before do
+      allow(client_custom_params.http_client).to receive(:get).and_return(ok_response)
+    end
+
+    it 'builds the request url' do
+      expect(client_custom_params.http_client).to receive(:get).with('base_url/endpoint', any_args)
+      client_custom_params.make_request({ http_method: :get, endpoint: '/endpoint' })
+    end
+
+    it 'sends authentication headers' do
+      expect(client_custom_params.http_client).to receive(:get).with(
+        anything,
+        anything,
+        hash_including(Authorization: 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
+      )
+      client_custom_params.make_request({ http_method: :get, endpoint: '/endpoint' })
+    end
+
+    it 'sends the body as json' do
+      expect(client_custom_params.http_client).to receive(:get).with(anything, '{"key":"value"}', any_args)
+      client_custom_params.make_request({ http_method: :get, endpoint: '/endpoint', request_body: { key: :value } })
+    end
+
+    context 'when the response is json' do
+      it 'parses the json response' do
+        allow(client_custom_params.http_client).to receive(:get).and_return(ok_response)
+        parsed_response = client_custom_params.make_request({ http_method: :get, endpoint: '/endpoint', request_body: { key: :value } })
+        expect(parsed_response['key']).to eq('value')
+      end
+    end
+
+    context 'when the response is not json' do
+      it 'formats the response as a ::TempFile' do
+        allow(client_custom_params.http_client).to receive(:get).and_return(file_response)
+        temp_file = client_custom_params.make_request({ http_method: :get, endpoint: '/endpoint', request_body: { key: :value } })
+
+        expect(temp_file).to be_kind_of(::Tempfile)
+        expect(::IO.read(temp_file)).to eq(::IO.read(sample_pdf))
+      end
+    end
+
+    context 'with error' do
+      it 'raises a ::MXPlatformRuby::Error' do
+        allow(client_custom_params.http_client).to receive(:get).and_return(error_response)
+        expect { client_custom_params.make_request({ http_method: :get, endpoint: '/endpoint', request_body: { key: :value } }) }.to raise_error(
+          ::MXPlatformRuby::Error
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::ConnectWidget do
+  let(:connect_widget_attributes) do
+    {
+      connect_widget_url: 'https://int-widgets.moneydesktop.com/md/connect/jb1rA14m85tw2lyvpgfx4gc6d3Z8z8Ayb8',
+      guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:request_connect_widget_url_options) do
+    {
+      color_scheme: 'light',
+      current_institution_code: 'chase',
+      current_member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+      disable_institution_search: false,
+      include_transactions: true,
+      is_mobile_webview: true,
+      mode: 'aggregation',
+      ui_message_version: 4,
+      ui_message_webview_url_scheme: 'mx',
+      update_credentials: false,
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54',
+      wait_for_full_aggregation: false
+    }
+  end
+
+  describe 'request_connect_widget_url' do
+    let(:request_connect_widget_url_response) { { 'user' => connect_widget_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(request_connect_widget_url_response) }
+
+    it 'returns connect_widget' do
+      response = described_class.request_connect_widget_url
+
+      expect(response).to be_kind_of(::MXPlatformRuby::ConnectWidget)
+      expect(response.connect_widget_url).to eq(connect_widget_attributes[:connect_widget_url])
+      expect(response.guid).to eq(connect_widget_attributes[: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/connect_widget_url',
+          http_method: :post,
+          request_body: {
+            config: {
+              color_scheme: 'light',
+              current_institution_code: 'chase',
+              current_member_guid: 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b',
+              disable_institution_search: false,
+              include_transactions: true,
+              is_mobile_webview: true,
+              mode: 'aggregation',
+              ui_message_version: 4,
+              ui_message_webview_url_scheme: 'mx',
+              update_credentials: false,
+              wait_for_full_aggregation: false
+            }
+          }
+        }
+      )
+      described_class.request_connect_widget_url(request_connect_widget_url_options)
+    end
+  end
+end