photograph 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in photograph.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JH. Chabran
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007, Tammer Saleh, Thoughtbot, Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Photograph
+
+Photograph solves the issue of generating previews or thumbnails of
+web-based documents. Think of generating a preview of a Google
+Spreadsheet. As a such document is dom based, it may be difficult to get a preview
+that truly reflects the original content. 
+
+Photograph solves that problem by firing a chrome instance thanks to
+capybara-webkit and sinatra to provides an easy way to interface it to
+your needs. 
+
+Obviously, it supports cropping to avoid reworking the image afterward.
+
+Please remind that having a chrome instance, even if it is being reused
+by all requests is still taking some time, aroung 600ms after the first 
+request on my development machine. *Consider using photograph only if
+you expect the same exact rendering of your 'web documents'*.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'photograph'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install photograph
+
+## Usage
+
+Photograph can be used either directly through the Photograph::Artist
+class or by its little sinata app. 
+
+    @artist = Photograph::Artist.new("http://github.com")
+    @artist.shoot!
+
+    @artist.image
+    # => MiniMagick instance you can toy with
+
+Or 
+
+    $ bundle exec photograph -h 127.0.0.1 -p 4567
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+
+Photograph is maintained and funded by Tactilize.
+
+Contributors : 
+
+* Jean-Hadrien Chabran
+
+The names and logos for Tactilize are trademarks of Tactilize.
+
+## License
+
+Photograph is Copyright © 2012 Tactilize. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/config.ru

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'photograph'
+
+run Photograph::Service.new

data/bin/photograph

@@ -0,0 +1,26 @@
+#! /usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+
+require 'optparse'
+require 'thin'
+
+require 'photograph'
+
+options = {:port => 3001, :host => "127.0.0.1"}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage : photograph [options]"
+  
+  opts.on "-h", "--host HOST", "Listen on the specified host" do |host|
+    options[:host] = host
+  end
+  opts.on "-p", "--port PORT", "Listen on the specified port" do |port|
+    options[:port] = port.to_i
+  end
+end.parse!
+
+Thin::Server.start options[:host], options[:port] do
+  run Photograph::Service.new
+end

data/lib/photograph/artist.rb

@@ -0,0 +1,79 @@
+require 'capybara-webkit'
+require 'mini_magick'
+
+
+Capybara.default_wait_time = 5
+
+module Photograph
+  class Artist
+    attr_accessor :options
+    attr_reader :image
+
+    MissingUrlError = Class.new(Exception)
+    DefaultOptions  = {
+      :x => 0,          # top left position
+      :y => 0,
+      :w => 1280,       # bottom right position
+      :h => 1024,
+
+      :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
+    }
+
+    def self.browser
+      @browser ||= Capybara::Session.new :webkit
+    end
+
+    def browser
+      self.class.browser
+    end
+
+    def initialize options={}
+      raise MissingUrlError unless options[:url]
+
+      @options = DefaultOptions.merge(options)
+    end
+
+    def shoot!
+      @image = capture
+    end
+
+    def capture
+      browser.visit @options[:url]
+
+      if @options[:selector]
+        browser.wait_until do
+          browser.has_css? @options[:selector]
+        end
+      else
+        sleep @options[:wait]
+      end
+
+      @tempfile = Tempfile.new(['photograph','.png'])
+
+      browser.driver.render @tempfile.path,
+        :width  => options[:w] + options[:x],
+        :height => options[:h] + options[:y]
+
+      @image = adjust_image
+    end
+
+    def adjust_image
+      image = MiniMagick::Image.read @tempfile
+
+      if options[:h] && options[:w]
+        image.crop "#{options[:w]}x#{options[:h]}+#{options[:x]}+#{options[:y]}"
+
+        image.write @tempfile
+
+      end
+
+      image
+    end
+
+    def clean!
+      @tempfile.unlink
+    end
+  end
+end
+

data/lib/photograph/service.rb

@@ -0,0 +1,33 @@
+require 'sinatra/base'
+require 'sinatra/json'
+
+module Photograph
+  # Preload the chrome instance
+  Artist.browser
+
+  class Service < ::Sinatra::Base
+    helpers Sinatra::JSON
+
+    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"]
+
+      artist.shoot!
+
+      send_file artist.image.path,
+        :type => :png
+
+      artist.clean!
+    end
+  end
+end
+

data/lib/photograph/version.rb

@@ -0,0 +1,3 @@
+module Photograph
+  VERSION = "0.0.1"
+end

data/lib/photograph.rb

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

data/photograph.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/photograph/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["JH. Chabran"]
+  gem.email         = ["jh@chabran.fr"]
+  gem.description   = %q{Webservice that screenshots any url}
+  gem.summary       = %q{Webservice that screenshots any url}
+  gem.homepage      = "https://github.com/TactilizeTeam/photograph"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "photograph"
+  gem.require_paths = ["lib"]
+  gem.version       = Photograph::VERSION
+
+  gem.add_dependency 'capybara-webkit'
+  gem.add_dependency 'mini_magick'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'sinatra-contrib'
+  gem.add_dependency 'thin'
+
+  gem.add_development_dependency 'rspec', '~> 2.6'
+end

data/spec/photograph/artist_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Photograph
+  describe Artist do
+    URL = "http://rubygems.org"
+
+    it "should instanciate a new artist" do
+      Artist.new :url => URL
+    end
+
+    it "should raise an error without an url" do
+      expect { Artist.new }.should raise_error(Artist::MissingUrlError)
+    end
+
+    describe "Default size values" do
+      before(:each) { @artist = Artist.new :url => URL }
+
+      it "should have default values for x,y : 0,0" do
+        @artist.options[:x].should == 0
+        @artist.options[:y].should == 0
+      end
+
+      it"should have default values for h,w : 1280, 1024" do
+        @artist.options[:w].should == 1280
+        @artist.options[:h].should == 1024
+      end
+    end
+
+    describe "Cropping" do
+      before(:each) { @artist = Artist.new :url => URL }
+
+      it "should take a screenshot large enough to crop later" do
+        pending
+
+        @artist = Artist.new :url => URL, :x => 200, :y => 100, :h => 400, :w => 400
+
+        Artist.browser.driver.stub :render
+
+        @artist.shoot!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'photograph'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: photograph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- JH. Chabran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Webservice that screenshots any url
+email:
+- jh@chabran.fr
+executables:
+- config.ru
+- photograph
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/config.ru
+- 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/TactilizeTeam/photograph
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4589063138671751824
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4589063138671751824
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Webservice that screenshots any url
+test_files:
+- spec/photograph/artist_spec.rb
+- spec/spec_helper.rb