bank_slip 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8eab2d7997e6d41a3ec758c29854687d094a8f38
+  data.tar.gz: 568e42044873bb81e08631b092ffcf7916d1a467
+SHA512:
+  metadata.gz: 063764cd326215f48aa2d39b1b8130d118ce13c803a952d11a74dca495d063f5f46631fbf78d3a8c9d82ccc2ce115427e50a9cdb840115ba9d1e819474494166
+  data.tar.gz: d9d80085851d481e5712df3179f9c5a4666823e6eef728c63a66328bdf0d90ac69ae78a6158e087b3b0d4149b2b94ec4f44c286a878c22102cc3c1a36072b900

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bank_slip.gemspec
+gemspec
+
+
+gem "rake", "~> 10.0" , group: [:development, :test]
+gem "rspec", "~> 3", group: [:development, :test]
+gem 'pdf-inspector', :require => "pdf/inspector", group: [:development, :test]
+gem 'pry', group: [:development, :test]

data/README.md

@@ -0,0 +1,39 @@
+# BankSlip
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bank_slip`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bank_slip'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bank_slip
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bank_slip/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bank_slip.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bank_slip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bank_slip"
+  spec.version       = BankSlip::VERSION
+  spec.licenses      = ["MIT"]
+
+  spec.summary       = %q{Bank Slip for Municipal Collection Document.}
+  spec.description   = %q{Generate Bank Slip for Municipal Collection Document.}
+  spec.homepage      = "https://github.com/marcomoura/bank-slip"
+  spec.authors       = ["Marco Moura"]
+  spec.email         = ["marco.moura@gmail.com"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.9"
+  spec.add_dependency "barby"
+  spec.add_dependency "prawn"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bank_slip"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bank_slip/barcode.rb

@@ -0,0 +1,104 @@
+# Barcode data according to febraban specification
+#
+# POSITION | SIZE | CONTENT                  |
+# 01 – 01  | 1    | Product                  | Fixed: 8
+# 02 – 02  | 1    | Segment                  | Fixed: 1 for City Halls
+# 03 – 03  | 1    | Real or Reference value  | 6 and mod10 for DV or 8 and mod11 for DV
+# 04 – 04  | 1    | Dígito verificador geral | mod10 or mod11
+# 05 – 15  | 11   | Value                    | value in Reais
+
+# 16 – 19  | 4    | Company or organization  | code of 4 digits febraban
+# 20 – 44  | 25   | Free                     | AAAAMMDD + free use
+
+# 16 – 23  | 8    | Company or organization  | code of 8 digits bank (start CNPJ)
+# 24 – 44  | 21   | Free                     | AAAAMMDD + free use
+#
+#
+require 'barby'
+require 'barby/barcode/code_25_interleaved'
+require 'barby/outputter/prawn_outputter'
+
+module BankSlip
+  class Barcode
+
+    # > options = {value: 1, identification_code: 2, document_number: 10, payment_date: Date.new(2010, 3, 10)}
+    # > barcode = BankSlip::Barcode.new(options)
+    def initialize(value:, identification_code:, payment_date:,
+                   segment: 1, effective_reference: 6,
+                   free_digits: 0, product: 8)
+      @value               = value
+      @segment             = segment
+      @identification_code = identification_code
+      @payment_date        = payment_date
+      @product             = product
+      @effective_reference = effective_reference
+      @free_digits         = free_digits
+      fail "identification_code #{identification_code} too long, #{identification_length} characters is the maximum allowed, for the segment #{segment}"  unless valid_identification_code?
+    end
+
+    # > barcode.digits
+    # => "81640000000000100022010031000000000000000010"
+    def digits
+      @digits ||= numbers.insert(3, digit(numbers).to_s)
+    end
+
+    # > barcode.numerical_representation
+    # => ["81640000000 5", "00010002201 1", "00310000000 3", "00000000010 9"]
+    def numerical_representation
+      @numerical_representation ||= digits.scan(/\d{11}/).collect {|p| "#{p} #{digit(p)}" }
+    end
+
+    private
+
+    def valid_identification_code?
+      @identification_code.to_s.size.eql?(identification_length)
+    end
+
+    def numbers
+      @numbers ||= [
+        @product,
+        @segment,
+        @effective_reference,
+        leading_zeros(@value),
+        mask_id,
+        @payment_date.strftime('%Y%m%d'),
+        free_digits_leading_zeros
+      ]
+      .join('')
+    end
+
+    def leading_zeros(n, length = 11)
+      "%0#{length}d" % n
+    end
+
+    def mask_id
+      leading_zeros(@identification_code, identification_length)
+    end
+
+    def free_digits_leading_zeros
+      length = 21 - identification_length
+      leading_zeros(@free_digits, length)
+    end
+
+    def digit(code_number)
+      d = BankSlip::CheckDigit.new(number: code_number)
+      d.calc
+    end
+
+    # The Indentification code is defined by the segment
+    # Use 4 digits (FEBRABAN code) for the segments:
+    #   1. Prefeituras;
+    #   2. Saneamento;
+    #   3. Energia Elétrica e Gás;
+    #   4. Telecomunicações;
+    #   5. Órgãos Governamentais;
+    #   6. Carnes e Assemelhados ou demais
+    #
+    # Use 8 digits (CNPJ) for the segments:
+    #   7. Multas de transito
+    #   9. Uso exclusivo do banco
+    def identification_length
+      %w{7 9}.include?(@segment.to_s) ? 8 : 4
+    end
+  end
+end

data/lib/bank_slip/check_digit.rb

@@ -0,0 +1,30 @@
+module BankSlip
+  class CheckDigit
+    def initialize(number:)
+      @number = number
+    end
+
+    def calc
+      r = result
+      r == 10 ? 0 : r
+    end
+
+    private
+
+    def result
+      result_string = ""
+      @number.reverse.split("").each_with_index do |c, index|
+        result_string << (c.to_i * ((1 + index) % 2 + 1)).to_s
+      end
+
+      10 - sum(result_string) % 10
+    end
+
+    def sum(result_string)
+      total = 0
+      result_string.each_char { |c| total += c.to_i }
+      total
+    end
+  end
+end
+

data/lib/bank_slip/pdf.rb

@@ -0,0 +1,232 @@
+require "prawn"
+require "prawn/measurement_extensions"
+
+module BankSlip
+  class Pdf
+    include Prawn::View
+
+    def self.render(data)
+      new(data).create.render
+    end
+
+    def initialize(data)
+      @data = data
+      # Measures
+      @vHEADER_HEIGHT      = 0.82.in
+      @vBODY_HEIGHT        = 2.35.in
+      @vINFO_WIDTH         = 6.15.in
+      @vVALUES_WIDTH       = 7.65.in - @vINFO_WIDTH
+      @vLINE_HEIGHT        = 0.335.in
+      @vFOOTER_HEIGHT      = 4.25.in - @vHEADER_HEIGHT - @vBODY_HEIGHT
+      @vFOOTER_LEFT_WIDTH  = 2.5.in
+    end
+
+    def create
+      content(0, 'CONTRIBUINTE')
+      footer_payer
+      cut_line
+      content(5.3.in, 'BANCO')
+      footer_payeer
+      add_barcode
+      self
+    end
+
+    private
+
+    def border
+      stroke_color '999999'
+      line_width 1
+      stroke_bounds
+    end
+
+    def add_digit(numbers, left_padding = 0)
+      bounding_box([0.185.in + left_padding, 0.85.in], width: 1.05.in, height: 0.17.in) do
+        move_down 0.03.in
+        stroke_color '444444'
+        stroke_bounds
+        text numbers, size: 9, style: :bold, align: :center
+      end
+    end
+
+    def copy_for(caption)
+      bounding_box [bounds.left - 0.05.in, bounds.top_left[1] - 0.7.in], width: bounds.right, height: 0.82.in do
+        text "VIA #{caption}", size: 7, style: :normal, align: :right
+      end
+    end
+
+    def content(initial_y, caption)
+      bounding_box [0, bounds.top_left()[1] - initial_y], width: 7.65.in, height: 3.17.in do
+        border
+        header_content
+        copy_for(caption)
+
+        # Info to the left
+        bounding_box([0.in, bounds.top_left[1] - @vHEADER_HEIGHT], width: @vINFO_WIDTH, height: @vBODY_HEIGHT) do
+          stroke do
+            stroke_color 'AAAAAA'
+            line bounds.bottom_left, bounds.bottom_right
+          end
+
+          draw_line("Nome Oficial"        , @data[:payer][:official_name]      , @vINFO_WIDTH   , @vLINE_HEIGHT , 0 , 0  , 'E6E6E6')
+          draw_line("CPF/CNPJ"            , @data[:payer][:cpf_cnpj]           , @vINFO_WIDTH/4 , @vLINE_HEIGHT , 0 , 1)
+          draw_line("Inscrição Municipal" , @data[:payer][:city_registration]  , @vINFO_WIDTH/4 , @vLINE_HEIGHT , 1 , 1)
+          draw_line("Emissão"             , @data[:stub][:emission_date]       , @vINFO_WIDTH/4 , @vLINE_HEIGHT , 2 , 1  , 'E6E6E6')
+          draw_line("Incidência"          , @data[:stub][:incidence]           , @vINFO_WIDTH/4 , @vLINE_HEIGHT , 3 , 1  , 'E6E6E6')
+          draw_line("Receita"             , @data[:stub][:revenue_description] , @vINFO_WIDTH   , @vLINE_HEIGHT , 0 , 2)
+
+          move_down 0.1.in
+          indent(0.1.in) do
+            text 'Outras Informações', size: 8
+            text @data[:stub][:other_information]
+          end
+
+          text_box "PAGÁVEL EM QUALQUER AGENTE ARRECADADOR AUTORIZADO ATÉ #{@data[:stub][:expiration_date]}.\n" +
+                    "O VALOR PARA PAGAMENTO DESTE DOCUMENTO NÃO PODE SER ATUALIZADO. ",
+                     at: [bounds.bottom_left[0] + 0.075.in, bounds.bottom_left[0] + 0.8.in],
+                     height: 0.75.in,
+                     size: 8,
+                     style: :normal,
+                     valign: :bottom
+
+        end # Info to the left
+
+        # Values to the right
+        bounding_box([@vINFO_WIDTH, bounds.top_left[1] - @vHEADER_HEIGHT], width: @vVALUES_WIDTH, height: @vBODY_HEIGHT) do
+          # Bottom line
+          stroke do
+            stroke_color 'AAAAAA'
+            line bounds.bottom_left, bounds.bottom_right
+            line bounds.top_left, bounds.bottom_left
+          end
+
+          draw_line("Vencimento da Guia"      , @data[:stub][:expiration_date]          , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 0 , 'E6E6E6' , :right)
+          draw_line("Valor (R$)"              , @data[:stub][:value]             , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 1 , 'FFFFFF' , :right)
+          draw_line("Multa/Juros (R$)"        , @data[:stub][:fine_and_interest] , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 2 , 'FFFFFF' , :right)
+          draw_line("Outros Acréscimos (R$)"  , @data[:stub][:adjustment]        , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 3 , 'FFFFFF' , :right)
+          draw_line("Descontos (R$)"          , "-#{@data[:stub][:discounts]}"   , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 4 , 'FFFFFF' , :right)
+          draw_line("Taxa de Expediente (R$)" , @data[:stub][:transaction_fee]   , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 5 , 'FFFFFF' , :right)
+          draw_line("Total (R$)"              , @data[:stub][:total]    , @vVALUES_WIDTH , @vLINE_HEIGHT , 0 , 6 , 'E6E6E6' , :right  , '000000')
+        end # Values to the right
+      end
+    end
+
+    def footer_payer
+      move_down 0.1.in
+      text "Documento No. #{@data[:stub][:document_number]}", size: 8
+      bounding_box([0, bounds.top_left[1] - 0.4.in - @vHEADER_HEIGHT - @vBODY_HEIGHT],
+                   width: 194.mm, height: 22.mm) do
+
+        move_down 0.05.in
+        indent 0.05.in do
+          text 'AUTENTICAÇÃO MECÂNICA', size: 7, align: :left
+        end
+
+        stroke do
+          stroke_color '999999'
+          line bounds.top_left, bounds.top_right
+          line bounds.top_left, bounds.bottom_left
+        end
+      end
+    end
+
+    def footer_payeer
+      move_down 0.1.in
+      text "Documento No. #{@data[:stub][:document_number]}", size: 8
+      bounding_box([bounds.right - 2.55.in, bounds.bottom_left[1] + 0.7.in],
+                   width: 65.mm, height: 22.mm) do
+
+        move_down 0.05.in
+        indent 0.03.in do
+          text 'AUTENTICAÇÃO MECÂNICA', size: 7, align: :center
+        end
+
+        stroke do
+          stroke_color '999999'
+          line bounds.top_left, bounds.top_right
+          line [bounds.top_left, 0], [bounds.top_left[0]+50, 0]
+        end
+      end
+    end
+
+    def draw_line(label, value, width, height, column = 0, line = 0, bg_color = 'FFFFFF', align = :left, stroke = 'AAAAAA')
+      bounding_box([0.in + column * width, bounds.top_left[1] - line * height], width: width, height: height) do
+        if bg_color != 'FFFFFF'
+          fill_color bg_color
+          transparent(0.6) do
+            fill_rectangle [bounds.top_left[0] + 1, bounds.top_left[1] - 1], width, height
+          end
+          fill_color '000000'
+        end
+
+        draw_line_text(label, value, width, height, align)
+        stroke_color stroke
+        line_width 1
+        stroke_bounds
+      end
+    end
+
+    def draw_line_text(label, value, width, height, align)
+      bounding_box([bounds.top_left[0], bounds.top_left[1] - 0.05.in], width: width - 0.075.in, height: height - 0.05.in) do
+        indent(0.075.in) do
+          text label, size: 7, style: :normal, leading: 0.025.in
+          text value.to_s, size: 8, style: :bold, align: align
+        end
+      end
+    end
+
+    def header_content
+      bounding_box [0,bounds.top_left()[1]], width: 7.65.in, height: @vHEADER_HEIGHT do
+        stroke do
+          stroke_color 'AAAAAA'
+          line bounds.bottom_left, bounds.bottom_right
+        end
+        indent 0.1.in do
+          unless @data[:header][:logo].nil?
+            img = image @data[:header][:logo], fit: [0.71.in, 0.68.in], position: :left, vposition: :center
+            image_width = img.scaled_width + 0.15.in
+            move_up img.scaled_height - 0.15.in
+          else
+            image_width = 0
+            move_down 0.2.in
+          end
+          indent image_width do
+            text @data[:header][:title]   , size: 10 , style: :bold  , leading: -0.01.in
+            text @data[:header][:subtitle], size: 8  , style: :normal, leading:  0.02.in
+            move_down 0.05.in
+            text @data[:header][:document], size:  13, style: :bold
+          end
+        end
+      end
+    end
+
+    def cut_line
+      dash 3
+      stroke_line [bounds.left, 5.3.in, bounds.right + 0.1.in, 5.3.in]
+      undash
+      font 'ZapfDingbats' do
+        text_box "#", size: 18, rotate: 180, at: [bounds.right, 5.3.in + 0.13.in]
+      end
+    end
+
+    def add_barcode
+      bounding_box([-13, 65],
+                   width: 7.65.in - @vFOOTER_LEFT_WIDTH,
+                   height: @vFOOTER_HEIGHT) do
+        add_digit(barcode.numerical_representation[0])
+        add_digit(barcode.numerical_representation[1], 1.242.in)
+        add_digit(barcode.numerical_representation[2], (1.242.in * 2))
+        add_digit(barcode.numerical_representation[3], (1.242.in * 3))
+      end
+      add_bar
+    end
+
+    def add_bar
+      Barby::Code25Interleaved.new(barcode.digits)
+        .annotate_pdf(self, x: 0, y: -10, xdim: 0.85, height: 0.5.in)
+    end
+
+    def barcode
+      @_barcode ||= BankSlip::Barcode.new(@data[:barcode])
+    end
+  end
+end

data/lib/bank_slip/version.rb

@@ -0,0 +1,3 @@
+module BankSlip
+  VERSION = "0.3.1"
+end

data/lib/bank_slip.rb

@@ -0,0 +1,8 @@
+require "bank_slip/version"
+require "bank_slip/barcode"
+require "bank_slip/check_digit"
+require "bank_slip/pdf"
+
+module BankSlip
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: bank_slip
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Marco Moura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: barby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate Bank Slip for Municipal Collection Document.
+email:
+- marco.moura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bank_slip.gemspec
+- bin/console
+- bin/setup
+- lib/bank_slip.rb
+- lib/bank_slip/barcode.rb
+- lib/bank_slip/check_digit.rb
+- lib/bank_slip/pdf.rb
+- lib/bank_slip/version.rb
+homepage: https://github.com/marcomoura/bank-slip
+licenses:
+- MIT
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Bank Slip for Municipal Collection Document.
+test_files: []