auth_token_store_provider 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d9b7f73982b9a9a3ee1f279630add22133eda53
+  data.tar.gz: 31e1aa63b0792770d5cb802ec2bb203012fe3a35
+SHA512:
+  metadata.gz: 924e9a3b0f803482e4b15bcd57b36f5a78d0ef7b532627753ad039279df08067974e323f75d645d929f4d3dc8e45a8e6ee76fc4529503a1fd181ae6a19d10bac
+  data.tar.gz: a41df3efa695ea28abfb1e6531e796b3bf7a4824107e7cd857980562fcc656cda80942f245d8927237b0ada5da98e1b296ad9cbf48bc42bf3ee653b65e928376

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+auth_token_store_provider

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.3.0
+
+WORKDIR /usr/local/src/
+
+ADD . /usr/local/src/
+RUN cd /usr/local/src/
+RUN gem install bundler
+RUN bundle install
+
+CMD bundle exec rspec -cfd spec/*

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Barney de Villiers
+
+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,84 @@
+# AuthTokenStoreProvider
+
+[![Gem Version](https://badge.fury.io/rb/sauthentication_token_store.png)](https://badge.fury.io/rb/authentication_token_store)
+
+This gem provides authentication token storage client library in order to interface with the authentication token storage service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auth_token_store_provider'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authentication_token_store --source http://gems.hetzner.co.za
+
+
+## Testing
+
+Locally run the tests:
+
+    $ bundle exec rspec -cfd spec/*
+
+
+## Usage
+
+### StubClient
+  ```
+  provider = AuthTokenStoreProvider::StubClient.new
+  ```
+### Adding a token
+```
+  provider.add(token_identifier: '4603547ba5bdc6',
+               authenticated_identifier: 'uuid123',
+               token_issue_time: '2017-01-11T14:00:36+02:00',
+               token_expiry_time: '2017-01-12T14:00:36+02:00')
+```
+
+### Removing a token
+```
+  provider.remove(token_identifier: '4603547ba5bdc6')
+```
+
+### Removing all tokens for a authenticated_identifier
+```
+  provider.remove_tokens_for(authenticated_identifier: 'uuid123')
+```
+
+### Determine if a token exist
+```
+provider.token_exist?(
+  token_identifier: '4603547ba5bdc6',
+  authenticated_identifier: 'uuid123',
+  token_issue_time:  '2017-01-11T14:00:36+02:00',
+  token_expiry_time: '2017-01-12T14:00:36+02:00'
+)
+```
+
+### List all tokens for a authenticated_identifier
+```
+provider.subject.list_tokens_for(authenticated_identifier: 'uuid123')
+```
+
+## Detailed example
+
+
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to barney dot de dot villiers at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+## Notes
+
+
+
+## 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"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)

data/auth_token_store_provider.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auth_token_store_provider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auth_token_store_provider"
+  spec.version       = AuthenticationTokenStore::VERSION
+  spec.authors       = ["Barney de Villiers", "Tiaan van Deventer"]
+  spec.email         = ["barney.de.villiers@hetzner.co.za", "tiaan.van.deventer@hetzner.co.za"]
+  spec.description   = %q{Client provider library for the authentication token storage service}
+  spec.summary       = %q{Client provider library for the authentication token storage service in order to interface with the storage programmatically}
+  spec.homepage      = "https://gitlab.host-h.net/hetznerZA/authentication-token-store"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_dependency 'authenticated_client', '~> 0.0.2'
+
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.13'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "authentication_token_store"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/auth_token_store_provider.rb

@@ -0,0 +1,6 @@
+module AuthenticationTokenStore
+end
+
+require 'auth_token_store_provider/client'
+require 'auth_token_store_provider/stub_client'
+require 'auth_token_store_provider/version'

data/lib/auth_token_store_provider/client.rb

@@ -0,0 +1,70 @@
+require 'authenticated_client'
+require 'json'
+
+module AuthTokenStoreProvider
+  class Client
+    def initialize(configuration)
+      @configuration = configuration
+      validate_configuration
+    end
+
+    def add(token_identifier:, authenticated_identifier:, token_issue_time:, token_expiry_time:, flow_identifier: nil)
+      request_body = {
+        'authenticated_identifier' => authenticated_identifier,
+        'token_identifier'         => token_identifier,
+        'token_issue_time'         => token_issue_time,
+        'token_expiry_time'        => token_expiry_time
+      }
+      response = perform_request(resource: 'add',
+                                 body: request_body,
+                                 flow_identifier: flow_identifier)
+      'success' == JSON.parse(response.body)['status']
+    end
+
+    def remove(token_identifier:, flow_identifier: nil)
+      request_body = { 'token_identifier' => token_identifier }
+      response = perform_request(resource: 'remove',
+                                 body: request_body,
+                                 flow_identifier: flow_identifier)
+      'success' == JSON.parse(response.body)['status']
+    end
+
+    def token_exist?(token_identifier:, authenticated_identifier:, token_issue_time:, token_expiry_time:, flow_identifier: nil)
+      request_body = {
+        'authenticated_identifier' => authenticated_identifier,
+        'token_identifier'         => token_identifier,
+        'token_issue_time'         => token_issue_time,
+        'token_expiry_time'        => token_expiry_time
+      }
+      response = perform_request(resource: 'check_existance',
+                                 body: request_body,
+                                 flow_identifier: flow_identifier)
+      JSON.parse(response.body)['data']['token_exist']
+    end
+
+    def remove_tokens_for(authenticated_identifier:, flow_identifier: nil)
+      raise RuntimeError, 'Not implemented'
+    end
+
+    def list_tokens_for(authenticated_identifier:, flow_identifier: nil)
+      raise RuntimeError, 'Not implemented'
+    end
+
+    private
+
+    def validate_configuration
+      raise "element 'service_url' not in configuration" unless @configuration['service_url']
+    end
+
+    def perform_request(resource:, body:, flow_identifier:)
+      client = AuthenticatedClient::Client.new
+      client.url = "#{@configuration['service_url']}/#{resource}"
+      client.token = @configuration['auth_token']
+      client.verb = :post
+      client.parameters = { 'flow_identifier' => flow_identifier }
+      client.body = body if body
+      client.auditing = nil
+      response = client.request
+    end
+  end
+end

data/lib/auth_token_store_provider/stub_client.rb

@@ -0,0 +1,55 @@
+module AuthTokenStoreProvider
+  class StubClient
+
+    def initialize(configuration = {})
+      if configuration == {}
+        @store = []
+      elsif configuration['stub-data'] != {} || configuration['stub-data'] != nil
+        @store = configuration['stub-data']
+      end
+    end
+
+    def simulate_store_failure
+      @store_failure = true
+    end
+
+    def add(token_identifier:, authenticated_identifier:, token_issue_time:, token_expiry_time:, flow_identifier: nil)
+      raise RuntimeError, 'Failure accessing store' if @store_failure
+      @store << { token_identifier: token_identifier,
+                  authenticated_identifier: authenticated_identifier,
+                  token_issue_time: token_issue_time,
+                  token_expiry_time: token_expiry_time }
+    end
+
+    def remove(token_identifier:, flow_identifier: nil)
+      raise RuntimeError, 'Failure accessing store' if @store_failure
+      @store.delete_if { |x| x[:token_identifier] == token_identifier }
+      true
+    end
+
+    def token_exist?(token_identifier:, authenticated_identifier:, token_issue_time:, token_expiry_time:, flow_identifier: nil)
+      raise RuntimeError, 'Failure accessing store' if @store_failure
+
+      @store.each { |x|
+        if ((x[:token_identifier] == token_identifier) and
+            (x[:authenticated_identifier] == authenticated_identifier) and
+            (x[:token_issue_time] == token_issue_time) and
+            (x[:token_expiry_time] == token_expiry_time))
+          return true
+        end
+      }
+      false
+    end
+
+    def remove_tokens_for(authenticated_identifier:, flow_identifier: nil)
+      raise RuntimeError, 'Failure accessing store' if @store_failure
+      @store.delete_if { |x| x[:authenticated_identifier] == authenticated_identifier }
+      true
+    end
+
+    def list_tokens_for(authenticated_identifier:, flow_identifier: nil)
+      raise RuntimeError, 'Failure accessing store' if @store_failure
+      @store.select { |x| x[:authenticated_identifier] == authenticated_identifier}
+    end
+  end
+end

data/lib/auth_token_store_provider/version.rb

@@ -0,0 +1,3 @@
+module AuthenticationTokenStore
+  VERSION = '1.0.1'
+end

data/sanity/.ruby-gemset

@@ -0,0 +1 @@
+sanity

data/sanity/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/sanity/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'authentication_token_store', :path => "../"

data/sanity/sanity.rb

@@ -0,0 +1,10 @@
+require 'authentication_token_store'
+require 'yaml'
+
+class Main
+  def run
+  end
+end
+
+main = Main.new
+main.run

data/spec/client_spec.rb

@@ -0,0 +1,335 @@
+require 'spec_helper'
+require 'yaml'
+
+describe AuthTokenStoreProvider::Client do
+
+  subject { AuthTokenStoreProvider::Client.new(test_configuration) }
+
+  before :each do
+    @test_token_identifier = create_test_token_identifier
+    @test_token_identifier_2 = create_test_token_identifier
+    @test_authenticated_identifier = 'someone'
+    @test_authenticated_identifier_2 = 'someone_else'
+    @test_token_token_issue_time = Time.now.utc.iso8601(3)
+    @test_token_token_issue_time_2 = Time.now.utc.iso8601(3)
+    @test_token_expiry_time = (Time.now+86400).utc.iso8601(3)
+  end
+
+  it 'has a version number' do
+    expect(AuthenticationTokenStore::VERSION).not_to be nil
+  end
+
+  describe "#initialize" do
+    context "when initializing the client" do
+      it 'saves the configuration' do
+        expect(subject.instance_variable_get('@configuration')).to eq test_configuration
+      end
+      it 'checks that the configuration is valid' do
+        expect{
+          AuthTokenStoreProvider::Client.new({})
+        }.to raise_error RuntimeError, "element 'service_url' not in configuration"
+      end
+    end
+  end
+
+  describe "#add" do
+    context "when adding a token to the store" do
+      it 'responds with true' do
+        expect(
+          subject.token_exist?(
+            token_identifier:         @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+
+        subject.add(
+          token_identifier:         @test_token_identifier,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        expect(
+          subject.token_exist?(
+            token_identifier:         @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq true
+      end
+    end
+
+    context "when unable to store a token due to an error" do
+      it 'responds with an error' do
+        expect(subject.token_exist?(
+          token_identifier:         @test_token_identifier,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time)
+        ).to eq false
+
+        simulate_storage_failure(subject)
+
+        expect{
+          subject.add(token_identifier:         @test_token_identifier,
+                      authenticated_identifier: @test_authenticated_identifier,
+                      token_issue_time:         @test_token_token_issue_time,
+                      token_expiry_time:        @test_token_expiry_time
+          )
+        }.to raise_error Exception
+      end
+    end
+  end
+
+  describe "#remove" do
+    context "Given an existing token with a unique token identifier" do
+      context "when the token is removed successfully" do
+        it "reponds with true" do
+          subject.add(token_identifier:         @test_token_identifier,
+                      authenticated_identifier: @test_authenticated_identifier,
+                      token_issue_time:         @test_token_token_issue_time,
+                      token_expiry_time:        @test_token_expiry_time)
+
+          expect(
+            subject.token_exist?(
+              token_identifier:         @test_token_identifier,
+              authenticated_identifier: @test_authenticated_identifier,
+              token_issue_time:         @test_token_token_issue_time,
+              token_expiry_time:        @test_token_expiry_time
+            )
+          ).to eq true
+
+          expect(
+            subject.remove(
+              token_identifier: @test_token_identifier
+            )
+          ).to eq(true)
+
+          expect(
+            subject.token_exist?(
+              token_identifier:         @test_token_identifier,
+              authenticated_identifier: @test_authenticated_identifier,
+              token_issue_time:         @test_token_token_issue_time,
+              token_expiry_time:        @test_token_expiry_time
+            )
+          ).to eq false
+        end
+      end
+
+    context "when unable to remove a token due to store error" do
+        it 'responds with an error' do
+          simulate_storage_failure(subject)
+
+          expect{
+            subject.remove(token_identifier: @test_token_identifier)
+          }.to raise_error Exception
+        end
+      end
+    end
+  end
+
+  # describe "#removes_for" do
+  #   context "when all the matching tokens for the authenticated indentifier has been removed successfully from the store" do
+  #     it 'responds with true' do
+  #       subject.add(
+  #         token_identifier:         @test_token_identifier,
+  #         authenticated_identifier: @test_authenticated_identifier,
+  #         token_issue_time:         @test_token_token_issue_time,
+  #         token_expiry_time:        @test_token_expiry_time
+  #       )
+  #
+  #       subject.add(
+  #         token_identifier:         @test_token_identifier_2,
+  #         authenticated_identifier: @test_authenticated_identifier,
+  #         token_issue_time:         @test_token_token_issue_time,
+  #         token_expiry_time:        @test_token_expiry_time
+  #       )
+  #
+  #       expect(
+  #         subject.token_exist?(
+  #           token_identifier:         @test_token_identifier,
+  #           authenticated_identifier: @test_authenticated_identifier,
+  #           token_issue_time:         @test_token_token_issue_time,
+  #           token_expiry_time:        @test_token_expiry_time
+  #         )
+  #       ).to eq true
+  #
+  #       expect(
+  #         subject.token_exist?(
+  #           token_identifier:         @test_token_identifier_2,
+  #           authenticated_identifier: @test_authenticated_identifier,
+  #           token_issue_time:         @test_token_token_issue_time,
+  #           token_expiry_time:        @test_token_expiry_time
+  #         )
+  #       ).to eq true
+  #
+  #       expect(
+  #         subject.remove_tokens_for(
+  #           authenticated_identifier: @test_authenticated_identifier
+  #         )
+  #       ).to eq(true)
+  #
+  #       expect(
+  #         subject.token_exist?(
+  #           token_identifier:         @test_token_identifier,
+  #           authenticated_identifier: @test_authenticated_identifier,
+  #           token_issue_time:         @test_token_token_issue_time,
+  #           token_expiry_time:        @test_token_expiry_time
+  #         )
+  #       ).to eq false
+  #
+  #       expect(
+  #         subject.token_exist?(
+  #           token_identifier:         @test_token_identifier_2,
+  #           authenticated_identifier: @test_authenticated_identifier,
+  #           token_issue_time:         @test_token_token_issue_time,
+  #           token_expiry_time:        @test_token_expiry_time
+  #         )
+  #       ).to eq false
+  #     end
+  #   end
+  #
+  #   context "When a store error occurs while trying to remove all tokens for authenticated identifier" do
+  #     it 'responds with an error' do
+  #       simulate_storage_failure(subject)
+  #
+  #       expect{
+  #         subject.remove_tokens_for(authenticated_identifier: @test_authenticated_identifier)
+  #       }.to raise_error Exception
+  #     end
+  #   end
+  # end
+
+  describe "#token_exist?" do
+    context "when searching for a existing and persisted token" do
+      it "responds with true" do
+        subject.add(token_identifier:         @test_token_identifier,
+                    authenticated_identifier: @test_authenticated_identifier,
+                    token_issue_time:         @test_token_token_issue_time,
+                    token_expiry_time:        @test_token_expiry_time)
+
+        expect(
+          subject.token_exist?(
+            token_identifier:         @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq true
+      end
+    end
+
+
+    context "when the token is not persisted" do
+      it "responds with false" do
+        expect(
+          subject.token_exist?(
+            token_identifier:         @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+      end
+    end
+
+    context "when a token (but only with some of the elements) exist in the store" do
+      it "responds with false" do
+        subject.add(
+          token_identifier:         @test_token_identifier,
+          authenticated_identifier: @test_identifier_2,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        expect(
+          subject.token_exist?(
+            token_identifier:         @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+      end
+    end
+
+    context "when unable to access the store" do
+      it "responds with an error" do
+        subject.add(
+          token_identifier:         @test_token_identifier,
+          authenticated_identifier: @test_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        simulate_storage_failure(subject)
+
+        expect{
+          subject.token_exist?(
+            token_identifier:         @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        }.to raise_error Exception
+      end
+    end
+  end
+
+  # describe "#list_tokens_for" do
+  #   context "when searching for the list of tokens belonging to an authenticated identifer" do
+  #     context "and there are not tokens for the authenticated identifer" do
+  #       it "responds with an empty list" do
+  #         expect(
+  #           subject.list_tokens_for(authenticated_identifier: @test_authenticated_identifier)
+  #         ).to eq([])
+  #       end
+  #     end
+  #
+  #     it 'should provide a list of details if there are tokens for that authenticated identifer' do
+  #       subject.add(
+  #         token_identifier:         @test_token_identifier,
+  #         authenticated_identifier: @test_authenticated_identifier,
+  #         token_issue_time:         @test_token_token_issue_time,
+  #         token_expiry_time:        @test_token_expiry_time
+  #       )
+  #
+  #       subject.add(
+  #         token_identifier:         @test_token_identifier_2,
+  #         authenticated_identifier: @test_authenticated_identifier,
+  #         token_issue_time:         @test_token_token_issue_time_2,
+  #         token_expiry_time:        @test_token_expiry_time
+  #       )
+  #
+  #       subject.add(
+  #         token_identifier:         @test_token_identifier_2,
+  #         authenticated_identifier: @test_authenticated_identifier_2,
+  #         token_issue_time:         @test_token_token_issue_time_2,
+  #         token_expiry_time:        @test_token_expiry_time
+  #       )
+  #
+  #       expect(
+  #         subject.list_tokens_for(authenticated_identifier: @test_authenticated_identifier)
+  #       ).to eq(
+  #         [
+  #           {
+  #             token_identifier:         @test_token_identifier,
+  #             authenticated_identifier: @test_authenticated_identifier,
+  #             token_issue_time:         @test_token_token_issue_time,
+  #             token_expiry_time:        @test_token_expiry_time
+  #           },
+  #           {
+  #             token_identifier:         @test_token_identifier_2,
+  #             authenticated_identifier: @test_authenticated_identifier,
+  #             token_issue_time:         @test_token_token_issue_time_2,
+  #             token_expiry_time:        @test_token_expiry_time
+  #           }
+  #         ]
+  #       )
+  #     end
+  #   end
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../spec/support', __FILE__)
+
+require 'auth_token_store_provider'
+require 'pry'
+
+def create_test_token_identifier
+  SecureRandom.hex(32)
+end
+
+def simulate_storage_failure(subject)
+  if subject.class == AuthTokenStoreProvider::StubClient
+    subject.simulate_store_failure
+  end
+  if subject.class == AuthTokenStoreProvider::Client
+    subject.instance_variable_get("@configuration")['service_url'] = "http://authentication-token-store:1111/"
+  end
+end
+
+def test_configuration
+  {
+    'service_url' => 'http://authentication-token-store:9393/',
+    'auth_token' => 'test_ecosystem_token_for_auth_token_generator_service'
+  }
+end

data/spec/stub_client_spec.rb

@@ -0,0 +1,350 @@
+require 'spec_helper'
+require 'yaml'
+
+describe AuthTokenStoreProvider::StubClient do
+
+  subject { AuthTokenStoreProvider::StubClient.new }
+
+  before :each do
+    @test_token_identifier = create_test_token_identifier
+    @test_token_identifier_2 = create_test_token_identifier
+    @test_authenticated_identifier = 'someone'
+    @test_authenticated_identifier_2 = 'someone_else'
+    @test_token_token_issue_time = Time.now.utc.iso8601(3)
+    @test_token_token_issue_time_2 = Time.now.utc.iso8601(3)
+    @test_token_expiry_time = (Time.now+86400).utc.iso8601(3)
+  end
+
+  it 'has a version number' do
+    expect(AuthenticationTokenStore::VERSION).not_to be nil
+  end
+
+
+  describe "#initialize" do
+    context "Given stub data, it populates the store with the data" do
+      it "responds with the stub data" do
+        configuration = {
+          'stub-data' => [{
+            token_identifier:         @test_token_identifier + 'stub',
+            authenticated_identifier: 'uuid321',
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+            }]
+          }
+
+          subject = AuthTokenStoreProvider::StubClient.new(configuration)
+
+          expect(
+            subject.token_exist?(
+              token_identifier:         @test_token_identifier + 'stub',
+              authenticated_identifier: 'uuid321',
+              token_issue_time:         @test_token_token_issue_time,
+              token_expiry_time:        @test_token_expiry_time
+            )
+          ).to eq true
+        end
+      end
+  end
+
+  describe "#add" do
+    context "when adding a token to the store" do
+      it 'responds with true' do
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+
+        subject.add(
+          token_identifier:          @test_token_identifier,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq true
+      end
+    end
+
+    context "when unable to store a token due to an error" do
+      it 'responds with an error' do
+        expect(subject.token_exist?(
+          token_identifier:          @test_token_identifier,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time)
+        ).to eq false
+
+        simulate_storage_failure(subject)
+
+        expect{
+          subject.add(token_identifier:          @test_token_identifier,
+                      authenticated_identifier: @test_authenticated_identifier,
+                      token_issue_time:         @test_token_token_issue_time,
+                      token_expiry_time:        @test_token_expiry_time
+          )
+        }.to raise_error RuntimeError, "Failure accessing store"
+      end
+    end
+
+  end
+
+  describe "#remove" do
+    context "Given an existing token with a unique token identifier" do
+      context "when the token is removed successfully" do
+        it "reponds with true" do
+          subject.add(token_identifier:          @test_token_identifier,
+                      authenticated_identifier: @test_authenticated_identifier,
+                      token_issue_time:         @test_token_token_issue_time,
+                      token_expiry_time:        @test_token_expiry_time)
+
+          expect(
+            subject.token_exist?(
+              token_identifier:          @test_token_identifier,
+              authenticated_identifier: @test_authenticated_identifier,
+              token_issue_time:         @test_token_token_issue_time,
+              token_expiry_time:        @test_token_expiry_time
+            )
+          ).to eq true
+
+          expect(
+            subject.remove(
+              token_identifier: @test_token_identifier
+            )
+          ).to eq(true)
+
+          expect(
+            subject.token_exist?(
+              token_identifier:          @test_token_identifier,
+              authenticated_identifier: @test_authenticated_identifier,
+              token_issue_time:         @test_token_token_issue_time,
+              token_expiry_time:        @test_token_expiry_time
+            )
+          ).to eq false
+        end
+      end
+
+    context "when unable to remove a token due to store error" do
+        it 'responds with an error' do
+          simulate_storage_failure(subject)
+
+          expect{
+            subject.remove(token_identifier: @test_token_identifier)
+          }.to raise_error RuntimeError, "Failure accessing store"
+        end
+      end
+    end
+  end
+
+  describe "#removes_for" do
+    context "when all the matching tokens for the authenticated indentifier has been removed successfully from the store" do
+      it 'responds with true' do
+        subject.add(
+          token_identifier:          @test_token_identifier,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        subject.add(
+          token_identifier:          @test_token_identifier_2,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq true
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier_2,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq true
+
+        expect(
+          subject.remove_tokens_for(
+            authenticated_identifier: @test_authenticated_identifier
+          )
+        ).to eq(true)
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier_2,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+      end
+    end
+
+    context "When a store error occurs while trying to remove all tokens for authenticated identifier" do
+      it 'responds with an error' do
+        simulate_storage_failure(subject)
+
+        expect{
+          subject.remove_tokens_for(authenticated_identifier: @test_authenticated_identifier)
+        }.to raise_error RuntimeError, "Failure accessing store"
+      end
+    end
+  end
+
+  describe "#token_exist?" do
+    context "when searching for a existing and persisted token" do
+      it "responds with true" do
+        subject.add(token_identifier:          @test_token_identifier,
+                    authenticated_identifier: @test_authenticated_identifier,
+                    token_issue_time:         @test_token_token_issue_time,
+                    token_expiry_time:        @test_token_expiry_time)
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq true
+      end
+    end
+
+
+    context "when the token is not persisted" do
+      it "responds with false" do
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+      end
+    end
+
+    context "when a token (but only with some of the elements) exist in the store" do
+      it "responds with false" do
+        subject.add(
+          token_identifier:          @test_token_identifier,
+          authenticated_identifier: @test_identifier_2,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        expect(
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        ).to eq false
+      end
+    end
+
+    context "when unable to access the store" do
+      it "responds with an error" do
+        subject.add(
+          token_identifier:          @test_token_identifier,
+          authenticated_identifier: @test_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        simulate_storage_failure(subject)
+
+        expect{
+          subject.token_exist?(
+            token_identifier:          @test_token_identifier,
+            authenticated_identifier: @test_authenticated_identifier,
+            token_issue_time:         @test_token_token_issue_time,
+            token_expiry_time:        @test_token_expiry_time
+          )
+        }.to raise_error RuntimeError, "Failure accessing store"
+      end
+    end
+  end
+
+  describe "#list_tokens_for" do
+    context "when searching for the list of tokens belonging to an authenticated identifier" do
+      context "and there are not tokens for the authenticated identifier" do
+        it "responds with an empty list" do
+          expect(
+            subject.list_tokens_for(authenticated_identifier: @test_authenticated_identifier)
+          ).to eq([])
+        end
+      end
+
+      it 'should provide a list of details if there are tokens for that authenticated identifier' do
+        subject.add(
+          token_identifier:          @test_token_identifier,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        subject.add(
+          token_identifier:          @test_token_identifier_2,
+          authenticated_identifier: @test_authenticated_identifier,
+          token_issue_time:         @test_token_token_issue_time_2,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        subject.add(
+          token_identifier:          @test_token_identifier_2,
+          authenticated_identifier: @test_authenticated_identifier_2,
+          token_issue_time:         @test_token_token_issue_time_2,
+          token_expiry_time:        @test_token_expiry_time
+        )
+
+        expect(
+          subject.list_tokens_for(authenticated_identifier: @test_authenticated_identifier)
+        ).to eq(
+          [
+            {
+              token_identifier:          @test_token_identifier,
+              authenticated_identifier: @test_authenticated_identifier,
+              token_issue_time:         @test_token_token_issue_time,
+              token_expiry_time:        @test_token_expiry_time
+            },
+            {
+              token_identifier:          @test_token_identifier_2,
+              authenticated_identifier: @test_authenticated_identifier,
+              token_issue_time:         @test_token_token_issue_time_2,
+              token_expiry_time:        @test_token_expiry_time
+            }
+          ]
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: auth_token_store_provider
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Barney de Villiers
+- Tiaan van Deventer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: authenticated_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Client provider library for the authentication token storage service
+email:
+- barney.de.villiers@hetzner.co.za
+- tiaan.van.deventer@hetzner.co.za
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auth_token_store_provider.gemspec
+- bin/console
+- bin/setup
+- lib/auth_token_store_provider.rb
+- lib/auth_token_store_provider/client.rb
+- lib/auth_token_store_provider/stub_client.rb
+- lib/auth_token_store_provider/version.rb
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/stub_client_spec.rb
+homepage: https://gitlab.host-h.net/hetznerZA/authentication-token-store
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Client provider library for the authentication token storage service in order
+  to interface with the storage programmatically
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/stub_client_spec.rb