fintoc 0.1.0 → 1.0.0

data/lib/fintoc/v1/resources/link.rb

@@ -0,0 +1,85 @@
+require 'date'
+require 'tabulate'
+require 'fintoc/utils'
+require 'fintoc/v1/resources/account'
+require 'fintoc/v1/resources/institution'
+
+module Fintoc
+  module V1
+    class Link
+      attr_reader :id, :username, :holder_type, :institution, :created_at, :mode,
+                  :accounts, :link_token
+
+      include Utils
+
+      def initialize(
+        id:,
+        username:,
+        holder_type:,
+        institution:,
+        created_at:,
+        mode:,
+        accounts: nil,
+        link_token: nil,
+        client: nil,
+        **
+      )
+        @id = id
+        @username = username
+        @holder_type = holder_type
+        @institution = Fintoc::V1::Institution.new(**institution)
+        @created_at = Date.iso8601(created_at)
+        @mode = mode
+        @accounts = if accounts.nil?
+                      []
+                    else
+                      accounts.map { |data| Fintoc::V1::Account.new(**data, client:) }
+                    end
+        @token = link_token
+        @client = client
+      end
+
+      def find_all(**kwargs)
+        raise 'You must provide *exactly one* account field.' if kwargs.size != 1
+
+        field, value = kwargs.to_a.first
+        @accounts.select do |account|
+          account.send(field.to_sym) == value
+        end
+      end
+
+      def find(**)
+        results = find_all(**)
+        results.any? ? results.first : nil
+      end
+
+      def show_accounts(rows = 5)
+        puts "This links has #{Utils.pluralize(@accounts.size, 'account')}"
+        return unless @accounts.any?
+
+        accounts = @accounts.to_a.slice(0, rows)
+                            .map.with_index do |acc, index|
+                              [index + 1, acc.name, acc.holder_name, acc.currency]
+                            end
+        headers = ['#', 'Name', 'Holder', 'Currency']
+        puts
+        puts tabulate(headers, accounts, indent: 4, style: 'fancy')
+      end
+
+      def update_accounts
+        @accounts.each do |account|
+          account.update_balance
+          account.update_movements
+        end
+      end
+
+      def delete
+        @client.links.delete(@id)
+      end
+
+      def to_s
+        "<#{@username}@#{@institution.name}> 🔗 <Fintoc>"
+      end
+    end
+  end
+end

data/lib/fintoc/v1/resources/movement.rb

@@ -0,0 +1,62 @@
+require 'date'
+require 'fintoc/v1/resources/transfer_account'
+
+module Fintoc
+  module V1
+    class Movement
+      attr_reader :id, :amount, :currency, :description, :reference_id,
+                  :post_date, :transaction_date, :type, :recipient_account,
+                  :sender_account, :account, :comment
+
+      def initialize(
+        id:,
+        amount:,
+        currency:,
+        description:,
+        post_date:,
+        transaction_date:,
+        type:,
+        reference_id:,
+        recipient_account:,
+        sender_account:,
+        comment:,
+        client: nil,
+        **
+      )
+        @id = id
+        @amount = amount
+        @currency = currency
+        @description = description
+        @post_date = DateTime.iso8601(post_date)
+        @transaction_date = DateTime.iso8601(transaction_date) if transaction_date
+        @type = type
+        @reference_id = reference_id
+        @recipient_account =
+          if recipient_account
+            Fintoc::V1::TransferAccount.new(**recipient_account)
+          end
+        @sender_account = Fintoc::V1::TransferAccount.new(**sender_account) if sender_account
+        @comment = comment
+        @client = client
+      end
+
+      def ==(other)
+        @id == other.id
+      end
+
+      alias eql? ==
+
+      def hash
+        @id.hash
+      end
+
+      def locale_date
+        @post_date.strftime('%x')
+      end
+
+      def to_s
+        "#{@amount} (#{@description} @ #{locale_date})"
+      end
+    end
+  end
+end

data/lib/fintoc/v1/resources/transfer_account.rb

@@ -0,0 +1,24 @@
+require 'fintoc/v1/resources/institution'
+
+module Fintoc
+  module V1
+    class TransferAccount
+      attr_reader :holder_id, :holder_name, :number, :institution
+
+      def initialize(holder_id:, holder_name:, number:, institution:, **)
+        @holder_id = holder_id
+        @holder_name = holder_name
+        @number = number
+        @institution = institution && Fintoc::V1::Institution.new(**institution)
+      end
+
+      def id
+        object_id
+      end
+
+      def to_s
+        @holder_id.to_s
+      end
+    end
+  end
+end

data/lib/fintoc/v2/client/client.rb

@@ -0,0 +1,37 @@
+require 'fintoc/base_client'
+require 'fintoc/v2/managers/entities_manager'
+require 'fintoc/v2/managers/accounts_manager'
+require 'fintoc/v2/managers/account_numbers_manager'
+require 'fintoc/v2/managers/transfers_manager'
+require 'fintoc/v2/managers/simulate_manager'
+require 'fintoc/v2/managers/account_verifications_manager'
+
+module Fintoc
+  module V2
+    class Client < BaseClient
+      def entities
+        @entities ||= Managers::EntitiesManager.new(self)
+      end
+
+      def accounts
+        @accounts ||= Managers::AccountsManager.new(self)
+      end
+
+      def account_numbers
+        @account_numbers ||= Managers::AccountNumbersManager.new(self)
+      end
+
+      def transfers
+        @transfers ||= Managers::TransfersManager.new(self)
+      end
+
+      def simulate
+        @simulate ||= Managers::SimulateManager.new(self)
+      end
+
+      def account_verifications
+        @account_verifications ||= Managers::AccountVerificationsManager.new(self)
+      end
+    end
+  end
+end

data/lib/fintoc/v2/managers/account_numbers_manager.rb

@@ -0,0 +1,59 @@
+require 'fintoc/v2/resources/account_number'
+
+module Fintoc
+  module V2
+    module Managers
+      class AccountNumbersManager
+        def initialize(client)
+          @client = client
+        end
+
+        def create(account_id:, description: nil, metadata: nil, **params)
+          data = _create_account_number(account_id:, description:, metadata:, **params)
+          build_account_number(data)
+        end
+
+        def get(account_number_id)
+          data = _get_account_number(account_number_id)
+          build_account_number(data)
+        end
+
+        def list(**params)
+          _list_account_numbers(**params).map { |data| build_account_number(data) }
+        end
+
+        def update(account_number_id, **params)
+          data = _update_account_number(account_number_id, **params)
+          build_account_number(data)
+        end
+
+        private
+
+        def _create_account_number(account_id:, description: nil, metadata: nil, **params)
+          request_params = { account_id: }
+          request_params[:description] = description if description
+          request_params[:metadata] = metadata if metadata
+          request_params.merge!(params)
+
+          @client.post(version: :v2).call('account_numbers', **request_params)
+        end
+
+        def _get_account_number(account_number_id)
+          @client.get(version: :v2).call("account_numbers/#{account_number_id}")
+        end
+
+        def _list_account_numbers(**params)
+          @client.get(version: :v2).call('account_numbers', **params)
+        end
+
+        def _update_account_number(account_number_id, **params)
+          @client.patch(version: :v2).call("account_numbers/#{account_number_id}", **params)
+        end
+
+        def build_account_number(data)
+          Fintoc::V2::AccountNumber.new(**data, client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/fintoc/v2/managers/account_verifications_manager.rb

@@ -0,0 +1,45 @@
+require 'fintoc/v2/resources/account_verification'
+
+module Fintoc
+  module V2
+    module Managers
+      class AccountVerificationsManager
+        def initialize(client)
+          @client = client
+        end
+
+        def create(account_number:)
+          data = _create_account_verification(account_number:)
+          build_account_verification(data)
+        end
+
+        def get(account_verification_id)
+          data = _get_account_verification(account_verification_id)
+          build_account_verification(data)
+        end
+
+        def list(**params)
+          _list_account_verifications(**params).map { |data| build_account_verification(data) }
+        end
+
+        private
+
+        def _create_account_verification(account_number:)
+          @client.post(version: :v2, use_jws: true).call('account_verifications', account_number:)
+        end
+
+        def _get_account_verification(account_verification_id)
+          @client.get(version: :v2).call("account_verifications/#{account_verification_id}")
+        end
+
+        def _list_account_verifications(**params)
+          @client.get(version: :v2).call('account_verifications', **params)
+        end
+
+        def build_account_verification(data)
+          Fintoc::V2::AccountVerification.new(**data, client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/fintoc/v2/managers/accounts_manager.rb

@@ -0,0 +1,54 @@
+require 'fintoc/v2/resources/account'
+
+module Fintoc
+  module V2
+    module Managers
+      class AccountsManager
+        def initialize(client)
+          @client = client
+        end
+
+        def create(entity_id:, description:, **params)
+          data = _create_account(entity_id:, description:, **params)
+          build_account(data)
+        end
+
+        def get(account_id)
+          data = _get_account(account_id)
+          build_account(data)
+        end
+
+        def list(**params)
+          _list_accounts(**params).map { |data| build_account(data) }
+        end
+
+        def update(account_id, **params)
+          data = _update_account(account_id, **params)
+          build_account(data)
+        end
+
+        private
+
+        def _create_account(entity_id:, description:, **params)
+          @client.post(version: :v2).call('accounts', entity_id:, description:, **params)
+        end
+
+        def _get_account(account_id)
+          @client.get(version: :v2).call("accounts/#{account_id}")
+        end
+
+        def _list_accounts(**params)
+          @client.get(version: :v2).call('accounts', **params)
+        end
+
+        def _update_account(account_id, **params)
+          @client.patch(version: :v2).call("accounts/#{account_id}", **params)
+        end
+
+        def build_account(data)
+          Fintoc::V2::Account.new(**data, client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/fintoc/v2/managers/entities_manager.rb

@@ -0,0 +1,36 @@
+require 'fintoc/v2/resources/entity'
+
+module Fintoc
+  module V2
+    module Managers
+      class EntitiesManager
+        def initialize(client)
+          @client = client
+        end
+
+        def get(entity_id)
+          data = _get_entity(entity_id)
+          build_entity(data)
+        end
+
+        def list(**params)
+          _list_entities(**params).map { |data| build_entity(data) }
+        end
+
+        private
+
+        def _get_entity(entity_id)
+          @client.get(version: :v2).call("entities/#{entity_id}")
+        end
+
+        def _list_entities(**params)
+          @client.get(version: :v2).call('entities', **params)
+        end
+
+        def build_entity(data)
+          Fintoc::V2::Entity.new(**data, client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/fintoc/v2/managers/simulate_manager.rb

@@ -0,0 +1,30 @@
+require 'fintoc/v2/resources/transfer'
+
+module Fintoc
+  module V2
+    module Managers
+      class SimulateManager
+        def initialize(client)
+          @client = client
+        end
+
+        def receive_transfer(account_number_id:, amount:, currency:)
+          data = _simulate_receive_transfer(account_number_id:, amount:, currency:)
+          build_transfer(data)
+        end
+
+        private
+
+        def _simulate_receive_transfer(account_number_id:, amount:, currency:)
+          @client
+            .post(version: :v2)
+            .call('simulate/receive_transfer', account_number_id:, amount:, currency:)
+        end
+
+        def build_transfer(data)
+          Fintoc::V2::Transfer.new(**data, client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/fintoc/v2/managers/transfers_manager.rb

@@ -0,0 +1,56 @@
+require 'fintoc/v2/resources/transfer'
+
+module Fintoc
+  module V2
+    module Managers
+      class TransfersManager
+        def initialize(client)
+          @client = client
+        end
+
+        def create(amount:, currency:, account_id:, counterparty:, **params)
+          data = _create_transfer(amount:, currency:, account_id:, counterparty:, **params)
+          build_transfer(data)
+        end
+
+        def get(transfer_id)
+          data = _get_transfer(transfer_id)
+          build_transfer(data)
+        end
+
+        def list(**params)
+          _list_transfers(**params).map { |data| build_transfer(data) }
+        end
+
+        def return(transfer_id)
+          data = _return_transfer(transfer_id)
+          build_transfer(data)
+        end
+
+        private
+
+        def _create_transfer(amount:, currency:, account_id:, counterparty:, **params)
+          @client
+            .post(version: :v2, use_jws: true)
+            .call('transfers', amount:, currency:, account_id:, counterparty:, **params)
+        end
+
+        def _get_transfer(transfer_id)
+          @client.get(version: :v2).call("transfers/#{transfer_id}")
+        end
+
+        def _list_transfers(**params)
+          @client.get(version: :v2).call('transfers', **params)
+        end
+
+        def _return_transfer(transfer_id)
+          @client.post(version: :v2, use_jws: true).call('transfers/return', transfer_id:)
+        end
+
+        def build_transfer(data)
+          Fintoc::V2::Transfer.new(**data, client: @client)
+        end
+      end
+    end
+  end
+end

data/lib/fintoc/v2/resources/account.rb

@@ -0,0 +1,105 @@
+require 'money'
+
+module Fintoc
+  module V2
+    class Account
+      attr_reader :id, :object, :mode, :description, :available_balance, :currency,
+                  :is_root, :root_account_number_id, :root_account_number, :status, :entity
+
+      def initialize(
+        id:,
+        object:,
+        mode:,
+        description:,
+        available_balance:,
+        currency:,
+        is_root:,
+        root_account_number_id:,
+        root_account_number:,
+        status:,
+        entity:,
+        client: nil,
+        **
+      )
+        @id = id
+        @object = object
+        @mode = mode
+        @description = description
+        @available_balance = available_balance
+        @currency = currency
+        @is_root = is_root
+        @root_account_number_id = root_account_number_id
+        @root_account_number = root_account_number
+        @status = status
+        @entity = entity
+        @client = client
+      end
+
+      def to_s
+        "💰 #{@description} (#{@id}) - #{Money.from_cents(@available_balance, @currency).format}"
+      end
+
+      def refresh
+        fresh_account = @client.accounts.get(@id)
+        refresh_from_account(fresh_account)
+      end
+
+      def update(description: nil)
+        params = {}
+        params[:description] = description if description
+
+        updated_account = @client.accounts.update(@id, **params)
+        refresh_from_account(updated_account)
+      end
+
+      def active?
+        @status == 'active'
+      end
+
+      def blocked?
+        @status == 'blocked'
+      end
+
+      def closed?
+        @status == 'closed'
+      end
+
+      def test_mode?
+        @mode == 'test'
+      end
+
+      def simulate_receive_transfer(amount:)
+        unless test_mode?
+          raise Fintoc::Errors::InvalidRequestError, 'Simulation is only available in test mode'
+        end
+
+        @client.simulate.receive_transfer(
+          account_number_id: @root_account_number_id,
+          amount:,
+          currency: @currency
+        )
+      end
+
+      private
+
+      def refresh_from_account(account)
+        unless account.id == @id
+          raise ArgumentError, 'Account must be the same instance'
+        end
+
+        @object = account.object
+        @mode = account.mode
+        @description = account.description
+        @available_balance = account.available_balance
+        @currency = account.currency
+        @is_root = account.is_root
+        @root_account_number_id = account.root_account_number_id
+        @root_account_number = account.root_account_number
+        @status = account.status
+        @entity = account.entity
+
+        self
+      end
+    end
+  end
+end

data/lib/fintoc/v2/resources/account_number.rb

@@ -0,0 +1,105 @@
+module Fintoc
+  module V2
+    class AccountNumber
+      attr_reader :id, :object, :description, :number, :created_at, :updated_at,
+                  :mode, :status, :is_root, :account_id, :metadata
+
+      def initialize(
+        id:,
+        object:,
+        description:,
+        number:,
+        created_at:,
+        updated_at:,
+        mode:,
+        status:,
+        is_root:,
+        account_id:,
+        metadata:,
+        client: nil,
+        **
+      )
+        @id = id
+        @object = object
+        @description = description
+        @number = number
+        @created_at = created_at
+        @updated_at = updated_at
+        @mode = mode
+        @status = status
+        @is_root = is_root
+        @account_id = account_id
+        @metadata = metadata
+        @client = client
+      end
+
+      def to_s
+        "🔢 #{@number} (#{@id}) - #{@description}"
+      end
+
+      def refresh
+        fresh_account_number = @client.account_numbers.get(@id)
+        refresh_from_account_number(fresh_account_number)
+      end
+
+      def update(description: nil, status: nil, metadata: nil)
+        params = {}
+        params[:description] = description if description
+        params[:status] = status if status
+        params[:metadata] = metadata if metadata
+
+        updated_account_number = @client.account_numbers.update(@id, **params)
+        refresh_from_account_number(updated_account_number)
+      end
+
+      def enabled?
+        @status == 'enabled'
+      end
+
+      def disabled?
+        @status == 'disabled'
+      end
+
+      def root?
+        @is_root
+      end
+
+      def test_mode?
+        @mode == 'test'
+      end
+
+      def simulate_receive_transfer(amount:, currency: 'MXN')
+        unless test_mode?
+          raise Fintoc::Errors::InvalidRequestError, 'Simulation is only available in test mode'
+        end
+
+        @client.simulate.receive_transfer(
+          account_number_id: @id,
+          amount:,
+          currency:
+        )
+      end
+
+      private
+
+      def refresh_from_account_number(account_number)
+        unless account_number.id == @id
+          raise ArgumentError, 'AccountNumber must be the same instance'
+        end
+
+        @object = account_number.object
+        @description = account_number.description
+        @number = account_number.number
+        @created_at = account_number.created_at
+        @updated_at = account_number.updated_at
+        @mode = account_number.mode
+        @status = account_number.status
+        @is_root = account_number.is_root
+        @account_id = account_number.account_id
+        @metadata = account_number.metadata
+
+        self
+      end
+    end
+  end
+end