biro 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 135d5ac51a23bb35aca3360514eddf2e521c0e51
+  data.tar.gz: 21c7baa69660e28d4dcd9517ae053d1b2477943a
+SHA512:
+  metadata.gz: 7f5663620edd64e7966c6e6d90f76b931c403f2d653d75bdd450d3bd4b9c4f62becfe5b10b986eab7c775b93ac3e0896e541cb497ede07b3e74aa68341b0df7f
+  data.tar.gz: 19132771a0be56c500cd6cd1991f6df3dcbb2a64a3580b50bec40c694ede1f2e271bfbd549878623c0a6bcf8f85ee5ad984339ab7bebb49e533105fb882db64a

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Noverde
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Noverde
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Biro
+
+DISCLAIMER: This library is currently in alpha and under active development.
+
+Biro is an extraction from the [Noverde](https://www.noverde.com.br) credit analysis system. Noverde's requirements for a simple and unified
+API to access different credit bureaus (pronounced "Birô" in brazilian portuguese) and others third parties systems was the main motivation to
+build this library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'biro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install biro
+
+## Usage
+
+```ruby
+require 'biro'
+
+# Configure the gateway provider
+Biro.configure do |config|
+  config.gateway :spc, username: 'myusername', password: 'mypassword'
+end
+
+# Use the gateway provider to fetch user data (the attributes are explained below)
+response = Biro.gateways[:spc].find('99353932750', 'F', 495)
+
+# Use the return data
+response[:resultado][:consumidor] # => should return the person data
+```
+
+## Gateways
+
+### [SPC](https://www.spcbrasil.org.br)
+```ruby
+Biro.configure do |config|
+  config.gateway :spc, username: 'myusername', password: 'mypassword'
+end
+```
+
+#### display_products
+This method wraps the "listarProdutos" from the SOAP API. You need this method to get the **product code**.
+```ruby
+ Biro.gateways[:spc].display_products
+```
+
+#### find(document, kind, product_code, options = {})
+This method wraps the "consultar" from the SOAP API. You should input the CPF if the kind is F or the CNPJ if the person is J.
+You can put the **include_score: true** to get the credit score data.
+
+```ruby
+ Biro.gateways[:spc].find('80541028286', 'F', 455, include_score: true)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/noverde/biro.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "biro"
+
+# 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

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/biro.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'biro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "biro"
+  spec.version       = Biro::VERSION
+  spec.authors       = ["Noverde Team", "Rafael Izidoro", "Alexandre Santos", "Paulo Herrera"]
+  spec.email         = ["dev@noverde.com.br", "izidoro.rafa@gmail.com", "alexandre.sns@gmail.com", "pauloherreralopes@gmail.com"]
+
+  spec.summary       = %q{Biro is a library that standardizes multi-provider brazilian credit bureaus.}
+  spec.description   = %q{Biro is a library that standardizes multi-provider brazilian credit bureaus.}
+  spec.homepage      = "https://github.com/noverde/biro"
+  spec.license       = "MIT"
+
+  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 "savon", "~> 2.11"
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "activesupport", '~> 5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

data/lib/biro/configuration.rb

@@ -0,0 +1,28 @@
+require 'singleton'
+
+module Biro
+  class Configuration
+    include Singleton
+
+    attr_accessor :environment, :logger
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def development!
+      @environment = :development
+    end
+
+    def development?
+      @environment == :development
+    end
+
+    def gateway(name, options = {})
+      klass_name = Biro::Utils.camelize(name.to_s) + '::Request'
+      klass = Biro.const_get(klass_name)
+
+      Biro.gateways[name] = klass.new(options)
+    end
+  end
+end

data/lib/biro/gateways/bacen/request.rb

@@ -0,0 +1,54 @@
+module Biro
+  module Bacen
+    class Request < BaseRequest
+      include Utils::Soap
+
+      def development_url
+        'https://scr.bcb.gov.br/wsscr/ControleCliente.xml'
+      end
+
+      def production_url
+        'https://scr.bcb.gov.br/wsscr/ControleCliente.xml'
+      end
+
+      def required_params
+        [:username, :password]
+      end
+
+      def find(document, date)
+        begin
+          params = {}
+          get_parameters(params, document, date)
+          result = soap.call(:get_resumo_do_cliente, message: params)
+        rescue => e
+          Biro.log(:warn, "Unable to process Bacen request")
+          raise StandardError.new("Error at Bacen request: #{e.message}")
+        end
+
+        get_response result
+      end
+
+      private
+
+      def get_response(result)
+        response = Response.new(result)
+        raise DocumentNotFoundError.new("Document not found: Code => #{response.result_validation[:codigo]} and Message => #{response.result_validation[:mensagem]}") if ['55'].include?(response.result_validation[:codigo])
+        raise AuthenticationError.new("Authentication Error: Code => #{response.result_validation[:codigo]} and Message => #{response.result_validation[:mensagem]}") if ['62','63','53'].include?(response.result_validation[:codigo])
+        raise StandardError.new("Error at Bacen Request: Code => #{response.result_validation[:codigo]} and Message => #{response.result_validation[:mensagem]}") unless response.result_validation.blank? || ['50'].include?(response.result_validation[:codigo])
+
+        response
+      end
+
+      def savon_options
+        { basic_auth: [@username, @password], headers: { 'SOAPAction' => ''} }
+      end
+
+      def get_parameters(params, document, date)
+        params['codCliente'] = document
+        params['tpCliente'] = 1
+        params['dataBase'] = date
+        params['autorizacao'] = 'S'
+      end
+    end
+  end
+end

data/lib/biro/gateways/bacen/response.rb

@@ -0,0 +1,109 @@
+require 'active_support/core_ext/array'
+
+module Biro
+  module Bacen
+    class Response < BaseResponse
+      def initialize(response)
+        @body = response.body
+      end
+
+      def cnpj_if
+        result.dig(:cnpj_da_if_solicitante)
+      end
+
+      def cpf
+        result.dig(:codigo_do_cliente)
+      end
+
+      def assumed_co_obligation
+        result.dig(:coobrigacao_assumida)&.to_f&.round(2)
+      end
+
+      def received_co_obligation
+        result.dig(:coobrigacao_recebida)&.to_f&.round(2)
+      end
+
+      def base_date
+        result.dig(:data_base_consultada)
+      end
+
+      def relationship_initial_date
+        result.dig(:data_inicio_relacionamento)&.to_date
+      end
+
+      def invoice_list
+        return if operation_list.blank?
+
+        result.dig(:lista_de_resumo_das_operacoes).each do |item|
+        {
+          :variacao_cambial => item[:variacao_cambial],
+          :modalidade =>  item[:modalidade],
+          :lista_de_vencimentos =>  item[:lista_de_vencimentos] #TODO: Translate the invoice codes
+        }
+        end
+      end
+
+      def exchange_rate_variation
+        operation_list&.dig(:variacao_cambial)
+      end
+
+      def processed_documents_percentage
+        result.dig(:percentual_documentos_processados)&.to_f&.round(2)
+      end
+
+      def processed_volume_percentage
+        result.dig(:percentual_volume_processado)&.to_f&.round(2)
+      end
+
+      def institutions_amount
+        result.dig(:quantidade_de_instituicoes).to_i
+      end
+
+      def operation_amount
+        result.dig(:quantidade_de_operacoes).to_i
+      end
+
+      def unconformity_operation_amount
+        result.dig(:quantidade_operacoes_discordancia).to_i
+      end
+
+      def sub_judice_operation_amount
+        result.dig(:quantidade_operacoes_sub_judice).to_i
+      end
+
+      def unconformity_total_responsibility
+        result.dig(:responsabilidade_total_discordancia).to_i
+      end
+
+      def sub_judice_total_responsibility
+        result.dig(:responsabilidade_total_sub_judice).to_i
+      end
+
+      def indirect_risk
+        result.dig(:risco_indireto_vendor).to_i
+      end
+
+      def customer_type
+        result.dig(:tipo_do_cliente).to_i
+      end
+
+      def result_validation
+        validation_content = result.dig(:lista_de_mensagens_de_validacao)
+
+        return { } if validation_content.blank?
+
+        validation_content
+      end
+
+      private
+
+      def result
+        @body.dig(:get_resumo_do_cliente_response, :return)
+      end
+
+      def operation_list
+        result.dig(:lista_de_resumo_das_operacoes)
+      end
+    end
+  end
+end

data/lib/biro/gateways/bacen.rb

@@ -0,0 +1,2 @@
+require_relative 'bacen/request'
+require_relative 'bacen/response'

data/lib/biro/gateways/base_request.rb

@@ -0,0 +1,30 @@
+module Biro
+  class BaseRequest
+    class AuthenticationError < StandardError; end
+    class DocumentNotFoundError < StandardError; end
+
+    def production_url
+      raise NotImplementedError.new('production_url must be implemented')
+    end
+
+    def development_url
+      production_url
+    end
+
+    def url
+      Biro.development? ? development_url : production_url
+    end
+
+    def required_params
+      []
+    end
+
+    def initialize(params)
+      required_params.each do |param|
+        raise ArgumentError.new("Missing required parameter '#{param}' for #{self.class.name}") unless params.has_key?(param)
+
+        instance_variable_set("@#{param}", params[param])
+      end
+    end
+  end
+end

data/lib/biro/gateways/base_response.rb

@@ -0,0 +1,5 @@
+module Biro
+  class BaseResponse
+    attr_reader :body
+  end
+end

data/lib/biro/gateways/bvs/builders/base_builder.rb

@@ -0,0 +1,17 @@
+class BaseBuilder
+  def initialize document, username, password
+    @document = document
+    @username = username
+    @password = password
+  end
+
+  def build
+    raise "This method must be implemented"
+  end
+
+  protected
+
+  def build_string
+    @parameters.values.map { |p| p[:type] == "T" ? p[:value].to_s.ljust(p[:size], " ") : p[:value].to_s.rjust(p[:size],"0") }.join
+  end
+end

data/lib/biro/gateways/bvs/builders/debits_request_builder.rb

@@ -0,0 +1,26 @@
+require_relative 'base_builder'
+
+class DebitsRequestBuilder < BaseBuilder
+  def build
+    @parameters = {
+      transaction: { size: 8, type: "T", value: "CSR60" },
+      version:  { size: 2, type: "T", value: "01" },
+      reserved_applicant: { size: 10, type: "T", value: "" },
+      reserved_bvs: { size: 20, type: "T", value: "" },
+      service_code: { size: 8, type: "N", value: @username },
+      password: { size: 8, type: "T", value: @password },
+      search_type: { size: 8, type: "T", value: "SPCIT" },
+      reserverd_bvs_2: { size: 4, type: "T", value: ""},
+      response_type: { size: 1, type: "T", value: "2" },
+      document_type: { size: 1, type: "T", value: "1" },
+      document: { size: 14, type: "N", value: @document },
+      reserverd_bvs_3: { size: 235, type: "T", value: ""},
+      facilitator_code: { size: 8, type: "N", value: "" },
+      reserverd_bvs_4: { size: 2, type: "T", value: ""},
+      response_trans_type: { size: 1, type: "T", value: "C" },
+      finish_marker: { size: 1, type: "T", value: "X" }
+    }
+
+    build_string
+  end
+end

data/lib/biro/gateways/bvs/builders/debits_response_builder.rb

@@ -0,0 +1,45 @@
+class DebitsResponseBuilder
+  def initialize body
+    @body = body.gsub("\n", '').scan(/<PRE>([^<>]*)<\/PRE>/imu).flatten[0]
+  end
+
+  def transaction
+    @body[0..7]
+  end
+
+  def version
+    @body[8..9]
+  end
+
+  def reserved_applicant
+    @body[10..19]
+  end
+
+  def reserved_bvs
+    @body[20..39]
+  end
+
+  def response_type
+    @body[56]
+  end
+
+  def return_code
+    @body[57]
+  end
+
+  def response_text_size
+    @body[58..61].to_i
+  end
+
+  def response_text
+    @body[62,response_text_size]
+  end
+
+  def error_message
+    response_text[8..100]
+  end
+
+  def debits_info
+    response_text[6]
+  end
+end

data/lib/biro/gateways/bvs/builders/score_request_builder.rb

@@ -0,0 +1,24 @@
+class ScoreRequestBuilder < BaseBuilder
+  def build
+    @parameters = {
+      transaction: { size: 8, type: "T", value: "CSR60" },
+      version:  { size: 2, type: "T", value: "01" },
+      reserved_applicant: { size: 10, type: "T", value: "" },
+      reserved_bvs: { size: 20, type: "T", value: "" },
+      service_code: { size: 8, type: "N", value: @username },
+      password: { size: 8, type: "T", value: @password },
+      search_type: { size: 8, type: "T", value: "SCORE" },
+      search_version: { size: 2, type: "T", value: "04" },
+      response_type: { size: 1, type: "T", value: "2" },
+      response_trans_type: { size: 1, type: "T", value: "C" },
+      document_type: { size: 1, type: "T", value: "1" },
+      document: { size: 14, type: "N", value: @document },
+      score_model: { size: 2, type: "T", value: "63" },
+      source_cep: { size: 8, type: "N", value: "" },
+      facilitator_code: { size: 8, type: "N", value: "" },
+      finish_marker: { size: 1, type: "T", value: "X" }
+    }
+
+    build_string
+  end
+end

data/lib/biro/gateways/bvs/builders/score_response_builder.rb

@@ -0,0 +1,93 @@
+class ScoreResponseBuilder
+  def initialize body
+    @body = body.gsub("\n", '').scan(/<PRE>([^<>]*)<\/PRE>/imu).flatten[0]
+  end
+
+  def transaction
+    @body[0..7]
+  end
+
+  def version
+    @body[8..9]
+  end
+
+  def reserved_applicant
+    @body[10..19]
+  end
+
+  def reserved_bvs
+    @body[20..39]
+  end
+
+  def service_code
+    @body[40..47]
+  end
+
+  def search_type
+    @body[48..55]
+  end
+
+  def search_version
+    @body[56..57]
+  end
+
+  def response_type
+    @body[58]
+  end
+
+  def return_code
+    @body[59]
+  end
+
+  def search_number
+    @body[60..66]
+  end
+
+  def response_text_size
+    @body[67..70].to_i
+  end
+
+  def response_text
+    @body[71,response_text_size]
+  end
+
+  def response_text_init
+    response_text[0..2]
+  end
+
+  def response_text_type
+    response_text[3..5]
+  end
+
+  def response_text_is_present
+    response_text[6]
+  end
+
+  def response_text_document_type
+    response_text[7]
+  end
+
+  def response_text_document
+    response_text[8..21]
+  end
+
+  def response_text_name
+    response_text[22..136]
+  end
+
+  def response_text_result_score
+    response_text[137..140]
+  end
+
+  def response_text_description
+    response_text[141..160]
+  end
+
+  def response_text_over
+    response_text[160..500]
+  end
+
+  def error_message
+    response_text[8..100]
+  end
+end