ebics_credentials 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b991f1d111e10b409ca1a4394e1e29e6a654fc8
+  data.tar.gz: bd730f1e6093f02a70912449206108eb2b35ddeb
+SHA512:
+  metadata.gz: 55b8e569e3fba9779c66afbb3eee6b6fa316c82bdf0b7a93e583f03ec9727aca38f30185cecacd58513fa90f765fa26e43352d873fa60c4273d2a2623bcf9cb8
+  data.tar.gz: d74f1774e95a545dc9fe505e4894ec81bf0a7c70c0ed5a036d42d1175d5937f0e0c1d0e84bd76e3b3fcd339d785138e4a3a605f60c2e3b34d96ef69becdb00e5

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    ebics_credentials (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  byebug (~> 5)
+  ebics_credentials!
+  rake (~> 10.0)
+  rspec (~> 3)
+
+BUNDLED WITH
+   1.10.5

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,81 @@
+# EbicsCredentials
+
+EbicsCredentials is a tiny wrapper for keeping together ebics credentials.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ebics_credentials'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebics_credentials
+
+## Usage
+
+### Feeding with a credentials hash
+Take a credentials hash and initialize an `EbicsCredentials` 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 = EbicsCredentials.new(credential_hash)
+```
+At initialization, the completeness of the attributes will be validated. If they are invalid, `EbicsCredentials::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 = EbicsCredentials.from_encoded_json(encoded_json)
+```
+When the given argument is not valid json, `EbicsCredentials::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"
+```
+
+
+
+## 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/romanlehnert/ebics_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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ebics_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/ebics_credentials.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ebics_credentials"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Roman Lehnert"]
+  spec.email         = ["roman.lehnert@googlemail.com"]
+
+  spec.summary       = %q{A ruby container for ebics credentials}
+  spec.description   = %q{Encapsulates and validates the completeness of ebics credentials}
+  spec.homepage      = "http://github.com/romanlehnert/ebics_credentials"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency "byebug", '~> 5'
+end

data/lib/ebics_credentials.rb

@@ -0,0 +1,71 @@
+require 'base64'
+require 'json'
+
+class EbicsCredentials
+
+  module Errors
+    class Base < StandardError; end
+    class Empty < Base
+      def to_s
+        "empty ebics credentials"
+      end
+    end
+    class Invalid < Base
+      def to_s
+        "invalid ebics credentials"
+      end
+    end
+  end
+
+  extend Forwardable
+  def_delegator :@credentials, :key
+  def_delegator :@credentials, :passphrase
+  def_delegator :@credentials, :url
+  def_delegator :@credentials, :host_id
+  def_delegator :@credentials, :partner_id
+  def_delegator :@credentials, :user_id
+
+  def self.from_encoded_json(encoded_json)
+    raise Errors::Empty if encoded_json.nil? || encoded_json.empty? 
+    raise Errors::Invalid if !encoded_json.is_a?(String)
+
+    begin
+      credential_hash = JSON.parse(Base64.decode64(encoded_json), symbolize_names: true)
+    rescue => error
+      if error.is_a?(JSON::ParserError) 
+        raise Errors::Invalid
+      else
+        raise error
+      end
+    end
+
+    self.new(credential_hash)
+  end
+
+  def initialize(credential_hash, options = {})
+    @credentials = OpenStruct.new(credential_hash)
+    validate! unless !options[:validate]
+  end
+
+  def to_h
+    @credentials.to_h
+  end
+
+  def to_json
+    to_h.to_json
+  end
+
+  def keys
+    [:key, :passphrase, :user_id, :host_id, :partner_id, :url]
+  end
+
+  def valid?
+    keys.each do |key|
+      return false if @credentials[key].nil? || @credentials[key].empty?
+    end
+  end
+
+  def validate!
+    raise Errors::Invalid unless valid?
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ebics_credentials
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Lehnert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-02 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: 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'
+- !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'
+description: Encapsulates and validates the completeness of ebics credentials
+email:
+- roman.lehnert@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ebics_credentials.gemspec
+- lib/ebics_credentials.rb
+homepage: http://github.com/romanlehnert/ebics_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.4.6
+signing_key: 
+specification_version: 4
+summary: A ruby container for ebics credentials
+test_files: []
+has_rdoc: