sepa 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Sepa
 
-An implementation of pain.008.001.04 CustomerDirectDebitInitiation. WARNING: NO WARRANTY, USE AT YOUR OWN RISK AND PERIL. 
+An implementation of pain.008.001.04 CustomerDirectDebitInitiation. WARNING: NO WARRANTY, USE AT YOUR OWN RISK AND PERIL.
 
 I wanted to make it as easy as possible to define message types and components so this library will be easy to grow to implement the entire standard.
 
@@ -22,30 +22,36 @@ Or install it yourself as:
 
 ## Usage
 
-The simplest way to generate a pain.008.001.04 xml message is to use the DirectDebitOrder module which exposes only the bare essentials. Which is still a lot, but hey, this is a banking standard, what do you expect.
+The simplest way to generate a pain.008.001.04 xml message is to use the DirectDebitOrder module which exposes only the bare essentials. Which
+is still a lot, but hey, this is a banking standard, what do you expect.
 
-Here's an example, ripped off from the spec, of a direct debit order for payments to a single creditor -
+Here's an example, ripped off from the spec, of a direct debit order for payments to a single creditor. You need to provide a list of direct
+debits, each with information about the amount, the bank account to debit, and the name and contact details of the debtor. You also need to
+provide a "creditor" and "initiator" object, which also contain bank account and contact details. Finally, you need to supply a message identifier.
 
-    direct_debits = []
+    def create_sepa_direct_debit_order direct_debits, creditor, initiator, message_id
+      dd_list = []
 
-    # for each direct debit you want to order ...
+      # for each direct debit you want to order ...
 
-    for(each direct debit) do | ... |
-      bank_account = Sepa::DirectDebitOrder::BankAccount.new iban, bic
-      debtor = Sepa::DirectDebitOrder::Party.new name, addr, nil, postcode, town, country, contact, phone, email
-      direct_debits << Sepa::DirectDebitOrder::DirectDebit.new debtor, bank_account, end_to_end_id, amount, "EUR"
-    end
+      for(each direct_debit to order) do | ... |
+        bank_account = Sepa::DirectDebitOrder::BankAccount.new direct_debit.iban, direct_debit.bic
+        debtor = Sepa::DirectDebitOrder::Party.new direct_debit.name, direct_debit.addr, nil, direct_debit.postcode, direct_debit.town, direct_debit.country, direct_debit.contact, direct_debit.phone, direct_debit.email
+        dd_list << Sepa::DirectDebitOrder::DirectDebit.new debtor, bank_account, end_to_end_id(direct_debit), direct_debit.amount, "EUR"
+      end
+
+      creditor = Sepa::DirectDebitOrder::Party.new creditor.name, creditor.address, nil, creditor.postcode, creditor.town, creditor.country, creditor.contact, creditor.phone, creditor.email
 
-    creditor = Sepa::DirectDebitOrder::Party.new creditor_name, creditor_addr, nil, creditor_postcode, creditor_town, creditor_country, creditor_contact, creditor_phone, creditor_email
+      creditor_account = Sepa::DirectDebitOrder::BankAccount.new creditor.iban, creditor.bic
 
-    creditor_account = Sepa::DirectDebitOrder::BankAccount.new creditor_iban, creditor_bic
-    payment = Sepa::DirectDebitOrder::CreditorPayment.new creditor, creditor_account, payment_identifier, collection_date, direct_debits
+      payment = Sepa::DirectDebitOrder::CreditorPayment.new creditor, creditor_account, payment_identifier, collection_date, dd_list
 
-    initiator = Sepa::DirectDebitOrder::Party.new initiator, initiator_addr, nil, initiator_postcode, initiator_town, initiator_country, initiator_contact, initiator_phone, initiator_email
+      initiator = Sepa::DirectDebitOrder::Party.new initiator.identifier, initiator.address, nil, initiator.postcode, initiator.town, initiator.country, initiator.contact, initiator.phone, initiator.email
 
-    order = Sepa::DirectDebitOrder::Order.new message_identifier, initiator, [payment]
+      order = Sepa::DirectDebitOrder::Order.new message_id, initiator, [payment]
 
-    order.to_xml
+      order.to_xml
+    end
 
 The last line returns a string that you will then need to send to your bank one way or another. For example, you might use an EBICS client.
 

data/lib/sepa/direct_debit_order.rb

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+require 'sepa/payments_initiation/pain00800104/customer_direct_debit_initiation'
+
 class Sepa::DirectDebitOrder
 
   class Order

data/lib/sepa/payments_initiation/cash_account.rb

@@ -1,3 +1,4 @@
+require "sepa/payments_initiation/account_identification_choice"
 require "sepa/payments_initiation/cash_account_type_choice"
 
 class Sepa::PaymentsInitiation::CashAccount < Sepa::Base

data/lib/sepa/payments_initiation/pain00800104/direct_debit_transaction_information.rb

@@ -1,3 +1,5 @@
+require "sepa/payments_initiation/cash_account"
+require "sepa/payments_initiation/party_identification"
 require "sepa/payments_initiation/pain00800104/payment_identification"
 require "sepa/payments_initiation/pain00800104/payment_type_information"
 require "sepa/payments_initiation/pain00800104/direct_debit_transaction"

data/lib/sepa/payments_initiation/pain00800104/group_header.rb

@@ -1,3 +1,7 @@
+require 'sepa/payments_initiation/branch_and_financial_institution_identification'
+require 'sepa/payments_initiation/authorisation'
+require 'sepa/payments_initiation/party_identification'
+
 class Sepa::PaymentsInitiation::Pain00800104::GroupHeader < Sepa::Base
   definition "Set of characteristics shared by all individual transactions included in the message."
   attribute :message_identification, "MsgId"

data/lib/sepa/payments_initiation/party_identification.rb

@@ -1,3 +1,4 @@
+require "sepa/payments_initiation/contact_details"
 require "sepa/payments_initiation/postal_address"
 require "sepa/payments_initiation/party_choice_identification"
 

data/lib/sepa/version.rb

@@ -1,3 +1,3 @@
 module Sepa
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder