mx-platform-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3acaf995ec3a1e178a0971383e20d718ed30b92fe4f9ac4a4dd188e7f3e7b744
-  data.tar.gz: 12aa93dd4985d7928cc04d1ba1272005cb425c46f45d1e5b79ae9e29fab6f2a6
+  metadata.gz: 9c37bb296e94c8e9931a9446fb80593f48d9e7b87ac3fb71d1d29cebb58c8723
+  data.tar.gz: 5d60ba2b693ffeecdd49348c0a0a444f1e202367a263f4385f3a61ab1e34fafd
 SHA512:
-  metadata.gz: ba9bc8ffd71e4e04f5748a155b16f686816a40e82455173a6c57b49d8d06f7ba48ab96ca7bf80b93406ac7157d2024987547428f4ac2af693a40b7588c53c28e
-  data.tar.gz: 31e8b3fc197cc6e4f3bd6dd97b8f54113093bdcfee7331eade8172c00dadf56bfba41c5a365442751d22a0bb6709a51e3790a60977bae4842330bd1960015017
+  metadata.gz: 9a245730b4ba64a0a5bc1d21a25b1834ed18951371fb4bcef008e5a8c84a5f78351b82f4ceab2cff914249d5cf4ed1e80f4ff06e36dcacecfc706b490cb818ff
+  data.tar.gz: ec13d47c295fff12ec888c527f3e4dfc81a401bb10c0169fb31bcdfd826b2f18d7d8091d40cd0fbefbe348dda13047b98e055ee4f3c153f89c4c2e270a86338e

data/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Test
+
+on: [push]
+
+jobs:
+  Test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run RuboCop and RSpec
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+*.swp
+.bundle
+.config
+.DS_Store
+.idea
+.ruby-*
+.rvmrc
+.yardoc
+coverage
+Gemfile.lock
+pkg/*
+tmp

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+  NewCops: disable # Disabling pending cops
+  SuggestExtensions: false # Disabling extension suggestions
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Description: Checks the length of lines in the source code
+  Exclude:
+    - 'spec/lib/**/*.rb' # Excluding to avoid multiline expect statements
+  IgnoredPatterns: ['^        endpoint: ".*'] # Excluding since the endpoints may require longer lines
+  Max: 120
+
+Metrics/AbcSize:
+  Description: Checks that the ABC size of methods is not higher than the configured maximum
+  Exclude:
+    - 'lib/mx-platform-ruby/pageable.rb' # Disabling because clarity > brevity
+
+Metrics/BlockLength:
+  Description: Checks if the length of a block exceeds some maximum value
+  Exclude:
+    - 'spec/**/*' # Excluding to allow rspec tests to grow with number of attributes
+
+Metrics/ClassLength:
+  Description: Checks if the length a class exceeds some maximum value
+  Enabled: false # Disabling because clarity > brevity
+
+Metrics/MethodLength:
+  Description: Checks if the length a method exceeds some maximum value
+  Enabled: false # Disabling to allow class methods to grow with number of attributes
+
+Naming/FileName:
+  Description: Checks that Ruby source files have snake_case names
+  Exclude:
+    - 'spec/lib/mx-platform-ruby_spec.rb' # Excluding since gems may have `-` in their name
+    - 'lib/mx-platform-ruby.rb' # Excluding since gems may have `-` in their name
+
+Style/Documentation:
+  Description: Checks for missing top-level documentation of classes and modules
+  Enabled: false # Disabling because Rails models should be self-explanatory
+
+Style/SignalException:
+  Description: Checks for uses of fail and raise
+  Exclude:
+    - 'lib/mx-platform-ruby/pageable.rb' # Allow fail if block isn't provided

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 MX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform API Ruby Library.*
+
+# MX Platform API Ruby Library
+#### Version 0.1.1
+
+A Ruby library for the [MX Platform API](https://www.mx.com/products/platform-api).
+
+## Documentation
+
+See the [MX Platform API docs](https://docs.mx.com/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mx-platform-ruby'
+```
+
+And then execute:
+```shell
+$ bundle
+```
+Or install it yourself with:
+```shell
+$ gem install mx-platform-ruby
+```
+
+## Configuration
+
+In order to make API requests, you will need to [sign up for the MX Platform API](https://dashboard.mx.com/sign_up) and get a `Client ID` and `API Key`.
+```ruby
+::MXPlatformRuby.configure do |config|
+  config.username = 'Client ID'
+  config.password = 'API Key'
+  config.base_url = 'https://int-api.mx.com' # in production, use 'https://api.mx.com'
+end
+```
+
+## Paginated endpoints
+
+For paginated endpoints, the pagination values can be accessed through the returned `::MXPlatformRuby::Page` array as follows
+
+```ruby
+institutions = ::MXPlatformRuby::Institution.list_institutions(options)
+
+puts "Current page: #{institutions.current_page}"
+puts "Per page: #{institutions.per_page}"
+puts "Total entries: #{institutions.total_entries}"
+puts "Total pages: #{institutions.total_pages}"
+
+institutions.each do |institution|
+  p institution
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/mxenabled/mx-platform-ruby).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+::RSpec::Core::RakeTask.new(:spec)
+::RuboCop::RakeTask.new(:rubocop)
+
+desc 'Run RuboCop and RSpec'
+task default: %i[rubocop spec]

data/lib/mx-platform-ruby.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_attr'
+require 'base64'
+require 'httpclient'
+require 'json'
+
+require 'mx-platform-ruby/client'
+require 'mx-platform-ruby/error'
+require 'mx-platform-ruby/pageable'
+require 'mx-platform-ruby/version'
+
+require 'mx-platform-ruby/account'
+require 'mx-platform-ruby/account_number'
+require 'mx-platform-ruby/account_owner'
+require 'mx-platform-ruby/category'
+require 'mx-platform-ruby/challenge'
+require 'mx-platform-ruby/connect_widget'
+require 'mx-platform-ruby/credential'
+require 'mx-platform-ruby/enhanced_transaction'
+require 'mx-platform-ruby/holding'
+require 'mx-platform-ruby/institution'
+require 'mx-platform-ruby/member'
+require 'mx-platform-ruby/member_status'
+require 'mx-platform-ruby/merchant'
+require 'mx-platform-ruby/oauth_window'
+require 'mx-platform-ruby/statement'
+require 'mx-platform-ruby/tag'
+require 'mx-platform-ruby/tagging'
+require 'mx-platform-ruby/transaction'
+require 'mx-platform-ruby/transaction_rule'
+require 'mx-platform-ruby/user'
+require 'mx-platform-ruby/widget'
+
+module MXPlatformRuby
+  class << self
+    attr_reader :client
+
+    def configure
+      @client = ::MXPlatformRuby::Client.new
+      yield @client
+    end
+  end
+end

data/lib/mx-platform-ruby/account.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class Account
+    extend ::MXPlatformRuby::Pageable
+    include ::ActiveAttr::Model
+
+    attribute :account_number
+    attribute :apr
+    attribute :apy
+    attribute :available_balance
+    attribute :available_credit
+    attribute :balance
+    attribute :cash_balance
+    attribute :cash_surrender_value
+    attribute :created_at
+    attribute :credit_limit
+    attribute :currency_code
+    attribute :day_payment_is_due
+    attribute :death_benefit
+    attribute :guid
+    attribute :holdings_value
+    attribute :id
+    attribute :institution_code
+    attribute :insured_name
+    attribute :interest_rate
+    attribute :is_closed
+    attribute :is_hidden
+    attribute :last_payment
+    attribute :last_payment_at
+    attribute :loan_amount
+    attribute :matures_on
+    attribute :member_guid
+    attribute :minimum_balance
+    attribute :minimum_payment
+    attribute :name
+    attribute :original_balance
+    attribute :pay_out_amount
+    attribute :payment_due_at
+    attribute :payoff_balance
+    attribute :premium_amount
+    attribute :started_on
+    attribute :subtype
+    attribute :total_account_value
+    attribute :type
+    attribute :updated_at
+    attribute :user_guid
+
+    def self.list_user_accounts(options = {})
+      options = list_user_accounts_options(options)
+
+      paginate(options)
+    end
+
+    def self.read_account(options = {})
+      read_account_options = read_account_options(options)
+      response = ::MXPlatformRuby.client.make_request(read_account_options)
+
+      account_params = response['account']
+      ::MXPlatformRuby::Account.new(account_params)
+    end
+
+    def self.update_account(options = {})
+      update_account_options = update_account_options(options)
+      response = ::MXPlatformRuby.client.make_request(update_account_options)
+
+      account_params = response['account']
+      ::MXPlatformRuby::Account.new(account_params)
+    end
+
+    # Private class methods
+
+    def self.list_user_accounts_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/accounts",
+        http_method: :get,
+        query_params: {
+          page: options[:page],
+          records_per_page: options[:records_per_page]
+        }.compact,
+        resource: 'accounts'
+      }
+    end
+    private_class_method :list_user_accounts_options
+
+    def self.read_account_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/accounts/#{options[:account_guid]}",
+        http_method: :get
+      }
+    end
+    private_class_method :read_account_options
+
+    def self.update_account_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/members/#{options[:member_guid]}/accounts/#{options[:account_guid]}",
+        http_method: :put,
+        request_body: {
+          account: {
+            is_hidden: options[:is_hidden]
+          }.compact
+        }
+      }
+    end
+    private_class_method :update_account_options
+  end
+end

data/lib/mx-platform-ruby/account_number.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class AccountNumber
+    extend ::MXPlatformRuby::Pageable
+    include ::ActiveAttr::Model
+
+    attribute :account_guid
+    attribute :account_number
+    attribute :guid
+    attribute :institution_number
+    attribute :member_guid
+    attribute :routing_number
+    attribute :transit_number
+    attribute :user_guid
+
+    def self.list_account_numbers_by_account(options = {})
+      options = list_account_numbers_by_account_options(options)
+
+      paginate(options)
+    end
+
+    def self.list_account_numbers_by_member(options = {})
+      options = list_account_numbers_by_member_options(options)
+
+      paginate(options)
+    end
+
+    # Private class methods
+
+    def self.list_account_numbers_by_account_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/accounts/#{options[:account_guid]}/account_numbers",
+        http_method: :get,
+        query_params: {
+          page: options[:page],
+          records_per_page: options[:records_per_page]
+        }.compact,
+        resource: 'account_numbers'
+      }
+    end
+    private_class_method :list_account_numbers_by_account_options
+
+    def self.list_account_numbers_by_member_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/members/#{options[:member_guid]}/account_numbers",
+        http_method: :get,
+        query_params: {
+          page: options[:page],
+          records_per_page: options[:records_per_page]
+        }.compact,
+        resource: 'account_numbers'
+      }
+    end
+    private_class_method :list_account_numbers_by_member_options
+  end
+end

data/lib/mx-platform-ruby/account_owner.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class AccountOwner
+    extend ::MXPlatformRuby::Pageable
+    include ::ActiveAttr::Model
+
+    attribute :account_guid
+    attribute :address
+    attribute :city
+    attribute :country
+    attribute :email
+    attribute :guid
+    attribute :member_guid
+    attribute :owner_name
+    attribute :phone
+    attribute :postal_code
+    attribute :state
+    attribute :user_guid
+
+    def self.list_account_owners(options = {})
+      options = list_account_owners_options(options)
+
+      paginate(options)
+    end
+
+    # Private class methods
+
+    def self.list_account_owners_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/members/#{options[:member_guid]}/account_owners",
+        http_method: :get,
+        query_params: {
+          page: options[:page],
+          records_per_page: options[:records_per_page]
+        }.compact,
+        resource: 'account_owners'
+      }
+    end
+    private_class_method :list_account_owners_options
+  end
+end