sepa_king 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d39443f2a8e1403804bfc6dd0eeb03f9e5e9d845
-  data.tar.gz: 7fa5f5072912dee37819412cc0e05229c371b33a
+  metadata.gz: 5cc20b05ec4228c5ed453503dd90329e3b6366b3
+  data.tar.gz: 884d0f00387ef8d8a50b06a529a92d4220897773
 SHA512:
-  metadata.gz: a6aa54767870360c955f350ae74bd3777fc6f7928b9cf9b75806689e76f4b70db70f5f722e426c7b4df075b6dcba939e560e84af479d56417c2b8caac9b173a1
-  data.tar.gz: 9a06003c4a9d9c9fdbf58d1d6430651888339317c1f1a8f98d2f5c1a5f320b7b60457e3fae7e7ce8d8c74e6fdc9e3d4b2052aeae96e742079c3dbc4650a5cf1b
+  metadata.gz: 21b8f10e50d79e84d5a9ef67a54b15999e48efa0d13e8bc9df75387638395cc852e37c2e7f8541763aaee9fd74eee3e969d95a08a04a744e3ad16869ac326eaf
+  data.tar.gz: ae7a218d84ba1ee072079a1720d9da747d8c6d6c24179db3ec4b7cc7d1b7e3ac61556a9260836d36eeabf33111efd97910a210709f7d75ca6a17b12a45e28dc9

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,7 +1,7 @@
-The MIT License (MIT)
-
 Copyright (c) 2013 Georg Leciejewski (Sales King GmbH) & Georg Ledermann
 
+MIT License
+
 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

data/README.md

@@ -0,0 +1,174 @@
+# Ruby gem for creating SEPA XML files
+
+[![Build Status](https://secure.travis-ci.org/salesking/sepa_king.png)](http://travis-ci.org/salesking/sepa_king)
+[![Code Climate](https://codeclimate.com/github/salesking/sepa_king.png)](https://codeclimate.com/github/salesking/sepa_king)
+[![Coverage Status](https://coveralls.io/repos/salesking/sepa_king/badge.png)](https://coveralls.io/r/salesking/sepa_king)
+
+We love building payment applications! So after developing the [DTAUS library for Ruby](https://github.com/salesking/king_dtaus) we move on with SEPA.
+
+
+## Features
+
+* Credit transfer initiation (pain.001.002.03)
+* Debit transfer initiation (pain.008.002.02)
+* Tested with Ruby 1.9.3 and 2.0.0
+
+
+## Installation
+
+    gem install sepa_king
+
+
+## Usage
+
+How to create the XML for **Direct Debit Initiation** (in German: "Lastschriften")
+
+```ruby
+# First: Create the main object
+sdd = SEPA::DirectDebit.new(
+  # Name of the initiating party and creditor, in German: "Auftraggeber"
+  # String, max. 70 char
+  name:       'Gläubiger GmbH',
+
+  # Business Identifier Code (SWIFT-Code) of the creditor
+  # String, 8 or 11 char
+  bic:        'BANKDEFFXXX',
+
+  # International Bank Account Number of the creditor
+  # String, max. 34 chars
+  iban:       'DE87200500001234567890',
+
+  # Creditor Identifier, in German: Gläubiger-Identifikationsnummer
+  # String, max. 35 chars
+  creditor_identifier: 'DE98ZZZ09999999999'
+)
+
+# Second: Add transactions
+sdd.add_transaction(
+  # Name of the debitor, in German: "Zahlungspflichtiger"
+  # String, max. 70 char
+  name:                      'Zahlemann & Söhne GbR',
+
+  # Business Identifier Code (SWIFT-Code) of the debitor's account
+  # String, 8 or 11 char
+  bic:                       'SPUEDE2UXXX',
+
+  # International Bank Account Number of the debitor's account
+  # String, max. 34 chars
+  iban:                      'DE21500500009876543210',
+
+  # Amount in EUR
+  # Number with two decimal digit
+  amount:                    39.99,
+
+  # OPTIONAL: End-To-End-Identification, will be submitted to the debitor
+  # String, max. 35 char
+  reference:                 'XYZ/2013-08-ABO/6789',
+
+  # OPTIONAL: Unstructured remittance Information, in German "Verwendungszweck"
+  # String, max. 140 char
+  remittance_information:    'Vielen Dank für Ihren Einkauf!',
+
+  # Mandate identifikation, in German "Mandatsreferenz"
+  # String, max. 35 char
+  mandate_id:                'K-02-2011-12345',
+
+  # Mandate Date of signature, in German "Datum, zu dem das Mandat unterschrieben wurde"
+  # Date
+  mandate_date_of_signature: Date.new(2011,1,25),
+
+  # Local instrument, in German "Lastschriftart"
+  # One of this strings:
+  #   'CORE' ("Basis-Lastschrift")
+  #   'B2B' ("Firmen-Lastschrift")
+  local_instrument: 'CORE',
+
+  # Sequence type
+  # One of this strings:
+  #   'FRST' ("Erst-Lastschrift")
+  #   'RCUR' ("Folge-Lastschrift")
+  #   'OOFF' ("Einmalige Lastschrift")
+  #   'FNAL' ("Letztmalige Lastschrift")
+  sequence_type: 'OOFF',
+
+  # OPTIONAL: Requested collection date, in German "Fälligkeitsdatum der Lastschrift"
+  # Date
+  requested_date: Date.new(2013,9,5),
+
+  # OPTIONAL: Enables or disables batch booking, in German "Sammelbuchung / Einzelbuchung"
+  batch_booking: true
+)
+sdd.add_transaction ...
+
+# Last: create XML string
+xml_string = sdd.to_xml
+```
+
+
+How to create the XML for **Credit Transfer Initiation** (in german: "Überweisungen")
+
+```ruby
+# First: Create the main object
+sct = SEPA::CreditTransfer.new(
+  # Name of the initiating party and debitor, in German: "Auftraggeber"
+  # String, max. 70 char
+  name: 'Schuldner GmbH',
+
+  # Business Identifier Code (SWIFT-Code) of the debitor
+  # String, 8 or 11 char
+  bic:  'BANKDEFFXXX',
+
+  # International Bank Account Number of the debitor
+  # String, max. 34 chars
+  iban: 'DE87200500001234567890'
+)
+
+# Second: Add transactions
+sct.add_transaction(
+  # Name of the creditor, in German: "Zahlungsempfänger"
+  # String, max. 70 char
+  name:                   'Telekomiker AG',
+
+  # Business Identifier Code (SWIFT-Code) of the creditor's account
+  # String, 8 or 11 char
+  bic:                    'PBNKDEFF370',
+
+  # International Bank Account Number of the creditor's account
+  # String, max. 34 chars
+  iban:                   'DE37112589611964645802',
+
+  # Amount in EUR
+  # Number with two decimal digit
+  amount:                 102.50,
+
+  # OPTIONAL: End-To-End-Identification, will be submitted to the creditor
+  # String, max. 35 char
+  reference:              'XYZ-1234/123',
+
+  # OPTIONAL: Unstructured remittance Information, in German "Verwendungszweck"
+  # String, max. 140 char
+  remittance_information: 'Rechnung vom 22.08.2013'
+)
+sct.add_transaction ...
+
+# Last: create XML string
+xml_string = sct.to_xml
+```
+
+
+## Changelog
+
+https://github.com/salesking/sepa_king/releases
+
+
+## Resources
+
+* http://www.ebics.de/index.php?id=77
+* SalesKing: http://salesking.eu
+
+
+## License
+
+Released under the MIT license
+
+Copyright (c) 2013 Georg Leciejewski (SalesKing), Georg Ledermann (https://github.com/ledermann)

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/sepa_king.rb

@@ -5,6 +5,7 @@ require 'builder'
 require 'iban-tools'
 
 require 'sepa_king/converter'
+require 'sepa_king/validator'
 require 'sepa_king/account'
 require 'sepa_king/account/debtor_account'
 require 'sepa_king/account/creditor_account'

data/lib/sepa_king/account.rb

@@ -1,18 +1,19 @@
 # encoding: utf-8
 module SEPA
   class Account
-    include ActiveModel::Model
+    include ActiveModel::Validations
     extend Converter
 
     attr_accessor :name, :iban, :bic
-    convert :name, :to => :text
+    convert :name, to: :text
 
-    validates_presence_of :name, :iban, :bic
-    validates_length_of :name, :maximum => 70
-    validates_length_of :bic, :within => 8..11
+    validates_length_of :name, within: 1..70
+    validates_with BICValidator, IBANValidator
 
-    validate do |t|
-      errors.add(:iban, 'is invalid') unless IBANTools::IBAN.valid?(t.iban.to_s)
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
     end
   end
 end

data/lib/sepa_king/account/creditor_account.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 module SEPA
   class CreditorAccount < Account
-    attr_accessor :identifier
+    attr_accessor :creditor_identifier
 
-    validates_length_of :identifier, :is => 18
+    validates_with CreditorIdentifierValidator
   end
 end

data/lib/sepa_king/message.rb

@@ -3,11 +3,11 @@
 module SEPA
   class Message
     attr_reader :account, :transactions
-    class_attribute :account_class, :transaction_class
+    class_attribute :account_class, :transaction_class, :xml_main_tag
 
     def initialize(account_options={})
       @transactions = []
-      @account = self.account_class.new(account_options)
+      @account = account_class.new(account_options)
     end
 
     def add_transaction(options)
@@ -16,12 +16,22 @@ module SEPA
       @transactions << transaction
     end
 
+    # @return [String] xml
     def to_xml
       raise RuntimeError.new(account.errors.full_messages.join("\n")) unless account.valid?
+
+      builder = Builder::XmlMarkup.new indent: 2
+      builder.instruct!
+      builder.Document(xml_schema) do
+        builder.__send__(xml_main_tag) do
+          build_group_header(builder)
+          build_payment_informations(builder)
+        end
+      end
     end
 
-    def amount_total
-      transactions.inject(0) { |sum, t| sum + t.amount }
+    def amount_total(selected_transactions=transactions)
+      selected_transactions.inject(0) { |sum, t| sum + t.amount }
     end
 
   private

data/lib/sepa_king/message/credit_transfer.rb

@@ -4,80 +4,87 @@ module SEPA
   class CreditTransfer < Message
     self.account_class = DebtorAccount
     self.transaction_class = CreditTransferTransaction
+    self.xml_main_tag = 'CstmrCdtTrfInitn'
 
-    def to_xml
-      super
+  private
+    # @return {Hash<Symbol=>String>} xml schema information used in output xml
+    def xml_schema
+      { :xmlns                => 'urn:iso:std:iso:20022:tech:xsd:pain.001.002.03',
+        :'xmlns:xsi'          => 'http://www.w3.org/2001/XMLSchema-instance',
+        :'xsi:schemaLocation' => 'urn:iso:std:iso:20022:tech:xsd:pain.001.002.03 pain.001.002.03.xsd' }
+    end
 
-      builder = Builder::XmlMarkup.new :indent => 2
-      builder.instruct!
-      builder.Document :xmlns                => 'urn:iso:std:iso:20022:tech:xsd:pain.001.002.03',
-                       :'xmlns:xsi'          => 'http://www.w3.org/2001/XMLSchema-instance',
-                       :'xsi:schemaLocation' => 'urn:iso:std:iso:20022:tech:xsd:pain.001.002.03 pain.001.002.03.xsd' do
-        builder.CstmrCdtTrfInitn do
-          build_group_header(builder)
-          build_payment_information(builder)
-        end
+    # Find groups of transactions which share the same values of some attributes
+    def grouped_transactions
+      transactions.group_by do |transaction|
+        { requested_date: transaction.requested_date,
+          batch_booking:  transaction.batch_booking
+        }
       end
     end
 
-  private
-    def build_payment_information(builder)
-      builder.PmtInf do
-        builder.PmtInfId(payment_information_identification)
-        builder.PmtMtd('TRF')
-        builder.BtchBookg(true)
-        builder.NbOfTxs(transactions.length)
-        builder.CtrlSum('%.2f' % amount_total)
-        builder.PmtTpInf do
-          builder.SvcLvl do
-            builder.Cd('SEPA')
+    def build_payment_informations(builder)
+      # Build a PmtInf block for every group of transactions
+      grouped_transactions.each do |group, transactions|
+        # All transactions with the same requested_date are placed into the same PmtInf block
+        builder.PmtInf do
+          builder.PmtInfId(payment_information_identification)
+          builder.PmtMtd('TRF')
+          builder.BtchBookg(group[:batch_booking])
+          builder.NbOfTxs(transactions.length)
+          builder.CtrlSum('%.2f' % amount_total(transactions))
+          builder.PmtTpInf do
+            builder.SvcLvl do
+              builder.Cd('SEPA')
+            end
           end
-        end
-        builder.ReqdExctnDt(Date.today.next.iso8601)
-        builder.Dbtr do
-          builder.Nm(account.name)
-        end
-        builder.DbtrAcct do
-          builder.Id do
-            builder.IBAN(account.iban)
+          builder.ReqdExctnDt(group[:requested_date].iso8601)
+          builder.Dbtr do
+            builder.Nm(account.name)
           end
-        end
-        builder.DbtrAgt do
-          builder.FinInstnId do
-            builder.BIC(account.bic)
+          builder.DbtrAcct do
+            builder.Id do
+              builder.IBAN(account.iban)
+            end
+          end
+          builder.DbtrAgt do
+            builder.FinInstnId do
+              builder.BIC(account.bic)
+            end
+          end
+          builder.ChrgBr('SLEV')
+
+          transactions.each do |transaction|
+            build_transaction(builder, transaction)
           end
         end
-        builder.ChrgBr('SLEV')
-        build_transactions(builder)
       end
     end
 
-    def build_transactions(builder)
-      transactions.each do |transaction|
-        builder.CdtTrfTxInf do
-          builder.PmtId do
-            builder.EndToEndId(transaction.reference || 'NOTPROVIDED')
-          end
-          builder.Amt do
-            builder.InstdAmt('%.2f' % transaction.amount, :Ccy => 'EUR')
-          end
-          builder.CdtrAgt do
-            builder.FinInstnId do
-              builder.BIC(transaction.bic)
-            end
-          end
-          builder.Cdtr do
-            builder.Nm(transaction.name)
+    def build_transaction(builder, transaction)
+      builder.CdtTrfTxInf do
+        builder.PmtId do
+          builder.EndToEndId(transaction.reference)
+        end
+        builder.Amt do
+          builder.InstdAmt('%.2f' % transaction.amount, Ccy: 'EUR')
+        end
+        builder.CdtrAgt do
+          builder.FinInstnId do
+            builder.BIC(transaction.bic)
           end
-          builder.CdtrAcct do
-            builder.Id do
-              builder.IBAN(transaction.iban)
-            end
+        end
+        builder.Cdtr do
+          builder.Nm(transaction.name)
+        end
+        builder.CdtrAcct do
+          builder.Id do
+            builder.IBAN(transaction.iban)
           end
-          if transaction.remittance_information
-            builder.RmtInf do
-              builder.Ustrd(transaction.remittance_information)
-            end
+        end
+        if transaction.remittance_information
+          builder.RmtInf do
+            builder.Ustrd(transaction.remittance_information)
           end
         end
       end