capybara-screenshot 1.0.22 → 1.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b82c5c74da4902799ac9a61f9eb37449a928254e
-  data.tar.gz: 8052ba2b86c41f32539463afeddfe07cb275eb0a
+SHA256:
+  metadata.gz: 7b55f70ee082cc747acdd7e056bec35e27a5be9b654f155e3f3919b535832aa9
+  data.tar.gz: 691ee47e150ed7d3d15e8f383974dca55dface3c0d977e40afa9a206cbdef37e
 SHA512:
-  metadata.gz: 7a4fc4c95398c92bec5387f27521623c2ca6c5d7b6dbf07bfa614e63012ccc31625488baf52b6471bdf6d27e8c5254a0af149e7cb3fc220c4b64ce4239fbdbcf
-  data.tar.gz: 74fc5fb1271e9d7faaf23271719085ea6302a3b74124d764b1d4f5c6b55109329dfc368e1588466cf99d077a071d4cf77ebe40a8b3f68b140522f2442333f655
+  metadata.gz: c87d7ff989030347d1d6b191041d2eaf952f7aab14bc9360cef90cc19ae17537e8e021e49c6b414fc4e0c903097cdd2364a474d872f8a7e379e185b253383b71
+  data.tar.gz: 2440f370b61e99ecea4c33ccf2797a5b727105a6d2610ddb11fd63a6fb12ee47eb49a31be6caf847e1207c266076aa6868a52b2a49fc72db7c1cd469f53ad4f2

data/.travis.yml

@@ -4,9 +4,10 @@ rvm:
   - 2.0.0
   - 2.1.10
   - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.2
 gemfile:
   - gemfiles/cucumber.1.3.gemfile
   - gemfiles/cucumber.2.4.gemfile

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+10 Jun 2019 - 1.0.22 -> 1.0.23
+
+* [Support for Capybara sessions implicitly](https://github.com/mattheworiordan/capybara-screenshot/pull/255). Thanks https://github.com/TylerRick
+* [Support for S3 bucket host configuration](https://github.com/mattheworiordan/capybara-screenshot/pull/252). Thanks https://github.com/machty
+
 21 Oct 2018 - 1.0.21 -> 1.0.22
 
 * [Support for S3 URL in HTML screenshots](https://github.com/mattheworiordan/capybara-screenshot/pull/239)

data/README.md

@@ -5,26 +5,27 @@ capybara-screenshot gem
 [![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/mattheworiordan/capybara-screenshot.svg)](https://codeclimate.com/github/mattheworiordan/capybara-screenshot)
 [![Gem Version](https://badge.fury.io/rb/capybara-screenshot.svg)](http://badge.fury.io/rb/capybara-screenshot)
 
-#### Capture a screen shot for every test failure automatically!
+#### Capture a screenshot for every test failure automatically!
 
-`capybara-screenshot` used with [Capybara](https://github.com/jnicklas/capybara) and [Cucumber](http://cukes.info/), [Rspec](https://www.relishapp.com/rspec) or [Minitest](https://github.com/seattlerb/minitest), will capture a screen shot for each failure in your test suite.  The HTML for the failed page, and a screenshot image (when using [capybara-webkit](https://github.com/thoughtbot/capybara-webkit), [Selenium](http://seleniumhq.org/) or [poltergeist](https://github.com/jonleighton/poltergeist)) is saved into `$APPLICATION_ROOT/tmp/capybara`.
+`capybara-screenshot` used with [Capybara](https://github.com/jnicklas/capybara) alongside [Cucumber](http://cukes.info/), [Rspec](https://www.relishapp.com/rspec) or [Minitest](https://github.com/seattlerb/minitest), will capture a screenshot for each failure in your test suite. Associated screenshot and HTML file
+of the failed page (when using [capybara-webkit](https://github.com/thoughtbot/capybara-webkit), [Selenium](http://seleniumhq.org/) or [poltergeist](https://github.com/jonleighton/poltergeist)) is saved into `$APPLICATION_ROOT/tmp/capybara`.
 
-Having screenshots readily available for each test failure is incredibly helpful when trying to quickly diagnose a problem in your failing steps.  You can view the source code, and have a screen shot of the page (when applicable), at the time of each failure.
+Available screenshots for each test failure is incredibly helpful for diagnosing problems quickly in your failing steps. You have the ability to view screenshots (when applicable) and source code at the time of each failure.
 
-_Please note that Ruby 1.9+ is required to use this Gem.  For Ruby 1.8 support, please see the [capybara-screenshot Ruby 1.8 branch](https://github.com/mattheworiordan/capybara-screenshot/tree/ruby-1.8-support)_
+_Please note that Ruby 1.9+ is required to use this Gem. For Ruby 1.8 support, please see the [capybara-screenshot Ruby 1.8 branch](https://github.com/mattheworiordan/capybara-screenshot/tree/ruby-1.8-support)_
 
 Installation
 -----
 
 ### Step 1: install the gem
 
-Using Bundler, add the following to your Gemfile
+Using Bundler, add the following to your Gemfile:
 
 ```ruby
 gem 'capybara-screenshot', :group => :test
 ```
 
-or install manually using Ruby Gems:
+Alternatively, manually install using Ruby Gems:
 
 ```
 gem install capybara-screenshot
@@ -76,7 +77,7 @@ Typically in 'test/test_helper.rb', please add:
 require 'capybara-screenshot/testunit'
 ```
 
-By default, screenshots will be captured for `Test::Unit` tests in the path 'test/integration'.  You can add additional paths as:
+By default, screenshots will be captured for `Test::Unit` tests in the path 'test/integration'.  You can add additional paths:
 
 ```ruby
 Capybara::Screenshot.testunit_paths << 'test/feature'
@@ -86,27 +87,28 @@ Capybara::Screenshot.testunit_paths << 'test/feature'
 Manual screenshots
 ----
 
-If you require more control, you can generate the screenshot on demand rather than on failure. This is useful
-if the failure occurs at a point where the screen shot is not as useful for debugging a rendering problem. This
-can be more useful if you disable the auto-generate on failure feature with the following config
+If you require more control, screenshots can be generated on demand rather than on failure. This is useful
+when screenshots produced at the time of failure are not as useful for debugging a rendering problem.
+Differentiating between manual and failure screenshots can be improved by disabling the auto-generate on
+failure feature:
 
 ```ruby
 Capybara::Screenshot.autosave_on_failure = false
 ```
 
-Anywhere the Capybara DSL methods (visit, click etc.) are available so too are the screenshot methods.
+Anywhere the Capybara DSL methods (visit, click etc.) are available so too are the screenshot methods:
 
 ```ruby
 screenshot_and_save_page
 ```
 
-Or for screenshot only, which will automatically open the image.
+Or for screenshot only, which will automatically open the image:
 
 ```ruby
 screenshot_and_open_image
 ```
 
-These are just calls on the main library methods.
+These are just calls on the main library methods:
 
 ```ruby
 Capybara::Screenshot.screenshot_and_save_page
@@ -116,7 +118,7 @@ Capybara::Screenshot.screenshot_and_open_image
 Better looking HTML screenshots
 -------------------------------
 
-By the default, HTML screenshots will not look very good when opened in a browser.  This happens because the browser can't correctly resolve relative paths like `<link href="/assets/...." />`, which stops CSS, images, etc... from beind loaded.  To get a nicer looking page, configure Capybara with:
+By the default, HTML screenshots will not look very good when opened in a browser.  This happens because the browser can't correctly resolve relative paths like `<link href="/assets/...." />`, which stops CSS, images, etc... from being loaded.  To get a nicer looking page, configure Capybara with:
 
 ```ruby
 Capybara.asset_host = 'http://localhost:3000'
@@ -165,7 +167,7 @@ Custom screenshot filename
 --------------------------
 
 If you want to control the screenshot filename for a specific test library, to inject the test name into it for example,
-you can override how the basename is generated for the file like so
+you can override how the basename is generated for the file:
 
 ```ruby
 Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
@@ -173,7 +175,7 @@ Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
 end
 ```
 
-By default capybara-screenshot will append a timestamp to the basename. If you want to disable this behavior set the following option:
+By default capybara-screenshot will append a timestamp to the basename. If you want to disable this behavior, set the following option:
 
 ```ruby
 Capybara::Screenshot.append_timestamp = false
@@ -183,36 +185,25 @@ Capybara::Screenshot.append_timestamp = false
 Custom screenshot directory
 --------------------------
 By default, when running under Rails, Sinatra, and Padrino, screenshots are saved into `$APPLICATION_ROOT/tmp/capybara`. Otherwise, they're saved under `Dir.pwd`.
-If you want to customize the location, override the file path as:
+If you want to customize the location, override the file path:
 
 ```ruby
 Capybara.save_path = "/file/path"
 ```
 
-Usage with multiple Capybara sessions
--------------------------------------
-
-To make screenshots work with multiple Capybara sessions, replace `Capybara.using_session` with `Capybara.using_session_with_screenshot`:
-
-```ruby
-Cabybara.using_session_with_screenshot('User 1') do
-  # screenshots will work and use the correct session
-end
-```
-
 
 Uploading screenshots to S3
 --------------------------
 You can configure capybara-screenshot to automatically save your screenshots to an AWS S3 bucket.
 
-First, install the `aws-sdk-s3` gem or add it to your Gemfile
+First, install the `aws-sdk-s3` gem or add it to your Gemfile:
 
 ```ruby
 gem 'aws-sdk-s3', group: :test
 gem 'capybara-screenshot', group: :test
 ```
 
-Next, configure capybara-screenshot with your S3 credentials, the bucket to save to, and an optional region (default: `us-east-1`).
+Next, configure capybara-screenshot with your S3 credentials, the bucket to save to, and an optional region (default: `us-east-1`):
 
 ```ruby
 Capybara::Screenshot.s3_configuration = {
@@ -221,10 +212,16 @@ Capybara::Screenshot.s3_configuration = {
     secret_access_key: "my_secret_access_key",
     region: "eu-central-1"
   },
-  bucket_name: "my_screenshots"
+  bucket_name: "my_screenshots",
+  # Optionally: Specify the host used to access the uploaded screenshots
+  bucket_host: "my_screenshots.s3-eu-central-1.amazonaws.com",
 }
 ```
 
+The access key used for S3 uploads need to have at least the `s3:PutObject` permission.
+
+**Note**: If you do not provide the `bucket_host` configuration option, additionally the `s3:GetBucketLocation` permission is required on the bucket for uploads to succeed.
+
 It is also possible to specify the object parameters such as acl.
 Configure the capybara-screenshot with these options in this way:
 
@@ -245,7 +242,7 @@ Capybara::Screenshot.s3_configuration = {
 
 Pruning old screenshots automatically
 --------------------------
-By default screenshots are saved indefinitely, if you want them to be automatically pruned on a new failure, then you can specify one of the following prune strategies as follows:
+By default, screenshots are saved indefinitely. If you want them to be automatically pruned on a new failure, then you can specify one of the following prune strategies as follows:
 
 ```ruby
 # Keep only the screenshots generated from the last failing test suite
@@ -258,7 +255,7 @@ Capybara::Screenshot.prune_strategy = { keep: 20 }
 Callbacks
 ---------
 
-You can hook your own logic into callbacks after the html/screenshot has been saved.
+You can hook your own logic into callbacks after the html/screenshot has been saved:
 
 ```ruby
 # after Saver#save_html
@@ -322,7 +319,7 @@ Please raise an issue at [https://github.com/mattheworiordan/capybara-screenshot
 
 #### Contributions
 
-Contributions are welcome.  Please fork this gem, and submit a pull request.  New features must include test coverage and must pass on all versions of the testing frameworks supported.  Run `appraisal` to set up the your Gems. then `appraisal "rake travis:ci"` locally to test your changes against all versions of testing framework gems supported.
+Contributions are welcome.  Please fork this gem and then submit a pull request.  New features must include test coverage and must pass on all versions of the testing frameworks supported.  Run `appraisal` to set up the your Gems. then `appraisal "rake travis:ci"` locally to test your changes against all versions of testing framework gems supported.
 
 #### Rubygems
 

data/lib/capybara-screenshot/capybara.rb

@@ -1,4 +1,20 @@
 module Capybara
+  class << self
+    module ScreenshotOverrides
+      def using_session(name, &block)
+        original_session_name = Capybara.session_name
+        Capybara::Screenshot.final_session_name = name
+        super(name, &block)
+        Capybara::Screenshot.final_session_name = original_session_name
+      end
+
+      # No longer needed. Kept for backwards compatibility only.
+      alias_method :using_session_with_screenshot, :using_session
+    end
+
+    prepend ScreenshotOverrides
+  end
+
   module DSL
     # Adds class methods to Capybara module and gets mixed into
     # the current scope during Cucumber and RSpec tests
@@ -10,15 +26,5 @@ module Capybara
     def screenshot_and_open_image
       Capybara::Screenshot.screenshot_and_open_image
     end
-
-    def using_session_with_screenshot(name,&blk)
-      original_session_name = Capybara.session_name
-      Capybara::Screenshot.final_session_name = name
-      using_session_without_screenshot(name,&blk)
-      Capybara::Screenshot.final_session_name = original_session_name
-    end
-
-    alias_method :using_session_without_screenshot, :using_session
-    alias_method :using_session, :using_session_with_screenshot
   end
 end

data/lib/capybara-screenshot/s3_saver.rb

@@ -11,6 +11,7 @@ module Capybara
         @saver = saver
         @s3_client = s3_client
         @bucket_name = bucket_name
+        @bucket_host = options[:bucket_host]
         @key_prefix = options[:key_prefix]
         @object_configuration = object_configuration
       end
@@ -49,9 +50,9 @@ module Capybara
                 object_payload
             )
 
-            s3_region = s3_client.get_bucket_location(bucket: bucket_name).location_constraint
+            host = bucket_host || determine_bucket_host
 
-            send("#{type}_path=", "https://#{bucket_name}.s3-#{s3_region}.amazonaws.com/#{s3_upload_path}")
+            send("#{type}_path=", "https://#{host}/#{s3_upload_path}")
           end
         end
       end
@@ -68,9 +69,18 @@ module Capybara
       attr_reader :saver,
                   :s3_client,
                   :bucket_name,
+                  :bucket_host,
                   :object_configuration
                   :key_prefix
 
+      ##
+      # Reads the bucket location using a S3 get_bucket_location request.
+      # Requires the +s3:GetBucketLocation+ policy.
+      def determine_bucket_host
+        s3_region = s3_client.get_bucket_location(bucket: bucket_name).location_constraint
+        "#{bucket_name}.s3-#{s3_region}.amazonaws.com"
+      end
+
       def save_and
         saver.save
 

data/lib/capybara-screenshot/saver.rb

@@ -27,7 +27,9 @@ module Capybara
 
       def save
         current_path do |path|
-          if !path.empty?
+          if path.empty?
+            warn 'WARN: Screenshot could not be saved. `page.current_path` is empty.'
+          else
             begin
               save_html if @html_save
             rescue StandardError => e
@@ -39,8 +41,6 @@ module Capybara
             rescue StandardError => e
               warn "WARN: Screenshot could not be saved. An exception is raised: #{e.inspect}."
             end
-          else
-            warn 'WARN: Screenshot could not be saved. `page.current_path` is empty.'
           end
         end
       end
@@ -49,9 +49,9 @@ module Capybara
         path = html_path
         clear_save_path do
           if Capybara::VERSION.match(/^\d+/)[0] == '1'
-            capybara.save_page(page.body, "#{path}")
+            capybara.save_page(page.body, path.to_s)
           else
-            capybara.save_page("#{path}")
+            capybara.save_page(path.to_s)
           end
         end
         @html_saved = true
@@ -132,13 +132,15 @@ module Capybara
       #   which('ruby') #=> /usr/bin/ruby
       def which(cmd)
         exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
         ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
           exts.each { |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
           }
         end
-        return nil
+
+        nil
       end
     end
   end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = '1.0.22'
+    VERSION = '1.0.23'
   end
 end

data/spec/cucumber/cucumber_spec.rb

@@ -26,7 +26,7 @@ describe "Using Capybara::Screenshot with Cucumber" do
 
     write_file('features/cucumber.feature', code)
 
-    run_simple_with_retry cmd, false
+    run_simple_with_retry cmd
 
     expect(last_command_started.output).to_not match(/failed|failure/i) if options[:assert_all_passed]
   end

data/spec/feature/minitest_spec.rb

@@ -22,7 +22,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
     RUBY
 
     cmd = 'bundle exec ruby test_failure.rb'
-    run_simple_with_retry cmd, false
+    run_simple_with_retry cmd
     expect(last_command_started.output).to match %r{Unable to find (visible )?link or button "you'll never find me"}
   end
 

data/spec/feature/testunit_spec.rb

@@ -28,7 +28,7 @@ describe "Using Capybara::Screenshot with Test::Unit" do
     RUBY
 
     cmd = "bundle exec ruby #{integration_path}/test_failure.rb"
-    run_simple_with_retry cmd, false
+    run_simple_with_retry cmd
     expect(last_command_started.output).to match %r{Unable to find (visible )?link or button "you'll never find me"}
   end
 

data/spec/rspec/rspec_spec.rb

@@ -31,7 +31,7 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
       RUBY
 
       cmd = cmd_with_format(options[:format])
-      run_simple_with_retry cmd, false
+      run_simple_with_retry cmd
 
       expect(last_command_started.output).to match('0 failures') if options[:assert_all_passed]
     end
@@ -116,7 +116,24 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
           end
         end
       RUBY
-      expect('tmp/screenshot.html').to have_file_content(/is/)
+      expect('tmp/screenshot.html').to have_file_content(/This is a different page/)
+    end
+
+    it 'saves a screenshot for the correct session for failures Capybara.using_session' do
+      run_failing_case <<-RUBY, %r{Unable to find (visible )?link or button "you'll never find me"}
+        feature 'screenshot with failure' do
+          scenario 'click on a missing link' do
+            visit '/'
+            expect(page.body).to include('This is the root page')
+            Capybara.using_session :different_session do
+              visit '/different_page'
+              expect(page.body).to include('This is a different page')
+              click_on "you'll never find me"
+            end
+          end
+        end
+      RUBY
+      expect('tmp/screenshot.html').to have_file_content(/This is a different page/)
     end
 
     context 'pruning' do

data/spec/spinach/spinach_spec.rb

@@ -12,7 +12,7 @@ describe "Using Capybara::Screenshot with Spinach" do
 
     write_file('spinach.feature', code)
     cmd = 'bundle exec spinach -f .'
-    run_simple_with_retry cmd, false
+    run_simple_with_retry cmd
     expect(last_command_started.output).to match(failure_message)
   end
 

data/spec/support/common_setup.rb

@@ -41,11 +41,11 @@ module CommonSetup
       end
     end
 
-    def run_simple_with_retry(*args)
-      run_simple(*args)
+    def run_simple_with_retry(cmd, fail_on_error: false)
+      run_command_and_stop(cmd, fail_on_error: fail_on_error)
     rescue ChildProcess::TimeoutError => e
-      puts "run_simple(#{args.join(', ')}) failed. Will retry once. `#{e.message}`"
-      run_simple(*args)
+      puts "run_command_and_stop(#{cmd}, fail_on_error: #{fail_on_error}) failed. Will retry once. `#{e.message}`"
+      run_command_and_stop(cmd, fail_on_error: fail_on_error)
     end
 
     def configure_prune_strategy(strategy)

data/spec/unit/capybara_spec.rb

@@ -26,6 +26,19 @@ describe Capybara do
       }.to raise_exception ::RSpec::Expectations::ExpectationNotMetError
     end
   end
+
+  describe 'Capybara.using_session' do
+    include Capybara::DSL
+
+    it 'saves the name of the final session' do
+      expect(Capybara::Screenshot).to receive(:final_session_name=).with(:different_session)
+      expect {
+        Capybara.using_session :different_session do
+          expect(0).to eq 1
+        end
+      }.to raise_exception ::RSpec::Expectations::ExpectationNotMetError
+    end
+  end
 end
 
 describe 'final_session_name' do

data/spec/unit/s3_saver_spec.rb

@@ -5,10 +5,11 @@ describe Capybara::Screenshot::S3Saver do
   let(:saver) { double('saver') }
   let(:bucket_name) { double('bucket_name') }
   let(:s3_object_configuration) { {} }
+  let(:options) { {} }
   let(:s3_client) { double('s3_client') }
   let(:key_prefix){ "some/path/" }
 
-  let(:s3_saver) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration) }
+  let(:s3_saver) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration, options) }
   let(:s3_saver_with_key_prefix) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration, key_prefix: key_prefix) }
 
   let(:region) { double('region') }
@@ -104,6 +105,20 @@ describe Capybara::Screenshot::S3Saver do
       allow(saver).to receive(:save)
     end
 
+    context 'providing a bucket_host' do
+      let(:options) { { bucket_host: 'some other location' } }
+  
+      it 'does not request the bucket location' do
+        screenshot_path = '/baz/bim.jpg'
+
+        screenshot_file = double('screenshot_file')
+
+        expect(s3_saver).not_to receive(:determine_bucket_host)
+
+        s3_saver.save
+      end
+    end
+
     it 'calls save on the underlying saver' do
       expect(saver).to receive(:save)
 
@@ -125,6 +140,8 @@ describe Capybara::Screenshot::S3Saver do
         body: html_file
       )
 
+      expect(s3_saver).to receive(:determine_bucket_host).and_call_original
+
       s3_saver.save
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.22
+  version: 1.0.23
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-21 00:00:00.000000000 Z
+date: 2019-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -256,8 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: capybara-screenshot
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Automatically create snapshots when Cucumber steps fail with Capybara and