afterbanks-api-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fa27b556d79a7825b09d17c10a21f9c554d1b05
+  data.tar.gz: a32e2b93047687dc1f97fabb398ebff542863ba4
+SHA512:
+  metadata.gz: 85b9193d0c31773f937f5915cd23a6a4a4979173a010f643e21e06664db4ea7b6d918ddf06aca5daa65908b5391e2d269830ed099865bb54efad2f7e195199d0
+  data.tar.gz: 8b7bbbf76fbbde4cab9439d4c7266a4d547cb9ab5b2094457549b9dc370a70c1568bb80551ce1996f00abaf953db41cd0e0cda955b5a062f3e400210b8bfc946

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 -v 1.17.3
+
+      - restore_cache:
+          keys:
+            - afterbanks-api-ruby-bundle-v2-{{ checksum "Gemfile.lock" }}
+            - afterbanks-api-ruby-bundle-v2-
+
+      - run: bundle install
+
+      - save_cache:
+          key: afterbanks-api-ruby-bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: bundle exec rspec spec/
+
+workflows:
+  build-test-gem:
+    jobs:
+      - build-test-gem

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

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 afterbanks.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    afterbanks-api-ruby (0.1.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.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    netrc (0.11.0)
+    public_suffix (4.0.1)
+    rake (13.0.1)
+    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)
+    timecop (0.9.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  afterbanks-api-ruby!
+  bundler
+  rake
+  rspec
+  timecop
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,48 @@
+# Ruby client for Afterbanks API
+
+[![CircleCI](https://circleci.com/gh/quipuapp/afterbanks-api-ruby.svg?style=shield)](https://circleci.com/gh/quipuapp/afterbanks-api-ruby)
+
+This is a Ruby client for the Afterbanks' API
+
+Changelog
+---------
+
+* v.0.1.0 First vull version, including resource wrapping (for banks, accounts, transactions and the user) and separate exceptions for each different code.
+
+Installation
+---------
+
+Install the gem (`gem install afterbanks-api-ruby`) or include it in your Gemfile and `bundle`.
+
+Configuration
+---------
+
+Just set the service key by doing this:
+
+```ruby
+Afterbanks.servicekey = 'yourservicekey'
+```
+
+Or, if you use it in a Rails application, create an initializer with this content:
+
+```ruby
+require 'afterbanks'
+
+Afterbanks.configure do |config|
+  config.servicekey = 'yourservicekey'
+end
+```
+
+You can set a `logger` as well.
+
+TODO
+----
+
+* Full usage for each resource
+* Proper explanation of the `Afterbanks:Error` and its subclasses
+
+About Afterbanks
+------------
+
+* [Public site](https://www.afterbanks.com)
+* [Documentation](https://app.swaggerhub.com/apis/Afterbanks/afterbanks-api-extendida)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/afterbanks.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'afterbanks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "afterbanks-api-ruby"
+  spec.version       = Afterbanks::VERSION
+  spec.authors       = ["Albert Bellonch"]
+  spec.email         = ["albert@getquipu.com"]
+
+  spec.summary       = "Ruby client for the Afterbanks' 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"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "webmock"
+end

data/lib/afterbanks.rb

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

data/lib/afterbanks/base.rb

@@ -0,0 +1,128 @@
+require 'rest-client'
+require 'json'
+
+module Afterbanks
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def api_call(method:, path:, params: {})
+      url = 'https://api.afterbanks.com' + path
+
+      request_params = { method: method, url: url }
+
+      if method == :post
+        request_params.merge!(payload: params)
+      else
+        request_params.merge!(headers: { params: params })
+      end
+
+      response = begin
+        RestClient::Request.execute(request_params)
+      rescue RestClient::BadRequest, RestClient::ExpectationFailed => bad_request
+        bad_request.response
+      end
+
+      debug_id = response.headers[:debug_id]
+
+      log_request(
+        method: method,
+        url: url,
+        params: params,
+        debug_id: debug_id
+      )
+
+      response_body = JSON.parse(response.body)
+
+      treat_errors_if_any(
+        response_body: response_body,
+        debug_id: debug_id
+      )
+
+      [response_body, debug_id]
+    end
+
+    def log_request(method:, url:, params: {}, debug_id: nil)
+      now = Time.now
+
+      log_message(message: "")
+      log_message(message: "=> #{method.upcase} #{url}")
+
+      log_message(message: "* Time: #{now}")
+      log_message(message: "* Timestamp: #{now.to_i}")
+      log_message(message: "* Debug ID: #{debug_id || 'none'}")
+
+      if params.any?
+        log_message(message: "* Params")
+        params.each do |key, value|
+          safe_value = if %w{servicekey user pass pass2}.include?(key.to_s)
+                         "<masked>"
+                       else
+                         value
+                       end
+
+          log_message(message: "#{key}: #{safe_value}")
+        end
+      else
+        log_message(message: "* No params")
+      end
+    end
+
+    def log_message(message: nil)
+      return if message.nil?
+
+      logger = Afterbanks.configuration.logger
+      return if logger.nil?
+
+      logger.info(message)
+    end
+
+    private
+
+    def treat_errors_if_any(response_body:, debug_id:)
+      return unless response_body.is_a?(Hash)
+
+      code = response_body['code']
+      message = response_body['message']
+      additional_info = response_body['additional_info']
+
+      error_info = { message: message, debug_id: debug_id }
+
+      case code
+      when 1
+        raise GenericError.new(error_info)
+      when 2
+        raise ServiceUnavailableTemporarilyError.new(error_info)
+      when 3
+        raise ConnectionDataError.new(error_info)
+      when 4
+        raise AccountIdDoesNotExistError.new(error_info)
+      when 5
+        raise CutConnectionError.new(error_info)
+      when 6
+        raise HumanActionNeededError.new(error_info)
+      when 50
+        unless additional_info
+          raise MissingParameterError.new(error_info)
+        end
+
+        error_info.merge!(additional_info: additional_info)
+
+        if additional_info['session_id']
+          raise TwoStepAuthenticationError.new(error_info)
+        else
+          raise AccountIdNeededError.new(error_info)
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/afterbanks/collection.rb

@@ -0,0 +1,9 @@
+module Afterbanks
+  class Collection < Array
+    def initialize(response, item_klass)
+      response.each do |item|
+        self << item_klass.new(item)
+      end
+    end
+  end
+end

data/lib/afterbanks/configuration.rb

@@ -0,0 +1,5 @@
+module Afterbanks
+  class Configuration
+    attr_accessor :servicekey, :logger
+  end
+end

data/lib/afterbanks/error.rb

@@ -0,0 +1,69 @@
+module Afterbanks
+  class Error < ::StandardError
+    attr_reader :message, :debug_id, :additional_info
+
+    def initialize(message:, debug_id:, additional_info: nil)
+      @message = message
+      @debug_id = debug_id
+      @additional_info = additional_info
+    end
+
+    def code
+      raise 'Not implemented'
+    end
+  end
+
+  class GenericError < Error
+    def code
+      1
+    end
+  end
+
+  class ServiceUnavailableTemporarilyError < Error
+    def code
+      2
+    end
+  end
+
+  class ConnectionDataError < Error
+    def code
+      3
+    end
+  end
+
+  class AccountIdDoesNotExistError < Error
+    def code
+      4
+    end
+  end
+
+  class CutConnectionError < Error
+    def code
+      5
+    end
+  end
+
+  class HumanActionNeededError < Error
+    def code
+      6
+    end
+  end
+
+  class AccountIdNeededError < Error
+    def code
+      50
+    end
+  end
+
+  class TwoStepAuthenticationError < Error
+    def code
+      50
+    end
+  end
+
+  class MissingParameterError < Error
+    def code
+      50
+    end
+  end
+end

data/lib/afterbanks/resource.rb

@@ -0,0 +1,77 @@
+module Afterbanks
+  class Resource
+    def initialize(data)
+      generate_attr_readers
+      set_data(data)
+    end
+
+    def fields_information
+      self.class.fields_information
+    end
+
+    private
+
+    def generate_attr_readers
+      fields_information.each do |field, _|
+        define_singleton_method(field) do
+          instance_variable_get("@#{field}")
+        end
+      end
+    end
+
+    def set_data(data)
+      fields_information.each do |field, type|
+        next unless data.key?(field.to_s) || data[field.to_sym]
+
+        raw_value = data[field.to_s] || data[field.to_sym]
+        value = value_for(raw_value, type)
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def value_for(raw_value, type)
+      case type
+      when :boolean
+        [true, "1", 1].include?(raw_value)
+      when :date
+        if raw_value.is_a?(Date)
+          raw_value
+        else
+          Date.parse(raw_value)
+        end
+      else
+        raw_value
+      end
+    end
+
+    def marshal_dump
+      dump = {}
+
+      fields_information.each do |field, _|
+        dump[field] = send(field)
+      end
+
+      dump
+    end
+
+    def marshal_load(serialized_resource)
+      keys = serialized_resource.keys
+
+      keys.each do |key|
+        serialized_resource[key.to_s] = serialized_resource.delete(key)
+      end
+
+      initialize(serialized_resource)
+    end
+
+    class << self
+      def fields_information
+        @fields_information
+      end
+
+      def has_fields(fields_information)
+        @fields_information = fields_information
+      end
+    end
+  end
+end

data/lib/afterbanks/resources/account.rb

@@ -0,0 +1,61 @@
+module Afterbanks
+  class Account < Resource
+    has_fields service: :string,
+               product: :string,
+               type: :string,
+               balance: :decimal,
+               currency: :string,
+               description: :string,
+               iban: :string,
+               is_owner: :boolean,
+               holders: :hash
+
+    def self.list(service:, username:, password:, password2: nil,
+                  document_type: nil, session_id: nil, otp: nil, counter_id: nil)
+
+      params = {
+        servicekey: Afterbanks.configuration.servicekey,
+        service: service,
+        user: username,
+        pass: password,
+        products: 'GLOBAL'
+      }
+
+      params.merge!(pass2: password2) unless password2.nil?
+      params.merge!(documentType: document_type) unless document_type.nil?
+      params.merge!(session_id: session_id) unless session_id.nil?
+      params.merge!(OTP: otp) unless otp.nil?
+      params.merge!(counterId: counter_id) unless counter_id.nil?
+
+      response, debug_id = Afterbanks.api_call(
+        method: :post,
+        path: '/V3/',
+        params: params
+      )
+
+      Response.new(
+        result: Collection.new(
+          accounts_information_for(
+            response: response,
+            service: service
+          ),
+          self
+        ),
+        debug_id: debug_id
+      )
+    end
+
+    private
+
+    def self.accounts_information_for(response:, service:)
+      accounts_information = []
+
+      response.each do |account_information|
+        account_information['service'] = service
+        accounts_information << account_information
+      end
+
+      accounts_information
+    end
+  end
+end

data/lib/afterbanks/resources/bank.rb

@@ -0,0 +1,60 @@
+module Afterbanks
+  class Bank < Resource
+    has_fields country_code: :string,
+               service: :string,
+               swift: :string,
+               fullname: :string,
+               business: :boolean,
+               documenttype: :string,
+               user: :string,
+               pass: :string,
+               pass2: :string,
+               userdesc: :string,
+               passdesc: :string,
+               pass2desc: :string,
+               usertype: :string,
+               passtype: :string,
+               pass2type: :string,
+               image: :string,
+               color: :string
+
+    def self.list(ordered: false)
+      response, debug_id = Afterbanks.api_call(
+        method: :get,
+        path: '/forms/'
+      )
+
+      if ordered
+        response.sort! do |bank1, bank2|
+          bank1['fullname'].downcase <=> bank2['fullname'].downcase
+        end
+      end
+
+      Response.new(
+        result: Collection.new(
+          banks_information_for(
+            response: response
+          ),
+          self
+        ),
+        debug_id: debug_id
+      )
+    end
+
+    private
+
+    def self.banks_information_for(response:)
+      banks_information = []
+
+      response.each do |bank_information|
+        if bank_information['business'] == "1"
+          bank_information['fullname'] += " Empresas"
+        end
+
+        banks_information << bank_information
+      end
+
+      banks_information
+    end
+  end
+end

data/lib/afterbanks/resources/transaction.rb

@@ -0,0 +1,76 @@
+module Afterbanks
+  class Transaction < Resource
+    has_fields service: :string,
+               product: :string,
+               date: :date,
+               date2: :date,
+               amount: :decimal,
+               description: :string,
+               balance: :decimal,
+               transactionId: :string,
+               categoryId: :integer
+
+    def self.list(service:, username:, password:, password2: nil,
+                  document_type: nil, products:, startdate:,
+                  session_id: nil, otp: nil, counter_id: nil)
+
+      params = {
+        servicekey: Afterbanks.configuration.servicekey,
+        service: service,
+        user: username,
+        pass: password,
+        products: products,
+        startdate: startdate.strftime("%d-%m-%Y")
+      }
+
+      params.merge!(pass2: password2) unless password2.nil?
+      params.merge!(documentType: document_type) unless document_type.nil?
+      params.merge!(session_id: session_id) unless session_id.nil?
+      params.merge!(OTP: otp) unless otp.nil?
+      params.merge!(counterId: counter_id) unless counter_id.nil?
+
+      response, debug_id = Afterbanks.api_call(
+        method: :post,
+        path: '/V3/',
+        params: params
+      )
+
+      Response.new(
+        result: Collection.new(
+          transactions_information_for(
+            service: service,
+            response: response,
+            products: products
+          ),
+          self
+        ),
+        debug_id: debug_id
+      )
+    end
+
+    private
+
+    def self.transactions_information_for(response:, service:, products:)
+      transactions_information = []
+      products_array = products.split(",")
+
+      response.each do |account_information|
+        product = account_information['product']
+
+        if products_array.include?(product)
+          transactions = account_information['transactions']
+          next if transactions.nil?
+
+          transactions.each do |transaction|
+            transaction['service'] = service
+            transaction['product'] = product
+          end
+
+          transactions_information += transactions
+        end
+      end
+
+      transactions_information
+    end
+  end
+end

data/lib/afterbanks/resources/user.rb

@@ -0,0 +1,24 @@
+module Afterbanks
+  class User < Resource
+    has_fields limit: :integer,
+               counter: :integer,
+               remaining_calls: :integer,
+               date_renewal: :date,
+               detail: :string
+
+    def self.get
+      response, debug_id = Afterbanks.api_call(
+        method: :post,
+        path: '/me/',
+        params: {
+          servicekey: Afterbanks.configuration.servicekey
+        }
+      )
+
+      Response.new(
+        result: new(response),
+        debug_id: debug_id
+      )
+    end
+  end
+end

data/lib/afterbanks/response.rb

@@ -0,0 +1,10 @@
+module Afterbanks
+  class Response
+    attr_accessor :result, :debug_id
+
+    def initialize(result:, debug_id:)
+      @result = result
+      @debug_id = debug_id
+    end
+  end
+end

data/lib/afterbanks/version.rb

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: afterbanks-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Albert Bellonch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-28 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: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 
+email:
+- albert@getquipu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- afterbanks.gemspec
+- lib/afterbanks.rb
+- lib/afterbanks/base.rb
+- lib/afterbanks/collection.rb
+- lib/afterbanks/configuration.rb
+- lib/afterbanks/error.rb
+- lib/afterbanks/resource.rb
+- lib/afterbanks/resources/account.rb
+- lib/afterbanks/resources/bank.rb
+- lib/afterbanks/resources/transaction.rb
+- lib/afterbanks/resources/user.rb
+- lib/afterbanks/response.rb
+- lib/afterbanks/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 Afterbanks' API
+test_files: []