selenium_tor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e1fe6540f9a3fdb5709dd88c4594a453052aec00f00423e39f69664ec8d27e1
-  data.tar.gz: a0a8a23354f5c0bad149baf6d0b043e72f64845b142921492c72d6565e8120da
+  metadata.gz: 484a1e6197b2ab0ad98ed6ccff6591db30094e87a3b51fb517c15f2531b9c76f
+  data.tar.gz: 180f09296eaf38cfe25b435f9126c9ae84e7fa123421bf9ec649d4d82d128e41
 SHA512:
-  metadata.gz: c74beaf4a2c71a66fb4cbee34f9896c483308b684b99ebcb12e653c983d7be6e4486d6ea8c177096d01243d2eb5f275044d308ef9f602bf56c760be2ffcb6022
-  data.tar.gz: 633ca399c16169d4f9d0a48b12fb4781a1c68fa4e49e121454db26d14bea1bef0770ef1d82e1cb700ffe1124d353ed7070e8830290a9e4796b3458d74a62492c
+  metadata.gz: d88198513d5606df47bc7a5917c2384320f9a855877498994d72a0e6c2a71118c226340df00cd8c8892bd1bad63010ab59cb71856e757c98a306dd1414bf164f
+  data.tar.gz: '01954638cb9ffc19275acd528cd19326d77604f2570cecd1ce2eb1afd41a130812246d57c9db8cb05ffa960c94e96d1213545d70565528f24260b92548e26677'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## [0.1.2] - 2023-11-20
+
+* Breaking change: change constant names in Tor namespace - see README
+
+### New features
+
+* Added Tor::Profile and lock file patch for Selenium < 4.16 see [Selenium #11576](https://github.com/SeleniumHQ/selenium/issues/11576)
+* Add tests for NoScript extension
+
 ## [0.1.1] - 2023-11-19
 
 * Rename gem from selenium-tor, yanked previous versions

data/README.md

@@ -34,37 +34,43 @@ puts driver.title
 ```
 The driver will not be instantiated until a connection to the Tor network is made. If the network is inaccessible for any reason a `TorNetworkError` will result.
 
-The `Selenium::WebDriver::Tor` namespace is used by `Driver` and `Options`. Otherwise Selenium's `Selenium::WebDriver::Firefox` namespace is used.
+The `Selenium::WebDriver::Tor` namespace is used for `Driver`, `Options` and `Profile`. Otherwise Selenium's `Selenium::WebDriver::Firefox` namespace is used.
 
 Remote functionality is not tested, but will be if Selenium provide a Tor Browser Docker container for Selenium Grid.
 
-A number of constants are set during driver initialization based upon values found in the Tor Browser Bundle (TBB) root directory (see below). These include:
+A number of constants are set during driver initialization based upon values found in the Tor Browser Bundle (TBB) root directory - see below. These include:
 ```ruby
 Tor::TBB_DIR # path to the TBB root directory
 Tor::TBB_BROWSER_DIR # path to the 'Browser' directory in the above
-Tor::TOR_BROWSER_BINARY_PATH # path to the binary
-Tor::TOR_BROWSER_VERSION # the version installed, e.g. "13.0.1", note: driver.capabilities.browser_version returns the Firefox version Tor Browser is based on 
+Tor::TBB_BINARY_PATH # path to the binary
+Tor::TBB_PROFILE_DIR # path to the default profile directory
+Tor::TBB_EXTENSIONS_DIR # path to the 'extensions' directory in the above
+Tor::TBB_VERSION # 
+the version installed, e.g. "13.0.1", note: driver.capabilities.browser_version returns the Firefox version Tor Browser is based on 
 ```
 
 ## Dependencies and configuration
 
-As with Firefox browser, Geckodriver needs to be installed and in your PATH.
+As with Firefox browser, `geckodriver` needs to be installed and in your PATH.
 
-The gem needs to know the location of the Tor Browser Bundle (TBB). This can be installed from the Tor Project [downloads page](https://www.torproject.org/download/). The download package archive must be extracted and the root TBB directory (called `tor-browser`) placed somewhere on your system. By default it is assumed to be in the current user's HOME directory. An alternative location can be set via the env var `TOR_BROWSER_ROOT_DIR` - e.g. `export TOR_BROWSER_ROOT_DIR=/home/<user>/Downloads`. The Tor Browser binary location is *automatically set* by reference to this directory, so there is no need to do this:
+The gem needs to know the location of the Tor Browser Bundle (TBB). This can be installed from the Tor Project [downloads page](https://www.torproject.org/download/). The download package archive must be extracted and the root TBB directory (named "tor-browser") placed somewhere on your system. By default it is assumed to be in the current user's HOME directory. An alternative location can be set via the env var `TOR_BROWSER_ROOT_DIR` - e.g. `export TOR_BROWSER_ROOT_DIR=/home/<user>/Downloads`. The Tor Browser binary location is *automatically set* by reference to this directory, so there is no need to do this:
 ```ruby
 options.binary = '/some/path/to/tor_firefox_binary' # UNNECESSARY
 ```
+
+The location of the TBB is not expected to change during execution.
+
 Tor Selenium is tested on **Linux only** right now.
 
 ## Testing
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests.
 
 Tests are run in headless mode by default. If you want to see what the browser is doing you can do this:
 
-    $ export RUN_HEADED_TESTS=1 && rake
+    $ export RUN_HEADED_TESTS=1 && bundle exec rake
 
-If you find tests are failing with `TorNetworkError` and a timeout message, check you have no other Tor Browser processes running. The process to look for is called `firefox.real`. You may also want to check the Tor network is actually up, it isn't always..
+If you find tests are failing with `TorNetworkError` and a timeout message, check you have no other Tor Browser processes running. The process to look for is called "firefox.real". You may also want to check the Tor network is actually up, it isn't always..
 
 ## Development
 

data/lib/firefox_driver_lock_file_patch.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Selenium
+  module WebDriver
+    module Firefox
+      # patched class
+      class Profile
+        alias old_delete_lock_files delete_lock_files
+
+        def delete_lock_files(directory)
+          %w[.parentlock parent.lock lock].each do |name| # 'lock' file missing from Selenium < 4.16
+            FileUtils.rm_f File.join(directory, name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tor/options.rb

@@ -11,8 +11,10 @@ module Selenium
         DEFAULT_TBB_DIR = File.join Dir.home, 'tor-browser'
         Tor::TBB_DIR = ENV.fetch('TOR_BROWSER_ROOT_DIR', nil) || DEFAULT_TBB_DIR
         Tor::TBB_BROWSER_DIR = File.join Tor::TBB_DIR, 'Browser'
-        Tor::TOR_BROWSER_BINARY_PATH = File.join Tor::TBB_BROWSER_DIR, 'firefox'
-        Tor::TOR_BROWSER_VERSION = JSON.parse(File.read(File.join(Tor::TBB_BROWSER_DIR, 'tbb_version.json')))['version']
+        Tor::TBB_BINARY_PATH = File.join Tor::TBB_BROWSER_DIR, 'firefox'
+        Tor::TBB_PROFILE_DIR = File.join Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data Browser profile.default]
+        Tor::TBB_EXTENSIONS_DIR = File.join Tor::TBB_PROFILE_DIR, 'extensions'
+        Tor::TBB_VERSION = JSON.parse(File.read(File.join(Tor::TBB_BROWSER_DIR, 'tbb_version.json')))['version']
 
         def initialize(log_level: nil, **opts)
           super(log_level: log_level, **tor_options.merge(opts))
@@ -22,7 +24,7 @@ module Selenium
         private
 
         def tor_options
-          { binary: TOR_BROWSER_BINARY_PATH, prefs: PREFS }
+          { binary: TBB_BINARY_PATH, prefs: PREFS }
         end
 
         def do_start_tor_browser_script_stuff

data/lib/tor/profile.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'selenium-webdriver'
+require_relative 'options'
+require_relative '../firefox_driver_lock_file_patch' unless
+  Gem::Version.new(Selenium::WebDriver::VERSION) > Gem::Version.new('4.15')
+
+module Selenium
+  module WebDriver
+    module Tor
+      # subclass
+      class Profile < Firefox::Profile
+      end
+    end
+  end
+end

data/lib/tor/version.rb

@@ -3,7 +3,7 @@
 module Selenium
   module WebDriver
     module Tor
-      VERSION = '0.1.1'
+      VERSION = '0.1.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_tor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - MatzFan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-19 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies: []
 description: Selenium extension for Tor Browser
 email:
@@ -26,6 +26,7 @@ files:
 - README.md
 - Rakefile
 - lib/driver.rb
+- lib/firefox_driver_lock_file_patch.rb
 - lib/mixin.rb
 - lib/options.rb
 - lib/selenium_tor.rb
@@ -34,6 +35,7 @@ files:
 - lib/tor/driver_not_yet_connected_to_tor_network.rb
 - lib/tor/options.rb
 - lib/tor/prefs.rb
+- lib/tor/profile.rb
 - lib/tor/version.rb
 - selenium_tor.gemspec
 - sig/tor.rbs