capybara-screenshot 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fb2ac718fb87183d57ce6b852dcd9a7f21d908d
-  data.tar.gz: 71177ec4576776a6ed0368cecfbb335e52e78457
+  metadata.gz: a2c4277a621182718153bba9b9bae60234ddfd17
+  data.tar.gz: 6af401d8ae56c2849916c0145f0f0ce928cc92ac
 SHA512:
-  metadata.gz: 78fcfead269c5570bfa3309d2263ca664359aa8ede1ce21e3a61af8bcb2ca9ca4f3b488b0bbc02cfc4da75ae6b35d0132977cf1e069ef120d3e6b651476b2a6c
-  data.tar.gz: 883369b31dc3b1e0ae3e1aa477892638f5adb745e9a53ff4ea0a49f8dc2b5a1782bbe59373afbe79063ed003e452dcd5eae61119ff5a7a94b97bf84614035b1c
+  metadata.gz: 0696563bcf86da3827f2d8392f2555c56e2f830b0ff6c76bad72d5ac2c1b8ddb37730fee26c51924dbd0f4edc4cf8054949adac7506bf01b45cd955fc200c676
+  data.tar.gz: 55ebe3341f404a7c57d5265ca6478127e3b3b4f277a0f2d130f87d5724b0d38d6d441fed4488ab13d0194826432ad0491f6a52b754dc19e578f6f33f61be1a83

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+23 May 2016 - 1.0.12 -> 1.0.13
+
+* Fixes [mkmf bug 162](https://github.com/mattheworiordan/capybara-screenshot/issues/162) and [mkmf bug 174](https://github.com/mattheworiordan/capybara-screenshot/issues/174)
+* Fix for `Capybara.save_path` method existence assumption
+
 29 March 2016 - 1.0.11 -> 1.0.12
 
 * [Aruba upgrade - passing CI](https://github.com/mattheworiordan/capybara-screenshot/pull/156)

data/README.md

@@ -174,6 +174,31 @@ Capybara.save_and_open_page_path = "/file/path"
 ```
 
 
+Uploading screenshots to S3
+--------------------------
+You can configure capybara-screenshot to automatically save your screenshots to an AWS S3 bucket. 
+
+First, install the `aws-sdk` gem or add it to your Gemfile
+
+```ruby
+gem 'capybara-screenshot', :group => :test
+gem 'aws-sdk', :group => :test
+```
+
+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 = {
+  s3_client_credentials: {
+    access_key_id: "my_access_key_id",
+    secret_access_key: "my_secret_access_key",
+    region: "eu-central-1"
+  },
+  bucket_name: "my_screenshots"
+}
+```
+
+
 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:

data/capybara-screenshot.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'test-unit'
   s.add_development_dependency 'spinach'
   s.add_development_dependency 'minitest'
+  s.add_development_dependency 'aws-sdk'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/capybara-screenshot.rb

@@ -9,6 +9,7 @@ module Capybara
       attr_accessor :webkit_options
       attr_writer   :final_session_name
       attr_accessor :prune_strategy
+      attr_accessor :s3_configuration
     end
 
     self.autosave_on_failure = true
@@ -18,6 +19,7 @@ module Capybara
     self.append_random = false
     self.webkit_options = {}
     self.prune_strategy = :keep_all
+    self.s3_configuration = {}
 
     def self.append_screenshot_path=(value)
       $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
@@ -26,7 +28,7 @@ module Capybara
     end
 
     def self.screenshot_and_save_page
-      saver = Saver.new(Capybara, Capybara.page)
+      saver = new_saver(Capybara, Capybara.page)
       if saver.save
         {:html => saver.html_path, :image => saver.screenshot_path}
       end
@@ -35,7 +37,7 @@ module Capybara
     def self.screenshot_and_open_image
       require "launchy"
 
-      saver = Saver.new(Capybara, Capybara.page, false)
+      saver = new_saver(Capybara, Capybara.page, false)
       if saver.save
         Launchy.open saver.screenshot_path
         {:html => nil, :image => saver.screenshot_path}
@@ -54,7 +56,7 @@ module Capybara
     end
 
     def self.capybara_root
-      @capybara_root ||= if defined?(::Rails) && Rails.root.present?
+      @capybara_root ||= if defined?(::Rails) && ::Rails.root.present?
         ::Rails.root.join capybara_tmp_path
       elsif defined?(Padrino)
         File.expand_path(capybara_tmp_path, Padrino.root)
@@ -90,11 +92,28 @@ module Capybara
       @pruned_previous_screenshots = nil
     end
 
+    def self.new_saver(*args)
+      saver = Saver.new(*args)
+
+      unless s3_configuration.empty?
+        require 'capybara-screenshot/s3_saver'
+        saver = S3Saver.new_with_configuration(saver, s3_configuration)
+      end
+
+      return saver
+    end
+
     private
 
     # If the path isn't set, default to the current directory
     def self.capybara_tmp_path
-      Capybara.save_and_open_page_path || '.'
+      # `#save_and_open_page_path` is deprecated
+      # https://github.com/jnicklas/capybara/blob/48ab1ede946dec2250a2d1d8cbb3313f25096456/History.md#L37
+      if Capybara.respond_to?(:save_path)
+        Capybara.save_path
+      else
+        Capybara.save_and_open_page_path
+      end || '.'
     end
   end
 end

data/lib/capybara-screenshot/cucumber.rb

@@ -1,5 +1,4 @@
 require "capybara-screenshot"
-require 'mkmf'
 
 Before do |scenario|
   Capybara::Screenshot.final_session_name = nil
@@ -10,7 +9,7 @@ After do |scenario|
     Capybara.using_session(Capybara::Screenshot.final_session_name) do
       filename_prefix = Capybara::Screenshot.filename_prefix_for(:cucumber, scenario)
 
-      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+      saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
       saver.save
       saver.output_screenshot_path
 

data/lib/capybara-screenshot/minitest.rb

@@ -6,14 +6,14 @@ module Capybara::Screenshot::MiniTestPlugin
     Capybara::Screenshot.final_session_name = nil
   end
 
-  def after_teardown
+  def before_teardown
     super
-    if self.class.ancestors.map(&:to_s).include?('ActionDispatch::IntegrationTest')
+    if self.class.ancestors.map(&:to_s).include?('Capybara::DSL')
       if Capybara::Screenshot.autosave_on_failure && !passed? && !skipped?
         Capybara.using_session(Capybara::Screenshot.final_session_name) do
           filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, self)
 
-          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
           saver.save
           saver.output_screenshot_path
         end

data/lib/capybara-screenshot/rspec.rb

@@ -3,6 +3,7 @@ require "capybara-screenshot"
 require "capybara-screenshot/rspec/text_reporter"
 require "capybara-screenshot/rspec/html_link_reporter"
 require "capybara-screenshot/rspec/html_embed_reporter"
+require "capybara-screenshot/rspec/json_reporter"
 require "capybara-screenshot/rspec/textmate_link_reporter"
 
 module Capybara
@@ -39,6 +40,7 @@ module Capybara
         "RSpec::Core::Formatters::ProgressFormatter"      => Capybara::Screenshot::RSpec::TextReporter,
         "RSpec::Core::Formatters::DocumentationFormatter" => Capybara::Screenshot::RSpec::TextReporter,
         "RSpec::Core::Formatters::HtmlFormatter"          => Capybara::Screenshot::RSpec::HtmlLinkReporter,
+        "RSpec::Core::Formatters::JsonFormatter"          => Capybara::Screenshot::RSpec::JsonReporter,
         "RSpec::Core::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter, # RSpec 2
         "RSpec::Mate::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter,  # RSpec 3
         "Fuubar"                                          => Capybara::Screenshot::RSpec::TextReporter
@@ -53,7 +55,7 @@ module Capybara
               if Capybara.page.current_url != '' && Capybara::Screenshot.autosave_on_failure && example.exception
                 filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
 
-                saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+                saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
                 saver.save
 
                 example.metadata[:screenshot] = {}

data/lib/capybara-screenshot/rspec/json_reporter.rb

@@ -0,0 +1,19 @@
+require 'capybara-screenshot/rspec/base_reporter'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module JsonReporter
+        extend BaseReporter
+
+        enhance_with_screenshot :format_example
+
+        def format_example_with_screenshot(example)
+          format_example_without_screenshot(example).merge({
+            screenshot: example.metadata[:screenshot]
+          })
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/s3_saver.rb

@@ -0,0 +1,64 @@
+require 'aws-sdk'
+
+module Capybara
+  module Screenshot
+    class S3Saver
+      DEFAULT_REGION = 'us-east-1'
+
+      def initialize(saver, s3_client, bucket_name)
+        @saver = saver
+        @s3_client = s3_client
+        @bucket_name = bucket_name
+      end
+
+      def self.new_with_configuration(saver, configuration)
+        default_s3_client_credentials = {
+          region: DEFAULT_REGION
+        }
+
+        s3_client_credentials = default_s3_client_credentials.merge(
+          configuration.fetch(:s3_client_credentials)
+        )
+
+        s3_client = Aws::S3::Client.new(s3_client_credentials)
+        bucket_name = configuration.fetch(:bucket_name)
+
+        new(saver, s3_client, bucket_name)
+      rescue KeyError
+        raise "Invalid S3 Configuration #{configuration}. Please refer to the documentation for the necessary configurations."
+      end
+
+      def save_and_upload_screenshot
+        save_and do |local_file_path|
+          File.open(local_file_path) do |file|
+            s3_client.put_object(
+                bucket: bucket_name,
+                key: File.basename(local_file_path),
+                body: file
+            )
+          end
+        end
+      end
+      alias_method :save, :save_and_upload_screenshot
+
+      def method_missing(method, *args)
+        # Need to use @saver instead of S3Saver#saver attr_reader method because
+        # using the method goes into infinite loop. Maybe attr_reader implements
+        # its methods via method_missing?
+        @saver.send(method, *args)
+      end
+
+      private
+      attr_reader :saver,
+                  :s3_client,
+                  :bucket_name
+
+      def save_and
+        saver.save
+
+        yield(saver.html_path) if block_given? && saver.html_saved?
+        yield(saver.screenshot_path) if block_given? && saver.screenshot_saved?
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/spinach.rb

@@ -9,7 +9,7 @@ module Capybara::Screenshot::Spinach
     if Capybara::Screenshot.autosave_on_failure
       Capybara.using_session(Capybara::Screenshot.final_session_name) do
         filename_prefix = Capybara::Screenshot.filename_prefix_for(:spinach, step_data)
-        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+        saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
         saver.save
         saver.output_screenshot_path
       end

data/lib/capybara-screenshot/testunit.rb

@@ -27,7 +27,7 @@ Test::Unit::TestResult.class_eval do
         Capybara.using_session(Capybara::Screenshot.final_session_name) do
           filename_prefix = Capybara::Screenshot.filename_prefix_for(:testunit, fault)
 
-          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
           saver.save
           saver.output_screenshot_path
         end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = '1.0.12'
+    VERSION = '1.0.13'
   end
 end

data/spec/feature/minitest_spec.rb

@@ -31,25 +31,6 @@ describe "Using Capybara::Screenshot with MiniTest" do
   end
 
   it 'saves a screenshot on failure' do
-    run_failing_case <<-RUBY
-      module ActionDispatch
-        class IntegrationTest < Minitest::Unit::TestCase; end
-      end
-
-      class TestFailure < ActionDispatch::IntegrationTest
-        include Capybara::DSL
-
-        def test_failure
-          visit '/'
-          assert(page.body.include?('This is the root page'))
-          click_on "you'll never find me"
-        end
-      end
-    RUBY
-    expect('tmp/my_screenshot.html').to have_file_content('This is the root page')
-  end
-
-  it "does not save a screenshot for tests that don't inherit from ActionDispatch::IntegrationTest" do
     run_failing_case <<-RUBY
       class TestFailure < MiniTest::Unit::TestCase
         include Capybara::DSL
@@ -61,16 +42,12 @@ describe "Using Capybara::Screenshot with MiniTest" do
         end
       end
     RUBY
-    expect('tmp/my_screenshot.html').to_not be_an_existing_file
+    expect('tmp/my_screenshot.html').to have_file_content('This is the root page')
   end
 
   it 'saves a screenshot for the correct session for failures using_session' do
     run_failing_case <<-RUBY
-      module ActionDispatch
-        class IntegrationTest < Minitest::Unit::TestCase; end
-      end
-
-      class TestFailure < ActionDispatch::IntegrationTest
+      class TestFailure < Minitest::Unit::TestCase
         include Capybara::DSL
 
         def test_failure
@@ -91,11 +68,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
     create_screenshot_for_pruning
     configure_prune_strategy :last_run
     run_failing_case <<-RUBY
-      module ActionDispatch
-        class IntegrationTest < Minitest::Unit::TestCase; end
-      end
-
-      class TestFailure < ActionDispatch::IntegrationTest
+      class TestFailure < Minitest::Unit::TestCase
         include Capybara::DSL
 
         def test_failure

data/spec/rspec/rspec_spec.rb

@@ -57,7 +57,8 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
     formatters = {
       progress:      'HTML screenshot:',
       documentation: 'HTML screenshot:',
-      html:          %r{<a href="file://\./tmp/screenshot\.html"[^>]*>HTML page</a>}
+      html:          %r{<a href="file://\./tmp/screenshot\.html"[^>]*>HTML page</a>},
+      json:          '"screenshot":{"'
     }
 
     # Textmate formatter is only included in RSpec 2

data/spec/unit/capybara-screenshot_spec.rb

@@ -65,6 +65,32 @@ describe Capybara::Screenshot do
     end
   end
 
+  describe '.new_saver' do
+    it 'passes through to get a new Saver if the user has not configured s3' do
+      saver_double = double('saver')
+      args = double('args')
+      expect(Capybara::Screenshot::Saver).to receive(:new).with(args).and_return(saver_double)
+
+      expect(Capybara::Screenshot.new_saver(args)).to eq(saver_double)
+    end
+
+    it 'wraps the returned saver in an S3 saver if it has been configured' do
+      require 'capybara-screenshot/s3_saver'
+
+      saver_double = double('saver')
+      args = double('args')
+      s3_saver_double = double('s3_saver')
+      s3_configuration = { hello: 'world' }
+
+      Capybara::Screenshot.s3_configuration = s3_configuration
+
+      expect(Capybara::Screenshot::Saver).to receive(:new).with(args).and_return(saver_double)
+      expect(Capybara::Screenshot::S3Saver).to receive(:new_with_configuration).with(saver_double, s3_configuration).and_return(s3_saver_double)
+
+      expect(Capybara::Screenshot.new_saver(args)).to eq(s3_saver_double)
+    end
+  end
+
   describe '#prune' do
     before do
       Capybara::Screenshot.reset_prune_history

data/spec/unit/s3_saver_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'capybara-screenshot/s3_saver'
+
+describe Capybara::Screenshot::S3Saver do
+  let(:saver) { double('saver') }
+  let(:bucket_name) { double('bucket_name') }
+  let(:s3_client) { double('s3_client') }
+
+  let(:s3_saver) { Capybara::Screenshot::S3Saver.new(saver, s3_client, bucket_name) }
+
+  describe '.new_with_configuration' do
+    let(:access_key_id) { double('access_key_id') }
+    let(:secret_access_key) { double('secret_access_key') }
+    let(:s3_client_credentials_using_defaults) {
+      {
+        access_key_id: access_key_id,
+        secret_access_key: secret_access_key
+      }
+    }
+
+    let(:region) { double('region') }
+    let(:s3_client_credentials) {
+      s3_client_credentials_using_defaults.merge(region: region)
+    }
+
+    it 'destructures the configuration into its components' do
+      allow(Aws::S3::Client).to receive(:new).and_return(s3_client)
+      allow(Capybara::Screenshot::S3Saver).to receive(:new)
+
+      Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
+        s3_client_credentials: s3_client_credentials,
+        bucket_name: bucket_name
+      })
+
+      expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
+      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name)
+    end
+
+    it 'defaults the region to us-east-1' do
+      default_region = 'us-east-1'
+
+      allow(Aws::S3::Client).to receive(:new).and_return(s3_client)
+      allow(Capybara::Screenshot::S3Saver).to receive(:new)
+
+      Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
+          s3_client_credentials: s3_client_credentials_using_defaults,
+          bucket_name: bucket_name
+      })
+
+      expect(Aws::S3::Client).to have_received(:new).with(
+        s3_client_credentials.merge(region: default_region)
+      )
+
+      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name)
+    end
+  end
+
+  describe '#save' do
+    before do
+      allow(saver).to receive(:html_saved?).and_return(false)
+      allow(saver).to receive(:screenshot_saved?).and_return(false)
+      allow(saver).to receive(:save)
+    end
+
+    it 'calls save on the underlying saver' do
+      expect(saver).to receive(:save)
+
+      s3_saver.save
+    end
+
+    it 'uploads the html' do
+      html_path = '/foo/bar.html'
+      expect(saver).to receive(:html_path).and_return(html_path)
+      expect(saver).to receive(:html_saved?).and_return(true)
+
+      html_file = double('html_file')
+
+      expect(File).to receive(:open).with(html_path).and_yield(html_file)
+
+      expect(s3_client).to receive(:put_object).with(
+        bucket: bucket_name,
+        key: 'bar.html',
+        body: html_file
+      )
+
+      s3_saver.save
+    end
+
+    it 'uploads the screenshot' do
+      screenshot_path = '/baz/bim.jpg'
+      expect(saver).to receive(:screenshot_path).and_return(screenshot_path)
+      expect(saver).to receive(:screenshot_saved?).and_return(true)
+
+      screenshot_file = double('screenshot_file')
+
+      expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
+
+      expect(s3_client).to receive(:put_object).with(
+        bucket: bucket_name,
+        key: 'bim.jpg',
+        body: screenshot_file
+      )
+
+      s3_saver.save
+    end
+  end
+
+  # Needed because we cannot depend on Verifying Doubles
+  # in older RSpec versions
+  describe 'an actual saver' do
+    it 'implements the methods needed by the s3 saver' do
+      instance_methods = Capybara::Screenshot::Saver.instance_methods
+
+      expect(instance_methods).to include(:save)
+      expect(instance_methods).to include(:html_saved?)
+      expect(instance_methods).to include(:html_path)
+      expect(instance_methods).to include(:screenshot_saved?)
+      expect(instance_methods).to include(:screenshot_path)
+    end
+  end
+
+  describe 'any other method' do
+    it 'transparently passes through to the saver' do
+      allow(saver).to receive(:foo_bar)
+
+      args = double('args')
+      s3_saver.foo_bar(*args)
+
+      expect(saver).to have_received(:foo_bar).with(*args)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -156,6 +156,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: When a Cucumber step fails, it is useful to create a screenshot image
   and HTML file of the current page
 email:
@@ -192,8 +206,10 @@ files:
 - lib/capybara-screenshot/rspec/base_reporter.rb
 - lib/capybara-screenshot/rspec/html_embed_reporter.rb
 - lib/capybara-screenshot/rspec/html_link_reporter.rb
+- lib/capybara-screenshot/rspec/json_reporter.rb
 - lib/capybara-screenshot/rspec/text_reporter.rb
 - lib/capybara-screenshot/rspec/textmate_link_reporter.rb
+- lib/capybara-screenshot/s3_saver.rb
 - lib/capybara-screenshot/saver.rb
 - lib/capybara-screenshot/spinach.rb
 - lib/capybara-screenshot/testunit.rb
@@ -220,6 +236,7 @@ files:
 - spec/unit/rspec_reporters/html_link_reporter_spec.rb
 - spec/unit/rspec_reporters/text_reporter_spec.rb
 - spec/unit/rspec_reporters/textmate_link_reporter_spec.rb
+- spec/unit/s3_saver_spec.rb
 - spec/unit/saver_spec.rb
 homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses:
@@ -269,4 +286,5 @@ test_files:
 - spec/unit/rspec_reporters/html_link_reporter_spec.rb
 - spec/unit/rspec_reporters/text_reporter_spec.rb
 - spec/unit/rspec_reporters/textmate_link_reporter_spec.rb
+- spec/unit/s3_saver_spec.rb
 - spec/unit/saver_spec.rb