girocode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2713f1afa65bd13d77e0253324b6cfb8bde9a7044e02e2f6c79b3403c61787a
+  data.tar.gz: 2743e4c121c12c3b14e4950f06027323971124de410e4588809ed685d3ff1155
+SHA512:
+  metadata.gz: ea6017284805b9beb507ea6b936ca4dd6665ecd63fdae69f5f6855c25000fe5ffb1bf4f3b05adae42ac2bc02abafab5b65e77023a8de60425858b26f6531aa62
+  data.tar.gz: a68821b07b92b04789bdb8d02db165b90315b12222d41de1b5b11dda43bdf3174f8e6333b40fe5e08c6c8f9e969602a9fe62d29f0ec521a97aed946c9be1640a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matthias Grosser
+
+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,30 @@
+[![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)
+# Girocode - create EPC QR codes for SEPA bank transfers
+
+Pure Ruby library to generate QR codes in SVG, PNG, HTML or ASCII format
+
+![Girocode](https://raw.githubusercontent.com/mtgrosser/girocode/master/test/demo.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'girocode'
+```
+
+## Usage
+
+```ruby
+code = Girocode.new(iban: 'DE02100500000054540402',
+                    name: 'Beispiel AG',
+                    currency: 'EUR', amount: 123.45,
+                    reference: 'RE 2019/05/445 744507')
+code.to_svg
+code.to_png
+code.to_html
+code.to_ascii
+
+# in your console
+puts code.to_ansi
+```

data/Rakefile

@@ -0,0 +1,10 @@
+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

data/lib/girocode.rb

@@ -0,0 +1,12 @@
+require 'bigdecimal'
+require 'bank/contact'
+require 'rqrcode'
+
+require_relative 'girocode/version'
+require_relative 'girocode/code'
+
+module Girocode
+  def self.new(**attrs)
+    Girocode::Code.new(**attrs)
+  end
+end

data/lib/girocode/code.rb

@@ -0,0 +1,119 @@
+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}"
+      end
+      attrs.each { |attr, value| send("#{attr}=", value) }
+      raise ArgumentError, "iban is required" unless iban?
+      raise ArgumentError, "name is required" unless name?
+      raise ArgumentError, 'currency is required for amount' if amount && !currency?
+      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)
+        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
+      raise ArgumentError, 'name too long' if value.size > 70
+      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
+    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
+  end
+end

data/lib/girocode/version.rb

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: girocode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  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: bank-contact
+  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: 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: EPC QR code for SEPA payments in any format
+email:
+- mtgrosser@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/girocode.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
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate QR codes for SEPA credit transfers
+test_files: []