girocode 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2713f1afa65bd13d77e0253324b6cfb8bde9a7044e02e2f6c79b3403c61787a
-  data.tar.gz: 2743e4c121c12c3b14e4950f06027323971124de410e4588809ed685d3ff1155
+  metadata.gz: ae1af8187bb62eb64c3b96a6d9001899e7f156bba781844f1d3f462bf954a248
+  data.tar.gz: bd8ca3c9fd7156c50d801368f91986c8ea63bbb7e6934d6b356bb0a91a8df7db
 SHA512:
-  metadata.gz: ea6017284805b9beb507ea6b936ca4dd6665ecd63fdae69f5f6855c25000fe5ffb1bf4f3b05adae42ac2bc02abafab5b65e77023a8de60425858b26f6531aa62
-  data.tar.gz: a68821b07b92b04789bdb8d02db165b90315b12222d41de1b5b11dda43bdf3174f8e6333b40fe5e08c6c8f9e969602a9fe62d29f0ec521a97aed946c9be1640a
+  metadata.gz: 2271e8db17f381aa6debff46557c81b08c3bf23bc74043a27fd61957f91f22d13fd6e6ba8791534d5a6f1df8e4eac85557befd4ec1ca4bc41ba9c3f799d1b6af
+  data.tar.gz: 8ac181062def7582a6fd8bc5604983a8ec8f95144cc276398f9f4df3d4ca2334b0c1a0101ff28d75d0de1655d661181cc0e908c44e8064bca27dc410a3524515

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0
+
+- Drop bank-contact, use iban-tools (@Joerg-Seitz)
+- Inline BIC validation from bank-contact
+- Support Ruby 3.4

data/README.md

@@ -1,7 +1,7 @@
-[![Gem Version](https://badge.fury.io/rb/girocode.svg)](http://badge.fury.io/rb/girocode) [![Build Status](https://travis-ci.org/mtgrosser/girocode.svg)](https://travis-ci.org/mtgrosser/girocode)
+[![Gem Version](https://badge.fury.io/rb/girocode.svg)](http://badge.fury.io/rb/girocode) [![build](https://github.com/mtgrosser/girocode/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/girocode/actions/workflows/build.yml)
 # Girocode - create EPC QR codes for SEPA bank transfers
 
-Pure Ruby library to generate QR codes in SVG, PNG, HTML or ASCII format
+Pure Ruby library to generate EPC QR codes in SVG, PNG, HTML or ASCII format
 
 ![Girocode](https://raw.githubusercontent.com/mtgrosser/girocode/master/test/demo.png)
 
@@ -28,3 +28,29 @@ code.to_ascii
 # in your console
 puts code.to_ansi
 ```
+
+## Supported attributes
+
+Codes can be generated with the following attributes:
+
+| Attribute            | Description                    | required           | exclusive | max size |
+|----------------------|--------------------------------|--------------------|-----------|----------|
+| `bic`                | Bank Identifier Code           |                    |           | 11       |
+| `name`               | Name of beneficiary            | ✓                  |           | 70       |
+| `iban`               | IBAN                           | ✓                  |           | 34       |
+| `currency`           | ISO-4217 currency code         | if `amount` given  |           | 3        |
+| `amount`             | Money amount                   |                    |           | 12       |
+| `purpose`            | SEPA purpose code              |                    |           | 4        |
+| `creditor_reference` | ISO-11649 creditor reference   |                    | ✓         | 35       |
+| `reference`          | Unstructured reference         |                    | ✓         | 140      |
+| `bto_info`           | Beneficiary to originator info |                    |           | 70       |
+
+## Limitations
+
+Codes are generated as EPC-QR Version 2 in UTF-8 format only.
+
+## Specification
+
+European Payments Council: Quick Response Code
+
+[Guidelines to enable data capture for the initiation of a SEPA credit transfer](https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2018-05/EPC069-12%20v2.1%20Quick%20Response%20Code%20-%20Guidelines%20to%20Enable%20the%20Data%20Capture%20for%20the%20Initiation%20of%20a%20SCT.pdf)

data/lib/girocode/bic.rb

@@ -0,0 +1,67 @@
+# derived from bank-contact/bic by Kevin
+
+module Girocode
+  class BIC
+    REGEX = /\A([A-Z]{4})([A-Z]{2})([A-Z0-9]{2})([A-Z0-9]{3})?\z/.freeze
+    
+    def self.valid?(code)
+      new(code).valid?
+    end
+
+    def initialize(code)
+      @code = code.to_s.gsub(/\s+/, '').upcase
+    end
+
+    def bank_code
+      @code[0..3]
+    end
+
+    def country_code
+      @code[4..5]
+    end
+
+    def location_code
+      @code[6..7]
+    end
+
+    def branch_code
+      @code[8..10]
+    end
+
+    def to_s(formatted = false)
+      formatted ? to_formatted_str : @code
+    end
+    
+    def to_formatted_str
+      "#{bank_code} #{country_code} #{location_code} #{branch_code}".strip
+    end
+
+    def test?
+      location_code[1] == '0'
+    end
+
+    def passive?
+      location_code[1] == '1'
+    end
+
+    def reverse_billing?
+      location_code[1] == '2'
+    end
+
+    def valid?
+      valid_format? && valid_location_code? && valid_branch_code?
+    end
+
+    def valid_format?
+      REGEX.match?(@code)
+    end
+
+    def valid_location_code?
+      !location_code.start_with?('0', '1') && !location_code.end_with?('O')
+    end
+
+    def valid_branch_code?
+      branch_code.empty? || branch_code == 'XXX' || !branch_code.start_with?('X')
+    end
+  end
+end

data/lib/girocode/code.rb

@@ -1,13 +1,13 @@
 module Girocode
   class Error < StandardError; end
-  
+
   class Code
     ATTRIBUTES = %i[bic name iban currency amount purpose creditor_reference reference bto_info]
     attr_reader *ATTRIBUTES
-    
+
     MAX_PAYLOAD_BYTES = 331
     AMOUNT_RANGE = BigDecimal('0.01')..BigDecimal('999999999.99')
-    
+
     def initialize(**attrs)
       if keys = attrs.keys - ATTRIBUTES and not keys.empty?
         raise ArgumentError, "Illegal attributes #{keys.inspect}"
@@ -19,17 +19,17 @@ module Girocode
       raise ArgumentError, "either creditor reference or reference may be set" if creditor_reference? && reference?
       raise ArgumentError, "payload too long" if payload.bytesize > MAX_PAYLOAD_BYTES
     end
-    
+
     def bic=(value)
       if value.nil?
         @bic = nil
       else
-        bic = Bank::BIC.new(value)
+        bic = BIC.new(value)
         raise ArgumentError, "Invalid BIC #{value.inspect}" unless bic.valid?
         @bic = bic.to_s
       end
     end
-    
+
     def name=(value)
       value = value.strip
       raise ArgumentError, 'name is required' unless value
@@ -37,81 +37,81 @@ module Girocode
       raise ArgumentError, 'Illegal name' if value.include?("\n") || value.include?("\r")
       @name = value
     end
-    
+
     def iban=(value)
-      iban = Bank::IBAN.new(value)
-      raise ArgumentError, "Invalid IBAN #{value.inspect}" unless iban.valid?
-      @iban = iban.to_s
+      raise ArgumentError, "Invalid IBAN #{value.inspect}" unless IBANTools::IBAN.valid?(value)
+
+      @iban = value
     end
-    
+
     def currency=(value)
       value = value.to_s.upcase
       raise ArgumentError, "Invalid currency" unless value.match?(/\A[A-Z]{3}\z/)
       @currency = value
     end
-    
+
     def amount=(value)
       raise ArgumentError, 'amount is required' unless value
       value = BigDecimal(value, Float::DIG + 1)
       raise ArgumentError, "invalid amount #{value.inspect}" unless AMOUNT_RANGE.cover?(value)
       @amount = value
     end
-    
+
     def purpose=(value)
       unless value.nil?
         raise ArgumentError, "invalid purpose #{value.inspect}" unless value.match?(/\A[A-z0-9]{0,4}\z/)
       end
       @purpose = value
     end
-    
+
     def creditor_reference=(value)
       unless value.nil?
         raise ArgumentError, "invalid creditor reference #{value.inspect}" if value.include?("\n") || value.include?("\r") || value.size > 35
       end
       @creditor_reference = value
     end
-    
+
     def reference=(value)
       unless value.nil?
         raise ArgumentError, "invalid reference #{value.inspect}" if value.include?("\n") || value.include?("\r") || value.size > 140
       end
       @reference = value
     end
-    
+
     def bto_info=(value)
       unless value.nil?
         raise ArgumentError, "invalid bto_info #{value.inspect}" if value.include?("\n") || value.include?("\r") || value.size > 70
       end
       @bto_info = value
     end
-    
+
     ATTRIBUTES.each do |attr|
       define_method("#{attr}?") do
         value = instance_variable_get("@#{attr}")
         value.respond_to?(:empty?) ? !value.empty? : !!value
       end
     end
-    
+
     def payload
       ['BCD', '002', '1', 'SCT',
        bic, name, iban,formatted_amount, purpose,
        creditor_reference || reference, bto_info].map(&:to_s).join("\n")
     end
-    
+
     def to_qrcode
       RQRCode::QRCode.new(payload, level: :m, mode: :byte_8bit)
     end
-    
+
     def to_ascii
       to_qrcode.to_s
     end
-    
+
     %i[png svg html ansi].each do |format|
       define_method("to_#{format}") { |*args| to_qrcode.public_send("as_#{format}", *args) }
     end
-    
+
     private
-    
+
     def formatted_amount
       "#{currency}#{amount.round(2).to_s('F')}" if currency? && amount
     end

data/lib/girocode/version.rb

@@ -1,3 +1,3 @@
 module Girocode
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/girocode.rb

@@ -1,8 +1,9 @@
 require 'bigdecimal'
-require 'bank/contact'
+require 'iban-tools'
 require 'rqrcode'
 
 require_relative 'girocode/version'
+require_relative 'girocode/bic'
 require_relative 'girocode/code'
 
 module Girocode

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: girocode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthias Grosser
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rqrcode
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bank-contact
+  name: rqrcode
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,55 +38,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: iban-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -101,17 +58,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
 - lib/girocode.rb
+- lib/girocode/bic.rb
 - lib/girocode/code.rb
 - lib/girocode/version.rb
 homepage: https://github.com/mtgrosser/girocode
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Generate QR codes for SEPA credit transfers
 test_files: []

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test