bank_credentials 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 845726d39c178f0e4b6289f3f98143a11599df7849740b081e2e2946e1c5b959
+  data.tar.gz: fffb808f6561b9ec92e23d742169ad22bf6f2ad449629eee99ebadd3e8d0923f
+SHA512:
+  metadata.gz: 3a3b39fd343430da2b851e643baf3d18da0dd3d3c9395b036af7e8bd216f2da55d6b501151d045b0c523c96b0d666ea28fa6639aa4244faef974e608c11b8b88
+  data.tar.gz: f3069b6e5b3635a5f0846a7351c3e730a239f7ed1b8eb00769c8415ba681ce468292750ca606acb839c29e3b62899f0057fb1d1451e1d620e476021d72d5586a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.overcommit.yml

@@ -0,0 +1,33 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/LineLength:
+  Max: 200
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Roman Lehnert
+
+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,144 @@
+# BankCredentials
+
+BankCredentials is a tiny wrapper for keeping together bank credentials for HBCI or Ebics. 
+
+- [Installation](#installation)
+- [Usage with Ebics credentials](#ebics-credentials)
+- [Usage with Hbci credentials](#hbci-credentials)
+
+[![Build Status](https://travis-ci.org/fintastic/bank_credentials.svg?branch=master)](https://travis-ci.org/fintastic/bank_credentials)
+[![Depfu](https://badges.depfu.com/badges/cbc516a00ed7e4ff91cfdf72d4644805/count.svg)](https://depfu.com/github/fintastic/bank_credentials?project=Bundler)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bank_credentials'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bank_credentials
+
+## Usage
+
+### Ebics Credentials
+
+Ebics credentials require the following attributes:
+
+* key
+* Host URL of the ebics server
+* Host ID
+* Partner ID
+* Passphrase
+
+#### Feeding with credentials hash
+Take a credentials hash and initialize an `BankCredentials::Ebics` instance with it. 
+```ruby
+credential_hash = {
+  key:        "key",
+  url:        "url",
+  host_id:    "host_id",
+  user_id:    "user_id",
+  partner_id: "partner_id"
+  passphrase: "passphrase",
+}
+
+credentials = BankCredentials::Ebics.new(credential_hash)
+```
+At initialization, the completeness of the attributes will be validated. If they are invalid, `BankCredentials::Error::Invalid` will be raised. 
+
+
+#### Feeding with a base64 encoded json hash
+To create an instance from a base64 encoded json string, use `.from_encoded_json`:
+```ruby
+credential_hash = {
+  key:        "key",
+  url:        "url",
+  host_id:    "host_id",
+  user_id:    "user_id",
+  partner_id: "partner_id"
+  passphrase: "passphrase",
+}
+
+encoded_json = Base64.decode64(credential_hash.to_json)
+
+credentials = BankCredentials::Ebics.from_encoded_json(encoded_json)
+```
+When the given argument is not valid json, `BankCredentials::Errors::Invalid` will be raised.
+
+Attribute accessors are provided:
+```ruby
+credentials.key        # => "key"
+credentials.host_id    # => "host_id"
+credentials.partner_id # => "partner_id"
+credentials.user_id    # => "user_id"
+credentials.passphrase # => "passphrase"
+```
+
+
+### HBCI Credentials
+
+Ebics credentials require the following attributes:
+
+* Host URL of the HBCI server
+* Bank code
+* user id
+* pin
+
+#### Feeding with credentials hash
+Take a credentials hash and initialize an `BankCredentials::Hbci` instance with it. 
+```ruby
+credential_hash = {
+  url:        "url",
+  bank_code:  "bank_code",
+  user_id:    "user_id",
+  pin:        "pin"
+}
+
+credentials = BankCredentials::Hbci.new(credential_hash)
+```
+At initialization, the completeness of the attributes will be validated. If they are invalid, `BankCredentials::Error::Invalid` will be raised. 
+
+
+#### Feeding with a base64 encoded json hash
+To create an instance from a base64 encoded json string, use `.from_encoded_json`:
+```ruby
+credential_hash = {
+  url:        "url",
+  user_id:    "user_id",
+  bank_code:  "bank_code",
+  pin:        "pin"
+}
+
+encoded_json = Base64.decode64(credential_hash.to_json)
+
+credentials = BankCredentials::Hbci.from_encoded_json(encoded_json)
+```
+When the given argument is not valid json, `BankCredentials::Errors::Invalid` will be raised.
+
+Attribute accessors are provided:
+```ruby
+credentials.pin        # => "pin"
+credentials.url        # => "url"
+credentials.user_id    # => "user_id"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bank_credentials.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bank_credentials.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bank_credentials/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bank_credentials'
+  spec.version       = BankCredentials::VERSION
+  spec.authors       = ['Roman Lehnert']
+  spec.email         = ['roman.lehnert@gmail.com']
+
+  spec.summary       = 'A tiny ruby container for ebics and hbci credentials.'
+  spec.description   = 'Encapsulates and validates the completeness of banking credentials for ebics and hbci.'
+  spec.homepage      = 'https://github.com/fintastic/bank_credentials'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'byebug', '~> 5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bank_credentials'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bank_credentials/base.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BankCredentials
+  class Base
+    extend Forwardable
+    attr_reader :credentials
+    def_delegator :credentials, :to_h
+
+    def self.type
+      name.nil? ? 'base' : name.split('::').last.downcase
+    end
+
+    def self.attributes
+      @attributes = [] if @attributes.nil?
+      @attributes
+    end
+
+    def self.attribute(attribute)
+      @attributes = [] if @attributes.nil?
+      @attributes << attribute
+      def_delegator :@credentials, attribute
+      def_delegator :@credentials, "#{attribute}=".to_sym
+    end
+
+    def initialize(credential_hash, options = {})
+      credential_hash[:type] = credential_hash[:type] || self.class.type || nil
+      @credentials = OpenStruct.new(credential_hash)
+      validate! if options[:validate]
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def encode
+      Base64.urlsafe_encode64(to_json)
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def valid?
+      attributes.each do |attribute|
+        return false if @credentials[attribute].nil? || @credentials[attribute].empty?
+      end
+    end
+
+    def validate!
+      raise self.class::Errors::Invalid unless valid?
+    end
+
+    attribute :type
+  end
+end

data/lib/bank_credentials/ebics.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BankCredentials
+  class Ebics < Base
+    attribute :key
+    attribute :passphrase
+    attribute :user_id
+    attribute :host_id
+    attribute :partner_id
+    attribute :url
+
+    module Errors
+      class Invalid < StandardError
+        def to_s
+          'Invalid Ebics credentials'
+        end
+      end
+
+      class Empty < StandardError
+        def to_s
+          'Empty Ebics credentials'
+        end
+      end
+    end
+  end
+end

data/lib/bank_credentials/errors/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BankCredentials
+  module Errors
+    class Base < StandardError
+    end
+
+    class Invalid < Base
+      def to_s
+        'Invalid credentials'
+      end
+    end
+  end
+end

data/lib/bank_credentials/factory.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BankCredentials
+  class Factory
+    def self.from_hash(credentials)
+      raise Errors::Invalid unless credentials.is_a?(Hash)
+      raise Errors::Invalid unless credentials.key?(:type)
+
+      class_for_type(credentials[:type]).new(credentials)
+    end
+
+    def self.from_encoded_json(encoded_json)
+      raise Errors::Invalid if encoded_json.nil?
+      raise Errors::Invalid if encoded_json.empty?
+      raise Errors::Invalid unless encoded_json.is_a?(String)
+
+      credentials = JSON.parse(Base64.urlsafe_decode64(encoded_json), symbolize_names: true)
+
+      class_for_type(credentials[:type]).new(credentials)
+    rescue JSON::ParserError, ArgumentError
+      raise Errors::Invalid
+    end
+
+    def self.class_for_type(type)
+      case type
+      when 'ebics' then Ebics
+      when 'hbci' then Hbci
+      end
+    end
+  end
+end

data/lib/bank_credentials/hbci.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BankCredentials
+  class Hbci < Base
+    module Errors
+      class Invalid < StandardError
+        def to_s
+          'Invalid Hbci credentials'
+        end
+      end
+
+      class Empty < StandardError
+        def to_s
+          'Empty Hbci credentials'
+        end
+      end
+    end
+
+    attribute :url
+    attribute :bank_code
+    attribute :user_id
+    attribute :pin
+  end
+end

data/lib/bank_credentials/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BankCredentials
+  VERSION = '0.1.7'
+end

data/lib/bank_credentials.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bank_credentials/version'
+
+require 'base64'
+require 'json'
+
+require 'bank_credentials/errors/errors'
+require 'bank_credentials/factory'
+require 'bank_credentials/base'
+require 'bank_credentials/hbci'
+require 'bank_credentials/ebics'
+
+module BankCredentials
+end

data/spec/bank_credentials/base_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BankCredentials::Base do
+  describe '.attribute' do
+    let(:klass) { Class.new(described_class) }
+
+    it 'adds the attribute to the attributes' do
+      expect { klass.attribute(:test) }
+        .to change { klass.attributes }
+        .from([]).to([:test])
+    end
+
+    it 'adds the reader delegator' do
+      klass.attribute(:test)
+      credentials_instance = klass.new(test: 'test')
+      expect(credentials_instance.credentials).to receive(:test).once
+
+      credentials_instance.test
+    end
+
+    it 'adds the writer delegator' do
+      klass.attribute(:test)
+      credentials_instance = klass.new(test: 'test')
+      expect(credentials_instance.credentials).to receive(:test=).once
+
+      credentials_instance.test = 'asd'
+    end
+  end
+
+  describe '.attributes' do
+    let(:klass) { Class.new(described_class) }
+    subject { klass.attributes }
+
+    context 'when there are no attributes' do
+      it 'returns an empty array' do
+        expect(subject).to eql([])
+      end
+    end
+
+    it 'returns the attributes' do
+      klass.attribute(:test)
+      expect(subject).to eql([:test])
+    end
+  end
+end

data/spec/bank_credentials/ebics_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BankCredentials::Ebics do
+  let(:credential_hash) { valid_ebics_credentials_without_type }
+
+  describe 'attribute readers' do
+    subject { described_class.new(credential_hash) }
+
+    it 'provides public access to the credentials' do
+      expect(subject.type).to eql('ebics')
+      expect(subject.key).to eql('key')
+      expect(subject.passphrase).to eql('passphrase')
+      expect(subject.host_id).to eql('host_id')
+      expect(subject.user_id).to eql('user_id')
+      expect(subject.partner_id).to eql('partner_id')
+      expect(subject.url).to eql('https://localhost')
+    end
+  end
+
+  describe '#valid?' do
+    it 'returns false when one of the keys is missing' do
+      %i[key passphrase user_id host_id partner_id url].each do |key|
+        expect(described_class.new(credential_hash.merge!(key => nil))).to_not be_valid
+      end
+    end
+
+    it 'returns true when none of the keys is missing' do
+      expect(described_class.new(credential_hash)).to be_valid
+    end
+  end
+
+  describe '#encode' do
+    subject { described_class.new(credential_hash).encode }
+
+    it 'returns the ursafe base64 encoded string' do
+      expect(subject).to eql(
+        Base64.urlsafe_encode64(described_class.new(credential_hash).to_json)
+      )
+    end
+  end
+
+  describe 'validate!' do
+    it 'raises an error when one of the keys is missing' do
+      %i[key passphrase user_id host_id partner_id url].each do |key|
+        subject = described_class.new(credential_hash.merge!(key => nil), validate: false)
+        expect { subject.validate! }.to raise_error(BankCredentials::Ebics::Errors::Invalid)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    subject { described_class.new(credential_hash).to_h }
+
+    context 'when credential hash includes the type' do
+      let(:credential_hash) { valid_ebics_credentials_with_type }
+
+      it { is_expected.to eql(credential_hash) }
+    end
+
+    context 'when credential hash excludes the type' do
+      let(:credential_hash) { valid_ebics_credentials_without_type }
+
+      it { is_expected.to eql(valid_ebics_credentials_with_type) }
+    end
+  end
+
+  describe '#to_json' do
+    subject { described_class.new(credential_hash).to_json }
+
+    context 'when credential hash includes the type' do
+      let(:credential_hash) { valid_ebics_credentials_with_type }
+
+      it { is_expected.to eql(credential_hash.to_json) }
+    end
+
+    context 'when credential hash excludes the type' do
+      let(:credential_hash) { valid_ebics_credentials_without_type }
+
+      it { is_expected.to eql(valid_ebics_credentials_with_type.to_json) }
+    end
+  end
+
+  describe described_class::Errors do
+    describe described_class::Empty do
+      describe '#to_s' do
+        it 'responds correct' do
+          expect(subject.to_s).to eql('Empty Ebics credentials')
+        end
+      end
+    end
+
+    describe described_class::Invalid do
+      describe '#to_s' do
+        it 'responds correct' do
+          expect(subject.to_s).to eql('Invalid Ebics credentials')
+        end
+      end
+    end
+  end
+end

data/spec/bank_credentials/errors_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BankCredentials::Errors::Base do
+  it 'has a message when given a message' do
+    expect do
+      raise described_class, 'oh no!'
+    end.to(raise_error do |error|
+      expect(error.message).to eql('oh no!')
+      expect(error.to_s).to eql('oh no!')
+    end)
+  end
+end

data/spec/bank_credentials/factory_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BankCredentials::Factory do
+  describe '.from_hash' do
+    subject { described_class.from_hash(credentials) }
+    context 'given a valid hbci credential hash' do
+      let(:credentials) { valid_hbci_credentials_with_type }
+
+      it { is_expected.to be_a(BankCredentials::Hbci) }
+    end
+
+    context 'given a valid hbci credential hash without type' do
+      let(:credentials) { valid_hbci_credentials_without_type }
+
+      specify { expect { subject }.to raise_error(BankCredentials::Errors::Invalid) }
+    end
+
+    context 'given a valid ebics credential hash without type' do
+      let(:credentials) { valid_ebics_credentials_without_type }
+
+      specify { expect { subject }.to raise_error(BankCredentials::Errors::Invalid) }
+    end
+
+    context 'given a valid hbci credential hash' do
+      let(:credentials) { valid_ebics_credentials_with_type }
+
+      it { is_expected.to be_a(BankCredentials::Ebics) }
+    end
+
+    context 'given an empty hash' do
+      let(:credentials) { {} }
+
+      specify { expect { subject }.to raise_error(BankCredentials::Errors::Invalid) }
+    end
+
+    context 'given nil' do
+      let(:credentials) { nil }
+
+      specify { expect { subject }.to raise_error(BankCredentials::Errors::Invalid) }
+    end
+  end
+
+  describe '.from_encoded_json' do
+    let(:encoded_json) { Base64.urlsafe_encode64(credential_hash.to_json) }
+
+    context 'given a valid ebics credential hash' do
+      let(:credential_hash) { valid_ebics_credentials }
+
+      it 'returns an ebics credential object' do
+        expect(described_class.from_encoded_json(encoded_json)).to be_a(BankCredentials::Ebics)
+      end
+
+      it 'initializes the credential object with the credential hash' do
+        expect(BankCredentials::Ebics).to receive(:new).with(credential_hash)
+
+        described_class.from_encoded_json(encoded_json)
+      end
+    end
+
+    context 'given a hbci credential hash' do
+      let(:credential_hash) { valid_hbci_credentials }
+
+      it 'returns an hbci credential object' do
+        expect(described_class.from_encoded_json(encoded_json)).to be_a(BankCredentials::Hbci)
+      end
+
+      it 'initializes the credential object with the credential hash' do
+        expect(BankCredentials::Hbci).to receive(:new).with(credential_hash)
+
+        described_class.from_encoded_json(encoded_json)
+      end
+    end
+
+    context 'given nil' do
+      let(:encoded_json) { nil }
+
+      it 'raises an error' do
+        expect { described_class.from_encoded_json(encoded_json) }
+          .to raise_error(BankCredentials::Errors::Invalid)
+      end
+    end
+
+    context 'given an empty string' do
+      let(:encoded_json) { '' }
+
+      it 'raises an error' do
+        expect { described_class.from_encoded_json(encoded_json) }
+          .to raise_error(BankCredentials::Errors::Invalid)
+      end
+    end
+
+    context 'given unparseable json' do
+      let(:encoded_json) { 'asd' }
+
+      it 'raises an error' do
+        expect { described_class.from_encoded_json(encoded_json) }
+          .to raise_error(BankCredentials::Errors::Invalid)
+      end
+    end
+
+    context 'given a hash' do
+      let(:encoded_json) { { a: 'asd' } }
+
+      it 'raises an error' do
+        expect { described_class.from_encoded_json(encoded_json) }
+          .to raise_error(BankCredentials::Errors::Invalid)
+      end
+    end
+  end
+end

data/spec/bank_credentials/hbci_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BankCredentials::Hbci do
+  let(:credential_hash) { valid_hbci_credentials_without_type }
+
+  describe 'attribute readers' do
+    subject { described_class.new(credential_hash) }
+
+    it 'provides public access to the credentials' do
+      expect(subject.url).to eql('url')
+      expect(subject.bank_code).to eql('bank_code')
+      expect(subject.user_id).to eql('user_id')
+      expect(subject.pin).to eql('pin')
+    end
+  end
+
+  describe '#valid?' do
+    it 'returns false when one of the keys is missing' do
+      %i[url bank_code user_id pin].each do |key|
+        expect(described_class.new(credential_hash.merge!(key => nil))).to_not be_valid
+      end
+    end
+
+    it 'returns true when none of the keys is missing' do
+      expect(described_class.new(credential_hash)).to be_valid
+    end
+  end
+
+  describe 'validate!' do
+    it 'raises an error when one of the keys is missing' do
+      %i[url bank_code user_id pin].each do |key|
+        subject = described_class.new(credential_hash.merge!(key => nil), validate: false)
+        expect { subject.validate! }.to raise_error(BankCredentials::Hbci::Errors::Invalid)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    subject { described_class.new(credential_hash).to_h }
+
+    context 'when credential hash includes the type' do
+      let(:credential_hash) { valid_hbci_credentials_with_type }
+
+      it { is_expected.to eql(credential_hash) }
+    end
+
+    context 'when credential hash excludes the type' do
+      let(:credential_hash) { valid_hbci_credentials_without_type }
+
+      it { is_expected.to eql(valid_hbci_credentials_with_type) }
+    end
+  end
+
+  describe '#to_json' do
+    subject { described_class.new(credential_hash).to_json }
+
+    context 'when credential hash includes the type' do
+      let(:credential_hash) { valid_hbci_credentials_with_type }
+
+      it { is_expected.to eql(credential_hash.to_json) }
+    end
+
+    context 'when credential hash excludes the type' do
+      let(:credential_hash) { valid_hbci_credentials_without_type }
+
+      it { is_expected.to eql(valid_hbci_credentials_with_type.to_json) }
+    end
+  end
+
+  describe '#encode' do
+    subject { described_class.new(credential_hash).encode }
+
+    it 'returns the ursafe base64 encoded string' do
+      expect(subject).to eql(
+        Base64.urlsafe_encode64(described_class.new(credential_hash).to_json)
+      )
+    end
+  end
+
+  describe described_class::Errors do
+    describe described_class::Empty do
+      describe '#to_s' do
+        it 'responds correct' do
+          expect(subject.to_s).to eql('Empty Hbci credentials')
+        end
+      end
+    end
+
+    describe described_class::Invalid do
+      describe '#to_s' do
+        it 'responds correct' do
+          expect(subject.to_s).to eql('Invalid Hbci credentials')
+        end
+      end
+    end
+  end
+end

data/spec/bank_credentials_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BankCredentials do
+  it 'has a version number' do
+    expect(BankCredentials::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'bank_credentials'
+require 'byebug'
+require 'support/credentials'

data/spec/support/credentials.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+def valid_ebics_credentials
+  valid_ebics_credentials_with_type
+end
+
+def valid_ebics_credentials_without_type
+  {
+    key:        'key',
+    passphrase: 'passphrase',
+    url:        'https://localhost',
+    host_id:    'host_id',
+    user_id:    'user_id',
+    partner_id: 'partner_id'
+  }
+end
+
+def valid_ebics_credentials_with_type
+  valid_ebics_credentials_without_type.merge(type: 'ebics')
+end
+
+def valid_hbci_credentials
+  valid_hbci_credentials_with_type
+end
+
+def valid_hbci_credentials_without_type
+  {
+    url:       'url',
+    bank_code: 'bank_code',
+    user_id:   'user_id',
+    pin:       'pin'
+  }
+end
+
+def valid_hbci_credentials_with_type
+  valid_hbci_credentials_without_type.merge(type: 'hbci')
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: bank_credentials
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Roman Lehnert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Encapsulates and validates the completeness of banking credentials for
+  ebics and hbci.
+email:
+- roman.lehnert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bank_credentials.gemspec
+- bin/console
+- bin/setup
+- lib/bank_credentials.rb
+- lib/bank_credentials/base.rb
+- lib/bank_credentials/ebics.rb
+- lib/bank_credentials/errors/errors.rb
+- lib/bank_credentials/factory.rb
+- lib/bank_credentials/hbci.rb
+- lib/bank_credentials/version.rb
+- spec/bank_credentials/base_spec.rb
+- spec/bank_credentials/ebics_spec.rb
+- spec/bank_credentials/errors_spec.rb
+- spec/bank_credentials/factory_spec.rb
+- spec/bank_credentials/hbci_spec.rb
+- spec/bank_credentials_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+homepage: https://github.com/fintastic/bank_credentials
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A tiny ruby container for ebics and hbci credentials.
+test_files: []