proxy_rb 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa700a6b39f4d950941f67dfc35147b1ed88420
-  data.tar.gz: 1a2de5927281397d6d141fbea2ed21b1ec515859
+  metadata.gz: f8f2ff7a132c447ec0c846e16e286c898a1221c5
+  data.tar.gz: f5f80b116193df7695e0b5f0e52c614f889b04bc
 SHA512:
-  metadata.gz: 90d3e09c2e2c30bf7b64f8fad31dbea529f5043e9d6965c178b17eec16a8d991fd733e21d672bdaea84448d477f438662c2b2646e2c4cb10e5c49e37493ac5d0
-  data.tar.gz: b63c5ca58039720f82086226a64ab566461153cace8b5b1e6a7b7743266fcc8f62f93cc514d59a364e38a2b8544485fd9dfea14199384db07f6ebc04c8542e58
+  metadata.gz: f837422215bb89b1e17be474ad595afaaa79173b8b3eca6b06b50f62c35229e0d2e841c14187926269660a74a7d3b251faf4729586b7d6a2c8c22957e6297e1c
+  data.tar.gz: ed4e7b774c23faa1738f3ed37df85caa9b3311ff5b9b745a019021bdee1176cbc2c11c2def73c0c07e7aac769810e3467026ff888bb6a99daf8eabf1a6f02bd5

data/.travis.yml

@@ -12,3 +12,7 @@ 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
+addons:
+  apt:
+    packages:
+      -  libwebkit-dev

data/CONTRIBUTING.md

@@ -17,7 +17,7 @@ Here are some ways *you* can contribute:
 * by closing [issues][]
 * by reviewing patches
 
-[issues]: https://github.com/fedux-org/proxy_pac_rb/issues
+[issues]: https://github.com/fedux-org/proxy_rb/issues
 
 ## Submitting an Issue
 
@@ -25,7 +25,7 @@ We use the [GitHub issue tracker][issues] to track bugs and features. Before
 submitting a bug report or feature request, check to make sure it hasn't
 already been submitted. 
 
-When submitting a bug report, please include a [Gist][] that includes a *stack
+When submitting a bug report, please include a [Gist][gist] that includes a *stack
 trace* and any details that may be necessary to reproduce the bug, including
 your *gem version*, *Ruby version*, and *operating system*. Ideally, a bug report
 should include a pull request with failing specs.

data/Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in local_pac.gemspec
 gemspec
 
+gem 'poltergeist'
+
 group :debug do
   gem 'pry'
   gem 'byebug'

data/README.md

@@ -20,82 +20,59 @@ Or install it yourself as:
 
 ## Usage
 
-### Rspec-Integration
+### Getting started
 
-```ruby
-require 'proxy_rb/rspec'
-
-RSpec.describe 'Infrastructure A' do
-  describe 'proxy1' do
-    subject { 'proxy1.example.com' }
-
-    context 'request resource via http' do
-      let(:resource) { Resource.new('http://example.com') }
-
-      context 'when url is readable' do
-        it { expect(proxy).to forward_url(resource) }
-      end
-
-      context 'when website needs to be browsed' do
-        before(:each) { download(resource) }
-        it { expect(resource).to have_content('Example') }
-      end
+The following steps are only a suggestion. If you normally use a different
+workflow, this is ok. Just make sure, that the `proxy_rb/rspec`-file is
+required by `spec/spec_helper.rb` directly or indirectly.
 
-      context 'when proxy authentication is needed' do
-        let(:user) { ProxyUser.new(name: 'user1') }
-        before(:each) { download(resource) }
+*Initialize RSpec*
 
-        it { expect(resource).to have_content('Example') }
-      end
-
-      context 'when upload uses post http method' do
-        let(:data) { 'data' }
-        before(:each) { upload(resource, data) }
+~~~bash
+bundle exec rspec --init
+~~~
 
-        it { expect(resource).to have_content('Example') }
-      end
+*Modify "spec/spec_helper.rb"*
 
-      context 'when upload uses put http method' do
-        let(:data) { 'data' }
-        before(:each) { upload(resource, data, method: 'put') }
+Add the following lines.
 
-        it { expect(resource).to have_content('Example') }
-      end
-    end
+~~~ruby
+# Loading support files
+Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+~~~
 
-    context 'request resource via https' do
-      let(:resource) { Resource.new('https://example.com') }
-    end
+*Load library*
 
-    context 'request resource via ftp' do
-      let(:resource) { Resource.new('ftp://example.com/file.txt') }
+Create a file named `spec/support/proxy_rb.rb`.
 
-      context 'when website needs to be browsed' do
-        before(:each) { download(resource) }
-        it { expect(resource).to have_content('Example') }
-      end
+~~~ruby
+require 'proxy_rb/rspec'
+~~~
 
-      context 'when url is readable' do
-        it { expect(proxy).to forward_url(resource) }
-      end
+*Create first Tests* 
 
-      context 'when authentication is needed' do
-        let(:user) { ProxyUser.new(name: 'user1') }
-        before(:each) { download(resource) }
+Create a file named `spec/test_spec.rb`.
 
-        it { expect(resource).to have_content('Example') }
-      end
+~~~ruby
+require 'spec_helper'
 
-      context 'when upload' do
-        let(:data) { File.open('file.txt') }
-        before(:each) { upload(resource, data) }
+RSpec.describe 'My Proxy' do
+  describe 'Production' do
+    subject { 'http://localhost:8080' }
 
-        it { expect(resource).to have_content('Example') }
-      end
+    before :each do
+      visit 'http://example.com'
     end
+
+    it { expect(request).to be_successful }
   end
 end
-```
+~~~
+
+### Getting on with "proxy_rb"
+
+Please have a look at our "feature"-files found [here](features/).
 
 ### Authentication
 
@@ -105,6 +82,12 @@ Please have a look at
 ["features/authentication.feature"](features/authentication.feature) for
 detailed information.
 
+### Driver
+
+You can choose between two drivers to sent your requests: "Poltergeist" and
+"Webkit". Please have a look at
+["features/drivers.feature"](features/drivers.feature) for detailed
+information.
 
 ## Development
 
@@ -130,8 +113,8 @@ 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
+After checking out the repo, run `bin/bootstrap` to install dependencies.
+Then, run `bin/console` for an interactive prompt that will allow you to
 experiment.
 
 To install this gem onto your local machine, run `bundle exec rake gem:install`. To
@@ -139,11 +122,3 @@ 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).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/proxy_rb/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/Rakefile

@@ -1,7 +1,7 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
 
-namespace :gems do
+namespace :gem do
   require 'bundler/gem_tasks'
 end
 

data/lib/proxy_rb/configuration.rb

@@ -8,6 +8,8 @@ require 'proxy_rb/basic_configuration/in_config_wrapper'
 require 'proxy_rb/password_fetchers/basic_password_fetcher'
 require 'proxy_rb/password_fetchers/environment_password_fetcher'
 
+require 'proxy_rb/drivers/webkit_driver'
+
 # ProxyRb
 module ProxyRb
   # ProxyRb Configuration
@@ -15,6 +17,7 @@ module ProxyRb
   # 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')
+    option_accessor :driver, contract: { Drivers::BasicDriver => Drivers::BasicDriver }, default: ProxyRb::Drivers::WebkitDriver.new
   end
 end
 

data/lib/proxy_rb/credentials.rb

@@ -5,13 +5,7 @@ require 'shellwords'
 module ProxyRb
   # Hold proxy credentials
   class Credentials
-    protected
-
-    attr_reader :password
-
-    public
-
-    attr_reader :user_name
+    attr_reader :user_name, :password
 
     # @param [String] user_name
     #   The user name to use for authentication against proxy

data/lib/proxy_rb/drivers/basic_driver.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# ProxyRb
+module ProxyRb
+  # Drivers
+  module Drivers
+    # Basic Driver
+    class BasicDriver
+      # Configure driver
+      def configure_driver
+        ::Capybara.run_server = false
+      end
+
+      # Register proxy
+      def register(_proxy)
+        raise NoMethodError, 'You need to implement this in your driver'
+      end
+    end
+  end
+end

data/lib/proxy_rb/drivers/poltergeist_driver.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'proxy_rb/drivers/basic_driver'
+require 'capybara'
+
+begin
+  require 'capybara/poltergeist'
+rescue LoadError
+  ProxyRb.logger.error %(Error loading `poltergeist`-gem. Please add `gem poltergeist` to your `Gemfile`)
+  exit 1
+end
+
+# ProxyRb
+module ProxyRb
+  # Drivers
+  module Drivers
+    # Driver for Poltergeist
+    class PoltergeistDriver < BasicDriver
+      # Register proxy
+      #
+      # @param [HttpProxy] proxy
+      #   The HTTP proxy which should be used for fetching content
+      def register(proxy)
+        if proxy.empty?
+          ::Capybara.current_driver = :poltergeist
+          return
+        end
+
+        cli_parameters = []
+        cli_parameters << "--proxy=#{proxy.url}" unless proxy.url.empty?
+        cli_parameters << "--proxy-auth=#{proxy.credentials}" unless proxy.credentials.empty?
+
+        options = {
+          phantomjs_options: cli_parameters,
+          js_errors: false,
+          phantomjs_logger: $stderr
+        }
+
+        unless ::Capybara.drivers.key? proxy.to_ref
+          ::Capybara.register_driver proxy.to_ref do |app|
+            ::Capybara::Poltergeist::Driver.new(app, options)
+          end
+        end
+
+        ::Capybara.current_driver = proxy.to_ref
+      end
+
+      def rescuable_errors
+        [::Capybara::Poltergeist::TimeoutError]
+      end
+    end
+  end
+end

data/lib/proxy_rb/drivers/webkit_driver.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'proxy_rb/drivers/basic_driver'
+
+begin
+  require 'capybara/webkit'
+rescue LoadError
+  ProxyRb.logger.error %(Error loading `capybara-webkit`-gem. Please add `gem capybara-webkit` to your `Gemfile`)
+  exit 1
+end
+
+# rubocop:disable Style/SymbolProc
+::Capybara::Webkit.configure do |config|
+  config.allow_unknown_urls
+end
+# rubocop:enable Style/SymbolProc
+
+# ProxyRb
+module ProxyRb
+  # Drivers
+  module Drivers
+    # Driver for Capybara-Webkit
+    class WebkitDriver < BasicDriver
+      # Register proxy
+      #
+      # @param [HttpProxy] proxy
+      #   The HTTP proxy which should be used for fetching content
+      def register(proxy)
+        if proxy.empty?
+          ::Capybara.current_driver = :webkit
+          return
+        end
+
+        options = {
+          proxy: {
+            host: proxy.host,
+            port: proxy.port,
+            user: proxy.user,
+            pass: proxy.password
+          }
+        }
+
+        unless ::Capybara.drivers.key? proxy.to_ref
+          ::Capybara.register_driver proxy.to_ref do |app|
+            ::Capybara::Webkit::Driver.new(app, Capybara::Webkit::Configuration.to_hash.merge(options))
+          end
+        end
+
+        ::Capybara.current_driver = proxy.to_ref
+      end
+
+      def rescuable_errors
+        [::Capybara::Webkit::TimeoutError]
+      end
+    end
+  end
+end

data/lib/proxy_rb/http_proxy.rb

@@ -8,45 +8,39 @@ require 'proxy_rb/proxy_url_parser'
 module ProxyRb
   # Represent proxy
   class HttpProxy
-    protected
-
     attr_reader :url, :credentials
 
-    public
-
     def initialize(parser)
       @url         = parser.proxy_url
       @credentials = parser.credentials
     end
 
-    # Convert to parameters for PhantomJS
-    #
-    # @return [Array]
-    #   An array of parameters for PhantomJS
-    def to_phantom_js
-      result = []
-      result << "--proxy=#{url}" unless url.empty?
-      result << "--proxy-auth=#{credentials}" unless credentials.empty?
-
-      result
+    def host
+      url.host
     end
 
-    # Convert to symbol to reference the proxy
-    #
-    # @return [Symbol]
-    #   <host>_<port>_<credentials>
-    def to_sym
-      Shellwords.escape(*[host, port, credentials.user_name].compact.join('_')).to_sym
+    def port
+      url.port
     end
 
-    private
+    def user
+      credentials.user_name
+    end
 
-    def host
-      url.host
+    def password
+      credentials.password
     end
 
-    def port
-      url.port
+    def empty?
+      host.nil? || host.empty?
+    end
+
+    # Convert to symbol to reference the proxy
+    #
+    # @return [Symbol]
+    #   <host>_<port>_<credentials>
+    def to_ref
+      Shellwords.escape(*[host, port, user].compact.join('_')).to_sym
     end
   end
 end

data/lib/proxy_rb/no_proxy.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 # No proxy
 class NoProxy
   def self.to_s
-    ""
+    ''
   end
 
   def self.nil?
@@ -21,6 +22,6 @@ class NoProxy
   end
 
   def to_s
-    ""
+    ''
   end
 end

data/lib/proxy_rb/proxy_url.rb

@@ -24,7 +24,16 @@ module ProxyRb
     # @return [ProxyUrl]
     #   The parsed url
     def self.parse(string)
-      new(Addressable::URI.heuristic_parse(string.to_s))
+      string = string.to_s
+      string = if string.empty?
+                 string
+               elsif string.start_with?('http://')
+                 string
+               else
+                 'http://' + string
+               end
+
+      new(Addressable::URI.heuristic_parse(string))
     end
 
     protected
@@ -46,7 +55,7 @@ module ProxyRb
     end
 
     def to_s
-      return "" if empty?
+      return '' if empty?
 
       url.to_s
     end

data/lib/proxy_rb/request.rb

@@ -21,9 +21,13 @@ module ProxyRb
       page.status_code.to_s.start_with?('2', '3')
     end
 
-    # def forbidden?
-    #   page.status_code == 403
-    # end
+    # The request is forbidden
+    #
+    # @return [TrueClass, FalseClass]
+    #   The result
+    def forbidden?
+      page.status_code == 403
+    end
 
     # def invalid?
     #   page.status_code == 401

data/lib/proxy_rb/rspec/helpers/http_proxy.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'capybara/poltergeist'
 
 require 'proxy_rb'
 require 'proxy_rb/resource'
@@ -28,19 +27,12 @@ module ProxyRb
             ).each { |v| ENV.delete v }
           end
 
-          def register_capybara_driver_for_proxy(proxy)
-            options = {
-              phantomjs_options: proxy.to_phantom_js,
-              js_errors: false,
-              phantomjs_logger: $stderr
-            }
-
-            ::Capybara.register_driver proxy.to_sym do |app|
-              ::Capybara::Poltergeist::Driver.new(app, options)
-            end
+          def configure_driver
+            ProxyRb.config.driver.configure_driver
+          end
 
-            ::Capybara.run_server = false
-            ::Capybara.current_driver = proxy.to_sym
+          def register_capybara_driver_for_proxy(proxy)
+            ProxyRb.config.driver.register proxy
           end
         end
       end
@@ -61,11 +53,12 @@ module ProxyRb
           resource = Resource.new(url)
 
           NonIncludes.clear_environment
+          NonIncludes.configure_driver
           NonIncludes.register_capybara_driver_for_proxy(proxy)
 
           begin
             super(resource.to_url)
-          rescue ::Capybara::Poltergeist::TimeoutError
+          rescue *ProxyRb.config.driver.rescuable_errors
             raise ProxyRb::UrlTimeoutError, "Failed to fetch #{resource.to_url}: Timeout occured."
           end
         end

data/lib/proxy_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Main Module
 module ProxyRb
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'
 end

data/proxy_rb.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
 
   spec.add_runtime_dependency 'capybara'
-  spec.add_runtime_dependency 'poltergeist'
+  spec.add_runtime_dependency 'capybara-webkit'
 
   spec.add_runtime_dependency 'addressable'
   spec.add_runtime_dependency 'contracts'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxy_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: poltergeist
+  name: capybara-webkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -147,7 +147,6 @@ files:
 - fixtures/proxy-config/.rspec
 - fixtures/proxy-config/README.md
 - fixtures/proxy-config/Rakefile
-- fixtures/proxy-config/bin/http_server
 - fixtures/proxy-config/spec/spec_helper.rb
 - fixtures/proxy-config/spec/support/aruba.rb
 - fixtures/proxy-config/spec/support/proxy_rb.rb
@@ -157,6 +156,9 @@ files:
 - lib/proxy_rb/basic_configuration/option.rb
 - lib/proxy_rb/configuration.rb
 - lib/proxy_rb/credentials.rb
+- lib/proxy_rb/drivers/basic_driver.rb
+- lib/proxy_rb/drivers/poltergeist_driver.rb
+- lib/proxy_rb/drivers/webkit_driver.rb
 - lib/proxy_rb/errors.rb
 - lib/proxy_rb/http_downloader.rb
 - lib/proxy_rb/http_proxy.rb

data/fixtures/proxy-config/bin/http_server

@@ -1,14 +0,0 @@
-#!/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