soar_customer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cfe5f645ce2138447b712ef3c71bdc2852cf292
+  data.tar.gz: 3e78e03791c9c1ddd5ae69834f44b1e771a2486e
+SHA512:
+  metadata.gz: 0f388bdd8ffae786e92c35e2b40109eebab3cdd92592d05572ab5b5c2dd78f1baa629f9de4628cb1d220923bd2de267861e433cc23d5a0b4d09a41b8d1fc811f
+  data.tar.gz: b1919b2356290d63b27cc716932c9001c4d8baea12c645612536ac9aa8208d96ab5d9168893b7e75f850f9137bef3ddac87e8f2daaf67828de2f42b2fa0ffb6c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+nohup.out
+sinatra.log
+/.gem/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,32 @@
+sudo: required
+
+services:  
+    - docker
+
+env:  
+    global:
+        - DOCKER_VERSION=1.10.1-0~trusty
+        - DOCKER_COMPOSE_VERSION=1.6.0
+rvm:
+  - 2.2.0
+
+before_install:  
+    # list docker-engine versions
+    - apt-cache madison docker-engine
+
+    # upgrade docker-engine to specific version
+    - sudo apt-get -o Dpkg::Options::="--force-confnew" install -y docker-engine=${DOCKER_VERSION}
+
+    # reinstall docker-compose at specific version
+    - sudo rm /usr/local/bin/docker-compose
+    - curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
+    - chmod +x docker-compose
+    - sudo mv docker-compose /usr/local/bin
+    - gem install bundler -v 1.11.2
+
+script:  
+    - docker version
+    - docker-compose version
+    - docker-compose up -d
+    - rake 
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 daneb
+
+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,45 @@
+# SoarCustomer
+This is a Hetzner API provider for Customer data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_customer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_customer
+
+## Testing
+If you desire to run docker locally without needing the Fake Service you, you can set your container IP here below and have the tests run against it.
+
+```bash
+set -x TEST_HOST 192.168.99.100 
+export TEST_HOST=192.168.99.100
+bundle
+rake docker 
+```
+
+To run tests as per usual (which will startup a local sinatra service to be a fake service)
+
+```bash
+bundle
+rake 
+```
+
+##### Travis CI requires Docker unfortunately for the Fake Service to run.
+The fake service can be found in spec/mock_hapi/
+
+## Usage
+
+## 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,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+$pid = 0
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :local
+
+task :local do
+  begin
+    sh 'nohup rackup -p 9292 spec/mock_hapi/app.rb > sinatra.log 2>&1&'
+    puts "Firing up mock HAPI server"
+    $pid = `ps -ef | grep [a]pp.rb | grep 9292 | awk '{ print $2 }'`
+    puts "Pid found: #{$pid}"
+    sh 'rspec spec/'
+  ensure # Rake will abort when tests fail
+    puts "Tests done - shutting down mock HAPI server"
+    `kill #{$pid}`
+  end
+end
+
+task :docker => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar_customer"
+
+# 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/docker-compose.yml

@@ -0,0 +1,9 @@
+sinatra:
+    build: ./spec/mock_hapi
+    command: bundle exec rackup -o 0.0.0.0 -p 9292
+    volumes:
+      - ./spec/mock_hapi:/app
+    ports:
+      - "9292:9292"
+    expose:
+      - "9292"

data/lib/soar_customer/version.rb

@@ -0,0 +1,3 @@
+module SoarCustomer
+  VERSION = "0.1.0"
+end

data/lib/soar_customer.rb

@@ -0,0 +1,136 @@
+require "soar_customer/version"
+require 'soar_idm/directory_provider'
+
+module SoarCustomer
+  # Custom Error Handling for Provider
+  class SoarHapiError < StandardError
+  end
+
+  # Directory Provider to HAPI for all things related to Customer Data
+  #
+  # @author Dane-Garrin Balia
+  class HapiProvider < SoarIdm::DirectoryProvider
+    # Passed in at initialization with connection details, username and password etc
+    attr_reader :configuration
+    # URL for HAPI
+    attr_reader :server_url
+    # Credentials is both the username and password
+    attr_reader :credentials
+    # Username for HAPI
+    attr_reader :username
+    # Password for HAPI
+    attr_reader :password
+    # Faraday initialized 
+    attr_reader :connection
+
+    # Constructor
+    # @param configuration [Hash] contains the configuration details for connecting to HAPI
+    # @note Cannot bootstrap without these details
+    def initialize(configuration)
+      bootstrap(configuration)
+    end
+
+    # Used to authenticate against HAPI
+    # @return [Boolean] Returns true if authentication details are passed in
+    # @note Must be called first prior to any use
+    def authenticate(credentials)
+      @credentials = credentials
+      validate_credentials(credentials)
+      remember_credentials(credentials)
+    end
+    
+    # Used to create a profile through HAPI
+    # @return [String] Returns body of message (JSON string) from HAPI response
+    # @note This is how you create a customer profile (not an account)
+    def create_profile(customer)
+      post('/profile', customer)
+    end
+   
+   # Confirms if the class is instantiated with some form of configuration information 
+    def bootstrapped?
+      not @configuration.nil?
+    end
+
+    protected
+    
+    # Bootstrapping the application via configuration
+    def bootstrap(configuration)
+      @configuration = configuration
+      validate_configuration(@configuration)
+      remember_configuration(@configuration)
+    end
+
+    # Generic Method for Posting to HAPI
+    # @param endpoint [String] used for what resource to access on HAPI
+    # @param data [JSON] customer details 
+    def post(endpoint, data)
+      raise SoarHapiError.new('Missing data') if data.nil? or data.empty?
+      setup_connection
+      response = submit_to_hapi(endpoint, data)
+      raise SoarHapiError.new('Endpoint Not Found') if response.status > 200
+      response.body
+    rescue Faraday::Error::ConnectionFailed => e
+      raise SoarHapiError.new('Connection failed to HAPI')
+    end
+    
+    private
+
+    # Submit information to HAPI (only post)
+    # 
+    # @note Raises exception to Method post(endpoint, data)
+    def submit_to_hapi(endpoint, data)
+      output = @connection.post do |req|
+        req.url endpoint
+        req.headers['Content-Type'] = 'application/json'
+        req.body = data
+      end
+      output
+    rescue Exception => e
+      raise 
+    end
+
+    # Sets up the connection by instantiating Faraday
+    # 
+    # @note Raises exception to Method post(endpoint, data)
+    def setup_connection
+      @connection = Faraday.new(:url => @server_url)
+      @connection.basic_auth(@username, @password)
+    rescue Exception => e
+      raise 
+    end
+
+    # Validation for configuration hash
+    #
+    # @note Returns a SoarHapiError if validation fails
+    def validate_configuration(configuration)
+      raise SoarHapiError.new('No configuration') if configuration.nil?
+      raise SoarHapiError.new('Empty configuration') if configuration == {}
+      raise SoarHapiError.new('Invalid configuration') if not configuration.is_a?(Hash)
+      raise SoarHapiError.new('Missing server url') if configuration['server_url'].nil?
+    end
+
+    # Validation for credentials 
+    #
+    # @note Returns a SoarHapiError if validation fails
+    def validate_credentials(credentials)
+      raise SoarHapiError.new('Missing credentials') if credentials.nil?
+      raise SoarHapiError.new('Empty credentials') if credentials == {}
+      raise SoarHapiError.new('Invalid credentials') if not credentials.is_a?(Hash)
+      raise SoarHapiError.new('Missing username') if credentials['username'].nil?
+      raise SoarHapiError.new('Missing password') if credentials['password'].nil?
+    end
+
+    # Ensures configuration is bound for re-use
+    def remember_configuration(configuration)
+      @configuration = configuration
+      @server_url = @configuration['server_url']
+    end
+
+    # Ensure credential is bound for re-use
+    def remember_credentials(credentials)
+      @credentials = credentials
+      @username = @credentials['username']
+      @password = @credentials['password']
+    end
+  end
+end

data/soar_customer.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_customer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_customer"
+  spec.version       = SoarCustomer::VERSION
+  spec.authors       = ["daneb"]
+  spec.email         = ["dane.balia@hetzner.co.za"]
+
+  spec.summary       = %q{Customer client library allowing easy access to customer data}
+  spec.description   = %q{Customer client library allowing easy access to customer data}
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "yard"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~>0.10"
+  spec.add_dependency "soar_idm", "~> 0.0.2"
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: soar_customer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- daneb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: byebug
+  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: sinatra
+  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: rack
+  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: yard
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: soar_idm
+  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
+description: Customer client library allowing easy access to customer data
+email:
+- dane.balia@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/soar_customer.rb
+- lib/soar_customer/version.rb
+- soar_customer.gemspec
+homepage: 
+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.5
+signing_key: 
+specification_version: 4
+summary: Customer client library allowing easy access to customer data
+test_files: []
+has_rdoc: