epics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36e7870a631e71236b0c9379770056d5c9c8d08f
+  data.tar.gz: 59d5dfe38c22a0d71fc1b9a700bb145fa4f1059c
+SHA512:
+  metadata.gz: eb1d40e580bf49be94aba0618a2146113cecc2781f60a4a37a79650a5afd479e09ab459568cca018faf7b2adfab741af7f6184c82934d2fb01ac673423cef458
+  data.tar.gz: 6d58b9dc15721089a511f908896b5c5b60a9628171fe0edb70f702b53a5a7346d788974c54e2ef50a46434c7906cf5190908ccf0e8d8095256df0221e87026f0

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/ebics_playground
+.DS_Store
+sbk.key
+/mt940
+*.key

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing to Epics
+
+## Before You Start
+
+Please contact team@railslove.com before working on Epics!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in epics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,197 @@
+[![Build Status](https://magnum.travis-ci.com/railslove/epics.svg?token=EhFJyZWe1sxdBDmF2bzC&branch=master)](https://magnum.travis-ci.com/railslove/epics)
+
+# Epics
+
+EPICS is a ruby implementation of the [EBICS](http://www.ebics.org/) (Electronic Banking Internet Communication Standard)
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'epics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install epics
+
+
+## Getting started
+
+In case you are new to EBICS, you'll have to complete a initialization process with
+your bank. Epics can help you to generate all the necessary keys and directly store
+them for later use, but first you'll have to to lift some contractually work with your
+bank.
+
+Once the paperwork is done, your bank should provide you with:
+
+* a URL to their EBICS Server
+* a HOST ID
+* a PARTNER ID
+* n User IDs (this depends on the bank and your needs)
+
+Take this parameters and start setting up one UserID (repeat this for every user
+you want to initialize):
+
+```ruby
+e = Epics::Client.setup("my-super-secret", "https://ebics.sandbox", "SIZBN001", "EBIX", "EPICS")
+```
+
+To use the keys later, just store them in a file
+
+```ruby
+e.save_keys("/home/epics/my.key")
+# or store the json elsewhere, but store it! for gods sake :D
+```
+
+It is really __important__ to keep your keys around, once your user has been initialized
+you'll have to start over when you loose the keys!
+
+Submit the keys to your bank:
+
+```ruby
+e.INI # sends the signature key
+
+e.HIA # sends the encryption and authentication keys
+```
+
+The next step is to print the INI letter and post it to your bank:
+
+```ruby
+e.save_ini_letter( 'My Banks Name', "/home/epics/ini.html" )
+```
+
+Open the generated HTML file in your favorite browser and print it out (skipping
+header and footer sounds like a solid setting here ;) In case your having difficulties
+with the encoding, try forcing your browser to use UTF-8.
+
+Put the INI letter in a envelope and mail it to your bank!
+
+Done! ... Well not completly :)
+
+Once the bank confirms that your user is completely initialized. You'll have to
+download the public keys of your bank:
+
+```ruby
+### see below for client creation
+e.HPB
+```
+
+Then again, save the keys or store the json somewhere safe.
+
+You're now ready to go. Maybe try:
+
+```ruby
+e.HAA
+```
+
+To get a list of all supported order types.
+
+## Usage
+
+### Create a client
+
+```ruby
+# read the keys from a file
+e = Epics::Client.new(File.open('/tmp/my.key'), 'passphrase', 'url', 'host', 'user', 'partner')
+
+# or provide a string hoding the key data
+keys = File.read('/tmp/my.key')
+
+e = Epics::Client.new(keys, 'passphrase', 'url', 'host', 'user', 'partner')
+```
+
+### Lazy Mode
+
+Once you have a client, go ahead and start playing! There are 3 convinence methods
+that are hiding some strange names from you:
+
+* debit( _xml_ ) (submits a PAIN.008.003.02 document via CDD)
+* credit( _xml_ ) (submits a pain.001.003.03 document)
+* statements( _from_, _to_ ) (fetches an account statement via STA)
+
+If you need more sophisticated EBICS order types, please read the next section
+about the supported functionalities.
+
+## Features
+
+### Initialization
+
+* INI (Sends the public key of the electronic signature.)
+* HIA (Sends the public authentication (X002) and encryption (E002) keys.)
+
+### Downloads
+
+Currently this EPICS implementation supports the following order types:
+
+* HPB (fetch your bank's public keys)
+* STA (statements in MT940 format)
+* HAA (available order types)
+* HTD (user properties and settings)
+* HPD (the available bank parameters)
+* PKT (customer usage report in text format)
+* ... more coming soon
+
+Example:
+
+```ruby
+puts e.STA('2014-09-01', '2014-09-11')
+# result is a MT940 feed
+
+:20:1
+:25:/PL12124012551111000015237873
+:28C:00152
+:60F:C081130PLN000000002535,03
+:61:0810021002DN000000001273,23N641NONREF
+:86:641^00PRZELEW MI¨DZYBANKOWY BETA/^34000
+^3019401076^38PL54194010765205871800000000
+^20wynagrodzenie z tytulu umow^21y o prac e
+^32BANKA MONIKA
+^62PODCHORAZYCH 16/1580-298 GD^63ANSK
+:61:0810021002DN000000001287,40N641NONREF
+:86:641^00PRZELEW MI¨DZYBANKOWY BETA/^34000
+^3010201909^38PL74102019090000310200475772
+^20wynagrodzenie z tytulu umow^21y o prac e
+^32SZCZACHOR DOROTA
+^62RATAJA 13B/1083-032 PSZCZOL^63KI
+```
+
+### Uploads
+
+* CD1 (Uploads a SEPA Direct Debit document of type COR1)
+* CDD (Uploads a SEPA Direct Debit document of type CORE)
+* CCT (Uploads a SEPA Credit document)
+* ... more coming soon
+
+Example:
+
+```ruby
+puts e.CD1("i-am-a-PAIN-xml-file")
+# res is a the transaction id of the order
+```
+
+## Supported Banks
+
+* Sofortbank
+* Deutsche Bank
+
+## Contributing
+
+0. Contact team@raislove.com for information about howto CLA
+1. Fork it ( https://github.com/[my-github-username]/epics/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+
+
+made with love by [railslove](http://www.railslove.com)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/epics.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "epics"
+  spec.version       = Epics::VERSION
+  spec.authors       = ["Lars Brillert"]
+  spec.email         = ["lars@railslove.com"]
+  spec.summary       = %q{a ruby implementation of the EBICS protocol}
+  spec.description   = <<-description
+    Epics is a ruby implementation of the EBIC standard (H004)
+
+    It supports the complete initialization process comprising INI, HIA and HPB
+    including the INI letter generation.
+
+    Furthermore it offers support for the most common download types:
+      STA HAA HTD HPD PKT
+
+    And the following upload orders:
+      CD1 CDD CCT
+  description
+
+  spec.homepage      = "https://github.com/railslove/epics"
+  spec.license       = "LGPL-3.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)/})
+  spec.require_paths = ["lib"]
+
+  spec.post_install_message  = "\n\e[32m" + ("*" * 60) + "\n\e[0m"
+  spec.post_install_message += "Thanks for using Epics - your epic EBICS client!\n"
+  spec.post_install_message += "Epics provides a full production-tested implementation of the Electronic Banking Internet Communication Standard.\n"
+  spec.post_install_message += "Railslove as the maintainer is commited to provide extensive developer tools to make integrating financial institutions fun and easy.\n"
+  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"
+  spec.add_dependency "gyoku"
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "bundler", ">= 1.6.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "equivalent-xml"
+end