nordea-filetransfer 0.2.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Edgars Beigarts
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+# Ruby client for Nordea FileTransfer
+
+```
+         Payload                ApplicationRequest           SOAP Envelope
+   +-------------------+     +---------------------+     +--------------------+
+ C |                   |     |                     |     |                    |
+ O |   Content         |     |   Customer ID       |     |    SOAP Header     |
+ R |                   |     |   Timestamp         |     | +----------------+ |
+ P |                   |     |   Environment       |     | | Signature      | |
+ O |                   |     |   Target ID         |     | | ...            | |
+ R |                   |     |   Encryption        |     | +----------------+ |
+ A |                   |     |   Compression       |     |                    |
+ T |                   |     |   Software ID       |     |                    |
+ E |                   |     |   File Type         |     |                    |
+   |                   |     | +-----------------+ |     |                    |
+ L |                   +-------> Content Base64  | |     |     SOAP Body      |
+ E |                   |     | +-----------------+ |     | +----------------+ |
+ G |                   |     |                     |     | | Request Header | |
+ A |                   |     |                     +-------> AppReq Base64  | |
+ C |                   |     |                     |     | +----------------+ |
+ Y |                   |     |                     |     |                    |
+   +-------------------+     +---------------------+     +--------------------+
+
+   1.          | 2.      | 3.                   | 4.        | 5.
+   Generate    | Import  | Builds XML structure | Transport | Creates WS Message
+   Legacy data | Payload | and signs it         | App.Req.  | and signs it
+
+```
+
+## Installation
+
+```bash
+$ gem install nordea-filetransfer
+```
+
+## Usage
+
+```ruby
+require "noredea/file_transfer"
+
+Nordea::FileTransfer.configure do |config|
+  config.language = "EN"
+  config.environment = "PRODUCTION"
+  config.user_agent = "Ruby"
+  config.software_id = "Ruby"
+  config.cert_file = "path/to/cert.pem"
+  config.private_key_file = "path/to/key.pem"
+  config.sender_id = 11111111
+end
+
+client = Nordea::FileTransfer::Client.new
+
+response = client.get_user_info do |header, request|
+  header.receiver_id  = 123456789
+  request.customer_id = 162355330
+end
+
+response.response_header
+# => Nordea::FileTransfer::ResponseHeader
+
+response.application_response
+# => Nordea::FileTransfer::ApplicationResponse
+```
+
+### Get User Info
+
+> The service will provide the client with information of
+> authorized user file types and service ID’s.
+
+```ruby
+response = client.get_user_info do |header, request|
+  header.receiver_id  = 123456789
+  request.customer_id = 162355330,
+end
+
+response.application_response.user_file_types
+# => [Nordea::FileTransfer::UserFileType, ...]
+```
+
+### Download File List
+
+> The service will provide the client with a list of
+> files that are available for download from Nordea.
+
+```ruby
+response = client.download_file_list do |header, request|
+  header.receiver_id  = 123456789
+  request.customer_id = 162355330
+  request.status      = "ALL"
+  request.target_id   = "11111111A1"
+  request.file_type   = "NDCORPAYL"
+end
+
+response.application_response.file_descriptors
+# => [Nordea::FileTransfer::FileDescriptor, ...]
+```
+
+### Download File
+
+> The service will provide the client with requested files.
+> Downloadable files can be checked by DownloadFileList –service. The query may be:
+> 
+> - download single file
+> - download multiple files
+> - download all files of type
+> - download all files
+
+```ruby
+response = client.download_file do |header, request|
+  header.receiver_id      = 123456789
+  request.customer_id     = 162355330
+  request.file_references = ["2012082621423418"]
+  request.target_id       = "11111111A1"
+  request.file_type       = "VKEUR"
+end
+
+response.application_response.content
+# => VK0100020120821154650Listakurssit alle 40.000 eur maksuille 21.08.12 15:35
+#    VK01001199901010730000001EUREUR00000100000000000010000000000001000000000000100000000000010000000+K000000000K
+#    VK01001201208211535490001USDEUR00000124280000000012578000000001227800000000127180000000012138000+K000000000K
+#    VK01001201208211535470001JPYEUR00009881000000001008100000000096810000000010252000000000951000000+K000000000K
+#    ...
+```
+
+### Upload File
+
+> The Service will provide the transport of the customers file to Nordea.
+> The response from Nordea will  be a transport acknowledgement with details
+> regarding the status of the transport.
+> 
+> Backend system will process the files in batch mode. This means that the only
+> verification of a file transfer, successful or not, will be a transfer
+> acknowledgement. The client will not usually receive any other notification and
+> the result must be retrieved with a new call later.
+
+```ruby
+response = client.upload_file do |header, request|
+  header.receiver_id      = 123456789
+  request.customer_id     = 162355330
+  request.target_id       = "11111111A1"
+  request.service_id      = "0012345678"
+  request.file_type       = "CNFTC000S"
+  request.user_filename   = "TEST.TXT"
+  request.content         = "..."
+end
+```
+
+## References
+
+* [Nordea: Web Services Security and Communication (PDF)](http://www.nordea.fi/sitemod/upload/root/fi_org/liite/e/yritys/pdf/web_services_ohjelmistotalot.pdf)
+* [Nordea: Web Services (PDF)](http://www.nordea.fi/sitemod/upload/root/fi_org/liite/e/yritys/pdf/web_services.pdf)
+* [Nordea: File Transfer Service Description (PDF)](http://www.nordea.fi/sitemod/upload/Root/fi_org/liite/e/yritys/pdf/erasiir.pdf)
+* [Nordea: File Transfer Instructions (HTML)](http://www.nordea.fi/Corporate+customers/Payments+and+cards/Advice+on+payments+and+cards/Instructions/1433022.html)
+* [Nordea: File Transfer Example files (HTML)](http://www.nordea.fi/Corporate+customers/Payments+and+cards/Advice+on+payments+and+cards/Example+files/1466002.html)
+* [Nordea: File Transfer WSDL (XML)](https://filetransfer.nordea.com/services/CorporateFileService?wsdl)
+* [Nordea: File Transfer WSDL: XSD1 (XML)](https://filetransfer.nordea.com/services/CorporateFileService.xsd1.xsd)
+* [Nordea: File Transfer WSDL: XSD2 (XML)](https://filetransfer.nordea.com/services/CorporateFileService.xsd2.xsd)
+* [Nordea: File Transfer WSDL: ApplicationRequest.xsd (XML)](http://www.nordea.fi/sitemod/upload/root/fi_org/liite/ApplicationRequest.xsd)
+* [Nordea: File Transfer WSDL: ApplicationResponse.xsd (XML)](http://www.nordea.fi/sitemod/upload/root/fi_org/liite/ApplicationResponse.xsd)

data/lib/nordea-filetransfer.rb

@@ -0,0 +1 @@
+require "nordea/file_transfer"

data/lib/nordea/file_transfer.rb

@@ -0,0 +1,28 @@
+require 'savon'
+require 'virtus'
+require 'signer'
+require 'active_support/core_ext'
+
+require 'nordea/file_transfer/version'
+
+module Nordea
+  module FileTransfer
+    autoload :Config,              'nordea/file_transfer/config'
+    autoload :Client,              'nordea/file_transfer/client'
+    autoload :Error,               'nordea/file_transfer/error'
+    autoload :Attributes,          'nordea/file_transfer/attributes'
+
+    autoload :Request,             'nordea/file_transfer/request'
+    autoload :RequestHeader,       'nordea/file_transfer/request_header'
+    autoload :ApplicationRequest,  'nordea/file_transfer/application_request'
+
+    autoload :Response,            'nordea/file_transfer/response'
+    autoload :ResponseHeader,      'nordea/file_transfer/response_header'
+    autoload :ApplicationResponse, 'nordea/file_transfer/application_response'
+    autoload :FileTypeService,     'nordea/file_transfer/file_type_service'
+    autoload :UserFileType,        'nordea/file_transfer/user_file_type'
+    autoload :FileDescriptor,      'nordea/file_transfer/file_descriptor'
+
+    extend Config
+  end
+end

data/lib/nordea/file_transfer/application_request.rb

@@ -0,0 +1,67 @@
+module Nordea
+  module FileTransfer
+    # http://www.nordea.fi/sitemod/upload/root/fi_org/liite/ApplicationRequest.xsd
+    class ApplicationRequest
+      include Virtus
+
+      attribute :customer_id, String, :required => true
+      attribute :command, String
+      attribute :timestamp, DateTime, :required => true
+      attribute :start_date, Date
+      attribute :end_date, Date
+      attribute :status, String, :length => 1..10 # (NEW|DOWNLOADED|ALL)
+      attribute :service_id, String
+      attribute :environment, String, :required => true # (PRODUCTION|TEST)
+      attribute :file_references, Array[String]
+      attribute :user_filename, String
+      attribute :target_id, String
+      attribute :execution_serial, String
+      attribute :encryption, Boolean
+      attribute :encryption_method, String
+      attribute :compression, Boolean
+      attribute :compression_method, String
+      attribute :amount_total, BigDecimal
+      attribute :transaction_count, Integer
+      attribute :software_id, String
+      attribute :customer_extension, String
+      attribute :file_type, String, :length => 1..40
+      attribute :content, Attributes::EncodedBase64String
+
+      def to_hash
+        hash = {
+          "ApplicationRequest" => { },
+          :attributes! => {
+            "ApplicationRequest" => { "xmlns" => "http://bxd.fi/xmldata/" }
+          }
+        }
+        attributes.each do |key, value|
+          next unless value
+          if value.is_a?(Array) && value.size > 0
+            hash["ApplicationRequest"][key.to_s.camelcase] = { key.to_s.camelcase[0..-2] => value }
+          else
+            hash["ApplicationRequest"][key.to_s.camelcase] = value
+          end
+        end
+        hash
+      end
+
+      def to_xml
+        Gyoku.xml(to_hash)
+      end
+
+      def to_signed_xml(options)
+        signer = Signer.new(to_xml)
+        signer.cert = options[:cert]
+        signer.private_key = options[:private_key]
+        signer.security_node = signer.document.root
+        signer.digest!(signer.document, :id => "", :enveloped => true)
+        signer.sign!(:issuer_serial => true)
+        signer.canonicalize
+      end
+
+      def to_signed_and_encoded_xml(options)
+        Base64.encode64(to_signed_xml(options)).gsub("\n", "")
+      end
+    end
+  end
+end

data/lib/nordea/file_transfer/application_response.rb

@@ -0,0 +1,40 @@
+module Nordea
+  module FileTransfer
+    # http://www.nordea.fi/sitemod/upload/root/fi_org/liite/ApplicationResponse.xsd
+    class ApplicationResponse
+      include Virtus
+
+      attribute :customer_id, String
+      attribute :timestamp, DateTime
+      attribute :response_code, String
+      attribute :response_text, String
+      attribute :execution_serial, String
+      attribute :encrypted, Boolean
+      attribute :encryption_method, String
+      attribute :compressed, Boolean
+      attribute :compression_method, String
+      attribute :amount_total, BigDecimal
+      attribute :transaction_count, Integer
+      attribute :file_descriptors, Array[FileDescriptor], :default => []
+      attribute :customer_extension, String
+      attribute :file_type, String
+      attribute :user_file_types, Array[UserFileType], :default => []
+
+      attribute :content, Attributes::DecodedBase64String
+      attribute :signature, Hash
+
+      def initialize(attributes = {})
+        if attributes.is_a?(String)
+          attributes = Nori.parse(Base64.decode64(attributes))[:application_response]
+        end
+        if attributes[:user_file_types]
+          attributes[:user_file_types] = Array.wrap(attributes[:user_file_types][:user_file_type])
+        end
+        if attributes[:file_descriptors]
+          attributes[:file_descriptors] = Array.wrap(attributes[:file_descriptors][:file_descriptor])
+        end
+        super(attributes)
+      end
+    end
+  end
+end

data/lib/nordea/file_transfer/attributes.rb

@@ -0,0 +1,23 @@
+require "base64"
+
+module Nordea
+  module FileTransfer
+    module Attributes
+      class EncodedBase64String < Virtus::Attribute::Object
+        primitive String
+
+        def coerce(value)
+          value && Base64.encode64(value).chomp
+        end
+      end
+
+      class DecodedBase64String < Virtus::Attribute::Object
+        primitive String
+
+        def coerce(value)
+          value && Base64.decode64(value)
+        end
+      end
+    end
+  end
+end

data/lib/nordea/file_transfer/client.rb

@@ -0,0 +1,122 @@
+require "securerandom"
+
+module Nordea
+  module FileTransfer
+    class Client
+      include Config
+
+      def initialize(options = {})
+        Nordea::FileTransfer.config.keys.each do |key|
+          send("#{key}=", options[key] || Nordea::FileTransfer.config.send(key))
+        end
+
+        @savon_client = Savon::Client.new do |wsdl, http, wsse|
+          # Do not fetch wsdl document, use namespace and endpoint instead.
+          wsdl.document = "https://filetransfer.nordea.com/services/CorporateFileService?wsdl"
+          wsdl.endpoint = "https://filetransfer.nordea.com/services/CorporateFileService"
+          certs = Akami::WSSE::Certs.new(:cert_file => @cert_file, :private_key_file => @private_key_file)
+          wsse.signature = Akami::WSSE::Signature.new(certs)
+          wsse.verify_response = false
+        end
+      end
+
+      # Get User Info
+      #
+      # The service will provide the client with information of
+      # authorized user file types and service ID’s.
+      def get_user_info(&block)
+        request :get_user_info, &block
+      end
+
+      # Download File List
+      #
+      # The service will provide the client with a list of
+      # files that are available for download from Nordea.
+      def download_file_list(&block)
+        request :download_file_list, &block
+      end
+
+      # Download File
+      #
+      # The service will provide the client with requested files.
+      # Downloadable files can be checked by DownloadFileList –service.
+      #
+      # The query may be:
+      #
+      # * download single file
+      # * download multiple files
+      # * download all files of type
+      # * download all files
+      def download_file(&block)
+        request :download_file, &block
+      end
+
+      # Upload File
+      #
+      # The Service will provide the transport of the customers file to Nordea.
+      # The response from Nordea will  be a transport acknowledgement with details
+      # regarding the status of the transport.
+      # 
+      # Backend system will process the files in batch mode. This means that the only
+      # verification of a file transfer, successful or not, will be a transfer
+      # acknowledgement. The client will not usually receive any other notification and
+      # the result must be retrieved with a new call later.
+      def upload_file(&block)
+        request :upload_file, &block
+      end
+
+      private
+
+      def cert
+        OpenSSL::X509::Certificate.new(File.read(cert_file))
+      end
+
+      def private_key
+        OpenSSL::PKey::RSA.new(File.read(private_key_file), private_key_password)
+      end
+
+      def request(action)
+        response = @savon_client.request action do
+          soap.namespaces["xmlns"]      = "http://model.bxd.fi"
+          soap.namespaces["xmlns:xsns"] = "http://bxd.fi/CorporateFileService"
+
+          timestamp = Time.now
+
+          req = Request.new
+          req.cert = cert
+          req.private_key = private_key
+
+          req.request_header = RequestHeader.new
+          req.request_header.sender_id   = sender_id
+          req.request_header.request_id  = SecureRandom.hex(32)
+          req.request_header.timestamp   = timestamp
+          req.request_header.language    = language
+          req.request_header.user_agent  = user_agent
+          req.request_header.receiver_id = receiver_id
+
+          req.application_request = ApplicationRequest.new
+          req.application_request.customer_id = customer_id
+          req.application_request.command     = action.to_s.camelcase
+          req.application_request.timestamp   = timestamp
+          req.application_request.environment = environment
+          req.application_request.software_id = software_id
+
+          if block_given?
+            yield req.request_header, req.application_request
+          end
+
+          soap.body = req.to_hash
+        end
+        response_params = response.to_hash[:"#{action}out"]
+        if response_params[:response_header][:response_code] == "00"
+          Response.new(response_params)
+        else
+          raise Error.new(
+            response_params[:response_header][:response_code],
+            response_params[:response_header][:response_text]
+          )
+        end
+      end
+    end
+  end
+end