proxy_rb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bc945043463fe4b3e69c8bdf8e125ef58aa8dce
-  data.tar.gz: 35765821a441b1d9bbc016bd2c6672cf4c122ee6
+  metadata.gz: 0902f8cb548f1fa6b4180ed66ebf2dcd26edb71a
+  data.tar.gz: 3e29d77475f07c367318ca19daa7dc5160ba1bb0
 SHA512:
-  metadata.gz: a9af5d4ece8df28ee2551e2dde1a2f3501081bdf5efcfc394201955528046adcbcfea9a4f39baa17bc0d4a032980b3e61aa44dee3191bccbb75717b8b06477e5
-  data.tar.gz: 17309f5b430978403dcd7bd3fedeb86a25d2d4bfff0a873c6c0a42abe357b2c1d295861c8d48a235e2d047111e2a26014cf56032486dc76931d019ff4a7e176c
+  metadata.gz: 14b997bcbfbeb3abffda5dc16e0b04b8313431c4f34b896d3b4cd5f54bddec02c1a05f007ba5ec69d9454c52930d3a309c2ae01a8e157bda5004b77f83e7efa1
+  data.tar.gz: 06b90ebb03851f17c42ba372f92bb82c033622b341870338897a8c1c2ce599f40dfee891db95cf473887eb5f3ed96e28ce0ad7c12fd04ae6ea6265535010753f

data/.travis.yml

@@ -4,16 +4,21 @@ env:
 language: ruby
 bundler_args: --without development debug profile
 rvm:
-  - 2.1.8
-  - 2.2.4
   - 2.3.0
   - ruby-head
 script: bin/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
+  - unzip /tmp/vault.zip -d /tmp/
   - install -D -m 0755 /tmp/vault ./bin/vault
+before_script:
+  - 'export DISPLAY=:99.0'
+  - 'sh -e /etc/init.d/xvfb start'
+  - sleep 3 # give xvfb some time to start
 addons:
   apt:
     packages:
-      -  libwebkit-dev
+      - libqtwebkit-dev
+matrix:
+  allow_failures:
+  - rvm: ruby-head

data/Gemfile

@@ -23,7 +23,7 @@ group :development, :test do
   # Set env during development/test
   gem 'dotenv'
 
-  gem 'aruba', require: false
+  gem 'aruba', '~> 0.14.1', require: false
   gem 'awesome_print', require: 'ap'
   gem 'bundler', '~> 1.3', require: false
   gem 'command_exec', require: false
@@ -38,7 +38,7 @@ group :development, :test do
   gem 'launchy', require: false
   gem 'license_finder'
   gem 'rack'
-  gem 'rake', require: false
+  gem 'rake', '~> 10.0', require: false
   gem 'rubocop', require: false
   gem 'simplecov', require: false
   gem 'sinatra', require: 'sinatra/base'

data/History.md

@@ -0,0 +1,17 @@
+#  UNRELEASED
+
+## [v0.5.0](https://github.com/cucumber/aruba/compare/v0.4.0...v0.5.0)
+
+* Added initializer to bootstrap `proxy_prb`
+* Improved documentation
+* Improved test suite
+* Made test suite succeed on travis.org
+* Added announcer known from `aruba`. Now one output information about
+  configured user, proxy and resource
+* Addd new matchers to output better error messages
+
+# RELEASED
+
+## [v0.4.0](https://github.com/cucumber/aruba/compare/v0.1.0...v0.4.0)
+
+* Added support for `poltergeist`, `selenium` and `webkit`

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016- Max Meyer
+
+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

@@ -76,6 +76,10 @@ RSpec.describe 'My Proxy' do
 end
 ~~~
 
+Please have a look at the
+["features/getting_started"](features/getting_started)-directory for more
+information about that topic.
+
 ### Getting on with "proxy_rb"
 
 Please have a look at our "feature"-files found [here](features/).
@@ -85,14 +89,14 @@ Please have a look at our "feature"-files found [here](features/).
 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.
+["features/proxy/authentication"](features/proxy/authentication) and
+["features/api/password"](features/api/password) for detailed information.
 
 ### Driver
 
-You can choose between two drivers to sent your requests: "Poltergeist" and
+You can choose between three drivers to sent your requests: "Selenium", "Poltergeist" and
 "Webkit". Please have a look at
-["features/drivers.feature"](features/drivers.feature) for detailed
+["features/drivers"](features/drivers) for detailed
 information.
 
 ## Development
@@ -128,3 +132,10 @@ release a new version, update the version number in `version.rb`, and then run
 `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).
+
+## Caveats
+
+* Authentication against a proxy using BASIC-scheme works fine for `Poltergeist` and `Webkit`-drivers. It fails for `Selenium` as you cannot pass username and password to the browser
+* Authentication agains a proxy using NEGOTIATE (Kerberos) and NTLM-scheme fails for `Poltergeist` and `Webkit`-drivers due to problems with Qt which is used by both projects
+
+

data/Rakefile

@@ -20,8 +20,9 @@ desc 'Test with coveralls'
 task coveralls: %w(test coveralls:push)
 
 namespace :test do
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
+  task :rubocop do
+    sh 'rubocop'
+  end
 
   desc 'Run rspec'
   task :rspec do
@@ -33,3 +34,8 @@ namespace :test do
     sh 'bundle exec cucumber -p all'
   end
 end
+
+desc 'Remove files in tmp'
+task :clobber do
+  rm_rf Dir.glob(File.expand_path('../tmp/*', __FILE__))
+end

data/exe/proxy_rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'proxy_rb/cli'
+
+ProxyRb::Cli.start

data/fixtures/empty/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/empty/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/lib/proxy_rb/announcer.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+require 'shellwords'
+require 'proxy_rb/colorizer'
+
+ProxyRb::AnsiColor.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
+
+# ProxyRb
+module ProxyRb
+  # Announcer
+  #
+  # @private
+  #
+  # @example Activate your you own channel in cucumber
+  #
+  #   Before('@announce-my-channel') do
+  #     aruba.announcer.activate :my_channel
+  #   end
+  #
+  # @example Activate your you own channel in rspec > 3
+  #
+  #   before do
+  #     current_example = context.example
+  #     aruba.announcer.activate :my_channel if current_example.metadata[:announce_my_channel]
+  #   end
+  #
+  #   ProxyRb.announcer.announce(:my_channel, 'my message')
+  #
+  class Announcer
+    # Announcer using Kernel.puts
+    class KernelPutsAnnouncer
+      def announce(message)
+        Kernel.puts message
+      end
+
+      def mode?(m)
+        :kernel_puts == m
+      end
+    end
+
+    # Announcer using Main#puts
+    class PutsAnnouncer
+      def announce(message)
+        puts message
+      end
+
+      def mode?(m)
+        :puts == m
+      end
+    end
+
+    private
+
+    attr_reader :announcers, :announcer, :channels, :output_formats, :colorizer
+
+    public
+
+    def initialize(*args)
+      @announcers = []
+      @announcers << PutsAnnouncer.new
+      @announcers << KernelPutsAnnouncer.new
+
+      @colorizer = ProxyRb::Colorizer.new
+
+      @announcer         = @announcers.first
+      @channels          = {}
+      @output_formats    = {}
+
+      @options           = args[1] || {}
+
+      after_init
+    end
+
+    private
+
+    def after_init
+      output_format :proxy, proc { |v| format('Proxy: %s', v) }
+      output_format :proxy_user, proc { |v| format('Proxy User: %s', v) }
+      output_format :resource_user, proc { |v| format('Resource User: %s', v) }
+      output_format :resource, proc { |v| format('Resource: %s', v) }
+    end
+
+    def output_format(channel, string = '%s', &block)
+      output_formats[channel.to_sym] = if block_given?
+                                         block
+                                       elsif string.is_a?(Proc)
+                                         string
+                                       else
+                                         proc { |*args| format(string, *args) }
+                                       end
+    end
+
+    public
+
+    # Reset announcer
+    def reset
+      @announcer = @announcers.first
+    end
+
+    # Change mode of announcer
+    #
+    # @param [Symbol] m
+    #   The mode to set
+    def mode=(m)
+      @announcer = @announcers.find { |_a| f.mode? m.to_sym }
+
+      self
+    end
+
+    # Check if channel is activated
+    #
+    # @param [Symbol] channel
+    #   The name of the channel to check
+    def activated?(channel)
+      channels[channel.to_sym] == true
+    end
+
+    # Activate a channel
+    #
+    # @param [Symbol] channel
+    #   The name of the channel to activate
+    def activate(*chns)
+      chns.flatten.each { |c| channels[c.to_sym] = true }
+
+      self
+    end
+
+    # Announce information to channel
+    #
+    # @param [Symbol] channel
+    #   The name of the channel to check
+    #
+    # @param [Array] args
+    #   Arguments
+    #
+    # @yield
+    #   If block is given, that one is called and the return value is used as
+    #   message to be announced.
+    def announce(channel, *args, &_block)
+      channel = channel.to_sym
+
+      the_output_format = if output_formats.key? channel
+                            output_formats[channel]
+                          else
+                            proc { |v| format('%s', v) }
+                          end
+
+      return unless activated?(channel)
+
+      message = if block_given?
+                  the_output_format.call(yield)
+                else
+                  the_output_format.call(*args)
+                end
+      message += "\n"
+      message = colorizer.cyan(message)
+
+      announcer.announce(message)
+
+      nil
+    end
+  end
+end

data/lib/proxy_rb/api/core.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'proxy_rb/runtime'
+require 'proxy_rb/setup'
+
+# Main Module
+module ProxyRb
+  # Api
+  module Api
+    # Core Module
+    module Core
+      # Aruba Runtime
+      def proxy_rb
+        @_proxy_rb_runtime ||= Runtime.new
+      end
+
+      # Setup everything to make proxy_rb work
+      #
+      def setup_proxy_rb
+        ProxyRb::Setup.new(proxy_rb).call
+
+        nil
+      end
+    end
+  end
+end

data/lib/proxy_rb/api/http_proxy.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'proxy_rb'
+require 'proxy_rb/resource'
+require 'proxy_rb/http_downloader'
+require 'proxy_rb/http_proxy'
+require 'proxy_rb/request'
+require 'proxy_rb/response'
+require 'proxy_rb/errors'
+
+# Main Module
+module ProxyRb
+  # Api
+  module Api
+    # Non includable internal helper methods
+    #
+    # Not for use by normal users
+    module NonIncludes
+      class << self
+        def clear_environment
+          %w(
+            http_proxy
+            https_proxy
+            HTTP_PROXY
+            HTTPS_PROXY
+          ).each { |v| ENV.delete v }
+        end
+
+        def configure_driver
+          ProxyRb.config.driver.configure_driver
+        end
+
+        def register_capybara_driver_for_proxy(proxy)
+          ProxyRb.config.driver.register proxy
+        end
+      end
+    end
+
+    # For http proxy
+    module HttpProxy
+      include ::Capybara::DSL
+
+      # The proxy based on subject
+      def proxy
+        ProxyRb::HttpProxy.new(ProxyUrlParser.new(subject))
+      end
+
+      # Visit an URL
+      #
+      # @param [String] url
+      # rubocop:disable Metrics/AbcSize
+      def visit(url)
+        resource = Resource.new(url)
+
+        proxy_rb.event_bus.notify Events::ResourceSet.new(resource.url.to_s)
+        proxy_rb.event_bus.notify Events::ResourceUserSet.new(resource.credentials.to_s) unless resource.credentials.empty?
+
+        NonIncludes.clear_environment
+        NonIncludes.configure_driver
+
+        proxy_rb.event_bus.notify Events::ProxySet.new(proxy.url.to_s)
+        proxy_rb.event_bus.notify Events::ProxyUserSet.new(proxy.credentials.to_s) unless proxy.credentials.empty?
+
+        NonIncludes.register_capybara_driver_for_proxy(proxy)
+
+        begin
+          super(resource.to_s)
+        rescue *ProxyRb.config.driver.timeout_errors
+          raise ProxyRb::UrlTimeoutError, "Failed to fetch #{resource}: Timeout occured."
+        rescue *ProxyRb.config.driver.failure_errors => e
+          raise ProxyRb::ResourceNotDownloadableError, "Failed to fetch #{resource}: #{e.message}."
+        rescue => e
+          raise ProxyRb::ResourceNotDownloadableError, "An unexpected error occured while fetching #{resource}: #{e.message}."
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # !@method download
+      #
+      # @see #visit
+      alias download visit
+
+      # Get access to the request made
+      def request
+        Request.new(page)
+      end
+
+      # Get access to the response get
+      def response
+        Response.new(page)
+      end
+    end
+  end
+end

data/lib/proxy_rb/api/passwords.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'contracts'
+
+# ProxyRb
+module ProxyRb
+  # Api
+  module Api
+    # Helpers to access passwords
+    module Passwords
+      include Contracts::Core
+      include Contracts::Builtin
+
+      Contract Or[String, Symbol] => Maybe[String]
+      # Get password for user
+      #
+      # @param [String] user_name
+      #   The user name
+      #
+      # @return [String]
+      #   The password
+      def password(user_name)
+        ProxyRb.config.password_fetcher.call(user_name.to_s)
+      end
+    end
+  end
+end

data/lib/proxy_rb/api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rspec/matchers'
+require 'capybara/rspec'
+
+require 'proxy_rb/no_proxy'
+require 'proxy_rb/main'
+ProxyRb.require_files_matching_pattern('api/*.rb')
+ProxyRb.require_files_matching_pattern('matchers/*.rb')
+
+# ProxyRb
+module ProxyRb
+  # Api
+  module Api
+    include ProxyRb::Api::Core
+    include ProxyRb::Api::HttpProxy
+    include ProxyRb::Api::Passwords
+    include Capybara::RSpecMatchers
+  end
+end

data/lib/proxy_rb/basic_configuration/{in_config_wrapper.rb → in_configuration_wrapper.rb}

@@ -9,7 +9,7 @@ module ProxyRb
     # configuration option from with `ProxyRb::Config`.
     #
     # @private
-    class InConfigWrapper
+    class InConfigurationWrapper
       attr_reader :config
       private :config
 

data/lib/proxy_rb/basic_configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'contracts'
 require 'proxy_rb/basic_configuration/option'
-require 'proxy_rb/basic_configuration/in_config_wrapper'
+require 'proxy_rb/basic_configuration/in_configuration_wrapper'
 
 # ProxyRb
 module ProxyRb
@@ -35,7 +35,7 @@ module ProxyRb
         raise ArgumentError, 'contract-options is required' if contract.nil?
 
         Contract contract
-        add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
+        add_option(name, block_given? ? yield(InConfigurationWrapper.new(known_options)) : default)
 
         define_method(name) { find_option(name).value }
 

data/lib/proxy_rb/cli.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'thor'
+require 'proxy_rb/console'
+require 'proxy_rb/initializer'
+
+# ProxyRb
+module ProxyRb
+  # Command line Interface
+  #
+  # @private
+  class Cli < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'console', "Start proxy_rb's console"
+    def console
+      ProxyRb::Console.new.start
+    end
+
+    desc 'init', 'Initialize proxy_rb'
+    option :test_framework, default: 'rspec', enum: %w(rspec), desc: 'Choose which test framework to use'
+    def init
+      ProxyRb::Initializer.new.call(options[:test_framework])
+    end
+  end
+end