fintoc 0.1.0

data/lib/fintoc/constants.rb

@@ -0,0 +1,8 @@
+module Fintoc
+  module Constants
+    FIELDSUBS = [%w[id id_], %w[type type_]].freeze
+    GENERAL_DOC_URL = "https://fintoc.com/docs"
+    SCHEME = "https://"
+    BASE_URL = "api.fintoc.com/v1/"
+  end
+end

data/lib/fintoc/errors.rb

@@ -0,0 +1,38 @@
+require 'fintoc/constants'
+
+module Fintoc
+  module Errors
+    class FintocError < StandardError
+      def initialize(message, doc_url = Fintoc::Constants::GENERAL_DOC_URL)
+        @message = message
+        @doc_url = doc_url
+      end
+
+      def message
+        "\n#{@message}\n Please check the docs at: #{@doc_url}"
+      end
+
+      def to_s
+        message
+      end
+    end
+    class InvalidRequestError < FintocError; end
+    class LinkError < FintocError; end
+    class AuthenticationError < FintocError; end
+    class InstitutionError < FintocError; end
+    class ApiError < FintocError; end
+    class MissingResourceError < FintocError; end
+    class InvalidLinkTokenError < FintocError; end
+    class InvalidUsernameError < FintocError; end
+    class InvalidHolderTypeError < FintocError; end
+    class MissingParameterError < FintocError; end
+    class EmptyStringError < FintocError; end
+    class UnrecognizedRequestError < FintocError; end
+    class InvalidDateError < FintocError; end
+    class InvalidCredentialsError < FintocError; end
+    class LockedCredentialsError < FintocError; end
+    class InvalidApiKeyError < FintocError; end
+    class UnavailableInstitutionError < FintocError; end
+    class InternalServerError < FintocError; end
+  end
+end

data/lib/fintoc/resources/account.rb

@@ -0,0 +1,84 @@
+require 'tabulate'
+require 'fintoc/utils'
+require 'fintoc/resources/movement'
+require 'fintoc/resources/balance'
+
+module Fintoc
+  class Account
+    include Utils
+    attr_reader :id, :name, :holder_name, :currency, :type, :refreshed_at,
+                :official_name, :number, :holder_id, :balance, :movements
+    def initialize(
+      id:,
+      name:,
+      official_name:,
+      number:,
+      holder_id:,
+      holder_name:,
+      type:,
+      currency:,
+      refreshed_at: nil,
+      balance: nil,
+      movements: nil,
+      client: nil,
+      **
+    )
+      @id = id
+      @name = name
+      @official_name = official_name
+      @number = number
+      @holder_id = holder_id
+      @holder_name = holder_name
+      @type = type
+      @currency = currency
+      @refreshed_at = DateTime.iso8601(refreshed_at) if refreshed_at
+      @balance = Fintoc::Balance.new(**balance)
+      @movements = movements || []
+      @client = client
+    end
+
+    def update_balance
+      @balance = Fintoc::Balance.new(**get_account[:balance])
+    end
+
+    def get_movements(**params)
+      _get_movements(**params).lazy.map { |movement| Fintoc::Movement.new(**movement) }
+    end
+
+    def update_movements(**params)
+      @movements += get_movements(**params).to_a
+      @movements = @movements.uniq.sort_by(&:post_date)
+    end
+
+    def show_movements(rows = 5)
+      puts("This account has #{Utils.pluralize(@movements.size, 'movement')}.")
+
+      return unless @movements.any?
+
+      movements = @movements.to_a.slice(0, rows)
+                            .map.with_index do |mov, index|
+                              [index + 1, mov.amount, mov.currency, mov.description, mov.locale_date]
+                            end
+      headers = ['#', 'Amount', 'Currency', 'Description', 'Date']
+      puts
+      puts tabulate(headers, movements, indent: 4, style: 'fancy')
+    end
+
+    def to_s
+      "💰 #{@holder_name}’s #{@name} #{@balance}"
+    end
+
+    private
+
+    def get_account
+      @client.get.call("accounts/#{@id}")
+    end
+
+    def _get_movements(**params)
+      first = @client.get.call("accounts/#{@id}/movements", **params)
+      return first if params.empty?
+
+      first + Utils.flatten(@client.fetch_next)
+    end
+  end
+end

data/lib/fintoc/resources/balance.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Fintoc
+  class Balance
+    attr_reader :available, :current, :limit
+    def initialize(available:, current:, limit:)
+      @available = available
+      @current = current
+      @limit = limit
+    end
+
+    def id
+      object_id
+    end
+
+    def to_s
+      "#{@available} (#{@current})"
+    end
+
+    def inspect
+      "<Balance #{@available} (#{@current})>"
+    end
+  end
+end

data/lib/fintoc/resources/institution.rb

@@ -0,0 +1,18 @@
+module Fintoc
+  class Institution
+    attr_reader :id, :name, :country
+    def initialize(id:, name:, country:, **)
+      @id = id
+      @name = name
+      @country = country
+    end
+
+    def to_s
+      "🏦 #{@name}"
+    end
+
+    def inspect
+      "<Institution #{@name}>"
+    end
+  end
+end

data/lib/fintoc/resources/link.rb

@@ -0,0 +1,83 @@
+require 'date'
+require 'tabulate'
+require 'fintoc/utils'
+require 'fintoc/resources/account'
+require 'fintoc/resources/institution'
+require 'tabulate'
+
+module Fintoc
+  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::Institution.new(**institution)
+      @created_at = Date.iso8601(created_at)
+      @mode = mode
+      @accounts = if accounts.nil?
+                    []
+                  else
+                    accounts.map { |data| Fintoc::Account.new(**data, client: 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(**kwargs)
+      results = find_all(**kwargs)
+      results.any? ? results.first : nil
+    end
+
+    def show_accounts(rows = 5)
+      puts "This links has #{Utils.plurlize(@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, account.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.delete_link(@id)
+    end
+
+    def to_s
+      "<#{@username}@#{@institution.name}> 🔗 <Fintoc>"
+    end
+  end
+end

data/lib/fintoc/resources/movement.rb

@@ -0,0 +1,55 @@
+require 'date'
+require 'fintoc/resources/transfer_account'
+
+module Fintoc
+  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:,
+      **
+    )
+      @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 = Fintoc::TransferAccount.new(**recipient_account) if recipient_account
+      @sender_account = Fintoc::TransferAccount.new(**sender_account) if sender_account
+      @comment = comment
+    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

data/lib/fintoc/resources/transfer_account.rb

@@ -0,0 +1,22 @@
+require 'fintoc/resources/institution'
+
+module Fintoc
+  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::Institution.new(**institution)
+    end
+
+    def id
+      object_id
+    end
+
+    def to_s
+      @holder_id.to_s
+    end
+  end
+end

data/lib/fintoc/utils.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Fintoc
+  # A handful of run-of-the-mill utilities
+  module Utils
+    extend self
+
+    # Get a flat Array out of a list of lists of Iterables(Enumerators)
+    #
+    def flatten(sequences)
+      Enumerator::Chain.new(*sequences).to_a
+    end
+
+    # If the key exists, you will get that key-value pair.
+    #
+    # @param dict_ [Hash] the hash to pick from
+    # @param key [String] the key to look at
+    # @return [Hash] the key-value pair or an empty hash
+    def pick(dict_, key)
+      key = key.to_sym
+      if dict_.key?(key)
+        { "#{key}": dict_[key] }
+      else
+        {}
+      end
+    end
+
+    # Get a pluralized noun with its appropiate quantifier
+    #
+    # @param amount [Integer]
+    # @param noun [String] the noun to pluralize
+    # @param suffix [String]
+    # @return [String]
+    def pluralize(amount, noun, suffix = 's')
+      quantifier = amount or 'no'
+      "#{quantifier} #{amount == 1 ? noun : noun + suffix}"
+    end
+
+    # Transform a snake-cased name to its pascal-cased version.
+    #
+    # @param name [String]
+    # @return [String]
+    def snake_to_pascal(name)
+      name.split('_').map(&:capitalize).join('')
+    end
+  end
+end

data/lib/fintoc/version.rb

@@ -0,0 +1,3 @@
+module Fintoc
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: fintoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Ca Sardin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tabulate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The official Ruby client for the Fintoc API.
+email:
+- juan.carlos.sardin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.MD
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fintoc.gemspec
+- lib/fintoc.rb
+- lib/fintoc/client.rb
+- lib/fintoc/constants.rb
+- lib/fintoc/errors.rb
+- lib/fintoc/resources/account.rb
+- lib/fintoc/resources/balance.rb
+- lib/fintoc/resources/institution.rb
+- lib/fintoc/resources/link.rb
+- lib/fintoc/resources/movement.rb
+- lib/fintoc/resources/transfer_account.rb
+- lib/fintoc/utils.rb
+- lib/fintoc/version.rb
+homepage: https://github.com/fintoc-com/fintoc-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/fintoc-com/fintoc-ruby
+  source_code_uri: https://github.com/fintoc-com/fintoc-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The official Ruby client for the Fintoc API.
+test_files: []