proxy_rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 504810e2b43ff35a50377363f2cd74b22caadf70
-  data.tar.gz: 54c59c88935fc8bd1195e26b25c0340a748c14ec
+  metadata.gz: db7176840c8e9a52da91b08248612198aa17f557
+  data.tar.gz: ca4ad19e9d3bad727954e3ed9164cad8ee0e6267
 SHA512:
-  metadata.gz: 634c2663282ea5804be8dacb98be87ffe0292390db532b537b41373919dea5327b33ec13fc5b08e21061bb9ca966040ea2034af7d6ebaade2ec511d2c6b21b35
-  data.tar.gz: 582664775a075dfd4ca583e645568a879b46f5436519dde04110460b6138e44191368da6785d927064c7abb0bdc78d499dc9d7e98dddc03dc39e42aa70b5cf0b
+  metadata.gz: 53f73d13a40222916a1783e2c4ba19bf1ac749ea866f6d81e571baed37a567e29f245a98fc0654dd2817b114faa5bc6e49cacca4a53cdd0baf3a8dcc796b27e1
+  data.tar.gz: c75ebce750ca3f20a8000a498a54208c4f6c5c24b79ceb30427c4a1cd769ee569c8ee39e27c13f6646a77876fe56267824b4d1d501cfa3a4f2d3490feb5d071a

data/.env

@@ -0,0 +1,3 @@
+VAULT_ADDR="http://localhost:8200"
+# VAULT_TOKEN="*Test123"
+# VAULT_SSL_VERIFY=0

data/.gitignore

@@ -3,3 +3,4 @@
 pkg/*
 coverage
 tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
     - 'tmp/**/*'
   DisplayCopNames: true
+  TargetRubyVersion: 2.3
 
 Metrics/AbcSize:
   Max: 38

data/.travis.yml

@@ -1,8 +1,14 @@
+sudo: false
 env:
   - CI=1
 language: ruby
 bundler_args: --without development debug profile
 rvm:
   - 2.1.5
-  - 2.2.1
-script: script/ci
+  - 2.2.3
+  - 2.3.0
+script: script/test
+before_install:
+  - curl -o /tmp/vault.zip https://releases.hashicorp.com/vault/0.5.1/vault_0.5.1_linux_amd64.zip
+  - unzip /tmp/vault.zip
+  - install -D -m 0755 /tmp/vault ./bin/vault

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in local_pac.gemspec
@@ -13,7 +14,12 @@ group :debug do
 end
 
 group :development, :test do
-  gem 'activesupport', '~> 4.2.0', require: false
+  # Password store
+  gem 'vault'
+
+  # Set env during development/test
+  gem 'dotenv'
+
   gem 'aruba', require: false
   gem 'awesome_print', require: 'ap'
   gem 'bundler', '~> 1.3', require: false
@@ -21,7 +27,6 @@ group :development, :test do
   gem 'coveralls', require: false
   gem 'cucumber', require: false
   gem 'erubis'
-  gem 'fedux_org-stdlib', '~>0.7.25', require: false
   gem 'filegen'
   gem 'foreman', require: false
   gem 'fuubar', require: false
@@ -31,7 +36,6 @@ group :development, :test do
   gem 'license_finder'
   gem 'rack'
   gem 'rake', require: false
-  gem 'redcarpet', require: false
   gem 'rubocop', require: false
   gem 'simplecov', require: false
   gem 'sinatra', require: 'sinatra/base'

data/README.md

@@ -1,8 +1,6 @@
 # ProxyRb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/proxy_rb`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+`proxy_rb` makes it easier for you to test your proxy infrastructre.
 
 ## Installation
 
@@ -22,8 +20,12 @@ Or install it yourself as:
 
 ## Usage
 
+### Rspec-Integration
+
 ```ruby
-RSpec.describe 'Intfrastructure A' do
+require 'proxy_rb/rspec'
+
+RSpec.describe 'Infrastructure A' do
   describe 'proxy1' do
     subject { 'proxy1.example.com' }
 
@@ -95,14 +97,46 @@ RSpec.describe 'Intfrastructure A' do
 end
 ```
 
+### Authentication
+
+Maybe your proxy servers require authentication and you would like to test this
+as well. You've got several possibilies to use proxy passwords with `proxy_rb`.
+Please have a look at
+["features/authentication.feature"](features/authentication.feature) for
+detailed information.
+
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bin/console` for an interactive prompt that will allow you to experiment.
+### Requirements
+
+Go to [the download site](https://www.vaultproject.io/downloads.html) of the
+"Vault Project" and download the latest `vault` binary. Make sure you place it
+into a path which is part of the "PATH"-environment variable - even on Windows.
+
+*Example for a Linux Distribution*
+
+~~~bash
+curl -o /tmp/vault.zip https://releases.hashicorp.com/vault/0.5.1/vault_0.5.1_linux_amd64.zip
+unzip /tmp/vault.zip
+install -D /tmp/vault -m 0755 ~/bin/vault
+~~~
+
+Maybe you want to add the path `~/bin` to `PATH` via `.bashrc` or `.zshrc`.
+
+~~~bash
+export PATH=~/bin:$PATH
+~~~
+
+### Scripts
+
+After checking out the repo, run `script/bootstrap` to install dependencies.
+Then, run `script/console` for an interactive prompt that will allow you to
+experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
+To install this gem onto your local machine, run `bundle exec rake gem:install`. To
 release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release` to create a git tag for the version, push git
+`bundle exec rake gem:release` to create a git tag for the version, push git
 commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,25 +1,20 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
+namespace :gems do
+  require 'bundler/gem_tasks'
+end
 
 # require 'bundler'
 # Bundler.require :default, :test, :development
 
-require 'filegen'
-require 'fedux_org_stdlib/rake_tasks'
-
 require 'coveralls/rake/task'
 Coveralls::RakeTask.new
 
+task default: :test
+
 desc 'Run test suite'
-task :test do
-  Rake::Task['test:before'].execute
-
-  begin
-    #%w(test:rubocop test:rspec test:cucumber test:after).each { |t| Rake::Task[t].execute }
-    %w(test:rubocop test:rspec test:after).each { |t| Rake::Task[t].execute }
-  ensure
-    Rake::Task['test:after'].execute
-  end
-end
+task test: %w(test:rubocop test:rspec test:cucumber)
 
 namespace :test do
   desc 'Test with coveralls'
@@ -37,14 +32,4 @@ namespace :test do
   task :cucumber do
     sh 'bundle exec cucumber -p all'
   end
-
-  desc 'Setup test environment'
-  task :before do
-    @web_server = Process.spawn 'rackup -p 65535 script/config.ru'
-  end
-
-  desc 'Teardown test environment'
-  task :after do
-    sh "kill -9 #{@web_server}"
-  end
 end

data/bin/bootstrap

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+which ruby 2>/dev/null >&2 || {
+  echo 'Bitte "ruby" installieren'
+  exit 2
+}
+
+gem install bundler && bundle install

data/{script → bin}/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'proxy_rb'

data/bin/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rake test

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: -t @wip:3 -t ~@broken-external -t ~@future -t ~@broken
+all: -t ~@wip -t ~@broken-external -t ~@future -t ~@broken

data/fixtures/proxy-config/.rspec

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

data/fixtures/proxy-config/README.md

@@ -0,0 +1,18 @@
+# Simple proxy configuration project
+
+This is a simple proxy configuration project
+
+## Boostrap
+
+Execute:
+
+    $ bundle
+
+## Usage
+
+Place files in `spec/` and run `rspec`.
+
+### Fixture
+
+This fixture includes files for `rspec`-integration.
+

data/fixtures/proxy-config/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+namespace :gem do
+  require 'bundler/gem_tasks'
+end
+
+task default: :test
+
+task :test do
+  sh 'rspec'
+end

data/fixtures/proxy-config/bin/http_server

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'webrick'
+
+server = WEBrick::HTTPServer.new(
+  Port: 8000
+)
+
+server.mount_proc '/' do |_req, res|
+  res.body = 'Example Domain'
+end
+
+server.start

data/fixtures/proxy-config/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+if RUBY_VERSION < '1.9.3'
+  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
+else
+  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+end

data/fixtures/proxy-config/spec/support/aruba.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'aruba/rspec'

data/fixtures/proxy-config/spec/support/proxy_rb.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'proxy_rb/rspec'

data/lib/proxy_rb/basic_configuration/in_config_wrapper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # Basic Configuration
+  class BasicConfiguration
+    # In config wrapper
+    #
+    # Used to make the configuration read only if one needs to access an
+    # configuration option from with `ProxyRb::Config`.
+    #
+    # @private
+    class InConfigWrapper
+      attr_reader :config
+      private :config
+
+      def initialize(config)
+        @config = config.dup
+      end
+
+      def method_missing(name, *args)
+        raise ArgumentError, 'Options take no argument' if args.count > 0
+        raise UnknownOptionError, %(Option "#{name}" is unknown. Please use only earlier defined options) unless config.key? name
+
+        config[name]
+      end
+    end
+  end
+end

data/lib/proxy_rb/basic_configuration/option.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # Basic Configuration
+  class BasicConfiguration
+    # A configuration option
+    #
+    # @private
+    class Option
+      attr_accessor :name, :value
+      attr_reader :default_value
+
+      # Create option
+      def initialize(opts = {})
+        name = opts[:name]
+        value = opts[:value]
+
+        raise ArgumentError, '"name" is required' unless opts.key? :name
+        raise ArgumentError, '"value" is required' unless opts.key? :value
+
+        @name          = name
+        @value         = value
+        @default_value = value
+      end
+
+      # Compare option
+      def ==(other)
+        name == other.name && value == other.value
+      end
+    end
+  end
+end

data/lib/proxy_rb/basic_configuration.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+require 'contracts'
+require 'proxy_rb/basic_configuration/option'
+require 'proxy_rb/basic_configuration/in_config_wrapper'
+
+# ProxyRb
+module ProxyRb
+  # Basic configuration
+  class BasicConfiguration
+    include Contracts
+
+    class << self
+      def known_options
+        @known_options ||= {}
+      end
+
+      # Define an option reader
+      #
+      # @param [Symbol] name
+      #   The name of the reader
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Class, Module] contract
+      #   The contract for the option
+      #
+      # @option [Object] default
+      #   The default value
+      def option_reader(name, opts = {})
+        contract = opts[:contract]
+        default  = opts[:default]
+
+        raise ArgumentError, 'Either use block or default value' if block_given? && default
+        raise ArgumentError, 'contract-options is required' if contract.nil?
+
+        Contract contract
+        add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
+
+        define_method(name) { find_option(name).value }
+
+        self
+      end
+
+      # Define an option reader and writer
+      #
+      # @param [Symbol] name
+      #   The name of the reader
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Class, Module] contract
+      #   The contract for the option
+      #
+      # @option [Object] default
+      #   The default value
+      def option_accessor(name, opts = {})
+        contract = opts[:contract]
+        default  = opts[:default]
+
+        raise ArgumentError, 'Either use block or default value' if block_given? && default
+        # fail ArgumentError, 'Either use block or default value' if !block_given? && default.nil? && default.to_s.empty?
+        raise ArgumentError, 'contract-options is required' if contract.nil?
+
+        # Add writer
+        add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
+
+        Contract contract
+        define_method("#{name}=") { |v| find_option(name).value = v }
+
+        # Add reader
+        option_reader name, contract: { None => contract.values.first }
+      end
+
+      private
+
+      def add_option(name, value = nil)
+        return if known_options.key?(name)
+
+        known_options[name] = Option.new(name: name, value: value)
+
+        self
+      end
+    end
+
+    protected
+
+    attr_accessor :local_options
+
+    public
+
+    # Create configuration
+    def initialize
+      initialize_configuration
+    end
+
+    # @yield [Configuration]
+    #
+    #   Yields self
+    def configure
+      yield self if block_given?
+    end
+
+    # Reset configuration
+    def reset
+      initialize_configuration
+    end
+
+    # Make deep dup copy of configuration
+    def make_copy
+      obj = dup
+      obj.local_options = Marshal.load(Marshal.dump(local_options))
+
+      obj
+    end
+
+    # Check if <name> is option
+    #
+    # @param [String, Symbol] name
+    #   The name of the option
+    def option?(name)
+      local_options.any? { |_, v| v.name == name.to_sym }
+    end
+
+    def ==(other)
+      local_options.values.map(&:value) == other.local_options.values.map(&:value)
+    end
+
+    # Set if name is option
+    def set_if_option(name, *args)
+      send("#{name}=".to_sym, *args) if option? name
+      public_send("#{name}=".to_sym, *args) if option? name
+    end
+
+    private
+
+    def initialize_configuration
+      @local_options = Marshal.load(Marshal.dump(self.class.known_options))
+    end
+
+    def find_option(name)
+      raise NotImplementedError, %(Unknown option "#{name}") unless option? name
+
+      local_options[name]
+    end
+  end
+end

data/lib/proxy_rb/configuration.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'contracts'
+
+require 'proxy_rb/version'
+require 'proxy_rb/basic_configuration'
+require 'proxy_rb/basic_configuration/in_config_wrapper'
+
+require 'proxy_rb/password_fetchers/basic_password_fetcher'
+require 'proxy_rb/password_fetchers/environment_password_fetcher'
+
+# ProxyRb
+module ProxyRb
+  # ProxyRb Configuration
+  #
+  # This defines the configuration options of proxy_rb
+  class Configuration < BasicConfiguration
+    option_accessor :password_fetcher, contract: { PasswordFetchers::BasicPasswordFetcher => PasswordFetchers::BasicPasswordFetcher }, default: ProxyRb::PasswordFetchers::EnvironmentPasswordFetcher.new(prefix: 'SECRET')
+  end
+end
+
+# ProxyRb
+module ProxyRb
+  @config = Configuration.new
+
+  class << self
+    attr_reader :config
+
+    # Configure proxy_rb
+    #
+    # @example How to configure proxy_rb
+    #
+    #   ProxyRb.configure do |config|
+    #     config.<option> = <value>
+    #   end
+    #
+    def configure(&block)
+      @config.configure(&block)
+
+      self
+    end
+  end
+end

data/lib/proxy_rb/credentials.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'shellwords'
+
+# ProxyRb
+module ProxyRb
+  # Hold proxy credentials
+  class Credentials
+    protected
+
+    attr_reader :password
+
+    public
+
+    attr_reader :user_name
+
+    # @param [String] user_name
+    #   The user name to use for authentication against proxy
+    #
+    # @param [String] password
+    #   The password to use for authentication against proxy
+    def initialize(user_name, password)
+      @user_name = user_name
+      @password  = password
+    end
+
+    # Convert to string
+    #
+    # @return [String]
+    #   A formatted string <user>:<password>
+    def to_s
+      Shellwords.escape(format('%s:%s', user_name, password))
+    end
+
+    # Is credentials empty
+    #
+    # @return [TrueClass, FalseClass]
+    #   Empty if any user_name or password is empty
+    def empty?
+      !(user_name? && password?)
+    end
+
+    private
+
+    def user_name?
+      !(user_name.nil? || user_name.empty?)
+    end
+
+    def password?
+      !(password.nil? || password.empty?)
+    end
+  end
+end

data/lib/proxy_rb/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module ProxyRb
+  # Raised if time out occured while fetch resource
+  class UrlTimeoutError < StandardError; end
+end

data/lib/proxy_rb/http_downloader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'excon'
+
+# ProxyRb
+module ProxyRb
+  # Download Content via proxy
+  class HttpDownloader
+    private
+
+    attr_reader :downloader, :proxy
+
+    public
+
+    def initialize(proxy)
+      @downloader = Excon
+      @proxy      = proxy
+    end
+
+    def process(resource)
+      resource.content = downloader.get(resource.to_uri, proxy: proxy.to_uri)
+    end
+  end
+end