verificador_boleto_br 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c34bfe9726e78a7a81a3063c9d0a96c000cdf786a7894daa97b0a28dc92e1ba9
+  data.tar.gz: c45ddc477b9337542cda021ed0b1bbb3d1e6bf4a2452c01e80bc4382c1ee52d0
+SHA512:
+  metadata.gz: 266359f9f9857327ee55f0ce6645a46eae1a66f416e42c9d76e0bb7dc7aa72e36edd6a77e50bdfaa882ea2e3b8995335d460aae1d930d6ba128d86f4014643e3
+  data.tar.gz: f9baa289c2f9a94a38bde0aff4bf726e8be97e6f3fb34335eb974e84fbf6af469ea3537ee1a53de90e31412fe11abda0abe8743ee5e5bedac2cd03f8b6151af7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ogabrielhamdan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    VerificadorBoletoBr (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  VerificadorBoletoBr!
+  bundler (~> 2.0.1)
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Gabriel Hamdan
+
+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,100 @@
+# VerificadorBoletoBr
+
+Essa gem o ajudará a identificar boletos bancários nos seguinte items:
+* Banco
+* Valor
+* Data de Vencimento
+
+e, no caso de boleto de arrecadação:
+* Segmento
+* Concessionario (Emissor)
+* Valor
+* Validade (se disponível e "padrão" (🤣🤣🤣🤣) Febraban)
+
+E ainda conferir a **validade** dos mesmos.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'verificador_boleto_br'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install verificador_boleto_br
+
+## Usage
+
+````ruby
+require './lib/verificador_boleto_br'
+>> slip = VerificadorBoletoBr.check('34191 75801 03928 662935 80573 180009 4 67700000007388')
+=> #<VerificadorBoletoBr::BankSlip:0x00007ff4c3933478 @digitable_line="34191 75801 03928 662935 80573 180009 4 67700000007388">
+````
+It will return the respective slip class with its methods:
+
+### BankSlip
+
+````ruby
+>> slip.valid?
+=> true
+>> slip.bank_code
+=> 341
+>> slip.currency_code 
+=> 9
+>> slip.value_in_cents
+=> 7388
+>> slip.value
+=> 73.88
+>> slip.due_date
+=> #<Date: 2016-04-20 ((2457499j,0s,0n),+0s,2299161j)
+````
+
+### ArrecadationSlip (Concessionária)
+
+````ruby
+>> slip = VerificadorBoletoBr.check('858900000018 097802702000 323858108001 011520190292')
+=> #<VerificadorBoletoBr::ArrecadationSlip:0x00007ff4c50c8d40 @digitable_line="858900000018 097802702000 323858108001 011520190292", @errors=[]>
+>> slip.valid?
+=> true
+>> slip.value_in_cents
+=> 10978
+>> slip.value
+=> 109.78
+>> slip.due_date
+=> nil # if unavailable
+>> slip.segment
+=> "Órgãos Governamentais"
+>> slip.identification
+=> "Guia GPS - INSS"
+````
+
+You can access the slip classes directly if you want.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/VerificadorBoletoBr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/VerificadorBoletoBr/blob/master/CODE_OF_CONDUCT.md).
+
+## SPECIAL THANKS
+
+Encontrei a lista de identificadores de bolego no repositório do Rodrigo Stuchi (https://github.com/rod-stuchi)
+Obrigado cara.. não sei a origem dos dados (porque não consegui com a Febraban) mas parabens ;)

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 "VerificadorBoletoBr"
+
+# 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/lib/verificador_boleto_br.rb

@@ -0,0 +1,21 @@
+require_relative "./verificador_boleto_br/version"
+require_relative "./verificador_boleto_br/operationals"
+require_relative "./verificador_boleto_br/calculus/module10"
+require_relative "./verificador_boleto_br/calculus/module11"
+require_relative "./verificador_boleto_br/arrecadation_slip"
+require_relative "./verificador_boleto_br/bank_slip"
+
+require 'date'
+
+module VerificadorBoletoBr
+  include Operationals
+  def self.check(digitable_line)
+    if digitable_line.gsub(/( |\.|-)/, '').size.eql?(47)
+      BankSlip.new(digitable_line)
+    elsif digitable_line.gsub(/( |\.|-)/, '').size.eql?(48)
+      ArrecadationSlip.new(digitable_line)
+    else
+      raise ArgumentError, 'Invalid Digitable Line'
+    end
+  end
+end

data/lib/verificador_boleto_br/arrecadation_slip.rb

@@ -0,0 +1,122 @@
+require 'json'
+
+module VerificadorBoletoBr
+  class ArrecadationSlip
+
+    include VerificadorBoletoBr::Operationals
+    include VerificadorBoletoBr::Calculus::Module10
+    include VerificadorBoletoBr::Calculus::Module11
+
+    attr_accessor :digitable_line, :errors
+
+    def initialize(cod)
+      @digitable_line = cod
+      raise ArgumentError, 'Expected String'              unless @digitable_line.class.eql?(String)
+      raise ArgumentError, 'Invalid Digitable Line'       unless clean_digitable_line.size == 48
+      raise ArgumentError, 'Boleto Não é de Arrecadação'  unless @digitable_line[0] == '8'
+
+      @errors = []
+    end
+
+    def clean_digitable_line
+      clean_masks(@digitable_line)
+    end
+
+    def verification_digit
+      clean_digitable_line[3].to_i
+    end
+
+    def value_in_cents
+      digitable_line_without_dvs[4..14].to_i
+    end
+
+    def value
+      value_in_cents.to_f / 100
+    end
+
+    def due_date
+      begin
+        Date.parse(digitable_line_without_dvs[-6..-1])
+      rescue
+        nil
+      end
+    end
+
+    def segment
+      case clean_digitable_line[1]
+      when '1'
+        'Prefeitura'
+      when '2'
+        'Saneamento'
+      when '3'
+        'Energia Elétrica e Gás'
+      when '4'
+        'Telefonia'
+      when '5'
+        'Órgãos Governamentais'
+      when '6'
+        'Empresas / Órgãos com CNPJ.'
+      when '7'
+        'Multa de trânsito'
+      when '9'
+        'Uso exclusivo do banco'
+      end
+    end
+
+    def identification
+      begin
+        JSON.parse(File.read('lib/verificador_boleto_br/data/Dealerships.json'))
+          .select { |d| d['code'] == clean_digitable_line[15..18] && d['segment'] == clean_digitable_line[1].to_i }[0]["dealership"]
+      rescue
+        "Boleto de #{segment}"
+      end
+    end
+
+    def bacen_module
+      case clean_digitable_line[2]
+      when '6'
+        'modulo10'
+      when '7'
+        'modulo10'
+      when '8'
+        'modulo11'
+      when '9'
+        'modulo11'
+      end
+    end
+
+    def valid?
+      global_validity && !groups_validity.map { |group| group[:valid] }.include?(false)
+    end
+
+    def groups_validity
+      grouped_digitable_line.map do |group|
+        dv = send(bacen_module, group[:num]).to_s
+        valid = dv.eql?(group[:dv])
+        errors << "Campo #{group[:group]}" unless valid
+        {
+          group: group[:group],
+          valid: valid
+        }
+      end
+    end
+
+    def global_validity
+      send(bacen_module, digitable_line_without_dvs[0..2] + digitable_line_without_dvs[4..-1]) == verification_digit
+    end
+
+    def grouped_digitable_line
+      clean_digitable_line.scan(/.{1,12}/).each_with_index.map do |group, index|
+        {
+          group: index,
+          num: group[0..-2],
+          dv: group[-1]
+        }
+      end
+    end
+
+    def digitable_line_without_dvs
+      grouped_digitable_line.map { |group| group[:num] }.join
+    end
+  end
+end