epics 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51b94d179773db218f4e12893aad065b478fe4fc
-  data.tar.gz: 221ef01157bbcd652e17e6bd7d05d97edeef0765
+  metadata.gz: ffb2fe355ff8d4811bff967cf20cf742cbd688a5
+  data.tar.gz: 5edb7d8ee8bbc115a97646fa10eb41eff0780a9c
 SHA512:
-  metadata.gz: bf71172943ed9c56975b555550277cc1a066a93f6e473b03819833f047c4ae328d50baf7419f535c1c8a62f4ecc64c46dba6fd68ad236d775d676dba5030dbef
-  data.tar.gz: b99b8db9d8a5a332012600d74ccde6fbcfeab0962edb33d34359c2abc2c37fdcfa94052edd0cfe622d23ad09414fc97d422cc2a8627f2da2554667c612115001
+  metadata.gz: 6d51f0ac477dac99702a10886ada30c5bb8bca9836cf4480b800a7717630d5b34183ef8246834e515e8e4a84753dbae11d0c031fe340c51e1af79c641e3ccd60
+  data.tar.gz: cc2220b2f3456e12e68cdc392873439a2ae634303276130a444ab9b504e081266db6924d31b83fc3544aa17f4efb6d538bd40d8b5555b5a3e595fb2d831c835f

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
+env:
+  - JAVA_OPTS=-Djava.security.egd=file:/dev/./urandom --server -Dcext.enabled=false -Xcompile.invokedynamic=false
 rvm:
   - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - jruby
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.10.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 1.5.0
+
+  * [ENHANCEMENT] support for fetching the C54 order type
+  * [ENHANCEMENT] Exceptions expose their internal code via `code`
+  * [HOUSEKEEPING] Added Ruby 2.4 compatibility
+  * [HOUSEKEEPING] Drop Ruby 2.0.0
+
 ### 1.4.1
 
   * [ENHANCEMENT] support for fetching the VMK order type

data/README.md

@@ -8,7 +8,7 @@ Communication Standard).
 
 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 PKT HAC HKD C52 C53 CD1 CDD CCT VMK).
+(STA HAA HTD HPD PKT HAC HKD C52 C53 C54 CD1 CDD CCT VMK).
 
 
 ## Installation
@@ -41,7 +41,7 @@ Once the paperwork is done, your bank should provide you with:
 Take these parameters and start setting up an UserID (repeat this for every user you want to initialize):
 
 ```ruby
-e = Epics::Client.setup("my-super-secret", "https://ebics.sandbox", "SIZBN001", "EBIX", "EPICS")
+e = Epics::Client.setup("my-super-secret", "https://ebics.sandbox", "EBICS_HOST_ID", "EBICS_USER_ID", "EBICS_PARTNER_ID")
 ```
 
 To use the keys later, just store them in a file
@@ -208,14 +208,38 @@ This gem provides a full implementation of the Electronic Banking Internet Commu
 and works with any bank that supports this standard. Please ask your bank if they support EBICS and
 what order types are available.
 
-Besides EBCIS being a standard, some server implementations are slighty different.
-Is Epics working with your institution?
-Please help us to grow this list of supported banks:
+Besides EBCIS being a standard, some server implementations are slighty different.  
+But most banks use the same EBICS server implementations. Commonly used and supported by Epics are: 
+
+* Business-Logics EBICS, Banking-Server
+* Travic Corporate 
+
+Used for example by the following tested institutions:
 
 * Handelsbank
 * Deutsche Bank
-* Sparkasse Köln Bonn
 * Commerzbank
+* Kreissparkasse Mayen 
+* Postbank
+* Sozialbank
+* Sparkassen 
+* Volksbanken Raiffeisenbanken
+* Hypo Vereinsbank
+
+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.
+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"`.
+
+For example:
+```
+http_proxy=localhost:8080
+EPICS_VERIFY_SSL=false
+```
 
 ## Links
 
@@ -236,4 +260,4 @@ Please help us to grow this list of supported banks:
 
 
 ------------
-2014 - built with love by [Railslove](http://railslove.com) and released under the [GNU LESSER GENERAL PUBLIC LICENSE](https://github.com/railslove/epics/blob/master/LICENSE.txt). We have built quite a number of FinTech products. If you need support we are happy to help. Please contact us at team@railslove.com.
+2014-2017 - built with love by [Railslove](http://railslove.com) and released under the [GNU LESSER GENERAL PUBLIC LICENSE](https://github.com/railslove/epics/blob/master/LICENSE.txt). We have built quite a number of FinTech products. If you need support we are happy to help. Please contact us at team@railslove.com.

data/epics.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
     including the INI letter generation.
 
     Furthermore it offers support for the most common download types:
-      STA HAA HTD HPD PKT HAC HKD C52 C53
+      STA HAA HTD HPD PKT HAC HKD C52 C53 C54
 
     And the following upload orders:
       CD1 CDD CCT
@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/railslove/epics"
   spec.license       = "LGPL-3.0"
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -37,7 +39,12 @@ 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 "nokogiri"
+  if RUBY_VERSION < '2.1'
+    spec.add_dependency "nokogiri", '< 1.7.0'
+  else
+    spec.add_dependency "nokogiri"
+  end
+
   spec.add_dependency "gyoku"
   spec.add_dependency "faraday"
   spec.add_dependency "rubyzip", ">= 1.0.0"

data/lib/epics.rb

@@ -26,6 +26,7 @@ require "epics/sta"
 require "epics/vmk"
 require "epics/c52"
 require "epics/c53"
+require "epics/c54"
 require "epics/ptk"
 require "epics/hac"
 require "epics/hpd"

data/lib/epics/c54.rb

@@ -0,0 +1,52 @@
+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
+    {
+      :@authenticate => true,
+      static: {
+        "HostID" => host_id,
+        "Nonce" => nonce,
+        "Timestamp" => timestamp,
+        "PartnerID" => partner_id,
+        "UserID" => user_id,
+        "Product" => {
+          :@Language => "de",
+          :content! => "EPICS - a ruby ebics kernel"
+        },
+        "OrderDetails" => {
+          "OrderType" => "C54",
+          "OrderAttribute" => "DZHNN",
+          "StandardOrderParams" => {
+            "DateRange" => {
+              "Start" => from,
+              "End" => to
+            }
+          }
+        },
+        "BankPubKeyDigests" => {
+          "Authentication" => {
+            :@Version => "X002",
+            :@Algorithm => "http://www.w3.org/2001/04/xmlenc#sha256",
+            :content! => client.bank_x.public_digest
+          },
+          "Encryption" => {
+            :@Version => "E002",
+            :@Algorithm => "http://www.w3.org/2001/04/xmlenc#sha256",
+            :content! => client.bank_e.public_digest
+          }
+        },
+        "SecurityMedium" => "0000"
+     },
+      "mutable" => {
+        "TransactionPhase" => "Initialisation"
+      }
+    }
+  end
+end

data/lib/epics/client.rb

@@ -102,8 +102,12 @@ class Epics::Client
       exponent = Base64.decode64(node.at_xpath(".//*[local-name() = 'Exponent']").content)
 
       bank   = OpenSSL::PKey::RSA.new
-      bank.n = OpenSSL::BN.new(modulus, 2)
-      bank.e = OpenSSL::BN.new(exponent, 2)
+      if bank.respond_to?(:set_key)
+        bank.set_key(OpenSSL::BN.new(modulus, 2), OpenSSL::BN.new(exponent, 2), nil)
+      else
+        bank.n = OpenSSL::BN.new(modulus, 2)
+        bank.e = OpenSSL::BN.new(exponent, 2)
+      end
 
       self.keys["#{host_id.upcase}.#{type}"] = Epics::Key.new(bank)
     end
@@ -139,6 +143,10 @@ class Epics::Client
     download_and_unzip(Epics::C53, from, to)
   end
 
+  def C54(from, to)
+    download_and_unzip(Epics::C54, from, to)
+  end
+
   def HAA
     Nokogiri::XML(download(Epics::HAA)).at_xpath("//xmlns:OrderTypes", xmlns: "urn:org:ebics:H004").content.split(/\s/)
   end
@@ -206,7 +214,7 @@ class Epics::Client
   end
 
   def connection
-    @connection ||= Faraday.new(headers: {user_agent: "EPICS v#{Epics::VERSION}"}) do |faraday|
+    @connection ||= Faraday.new(headers: {user_agent: "EPICS v#{Epics::VERSION}"}, ssl: { verify: verify_ssl? }) do |faraday|
       faraday.use Epics::XMLSIG, { client: self }
       faraday.use Epics::ParseEbics, { client: self}
       # faraday.response :logger                  # log requests to STDOUT
@@ -225,7 +233,7 @@ class Epics::Client
   end
 
   def cipher
-    @cipher ||= OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+    @cipher ||= OpenSSL::Cipher.new("aes-256-cbc")
   end
 
   def encrypt(data)
@@ -249,4 +257,7 @@ class Epics::Client
     cipher.key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(passphrase, salt, 1, cipher.key_len)
   end
 
+  def verify_ssl?
+    ENV['EPICS_VERIFY_SSL'] != 'false'
+  end
 end

data/lib/epics/error.rb

@@ -1,4 +1,7 @@
 class Epics::Error < StandardError
+
+  attr_reader :code
+
   def to_s
     [@error.fetch("symbol", "EPICS_UNKNOWN"), @error.fetch("short_text", "unknown")].join(" - ")
   end
@@ -8,6 +11,15 @@ class Epics::Error < StandardError
     @error = self.class::ERRORS.fetch(code, {})
   end
 
+  def symbol
+    @error.fetch("symbol", "EPICS_UNKNOWN")
+  end
+
+  def short_text
+    @error.fetch("short_text", "unknown")
+  end
+
+
   class TechnicalError < self
     ERRORS = {
       "000000" => {

data/lib/epics/generic_upload_request.rb

@@ -10,7 +10,7 @@ class Epics::GenericUploadRequest < Epics::GenericRequest
   end
 
   def cipher
-    @cipher ||= OpenSSL::Cipher::Cipher.new("aes-128-cbc")
+    @cipher ||= OpenSSL::Cipher.new("aes-128-cbc")
   end
 
   def digester

data/lib/epics/response.rb

@@ -84,7 +84,7 @@ class Epics::Response
   end
 
   def cipher
-    cipher = OpenSSL::Cipher::Cipher.new("aes-128-cbc")
+    cipher = OpenSSL::Cipher.new("aes-128-cbc")
 
     cipher.decrypt
     cipher.padding = 0

data/lib/epics/version.rb

@@ -1,3 +1,3 @@
 module Epics
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/spec/client_spec.rb

@@ -22,6 +22,28 @@ RSpec.describe Epics::Client do
 
   end
 
+  context 'environment settings' do
+    before(:each) do
+      ENV.delete('EPICS_VERIFY_SSL')
+    end
+
+    describe '#verify_ssl?' do
+      it 'verifies ssl by default' do
+        expect(subject.send(:verify_ssl?)).to eq true
+      end
+
+      it 'verifies ssl if there\'s something strange set to your env' do
+        ENV['EPICS_VERIFY_SSL'] = 'somethingstrange'
+        expect(subject.send(:verify_ssl?)).to eq true
+      end
+
+      it 'skips ssl verification if you want to' do
+        ENV['EPICS_VERIFY_SSL'] = 'false'
+        expect(subject.send(:verify_ssl?)).to eq false
+      end
+    end
+  end
+
   describe '#inspect' do
     it 'will not print the complete object' do
       expect(subject.inspect).to include("@keys=#{subject.keys.keys}")
@@ -131,13 +153,15 @@ RSpec.describe Epics::Client do
     end
   end
 
-  describe '#C53/C52 types with zipped data' do
+  describe '#C53/C52/C54 types with zipped data' do
     before do
       allow(subject).to receive(:download).and_return( File.read(File.join(File.dirname(__FILE__), 'fixtures', 'test.zip') ))
     end
 
     it 'will unzip the returned data' do
-      expect(subject.C53(:today, :yesterday)).to eq(["ebics is great\n"])
+      %w(C52 C53 C54).each do |c|
+        expect(subject.send(c, :today, :yesterday)).to eq(["ebics is great\n"])
+      end
     end
   end
 end

data/spec/error_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Epics::Error::BusinessError do
+
+  subject { Epics::Error::BusinessError.new(code) }
+
+  before do
+    stub_const("Epics::Error::BusinessError::ERRORS", {
+      "123" => {
+        "symbol" => "BOTTMUEHLE",
+        "short_text" => "home of awesome",
+      }
+    })
+  end
+
+  let(:code) { '123' }
+
+  describe '#to_s' do
+
+    it 'returns a message composed of symbol and short text' do
+      expect(subject.to_s).to eql('BOTTMUEHLE - home of awesome')
+    end
+  end
+
+  describe '#code' do
+    it 'returns the code' do
+      expect(subject.code).to eql('123')
+    end
+  end
+
+  describe '#symbol' do
+    it 'returns the symbol' do
+      expect(subject.symbol).to eql('BOTTMUEHLE')
+    end
+  end
+
+  describe '#short_text' do
+    it 'returns the short text' do
+      expect(subject.short_text).to eql('home of awesome')
+    end
+  end
+
+end

data/spec/generic_upload_spec.rb

@@ -18,7 +18,8 @@ RSpec.describe Epics::GenericUploadRequest do
   end
 
   describe '#signature_value' do
-    before { allow(OpenSSL::Random).to receive(:random_bytes).and_return(Base64.strict_decode64("7wtROfiX4tyN60cygJUSsHkhzxX1RVJa8vGNYnflvKc=")) }
+    before { allow(OpenSSL::Random).to receive(:random_bytes).with(16).and_return("\x01" * 16) } # fake random_key requires a 16byte lenght but is not used in this test
+    before { allow(OpenSSL::Random).to receive(:random_bytes).with(32).and_return(Base64.strict_decode64("7wtROfiX4tyN60cygJUSsHkhzxX1RVJa8vGNYnflvKc=")) } # digest requires 32 bytes
 
     it 'will be the signed document' do
       expect(subject.signature_value).to eq("BQBMyxGHYoAbbmbMJRFbGrvUNinY15+qeeRLF708VL+tuENnbJMO6xHLWxU1rksOnu4xDzxfua9b3IxIaxLyTTFDuVi6bbu3sBslhIt2frdigo0xBL14KUJQ/pYiMj+2pfNYhtVxzamrnvgPSLNAEn36JykK2d347chT87HlZ7CAGNBS7lJHAzRP1v7Hkc+kKttkkWCpOGk06R6FUCxxVKXmQketMEl/scsMyJ3JtBe/EcjEZdDe5WcqZYUu5ARrfEiAeyutVRZnu17c3nKwkmWl7UqFAwp16cS8IPNL4i5FGCytgKl/kyaoxaE/P1lrGOkHcCTsSR0bAbARhndfdQ==")

data/spec/orders/c54_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epics
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Lars Brillert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -157,7 +157,7 @@ description: |2
       including the INI letter generation.
 
       Furthermore it offers support for the most common download types:
-        STA HAA HTD HPD PKT HAC HKD C52 C53
+        STA HAA HTD HPD PKT HAC HKD C52 C53 C54
 
       And the following upload orders:
         CD1 CDD CCT
@@ -180,6 +180,7 @@ files:
 - lib/epics.rb
 - lib/epics/c52.rb
 - lib/epics/c53.rb
+- lib/epics/c54.rb
 - lib/epics/cct.rb
 - lib/epics/cd1.rb
 - lib/epics/cdb.rb
@@ -209,6 +210,7 @@ files:
 - lib/letter/ini.erb
 - spec/.DS_Store
 - spec/client_spec.rb
+- spec/error_spec.rb
 - spec/fixtures/.DS_Store
 - spec/fixtures/SIZBN001.key
 - spec/fixtures/a006.pem
@@ -242,6 +244,7 @@ files:
 - spec/middleware/parse_ebics_spec.rb
 - spec/orders/c52_spec.rb
 - spec/orders/c53_spec.rb
+- spec/orders/c54_spec.rb
 - spec/orders/cct_spec.rb
 - spec/orders/cd1_spec.rb
 - spec/orders/cdb_spec.rb
@@ -288,7 +291,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -303,6 +306,7 @@ summary: a ruby implementation of the EBICS protocol
 test_files:
 - spec/.DS_Store
 - spec/client_spec.rb
+- spec/error_spec.rb
 - spec/fixtures/.DS_Store
 - spec/fixtures/SIZBN001.key
 - spec/fixtures/a006.pem
@@ -336,6 +340,7 @@ test_files:
 - spec/middleware/parse_ebics_spec.rb
 - spec/orders/c52_spec.rb
 - spec/orders/c53_spec.rb
+- spec/orders/c54_spec.rb
 - spec/orders/cct_spec.rb
 - spec/orders/cd1_spec.rb
 - spec/orders/cdb_spec.rb