epics 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cf646dc0ea923f4e7f5846755a2040471b16a3fb955f609093f3e55d499ef68
-  data.tar.gz: 1678882aa4ea27b878f692607b8f84b92e9d094a7c9dd93cfd1bb0d649b7c639
+  metadata.gz: 16a3bb74f8943c4f82b808e830e2306d2af5bfb80e80a4985ca47760b8e6a28f
+  data.tar.gz: 2ae911622605fb2965431fd7fb78f16e97e4bf1151fe0ec0f47c30632015a125
 SHA512:
-  metadata.gz: 4b8efb42f871895126c0616dde21bcb5bd2fbd7cad0aa4b1f666192903517c9fb95df20cdd997f44fded94e858e8db515bc5510e879c7b25217fc35fd3fab5d0
-  data.tar.gz: 52a30f3d601dd5536abe79e18fab70107b803496173a664f3b0c437612fb9e8c8fa97049412fff4de1f67551dc9563d1c2be643600812973650288ca8081d3aa
+  metadata.gz: 3ca8b3806e14e95aeed7576b48aebe5c04c7cbfac8e524f9e89da93716735533567d8c20529934d2bb65875b9db828318639f2d5ede1592cd53f210b41e6e398
+  data.tar.gz: 7c8f67d58425a6dc8ce16427c89960d50ecc55f4ee18880c2012655d4f271df719dca55c955ce04da3ccd8a12e4a104b30b948af38f029884947a2484d99491b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.7.2
+
+- [FEATURE] adds XCT order type (thanks to @punkle64)
+
 ### 1.7.1
 
 - [HOUSEKEEPING] sets headers for requests to text/xml

data/README.md

@@ -10,7 +10,6 @@ The client supports the complete initialization process comprising INI, HIA and
 INI letter generation. It offers support for the most common download and upload order types
 (STA HAA HTD HPD PTK HAC HKD C52 C53 C54 CD1 CDB CDD CCT VMK).
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,7 +22,6 @@ Or install it yourself as:
 
     $ gem install epics
 
-
 ## Getting started
 
 In case you are new to EBICS, you'll have to complete an initialization process with
@@ -33,10 +31,10 @@ bank.
 
 Once the paperwork is done, your bank should provide you with:
 
-* _a_ URL to their EBICS Server
-* _a_ HOST ID
-* _a_ PARTNER ID
-* _n_ User IDs (depends on your bank and needs)
+- _a_ URL to their EBICS Server
+- _a_ HOST ID
+- _a_ PARTNER ID
+- _n_ User IDs (depends on your bank and needs)
 
 Take these parameters and start setting up an UserID (repeat this for every user you want to initialize):
 
@@ -51,7 +49,7 @@ e.save_keys("/home/epics/my.key")
 # or store the json elsewhere, but store it! for gods sake :D
 ```
 
-It is really __important__ to keep your keys around, once your user has been initialized
+It is really **important** to keep your keys around, once your user has been initialized
 you'll have to start over when you loose the keys!
 
 Submit the keys to your bank:
@@ -93,15 +91,13 @@ e.HAA
 
 To get a list of all supported order types.
 
-
 ## Need help? Having questions?
 
 We have many years of experience in developing innovative applications for the finance sector and
 integrating applications with financial institutions. - you might want to have a look at our
 [portfolio](http://www.railslove.com/portfolio)
-__If you need help we are happy to provide consulting or development services. Contact us:
-[team@railslove.com](mailto:team@railslove.com)__
-
+**If you need help we are happy to provide consulting or development services. Contact us:
+[team@railslove.com](mailto:team@railslove.com)**
 
 ## Usage
 
@@ -117,27 +113,26 @@ keys = File.read('/tmp/my.key')
 e = Epics::Client.new(keys, 'passphrase', 'url', 'host', 'user', 'partner')
 ```
 
-
 ## Features
 
 ### Initialization
 
-* INI (Sends the public key of the electronic signature.)
-* HIA (Sends the public authentication (X002) and encryption (E002) keys.)
+- INI (Sends the public key of the electronic signature.)
+- HIA (Sends the public authentication (X002) and encryption (E002) keys.)
 
 ### Downloads
 
 Currently this EPICS implementation supports the following order types:
 
-* HPB (fetch your bank's public keys)
-* STA (statements in MT940 format)
-* HAA (available order types)
-* HTD (user properties and settings)
-* HPD (the available bank parameters)
-* PTK (customer usage report in text format)
-* HAC (customer usage report in xml format)
-* VMK (customer usage report in xml format)
-* ... more coming soon
+- HPB (fetch your bank's public keys)
+- STA (statements in MT940 format)
+- HAA (available order types)
+- HTD (user properties and settings)
+- HPD (the available bank parameters)
+- PTK (customer usage report in text format)
+- HAC (customer usage report in xml format)
+- VMK (customer usage report in xml format)
+- ... more coming soon
 
 Example:
 
@@ -165,11 +160,11 @@ puts e.STA('2014-09-01', '2014-09-11')
 
 ### Uploads
 
-* CD1 (Uploads a SEPA Direct Debit document of type COR1)
-* CDB (Uploads a SEPA Direct Debit document of type B2B)
-* CDD (Uploads a SEPA Direct Debit document of type CORE)
-* CCT (Uploads a SEPA Credit document)
-* ... more coming soon
+- CD1 (Uploads a SEPA Direct Debit document of type COR1)
+- CDB (Uploads a SEPA Direct Debit document of type B2B)
+- CDD (Uploads a SEPA Direct Debit document of type CORE)
+- CCT (Uploads a SEPA Credit document)
+- ... more coming soon
 
 Example:
 
@@ -187,22 +182,19 @@ puts e.CD1(File.read("/where/the/xml/is/stored.xml"))
 Once you have a client, go ahead and start playing! There are 3 convenience methods
 that are hiding some strange names from you:
 
-* debit( _xml_ ) (submits a PAIN.008.003.02 document via CDD)
-* credit( _xml_ ) (submits a pain.001.003.03 document)
-* statements( _from_, _to_ ) (fetches an account statement via STA)
+- debit( _xml_ ) (submits a PAIN.008.003.02 document via CDD)
+- credit( _xml_ ) (submits a pain.001.003.03 document)
+- statements( _from_, _to_ ) (fetches an account statement via STA)
 
 If you need more sophisticated EBICS order types, please read the next section
 about the supported functionalities.
 
-
 ## Issues and Feature Requests
 
 [Railslove](http://railslove.com) is commited to provide the best developer tools for integrating
 with financial institutions. Epics is one of our many tools and services.
 If you are missing some features or something is not working as expected please create an issue.
 
-
-
 ## Supported Banks
 
 This gem provides a full implementation of the Electronic Banking Internet Communication Standard
@@ -212,26 +204,25 @@ what order types are available.
 Besides EBCIS being a standard, some server implementations are slighty different.
 But most banks use the same EBICS server implementations. Commonly used and supported by Epics are:
 
-* Business-Logics EBICS, Banking-Server
-* Travic Corporate
+- Business-Logics EBICS, Banking-Server
+- Travic Corporate
 
 Used for example by the following tested institutions:
 
-* Handelsbank
-* Deutsche Bank
-* Commerzbank
-* Kreissparkasse Mayen
-* Postbank
-* Sozialbank
-* Sparkassen
-* Volksbanken Raiffeisenbanken
-* Hypo Vereinsbank
-* BAWAG P.S.K. (AT)
-* Bank Frick (LI)
+- Handelsbank
+- Deutsche Bank
+- Commerzbank
+- Kreissparkasse Mayen
+- Postbank
+- Sozialbank
+- Sparkassen
+- Volksbanken Raiffeisenbanken
+- Hypo Vereinsbank
+- BAWAG P.S.K. (AT)
+- Bank Frick (LI)
 
 Is Epics working with your institution? Please help us to grow this list of supported banks:
 
-
 ## Development
 
 For development purposes, you may want to use a proxy server in order to have a convienent look into request and response data.
@@ -239,6 +230,7 @@ To do so, it's sufficient to define `http_proxy` in your environment.
 Also you may want to disable SSL verification - simply set `EPICS_VERIFY_SSL` to `"false"`.
 
 For example:
+
 ```
 http_proxy=localhost:8080
 EPICS_VERIFY_SSL=false
@@ -246,21 +238,30 @@ EPICS_VERIFY_SSL=false
 
 ## Links
 
-* [ebics.de](http://www.ebics.de/)
-* [EBICS specification](http://www.ebics.de/index.php?id=30)
-* [Common Integrative Implementation Guide to Supplement the EBICS Specification (pdf)](http://www.ebics.de/fileadmin/unsecured/specification/implementation_guide_DE/EBICS_Common_IG_basiert_auf_EBICS_2.5.pdf)
-* [Die Deutsche Kreditwirtschaft](http://www.die-deutsche-kreditwirtschaft.de/)
-
+- [ebics.de](http://www.ebics.de/)
+- [EBICS specification](http://www.ebics.de/index.php?id=30)
+- [Common Integrative Implementation Guide to Supplement the EBICS Specification (pdf)](http://www.ebics.de/fileadmin/unsecured/specification/implementation_guide_DE/EBICS_Common_IG_basiert_auf_EBICS_2.5.pdf)
+- [Die Deutsche Kreditwirtschaft](http://www.die-deutsche-kreditwirtschaft.de/)
 
 ## Contributing
 
 0. Contact team@railslove.com for information about the CLA
 1. Fork it ( https://github.com/[my-github-username]/epics/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
+
+## Contribution Credits
+
+- [@punkle64](https://github.com/punkle64) \
+  for adding XCT order type
+- [@romanlehnert](https://github.com/romanlehnert) \
+  for adding CDB order type
+- [@gadimbaylisahil](https://github.com/gadimbaylisahil) \
+  for fixing CCS order type and attribute
+- you, for contributing too!
 
+---
 
-------------
 2014-2018 - built with love by [Railslove](http://railslove.com) and released under the [GNU LESSER GENERAL PUBLIC LICENSE](https://github.com/railslove/epics/blob/master/LICENSE.txt). We have built quite a number of FinTech products. If you need support we are happy to help. Please contact us at team@railslove.com.

data/lib/epics.rb

@@ -36,8 +36,10 @@ require "epics/ccs"
 require "epics/cdb"
 require "epics/cdd"
 require "epics/b2b"
+require "epics/xds"
 require "epics/cds"
 require "epics/cdz"
+require "epics/xct"
 require "epics/hia"
 require "epics/ini"
 require "epics/signer"

data/lib/epics/client.rb

@@ -139,6 +139,10 @@ class Epics::Client
     upload(Epics::CDS, document)
   end
 
+  def XDS(document)
+    upload(Epics::XDS, document)
+  end
+
   def CDZ(document)
     upload(Epics::CDZ, document)
   end
@@ -151,6 +155,10 @@ class Epics::Client
     upload(Epics::CCS, document)
   end
 
+  def XCT(document)
+    upload(Epics::XCT, document)
+  end
+
   def STA(from = nil, to = nil)
     download(Epics::STA, from, to)
   end
@@ -177,9 +185,9 @@ class Epics::Client
 
   def HTD
     Nokogiri::XML(download(Epics::HTD)).tap do |htd|
-      @iban        ||= htd.at_xpath("//xmlns:AccountNumber[@international='true']", xmlns: "urn:org:ebics:H004").text
-      @bic         ||= htd.at_xpath("//xmlns:BankCode[@international='true']", xmlns: "urn:org:ebics:H004").text
-      @name        ||= htd.at_xpath("//xmlns:Name", xmlns: "urn:org:ebics:H004").text
+      @iban        ||= htd.at_xpath("//xmlns:AccountNumber[@international='true']", xmlns: "urn:org:ebics:H004").text rescue nil
+      @bic         ||= htd.at_xpath("//xmlns:BankCode[@international='true']", xmlns: "urn:org:ebics:H004").text rescue nil
+      @name        ||= htd.at_xpath("//xmlns:Name", xmlns: "urn:org:ebics:H004").text rescue nil
       @order_types ||= htd.search("//xmlns:OrderTypes", xmlns: "urn:org:ebics:H004").map{|o| o.content.split(/\s/) }.delete_if{|o| o == ""}.flatten
     end.to_xml
   end

data/lib/epics/error.rb

@@ -333,4 +333,5 @@ class Epics::Error < StandardError
     }
   end
 
-end
+end
+class Epics::Error::UnknownError < StandardError; end

data/lib/epics/middleware/parse_ebics.rb

@@ -1,15 +1,20 @@
-class Epics::ParseEbics < Faraday::Middleware
+# frozen_string_literal: true
 
+class Epics::ParseEbics < Faraday::Middleware
   def initialize(app = nil, options = {})
     super(app)
     @client = options[:client]
   end
 
   def call(env)
-    @app.call(env).on_complete do |env|
-      env[:body] = ::Epics::Response.new(@client, env[:body])
-      raise Epics::Error::TechnicalError.new(env[:body].technical_code) if env[:body].technical_error?
-      raise Epics::Error::BusinessError.new(env[:body].business_code)  if env[:body].business_error?
+    @app.call(env).on_complete do |response|
+      response[:body] = ::Epics::Response.new(@client, response[:body])
+      raise Epics::Error::TechnicalError, response[:body].technical_code if response[:body].technical_error?
+      raise Epics::Error::BusinessError, response[:body].business_code if response[:body].business_error?
     end
+  rescue Epics::Error::TechnicalError, Epics::Error::BusinessError
+    raise # re-raise as otherwise they would be swallowed by the following rescue
+  rescue StandardError => e
+    raise Epics::Error::UnknownError, e
   end
 end

data/lib/epics/version.rb

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

data/lib/epics/xct.rb

@@ -0,0 +1,30 @@
+class Epics::XCT < Epics::GenericUploadRequest
+  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 'XCT'
+            xml.OrderAttribute 'OZHNN'
+            xml.StandardOrderParams
+          }
+          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.NumSegments 1
+        }
+        xml.mutable {
+          xml.TransactionPhase 'Initialisation'
+        }
+      }
+    end.doc.root
+  end
+end

data/lib/epics/xds.rb

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

data/spec/client_spec.rb

@@ -197,6 +197,16 @@ RSpec.describe Epics::Client do
     it 'sets @order_types' do
       expect { subject.HTD }.to change { subject.instance_variable_get("@order_types") }
     end
+
+    describe 'without iban' do
+      before do
+        allow(subject).to receive(:download).and_return( File.read(File.join(File.dirname(__FILE__), 'fixtures', 'xml', 'htd_order_data_without_names.xml')))
+      end
+
+      it 'sets @iban' do
+        expect(subject.iban).to be_nil
+      end
+    end
   end
 
   describe '#C53/C52/C54 types with zipped data' do

data/spec/fixtures/xml/htd_order_data_without_names.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<HTDResponseOrderData xmlns="urn:org:ebics:H004" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:org:ebics:H004 http://www.ebics.org/H004/ebics_orders_H004.xsd">
+  <PartnerInfo>
+    <AddressInfo>
+      <Name>Railslove GmbH</Name>
+      <Country>Deutschland</Country>
+    </AddressInfo>
+    <BankInfo>
+      <HostID>SIZBN001</HostID>
+    </BankInfo>
+    <OrderInfo>
+      <OrderType>HTD</OrderType>
+      <TransferType>Download</TransferType>
+      <Description>Kunden- und Teilnehmerdaten abholen</Description>
+    </OrderInfo>
+      </PartnerInfo>
+  <UserInfo>
+    <UserID Status="1">EBIX</UserID>
+    <Name>Ebi, Epics</Name>
+    <Permission>
+      <OrderTypes>HTD</OrderTypes>
+    </Permission>
+    <Permission AuthorisationLevel="E">
+      <OrderTypes></OrderTypes>
+    </Permission>
+  </UserInfo>
+</HTDResponseOrderData>

data/spec/middleware/parse_ebics_spec.rb

@@ -1,23 +1,39 @@
-RSpec.describe Epics::ParseEbics do
+# frozen_string_literal: true
 
+RSpec.describe Epics::ParseEbics do
   subject do
     Faraday.new do |builder|
       builder.use Epics::ParseEbics
       builder.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('/business_nok') {[ 200, {}, File.read( File.join( File.dirname(__FILE__), '..', 'fixtures', 'xml', 'ebics_business_nok.xml') )  ]}
-        stub.post('/technical_nok') {[ 200, {}, File.read( File.join( File.dirname(__FILE__), '..', 'fixtures', 'xml', 'ebics_technical_nok.xml') )  ]}
-        stub.post('/ok') {[ 200, {}, File.read( File.join( File.dirname(__FILE__), '..', 'fixtures', 'xml', 'hpb_response_ebics_ns.xml') )  ]}
+        stub.post('/business_nok') { [200, {}, File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', 'xml', 'ebics_business_nok.xml'))] }
+        stub.post('/technical_nok') { [200, {}, File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', 'xml', 'ebics_technical_nok.xml'))] }
+        stub.post('/ok') { [200, {}, File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', 'xml', 'hpb_response_ebics_ns.xml'))] }
+        stub.post('/timeout') { raise Faraday::TimeoutError }
+        stub.post('/no_connection') { raise Faraday::Error::ConnectionFailed, 'peer has finished all lan parties and gone home' }
       end
     end
   end
 
-  it "will handle errornous response with raising the related error class" do
-    expect { subject.post("/business_nok") }.to raise_error(Epics::Error::BusinessError, "EBICS_PROCESSING_ERROR - During processing of the EBICS request, other business-related errors have ocurred")
-    expect { subject.post("/technical_nok") }.to raise_error(Epics::Error::TechnicalError, "EBICS_AUTHENTICATION_FAILED - Authentication signature error")
+  it 'will handle errornous response with raising the related error class' do
+    expect { subject.post('/business_nok') }.to raise_error(Epics::Error::BusinessError, 'EBICS_PROCESSING_ERROR - During processing of the EBICS request, other business-related errors have ocurred')
+    expect { subject.post('/technical_nok') }.to raise_error(Epics::Error::TechnicalError, 'EBICS_AUTHENTICATION_FAILED - Authentication signature error')
+  end
+
+  it 'will parsed as Epics::Response' do
+    expect(subject.post('/ok').body).to be_kind_of(Epics::Response)
   end
 
-  it "will parsed as Epics::Response" do
-    expect(subject.post("/ok").body).to be_kind_of(Epics::Response)
+  it 'will handle a timeout with raising an Epics::Error::TechnicalError' do
+    expect { subject.post('/timeout') }.to raise_error(Epics::Error::UnknownError, 'timeout')
   end
 
+  context 'failures' do
+    it 'will handle a timeout with raising an Epics::Error::TechnicalError' do
+      expect { subject.post('/timeout') }.to raise_error(Epics::Error::UnknownError, 'timeout')
+    end
+
+    it 'will handle a no connection error with raising an Epics::Error::TechnicalError' do
+      expect { subject.post('/no_connection') }.to raise_error(Epics::Error::UnknownError, 'peer has finished all lan parties and gone home')
+    end
+  end
 end

data/spec/orders/xds_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe Epics::XDS 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', 'cd1.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epics
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Lars Brillert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -198,6 +198,8 @@ files:
 - lib/epics/sta.rb
 - lib/epics/version.rb
 - lib/epics/vmk.rb
+- lib/epics/xct.rb
+- lib/epics/xds.rb
 - lib/letter/ini.erb
 - spec/.DS_Store
 - spec/client_spec.rb
@@ -226,6 +228,7 @@ files:
 - spec/fixtures/xml/hpb_response_order.xml
 - spec/fixtures/xml/hpb_response_order_without_ns.xml
 - spec/fixtures/xml/htd_order_data.xml
+- spec/fixtures/xml/htd_order_data_without_names.xml
 - spec/fixtures/xml/ini_response_h004_ns.xml
 - spec/fixtures/xml/jruby/hia.xml
 - spec/fixtures/xml/jruby/ini.xml
@@ -262,6 +265,7 @@ files:
 - spec/orders/ptk_spec.rb
 - spec/orders/sta_spec.rb
 - spec/orders/vmk_spec.rb
+- spec/orders/xds_spec.rb
 - spec/response_spec.rb
 - spec/signer_spec.rb
 - spec/spec_helper.rb
@@ -333,6 +337,7 @@ test_files:
 - spec/fixtures/xml/hpb_response_order.xml
 - spec/fixtures/xml/hpb_response_order_without_ns.xml
 - spec/fixtures/xml/htd_order_data.xml
+- spec/fixtures/xml/htd_order_data_without_names.xml
 - spec/fixtures/xml/ini_response_h004_ns.xml
 - spec/fixtures/xml/jruby/hia.xml
 - spec/fixtures/xml/jruby/ini.xml
@@ -369,6 +374,7 @@ test_files:
 - spec/orders/ptk_spec.rb
 - spec/orders/sta_spec.rb
 - spec/orders/vmk_spec.rb
+- spec/orders/xds_spec.rb
 - spec/response_spec.rb
 - spec/signer_spec.rb
 - spec/spec_helper.rb