epics 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 196537be2328e1c2445eafddb04840616446d599e8f2c887b8d6e5884acd1107
-  data.tar.gz: 7d0fc17a578fcae3e3827d56375c20449961b40f581fdd2a192f7addf1ac3c6e
+  metadata.gz: 8cb98bb83470739103b20941fc4a5f636f57752d90941aa0ba9ac9e7c111503f
+  data.tar.gz: 134ef14259b6e5728677f45dd21446fc642f8eca7c6641e7befd537936c406b6
 SHA512:
-  metadata.gz: d8b5b8538c6c6100f1e6f9cf225999ec1d9bed0fa152bfb0aa5ff8f02cdfd545254eb9a348f03e868fa7544e67424b1fbd4277ba1185bc820fa68792ed23bb9b
-  data.tar.gz: e490b632b8f018aff18c8461780875190af6a287807c7baaaa579060eca89961b83bd3404291b31f98a54859a6a8eca9df2b7053c9de080a9043a7b1ae0a84f6
+  metadata.gz: 55ba0cecabed4d9397643b0fc7116c3675dc5bdc4d076e8599812338503061fb15521164b7ee02ce42cf7aa778fa3694c6ca0d0358dcbc2684cbffdfb9888374
+  data.tar.gz: 1df6989cdc96ee6e68069a34bdd6496e8a739b9665ab1c68f1533dd247664a67452e0157c3b1ea6eb84e66868e7e94094c344229b598a7de862d702e46b99e86

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 ### Unreleased
 
+### 2.4.0
+
+- [ENHANCEMENT]  Adds XE2 and XE3 order type (CCT and CDD for swiss banks)
+
+### 2.3.0
+
+- [ENHANCEMENT]  Adds Z52, Z53, Z54 order type (C52, C53, C54 for swiss banks)
+
 ### 2.2.0
 
-- [ENHANCEMENT]  Adds C2S order tyoe
+- [ENHANCEMENT]  Adds C2S order type
 - [HOUSEKEEPING] updates nokogiri dependency
 - [HOUSEKEEPING] updates rexml dependency
 - [HOUSEKEEPING] adds Ruby 3.3 to CI

data/lib/epics/client.rb

@@ -137,6 +137,14 @@ class Epics::Client
     upload(Epics::CDD, document)
   end
 
+  def XE2(document)
+    upload(Epics::XE2, document)
+  end
+
+  def XE3(document)
+    upload(Epics::XE3, document)
+  end
+
   def CDS(document)
     upload(Epics::CDS, document)
   end
@@ -185,6 +193,18 @@ class Epics::Client
     download_and_unzip(Epics::C54, from, to)
   end
 
+  def Z52(from, to)
+    download_and_unzip(Epics::Z52, from, to)
+  end
+
+  def Z53(from, to)
+    download_and_unzip(Epics::Z53, from, to)
+  end
+
+  def Z54(from, to)
+    download_and_unzip(Epics::Z54, from, to)
+  end
+
   def HAA
     Nokogiri::XML(download(Epics::HAA)).at_xpath("//xmlns:OrderTypes", xmlns: "urn:org:ebics:H004").content.split(/\s/)
   end

data/lib/epics/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Epics
-  VERSION = '2.2.0'
+  VERSION = '2.4.0'
 end

data/lib/epics/xe2.rb

@@ -0,0 +1,5 @@
+class Epics::XE2 < Epics::CCT
+  def order_type
+    'XE2'
+  end
+end

data/lib/epics/xe3.rb

@@ -0,0 +1,5 @@
+class Epics::XE3 < Epics::CDD
+  def order_type
+    'XE3'
+  end
+end

data/lib/epics/z52.rb

@@ -0,0 +1,42 @@
+class Epics::Z52 < Epics::GenericRequest
+  attr_accessor :from, :to
+
+  def initialize(client, from, to)
+    super(client)
+    self.from = from
+    self.to = to
+  end
+
+  def header
+    Nokogiri::XML::Builder.new do |xml|
+      xml.header(authenticate: true) {
+        xml.static {
+          xml.HostID host_id
+          xml.Nonce nonce
+          xml.Timestamp timestamp
+          xml.PartnerID partner_id
+          xml.UserID user_id
+          xml.Product("EPICS - a ruby ebics kernel", 'Language' => 'de')
+          xml.OrderDetails {
+            xml.OrderType 'Z52'
+            xml.OrderAttribute 'DZHNN'
+            xml.StandardOrderParams {
+              xml.DateRange {
+                xml.Start from
+                xml.End to
+              }
+            }
+          }
+          xml.BankPubKeyDigests {
+            xml.Authentication(client.bank_x.public_digest, Version: 'X002', Algorithm: "http://www.w3.org/2001/04/xmlenc#sha256")
+            xml.Encryption(client.bank_e.public_digest, Version: 'E002', Algorithm: "http://www.w3.org/2001/04/xmlenc#sha256" )
+          }
+          xml.SecurityMedium '0000'
+        }
+        xml.mutable {
+          xml.TransactionPhase 'Initialisation'
+        }
+      }
+    end.doc.root
+  end
+end

data/lib/epics/z53.rb

@@ -0,0 +1,42 @@
+class Epics::Z53 < Epics::GenericRequest
+  attr_accessor :from, :to
+
+  def initialize(client, from, to)
+    super(client)
+    self.from = from
+    self.to = to
+  end
+
+  def header
+    Nokogiri::XML::Builder.new do |xml|
+      xml.header(authenticate: true) {
+        xml.static {
+          xml.HostID host_id
+          xml.Nonce nonce
+          xml.Timestamp timestamp
+          xml.PartnerID partner_id
+          xml.UserID user_id
+          xml.Product("EPICS - a ruby ebics kernel", 'Language' => 'de')
+          xml.OrderDetails {
+            xml.OrderType 'Z53'
+            xml.OrderAttribute 'DZHNN'
+            xml.StandardOrderParams {
+              xml.DateRange {
+                xml.Start from
+                xml.End to
+              }
+            }
+          }
+          xml.BankPubKeyDigests {
+            xml.Authentication(client.bank_x.public_digest, Version: 'X002', Algorithm: "http://www.w3.org/2001/04/xmlenc#sha256")
+            xml.Encryption(client.bank_e.public_digest, Version: 'E002', Algorithm: "http://www.w3.org/2001/04/xmlenc#sha256" )
+          }
+          xml.SecurityMedium '0000'
+        }
+        xml.mutable {
+          xml.TransactionPhase 'Initialisation'
+        }
+      }
+    end.doc.root
+  end
+end

data/lib/epics/z54.rb

@@ -0,0 +1,42 @@
+class Epics::Z54 < Epics::GenericRequest
+  attr_accessor :from, :to
+
+  def initialize(client, from, to)
+    super(client)
+    self.from = from
+    self.to = to
+  end
+
+  def header
+    Nokogiri::XML::Builder.new do |xml|
+      xml.header(authenticate: true) {
+        xml.static {
+          xml.HostID host_id
+          xml.Nonce nonce
+          xml.Timestamp timestamp
+          xml.PartnerID partner_id
+          xml.UserID user_id
+          xml.Product("EPICS - a ruby ebics kernel", 'Language' => 'de')
+          xml.OrderDetails {
+            xml.OrderType 'Z54'
+            xml.OrderAttribute 'DZHNN'
+            xml.StandardOrderParams {
+              xml.DateRange {
+                xml.Start from
+                xml.End to
+              }
+            }
+          }
+          xml.BankPubKeyDigests {
+            xml.Authentication(client.bank_x.public_digest, Version: 'X002', Algorithm: "http://www.w3.org/2001/04/xmlenc#sha256")
+            xml.Encryption(client.bank_e.public_digest, Version: 'E002', Algorithm: "http://www.w3.org/2001/04/xmlenc#sha256" )
+          }
+          xml.SecurityMedium '0000'
+        }
+        xml.mutable {
+          xml.TransactionPhase 'Initialisation'
+        }
+      }
+    end.doc.root
+  end
+end

data/lib/epics.rb

@@ -26,6 +26,9 @@ require "epics/vmk"
 require "epics/c52"
 require "epics/c53"
 require "epics/c54"
+require "epics/z52"
+require "epics/z53"
+require "epics/z54"
 require "epics/ptk"
 require "epics/hac"
 require "epics/hpd"
@@ -34,6 +37,8 @@ require "epics/cct"
 require "epics/ccs"
 require "epics/cdb"
 require "epics/cdd"
+require "epics/xe2"
+require "epics/xe3"
 require "epics/b2b"
 require "epics/xds"
 require "epics/cds"

data/spec/client_spec.rb

@@ -209,25 +209,25 @@ RSpec.describe Epics::Client do
     end
   end
 
-  describe '#C53/C52/C54 types with zipped data' do
+  describe '#C53/C52/C54/Z52/Z53/Z54 types with zipped data' do
     before do
       allow(subject).to receive(:download).and_return( File.read(File.join(File.dirname(__FILE__), 'fixtures', 'test.zip') ))
     end
 
     it 'will unzip the returned data' do
-      %w(C52 C53 C54).each do |c|
+      %w(C52 C53 C54 Z52 Z53 Z54).each do |c|
         expect(subject.send(c, :today, :yesterday)).to eq(["ebics is great\n"])
       end
     end
   end
 
-  describe '#C53/C52/C54 types with zipped data with general purpose bit flag 3 set' do
+  describe '#C53/C52/C54/Z52/Z53/Z54 types with zipped data with general purpose bit flag 3 set' do
     before do
       allow(subject).to receive(:download).and_return( File.read(File.join(File.dirname(__FILE__), 'fixtures', 'test_with_general_purpose_bit_3.zip') ))
     end
 
     it 'will unzip the returned data' do
-      %w(C52 C53 C54).each do |c|
+      %w(C52 C53 C54 Z52 Z53 Z54).each do |c|
         expect(subject.send(c, :today, :yesterday)).to eq(["ebics is great\n"])
       end
     end

data/spec/fixtures/xml/swiss_credit_transfer.xml

@@ -0,0 +1,69 @@
+<?xml version="1.0"?>
+<Document xmlns="http://www.six-interbank-clearing.com/de/pain.001.001.03.ch.02.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.six-interbank-clearing.com/de/pain.001.001.03.ch.02.xsd pain.001.001.03.ch.02.xsd">
+  <CstmrCdtTrfInitn>
+    <GrpHdr>
+      <MsgId>SPS-KING/7c332aeb9ec40d29232691</MsgId>
+      <CreDtTm>2024-06-20T17:27:56+02:00</CreDtTm>
+      <NbOfTxs>1</NbOfTxs>
+      <CtrlSum>102.50</CtrlSum>
+      <InitgPty>
+        <Nm>Schuldner GmbH</Nm>
+      </InitgPty>
+    </GrpHdr>
+    <PmtInf>
+      <PmtInfId>SPS-KING/7c332aeb9ec40d29232691/1</PmtInfId>
+      <PmtMtd>TRF</PmtMtd>
+      <BtchBookg>false</BtchBookg>
+      <NbOfTxs>1</NbOfTxs>
+      <CtrlSum>102.50</CtrlSum>
+      <PmtTpInf>
+        <SvcLvl>
+          <Cd>SEPA</Cd>
+        </SvcLvl>
+      </PmtTpInf>
+      <ReqdExctnDt>1999-01-01</ReqdExctnDt>
+      <Dbtr>
+        <Nm>Schuldner GmbH</Nm>
+      </Dbtr>
+      <DbtrAcct>
+        <Id>
+          <IBAN>CH5481230000001998736</IBAN>
+        </Id>
+      </DbtrAcct>
+      <DbtrAgt>
+        <FinInstnId>
+          <BIC>RAIFCH22</BIC>
+        </FinInstnId>
+      </DbtrAgt>
+      <ChrgBr>SLEV</ChrgBr>
+      <CdtTrfTxInf>
+        <PmtId>
+          <EndToEndId>NOTPROVIDED</EndToEndId>
+        </PmtId>
+        <Amt>
+          <InstdAmt Ccy="CHR">102.50</InstdAmt>
+        </Amt>
+        <CdtrAgt>
+          <FinInstnId>
+            <BIC>CRESCHZZ80A</BIC>
+          </FinInstnId>
+        </CdtrAgt>
+        <Cdtr>
+          <Nm>Contoso AG</Nm>
+          <PstlAdr>
+            <StrtNm>Mustergasse</StrtNm>
+            <BldgNb>123a</BldgNb>
+            <PstCd>1234</PstCd>
+            <TwnNm>Musterstadt</TwnNm>
+            <Ctry>CH</Ctry>
+          </PstlAdr>
+        </Cdtr>
+        <CdtrAcct>
+          <Id>
+            <IBAN>CH9300762011623852957</IBAN>
+          </Id>
+        </CdtrAcct>
+      </CdtTrfTxInf>
+    </PmtInf>
+  </CstmrCdtTrfInitn>
+</Document>

data/spec/fixtures/xml/swiss_direct_debit.xml

@@ -0,0 +1,104 @@
+<?xml version="1.0"?>
+<Document xmlns="http://www.six-interbank-clearing.com/de/pain.008.001.02.ch.03.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.six-interbank-clearing.com/de/pain.008.001.02.ch.03.xsd pain.008.001.02.ch.03.xsd">
+  <CstmrDrctDbtInitn>
+    <GrpHdr>
+      <MsgId>SPS-KING/c1e3bcc1a22c941e6c631b</MsgId>
+      <CreDtTm>2024-06-20T17:43:31+02:00</CreDtTm>
+      <NbOfTxs>1</NbOfTxs>
+      <CtrlSum>39.99</CtrlSum>
+      <InitgPty>
+        <Nm>Glaubiger GmbH</Nm>
+        <Id>
+          <OrgId>
+            <Othr>
+              <Id>ABC1W</Id>
+            </Othr>
+          </OrgId>
+        </Id>
+      </InitgPty>
+    </GrpHdr>
+    <PmtInf>
+      <PmtInfId>SPS-KING/c1e3bcc1a22c941e6c631b/1</PmtInfId>
+      <PmtMtd>DD</PmtMtd>
+      <PmtTpInf>
+        <SvcLvl>
+          <Prtry>CHTA</Prtry>
+        </SvcLvl>
+        <LclInstrm>
+          <Prtry>LSV+</Prtry>
+        </LclInstrm>
+      </PmtTpInf>
+      <ReqdColltnDt>1999-01-01</ReqdColltnDt>
+      <Cdtr>
+        <Nm>Glaubiger GmbH</Nm>
+      </Cdtr>
+      <CdtrAcct>
+        <Id>
+          <IBAN>CH7081232000001998736</IBAN>
+        </Id>
+      </CdtrAcct>
+      <CdtrAgt>
+        <FinInstnId>
+          <ClrSysMmbId>
+            <MmbId>81232</MmbId>
+          </ClrSysMmbId>
+          <Othr>
+            <Id>010001456</Id>
+          </Othr>
+        </FinInstnId>
+      </CdtrAgt>
+      <CdtrSchmeId>
+        <Id>
+          <PrvtId>
+            <Othr>
+              <Id>ABC1W</Id>
+              <SchmeNm>
+                <Prtry>CHLS</Prtry>
+              </SchmeNm>
+            </Othr>
+          </PrvtId>
+        </Id>
+      </CdtrSchmeId>
+      <DrctDbtTxInf>
+        <PmtId>
+          <InstrId>12345</InstrId>
+          <EndToEndId>XYZ/2013-08-ABO/6789</EndToEndId>
+        </PmtId>
+        <InstdAmt Ccy="CHF">39.99</InstdAmt>
+        <DbtrAgt>
+          <FinInstnId>
+            <ClrSysMmbId>
+              <MmbId>4835</MmbId>
+            </ClrSysMmbId>
+          </FinInstnId>
+        </DbtrAgt>
+        <Dbtr>
+          <Nm>Zahlemann Soehne GbR</Nm>
+          <PstlAdr>
+            <StrtNm>Mustergasse</StrtNm>
+            <PstCd>1234</PstCd>
+            <TwnNm>Musterstadt</TwnNm>
+            <Ctry>CH</Ctry>
+          </PstlAdr>
+        </Dbtr>
+        <DbtrAcct>
+          <Id>
+            <IBAN>CH9804835011062385295</IBAN>
+          </Id>
+        </DbtrAcct>
+        <RmtInf>
+          <Strd>
+            <CdtrRefInf>
+              <Tp>
+                <CdOrPrtry>
+                  <Prtry>ESR</Prtry>
+                </CdOrPrtry>
+              </Tp>
+              <Ref>609323234234234353453423423</Ref>
+            </CdtrRefInf>
+          </Strd>
+        </RmtInf>
+      </DrctDbtTxInf>
+    </PmtInf>
+  </CstmrDrctDbtInitn>
+</Document>

data/spec/orders/xe2_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Epics::XE2 do
+
+  let(:client) { Epics::Client.new( File.open(File.join( File.dirname(__FILE__), '..', 'fixtures', 'SIZBN001.key')), 'secret' , 'https://194.180.18.30/ebicsweb/ebicsweb', 'SIZBN001', 'EBIX', 'EBICS') }
+  let(:document) { File.read( File.join( File.dirname(__FILE__), '..', 'fixtures', 'xml', 'swiss_credit_transfer.xml') ) }
+  subject { described_class.new(client, document) }
+
+  describe '#to_xml' do
+    specify { expect(subject.to_xml).to be_a_valid_ebics_doc }
+  end
+
+  describe '#to_transfer_xml' do
+    before { subject.transaction_id = SecureRandom.hex(16) }
+
+    specify { expect(subject.to_transfer_xml).to be_a_valid_ebics_doc }
+  end
+
+end

data/spec/orders/xe3_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Epics::XE3 do
+
+  let(:client) { Epics::Client.new( File.open(File.join( File.dirname(__FILE__), '..', 'fixtures', 'SIZBN001.key')), 'secret' , 'https://194.180.18.30/ebicsweb/ebicsweb', 'SIZBN001', 'EBIX', 'EBICS') }
+  let(:document) { File.read( File.join( File.dirname(__FILE__), '..', 'fixtures', 'xml', 'swiss_direct_debit.xml') ) }
+  subject { described_class.new(client, document) }
+
+  describe '#to_xml' do
+    specify { expect(subject.to_xml).to be_a_valid_ebics_doc }
+  end
+
+  describe '#to_transfer_xml' do
+    before { subject.transaction_id = SecureRandom.hex(16) }
+
+    specify { expect(subject.to_transfer_xml).to be_a_valid_ebics_doc }
+  end
+
+end

data/spec/orders/z52_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Epics::Z52 do
+
+  let(:client) { Epics::Client.new( File.open(File.join( File.dirname(__FILE__), '..', 'fixtures', 'SIZBN001.key')), 'secret' , 'https://194.180.18.30/ebicsweb/ebicsweb', 'SIZBN001', 'EBIX', 'EBICS') }
+
+  subject { described_class.new(client, "2014-09-01", "2014-09-30") }
+
+  describe '#to_xml' do
+    specify { expect(subject.to_xml).to be_a_valid_ebics_doc }
+  end
+
+end

data/spec/orders/z53_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Epics::Z53 do
+
+  let(:client) { Epics::Client.new( File.open(File.join( File.dirname(__FILE__), '..', 'fixtures', 'SIZBN001.key')), 'secret' , 'https://194.180.18.30/ebicsweb/ebicsweb', 'SIZBN001', 'EBIX', 'EBICS') }
+
+  subject { described_class.new(client, "2014-09-01", "2014-09-30") }
+
+  describe '#to_xml' do
+    specify { expect(subject.to_xml).to be_a_valid_ebics_doc }
+  end
+
+end

data/spec/orders/z54_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe Epics::Z54 do
+  let(:client) { Epics::Client.new( File.open(File.join( File.dirname(__FILE__), '..', 'fixtures', 'SIZBN001.key')), 'secret' , 'https://194.180.18.30/ebicsweb/ebicsweb', 'SIZBN001', 'EBIX', 'EBICS') }
+
+  subject { described_class.new(client, "2014-09-01", "2014-09-30") }
+
+  describe '#to_xml' do
+    specify { expect(subject.to_xml).to be_a_valid_ebics_doc }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epics
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Lars Brillert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -215,6 +215,11 @@ files:
 - lib/epics/vmk.rb
 - lib/epics/xct.rb
 - lib/epics/xds.rb
+- lib/epics/xe2.rb
+- lib/epics/xe3.rb
+- lib/epics/z52.rb
+- lib/epics/z53.rb
+- lib/epics/z54.rb
 - lib/letter/ini.erb
 - spec/.DS_Store
 - spec/client_spec.rb
@@ -252,6 +257,8 @@ files:
 - spec/fixtures/xml/signature_pub_key_order_data.xml
 - spec/fixtures/xml/sta_response.xml
 - spec/fixtures/xml/sta_response_continued.xml
+- spec/fixtures/xml/swiss_credit_transfer.xml
+- spec/fixtures/xml/swiss_direct_debit.xml
 - spec/fixtures/xml/upload_init_response.xml
 - spec/generic_upload_spec.rb
 - spec/hpb_spec.rb
@@ -282,6 +289,11 @@ files:
 - spec/orders/sta_spec.rb
 - spec/orders/vmk_spec.rb
 - spec/orders/xds_spec.rb
+- spec/orders/xe2_spec.rb
+- spec/orders/xe3_spec.rb
+- spec/orders/z52_spec.rb
+- spec/orders/z53_spec.rb
+- spec/orders/z54_spec.rb
 - spec/response_spec.rb
 - spec/signer_spec.rb
 - spec/spec_helper.rb
@@ -362,6 +374,8 @@ test_files:
 - spec/fixtures/xml/signature_pub_key_order_data.xml
 - spec/fixtures/xml/sta_response.xml
 - spec/fixtures/xml/sta_response_continued.xml
+- spec/fixtures/xml/swiss_credit_transfer.xml
+- spec/fixtures/xml/swiss_direct_debit.xml
 - spec/fixtures/xml/upload_init_response.xml
 - spec/generic_upload_spec.rb
 - spec/hpb_spec.rb
@@ -392,6 +406,11 @@ test_files:
 - spec/orders/sta_spec.rb
 - spec/orders/vmk_spec.rb
 - spec/orders/xds_spec.rb
+- spec/orders/xe2_spec.rb
+- spec/orders/xe3_spec.rb
+- spec/orders/z52_spec.rb
+- spec/orders/z53_spec.rb
+- spec/orders/z54_spec.rb
 - spec/response_spec.rb
 - spec/signer_spec.rb
 - spec/spec_helper.rb