epics 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cb98bb83470739103b20941fc4a5f636f57752d90941aa0ba9ac9e7c111503f
-  data.tar.gz: 134ef14259b6e5728677f45dd21446fc642f8eca7c6641e7befd537936c406b6
+  metadata.gz: 7d2540241c26353b2e1134bfed820618ed1b8470790c66985cade8d306d49b3a
+  data.tar.gz: 6ece5e86fc70adecc140b5ed64d9d0e47c2d3c86619d5b20e9fd615bc33ded65
 SHA512:
-  metadata.gz: 55ba0cecabed4d9397643b0fc7116c3675dc5bdc4d076e8599812338503061fb15521164b7ee02ce42cf7aa778fa3694c6ca0d0358dcbc2684cbffdfb9888374
-  data.tar.gz: 1df6989cdc96ee6e68069a34bdd6496e8a739b9665ab1c68f1533dd247664a67452e0157c3b1ea6eb84e66868e7e94094c344229b598a7de862d702e46b99e86
+  metadata.gz: cead2ddb91fe295b3e6a7b25723d5eb6810f836c0e74cfb3f33e1717a9d023192d289706fb84ba01897a80a6c7420dca3ab767a5d5cdc897d74612b717e86199
+  data.tar.gz: 57a8513a4d9b6a373d8158e231779566363966a8ac6cc058a8151c6b70d905719bee7c4fa139c46d450e724da8cd372d93e68b96f45b87d21a249dbfbacdb41a

data/.semaphore/semaphore.yml

@@ -16,21 +16,12 @@ blocks:
   - name: Spec versions
     task:
       jobs:
-        - name: "3.0"
-          commands:
-            - checkout
-            - sem-version ruby 3.0
-            - cache restore
-            - gem install bundler:2.4.22
-            - bundle install
-            - cache store
-            - bundle exec rspec
         - name: "3.1"
           commands:
             - checkout
             - sem-version ruby 3.1
             - cache restore
-            - gem install bundler:2.4.22
+            - gem install bundler:2.5.19
             - bundle install
             - cache store
             - bundle exec rspec
@@ -39,7 +30,7 @@ blocks:
             - checkout
             - sem-version ruby 3.2
             - cache restore
-            - gem install bundler:2.4.22
+            - gem install bundler:2.5.19
             - bundle install
             - cache store
             - bundle exec rspec
@@ -48,7 +39,7 @@ blocks:
             - checkout
             - sem-version ruby 3.3
             - cache restore
-            - gem install bundler:2.4.22
+            - gem install bundler:2.5.19
             - bundle install
             - cache store
             - bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ### Unreleased
 
+### 2.5.0
+
+- [HOUSEKEEPING] Bump XML dependency requirements to more recent versions
+- [HOUSEKEEPING] Bump bundler version to 2.5.19
+- [HOUSEKEEPING] Bump ruby required version from 2.7 to 3.1
+- [ENHANCEMENT] Request Header generation more generalized (thanks to @jplot)
+- [ENHANCEMENT] Multi language support for initialization letter (thanks to @jplot)
+- [ENHANVEMENT] Added support for WSS and C5N order types (thanks to @kostja93)
+
 ### 2.4.0
 
 - [ENHANCEMENT]  Adds XE2 and XE3 order type (CCT and CDD for swiss banks)

data/epics.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/railslove/epics'
   spec.license       = 'LGPL-3.0'
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -41,11 +41,12 @@ Gem::Specification.new do |spec|
   spec.post_install_message += "\e[32m" + ('*' * 60) + "\n\e[0m"
 
   spec.add_dependency 'faraday',  '>= 1.10.0'
-  spec.add_dependency 'nokogiri', '>= 1.16.5'
+  spec.add_dependency 'i18n',     '>= 1.1.0'
+  spec.add_dependency 'nokogiri', '>= 1.16.7'
   spec.add_dependency 'rubyzip',  '>= 2.3.2'
-  spec.add_dependency 'rexml',    '>= 3.2.8'
+  spec.add_dependency 'rexml',    '>= 3.3.7'
 
-  spec.add_development_dependency 'bundler', '>= 2.4.12'
+  spec.add_development_dependency 'bundler', '>= 2.5.19'
   spec.add_development_dependency 'equivalent-xml'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/epics/azv.rb

@@ -1,30 +1,13 @@
 class Epics::AZV < 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 'CD1'
-            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
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CD1',
+      order_attribute: 'OZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/b2b.rb

@@ -1,5 +1,13 @@
-class Epics::B2B < Epics::CDD
-  def order_type
-    'B2B'
+class Epics::B2B < Epics::GenericUploadRequest
+  def header
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'B2B',
+      order_attribute: 'OZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/c2s.rb

@@ -1,9 +1,13 @@
-class Epics::C2S < Epics::CDB
-  def order_attribute
-    "DZHNN"
-  end
-
-  def order_type
-    'C2S'
+class Epics::C2S < Epics::GenericUploadRequest
+  def header
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'C2S',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/c52.rb

@@ -1,42 +1,17 @@
 class Epics::C52 < 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 'C52'
-            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'
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'C52',
+      order_attribute: 'DZHNN',
+      order_params: {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
         }
-      }
-    end.doc.root
+      },
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/c53.rb

@@ -1,42 +1,17 @@
 class Epics::C53 < 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 'C53'
-            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'
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'C53',
+      order_attribute: 'DZHNN',
+      order_params: {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
         }
-      }
-    end.doc.root
+      },
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/c54.rb

@@ -1,42 +1,17 @@
 class Epics::C54 < 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 'C54'
-            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'
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'C54',
+      order_attribute: 'DZHNN',
+      order_params: {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
         }
-      }
-    end.doc.root
+      },
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/c5n.rb

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

data/lib/epics/ccs.rb

@@ -1,9 +1,13 @@
-class Epics::CCS < Epics::CCT
-  def order_attribute
-    'DZHNN'
-  end
-
-  def order_type
-    'CCS'
+class Epics::CCS < Epics::GenericUploadRequest
+  def header
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CCS',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/cct.rb

@@ -1,38 +1,13 @@
 class Epics::CCT < Epics::GenericUploadRequest
-  def order_attribute
-    'OZHNN'
-  end
-
-  def order_type
-    'CCT'
-  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 order_type
-            xml.OrderAttribute order_attribute
-            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
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CCT',
+      order_attribute: 'OZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/cd1.rb

@@ -1,30 +1,13 @@
 class Epics::CD1 < 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 'CD1'
-            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
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CD1',
+      order_attribute: 'OZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/cdb.rb

@@ -1,38 +1,13 @@
 class Epics::CDB < Epics::GenericUploadRequest
-  def order_attribute
-    'OZHNN'
-  end
-
-  def order_type
-    'CDB'
-  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 order_type
-            xml.OrderAttribute order_attribute
-            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
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CDB',
+      order_attribute: 'OZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/cdd.rb

@@ -1,38 +1,13 @@
 class Epics::CDD < Epics::GenericUploadRequest
-  def order_attribute
-    'OZHNN'
-  end
-
-  def order_type
-    'CDD'
-  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 order_type
-            xml.OrderAttribute order_attribute
-            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
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CDD',
+      order_attribute: 'OZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/cds.rb

@@ -1,9 +1,13 @@
-class Epics::CDS < Epics::CDD
-  def order_attribute
-    "DZHNN"
-  end
-
-  def order_type
-    'CDS'
+class Epics::CDS < Epics::GenericUploadRequest
+  def header
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CDS',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      num_segments: 1,
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/cdz.rb

@@ -1,46 +1,17 @@
 class Epics::CDZ < Epics::GenericRequest
-  attr_accessor :from, :to
-
-  def initialize(client, from = nil, to = nil)
-    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 'CDZ'
-            xml.OrderAttribute 'DZHNN'
-            if !!from && !!to
-              xml.StandardOrderParams {
-                xml.DateRange {
-                  xml.Start from
-                  xml.End to
-                }
-              }
-            else
-              xml.StandardOrderParams
-            end
-          }  
-          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'
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'CDZ',
+      order_attribute: 'DZHNN',
+      order_params: !!options[:from] && !!options[:to] ? {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
         }
-      }
-    end.doc.root
+      } : {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end