epics 2.11.0 → 3.0.0.rc1

data/lib/epics/builders/order_details_builder/base.rb

@@ -0,0 +1,100 @@
+class Epics::Builders::OrderDetailsBuilder::Base
+  def initialize
+    Nokogiri::XML::Builder.new do |xml|
+      @xml = xml
+      xml.OrderDetails do
+        yield self
+      end
+    end
+  end
+
+  def add_order_type
+    raise NotImplementedError
+  end
+
+  def add_admin_order_type
+    raise NotImplementedError
+  end
+
+  def add_order_id(order_id)
+    @xml.OrderID order_id.to_s(36).upcase.rjust(4, '0')
+    self
+  end
+
+  def add_order_attribute(order_attribute)
+    raise NotImplementedError
+  end
+
+  def add_standard_order_params(start_date = nil, end_date = nil)
+    date_range = create_date_range(start_date, end_date)
+    @xml.StandardOrderParams do |xml|
+      xml.parent.add_child(date_range) if date_range
+    end
+    self
+  end
+
+  def add_fdl_order_params(format, start_date = nil, end_date = nil)
+    date_range = create_date_range(start_date, end_date)
+    @xml.FDLOrderParams do |xml|
+      xml.parent.add_child(date_range) if date_range
+      xml.FileFormat format
+    end
+    self
+  end
+
+  def add_ful_order_params(format)
+    @xml.FULOrderParams do |xml|
+      xml.FileFormat format
+    end
+    self
+  end
+
+  def add_btd_order_params
+    raise NotImplementedError
+  end
+
+  def add_btu_order_params
+    raise NotImplementedError
+  end
+
+  def doc
+    @xml.doc.root
+  end
+
+  protected
+
+  # Start and End are both mandatory within DateRange: no bounds means no range, one
+  # bound cannot be rendered at all.
+  def create_date_range(start_date, end_date)
+    return if start_date.nil? && end_date.nil?
+
+    if start_date.nil? || end_date.nil?
+      raise ArgumentError, 'DateRange requires both a start and an end date, got ' \
+                           "start_date=#{start_date.inspect} end_date=#{end_date.inspect}"
+    end
+
+    start_date = coerce_date(start_date, 'start_date')
+    end_date = coerce_date(end_date, 'end_date')
+
+    Nokogiri::XML::Builder.new do |xml|
+      xml.DateRange do
+        xml.Start start_date.iso8601
+        xml.End end_date.iso8601
+      end
+    end.doc.root
+  end
+
+  # Start and End are xs:date; Time and DateTime would render an xs:dateTime with an
+  # offset and be rejected.
+  def coerce_date(value, name)
+    case value
+    when String
+      puts "DEPRECATION WARNING: #{name} is a String, use Date instead"
+      Date.parse(value)
+    when DateTime, Time
+      value.to_date
+    else
+      value
+    end
+  end
+end

data/lib/epics/builders/order_details_builder/v2.rb

@@ -0,0 +1,21 @@
+class Epics::Builders::OrderDetailsBuilder::V2 < Epics::Builders::OrderDetailsBuilder::Base
+  def add_order_type(order_type)
+    @xml.OrderType order_type
+  end
+
+  def add_admin_order_type(order_type)
+    raise Epics::VersionSupportError, 3.0
+  end
+
+  def add_order_attribute(order_attribute)
+    @xml.OrderAttribute order_attribute
+  end
+
+  def add_btd_order_params
+    raise Epics::VersionSupportError, 3.0
+  end
+
+  def add_btu_order_params
+    raise Epics::VersionSupportError, 3.0
+  end
+end

data/lib/epics/builders/order_details_builder/v3.rb

@@ -0,0 +1,51 @@
+class Epics::Builders::OrderDetailsBuilder::V3 < Epics::Builders::OrderDetailsBuilder::Base
+  def add_order_type(_order_type)
+    raise Epics::VersionSupportError.new(3.0, 'below')
+  end
+
+  def add_admin_order_type(order_type)
+    @xml.AdminOrderType order_type
+  end
+
+  def add_order_attribute(_order_attribute)
+    raise Epics::VersionSupportError.new(3.0, 'below')
+  end
+
+  def add_btd_order_params(
+    service_name:, msg_name:, scope: nil, service_option: nil,
+    container_type: nil, start_date: nil, end_date: nil, msg_name_version: nil, msg_name_variant: nil, msg_name_format: nil
+  )
+    @xml.BTDOrderParams do |xml|
+      xml.Service do
+        xml.ServiceName service_name
+        xml.Scope scope if scope
+        xml.ServiceOption service_option if service_option
+        xml.Container '', containerType: container_type if container_type
+        msg_name_attributes = {}
+        msg_name_attributes[:version] = msg_name_version if msg_name_version
+        msg_name_attributes[:variant] = msg_name_variant if msg_name_variant
+        msg_name_attributes[:format] = msg_name_format if msg_name_format
+        xml.MsgName msg_name, msg_name_attributes
+      end
+      xml.parent.add_child(create_date_range(start_date, end_date)) if start_date && end_date
+    end
+  end
+
+  def add_btu_order_params(
+    filename:, service_name:, msg_name:, scope: nil, service_option: nil, container_type: nil, msg_name_version: nil, msg_name_variant: nil, msg_name_format: nil
+  )
+    @xml.BTUOrderParams fileName: filename do |xml|
+      xml.Service do
+        xml.ServiceName service_name
+        xml.Scope scope if scope
+        xml.ServiceOption service_option if service_option
+        xml.Container '', containerType: container_type if container_type
+        msg_name_attributes = {}
+        msg_name_attributes[:version] = msg_name_version if msg_name_version
+        msg_name_attributes[:variant] = msg_name_variant if msg_name_variant
+        msg_name_attributes[:format] = msg_name_format if msg_name_format
+        xml.MsgName msg_name, msg_name_attributes
+      end
+    end
+  end
+end

data/lib/epics/builders/order_details_builder.rb

@@ -0,0 +1,10 @@
+module Epics::Builders::OrderDetailsBuilder
+  ORDER_ATTRIBUTE_DZNNN = 'DZNNN'
+  ORDER_ATTRIBUTE_DZHNN = 'DZHNN'
+  ORDER_ATTRIBUTE_UZHNN = 'UZHNN'
+  ORDER_ATTRIBUTE_OZHNN = 'OZHNN'
+end
+
+require 'epics/builders/order_details_builder/base'
+require 'epics/builders/order_details_builder/v2'
+require 'epics/builders/order_details_builder/v3'

data/lib/epics/builders/request_builder.rb

@@ -0,0 +1,25 @@
+class Epics::Builders::RequestBuilder
+  def initialize(xml_builder)
+    @xml_builder = xml_builder
+  end
+
+  def add_container_unsecured(&)
+    @xml_builder.create_unsecured(&)
+  end
+
+  def add_container_secured_no_pubkey_digests(&)
+    @xml_builder.create_secured_no_pubkey_digests(&)
+  end
+
+  def add_container_secured(&)
+    @xml_builder.create_secured(&)
+  end
+
+  def add_container_unsigned(&)
+    @xml_builder.create_unsigned(&)
+  end
+
+  def add_container_hev(&)
+    @xml_builder.create_hev(&)
+  end
+end

data/lib/epics/builders/static_builder/base.rb

@@ -0,0 +1,75 @@
+class Epics::Builders::StaticBuilder::Base
+  def initialize
+    Nokogiri::XML::Builder.new do |xml|
+      @xml = xml
+      xml.static do
+        yield self
+      end
+    end
+  end
+
+  def add_host_id(host_id)
+    @xml.HostID host_id
+    self
+  end
+
+  def add_nonce(data)
+    @xml.Nonce data
+    self
+  end
+
+  def add_random_nonce
+    add_nonce SecureRandom.hex(16)
+  end
+
+  def add_timestamp(datetime)
+    @xml.Timestamp datetime.iso8601
+    self
+  end
+
+  def add_partner_id(partner_id)
+    @xml.PartnerID partner_id
+    self
+  end
+
+  def add_user_id(user_id)
+    @xml.UserID user_id
+    self
+  end
+
+  def add_product(product, language)
+    @xml.Product product, Language: language
+    self
+  end
+
+  def add_order_details
+    raise NotImplementedError
+  end
+
+  def add_num_segments(num_segments)
+    @xml.NumSegments num_segments
+    self
+  end
+
+  def add_bank_pubbey_digests(authentication_version, authentication_digest, encryption_version, encryption_digest, algorithm = 'sha256')
+    @xml.BankPubKeyDigests do
+      @xml.Authentication Base64.strict_encode64(authentication_digest), Version: authentication_version, Algorithm: "http://www.w3.org/2001/04/xmlenc##{algorithm}"
+      @xml.Encryption Base64.strict_encode64(encryption_digest), Version: encryption_version, Algorithm: "http://www.w3.org/2001/04/xmlenc##{algorithm}"
+    end
+    self
+  end
+
+  def add_security_medium(security_medium)
+    @xml.SecurityMedium security_medium
+    self
+  end
+
+  def add_transaction_id(transaction_id)
+    @xml.TransactionID transaction_id
+    self
+  end
+
+  def doc
+    @xml.doc.root
+  end
+end

data/lib/epics/builders/static_builder/v2.rb

@@ -0,0 +1,9 @@
+class Epics::Builders::StaticBuilder::V2 < Epics::Builders::StaticBuilder::Base
+  def add_order_details
+    instance = Epics::Builders::OrderDetailsBuilder::V2.new do |instance|
+      yield instance
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+end

data/lib/epics/builders/static_builder/v3.rb

@@ -0,0 +1,9 @@
+class Epics::Builders::StaticBuilder::V3 < Epics::Builders::StaticBuilder::Base
+  def add_order_details
+    instance = Epics::Builders::OrderDetailsBuilder::V3.new do |instance|
+      yield instance
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+end

data/lib/epics/builders/static_builder.rb

@@ -0,0 +1,9 @@
+module Epics::Builders::StaticBuilder
+  SECURITY_MEDIUM_0000 = '0000'
+  SECURITY_MEDIUM_0100 = '0100'
+  SECURITY_MEDIUM_0200 = '0200'
+end
+
+require 'epics/builders/static_builder/base'
+require 'epics/builders/static_builder/v2'
+require 'epics/builders/static_builder/v3'

data/lib/epics/builders/transfer_receipt_builder.rb

@@ -0,0 +1,19 @@
+class Epics::Builders::TransferReceiptBuilder
+  def initialize
+    Nokogiri::XML::Builder.new do |xml|
+      @xml = xml
+      xml.TransferReceipt(authenticate: true) do
+        yield self
+      end
+    end
+  end
+
+  def add_receipt_code(receipt_code)
+    @xml.ReceiptCode receipt_code
+    self
+  end
+
+  def doc
+    @xml.doc.root
+  end
+end

data/lib/epics/builders/xml_builder/base.rb

@@ -0,0 +1,92 @@
+class Epics::Builders::XmlBuilder::Base
+  EBICS_REQUEST = 'ebicsRequest'
+  EBICS_UNSECURED_REQUEST = 'ebicsUnsecuredRequest'
+  EBICS_UNSIGNED_REQUEST = 'ebicsUnsignedRequest'
+  EBICS_NO_PUB_KEY_DIGESTS = 'ebicsNoPubKeyDigestsRequest'
+  EBICS_HEV = 'ebicsHEVRequest'
+
+  def initialize
+    Nokogiri::XML::Builder.new do |xml|
+      @xml = xml
+    end
+  end
+
+  def create_unsecured(&)
+    create_h00x(EBICS_UNSECURED_REQUEST, &)
+  end
+
+  def create_secured_no_pubkey_digests(&)
+    create_h00x(EBICS_NO_PUB_KEY_DIGESTS, true, &)
+  end
+
+  def create_secured(&)
+    create_h00x(EBICS_REQUEST, true, &)
+  end
+
+  def create_unsigned(&)
+    create_h00x(EBICS_UNSIGNED_REQUEST, &)
+  end
+
+  def create_hev(&)
+    create_h000(EBICS_HEV, &)
+  end
+
+  def add_header
+    raise NotImplementedError
+  end
+
+  def add_body
+    raise NotImplementedError
+  end
+
+  def add_host_id(host_id)
+    @xml.HostID host_id
+    self
+  end
+
+  def xml
+    @xml
+  end
+
+  def to_xml
+    @xml.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML, encoding: 'utf-8')
+  end
+
+  protected
+
+  def h00x_version
+    raise NotImplementedError
+  end
+
+  def h00x_namespace
+    raise NotImplementedError
+  end
+
+  def h00x_schema_location
+    raise NotImplementedError
+  end
+
+  private
+
+  def create_h00x(container, secured = false)
+    namespaces = { xmlns: h00x_namespace }
+    namespaces['xmlns:ds'] = 'http://www.w3.org/2000/09/xmldsig#' if secured
+    namespaces['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
+    attributes = { Version: h00x_version, Revision: '1' }
+    attributes['xsi:schemaLocation'] = "#{h00x_namespace} #{h00x_schema_location}"
+    @xml.send(container, **namespaces, **attributes) do
+      yield self
+    end
+    self
+  end
+
+  def create_h000(container)
+    namespaces = { xmlns: 'http://www.ebics.org/H000' }
+    namespaces['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
+    namespaces['xsi:schemaLocation'] = 'http://www.ebics.org/H000 http://www.ebics.org/H000/ebics_hev.xsd'
+    @xml.send(container, **namespaces) do
+      yield self
+    end
+    self
+  end
+end

data/lib/epics/builders/xml_builder/v24.rb

@@ -0,0 +1,31 @@
+class Epics::Builders::XmlBuilder::V24 < Epics::Builders::XmlBuilder::Base
+  def add_header
+    instance = Epics::Builders::HeaderBuilder::V2.new do |instance|
+      yield instance
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+
+  def add_body
+    instance = Epics::Builders::BodyBuilder::V2.new do |instance|
+      yield instance if block_given?
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+
+  protected
+
+  def h00x_version
+    'H003'
+  end
+
+  def h00x_namespace
+    'http://www.ebics.org/H003'
+  end
+
+  def h00x_schema_location
+    'http://www.ebics.org/H003/ebics_H003.xsd'
+  end
+end

data/lib/epics/builders/xml_builder/v25.rb

@@ -0,0 +1,31 @@
+class Epics::Builders::XmlBuilder::V25 < Epics::Builders::XmlBuilder::Base
+  def add_header
+    instance = Epics::Builders::HeaderBuilder::V2.new do |instance|
+      yield instance
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+
+  def add_body
+    instance = Epics::Builders::BodyBuilder::V2.new do |instance|
+      yield instance if block_given?
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+
+  protected
+
+  def h00x_version
+    'H004'
+  end
+
+  def h00x_namespace
+    'urn:org:ebics:H004'
+  end
+
+  def h00x_schema_location
+    'http://www.ebics.org/H004/ebics_H004.xsd'
+  end
+end

data/lib/epics/builders/xml_builder/v3.rb

@@ -0,0 +1,31 @@
+class Epics::Builders::XmlBuilder::V3 < Epics::Builders::XmlBuilder::Base
+  def add_header
+    instance = Epics::Builders::HeaderBuilder::V3.new do |instance|
+      yield instance
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+
+  def add_body
+    instance = Epics::Builders::BodyBuilder::V3.new do |instance|
+      yield instance if block_given?
+    end
+    @xml.parent.add_child(instance.doc)
+    self
+  end
+
+  protected
+
+  def h00x_version
+    'H005'
+  end
+
+  def h00x_namespace
+    'urn:org:ebics:H005'
+  end
+
+  def h00x_schema_location
+    'http://www.ebics.org/H005/ebics_H005.xsd'
+  end
+end

data/lib/epics/builders/xml_builder.rb

@@ -0,0 +1,7 @@
+module Epics::Builders::XmlBuilder
+end
+
+require 'epics/builders/xml_builder/base'
+require 'epics/builders/xml_builder/v24'
+require 'epics/builders/xml_builder/v25'
+require 'epics/builders/xml_builder/v3'

data/lib/epics/builders.rb

@@ -0,0 +1,13 @@
+module Epics::Builders
+end
+
+require 'epics/builders/body_builder'
+require 'epics/builders/data_encryption_info_builder'
+require 'epics/builders/data_transfer_builder'
+require 'epics/builders/header_builder'
+require 'epics/builders/mutable_builder'
+require 'epics/builders/order_details_builder'
+require 'epics/builders/request_builder'
+require 'epics/builders/static_builder'
+require 'epics/builders/transfer_receipt_builder'
+require 'epics/builders/xml_builder'

data/lib/epics/c2s.rb

@@ -1,13 +1,6 @@
 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' }
-    )
+  def to_xml
+    builder = request_factory.create_c2s(document_digest, transaction_key, **options)
+    builder.to_xml
   end
 end

data/lib/epics/c52.rb

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

data/lib/epics/c53.rb

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

data/lib/epics/c54.rb

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

data/lib/epics/c5n.rb

@@ -1,17 +1,6 @@
 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' }
-    )
+  def to_xml
+    builder = request_factory.create_c5n(options[:from], options[:to])
+    builder.to_xml
   end
 end

data/lib/epics/ccs.rb

@@ -1,13 +1,6 @@
 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' }
-    )
+  def to_xml
+    builder = request_factory.create_ccs(document_digest, transaction_key, **options)
+    builder.to_xml
   end
 end

data/lib/epics/cct.rb

@@ -1,13 +1,6 @@
 class Epics::CCT < Epics::GenericUploadRequest
-  def header
-    client.header_request.build(
-      nonce: nonce,
-      timestamp: timestamp,
-      order_type: 'CCT',
-      order_attribute: 'OZHNN',
-      order_params: {},
-      num_segments: 1,
-      mutable: { TransactionPhase: 'Initialisation' }
-    )
+  def to_xml
+    builder = request_factory.create_cct(document_digest, transaction_key, **options)
+    builder.to_xml
   end
 end