mx-platform-ruby 0.1.1 → 0.2.0

data/.github/workflows/test.yml

@@ -1,20 +0,0 @@
-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

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

data/.rubocop.yml

@@ -1,44 +0,0 @@
-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/lib/mx-platform-ruby/account.rb

@@ -1,107 +0,0 @@
-# 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

@@ -1,57 +0,0 @@
-# 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

@@ -1,42 +0,0 @@
-# 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

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

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-module MXPlatformRuby
-  class Category
-    extend ::MXPlatformRuby::Pageable
-    include ::ActiveAttr::Model
-
-    attribute :created_at
-    attribute :guid
-    attribute :is_default
-    attribute :is_income
-    attribute :metadata
-    attribute :name
-    attribute :parent_guid
-    attribute :updated_at
-
-    def self.create_category(options = {})
-      create_category_options = create_category_options(options)
-      response = ::MXPlatformRuby.client.make_request(create_category_options)
-
-      category_params = response['category']
-      ::MXPlatformRuby::Category.new(category_params)
-    end
-
-    def self.delete_category(options = {})
-      delete_category_options = delete_category_options(options)
-      ::MXPlatformRuby.client.make_request(delete_category_options)
-    end
-
-    def self.list_categories(options = {})
-      options = list_categories_options(options)
-
-      paginate(options)
-    end
-
-    def self.list_default_categories(options = {})
-      options = list_default_categories_options(options)
-
-      paginate(options)
-    end
-
-    def self.read_category(options = {})
-      read_category_options = read_category_options(options)
-      response = ::MXPlatformRuby.client.make_request(read_category_options)
-
-      category_params = response['category']
-      ::MXPlatformRuby::Category.new(category_params)
-    end
-
-    def self.update_category(options = {})
-      update_category_options = update_category_options(options)
-      response = ::MXPlatformRuby.client.make_request(update_category_options)
-
-      category_params = response['category']
-      ::MXPlatformRuby::Category.new(category_params)
-    end
-
-    # Private class methods
-
-    def self.create_category_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/categories",
-        http_method: :post,
-        request_body: {
-          category: {
-            metadata: options[:metadata],
-            name: options[:name],
-            parent_guid: options[:parent_guid]
-          }.compact
-        }
-      }
-    end
-    private_class_method :create_category_options
-
-    def self.delete_category_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/categories/#{options[:category_guid]}",
-        http_method: :delete
-      }
-    end
-    private_class_method :delete_category_options
-
-    def self.list_categories_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/categories",
-        http_method: :get,
-        query_params: {
-          page: options[:page],
-          records_per_page: options[:records_per_page]
-        }.compact,
-        resource: 'categories'
-      }
-    end
-    private_class_method :list_categories_options
-
-    def self.list_default_categories_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/categories/default",
-        http_method: :get,
-        resource: 'categories'
-      }
-    end
-    private_class_method :list_default_categories_options
-
-    def self.read_category_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/categories/#{options[:category_guid]}",
-        http_method: :get
-      }
-    end
-    private_class_method :read_category_options
-
-    def self.update_category_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/categories/#{options[:category_guid]}",
-        http_method: :put,
-        request_body: {
-          category: {
-            metadata: options[:metadata],
-            name: options[:name]
-          }.compact
-        }
-      }
-    end
-    private_class_method :update_category_options
-  end
-end

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module MXPlatformRuby
-  class Challenge
-    extend ::MXPlatformRuby::Pageable
-    include ::ActiveAttr::Model
-
-    attribute :field_name
-    attribute :guid
-    attribute :image_data
-    attribute :image_options
-    attribute :label
-    attribute :options
-    attribute :type
-
-    def self.list_member_challenges(options = {})
-      options = list_member_challenges_options(options)
-
-      paginate(options)
-    end
-
-    # Private class methods
-
-    def self.list_member_challenges_options(options)
-      {
-        endpoint: "/users/#{options[:user_guid]}/members/#{options[:member_guid]}/challenges",
-        http_method: :get,
-        query_params: {
-          page: options[:page],
-          records_per_page: options[:records_per_page]
-        }.compact,
-        resource: 'challenges'
-      }
-    end
-    private_class_method :list_member_challenges_options
-  end
-end