mx-platform-ruby 0.1.0 → 0.1.1

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

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

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

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class Client
+    BASE_URL = 'https://int-api.mx.com'
+
+    attr_accessor :base_url, :password, :username
+
+    def initialize(base_url = BASE_URL, password = nil, username = nil)
+      @base_url = base_url
+      @password = password
+      @username = username
+    end
+
+    def http_client
+      @http_client ||= ::HTTPClient.new
+    end
+
+    def make_request(options = {})
+      body    = ::JSON.dump(options[:request_body]) if options[:request_body]
+      headers = default_headers.merge(options[:headers] || {})
+      url     = "#{base_url}#{options[:endpoint]}"
+      url     = "#{url}?#{::URI.encode_www_form(options[:query_params])}" if options[:query_params]
+      method  = options[:http_method]
+
+      response = http_client.public_send(method, url, body, headers)
+
+      handle_response(response)
+    end
+
+    private
+
+    def default_headers
+      {
+        'Accept': 'application/vnd.mx.api.v1+json',
+        'Authorization': "Basic #{::Base64.urlsafe_encode64("#{username}:#{password}")}",
+        'Content-Type': 'application/json'
+      }
+    end
+
+    def format_response_body(body)
+      ::JSON.parse(body)
+    rescue JSON::ParserError
+      file = ::Tempfile.new
+      file.write(body)
+      file.close
+      file
+    end
+
+    def handle_response(response)
+      # Handle 200-206 responses as acceptable
+      raise ::MXPlatformRuby::Error, "#{response.status}: #{response.body}" unless response.status.between?(200, 206)
+
+      return if response.body.empty?
+
+      format_response_body(response.body)
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class ConnectWidget
+    include ::ActiveAttr::Model
+
+    attribute :connect_widget_url
+    attribute :guid
+
+    def self.request_connect_widget_url(options = {})
+      request_connect_widget_url_options = request_connect_widget_url_options(options)
+      response = ::MXPlatformRuby.client.make_request(request_connect_widget_url_options)
+
+      user_params = response['user']
+      ::MXPlatformRuby::ConnectWidget.new(user_params)
+    end
+
+    # Private class methods
+
+    def self.request_connect_widget_url_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/connect_widget_url",
+        http_method: :post,
+        request_body: {
+          config: {
+            color_scheme: options[:color_scheme],
+            current_institution_code: options[:current_institution_code],
+            current_member_guid: options[:current_member_guid],
+            disable_institution_search: options[:disable_institution_search],
+            include_transactions: options[:include_transactions],
+            is_mobile_webview: options[:is_mobile_webview],
+            mode: options[:mode],
+            ui_message_version: options[:ui_message_version],
+            ui_message_webview_url_scheme: options[:ui_message_webview_url_scheme],
+            update_credentials: options[:update_credentials],
+            wait_for_full_aggregation: options[:wait_for_full_aggregation]
+          }.compact
+        }
+      }
+    end
+    private_class_method :request_connect_widget_url_options
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class Credential
+    extend ::MXPlatformRuby::Pageable
+    include ::ActiveAttr::Model
+
+    attribute :display_order
+    attribute :field_name
+    attribute :field_type
+    attribute :guid
+    attribute :label
+
+    def self.list_institution_required_credentials(options = {})
+      options = list_institution_required_credentials_options(options)
+
+      paginate(options)
+    end
+
+    def self.list_member_credentials(options = {})
+      options = list_member_credentials_options(options)
+
+      paginate(options)
+    end
+
+    # Private class methods
+
+    def self.list_institution_required_credentials_options(options)
+      {
+        endpoint: "/institutions/#{options[:institution_code]}/credentials",
+        http_method: :get,
+        query_params: {
+          page: options[:page],
+          records_per_page: options[:records_per_page]
+        }.compact,
+        resource: 'credentials'
+      }
+    end
+    private_class_method :list_institution_required_credentials_options
+
+    def self.list_member_credentials_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/members/#{options[:member_guid]}/credentials",
+        http_method: :get,
+        query_params: {
+          page: options[:page],
+          records_per_page: options[:records_per_page]
+        }.compact,
+        resource: 'credentials'
+      }
+    end
+    private_class_method :list_member_credentials_options
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class EnhancedTransaction
+    include ::ActiveAttr::Model
+
+    attribute :amount
+    attribute :category
+    attribute :description
+    attribute :id
+    attribute :is_bill_pay
+    attribute :is_direct_deposit
+    attribute :is_expense
+    attribute :is_fee
+    attribute :is_income
+    attribute :is_international
+    attribute :is_overdraft_fee
+    attribute :is_payroll_advance
+    attribute :merchant_category_code
+    attribute :merchant_guid
+    attribute :original_description
+    attribute :type
+
+    def self.enhance_transactions(options = {})
+      enhance_transactions_options = enhance_transactions_options(options)
+      response = ::MXPlatformRuby.client.make_request(enhance_transactions_options)
+
+      response['transactions'].map { |attributes| ::MXPlatformRuby::EnhancedTransaction.new(attributes) }
+    end
+
+    # Private class methods
+
+    def self.enhance_transactions_options(options)
+      {
+        endpoint: '/transactions/enhance',
+        http_method: :post,
+        request_body: {
+          transactions: options[:transactions]
+        }.compact
+      }
+    end
+    private_class_method :enhance_transactions_options
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class Error < StandardError
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module MXPlatformRuby
+  class Holding
+    extend ::MXPlatformRuby::Pageable
+    include ::ActiveAttr::Model
+
+    attribute :account_guid
+    attribute :cost_basis
+    attribute :created_at
+    attribute :currency_code
+    attribute :cusip
+    attribute :daily_change
+    attribute :description
+    attribute :guid
+    attribute :holding_type
+    attribute :id
+    attribute :market_value
+    attribute :member_guid
+    attribute :metadata
+    attribute :purchase_price
+    attribute :shares
+    attribute :symbol
+    attribute :updated_at
+    attribute :user_guid
+
+    def self.list_holdings_by_member(options = {})
+      options = list_holdings_by_member_options(options)
+
+      paginate(options)
+    end
+
+    def self.list_holdings_by_user(options = {})
+      options = list_holdings_by_user_options(options)
+
+      paginate(options)
+    end
+
+    def self.read_holding(options = {})
+      read_holding_options = read_holding_options(options)
+      response = ::MXPlatformRuby.client.make_request(read_holding_options)
+
+      holding_params = response['holding']
+      ::MXPlatformRuby::Holding.new(holding_params)
+    end
+
+    # Private class methods
+
+    def self.list_holdings_by_member_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/members/#{options[:member_guid]}/holdings",
+        http_method: :get,
+        query_params: {
+          from_date: options[:from_date],
+          page: options[:page],
+          records_per_page: options[:records_per_page],
+          to_date: options[:to_date]
+        }.compact,
+        resource: 'holdings'
+      }
+    end
+    private_class_method :list_holdings_by_member_options
+
+    def self.list_holdings_by_user_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/holdings",
+        http_method: :get,
+        query_params: {
+          from_date: options[:from_date],
+          page: options[:page],
+          records_per_page: options[:records_per_page],
+          to_date: options[:to_date]
+        }.compact,
+        resource: 'holdings'
+      }
+    end
+    private_class_method :list_holdings_by_user_options
+
+    def self.read_holding_options(options)
+      {
+        endpoint: "/users/#{options[:user_guid]}/holdings/#{options[:holding_guid]}",
+        http_method: :get
+      }
+    end
+    private_class_method :read_holding_options
+  end
+end