mx-platform-ruby 0.1.0 → 0.1.1

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

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::User do
+  let(:user_attributes) do
+    {
+      email: 'email@provider.com',
+      guid: 'USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6',
+      id: 'My-Unique-ID',
+      is_disabled: false,
+      metadata: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
+    }
+  end
+  let(:create_user_options) do
+    {
+      email: 'email@provider.com',
+      id: 'My-Unique-ID',
+      is_disabled: false,
+      metadata: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
+    }
+  end
+  let(:delete_user_options) do
+    {
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:list_users_options) do
+    {
+      page: 1,
+      records_per_page: 10
+    }
+  end
+  let(:read_user_options) do
+    {
+      user_guid: 'USR-fa7537f3-48aa-a683-a02a-b18940482f54'
+    }
+  end
+  let(:update_user_options) do
+    {
+      email: 'email@provider.com',
+      id: 'My-Unique-ID',
+      is_disabled: false,
+      metadata: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}',
+      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_user' do
+    let(:create_user_response) { { 'user' => user_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(create_user_response) }
+
+    it 'returns user' do
+      response = described_class.create_user
+
+      expect(response).to be_kind_of(::MXPlatformRuby::User)
+      expect(response.email).to eq(user_attributes[:email])
+      expect(response.guid).to eq(user_attributes[:guid])
+      expect(response.id).to eq(user_attributes[:id])
+      expect(response.is_disabled).to eq(user_attributes[:is_disabled])
+      expect(response.metadata).to eq(user_attributes[:metadata])
+    end
+
+    it 'makes a client request with the expected params' do
+      expect(::MXPlatformRuby.client).to receive(:make_request).with(
+        {
+          endpoint: '/users',
+          http_method: :post,
+          request_body: {
+            user: {
+              email: 'email@provider.com',
+              id: 'My-Unique-ID',
+              is_disabled: false,
+              metadata: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
+            }
+          }
+        }
+      )
+      described_class.create_user(create_user_options)
+    end
+  end
+
+  describe 'delete_user' do
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(nil) }
+
+    it 'returns nil' do
+      response = described_class.delete_user
+
+      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',
+          http_method: :delete
+        }
+      )
+      described_class.delete_user(delete_user_options)
+    end
+  end
+
+  context 'list_users endpoints' do
+    let(:list_users_response) do
+      {
+        'users' => [user_attributes],
+        'pagination' => pagination_attributes
+      }
+    end
+
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(list_users_response) }
+
+    describe 'list_users' do
+      it 'returns a list of users' do
+        response = described_class.list_users
+
+        expect(response).to be_kind_of(::MXPlatformRuby::Page)
+        expect(response.first).to be_kind_of(::MXPlatformRuby::User)
+        expect(response.first.email).to eq(user_attributes[:email])
+        expect(response.first.guid).to eq(user_attributes[:guid])
+        expect(response.first.id).to eq(user_attributes[:id])
+        expect(response.first.is_disabled).to eq(user_attributes[:is_disabled])
+        expect(response.first.metadata).to eq(user_attributes[:metadata])
+        expect(response.length).to eq(1)
+      end
+    end
+  end
+
+  describe 'read_user' do
+    let(:read_user_response) { { 'user' => user_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(read_user_response) }
+
+    it 'returns user' do
+      response = described_class.read_user
+
+      expect(response).to be_kind_of(::MXPlatformRuby::User)
+      expect(response.email).to eq(user_attributes[:email])
+      expect(response.guid).to eq(user_attributes[:guid])
+      expect(response.id).to eq(user_attributes[:id])
+      expect(response.is_disabled).to eq(user_attributes[:is_disabled])
+      expect(response.metadata).to eq(user_attributes[:metadata])
+    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',
+          http_method: :get
+        }
+      )
+      described_class.read_user(read_user_options)
+    end
+  end
+
+  describe 'update_user' do
+    let(:update_user_response) { { 'user' => user_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(update_user_response) }
+
+    it 'returns user' do
+      response = described_class.update_user
+
+      expect(response).to be_kind_of(::MXPlatformRuby::User)
+      expect(response.email).to eq(user_attributes[:email])
+      expect(response.guid).to eq(user_attributes[:guid])
+      expect(response.id).to eq(user_attributes[:id])
+      expect(response.is_disabled).to eq(user_attributes[:is_disabled])
+      expect(response.metadata).to eq(user_attributes[:metadata])
+    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',
+          http_method: :put,
+          request_body: {
+            user: {
+              email: 'email@provider.com',
+              id: 'My-Unique-ID',
+              is_disabled: false,
+              metadata: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
+            }
+          }
+        }
+      )
+      described_class.update_user(update_user_options)
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby::Widget do
+  let(:widget_attributes) do
+    {
+      type: 'connect_widget',
+      url: 'https://int-widgets.moneydesktop.com/md/connect/yxcdk7f1nb99jwApp34lA24m0AZ8rzprgmw17gm8z8h2AzjyAnd1rj42qfv42r3xnn07Amfwlg3j09hwp8bkq8tc5z21j33xjggmp2qtlpkz2v4gywfhfn31l44tx2w91bfc2thc58j4syqp0hgxcyvA4g7754hk7gjc56kt7tc36s45mmkdz2jqqqydspytmtr3dAb9jh6fkb24f3zkfpdjj0v77f0vmrtzvzxkmxz7dklsq8gd0gstkbhlw5bgpgc3m9mAtpAcr2w15gwy5xc4blgxppl42Avnm63291z3cyp0wm3lqgmvgzdAddct423gAdqxdlfx5d4mvc0ck2gt7ktqgks4vxq1pAy5',
+      user_id: 'U-jeff-201709221210'
+    }
+  end
+  let(:request_widget_url_options) do
+    {
+      accept_language: 'en-US',
+      color_scheme: 'light',
+      current_institution_code: 'chase',
+      current_institution_guid: 'INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9',
+      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,
+      widget_type: 'connect_widget'
+    }
+  end
+
+  describe 'request_widget_url' do
+    let(:request_widget_url_response) { { 'widget_url' => widget_attributes } }
+    before { allow(::MXPlatformRuby.client).to receive(:make_request).and_return(request_widget_url_response) }
+
+    it 'returns widget' do
+      response = described_class.request_widget_url
+
+      expect(response).to be_kind_of(::MXPlatformRuby::Widget)
+      expect(response.type).to eq(widget_attributes[:type])
+      expect(response.url).to eq(widget_attributes[:url])
+      expect(response.user_id).to eq(widget_attributes[:user_id])
+    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/widget_urls',
+          headers: {
+            'Accept-Language': 'en-US'
+          },
+          http_method: :post,
+          request_body: {
+            widget_url: {
+              color_scheme: 'light',
+              current_institution_code: 'chase',
+              current_institution_guid: 'INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9',
+              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,
+              widget_type: 'connect_widget'
+            }
+          }
+        }
+      )
+      described_class.request_widget_url(request_widget_url_options)
+    end
+  end
+end

data/spec/lib/mx-platform-ruby_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::MXPlatformRuby do
+  it 'has a client' do
+    expect(described_class).to respond_to(:client)
+  end
+
+  describe '.configure' do
+    it 'yields a ::MXPlatformRuby::Client' do
+      expect { |block| described_class.configure(&block) }.to yield_with_args(::MXPlatformRuby::Client)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'pry'
+
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'mx-platform-ruby'
+
+RSpec.configure do |config|
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.allow_message_expectations_on_nil = true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mx-platform-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - MX
@@ -124,11 +124,71 @@ dependencies:
         version: '0'
 description: A Ruby library for the MX Platform API.
 email:
-- dev@mx.com
+- devexperience@mx.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mx-platform-ruby.rb
+- lib/mx-platform-ruby/account.rb
+- lib/mx-platform-ruby/account_number.rb
+- lib/mx-platform-ruby/account_owner.rb
+- lib/mx-platform-ruby/category.rb
+- lib/mx-platform-ruby/challenge.rb
+- lib/mx-platform-ruby/client.rb
+- lib/mx-platform-ruby/connect_widget.rb
+- lib/mx-platform-ruby/credential.rb
+- lib/mx-platform-ruby/enhanced_transaction.rb
+- lib/mx-platform-ruby/error.rb
+- lib/mx-platform-ruby/holding.rb
+- lib/mx-platform-ruby/institution.rb
+- lib/mx-platform-ruby/member.rb
+- lib/mx-platform-ruby/member_status.rb
+- lib/mx-platform-ruby/merchant.rb
+- lib/mx-platform-ruby/oauth_window.rb
+- lib/mx-platform-ruby/pageable.rb
+- lib/mx-platform-ruby/statement.rb
+- lib/mx-platform-ruby/tag.rb
+- lib/mx-platform-ruby/tagging.rb
+- lib/mx-platform-ruby/transaction.rb
+- lib/mx-platform-ruby/transaction_rule.rb
+- lib/mx-platform-ruby/user.rb
+- lib/mx-platform-ruby/version.rb
+- lib/mx-platform-ruby/widget.rb
+- mx-platform-ruby.gemspec
+- spec/lib/mx-platform-ruby/account_number_spec.rb
+- spec/lib/mx-platform-ruby/account_owner_spec.rb
+- spec/lib/mx-platform-ruby/account_spec.rb
+- spec/lib/mx-platform-ruby/category_spec.rb
+- spec/lib/mx-platform-ruby/challenge_spec.rb
+- spec/lib/mx-platform-ruby/client_spec.rb
+- spec/lib/mx-platform-ruby/connect_widget_spec.rb
+- spec/lib/mx-platform-ruby/credential_spec.rb
+- spec/lib/mx-platform-ruby/enhanced_transaction_spec.rb
+- spec/lib/mx-platform-ruby/holding_spec.rb
+- spec/lib/mx-platform-ruby/institution_spec.rb
+- spec/lib/mx-platform-ruby/member_spec.rb
+- spec/lib/mx-platform-ruby/member_status_spec.rb
+- spec/lib/mx-platform-ruby/merchant_spec.rb
+- spec/lib/mx-platform-ruby/oauth_window_spec.rb
+- spec/lib/mx-platform-ruby/pageable_spec.rb
+- spec/lib/mx-platform-ruby/statement_spec.rb
+- spec/lib/mx-platform-ruby/tag_spec.rb
+- spec/lib/mx-platform-ruby/tagging_spec.rb
+- spec/lib/mx-platform-ruby/transaction_rule_spec.rb
+- spec/lib/mx-platform-ruby/transaction_spec.rb
+- spec/lib/mx-platform-ruby/user_spec.rb
+- spec/lib/mx-platform-ruby/widget_spec.rb
+- spec/lib/mx-platform-ruby_spec.rb
+- spec/sample.pdf
+- spec/spec_helper.rb
 homepage: https://www.mx.com/products/platform-api
 licenses:
 - MIT