photograph 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea0a5dcbf3a353549a0009a793780daeeed56e2a
-  data.tar.gz: 648222a1f1475cc98c87c7ae1ab2efd67204cc1c
+  metadata.gz: 57e2e388307ebd1a8b4f5778ddacc96ae7e775a1
+  data.tar.gz: 0c524964148c4cdcfb53422bd294eb6743f58f6f
 SHA512:
-  metadata.gz: f54b2bbc8a8fb484674a6b646458dfd690da18c670b8f2244473bcdaa292e23420c940f93b752c84e525223c5a69ac2d7790765d6626763067d8f267fc6bf871
-  data.tar.gz: 091f1490bd3c72f2a2bd243c2dc2a734ee68fc3f563ab1e8c8c4f96556786cee5e3513c249bf4354b7b59e6b293c6324e302c3b4082df7c3c5104bd2d371fc65
+  metadata.gz: 6a69d29af237a5728510ded57476604fe5ef7f3b9235bb2dccb36975b63919d48a4ff763222843a8ef7b33fe916b7a45e8308018b6e0cb42f6f909b9a264e670
+  data.tar.gz: af29eb62cc97c3939be416510b6cb29ceed71c62d2fd08deb8acdbf2fcf04ca7a09b4b15de8b4ecaafc21216c96839fbe3b4a3c7a1f4eb48d863a4b51313ebcf

data/.gitignore

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+vendor/bundle
 test/tmp
 test/version_tmp
 tmp

data/README.md

@@ -1,17 +1,18 @@
 # Photograph
 
 Photograph allows to take screenshots of webpages, the rendering being
-done by Chrome.
+done by webkit thanks to [PhantomJS](http://phantomjs.org/) and [Poltergeist](https://github.com/jonleighton/poltergeist).
 
-Typically, this can be used to generate screenshots for DOM based
+Typically, this can be used to generate previews for DOM based
 documents.
 
-Please remind that having a chrome instance doing the rendering, even if it is launched only once,
-is slow, around 600ms.
+Please remind that having a webkit instance doing the rendering, even if it is launched only once then reused, is slow, around 600ms!
 
 ## Installation
 
-Add this line to your application's Gemfile:
+PhantomJS is required and must be available in your path. See [installation instructions](http://phantomjs.org/download.html).
+
+Then you can add this line to your application's Gemfile:
 
     gem 'photograph'
 
@@ -24,24 +25,54 @@ Or install it yourself as:
     $ gem install photograph
 
 ## Usage
+Photograph can be used either directly through the Photograph::Artist
+class or by its little Sinatra app.
 
+### Basics
 **Using `Artist.shoot!` without a block had been deprecated in 0.3 and
 will raise an exception.**
 
-Photograph can be used either directly through the Photograph::Artist
-class or by its little sinatra app. 
+Artist can be instanciated with an url to screenshot, calling ``#shoot!`` will take the screenshot and yields it. The screenshot is only accessible within the block as it is always deleted afterward.
 
     @artist = Photograph::Artist.new(:url => "http://github.com")
     @artist.shoot! do |image|
       image # => MiniMagick instance you can toy with
 
-      send_file image.path,
-        :type => :png
+      # Sinatra? Serve screenshot to client with:
+      send_file image.path, :type => :png
+
+      # Jobs or Rake task ? Export screenshot with:
+      FileUtils.cp(image.path, "/somewhere/image.png")
     end
 
-Or 
+### Cropping
+To crop the screenshot, ``Artist.new`` accepts ``:x``, ``y``, ``w`` and ``h`` options:
+
+    @artist = Photograph::Artist.new(:url => "http://github.com", :x => 100, :y => 100, :w => 800, :h => 600)
+
+This will take a 800x600 screenshot, skipping 100 pixels top and left.
+
+### Interacting with the page before shooting
+If authentication is required (or any browser action), ``Artist#before`` allows to supply actions to be done before shooting. It yields a ``Capybara`` browser instance that respond to the usual methods, ``fill_in``, ``click_link`` [see for more details](https://github.com/jonleighton/poltergeist).
+
+    @artist = Photograph::Artist.new(:url => "http://rubygems.org")
+    @artist.before do |browser|
+      browser.click_button("Sign in")
+      browser.fill_in("Username", :with => "MyUsername")
+      # ...
+    end
+
+    @artist.shoot! do |image|
+      send_file image, :type => :png
+    end
+
+### RDOC
+
+[Full Documentation](http://rdoc.info/gems/photograph/frames)
+
+### As a web service
 
-    $ bundle exec photograph -h 127.0.0.1 -p 4567
+As having the web service builtin requires Sinatra and Thin, it had been extracted to [Photograph-Service](https://github.com/jhchabran/photograph-service).
 
 ## Contributing
 

data/lib/photograph.rb

@@ -1,6 +1,5 @@
 require "photograph/version"
 require 'photograph/artist'
-require 'photograph/service'
 
 module Photograph
 end

data/lib/photograph/artist.rb

@@ -1,8 +1,6 @@
 require 'capybara/poltergeist'
 require 'mini_magick'
 
-Capybara.default_wait_time = 15
-
 module Photograph
   class Artist
     attr_accessor :options
@@ -12,14 +10,15 @@ module Photograph
     class DeprecationError < RuntimeError;  end
 
     DefaultOptions  = {
-      :x => 0,          # top left position
-      :y => 0,
-      :w => 1280,       # width
-      :h => 1024,       # height
+                       :x => 0,          # top left position
+                       :y => 0,
+                       :w => 1280,       # width
+                       :h => 1024,       # height
 
-      :wait => 0.5,     # if selector is nil, wait 1 seconds before taking the screenshot
-      :selector => nil  # wait until the selector matches to take the screenshot
-    }
+                       :sleep => 0.5,    # Sleep 0.5 seconds before taking the screenshot
+                       :capybara_wait_time => 15, # Default Capybara wait time
+                       :selector => nil  # wait until the selector matches to take the screenshot
+                      }
 
     ##
     # Instanciate a browser instance.
@@ -56,8 +55,9 @@ module Photograph
     #
     # Options:
     # * +url+ mandatory, location you want to screenshot
-    # * +wait+ wait amount of seconds before screenshotting. *this is option is ignored if +selector+ is provided.
+    # * +sleep+ sleep amount of seconds before screenshotting. *this is option is ignored if +selector+ is provided.
     # * +selector+ wait until the provided +selector+ matches a dom node before screenshotting. Typically faster than an arbritrary +wait+ amount, used when your page has some dynamically inserted nodes.
+    # * +capybara_wait_time+ time capybara will wait for a a selector to appear before timing out
     # * +x+ top coordinate of the screenshot, default to 0
     # * +y+ left coordinate of the screenshot, default to 0
     # * +w+ width of the screenshot, default to 1280
@@ -65,6 +65,9 @@ module Photograph
     # * +browser+ Capybara instance to use, typically instanciated by +Artist.create_browser+
     def initialize options={}
       raise MissingUrlError.new('missing argument :url') unless options[:url]
+      if options[:wait]
+        $stderr.puts "DEPRECATED: the :wait option had been deprecated and will be ignored in further version, please use :sleep instead."
+      end
 
       @options = DefaultOptions.merge(options)
       @options[:url] = normalize_url(options[:url])
@@ -75,27 +78,31 @@ module Photograph
     def shoot! &block
       raise DeprecationError.new('Using Artist#shoot! without a block had been deprecated') unless block_given?
 
-      browser.visit @options[:url]
+      Capybara.using_wait_time @options[:capybara_wait_time] do
+        begin
+          browser.visit @options[:url]
 
-      @before_hook.call(browser) if @before_hook
+          @before_hook.call(browser) if @before_hook
 
-      if @options[:selector]
-        browser.wait_until do
-          browser.has_css? @options[:selector]
-        end
-      else
-        sleep @options[:wait]
-      end
+          if @options[:selector]
+            browser.wait_until do
+              browser.has_css? @options[:selector]
+            end
+          else
+            sleep @options[:sleep]
+          end
 
-      tempfile = Tempfile.new(['photograph','.png'])
+          tempfile = Tempfile.new(['photograph','.png'])
 
-      browser.driver.render tempfile.path,
-        :width  => options[:w] + options[:x],
-        :height => options[:h] + options[:y]
+          browser.driver.render tempfile.path,
+            :width  => options[:w] + options[:x],
+            :height => options[:h] + options[:y]
 
-      yield adjust_image(tempfile)
-    ensure
-      tempfile.unlink if tempfile
+          yield adjust_image(tempfile)
+        ensure
+          tempfile.unlink if tempfile
+        end
+      end
     end
 
     ##

data/lib/photograph/version.rb

@@ -1,3 +1,3 @@
 module Photograph
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/photograph.gemspec

@@ -2,11 +2,12 @@
 require File.expand_path('../lib/photograph/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["JH. Chabran"]
+  gem.authors       = ["Jean Hadrien Chabran"]
   gem.email         = ["jh@chabran.fr"]
-  gem.description   = %q{Webservice that screenshots any url}
-  gem.summary       = %q{Webservice that screenshots any url}
+  gem.description   = %q{Small library to take screenshots of web pages}
+  gem.summary       = %q{Small library to take screenshots of web pages}
   gem.homepage      = "https://github.com/jhchabran/photograph"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -17,12 +18,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'poltergeist'
   gem.add_dependency 'mini_magick'
-  gem.add_dependency 'sinatra'
-  gem.add_dependency 'sinatra-contrib'
-  gem.add_dependency 'thin'
 
   gem.add_development_dependency 'rspec', '~> 2.14'
   gem.add_development_dependency 'rake'
 
-  gem.post_install_message = 'DEPRECATION: Artist#shoot! cannot be used without a block anymore. Please check your code, thank you.'
+  gem.post_install_message = 'DEPRECATION: Photograph::Artist#new :wait option had been renamed to :sleep. :wait will be ignored in the next version.'
 end

data/spec/photograph/artist_spec.rb

@@ -43,6 +43,11 @@ module Photograph
         end
       end
 
+      it 'should locally set capybara default time' do
+        subject.shoot!{ expect(Capybara.default_wait_time).to eq(15) }
+        expect(Capybara.default_wait_time).to eq(2)
+      end
+
       it('should accept a block when shooting') do
         subject.shoot!{|image| image.should respond_to(:path) }
       end

metadata

@@ -1,114 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: photograph
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
-- JH. Chabran
+- Jean Hadrien Chabran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-28 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra-contrib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: thin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   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: Webservice that screenshots any url
+description: Small library to take screenshots of web pages
 email:
 - jh@chabran.fr
 executables:
@@ -117,7 +75,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - MIT-LICENSE
@@ -127,35 +85,35 @@ files:
 - bin/photograph
 - lib/photograph.rb
 - lib/photograph/artist.rb
-- lib/photograph/service.rb
 - lib/photograph/version.rb
 - photograph.gemspec
 - spec/photograph/artist_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jhchabran/photograph
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 'DEPRECATION: Artist#shoot! cannot be used without a block anymore.
-  Please check your code, thank you.'
+post_install_message: 'DEPRECATION: Photograph::Artist#new :wait option had been renamed
+  to :sleep. :wait will be ignored in the next version.'
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Webservice that screenshots any url
+summary: Small library to take screenshots of web pages
 test_files:
 - spec/photograph/artist_spec.rb
 - spec/spec_helper.rb

data/lib/photograph/service.rb

@@ -1,34 +0,0 @@
-require 'sinatra/base'
-require 'sinatra/json'
-
-module Photograph
-  class Service < ::Sinatra::Base
-    helpers Sinatra::JSON
-
-    # Reuse the same browser instance between requests.
-    def browser
-      @browser ||= Artist.create_browser
-    end
-
-    get '/' do
-      json :version => Photograph::VERSION
-    end
-
-    get '/shoot' do
-      artist = Artist.new :url => params["url"],
-                          :x   => params["x"].to_i,
-                          :y   => params["y"].to_i,
-                          :w   => params["w"].to_i,
-                          :h   => params["h"].to_i,
-                          :wait => params["wait"].to_f,
-                          :selector => params["selector"],
-                          :browser => browser
-
-      artist.shoot! do |image|
-        send_file image.path,
-          :type => :png
-      end
-    end
-  end
-end
-