bankin-api-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db78af9475eadffd4121bc1abf54c950df99b9be
+  data.tar.gz: 6bf8d6f6791b6361e8d2e2d76f3aacb4308ba0b1
+SHA512:
+  metadata.gz: a41d3d670a410dde6873ccb8f348ef3dfc5c3056d0f80408360fb3b88465c3a34a810f24c413182d9aebce2959e7933467dacc2b4fc9de8ef13435e486e721b4
+  data.tar.gz: e51b1c9b4549c9acb978c36c2a502f2280e251cbbed02f3a2d24b5e7b0511083a886b888dbd1d1739b0ff2c62dffbcd4d23cd6e1d3c92fe9c4613ae04d5826bb

data/.circleci/config.yml

@@ -0,0 +1,40 @@
+version: 2.1
+
+executors:
+  gem-executor:
+    working_directory: ~/tmp/gem
+    docker:
+      - image: circleci/ruby:2.4.1
+    environment:
+      TZ: "Europe/Madrid"
+
+jobs:
+  build-test-gem:
+    executor: gem-executor
+    steps:
+      - checkout
+
+      - run:
+          name: Update bundler
+          command: gem install bundler
+
+      - restore_cache:
+          keys:
+            - bankin-api-ruby-bundle-v2-{{ checksum "Gemfile.lock" }}
+            - bankin-api-ruby-bundle-v2-
+
+      - run: bundle install
+
+      - save_cache:
+          key: bankin-api-ruby-bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: RAILS_ENV=test bundle exec rspec spec/
+
+workflows:
+  build-test-gem:
+    jobs:
+      - build-test-gem

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    bankin-api-ruby (1.0.0)
+      rest-client (~> 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    netrc (0.11.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    safe_yaml (1.0.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bankin-api-ruby!
+  bundler
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 2.3.1)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,9 @@
+# Bankin
+
+Ruby client for the Bankin' API (aka Bridge API)
+
+Changelog
+---------
+
+* v.1.0.0 Updated for API 2018-06-15 (with breaking changes) & added opt-in request logging
+* v.0.1.2 Working Ruby wrapper for API 2018-06-15 with support for the `Account`, `Bank`, `Item`, `Transaction` and `User` resources

data/Rakefile

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

data/bankin.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bankin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bankin-api-ruby"
+  spec.version       = Bankin::VERSION
+  spec.authors       = ["Maxim Novichenko", "Albert Bellonch"]
+  spec.email         = ["maxim@getquipu.com"]
+
+  spec.summary       = "Ruby client for the Bankin' API"
+  spec.homepage      = "https://getquipu.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "rest-client", "~> 2.0.2"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3.1"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bankin"
+
+# 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

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/lib/bankin.rb

@@ -0,0 +1,12 @@
+require 'bankin/version'
+require 'bankin/configuration'
+require 'bankin/base'
+require 'bankin/error'
+require 'bankin/resource'
+require 'bankin/collection'
+
+require 'bankin/resources/bank'
+require 'bankin/resources/user'
+require 'bankin/resources/item'
+require 'bankin/resources/account'
+require 'bankin/resources/transaction'

data/lib/bankin/base.rb

@@ -0,0 +1,77 @@
+require 'rest-client'
+require 'json'
+
+module Bankin
+  BASE_URL = 'https://sync.bankin.com'
+  API_VERSION = '2018-06-15'
+  RATELIMIT_FIELDS = %w(limit remaining reset)
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def rate_limits
+      @rate_limits ||= Hash[RATELIMIT_FIELDS.map { |f| [f, nil] }]
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def api_call(method, path, params = {}, token = nil)
+      url = Bankin.const_get(:BASE_URL) + path
+
+      log_message("#{method.upcase} #{url}")
+      params.each do |k, v|
+        next if k =~ /password/
+
+        log_message("* #{k}: #{v}")
+      end
+
+      request_params = {
+        method: method,
+        url: url,
+        headers: {
+          'Bankin-Version': Bankin.const_get(:API_VERSION),
+          params: {
+            client_id: Bankin.configuration.client_id,
+            client_secret: Bankin.configuration.client_secret
+          }.merge(params)
+        }
+      }
+      request_params[:headers][:Authorization] = "Bearer #{token}" if token
+
+      begin
+        response = RestClient::Request.execute(request_params)
+        set_rate_limits(response.headers)
+
+        return {} if response.empty?
+        data = JSON.parse(response)
+        return data
+      rescue StandardError => e
+        response = JSON.parse(e.response)
+        raise Error.new(response['type'], response['message'])
+      end
+    end
+
+    def set_rate_limits(headers)
+      @rate_limits ||= {}
+
+      RATELIMIT_FIELDS.each do |field|
+        @rate_limits[field] = headers["ratelimit_#{field}".to_sym]
+      end
+    end
+
+    def log_message(msg)
+      return if msg.nil? || msg.empty?
+
+      logger = Bankin.configuration.logger
+      return if logger.nil?
+
+      logger.info(msg)
+    end
+  end
+end

data/lib/bankin/collection.rb

@@ -0,0 +1,54 @@
+module Bankin
+  class Collection < Array
+    def initialize(response, item_class, token = nil)
+      @item_class = item_class
+      @token = token
+      populate!(response, item_class)
+    end
+
+    def next_page?
+      !@next_page_uri.nil?
+    end
+
+    def previous_page?
+      !@previous_page_uri.nil?
+    end
+
+    def next_page!
+      return unless next_page?
+
+      uri = URI.parse(@next_page_uri)
+      params = if uri.query
+                 Hash[URI::decode_www_form(uri.query)]
+               else
+                 {}
+               end
+
+      response = Bankin.api_call(:get, uri.path, params, @token)
+      populate!(response, @item_class)
+      self
+    end
+
+    def load_all!
+      while next_page? do
+        next_page!
+      end
+      self
+    end
+
+    private
+
+    def populate!(response, item_klass)
+      response['resources'].each do |item|
+        self << item_klass.new(item, @token)
+      end
+
+      set_pagination(response['pagination'])
+    end
+
+    def set_pagination(pagination_data)
+      @next_page_uri = pagination_data['next_uri']
+      @previous_page_uri = pagination_data['previous_uri']
+    end
+  end
+end

data/lib/bankin/configuration.rb

@@ -0,0 +1,5 @@
+module Bankin
+  class Configuration
+    attr_accessor :client_id, :client_secret, :logger
+  end
+end

data/lib/bankin/error.rb

@@ -0,0 +1,10 @@
+module Bankin
+  class Error < StandardError
+    attr_reader :message, :type
+
+    def initialize(type, message)
+      @type = type
+      @message = message
+    end
+  end
+end

data/lib/bankin/resource.rb

@@ -0,0 +1,101 @@
+module Bankin
+  class Resource
+    def initialize(data, token = nil)
+      @token = token
+      generate_attr_readers
+      set_data(data)
+    end
+
+    def fields
+      self.class.fields
+    end
+
+    def resources
+      self.class.resources
+    end
+
+    def collections
+      self.class.collections
+    end
+
+    private
+
+    def generate_attr_readers
+      fields.each do |field|
+        define_singleton_method(field) do
+          load_data! if instance_variable_get("@#{field}").nil?
+          instance_variable_get("@#{field}")
+        end
+      end
+
+      (resources + collections).each do |resource|
+        define_singleton_method(resource[:name]) do
+          load_data! if instance_variable_get("@#{resource[:name]}").nil?
+          instance_variable_get("@#{resource[:name]}")
+        end
+      end
+    end
+
+    def set_data(data)
+      fields.each do |field|
+        next unless data.key?(field.to_s)
+        instance_variable_set("@#{field}", data[field.to_s])
+      end
+
+      resources.each do |resource|
+        next unless data.key?(resource[:name].to_s)
+        klass = Object.const_get("Bankin::#{resource[:klass]}")
+        instance_variable_set("@#{resource[:name]}", klass.new(data[resource[:name].to_s], @token))
+      end
+
+      collections.each do |collection|
+        next unless data[collection[:name].to_s]
+        klass = Object.const_get("Bankin::#{collection[:klass]}")
+        arr = data[collection[:name].to_s].map { |item | klass.new(item, @token) }
+        instance_variable_set("@#{collection[:name]}", arr)
+        instance_variable_set("@#{collection[:name]}_ids", arr.map(&:id))
+      end
+    end
+
+    def load_data!
+      return if @loaded
+      response = Bankin.api_call(:get, @resource_uri, {}, @token)
+      set_data(response)
+      @loaded = true
+    end
+
+    class << self
+      def fields
+        @fields || [:resource_type, :resource_uri]
+      end
+
+      def resources
+        @resources || []
+      end
+
+      def collections
+        @collections || []
+      end
+
+      def auth_delegate(name, options)
+        define_method(name) do |*args|
+          klass = Object.const_get("Bankin::#{options[:class]}")
+          klass.send(options[:method], self.token, *args)
+        end
+      end
+
+      def has_fields(*new_fields)
+        @fields = (fields + new_fields).uniq
+      end
+
+      def has_resource(name, klass)
+        @resources = resources << { name: name, klass: klass }
+      end
+
+      def has_collection(name, klass)
+        @collections = collections << { name: name, klass: klass }
+        attr_reader :"#{name}_ids"
+      end
+    end
+  end
+end

data/lib/bankin/resources/account.rb

@@ -0,0 +1,20 @@
+module Bankin
+  class Account < Resource
+    RESOURCE_PATH = '/v2/accounts'
+
+    has_fields :id, :name, :balance, :currency_code, :status, :type, :last_refresh_date
+
+    has_resource :bank, 'Bank'
+    has_resource :item, 'Item'
+
+    def self.list(token, options = {})
+      response = Bankin.api_call(:get, RESOURCE_PATH, options, token)
+      Collection.new(response, self, token)
+    end
+
+    def self.get(token, id)
+      response = Bankin.api_call(:get, "#{RESOURCE_PATH}/#{id}", {}, token)
+      new(response, token)
+    end
+  end
+end

data/lib/bankin/resources/bank.rb

@@ -0,0 +1,29 @@
+module Bankin
+  class Bank < Resource
+    RESOURCE_PATH = '/v2/banks'
+
+    has_fields :id, :name, :automatic_refresh, :country_code
+
+    def self.list(options = {})
+      response = Bankin.api_call(:get, RESOURCE_PATH, options)
+      Collection.new(flatten_list(response), self)
+    end
+
+    def self.get(id)
+      response = Bankin.api_call(:get, "#{RESOURCE_PATH}/#{id}")
+      new(response)
+    end
+
+    private
+
+    def self.flatten_list(response)
+      response["resources"] = response["resources"].map do |country_banks|
+        country_banks["parent_banks"].map do |entity_banks|
+          entity_banks["banks"]
+        end.flatten
+      end.flatten
+
+      response
+    end
+  end
+end

data/lib/bankin/resources/item.rb

@@ -0,0 +1,68 @@
+module Bankin
+  class Item < Resource
+    RESOURCE_PATH = '/v2/items'
+
+    has_fields :id, :status
+
+    has_resource :bank, 'Bank'
+    has_collection :accounts, 'Account'
+
+    def delete
+      Bankin.api_call(:delete, resource_uri, {}, @token)
+    end
+
+    def refresh
+      Bankin.api_call(:post, "#{resource_uri}/refresh", {}, @token)
+    end
+
+    def refresh_status
+      Bankin.api_call(:get, "#{resource_uri}/refresh/status", {}, @token)
+    end
+
+    def edit_url
+      Bankin.api_call(
+        :get,
+        "/v2/connect/items/edit/url",
+        { item_id: id },
+        @token
+      )['redirect_url']
+    end
+
+    def fill_in_otp_url
+      Bankin.api_call(
+        :get,
+        "/v2/connect/items/sync?item_id=#{id}",
+        {},
+        @token
+      )['redirect_url']
+    end
+
+    def self.add_url(token, redirect_url, params)
+      Bankin.api_call(
+        :get,
+        "/v2/connect/items/add/url",
+        params.merge(redirect_url: redirect_url),
+        token
+      )['redirect_url']
+    end
+
+    def self.pro_confirmation_url(token)
+      Bankin.api_call(
+        :get,
+        "/v2/connect/items/pro/confirmation/url",
+        {},
+        token
+      )['redirect_url']
+    end
+
+    def self.list(token, options = {})
+      response = Bankin.api_call(:get, RESOURCE_PATH, options, token)
+      Collection.new(response, self, token)
+    end
+
+    def self.get(token, id)
+      response = Bankin.api_call(:get, "#{RESOURCE_PATH}/#{id}", {}, token)
+      new(response, token)
+    end
+  end
+end

data/lib/bankin/resources/transaction.rb

@@ -0,0 +1,25 @@
+module Bankin
+  class Transaction < Resource
+    RESOURCE_PATH = '/v2/transactions'
+
+    has_fields :id, :description, :raw_description, :amount, :date,
+      :updated_at, :currency_code, :is_deleted
+
+    has_resource :account, 'Account'
+
+    def self.list(token, options = {})
+      response = Bankin.api_call(:get, RESOURCE_PATH, options, token)
+      Collection.new(response, self, token)
+    end
+
+    def self.list_updated(token, options = {})
+      response = Bankin.api_call(:get, "#{RESOURCE_PATH}/updated", options, token)
+      Collection.new(response, self, token)
+    end
+
+    def self.get(token, id)
+      response = Bankin.api_call(:get, "#{RESOURCE_PATH}/#{id}", {}, token)
+      new(response, token)
+    end
+  end
+end

data/lib/bankin/resources/user.rb

@@ -0,0 +1,57 @@
+module Bankin
+  class User < Resource
+    attr_accessor :token
+
+    RESOURCE_PATH = '/v2/users'
+
+    has_fields :uuid, :email
+
+    auth_delegate :items, class: 'Item', method: :list
+    auth_delegate :item, class: 'Item', method: :get
+    auth_delegate :accounts, class: 'Account', method: :list
+    auth_delegate :account, class: 'Account', method: :get
+    auth_delegate :updated_transactions, class: 'Transaction', method: :list_updated
+    auth_delegate :transactions, class: 'Transaction', method: :list
+    auth_delegate :transaction, class: 'Transaction', method: :get
+
+    def delete(password)
+      Bankin.api_call(:delete, resource_uri, { password: password })
+    end
+
+    def add_item_url(redirect_url = nil, params = {})
+      authenticate if token.nil?
+      Item.add_url(token, redirect_url, params)
+    end
+
+    def item_connect_url(bank_id, redirect_url = nil)
+      Item.connect_url(token, bank_id, redirect_url)
+    end
+
+    def pro_confirmation_url
+      Item.pro_confirmation_url(token)
+    end
+
+    def self.list(options = {})
+      response = Bankin.api_call(:get, RESOURCE_PATH, options)
+      Collection.new(response, self)
+    end
+
+    def self.delete_all
+      Bankin.api_call(:delete, RESOURCE_PATH)
+    end
+
+    def self.create(email, password)
+      response = Bankin.api_call(:post, RESOURCE_PATH,
+        { email: email, password: password })
+      new(response)
+    end
+
+    def self.authenticate(email, password)
+      response = Bankin.api_call(:post, '/v2/authenticate',
+        { email: email, password: password })
+      user = new(response['user'])
+      user.token = response['access_token']
+      user
+    end
+  end
+end

data/lib/bankin/version.rb

@@ -0,0 +1,3 @@
+module Bankin
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: bankin-api-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maxim Novichenko
+- Albert Bellonch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+description: 
+email:
+- maxim@getquipu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bankin.gemspec
+- bin/console
+- bin/setup
+- lib/bankin.rb
+- lib/bankin/base.rb
+- lib/bankin/collection.rb
+- lib/bankin/configuration.rb
+- lib/bankin/error.rb
+- lib/bankin/resource.rb
+- lib/bankin/resources/account.rb
+- lib/bankin/resources/bank.rb
+- lib/bankin/resources/item.rb
+- lib/bankin/resources/transaction.rb
+- lib/bankin/resources/user.rb
+- lib/bankin/version.rb
+homepage: https://getquipu.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Bankin' API
+test_files: []