mediawiki_selenium 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67af225480dde4d5ac5bacbe01d631d2334859ec
-  data.tar.gz: 28454c89b3d8f8550953e18fe9b7762a0333d669
+  metadata.gz: 7aa88726278140c10f75311afdd0a7539db96fda
+  data.tar.gz: 78c6c6c468dadd5a49ae3d6dff971b4ffa46dc1e
 SHA512:
-  metadata.gz: bbcef005071dba80b554fc05c2a61a9fb20a1fb00cafd576fb9cacfb6debe2aae41caf3d571983a1b367c7f693d640998507d3d786051e34e0854f2e032498db
-  data.tar.gz: a98d7297808c1d75ec7ee16c46d7763e14609e9ce6d43f1298ba641452dd536e5612322b925a2dc7fc6388313334a71302fc86a89da7197534175f957d8fb27d
+  metadata.gz: 2790c6bafb50c5924b545ee72d1149732a046d45a7833bcc38f6381721b1a683dd099ec95fd9dd9e4f47fabe1b29cd83fcd0560871e0b6387e333a1d0bc56e63
+  data.tar.gz: 62f2281382c96ddc1489bb31cc0d4977b06b3a3bcecde883847fccb90ec713a43394f355a30710376118c4bdd91f6cc78f460eecc1a935df6914ddd237dda4ef

data/.rubocop.yml

@@ -19,5 +19,8 @@ Style/FileName:
 Style/SignalException:
   Enabled: false
 
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
 Style/TrivialAccessors:
   ExactNameMatch: true

data/README.md

@@ -199,6 +199,10 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 1.1.0 2015-04-06
+* Support for `browser_http_proxy` in Firefox, Chrome, and Phantomjs
+* Renamed browser factory `bind` method to `configure`
+
 ### 1.0.2 2015-03-26
 * Fixed double yield bug in `PageFactory#on`
 * Implemented loading of a `default` configuration from `environments.yml`

data/lib/mediawiki_selenium/browser_factory/base.rb

@@ -15,7 +15,7 @@ module MediawikiSelenium
         # @example Always configure Firefox's language according to `:browser_language`
         #   module MediawikiSelenium::BrowserFactory
         #     class Firefox < Base
-        #       bind(:browser_language) do |lang, options|
+        #       configure(:browser_language) do |lang, options|
         #         options[:desired_capabilities][:firefox_profile]["intl.accept_languages"] = lang
         #       end
         #     end
@@ -26,7 +26,7 @@ module MediawikiSelenium
         # @yield [values, browser_options] A block that binds the configuration to
         #                                  the browser options.
         #
-        def bind(*names, &blk)
+        def configure(*names, &blk)
           raise ArgumentError, 'no block given' unless block_given?
 
           key = names.length == 1 ? names.first : names
@@ -34,6 +34,9 @@ module MediawikiSelenium
           default_bindings[key] << blk
         end
 
+        # @deprecated Use {.configure} instead.
+        alias bind configure
+
         # All bindings for this factory class combined with those of super
         # classes.
         #
@@ -58,7 +61,7 @@ module MediawikiSelenium
 
       attr_reader :browser_name
 
-      bind(:browser_timeout) { |value, options| options[:http_client].timeout = value.to_i }
+      configure(:browser_timeout) { |value, options| options[:http_client].timeout = value.to_i }
 
       # Initializes new factory instances.
       #
@@ -83,17 +86,17 @@ module MediawikiSelenium
       #
       # @example Override the user agent according :browser_user_agent
       #   factory = BrowserFactory.new(:firefox)
-      #   factory.bind(:browser_user_agent) do |agent, options|
+      #   factory.configure(:browser_user_agent) do |agent, options|
       #     options[:desired_capabilities][:firefox_profile]["general.useragent.override"] = agent
       #   end
       #
       # @example Annotate the session with our build information
-      #   factory.bind(:job_name, :build_number) do |job, build, options|
+      #   factory.configure(:job_name, :build_number) do |job, build, options|
       #     options[:desired_capabilities][:name] = "#{job} (#{build})"
       #   end
       #
       # @example Bindings aren't invoked unless all given options are configured
-      #   factory.bind(:foo, :bar) do |foo, bar, options|
+      #   factory.configure(:foo, :bar) do |foo, bar, options|
       #     # this never happens!
       #     options[:desired_capabilities][:name] = "#{foo} #{bar}"
       #   end
@@ -104,12 +107,15 @@ module MediawikiSelenium
       # @yield [values, browser_options] A block that binds the configuration to
       #                                  the browser options.
       #
-      def bind(*names, &blk)
+      def configure(*names, &blk)
         key = names.length == 1 ? names.first : names
         @bindings[key] ||= []
         @bindings[key] << (blk || proc {})
       end
 
+      # @deprecated Use {#configure} instead.
+      alias bind configure
+
       # Effective bindings for this factory, those defined at the class level
       # and those defined for this instance.
       #

data/lib/mediawiki_selenium/browser_factory/chrome.rb

@@ -3,17 +3,22 @@ module MediawikiSelenium
     # Constructs new Chrome browser instances. The following configuration is
     # supported.
     #
+    #  - browser_http_proxy
     #  - browser_language
     #  - browser_user_agent
     #
     # @see Base
     #
     class Chrome < Base
-      bind(:browser_language) do |language, options|
+      configure(:browser_http_proxy) do |http_proxy, options|
+        options[:args] << "--proxy-server=#{http_proxy}"
+      end
+
+      configure(:browser_language) do |language, options|
         options[:prefs]['intl.accept_languages'] = language
       end
 
-      bind(:browser_user_agent) do |user_agent, options|
+      configure(:browser_user_agent) do |user_agent, options|
         options[:args] << "--user-agent=#{user_agent}"
       end
 

data/lib/mediawiki_selenium/browser_factory/firefox.rb

@@ -3,6 +3,7 @@ module MediawikiSelenium
     # Constructs new Firefox browser instances. The following configuration is
     # supported.
     #
+    #  - browser_http_proxy
     #  - browser_language
     #  - browser_timeout
     #  - browser_user_agent
@@ -10,17 +11,21 @@ module MediawikiSelenium
     # @see Base
     #
     class Firefox < Base
-      bind(:browser_timeout) do |timeout, options|
+      configure(:browser_http_proxy) do |http_proxy, options|
+        options[:profile].proxy = Selenium::WebDriver::Proxy.new(http: http_proxy, ssl: http_proxy)
+      end
+
+      configure(:browser_timeout) do |timeout, options|
         timeout = timeout.to_i
         options[:profile]['dom.max_script_run_time'] = timeout
         options[:profile]['dom.max_chrome_script_run_time'] = timeout
       end
 
-      bind(:browser_language) do |language, options|
+      configure(:browser_language) do |language, options|
         options[:profile]['intl.accept_languages'] = language
       end
 
-      bind(:browser_user_agent) do |user_agent, options|
+      configure(:browser_user_agent) do |user_agent, options|
         options[:profile]['general.useragent.override'] = user_agent
       end
 

data/lib/mediawiki_selenium/browser_factory/phantomjs.rb

@@ -3,19 +3,32 @@ module MediawikiSelenium
     # Constructs new Phantomjs browser instances. The following configuration is
     # supported.
     #
+    #  - browser_http_proxy
     #  - browser_language
     #  - browser_user_agent
     #
     # @see Base
     #
     class Phantomjs < Base
-      bind(:browser_language) do |language, options|
+      configure(:browser_http_proxy) do |http_proxy, options|
+        options[:desired_capabilities]['phantomjs.cli.args'] << "--proxy=#{http_proxy}"
+      end
+
+      configure(:browser_language) do |language, options|
         options[:desired_capabilities]['phantomjs.page.customHeaders.Accept-Language'] = language
       end
 
-      bind(:browser_user_agent) do |user_agent, options|
+      configure(:browser_user_agent) do |user_agent, options|
         options[:desired_capabilities]['phantomjs.page.settings.userAgent'] = user_agent
       end
+
+      protected
+
+      def default_browser_options
+        super.tap do |options|
+          options[:desired_capabilities]['phantomjs.cli.args'] = []
+        end
+      end
     end
   end
 end

data/lib/mediawiki_selenium/environment.rb

@@ -167,7 +167,7 @@ module MediawikiSelenium
       browser = browser.to_s.downcase.to_sym
 
       @_factory_cache[[remote?, browser]] ||= BrowserFactory.new(browser).tap do |factory|
-        factory.bind(:_browser_session)
+        factory.configure(:_browser_session)
         factory.extend(RemoteBrowserFactory) if remote?
       end
     end

data/lib/mediawiki_selenium/remote_browser_factory.rb

@@ -17,23 +17,23 @@ module MediawikiSelenium
     URL = 'http://ondemand.saucelabs.com/wd/hub'
 
     class << self
-      def extend_object(factory)
-        return if factory.is_a?(self)
+      def extend_object(base)
+        return if base.is_a?(self)
 
         super
 
-        factory.bind(:sauce_ondemand_username, :sauce_ondemand_access_key) do |user, key, options|
+        base.configure(:sauce_ondemand_username, :sauce_ondemand_access_key) do |user, key, options|
           options[:url] = URI.parse(URL)
 
           options[:url].user = user
           options[:url].password = key
         end
 
-        factory.bind(:platform) do |platform, options|
+        base.configure(:platform) do |platform, options|
           options[:desired_capabilities].platform = platform
         end
 
-        factory.bind(:version) do |version, options|
+        base.configure(:version) do |version, options|
           options[:desired_capabilities].version = version
         end
       end

data/lib/mediawiki_selenium/support/hooks.rb

@@ -55,15 +55,15 @@ Before do |scenario|
   @random_string = Random.new.rand.to_s
 
   # Annotate sessions with the scenario name and Jenkins build info
-  browser_factory.bind do |options|
+  browser_factory.configure do |options|
     options[:desired_capabilities][:name] = test_name(scenario)
   end
 
-  browser_factory.bind(:job_name) do |job, options|
+  browser_factory.configure(:job_name) do |job, options|
     options[:desired_capabilities][:name] += " #{job}"
   end
 
-  browser_factory.bind(:build_number) do |build, options|
+  browser_factory.configure(:build_number) do |build, options|
     options[:desired_capabilities][:name] += "##{build}"
   end
 end

data/lib/mediawiki_selenium/version.rb

@@ -1,3 +1,3 @@
 module MediawikiSelenium
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/mediawiki_selenium.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6', '>= 1.6.3'
   spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.4'
   spec.add_development_dependency 'redcarpet', '~> 3.2', '>= 3.2.0'
-  spec.add_development_dependency 'rubocop', '~> 0.26', '>= 0.26.1'
+  spec.add_development_dependency 'rubocop', '~> 0.29.1'
   spec.add_development_dependency 'rspec-core', '~> 2.14', '>= 2.14.4'
   spec.add_development_dependency 'rspec-mocks', '~> 2.14', '>= 2.14.4'
 end

data/spec/browser_factory/base_spec.rb

@@ -6,8 +6,24 @@ module MediawikiSelenium::BrowserFactory
     let(:factory) { factory_class.new(browser_name) }
     let(:browser_name) { :lynx }
 
-    describe '.bind' do
-      subject { factory_class.bind(option_name, &block) }
+    describe '.bindings' do
+      subject { factory_class.bindings }
+
+      before do
+        factory_class.configure(:foo) {}
+      end
+
+      it "includes the base class's default bindings" do
+        expect(subject).to include(Base.default_bindings)
+      end
+
+      it 'includes its own bindings' do
+        expect(subject).to include(factory_class.default_bindings)
+      end
+    end
+
+    describe '.configure' do
+      subject { factory_class.configure(option_name, &block) }
 
       let(:option_name) { :foo }
       let(:block) { proc { } }
@@ -19,7 +35,7 @@ module MediawikiSelenium::BrowserFactory
       end
 
       context 'given no block' do
-        subject { factory_class.bind(option_name) }
+        subject { factory_class.configure(option_name) }
 
         it 'raises an ArgumentError' do
           expect { subject }.to raise_error(ArgumentError)
@@ -27,22 +43,6 @@ module MediawikiSelenium::BrowserFactory
       end
     end
 
-    describe '.bindings' do
-      subject { factory_class.bindings }
-
-      before do
-        factory_class.bind(:foo) {}
-      end
-
-      it "includes the base class's default bindings" do
-        expect(subject).to include(Base.default_bindings)
-      end
-
-      it 'includes its own bindings' do
-        expect(subject).to include(factory_class.default_bindings)
-      end
-    end
-
     describe '.default_bindings' do
       subject { factory_class.default_bindings }
 
@@ -54,9 +54,9 @@ module MediawikiSelenium::BrowserFactory
 
       context 'when bindings are defined' do
         before do
-          factory_class.bind(:foo) {}
-          factory_class.bind(:bar) {}
-          factory_class.bind(:bar) {}
+          factory_class.configure(:foo) {}
+          factory_class.configure(:bar) {}
+          factory_class.configure(:bar) {}
         end
 
         it 'includes all defined bindings' do
@@ -69,33 +69,12 @@ module MediawikiSelenium::BrowserFactory
       end
     end
 
-    describe '#bind' do
-      subject { factory.bind(option_name, &block) }
-      before { subject }
-
-      let(:option_name) { :foo }
-      let(:block) { proc { } }
-
-      it 'adds a new binding for the given option' do
-        expect(factory.bindings).to include(option_name)
-        expect(factory.bindings[option_name]).to include(block)
-      end
-
-      context 'given no block' do
-        subject { factory.bind(option_name) }
-
-        it 'will default to an empty block' do
-          expect(factory.bindings[option_name]).not_to include(nil)
-        end
-      end
-    end
-
     describe '#bindings' do
       subject { factory.bindings }
 
       before do
-        factory_class.bind(:foo) {}
-        factory.bind(:bar)
+        factory_class.configure(:foo) {}
+        factory.configure(:bar)
       end
 
       it 'includes the class-level bindings' do
@@ -176,7 +155,7 @@ module MediawikiSelenium::BrowserFactory
           let(:config) { { foo: 'x' } }
 
           it 'invokes the binding with the configured value' do
-            expect { |block| factory.bind(:foo, &block) && subject }.
+            expect { |block| factory.configure(:foo, &block) && subject }.
               to yield_with_args('x', options)
           end
         end
@@ -185,7 +164,7 @@ module MediawikiSelenium::BrowserFactory
           let(:config) { {} }
 
           it 'never invokes the binding' do
-            expect { |block| factory.bind(:foo, &block) && subject }.
+            expect { |block| factory.configure(:foo, &block) && subject }.
               to_not yield_control
           end
         end
@@ -196,7 +175,7 @@ module MediawikiSelenium::BrowserFactory
           let(:config) { { foo: 'x', bar: 'y' } }
 
           it 'invokes the binding with the configured values' do
-            expect { |block| factory.bind(:foo, :bar, &block) && subject }.
+            expect { |block| factory.configure(:foo, :bar, &block) && subject }.
               to yield_with_args('x', 'y', options)
           end
         end
@@ -205,11 +184,32 @@ module MediawikiSelenium::BrowserFactory
           let(:config) { { foo: 'x' } }
 
           it 'never invokes the binding' do
-            expect { |block| factory.bind(:foo, :bar, &block) && subject }.
+            expect { |block| factory.configure(:foo, :bar, &block) && subject }.
               to_not yield_control
           end
         end
       end
     end
+
+    describe '#configure' do
+      subject { factory.configure(option_name, &block) }
+      before { subject }
+
+      let(:option_name) { :foo }
+      let(:block) { proc { } }
+
+      it 'adds a new binding for the given option' do
+        expect(factory.bindings).to include(option_name)
+        expect(factory.bindings[option_name]).to include(block)
+      end
+
+      context 'given no block' do
+        subject { factory.configure(option_name) }
+
+        it 'will default to an empty block' do
+          expect(factory.bindings[option_name]).not_to include(nil)
+        end
+      end
+    end
   end
 end

data/spec/browser_factory/chrome_spec.rb

@@ -16,6 +16,14 @@ module MediawikiSelenium::BrowserFactory
     describe '#browser_options' do
       subject { factory.browser_options(config) }
 
+      context 'given a browser proxy' do
+        let(:config) { { browser_http_proxy: 'proxy.example:8080' } }
+
+        it 'includes it as --proxy-server in the chrome arguments' do
+          expect(subject[:args]).to include('--proxy-server=proxy.example:8080')
+        end
+      end
+
       context 'given a custom browser_language' do
         let(:config) { { browser_language: 'eo' } }
 

data/spec/browser_factory/firefox_spec.rb

@@ -22,6 +22,21 @@ module MediawikiSelenium::BrowserFactory
         expect(Selenium::WebDriver::Firefox::Profile).to receive(:new).and_return(profile)
       end
 
+      context 'given a browser proxy' do
+        let(:config) { { browser_http_proxy: 'proxy.example:8080' } }
+
+        it 'sets up the profile to use a proxy for both http and https' do
+          selenium_proxy = double('Selenium::WebDriver::Proxy')
+
+          expect(Selenium::WebDriver::Proxy).to receive(:new).
+            with(http: 'proxy.example:8080', ssl: 'proxy.example:8080').
+            and_return(selenium_proxy)
+          expect(profile).to receive(:proxy=).with(selenium_proxy)
+
+          subject
+        end
+      end
+
       context 'given a custom browser_timeout' do
         let(:config) { { browser_timeout: '30' } }
 

data/spec/browser_factory/phantomjs_spec.rb

@@ -16,6 +16,15 @@ module MediawikiSelenium::BrowserFactory
     describe '#browser_options' do
       subject { factory.browser_options(config) }
 
+      context 'given a browser proxy' do
+        let(:config) { { browser_http_proxy: 'proxy.example:8080' } }
+
+        it 'includes it as --proxy in the cli arguments' do
+          capabilities = subject[:desired_capabilities]
+          expect(capabilities['phantomjs.cli.args']).to include('--proxy=proxy.example:8080')
+        end
+      end
+
       context 'given a custom browser_language' do
         let(:config) { { browser_language: 'eo' } }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -255,20 +255,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.26.1
+        version: 0.29.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.26.1
+        version: 0.29.1
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement