webshot 0.0.9 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62a9727397129f1b5a062f88bd46a48c1b4dd5db
-  data.tar.gz: b8d66c2cad1e39bb66c55b245549486d1e8e52bb
+SHA256:
+  metadata.gz: a59b9cc6a133d67974cba34f4493c8a478501667c32aac1e098ba38774779eaa
+  data.tar.gz: a879235931047261bf8fa43dc20a99bfd3e65f8c2600de19a26aa03a80826d43
 SHA512:
-  metadata.gz: 6576d08d90ffe8fc2f129f143cf7f13327af5375e7ceef002646fa9df7f55baa459ebe7d8bfaed128e164359dadd15f3da8722d7f95f5d75903c155f857b807e
-  data.tar.gz: 4e76de6199a9a96ba5feb068645733dcc857bfefd667a30c7c43cce9d2e929f4c73580897b5c2f23c6f1263cb7be2e2ba82cc01257ed525a002650b8a2cf9868
+  metadata.gz: a003e10846290ac9717ed85fb2859cfe7d93f704f2a109dc31d5aea7a03e6be0ac514887e4e6f8154621558f8dbee1a8e350fff663b88d4c93967b113654505a
+  data.tar.gz: 0dcf0f7ad5cc31ed044bd253b8d6d31ae81191e616d2d401f5dd8010a05b51fa2fa3a799738744ecb25726aa5c346636a5fc7a61877e4669d600b6da90eed1c5

data/.travis.yml

@@ -3,12 +3,8 @@ cache: bundler
 before_install:
   - gem install bundler
 rvm:
-  - 2.1
-  - 2.0
-  - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-2
+  - 2.5
+  - 2.6
+  - 2.7
 matrix:
-  allow_failures:
-    - rvm: rbx-2
   fast_finish: true

data/CONTRIBUTORS

@@ -1 +1,4 @@
 Alex Avoyants
+Nick Kezhaya
+Rafa García
+Sage Ross

data/README.md

@@ -6,7 +6,7 @@ Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS.
 
 ## Installation
 
-Download and install [PhantomJS](http://phantomjs.org/),
+Download and install [PhantomJS](http://phantomjs.org/releases.html) version 2.X,
 add the directory containing the binary to your PATH.
 
 Add the `webshot` gem to your Gemfile:
@@ -33,6 +33,13 @@ ws.capture "http://www.google.com/", "google.png"
 # Customize thumbnail
 ws.capture "http://www.google.com/", "google.png", width: 100, height: 90, quality: 85
 
+# Specify only width, height will be computed according to page's height
+ws.capture "http://www.google.com/", "google.png", width: 1024
+
+# Specify an array of additional HTTP status codes to accept,
+# beyond normal success codes like 200 or 302
+ws.capture "http://www.google.com/foo", "google_404.png", allowed_status_codes: [404]
+
 # Customize thumbnail generation (MiniMagick)
 # see: https://github.com/minimagick/minimagick
 ws.capture("http://www.google.com/", "google.png") do |magick|
@@ -82,7 +89,7 @@ Recommended setup:
 
 
 The application triggers screenshot requests which are queued and
-then processed by a background worker (Resque, Sidkiq, etc).
+then processed by a background worker ([Resque](https://github.com/resque/resque), [Sidekiq](https://github.com/mperham/sidekiq), etc).
 The worker uploads the images to S3 which are served through
 CloudFront. The CDN should be configured to serve a default
 image (404 handler) with a low TTL to handle screenshot are not

data/lib/webshot.rb

@@ -27,7 +27,7 @@ module Webshot
     yield self
   end
 
-  # Capibara setup
+  # Capybara setup
   def self.capybara_setup!
     # By default Capybara will try to boot a rack application
     # automatically. You might want to switch off Capybara's

data/lib/webshot/screenshot.rb

@@ -14,7 +14,7 @@ module Webshot
       # Browser settings
       page.driver.resize(width, height)
       page.driver.headers = {
-        "User-Agent" => user_agent,
+        "User-Agent" => user_agent
       }
     end
 
@@ -25,6 +25,13 @@ module Webshot
       self
     end
 
+    def valid_status_code?(status_code, allowed_status_codes)
+      return true if status_code == 200
+      return true if status_code / 100 == 3
+      return true if allowed_status_codes.include?(status_code)
+      false
+    end
+
     # Captures a screenshot of +url+ saving it to +path+.
     def capture(url, path, opts = {})
       begin
@@ -33,6 +40,9 @@ module Webshot
         height  = opts.fetch(:height, 90)
         gravity = opts.fetch(:gravity, "north")
         quality = opts.fetch(:quality, 85)
+        full = opts.fetch(:full, true)
+        selector = opts.fetch(:selector, nil)
+        allowed_status_codes = opts.fetch(:allowed_status_codes, [])
 
         # Reset session before visiting url
         Capybara.reset_sessions! unless @session_started
@@ -45,36 +55,40 @@ module Webshot
         sleep opts[:timeout] if opts[:timeout]
 
         # Check response code
-        if page.driver.status_code.to_i == 200 || page.driver.status_code.to_i / 100 == 3
-          tmp = Tempfile.new(["webshot", ".png"])
-          tmp.close
-          begin
-            # Save screenshot to file
-            page.driver.save_screenshot(tmp.path, :full => true)
+        status_code = page.driver.status_code.to_i
+        unless valid_status_code?(status_code, allowed_status_codes)
+          fail WebshotError, "Could not fetch page: #{url.inspect}, error code: #{page.driver.status_code}"
+        end
 
-            # Resize screenshot
-            thumb = MiniMagick::Image.open(tmp.path)
-            if block_given?
-              # Customize MiniMagick options
-              yield thumb
-            else
-              thumb.combine_options do |c|
-                c.thumbnail "#{width}x"
-                c.background "white"
-                c.extent "#{width}x#{height}"
-                c.gravity gravity
-                c.quality quality
-              end
-            end
+        tmp = Tempfile.new(["webshot", ".png"])
+        tmp.close
+        begin
+          screenshot_opts = { full: full }
+          screenshot_opts = screenshot_opts.merge({ selector: selector }) if selector
 
-            # Save thumbnail
-            thumb.write path
-            thumb
-          ensure
-            tmp.unlink
+          # Save screenshot to file
+          page.driver.save_screenshot(tmp.path, screenshot_opts)
+
+          # Resize screenshot
+          thumb = MiniMagick::Image.open(tmp.path)
+          if block_given?
+            # Customize MiniMagick options
+            yield thumb
+          else
+            thumb.combine_options do |c|
+              c.thumbnail "#{width}x"
+              c.background "white"
+              c.extent "#{width}x#{height}"
+              c.gravity gravity
+              c.quality quality
+            end
           end
-        else
-          raise WebshotError.new("Could not fetch page: #{url.inspect}, error code: #{page.driver.status_code}")
+
+          # Save thumbnail
+          thumb.write path
+          thumb
+        ensure
+          tmp.unlink
         end
       rescue Capybara::Poltergeist::StatusFailError, Capybara::Poltergeist::BrowserError, Capybara::Poltergeist::DeadClient, Capybara::Poltergeist::TimeoutError, Errno::EPIPE => e
         # TODO: Handle Errno::EPIPE and Errno::ECONNRESET

data/lib/webshot/version.rb

@@ -1,3 +1,3 @@
 module Webshot
-  VERSION = '0.0.9'
+  VERSION = '0.1.2'
 end

data/test/webshot_test.rb

@@ -1,7 +1,6 @@
 require "test_helper"
 
-class WebshotTest < MiniTest::Unit::TestCase
-
+class WebshotTest < Minitest::Test
   DATA_DIR = File.expand_path(File.dirname(__FILE__) + "/data")
 
   def setup
@@ -12,18 +11,18 @@ class WebshotTest < MiniTest::Unit::TestCase
   def test_http
     %w(www.yahoo.com).each do |name|
       output = thumb(name)
-      File.delete output if File.exists? output
+      File.delete output if File.exist? output
       @webshot.capture "http://#{name}/", output
-      assert File.exists? output
+      assert File.exist? output
     end
   end
 
   def test_https
     %w(github.com).each do |name|
       output = thumb(name)
-      File.delete output if File.exists? output
+      File.delete output if File.exist? output
       @webshot.capture "https://#{name}/", output
-      assert File.exists? output
+      assert File.exist? output
     end
   end
 
@@ -38,7 +37,7 @@ class WebshotTest < MiniTest::Unit::TestCase
   def test_mini_magick
     %w(www.yahoo.com).each do |name|
       output = thumb(name)
-      File.delete output if File.exists? output
+      File.delete output if File.exist? output
 
       # Customize MiniMagick options
       result = @webshot.capture("http://#{name}/", output) do |thumb|
@@ -46,11 +45,21 @@ class WebshotTest < MiniTest::Unit::TestCase
           c.thumbnail "100x90"
         end
       end
-      assert File.exists? output
+      assert File.exist? output
       assert result.respond_to? :to_blob
     end
   end
 
+  def test_allowed_404_status
+    %w(en.wikipedia.org/wiki/THIS_PAGE_DOES_NOT_EXIST).each do |name|
+      output = thumb('404_example')
+      File.delete output if File.exist? output
+
+      @webshot.capture "https://#{name}/", output, allowed_status_codes: [404]
+      assert File.exist? output
+    end
+  end
+
   protected
 
   def thumb(name)

data/webshot.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "gem-release"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "minitest", "~> 5.14"
+  spec.add_development_dependency "gem-release", "~> 2.1"
+  spec.add_development_dependency "bump", "~> 0.9"
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "poltergeist", "~> 1.6.0"
-  spec.add_dependency "faye-websocket", "~> 0.7.3"
-  spec.add_dependency "mini_magick", "~> 4.3.3"
+  spec.add_dependency "activesupport", "~> 5"
+  spec.add_dependency "poltergeist", [">= 1.12.0", "<= 1.18.1"]
+  spec.add_dependency "faye-websocket", "~> 0.11.0"
+  spec.add_dependency "mini_magick", "~> 4.9"
 end

metadata

@@ -1,127 +1,133 @@
 --- !ruby/object:Gem::Specification
 name: webshot
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.2
 platform: ruby
 authors:
 - Vitalie Cherpec
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.12.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.18.1
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.3
+        version: '4.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.3
+        version: '4.9'
 description: Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS
 email:
 - vitalie@penguin.ro
@@ -147,7 +153,7 @@ homepage: https://github.com/vitalie/webshot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,9 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Captures a web page as a screenshot
 test_files: