fintoc 0.1.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 - 2021-01-18
+
+* Up to date with the [2020-11-17](https://docs.fintoc.com/docs/api-changelog#2020-11-17) API version

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fintoc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    fintoc (0.1.0)
+      http
+      tabulate
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    jaro_winkler (1.5.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.41.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    tabulate (0.1.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fintoc!
+  rspec (~> 3.0)
+  rubocop (~> 0.81.0)
+  rubocop-performance
+  rubocop-rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.MD

@@ -0,0 +1,27 @@
+Copyright © 2020, [Fintoc](https://fintoc.com/).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author nor the names of contributors may be used to
+  endorse or promote products derived from this software without specific prior
+  written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,166 @@
+# Fintoc meets Ruby
+
+You have just found the [Ruby](https://www.ruby-lang.org/)-flavored client of [Fintoc](https://fintoc.com). It mainly consists of a port (more of a carbon copy, really) of [fintoc-python](https://github.com/fintoc-com/fintoc-python).
+
+## Why?
+
+You can think of [Fintoc API](https://fintoc.com/docs) as a piscola.
+And the key ingredient to a properly made piscola are the ice cubes.
+Sure, you can still have a [piscola without ice cubes](https://curl.haxx.se/).
+But hey… that’s not enjoyable -- why would you do that?
+Do yourself a favor: go grab some ice cubes by installing this refreshing library.
+
+## Table of contents
+
+- [Fintoc meets Ruby](#fintoc-meets-ruby)
+  - [Table of contents](#table-of-contents)
+  - [How to install](#how-to-install)
+  - [Quickstart](#quickstart)
+  - [Documentation](#documentation)
+  - [Examples](#examples)
+    - [Get accounts](#get-accounts)
+    - [Get movements](#get-movements)
+  - [Dependencies](#dependencies)
+  - [How to test…](#how-to-test)
+  - [Roadmap](#roadmap)
+  - [Acknowledgements](#acknowledgements)
+
+
+## How to Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fintoc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fintoc
+
+## Quickstart
+
+1. Get your API key and link your bank account using the [Fintoc dashboard](https://app.fintoc.com/login).
+2. Open your command-line interface.
+3. Write a few lines of Ruby code to see your bank movements.
+
+```ruby
+require 'fintoc'
+
+client = Fintoc::Client.new('sk_test_9c8d8CeyBTx1VcJzuDgpm4H-bywJCeSx')
+link = client.get_link('6n12zLmai3lLE9Dq_token_gvEJi8FrBge4fb3cz7Wp856W')
+account = link.find(type: 'checking_account')
+
+# Get the las 30 movements
+movements = account.get_movements
+
+# Or get all the movements since a specific date
+movements = account.get_movements(since: '2020-08-15')
+
+```
+And that’s it!
+
+## Documentation
+
+This client supports all Fintoc API endpoints. For complete information about the API, head to the [docs](https://docs.fintoc.com/reference).
+
+## Examples
+
+### Get accounts
+
+```ruby
+require 'fintoc'
+
+client = Fintoc::Client.new('api_key')
+link = client.get_link('link_token')
+puts link.accounts
+
+# Or... you can pretty print all the accounts in a Link
+
+link = client.get_link('link_token')
+link.show_accounts
+
+```
+
+If you want to find a specific account in a link, you can use **find**. You can search by any account field:
+
+```ruby
+require 'fintoc'
+
+client = Fintoc::Client.new('api_key')
+link = client.get_link('link_token')
+account = link.find(type: 'checking_account')
+
+# Or by number
+account = link.find(number: '1111111')
+
+# Or by account id
+account = link.find(id: 'sdfsdf234')
+```
+
+You can also search for multiple accounts matching a specific criteria with **find_all**:
+
+```ruby
+require 'fintoc'
+
+client = Fintoc::Client.new('api_key')
+link = client.get_link('link_token')
+accounts = link.find_all(currency: 'CLP')
+```
+
+To update the account balance you can use **update_balance**:
+
+```ruby
+require 'fintoc'
+
+client = Fintoc::Client.new('api_key')
+link = client.get_link('link_token')
+account = link.find(number: '1111111')
+account.update_balance
+```
+
+### Get movements
+
+```ruby
+require 'fintoc'
+require 'time'
+
+client = Fintoc::Client.new('api_key')
+link = client.get_link('link_token')
+account = link.find(type: 'checking_account')
+
+# You can get the account movements since a specific DateTime
+yesterday = DateTime.now - 1
+account.get_movements(since: yesterday)
+
+# Or you can use an ISO 8601 formatted string representation of the Date
+account.get_movements(since: '2020-01-01')
+
+# You can also set how many movements you want per_page
+account.get_movements(since: '2020-01-01', per_page: 100)
+```
+
+Calling **get_movements** without arguments gets the last 30 movements of the account
+
+## Dependencies
+
+This project relies on the following packages:
+
+- [**http.rb**](https://github.com/httprb/http)
+- [**tabulate**](https://github.com/roylez/tabulate)
+
+## How to test…
+
+You can run all the tests just by running:
+
+```
+rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fintoc-com/fintoc.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fintoc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fintoc.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/fintoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fintoc'
+  spec.version       = Fintoc::VERSION
+  spec.authors       = ['Juan Ca Sardin']
+  spec.email         = ['juan.carlos.sardin@gmail.com']
+
+  spec.summary       = 'The official Ruby client for the Fintoc API.'
+  spec.description   = 'The official Ruby client for the Fintoc API.'
+  spec.homepage      = 'https://github.com/fintoc-com/fintoc-ruby'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fintoc-com/fintoc-ruby'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'http'
+  spec.add_dependency 'tabulate'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.81.0'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/lib/fintoc.rb

@@ -0,0 +1,6 @@
+require 'fintoc/version'
+require 'fintoc/errors'
+require 'fintoc/client'
+
+module Fintoc
+end

data/lib/fintoc/client.rb

@@ -0,0 +1,149 @@
+require 'http'
+require 'fintoc/utils'
+require 'fintoc/errors'
+require 'fintoc/resources/link'
+require 'fintoc/constants'
+require 'fintoc/version'
+require 'json'
+
+module Fintoc
+  class Client
+    include Utils
+    def initialize(api_key)
+      @api_key = api_key
+      @user_agent = "fintoc-ruby/#{Fintoc::VERSION}"
+      @headers = { "Authorization": @api_key, "User-Agent": @user_agent }
+      @link_headers = nil
+      @link_header_pattern = '<(?<url>.*)>;\s*rel="(?<rel>.*)"'
+      @default_params = {}
+    end
+
+    def get
+      request('get')
+    end
+
+    def delete
+      request('delete')
+    end
+
+    def request(method)
+      proc do |resource, **kwargs|
+        parameters = params(method, **kwargs)
+        response = make_request(method, resource, parameters)
+        content = JSON.parse(response.body, symbolize_names: true)
+
+        if response.status.client_error? || response.status.server_error?
+          raise_custom_error(content[:error])
+        end
+
+        @link_headers = response.headers.get('link')
+        content
+      end
+    end
+
+    def fetch_next
+      next_ = link_headers['next']
+      Enumerator.new do |yielder|
+        while next_
+          yielder << get.call(next_)
+          next_ = link_headers['next']
+        end
+      end
+    end
+
+    def get_link(link_token)
+      data = { **_get_link(link_token), "link_token": link_token }
+      build_link(data)
+    end
+
+    def get_links
+      _get_links.map { |data| build_link(data) }
+    end
+
+    def delete_link(link_id)
+      delete.call("links/#{link_id}")
+    end
+
+    def get_account(link_token, account_id)
+      get_link(link_token).find(id: account_id)
+    end
+
+    def to_s
+      visible_chars = 4
+      hidden_part = '*' * (@api_key.size - visible_chars)
+      visible_key = @api_key.slice(0, visible_chars)
+      "Client(🔑=#{hidden_part + visible_key}"
+    end
+
+    private
+
+    def client
+      @client ||= HTTP.headers(@headers)
+    end
+
+    def parse_headers(dict, link)
+      matches = link.strip.match(@link_header_pattern)
+      dict[matches[:rel]] = matches[:url]
+      dict
+    end
+
+    def _get_link(link_token)
+      get.call("links/#{link_token}")
+    end
+
+    def _get_links
+      get.call('links')
+    end
+
+    def build_link(data)
+      param = Utils.pick(data, 'link_token')
+      @default_params.update(param)
+      Link.new(**data, client: self)
+    end
+
+    def make_request(method, resource, parameters)
+      # this is to handle url returned in the link headers
+      # I'm sure there is a better and more clever way to solve this
+      if resource.start_with? 'https'
+        client.send(method, resource)
+      else
+        url = "#{Fintoc::Constants::SCHEME}#{Fintoc::Constants::BASE_URL}#{resource}"
+        client.send(method, url, parameters)
+      end
+    end
+
+    def params(method, **kwargs)
+      if method == 'get'
+        { params: { **@default_params, **kwargs } }
+      else
+        { json: { **@default_params, **kwargs } }
+      end
+    end
+
+    def raise_custom_error(error)
+      raise error_class(error[:code]).new(error[:message], error[:doc_url])
+    end
+
+    def error_class(snake_code)
+      pascal_klass_name = Utils.snake_to_pascal(snake_code)
+      # this conditional klass_name is to handle InternalServerError custom error class
+      # without this the error class name would be like InternalServerErrorError (^-^)
+      klass = pascal_klass_name.end_with?('Error') ? pascal_klass_name : "#{pascal_klass_name}Error"
+      Module.const_get("Fintoc::Errors::#{klass}")
+    end
+
+    # This attribute getter parses the link headers using some regex 24K magic in the air...
+    # Ex.
+    # <https://api.fintoc.com/v1/links?page=1>; rel="first", <https://api.fintoc.com/v1/links?page=1>; rel="last"
+    # this helps to handle pagination see: https://fintoc.com/docs#paginacion
+    # return a hash like { first:"https://api.fintoc.com/v1/links?page=1" }
+    #
+    # @param link_headers [String]
+    # @return [Hash]
+    def link_headers
+      return if @link_headers.nil?
+
+      @link_headers[0].split(',').reduce({}) { |dict, link| parse_headers(dict, link) }
+    end
+  end
+end