epics 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51d24b50fdc5705acf921ecc331fbbc504be08c1615bb1e19e5586a808549cc
-  data.tar.gz: 7da71fe00c348df5e32774633d6b14d1f22df867d69830811c8ed1db8c26134e
+  metadata.gz: f97fb2e1d069feca084d74aff47a5a55a4f0f8d6aa2865567544450f68cf35c8
+  data.tar.gz: 4028071efc11da0c35e2c4e1ca9997512538083fbbfeebd6eb00ce985ea76f45
 SHA512:
-  metadata.gz: d28b7833d9b95b7c849918cbda0bb5edd8e8836688989e308ab7e90f0982b2f802604ac02acff0960a644db6b3941c32ce2b055c45d00678d5a8acb0778f430b
-  data.tar.gz: 52bf70e50a99e2844a2c62115b6b59b3455e5fbedfcc1f575033a702a5d2838ac05fbfacb6e0438f4fee13b76e6837b6682e0aca4bb9cf6978d6eb1660317174
+  metadata.gz: 90c7e7bf8b9dd58f367a432eb8b1beec2b3faff2bde2f186575555b4098e6db494769ba0f567e2c419bb0387344d2bf6a10f6201544a2e15f09eb583bc89fe70
+  data.tar.gz: 4b9e25b55194e4a299717d8d9cd6f1296d6e0298b20e4d405518488e90d90ed9c3e5e92c9361e00e51fcb6759d366a5100d629f4a1c582f4ab242471363f9009

data/.gitignore

@@ -16,4 +16,5 @@ mkmf.log
 .DS_Store
 sbk.key
 /mt940
-*.key
+*.key
+.idea/

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 ### Unreleased
 
+### 2.8.0
+
+- [ENHANCEMENT] Added BKA order type
+
+### 2.7.0
+
+- [ENHANCEMENT] Added FDL order type (thanks to @frantisekrokusek)
+- [ENHANCEMENT] Added support for configuring locale and client/product name on initialization (thanks to @frantisekrokusek)
+
 ### 2.6.0
 
-- [ENHANCEMENT] Adds CIP order type (instant transfers)
+- [ENHANCEMENT] Added CIP order type (instant transfers)
 - [ENHANCEMENT] Added gem metadata (thanks to @Nymuxyzo)
 
 ### 2.5.0

data/README.md

@@ -10,7 +10,7 @@ It supports EBICS 2.5.
 
 The client supports the complete initialization process comprising INI, HIA and HPB including the
 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).
+(STA HAA HTD HPD PTK HAC HKD BKA C52 C53 C54 CD1 CDB CDD CCT VMK FDL).
 
 ## Installation
 
@@ -115,6 +115,15 @@ keys = File.read('/tmp/my.key')
 e = Epics::Client.new(keys, 'passphrase', 'url', 'host', 'user', 'partner')
 ```
 
+### Client Configuration
+
+You can choose to configure some default values like this
+
+```ruby
+# For default values see `lib/epics.rb`
+e = Epics::Client.new(keys, 'passphrase', 'url', 'host', 'user', 'partner', locale: :fr, product_name: 'Mon Epic Client EBICS')
+```
+
 ## Features
 
 ### Initialization
@@ -222,12 +231,13 @@ Used for example by the following tested institutions:
 - Hypo Vereinsbank
 - BAWAG P.S.K. (AT)
 - Bank Frick (LI)
+- BNP Paribas (FR)
 
 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.
+For development purposes, you may want to use a proxy server in order to have a convenient look into request and response data.
 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"`.
 
@@ -246,14 +256,19 @@ EPICS_VERIFY_SSL=false
 - [Die Deutsche Kreditwirtschaft](http://www.die-deutsche-kreditwirtschaft.de/)
 
 ## Contributing
-Railslove has a [Contributor License Agreement (CLA)](https://github.com/railslove/epics/blob/master/CONTRIBUTING.md) which clarifies the intellectual property rights for contributions from individuals or entities. To ensure every developer has signed the CLA, we use [CLA  Assistant](https://cla-assistant.io/). 
+Railslove has a [Contributor License Agreement (CLA)](https://github.com/railslove/epics/blob/master/CONTRIBUTING.md) which clarifies the intellectual property rights for contributions from individuals or entities. To ensure every developer has signed the CLA, we use [CLA  Assistant](https://cla-assistant.io/).
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rspec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 0. Contact team@railslove.com for information about the CLA
 1. Fork it ( https://github.com/[my-github-username]/epics/fork )
-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
+2. Run `bin/setup`
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
 
 ## Contribution Credits
 

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "epics"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/epics.gemspec

@@ -44,6 +44,8 @@ Gem::Specification.new do |spec|
   spec.post_install_message += "Please create an issue on github (railslove/epics) if anything does not work as expected. And contact team@railslove.com if you are looking for support with your integration.\n"
   spec.post_install_message += "\e[32m" + ('*' * 60) + "\n\e[0m"
 
+  spec.add_dependency 'base64'
+  spec.add_dependency 'bigdecimal'
   spec.add_dependency 'faraday',  '>= 1.10.0'
   spec.add_dependency 'i18n',     '>= 1.1.0'
   spec.add_dependency 'nokogiri', '>= 1.16.7'

data/lib/epics/bka.rb

@@ -0,0 +1,17 @@
+class Epics::BKA < Epics::GenericRequest
+  def header
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'BKA',
+      order_attribute: 'DZHNN',
+      order_params: {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
+        }
+      },
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
+  end
+end

data/lib/epics/client.rb

@@ -1,13 +1,12 @@
 class Epics::Client
   extend Forwardable
 
-  attr_accessor :passphrase, :url, :host_id, :user_id, :partner_id, :keys, :keys_content
+  attr_accessor :passphrase, :url, :host_id, :user_id, :partner_id, :keys, :keys_content, :locale, :product_name
   attr_writer :iban, :bic, :name
-  attr_accessor :locale
 
   def_delegators :connection, :post
 
-  def initialize(keys_content, passphrase, url, host_id, user_id, partner_id)
+  def initialize(keys_content, passphrase, url, host_id, user_id, partner_id, locale: Epics::DEFAULT_LOCALE, product_name: Epics::DEFAULT_PRODUCT_NAME)
     self.keys_content = keys_content.respond_to?(:read) ? keys_content.read : keys_content if keys_content
     self.passphrase = passphrase
     self.keys = extract_keys if keys_content
@@ -15,7 +14,8 @@ class Epics::Client
     self.host_id    = host_id
     self.user_id    = user_id
     self.partner_id = partner_id
-    self.locale = :de
+    self.locale = locale
+    self.product_name = product_name
   end
 
   def inspect
@@ -182,6 +182,10 @@ class Epics::Client
     download(Epics::STA, from: from, to: to)
   end
 
+  def FDL(format, from = nil, to = nil)
+    download(Epics::FDL, file_format: format, from: from, to: to )
+  end
+
   def VMK(from = nil, to = nil)
     download(Epics::VMK, from: from, to: to)
   end
@@ -194,6 +198,10 @@ class Epics::Client
     download_and_unzip(Epics::CRZ, from: from, to: to)
   end
 
+  def BKA(from, to)
+    download_and_unzip(Epics::BKA, from: from, to: to)
+  end
+
   def C52(from, to)
     download_and_unzip(Epics::C52, from: from, to: to)
   end

data/lib/epics/fdl.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Epics::FDL < Epics::GenericRequest
+  def header
+    fdl_order_params = Hash.new.tap do |params|
+      params[:DateRange] = {
+        Start: options[:from],
+        End: options[:to],
+      } if options[:from] && options[:to]
+      params[:FileFormat] = options[:file_format]
+    end
+
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'FDL',
+      order_attribute: 'DZHNN',
+      order_id: 'A00A',
+      custom_order_params: { FDLOrderParams: fdl_order_params },
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
+  end
+end

data/lib/epics/header_request.rb

@@ -2,9 +2,6 @@ class Epics::HeaderRequest
   extend Forwardable
   attr_accessor :client
 
-  PRODUCT_NAME = 'EPICS - a ruby ebics kernel'
-  PRODUCT_LANG = 'de'
-
   def initialize(client)
     self.client = client
   end
@@ -22,13 +19,14 @@ class Epics::HeaderRequest
           xml.Timestamp options[:timestamp] if options[:timestamp]
           xml.PartnerID partner_id
           xml.UserID user_id
-          xml.Product(PRODUCT_NAME, 'Language' => PRODUCT_LANG)
+          xml.Product(client.product_name, 'Language' => client.locale)
           xml.OrderDetails {
             xml.OrderType options[:order_type]
             xml.OrderAttribute options[:order_attribute]
             xml.StandardOrderParams {
               build_attributes(xml, options[:order_params])
             } if options[:order_params]
+            build_attributes(xml, options[:custom_order_params]) if options[:custom_order_params]
           }
           xml.BankPubKeyDigests {
             xml.Authentication(client.bank_x.public_digest, Version: 'X002', Algorithm: 'http://www.w3.org/2001/04/xmlenc#sha256')

data/lib/epics/version.rb

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

data/lib/epics.rb

@@ -25,7 +25,9 @@ require "epics/hkd"
 require "epics/htd"
 require "epics/haa"
 require "epics/sta"
+require "epics/fdl"
 require "epics/vmk"
+require "epics/bka"
 require "epics/c52"
 require "epics/c53"
 require "epics/c54"
@@ -60,6 +62,8 @@ require "epics/client"
 I18n.load_path += Dir[File.join(File.dirname(__FILE__), 'letter/locales', '*.yml')]
 
 module Epics
-
+  DEFAULT_PRODUCT_NAME = 'EPICS - a ruby ebics kernel'
+  DEFAULT_LOCALE = :de
 end
+
 Ebics = Epics

data/spec/orders/bka_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Epics::BKA 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, from: "2014-09-01", to: "2014-09-30") }
+
+  describe '#to_xml' do
+    specify { expect(subject.to_xml).to be_a_valid_ebics_doc }
+  end
+
+end

data/spec/orders/fdl_spec.rb

@@ -0,0 +1,58 @@
+RSpec.describe Epics::FDL 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(:file_format) { 'camt.xxx.cfonb120.stm.Oby' }
+
+  context 'with file_format' do
+    subject(:order) { described_class.new(client, file_format: file_format) }
+
+    describe '#to_xml' do
+      specify { expect(order.to_xml).to be_a_valid_ebics_doc }
+
+      it 'does includes a date range as standard order parameter' do
+        expect(order.to_xml).to include('<FDLOrderParams><FileFormat>camt.xxx.cfonb120.stm.Oby</FileFormat></FDLOrderParams>')
+      end
+    end
+
+    describe '#to_receipt_xml' do
+      before { order.transaction_id = SecureRandom.hex(16) }
+
+      specify { expect(order.to_receipt_xml).to be_a_valid_ebics_doc }
+    end
+
+    context 'with DateRange' do
+      subject(:order) { described_class.new(client, file_format: file_format, from: Date.new(2024, 1, 1), to: Date.new(2024, 1, 2)) }
+
+      describe '#to_xml' do
+        specify { expect(order.to_xml).to be_a_valid_ebics_doc }
+
+        it 'does includes a date range as optional order parameter' do
+          expect(order.to_xml).to include('<FDLOrderParams><DateRange><Start>2024-01-01</Start><End>2024-01-02</End></DateRange><FileFormat>camt.xxx.cfonb120.stm.Oby</FileFormat></FDLOrderParams>')
+        end
+      end
+
+      describe '#to_receipt_xml' do
+        before { order.transaction_id = SecureRandom.hex(16) }
+
+        specify { expect(order.to_receipt_xml).to be_a_valid_ebics_doc }
+      end
+    end
+  end
+
+  context 'without file_format' do
+    subject(:order) { described_class.new(client) }
+
+    describe '#to_xml' do
+      specify { expect(order.to_xml).to be_a_valid_ebics_doc }
+
+      it 'does not include a standard order parameter' do
+        expect(order.to_xml).to include('<FDLOrderParams><FileFormat/></FDLOrderParams>')
+      end
+    end
+
+    describe '#to_receipt_xml' do
+      before { order.transaction_id = SecureRandom.hex(16) }
+
+      specify { expect(order.to_receipt_xml).to be_a_valid_ebics_doc }
+    end
+  end
+end

data/spec/support/ebics_matcher.rb

@@ -16,7 +16,7 @@ RSpec::Matchers.define :be_a_valid_ebics_doc do
   end
 
   description do
-    "be a valid EBCIS document"
+    "be a valid EBICS document"
   end
 
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: epics
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Lars Brillert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: bigdecimal
+  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +205,9 @@ description: |2
         CD1 CDD CCT CDB CDS CCS CDZ CRZ
 email:
 - lars@railslove.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -190,10 +220,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - epics.gemspec
 - lib/epics.rb
 - lib/epics/azv.rb
 - lib/epics/b2b.rb
+- lib/epics/bka.rb
 - lib/epics/c2s.rb
 - lib/epics/c52.rb
 - lib/epics/c53.rb
@@ -210,6 +243,7 @@ files:
 - lib/epics/client.rb
 - lib/epics/crz.rb
 - lib/epics/error.rb
+- lib/epics/fdl.rb
 - lib/epics/generic_request.rb
 - lib/epics/generic_upload_request.rb
 - lib/epics/haa.rb
@@ -289,6 +323,7 @@ files:
 - spec/middleware/parse_ebics_spec.rb
 - spec/orders/azv_spec.rb
 - spec/orders/b2b_spec.rb
+- spec/orders/bka_spec.rb
 - spec/orders/c2s_spec.rb
 - spec/orders/c52_spec.rb
 - spec/orders/c53_spec.rb
@@ -302,6 +337,7 @@ files:
 - spec/orders/cdz_spec.rb
 - spec/orders/cip_spec.rb
 - spec/orders/crz_spec.rb
+- spec/orders/fdl_spec.rb
 - spec/orders/haa_spec.rb
 - spec/orders/hac_spec.rb
 - spec/orders/hia_spec.rb
@@ -362,7 +398,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: a ruby implementation of the EBICS protocol
@@ -413,6 +449,7 @@ test_files:
 - spec/middleware/parse_ebics_spec.rb
 - spec/orders/azv_spec.rb
 - spec/orders/b2b_spec.rb
+- spec/orders/bka_spec.rb
 - spec/orders/c2s_spec.rb
 - spec/orders/c52_spec.rb
 - spec/orders/c53_spec.rb
@@ -426,6 +463,7 @@ test_files:
 - spec/orders/cdz_spec.rb
 - spec/orders/cip_spec.rb
 - spec/orders/crz_spec.rb
+- spec/orders/fdl_spec.rb
 - spec/orders/haa_spec.rb
 - spec/orders/hac_spec.rb
 - spec/orders/hia_spec.rb