verificador_boleto_br 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c35a0def8abc00b3967eb7c0104429b4e579fbdf29e303329a1ba3de6cd14716
-  data.tar.gz: 0c9247621d9c7406e0f43442e350627d9c809490cedb2628038695cca66e0975
+  metadata.gz: 7bdcfc77a1579acbf0ba65b3df459cff54c511bc9a34dc923ad2899ef3198c6f
+  data.tar.gz: 7cd07fa4cc00d5013bdb19a89dd56cc744a767d34d2ca96b96cf7a65bb6acd30
 SHA512:
-  metadata.gz: b1e0461ca6487fa9a366242a1d877480a0d9e13d3dc500794c9374db8fa1475c77064985dca0067e84bf583de2a84dbfa4bda293effcbda3f92658d6ba79603a
-  data.tar.gz: 5f888117a7b57076fa5fa65e2aecbc30300a2914e72e70928e72e2af87057addecf87aef384edea16f02e545a215fafd7ce2d6a9bb6d1ce314614b4990e26a64
+  metadata.gz: 1897917e8a3d383238210d4087ad20459a20bb411fa4a58ba1b2ca6e85119d13bad83ab91a15bd3d51c77613bcaeae96f7ebe2ab0a3bef5cbae622a57d02f06f
+  data.tar.gz: f6073471392c4ee31d9743a0f01b537f9272b526158a6dc8fbdae0cf5bb9e6946d5734932d0fc1d482e819fc52bf371325676d3af02389d01c951c7d205b7964

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    verificador_boleto_br (0.1.1)
+    verificador_boleto_br (0.1.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -34,7 +34,7 @@ Or install it yourself as:
 ````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">
+=> #<VerificadorBoletoBr::Slip::Bank::Validity:0x00007f9f820c7a00 @digitable_line="34191 75801 03928 662935 80573 180009 4 67700000007388", @kind=:bank_slip>
 ````
 It will return the respective slip class with its methods:
 
@@ -47,6 +47,8 @@ It will return the respective slip class with its methods:
 => 341
 >> slip.currency_code 
 => 9
+>> slip.kind
+=> :bank_slip
 >> slip.value_in_cents
 => 7388
 >> slip.value
@@ -59,9 +61,11 @@ It will return the respective slip class with its methods:
 
 ````ruby
 >> slip = VerificadorBoletoBr.check('858900000018 097802702000 323858108001 011520190292')
-=> #<VerificadorBoletoBr::ArrecadationSlip:0x00007ff4c50c8d40 @digitable_line="858900000018 097802702000 323858108001 011520190292", @errors=[]>
+=> #<VerificadorBoletoBr::Slip::Arrecadation::Validity:0x00007f9f821bbd08 @digitable_line="858900000018 097802702000 323858108001 011520190292", @errors=[], @kind=:arrecadation_slip>
 >> slip.valid?
 => true
+>> slip.kind
+=> :arrecadation_slip
 >> slip.value_in_cents
 => 10978
 >> slip.value
@@ -76,6 +80,15 @@ It will return the respective slip class with its methods:
 
 You can access the slip classes directly if you want.
 
+## Assembling Digitable Line from BarCode
+
+````ruby
+slip = VerificadorBoletoBr.translate_barcode('34196773300001455851090806185172938349558000')
+=> #<VerificadorBoletoBr::Slip::Bank::CodeAssembly:0x00007f9f84810990 @code="34196773300001455851090806185172938349558000">
+>> slip.digitable_line 
+=> "34191090810618517293683495580009677330000145585"
+````
+
 ## Special Feature
 Some bank slips do not validate the global digit well (anybody, feel free to explain me if my theory is correct) for example credit card slips (eg: NuBank). It may be because credit card bills can be paid with any value and global verification ensures that the value is also correct. This method allows to validate bank slips without global digit validation:
 

data/lib/verificador_boleto_br/slip/arrecadation/code_assembly.rb

@@ -0,0 +1,45 @@
+module VerificadorBoletoBr
+  module Slip
+    module Arrecadation
+      class CodeAssembly
+
+        include VerificadorBoletoBr::Calculus::Module10
+        include VerificadorBoletoBr::Calculus::Module11
+
+        def initialize(code)
+          @code = code
+        end
+
+        def treated_group
+          @code.scan(/.{1,11}/m)
+        end
+
+        def treated_code
+          treated_group.map {|partial| partial << "0" }.join
+        end
+
+        def digitable_line
+          result = ""
+          treated_group.each do |group|
+            result += group + send(bacen_module, group).to_s
+          end
+          result
+        end
+
+        def bacen_module
+          case treated_code[2]
+          when '6'
+            'modulo10'
+          when '7'
+            'modulo10'
+          when '8'
+            'modulo11'
+          when '9'
+            'modulo11'
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/verificador_boleto_br/slip/arrecadation/validity.rb

@@ -0,0 +1,134 @@
+require 'json'
+
+module VerificadorBoletoBr
+  module Slip
+    module Arrecadation
+      class Validity
+
+        include VerificadorBoletoBr::Operationals
+        include VerificadorBoletoBr::Calculus::Module10
+        include VerificadorBoletoBr::Calculus::Module11
+
+        attr_accessor :digitable_line, :kind, :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 = []
+          @kind = :arrecadation_slip
+        end
+
+        def clean_digitable_line
+          clean_masks(@digitable_line)
+        end
+
+        def verification_digit
+          clean_digitable_line[3].to_i
+        end
+
+        def value_in_cents
+          return nil unless valid?
+          digitable_line_without_dvs[4..14].to_i
+        end
+
+        def value
+          return nil unless valid?
+          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
+
+        # Duplicate just for mantaining module methods
+        def valid_without_global?
+          valid?
+        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
+  end
+end

data/lib/verificador_boleto_br/slip/bank/code_assembly.rb

@@ -0,0 +1,23 @@
+module VerificadorBoletoBr
+  module Slip
+    module Bank
+      class CodeAssembly
+        include VerificadorBoletoBr::Calculus::Module10
+        include VerificadorBoletoBr::Calculus::Module11
+
+        attr_accessor :code
+
+        def initialize(code)
+          @code = code
+        end
+
+        def digitable_line
+          block_1 = code[0..3] + code[19..23] + modulo10(code[0..3] + code[19..23]).to_s
+          block_2 = code[24..33] + modulo10(code[24..33]).to_s
+          block_3 = code[34..-1] + modulo10(code[34..-1]).to_s
+          block_1 + block_2 + block_3 + code[4..18]
+        end
+      end
+    end
+  end
+end

data/lib/verificador_boleto_br/slip/bank/validity.rb

@@ -0,0 +1,113 @@
+module VerificadorBoletoBr
+  module Slip
+    module Bank
+      class Validity
+        include VerificadorBoletoBr::Operationals
+        include VerificadorBoletoBr::Calculus::Module10
+        include VerificadorBoletoBr::Calculus::Module11
+
+        attr_accessor :digitable_line, :kind, :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 == 47
+
+          @kind = :bank_slip
+        end
+
+        def clean_digitable_line
+          clean_masks(@digitable_line)
+        end
+
+        def bank_code
+          clean_digitable_line[0..2].to_i
+        end
+
+        def currency_code
+          clean_digitable_line[3].to_i
+        end
+
+        def verification_digit
+          clean_digitable_line[32].to_i
+        end
+
+        def value_in_cents
+          return nil unless valid?
+          clean_digitable_line[37..-1].to_i
+        end
+
+        def value
+          return nil unless valid?
+          value_in_cents.to_f / 100
+        end
+
+        def block_1_validity
+          modulo10(clean_digitable_line[0..8]).eql?clean_digitable_line[9].to_i
+        end
+
+        def block_2_validity
+          modulo10(clean_digitable_line[10..19]).eql?clean_digitable_line[20].to_i
+        end
+
+        def block_3_validity
+          modulo10(clean_digitable_line[21..30]).eql?clean_digitable_line[31].to_i
+        end
+
+        def global_validity
+          str = ""
+          str += clean_digitable_line[0..2]
+          str += clean_digitable_line[3..3]
+          str += clean_digitable_line[32..32]
+          str += clean_digitable_line[33..36]
+          str += clean_digitable_line[37..46]
+          str += clean_digitable_line[4..8]
+          str += clean_digitable_line[10..19]
+          str += clean_digitable_line[21..30]
+          modulo11(str[0..3] + str[5..-1]).eql?(verification_digit)
+        end
+
+        def due_date
+          begin
+            bank_epoque(clean_digitable_line[33..36].to_i)
+          rescue
+            nil
+          end
+        end
+
+        def valid?
+          valid_without_global? && global_validity
+        end
+
+        def valid_without_global?
+          block_1_validity && block_2_validity && block_3_validity
+        end
+
+        def grouped_digitable_line
+          [
+            {
+              group: 0,
+              valid: block_1_validity
+            },
+            {
+              group: 1,
+              valid: block_2_validity
+            },
+            {
+              group: 2,
+              valid: block_2_validity
+            },
+          ]
+        end
+
+        def segment
+          'Boleto Bancário'
+        end
+
+        def identification
+          'Boleto Bancário'
+        end
+      end
+    end
+  end
+end

data/lib/verificador_boleto_br/version.rb

@@ -1,3 +1,3 @@
 module VerificadorBoletoBr
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/verificador_boleto_br.rb

@@ -2,20 +2,34 @@ 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_relative "./verificador_boleto_br/slip/arrecadation/code_assembly"
+require_relative "./verificador_boleto_br/slip/arrecadation/validity"
+require_relative "./verificador_boleto_br/slip/bank/code_assembly"
+require_relative "./verificador_boleto_br/slip/bank/validity"
 
 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)
+  def self.check(code)
+    clean_code =  code.gsub(/( |\.|-)/, '')
+    if clean_code.size.eql?(47)
+      VerificadorBoletoBr::Slip::Bank::Validity.new(code)
+    elsif clean_code.size.eql?(48)
+      VerificadorBoletoBr::Slip::Arrecadation::Validity.new(code)
     else
       raise ArgumentError, 'Invalid Digitable Line'
     end
   end
+
+  def self.translate_barcode(code)
+    clean_code =  code.gsub(/( |\.|-)/, '')
+    if clean_code.size.eql?(44) && clean_code[0] != '8'
+      VerificadorBoletoBr::Slip::Bank::CodeAssembly.new(code)
+    elsif clean_code.size.eql?(44) && clean_code[0] == '8'
+      VerificadorBoletoBr::Slip::Arrecadation::CodeAssembly.new(code)
+    else
+      raise ArgumentError, 'Invalid Barcode'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verificador_boleto_br
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Gabriel Hamdan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,13 +71,15 @@ files:
 - bin/console
 - bin/setup
 - lib/verificador_boleto_br.rb
-- lib/verificador_boleto_br/arrecadation_slip.rb
-- lib/verificador_boleto_br/bank_slip.rb
 - lib/verificador_boleto_br/calculus/module10.rb
 - lib/verificador_boleto_br/calculus/module11.rb
 - lib/verificador_boleto_br/data/Banks.json
 - lib/verificador_boleto_br/data/Dealerships.json
 - lib/verificador_boleto_br/operationals.rb
+- lib/verificador_boleto_br/slip/arrecadation/code_assembly.rb
+- lib/verificador_boleto_br/slip/arrecadation/validity.rb
+- lib/verificador_boleto_br/slip/bank/code_assembly.rb
+- lib/verificador_boleto_br/slip/bank/validity.rb
 - lib/verificador_boleto_br/version.rb
 - verificador_boleto_br.gemspec
 homepage: https://github.com/Hamdan85/VerificadorBoletoBr

data/lib/verificador_boleto_br/arrecadation_slip.rb

@@ -1,129 +0,0 @@
-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
-      return nil unless valid?
-      digitable_line_without_dvs[4..14].to_i
-    end
-
-    def value
-      return nil unless valid?
-      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
-
-    # Duplicate just for mantaining module methods
-    def valid_without_global?
-      valid?
-    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

data/lib/verificador_boleto_br/bank_slip.rb

@@ -1,108 +0,0 @@
-module VerificadorBoletoBr
-  class BankSlip
-    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 == 47
-    end
-
-    def clean_digitable_line
-      clean_masks(@digitable_line)
-    end
-
-    def bank_code
-      clean_digitable_line[0..2].to_i
-    end
-
-    def currency_code
-      clean_digitable_line[3].to_i
-    end
-
-    def verification_digit
-      clean_digitable_line[32].to_i
-    end
-
-    def value_in_cents
-      return nil unless valid?
-      clean_digitable_line[37..-1].to_i
-    end
-
-    def value
-      return nil unless valid?
-      value_in_cents.to_f / 100
-    end
-
-    def block_1_validity
-      modulo10(clean_digitable_line[0..8]).eql?clean_digitable_line[9].to_i
-    end
-
-    def block_2_validity
-      modulo10(clean_digitable_line[10..19]).eql?clean_digitable_line[20].to_i
-    end
-
-    def block_3_validity
-      modulo10(clean_digitable_line[21..30]).eql?clean_digitable_line[31].to_i
-    end
-
-    def global_validity
-      str = ""
-      str += clean_digitable_line[0..2]
-      str += clean_digitable_line[3..3]
-      str += clean_digitable_line[32..32]
-      str += clean_digitable_line[33..36]
-      str += clean_digitable_line[37..46]
-      str += clean_digitable_line[4..8]
-      str += clean_digitable_line[10..19]
-      str += clean_digitable_line[21..30]
-
-      modulo11(str[0..3] + str[5..-1]).eql?(verification_digit)
-    end
-
-    def due_date
-      begin
-        bank_epoque(clean_digitable_line[33..36].to_i)
-      rescue
-        nil
-      end
-    end
-
-    def valid?
-      valid_without_global? && global_validity
-    end
-
-    def valid_without_global?
-      block_1_validity && block_2_validity && block_3_validity
-    end
-
-    def grouped_digitable_line
-      [
-        {
-          group: 0,
-          valid: block_1_validity
-        },
-        {
-          group: 1,
-          valid: block_2_validity
-        },
-        {
-          group: 2,
-          valid: block_2_validity
-        },
-      ]
-    end
-
-    def segment
-      'Boleto Bancário'
-    end
-
-    def identification
-      'Boleto Bancário'
-    end
-  end
-end