proxy_pac_rb 0.6.9 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e91fc474b42767f3467a68ee3d5c5ce8856f06f6
-  data.tar.gz: 77927902a99dcc26026e0381f2692815690235b6
+  metadata.gz: e6882f46bded8f3ff2ad971b2b6eb2c4cfe6458e
+  data.tar.gz: 99a114959d3e42f3e242263e6a7627bbc8e0baf9
 SHA512:
-  metadata.gz: 267f300d1b5aaa5abfc8c3717c359341f70904266880eed6ff84526f0909a0a70eacb706bdf2c143aa94f926ad7dc9f17cd3a7812f01a590d0f4f405c14811b6
-  data.tar.gz: 5067d0c9c78254aa7576f8c46e7ea953239ff91d713878de2b45c658a7757fc6bd9b0b10e3b1eb29a8856add226d67461209486c140faf91e8f1cbb4c4cf36f1
+  metadata.gz: 70409e443bbbec0e96e33eea57b8d72406314fef6515d8e65f3f87920f64771cca71c3083367ef3c94e1b0674691c2bfe7f7c7f94ce2adf6cdb1f99d6170a6ef
+  data.tar.gz: c894044358c10a244165a0d8e5eb3f628758171198669cbbe940a4458278ef2fc16be95b0600f6e5436c19c54b55a3f69b2ccae2e1462671c6c405aea146cd4c

data/README.md

@@ -59,6 +59,9 @@ pprb find proxy -c 127.0.0.1 -t "2014-03-09 12:00:00" -p sample.pac -u https://g
 # Or download via pprb directly and parse pac #2
 pprb find proxy -c 127.0.0.1 -t "2014-03-09 12:00:00" -p https://github.com/fedux-org/proxy_pac_rb/raw/master/files/sample.pac -u https://github.com
 
+# Or download this example if you are behind a coporate proxy via pprb directly and parse pac #3
+pprb find proxy -c 127.0.0.1 -t "2014-03-09 12:00:00" -p https://github.com/fedux-org/proxy_pac_rb/raw/master/files/sample.pac -u https://github.com --use-proxy
+
 # =>                url: result
 # => https://github.com: DIRECT
 ```
@@ -340,6 +343,23 @@ require 'proxy_pac_rb/rspec'
     "proxy.pac"-files. By default its value is `Dir.getwd` which is set by
     `rspec`.
 
+### Configuration
+
+You can either configure `ProxyPacRb` either via a global `ProxyPacRb.configure`-block:
+
+```ruby
+ProxyPacRb.configure do |config|
+  config.use_proxy = true
+end
+```
+
+or via `RSpec`-metadata:
+
+```ruby
+RSpec.describe 'proxy.pac', type: :proxy_pac, use_proxy: true do
+end
+```
+
 ### Examples
 
 To make it easier for you to start, you find some examples below.

data/features/step_definitions.rb

@@ -1,5 +1,5 @@
 Given(/^a proxy\.pac named "([^"]*)" does not exist$/) do |name|
-  FileUtils.rm_rf absolute_path("#{name}.pac")
+  FileUtils.rm_rf expand_path("#{name}.pac")
 end
 
 Then(/^the proxy\.pac "([^"]*)" should contain:$/) do |name, string|

data/lib/proxy_pac_rb.rb

@@ -2,8 +2,10 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/strip'
 require 'active_support/core_ext/string/filters'
 require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/object/deep_dup'
 require 'addressable/uri'
 require 'ipaddr'
+require 'set'
 require 'thor'
 require 'uglifier'
 require 'optparse'
@@ -13,6 +15,7 @@ require 'excon'
 require 'time'
 require 'timeout'
 require 'pathname'
+require 'contracts'
 
 require 'proxy_pac_rb/version'
 require 'proxy_pac_rb/main'
@@ -35,6 +38,9 @@ require 'proxy_pac_rb/proxy_pac_loader'
 require 'proxy_pac_rb/proxy_pac_linter'
 require 'proxy_pac_rb/proxy_pac_parser'
 
+require 'proxy_pac_rb/basic_configuration'
+require 'proxy_pac_rb/code_configuration'
+
 require 'proxy_pac_rb/cli_validator'
 
 require 'proxy_pac_rb/cli/shared'

data/lib/proxy_pac_rb/basic_configuration.rb

@@ -0,0 +1,85 @@
+module ProxyPacRb
+  # Basic configuration for ProxyPacRb
+  class BasicConfiguration
+    include Contracts
+
+    # A configuration option
+    class Option
+      attr_accessor :name, :value
+
+      def initialize(name:, value:)
+        @name  = name
+        @value = value
+      end
+    end
+
+    class << self
+      def known_options
+        @known_options ||= {}
+      end
+
+      def option_writer(name, contract:, default:)
+        add_option(name, default)
+
+        Contract contract
+        define_method("#{name}=") { |v| find_option(name).value = v }
+
+        self
+      end
+
+      def option_reader(name, value: nil)
+        add_option(name, value)
+
+        define_method(name) { find_option(name).value }
+
+        self
+      end
+
+      def option(name, contract:, default:)
+        option_writer name, contract: contract, default: default
+        option_reader name
+      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
+
+    attr_reader :local_options
+    private :local_options
+
+    def initialize
+      @local_options = self.class.known_options.deep_dup
+    end
+
+    # @yield [Configuration]
+    #
+    #   Yields self
+    def configure
+      yield self if block_given?
+    end
+
+    def option?(name)
+      local_options.any? { |_, v| v.name == name }
+    end
+
+    # Set if name is option
+    def set_if_option(name, *args)
+      public_send("#{name}=".to_sym, *args) if option? name
+    end
+
+    private
+
+    def find_option(name)
+      fail NotImplementedError, %(Unknown option "#{name}") unless option? name
+
+      local_options[name]
+    end
+  end
+end

data/lib/proxy_pac_rb/code_configuration.rb

@@ -0,0 +1,6 @@
+module ProxyPacRb
+  # Configure ProxyPacRb
+  class CodeConfiguration < BasicConfiguration
+    option :use_proxy, contract: { Bool => Bool }, default: false
+  end
+end

data/lib/proxy_pac_rb/rspec.rb

@@ -8,11 +8,43 @@ ProxyPacRb.require_file_matching_pattern('rspec/shared_contexts/*.rb')
 
 # Main Module
 module ProxyPacRb
-  # Main Module
-  module Rspec
+  @configuration = CodeConfiguration.new
+
+  class << self
+    def configure(&block)
+      @configuration.configure(&block)
+
+      @configuration
+    end
   end
 end
 
+ProxyPacRb.configure do |config|
+  config.use_proxy = false
+end
+
 RSpec.configure do |config|
   config.include ProxyPacRb::Rspec::Helpers, type: :proxy_pac
+
+  config.before :each do |example|
+    next unless self.class.include?(ProxyPacRb::Rspec::Helpers)
+
+    @proxy_pac_rb_config = ProxyPacRb.configure.dup \
+      unless defined?(@proxy_pac_rb_config) && @proxy_pac_rb_config.is_a?(ProxyPacRb::CodeConfiguration)
+
+    example.metadata.select { |k, _v| k != :proxy_pac_rb_config }.each do |k, v|
+      @proxy_pac_rb_config.set_if_option(k, v)
+    end
+
+    if @proxy_pac_rb_config.use_proxy == false
+      %w(
+        http_proxy
+        https_proxy
+        HTTP_PROXY
+        HTTPS_PROXY
+      ).each do |v|
+        ENV.delete(v)
+      end
+    end
+  end
 end

data/lib/proxy_pac_rb/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # ProxyPacRb
 module ProxyPacRb
-  VERSION = '0.6.9'
+  VERSION = '0.7.0'
 end

data/proxy_pac_rb.gemspec

@@ -26,6 +26,7 @@ DESC
   spec.add_runtime_dependency 'activesupport', '~>4.1'
   spec.add_runtime_dependency 'uglifier', '~> 2.7.1'
   spec.add_runtime_dependency 'excon', '~> 0.45.3'
+  spec.add_runtime_dependency 'contracts', '~> 0.9'
 
   spec.required_ruby_version = '~> 2.0'
 end

data/spec/api/proxy_pac_dumper_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe ProxyPacDumper do
   end
 
   let(:dumper) { ProxyPacDumper.new }
-  let(:destination) { absolute_path('proxy.pac') }
+  let(:destination) { expand_path('proxy.pac') }
 
   describe '#dump' do
     before :each do

data/spec/api/proxy_pac_loader_spec.rb

@@ -53,7 +53,7 @@ RSpec.describe ProxyPacLoader do
     context 'when proxy pac is file' do
       let(:file) { 'proxy.pac' }
       let(:type) { :file }
-      let(:source) { absolute_path(file) }
+      let(:source) { expand_path(file) }
 
       before(:each) { allow(proxy_pac).to receive(:source).and_return(source) }
 

data/spec/basic_configuration_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacRb::BasicConfiguration do
+  it_behaves_like 'a basic configuration'
+end

data/spec/code_configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacRb::CodeConfiguration do
+  it_behaves_like 'a basic configuration'
+
+  describe '#use_proxy' do
+    subject(:config) { described_class.new }
+
+    context 'when default is used' do
+      it { expect(config.use_proxy).to be false }
+    end
+
+    context 'when modified' do
+      context 'when valid value' do
+        before(:each) { config.use_proxy = true }
+        it { expect(config.use_proxy).to be true }
+      end
+
+      context 'when invalid value' do
+        it { expect {  config.use_proxy = '' }.to raise_error ArgumentError }
+      end
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe ProxyPacRb::Parser do
   end
 
   context 'when path is given' do
-    let(:source) { absolute_path('proxy.pac') }
+    let(:source) { expand_path('proxy.pac') }
     before(:each) { write_file(source, content) }
 
     it { expect(proxy_pac).not_to be_nil }

data/spec/rspec/rspec_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
-describe ProxyPacRb do
-  it 'has a version number' do
-    expect(ProxyPacRb::VERSION).not_to be nil
+RSpec.describe ProxyPacRb, type: :proxy_pac do
+  context 'when use_proxy is true', use_proxy: true do
+    it { expect(@proxy_pac_rb_config.use_proxy).to be true }
+  end
+
+  context 'when use_proxy is false', use_proxy: false do
+    it { expect(@proxy_pac_rb_config.use_proxy).to be false }
   end
 end

data/spec/rspec_integration_spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative 'spec_helper'
+require 'proxy_pac_rb/rspec'

data/spec/support/matchers/option.rb

@@ -0,0 +1,31 @@
+RSpec::Matchers.define :be_valid_option do |_|
+  match do |actual|
+    subject.option?(actual)
+  end
+
+  failure_message do |actual|
+    format("expected that \"%s\" is a valid option", actual)
+  end
+
+  failure_message_when_negated do |actual|
+    format("expected that \"%s\" is not a valid option", actual)
+  end
+end
+
+RSpec::Matchers.define :have_option_value do |expected|
+  match do |actual|
+    @old_actual = actual
+    @actual     = subject.public_send(actual.to_sym)
+    values_match? expected, @actual
+  end
+
+  diffable
+
+  failure_message do |_actual|
+    format(%(expected that option "%s" has value "%s"), @old_actual, expected)
+  end
+
+  failure_message_when_negated do |_actual|
+    format(%(expected that option "%s" does not have value "%s"), @old_actual, expected)
+  end
+end

data/spec/support/shared_examples/configuration.rb

@@ -0,0 +1,38 @@
+RSpec.shared_examples 'a basic configuration' do
+  subject(:config) do
+    Class.new(described_class) do
+      option :use_test, contract: { Contracts::Bool => Contracts::Bool }, default: false
+    end.new
+  end
+
+  it { expect(config).not_to be_nil }
+
+  describe 'option?' do
+    let(:name) { :use_test }
+
+    context 'when valid option' do
+      it { expect(name).to be_valid_option }
+    end
+
+    context 'when invalid_option' do
+      let(:name) { :blub }
+      it { expect(name).not_to be_valid_option }
+    end
+  end
+
+  describe 'set_if_option' do
+    let(:name) { :use_test }
+    let(:value) { true }
+
+    context 'when valid option' do
+      before(:each) { config.set_if_option(name, value) }
+      it { expect(name).to have_option_value true }
+    end
+
+    context 'when invalid_option' do
+      let(:name) { :blub }
+
+      it { expect { config.set_if_option(name, value) }.not_to raise_error }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxy_pac_rb
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.7.0
 platform: ruby
 authors:
 - Dennis Günnewig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.45.3
+- !ruby/object:Gem::Dependency
+  name: contracts
+  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'
 description: |
   "proxy_pac_rb" is a gem to compress, lint and parse proxy auto-config files. It comes with a cli program, some rack middlewares and can be used from within ruby scripts as well. "proxy_pac_rb" uses a JavaScript runtime to evaulate a proxy auto-config file the same way a browser does to determine what proxy (if any at all) should a program use to connect to a server. You must install on of the supported JavaScript runtimes: therubyracer or therubyrhino
 email:
@@ -104,6 +118,7 @@ files:
 - files/sample2.pac
 - files/sample3.pac
 - lib/proxy_pac_rb.rb
+- lib/proxy_pac_rb/basic_configuration.rb
 - lib/proxy_pac_rb/cli/compress.rb
 - lib/proxy_pac_rb/cli/compress_proxy_pac.rb
 - lib/proxy_pac_rb/cli/find.rb
@@ -116,6 +131,7 @@ files:
 - lib/proxy_pac_rb/cli/shared.rb
 - lib/proxy_pac_rb/cli/show.rb
 - lib/proxy_pac_rb/cli_validator.rb
+- lib/proxy_pac_rb/code_configuration.rb
 - lib/proxy_pac_rb/encoding.rb
 - lib/proxy_pac_rb/environment.rb
 - lib/proxy_pac_rb/errors.rb
@@ -160,6 +176,8 @@ files:
 - spec/api/proxy_pac_linter_spec.rb
 - spec/api/proxy_pac_loader_spec.rb
 - spec/api/proxy_pac_parser_spec.rb
+- spec/basic_configuration_spec.rb
+- spec/code_configuration_spec.rb
 - spec/environment_spec.rb
 - spec/parser_spec.rb
 - spec/rack/proxy_pac_compressor_spec.rb
@@ -169,12 +187,15 @@ files:
 - spec/rspec/readability_spec.rb
 - spec/rspec/rspec_spec.rb
 - spec/rspec/validitiy_spec.rb
+- spec/rspec_integration_spec_helper.rb
 - spec/spec_helper.rb
 - spec/support/aruba.rb
 - spec/support/matchers/file.rb
+- spec/support/matchers/option.rb
 - spec/support/rack_test.rb
 - spec/support/reporting.rb
 - spec/support/rspec.rb
+- spec/support/shared_examples/configuration.rb
 - spec/support/shared_examples/loader.rb
 - spec/support/strip.rb
 - spec/support/webmock.rb
@@ -238,6 +259,8 @@ test_files:
 - spec/api/proxy_pac_linter_spec.rb
 - spec/api/proxy_pac_loader_spec.rb
 - spec/api/proxy_pac_parser_spec.rb
+- spec/basic_configuration_spec.rb
+- spec/code_configuration_spec.rb
 - spec/environment_spec.rb
 - spec/parser_spec.rb
 - spec/rack/proxy_pac_compressor_spec.rb
@@ -247,12 +270,15 @@ test_files:
 - spec/rspec/readability_spec.rb
 - spec/rspec/rspec_spec.rb
 - spec/rspec/validitiy_spec.rb
+- spec/rspec_integration_spec_helper.rb
 - spec/spec_helper.rb
 - spec/support/aruba.rb
 - spec/support/matchers/file.rb
+- spec/support/matchers/option.rb
 - spec/support/rack_test.rb
 - spec/support/reporting.rb
 - spec/support/rspec.rb
+- spec/support/shared_examples/configuration.rb
 - spec/support/shared_examples/loader.rb
 - spec/support/strip.rb
 - spec/support/webmock.rb