epics 2.4.0 → 2.6.0

data/lib/epics/cip.rb

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

data/lib/epics/client.rb

@@ -3,6 +3,7 @@ class Epics::Client
 
   attr_accessor :passphrase, :url, :host_id, :user_id, :partner_id, :keys, :keys_content
   attr_writer :iban, :bic, :name
+  attr_accessor :locale
 
   def_delegators :connection, :post
 
@@ -14,6 +15,7 @@ class Epics::Client
     self.host_id    = host_id
     self.user_id    = user_id
     self.partner_id = partner_id
+    self.locale = :de
   end
 
   def inspect
@@ -68,9 +70,12 @@ class Epics::Client
     client
   end
 
+  def letter_renderer
+    @letter_renderer ||= Epics::LetterRenderer.new(self)
+  end
+
   def ini_letter(bankname)
-    raw = File.read(File.join(File.dirname(__FILE__), '../letter/', 'ini.erb'))
-    ERB.new(raw).result(binding)
+    letter_renderer.render(bankname)
   end
 
   def save_ini_letter(bankname, path)
@@ -78,6 +83,10 @@ class Epics::Client
     path
   end
 
+  def header_request
+    @header_request ||= Epics::HeaderRequest.new(self)
+  end
+
   def credit(document)
     self.CCT(document)
   end
@@ -87,7 +96,7 @@ class Epics::Client
   end
 
   def statements(from, to, type = :STA)
-    self.public_send(type, from, to)
+    self.public_send(type, from: from, to: to)
   end
 
   def HIA
@@ -157,6 +166,10 @@ class Epics::Client
     upload(Epics::CCT, document)
   end
 
+  def CIP(document)
+    upload(Epics::CIP, document)
+  end
+
   def CCS(document)
     upload(Epics::CCS, document)
   end
@@ -166,43 +179,47 @@ class Epics::Client
   end
 
   def STA(from = nil, to = nil)
-    download(Epics::STA, from, to)
+    download(Epics::STA, from: from, to: to)
   end
 
   def VMK(from = nil, to = nil)
-    download(Epics::VMK, from, to)
+    download(Epics::VMK, from: from, to: to)
   end
 
   def CDZ(from = nil, to = nil)
-    download_and_unzip(Epics::CDZ, from, to)
+    download_and_unzip(Epics::CDZ, from: from, to: to)
   end
 
   def CRZ(from = nil, to = nil)
-    download_and_unzip(Epics::CRZ, from, to)
+    download_and_unzip(Epics::CRZ, from: from, to: to)
   end
 
   def C52(from, to)
-    download_and_unzip(Epics::C52, from, to)
+    download_and_unzip(Epics::C52, from: from, to: to)
   end
 
   def C53(from, to)
-    download_and_unzip(Epics::C53, from, to)
+    download_and_unzip(Epics::C53, from: from, to: to)
   end
 
   def C54(from, to)
-    download_and_unzip(Epics::C54, from, to)
+    download_and_unzip(Epics::C54, from: from, to: to)
+  end
+
+  def C5N(from, to)
+    download_and_unzip(Epics::C5N, from: from, to: to)
   end
 
   def Z52(from, to)
-    download_and_unzip(Epics::Z52, from, to)
+    download_and_unzip(Epics::Z52, from: from, to: to)
   end
 
   def Z53(from, to)
-    download_and_unzip(Epics::Z53, from, to)
+    download_and_unzip(Epics::Z53, from: from, to: to)
   end
 
   def Z54(from, to)
-    download_and_unzip(Epics::Z54, from, to)
+    download_and_unzip(Epics::Z54, from: from, to: to)
   end
 
   def HAA
@@ -227,11 +244,15 @@ class Epics::Client
   end
 
   def PTK(from, to)
-    download(Epics::PTK, from, to)
+    download(Epics::PTK, from: from, to: to)
   end
 
   def HAC(from = nil, to = nil)
-    download(Epics::HAC, from, to)
+    download(Epics::HAC, from: from, to: to)
+  end
+
+  def WSS
+    download(Epics::WSS)
   end
 
   def save_keys(path)
@@ -252,8 +273,8 @@ class Epics::Client
     return res.transaction_id, [res.order_id, order_id].detect { |id| id.to_s.chars.any? }
   end
 
-  def download(order_type, *args)
-    document = order_type.new(self, *args)
+  def download(order_type, *args, **options)
+    document = order_type.new(self, *args, **options)
     res = post(url, document.to_xml).body
     document.transaction_id = res.transaction_id
 
@@ -264,9 +285,9 @@ class Epics::Client
     res.order_data
   end
 
-  def download_and_unzip(order_type, *args)
+  def download_and_unzip(order_type, *args, **options)
     [].tap do |entries|
-      Zip::File.open_buffer(StringIO.new(download(order_type, *args))).each do |zipfile|
+      Zip::File.open_buffer(StringIO.new(download(order_type, *args, **options))).each do |zipfile|
         entries << zipfile.get_input_stream.read
       end
     end

data/lib/epics/crz.rb

@@ -1,46 +1,17 @@
 class Epics::CRZ < 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 'CRZ'
-            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: 'CRZ',
+      order_attribute: 'DZHNN',
+      order_params: !!options[:from] && !!options[:to] ? {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
         }
-      }
-    end.doc.root
+      } : {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/generic_request.rb

@@ -1,10 +1,11 @@
 class Epics::GenericRequest
   extend Forwardable
-  attr_accessor :client
+  attr_reader :client, :options
   attr_accessor :transaction_id
 
-  def initialize(client)
-    self.client = client
+  def initialize(client, **options)
+    @client = client
+    @options = options
   end
 
   def nonce
@@ -27,6 +28,10 @@ class Epics::GenericRequest
     end.doc.root
   end
 
+  def header
+    raise NotImplementedError
+  end
+
   def auth_signature
     Nokogiri::XML::Builder.new do |xml|
       xml.AuthSignature{

data/lib/epics/generic_upload_request.rb

@@ -3,8 +3,8 @@ class Epics::GenericUploadRequest < Epics::GenericRequest
   attr_accessor :iv
   attr_accessor :document
 
-  def initialize(client, document)
-    super(client)
+  def initialize(client, document, **options)
+    super(client, **options)
     self.document = document
     self.key = cipher.random_key
     self.iv = 0.chr * cipher.iv_len

data/lib/epics/haa.rb

@@ -1,29 +1,12 @@
 class Epics::HAA < Epics::GenericRequest
   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 'HAA'
-            xml.OrderAttribute 'DZHNN'
-            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.mutable {
-          xml.TransactionPhase 'Initialisation'
-        }
-      }
-    end.doc.root
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'HAA',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/hac.rb

@@ -1,49 +1,20 @@
 class Epics::HAC < Epics::GenericRequest
-  attr_accessor :from, :to
-
   # By default HAC only returns data for transactions which have not yet been fetched. Therefore,
   # most applications not not have to specify a date range, but can simply fetch the status and
   # be done
-  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 'HAC'
-            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: 'HAC',
+      order_attribute: 'DZHNN',
+      order_params: !!options[:from] && !!options[:to] ? {
+        DateRange: {
+          Start: options[:from],
+          End: options[:to]
         }
-      }
-    end.doc.root
+      } : {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/header_request.rb

@@ -0,0 +1,60 @@
+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
+
+  def_delegators :client, :host_id, :user_id, :partner_id
+
+  def build(options = {})
+    options[:with_bank_pubkey_digests] = true if options[:with_bank_pubkey_digests].nil?
+
+    Nokogiri::XML::Builder.new do |xml|
+      xml.header(authenticate: true) {
+        xml.static {
+          xml.HostID host_id
+          xml.Nonce options[:nonce] if options[:nonce]
+          xml.Timestamp options[:timestamp] if options[:timestamp]
+          xml.PartnerID partner_id
+          xml.UserID user_id
+          xml.Product(PRODUCT_NAME, 'Language' => PRODUCT_LANG)
+          xml.OrderDetails {
+            xml.OrderType options[:order_type]
+            xml.OrderAttribute options[:order_attribute]
+            xml.StandardOrderParams {
+              build_attributes(xml, options[:order_params])
+            } if options[:order_params]
+          }
+          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')
+          } if options[:with_bank_pubkey_digests]
+          xml.SecurityMedium '0000'
+          xml.NumSegments options[:num_segments] if options[:num_segments]
+        }
+        xml.mutable {
+          build_attributes(xml, options[:mutable])
+        } if options[:mutable]
+      }
+    end.doc.root
+  end
+
+  private
+
+  def build_attributes(xml, attributes)
+    attributes.each do |key, value|
+      if value.is_a?(Hash)
+        xml.send(key) {
+          build_attributes(xml, value)
+        }
+      else
+        xml.send(key, value)
+      end
+    end
+  end
+end

data/lib/epics/hia.rb

@@ -4,22 +4,12 @@ class Epics::HIA < Epics::GenericRequest
   end
 
   def header
-    Nokogiri::XML::Builder.new do |xml|
-      xml.header(authenticate: true) {
-        xml.static {
-          xml.HostID host_id
-          xml.PartnerID partner_id
-          xml.UserID user_id
-          xml.Product("EPICS - a ruby ebics kernel", 'Language' => 'de')
-          xml.OrderDetails {
-            xml.OrderType 'HIA'
-            xml.OrderAttribute 'DZNNN'
-          }
-          xml.SecurityMedium '0000'
-        }
-        xml.mutable ''
-      }
-    end.doc.root
+    client.header_request.build(
+      order_type: 'HIA',
+      order_attribute: 'DZNNN',
+      with_bank_pubkey_digests: false,
+      mutable: {}
+    )
   end
 
   def body

data/lib/epics/hkd.rb

@@ -1,29 +1,12 @@
 class Epics::HKD < Epics::GenericRequest
   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 'HKD'
-            xml.OrderAttribute 'DZHNN'
-            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.mutable {
-          xml.TransactionPhase 'Initialisation'
-        }
-      }
-    end.doc.root
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'HKD',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/hpb.rb

@@ -4,23 +4,13 @@ class Epics::HPB < Epics::GenericRequest
   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 'HPB'
-            xml.OrderAttribute 'DZHNN'
-          }
-          xml.SecurityMedium '0000'
-        }
-        xml.mutable ''
-      }
-    end.doc.root
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'HPB',
+      order_attribute: 'DZHNN',
+      with_bank_pubkey_digests: false,
+      mutable: {}
+    )
   end
 end

data/lib/epics/hpd.rb

@@ -1,29 +1,12 @@
 class Epics::HPD < Epics::GenericRequest
   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 'HPD'
-            xml.OrderAttribute 'DZHNN'
-            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.mutable {
-          xml.TransactionPhase 'Initialisation'
-        }
-      }
-    end.doc.root
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'HPD',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/htd.rb

@@ -1,29 +1,12 @@
 class Epics::HTD < Epics::GenericRequest
   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 'HTD'
-            xml.OrderAttribute 'DZHNN'
-            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.mutable {
-          xml.TransactionPhase 'Initialisation'
-        }
-      }
-    end.doc.root
+    client.header_request.build(
+      nonce: nonce,
+      timestamp: timestamp,
+      order_type: 'HTD',
+      order_attribute: 'DZHNN',
+      order_params: {},
+      mutable: { TransactionPhase: 'Initialisation' }
+    )
   end
 end

data/lib/epics/ini.rb

@@ -4,22 +4,12 @@ class Epics::INI < Epics::GenericRequest
   end
 
   def header
-    Nokogiri::XML::Builder.new do |xml|
-      xml.header(authenticate: true) {
-        xml.static {
-          xml.HostID host_id
-          xml.PartnerID partner_id
-          xml.UserID user_id
-          xml.Product("EPICS - a ruby ebics kernel", 'Language' => 'de')
-          xml.OrderDetails {
-            xml.OrderType 'INI'
-            xml.OrderAttribute 'DZNNN'
-          }
-          xml.SecurityMedium '0000'
-        }
-        xml.mutable ''
-      }
-    end.doc.root
+    client.header_request.build(
+      order_type: 'INI',
+      order_attribute: 'DZNNN',
+      with_bank_pubkey_digests: false,
+      mutable: {},
+    )
   end
 
   def body

data/lib/epics/letter_renderer.rb

@@ -0,0 +1,22 @@
+class Epics::LetterRenderer
+  extend Forwardable
+
+  TEMPLATE_PATH = File.join(File.dirname(__FILE__), '../letter/', 'ini.erb')
+  I18N_SCOPE = 'epics.letter'
+
+  def initialize(client)
+    @client = client
+  end
+
+  def translate(key, **options)
+    I18n.translate(key, **{ locale: @client.locale, scope: I18N_SCOPE }.merge(options))
+  end
+
+  alias_method :t, :translate
+
+  def_delegators :@client, :host_id, :user_id, :partner_id, :a, :x, :e
+
+  def render(bankname)
+    ERB.new(File.read(TEMPLATE_PATH)).result(binding)
+  end
+end