RubyGems - imgkit - Versions diffs - 1.3.6 → 1.3.7 - Mend

imgkit 1.3.6 → 1.3.7

Files changed (7) hide show

data/Gemfile CHANGED

@@ -1,5 +1,7 @@
 source :rubygems
+gemspec
 group :test do
   gem "rake"
   gem "rspec", "~> 2"

data/Gemfile.lock CHANGED

@@ -1,3 +1,8 @@
+PATH
+  remote: .
+  specs:
+    imgkit (1.3.7)
 GEM
   remote: http://rubygems.org/
   specs:
@@ -40,6 +45,7 @@ PLATFORMS
   ruby
 DEPENDENCIES
+  imgkit!
   mocha
   rack
   rake

data/README.md CHANGED

@@ -12,24 +12,24 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     gem install imgkit
 ### wkhtmltoimage
- * **Automatic**: `sudo imgkit --install-wkhtmltoimage`
- install latest version into /usr/local/bin
+ * **Automatic**: `sudo imgkit --install-wkhtmltoimage`
+ install latest version into /usr/local/bin
  (overwrite defaults with e.g. ARCHITECTURE=amd64 TO=/home/foo/bin)
  * By hand: http://code.google.com/p/wkhtmltopdf/downloads/list
 ## Usage
     # IMGKit.new takes the HTML and any options for wkhtmltoimage
     # run `wkhtmltoimage --extended-help` for a full list of options
     kit = IMGKit.new(html, :quality => 50)
     kit.stylesheets << '/path/to/css/file'
     # Get the image BLOB
     img = kit.to_img
     # New in 1.3!
     img = kit.to_img(:jpg)      #default
-    img = kit.to_img(:jpeg)
+    img = kit.to_img(:jpeg)
     img = kit.to_img(:png)
     img = kit.to_img(:tif)
     img = kit.to_img(:tiff)
@@ -37,7 +37,7 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     # Save the image to a file
     file = kit.to_file('/path/to/save/file.jpg')
     file = kit.to_file('/path/to/save/file.png')
     # IMGKit.new can optionally accept a URL or a File.
     # Stylesheets can not be added when source is provided as a URL of File.
     kit = IMGKit.new('http://google.com')
@@ -47,12 +47,14 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     IMGKit.new('<html><head><meta name="imgkit-quality" content="75"...
     # Format shortcuts - New in 1.3!
-    IMGKit.new("hello").to_jpg
-    IMGKit.new("hello").to_jpeg
-    IMGKit.new("hello").to_png
-    IMGKit.new("hello").to_tif
-    IMGKit.new("hello").to_tiff
+    IMGKit.new("hello").to_jpg
+    IMGKit.new("hello").to_jpeg
+    IMGKit.new("hello").to_png
+    IMGKit.new("hello").to_tif
+    IMGKit.new("hello").to_tiff
+    Note: Ruby's buffered I/O means that if you want to write the string data to a file or tempfile make sure to call `#flush` to ensure the contents don't get stuck in the buffer.
 ## Configuration
 If you're on Windows or you installed wkhtmltoimage by hand to a location other than /usr/local/bin you will need to tell IMGKit where the binary is. You can configure IMGKit like so:
@@ -68,10 +70,14 @@ If you're on Windows or you installed wkhtmltoimage by hand to a location other
 ## Heroku
-get a version of `wkhtmltoimage` as an amd64 binary and commit it
+get a version of `wkhtmltoimage` as an amd64 binary and commit it
 to your git repo.  I like to put mine in "./bin/wkhtmltoimage-amd64"
-assuming its in that location you can just do:
+<a href="http://code.google.com/p/wkhtmltopdf/downloads/detail?name=wkhtmltoimage-0.10.0_rc2-static-amd64.tar.bz2&can=1&q=amd64">
+version 0.10.0 has worked best for me
+</a>
+assuming its in that location you can just do:
     IMGKit.configure do |config|
       config.wkhtmltoimage = Rails.root.join('bin', 'wkhtmltoimage-amd64').to_s if ENV['RACK_ENV'] == 'production'
@@ -80,15 +86,15 @@ assuming its in that location you can just do:
 If you're not using Rails just replace Rails.root with the root dir of your app.
-## Rails
+## Rails
 ### Mime Types
-register a .jpg mime type in:
+register a .jpg mime type in:
     #config/initializers/mime_type.rb
     Mime::Type.register       "image/jpeg", :jpg
-register a .png mime type in:
+register a .png mime type in:
     #config/initializers/mime_type.rb
     Mime::Type.register       "image/png", :png
@@ -111,7 +117,7 @@ You can respond in a controller with:
     - or -
     respond_to do |format|
-      send_data(@kit.to_img(format.to_sym),
+      send_data(@kit.to_img(format.to_sym),
                 :type => "image/png", :disposition => 'inline')
     end
@@ -143,6 +149,38 @@ To overcome the lack of support for --user-style-sheet option by wkhtmltoimage 0
       kit.stylesheets << css
+## Paperclip Example
+Model:
+```ruby
+class Model < ActiveRecord::Base
+  # attr_accessible :title, :body
+   has_attached_file :snapshot, :storage => :s3,
+        :s3_credentials => "#{Rails.root}/config/s3.yml"
+end
+```
+Controller:
+```ruby
+def upload_image
+   model = Model.find(params[:id])
+   html  = render_to_string
+   kit   = IMGKit.new(html)
+   img   = kit.to_img(:png)
+   file  = Tempfile.new(["template_#{model.id}", 'png'], 'tmp',
+                         :encoding => 'ascii-8bit')
+   file.write(img)
+   file.flush
+   model.snapshot = file
+   model.save
+   file.unlink
+end
+```
 ## CarrierWave Workaround
 Contributed by @ticktricktrack
@@ -158,16 +196,17 @@ Contributed by @ticktricktrack
     def take_snapshot
       file = Tempfile.new(["template_#{self.id.to_s}", 'jpg'], 'tmp', :encoding => 'ascii-8bit')
       file.write(IMGKit.new(self.html_body, quality: 50, width: 600).to_jpg)
+      file.flush
       self.snapshot = file
-      file.unlink
       self.save
+      file.unlink
     end
   end
 ```
 ## Note on Patches/Pull Requests
 * Fork the project.
 * Setup your development environment with: gem install bundler; bundle install
 * Make your feature addition or bug fix.
@@ -180,5 +219,5 @@ Contributed by @ticktricktrack
 ## Copyright
 Copyright (c) 2010 <a href="mailto:christopher.continanza@gmail.com">Chris Continanza</a>
-Based on work by Jared Pace
+Based on work by Jared Pace
 See LICENSE for details.

data/bin/imgkit CHANGED

@@ -51,17 +51,17 @@ end
 def install(download, arch, install_to)
   puts "Installing #{download} to #{install_to}"
   if download =~ /.tar.bz2$/
-    `sudo tar xjvf #{download}`
-    `sudo mv wkhtmltoimage-#{arch} #{install_to}`
+    `tar xjvf #{download}`
+    `mv wkhtmltoimage #{install_to}`
   elsif download =~ /.tar.lzma$/
     raise "couldn't extract archive: lzcat not found" unless system("which lzcat > /dev/null 2>/dev/null")
     puts "Warning: lzcat is broken on Ubuntu. Re-run with --use-bzip to install alternate version"
-    `sudo lzcat #{download} | tar x`
-    `sudo mv wkhtmltoimage-#{arch} #{install_to}`
+    `lzcat #{download} | tar x`
+    `mv wkhtmltoimage-#{arch} #{install_to}`
   else
-    `sudo mv #{download} #{install_to}`
+    `mv #{download} #{install_to}`
   end
-  `sudo chmod +x #{install_to}`
+  `chmod +x #{install_to}`
 end
 @command = Proc.new { puts "Nothing to do: use --help"}
@@ -76,7 +76,7 @@ OptionParser.new do |parser|
   parser.on("--install-wkhtmltoimage", "Install wkhtmltoimage binaries (TO=/usr/local/bin ARCHITECTURE=i386)") do
     @command = Proc.new do
       architecture = ENV['ARCHITECTURE'] || detect_architecture
-      install_to = ENV['TO']+'/wkhtmltoimage' || IMGKit.configuration.wkhtmltoimage
+      install_to = ENV['TO'] ? ENV['TO']+'/wkhtmltoimage' : IMGKit.configuration.wkhtmltoimage
       Dir.chdir '/tmp'

data/lib/imgkit/version.rb CHANGED

@@ -1,3 +1,3 @@
 class IMGKit
-  VERSION = "1.3.6"
+  VERSION = "1.3.7"
 end

data/spec/imgkit_spec.rb CHANGED

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'spec_helper'
 describe IMGKit do
   context "initialization" do
@@ -7,37 +7,37 @@ describe IMGKit do
       imgkit.source.should be_html
       imgkit.source.to_s.should == '<h1>Oh Hai</h1>'
     end
     it "should accept a URL as the source" do
       imgkit = IMGKit.new('http://google.com')
       imgkit.source.should be_url
       imgkit.source.to_s.should == 'http://google.com'
     end
     it "should accept a File as the source" do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       imgkit = IMGKit.new(File.new(file_path))
       imgkit.source.should be_file
       imgkit.source.to_s.should == file_path
     end
     it "should provide no default options" do
       imgkit = IMGKit.new('<h1>Oh Hai</h1>')
       imgkit.options.should be_empty
     end
 =begin
     it "should default to 'UTF-8' encoding" do
       imgkit = IMGKit.new('Captación')
     end
 =end
     it "should not have any stylesheet by default" do
       imgkit = IMGKit.new('<h1>Oh Hai</h1>')
       imgkit.stylesheets.should be_empty
     end
   end
   context "command" do
     it "should contstruct the correct command" do
       imgkit = IMGKit.new('html')
@@ -49,7 +49,7 @@ describe IMGKit do
       imgkit = IMGKit.new('html', :quality => 75)
       imgkit.command.should include('--quality')
     end
     it "will not include default options it is told to omit" do
       imgkit = IMGKit.new('html')
       imgkit = IMGKit.new('html', :disable_smart_shrinking => false)
@@ -65,17 +65,17 @@ describe IMGKit do
       imgkit.command[imgkit.command.index('--custom-header') + 1].should == 'User-Agent'
       imgkit.command[imgkit.command.index('--custom-header') + 2].should == 'some user agent'
     end
     it "read the source from stdin if it is html" do
       imgkit = IMGKit.new('html')
       imgkit.command[-2..-1].should == ['-', '-']
     end
     it "specify the URL to the source if it is a url" do
       imgkit = IMGKit.new('http://google.com')
       imgkit.command[-2..-1].should == ['http://google.com', '-']
     end
     it "should specify the path to the source if it is a file" do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       imgkit = IMGKit.new(File.new(file_path))
@@ -88,19 +88,21 @@ describe IMGKit do
           <head>
             <meta name="imgkit-page_size" content="Legal"/>
             <meta name="imgkit-orientation" content="Landscape"/>
+            <meta name="imgkit-crop-h" content="900"/>
           </head>
         </html>
       }
       imgkit = IMGKit.new(body)
       imgkit.command[imgkit.command.index('--page-size') + 1].should == 'Legal'
       imgkit.command[imgkit.command.index('--orientation') + 1].should == 'Landscape'
+      imgkit.command[imgkit.command.index('--crop-h') + 1].should == '900'
     end
   end
   context "#to_img(format = nil)" do
-    def filetype_of(img)
+    def filetype_of(img)
       result = nil
-      tmpfile = Tempfile.new('imgkit')
+      tmpfile = Tempfile.new('imgkit')
       File.open(tmpfile.path, 'w') { |f| f << img }
       result = `file #{tmpfile.path}`
       tmpfile.unlink()
@@ -112,13 +114,13 @@ describe IMGKit do
       img = imgkit.to_img
       filetype_of(img).should include('JPEG')
     end
     it "should generate an Image with a numerical parameter" do
       imgkit = IMGKit.new('html', :quality => 50)
       img = imgkit.to_img
       filetype_of(img).should include('JPEG')
     end
     it "should generate an Image with a symbol parameter" do
       imgkit = IMGKit.new('html', :username => 'chris')
       img = imgkit.to_img
@@ -148,7 +150,7 @@ describe IMGKit do
       imgkit.to_img
       imgkit.source.to_s.should include("<style>#{File.read(css)}</style><html>")
     end
     it "should throw an error if the source is not html and stylesheets have been added" do
       imgkit = IMGKit.new('http://google.com')
       css = File.join(SPEC_ROOT,'fixtures','example.css')
@@ -233,17 +235,17 @@ describe IMGKit do
       lambda { IMGKit.new("Hello, world").to_blah }.should raise_error(IMGKit::UnknownFormatError)
     end
   end
   context "#to_file" do
     before do
       @file_path = File.join(SPEC_ROOT,'fixtures','test.jpg')
       File.delete(@file_path) if File.exist?(@file_path)
     end
     after do
       File.delete(@file_path) if File.exist?(@file_path)
     end
     it "should create a file with the result of :to_img  as content" do
       imgkit = IMGKit.new('html', :quality => 50)
       imgkit.expects(:to_img).returns('CONTENT')
@@ -264,28 +266,28 @@ describe IMGKit do
     it "should raise UnknownFormatError when format is unknown" do
       kit = IMGKit.new("html")
-      lambda {
-        kit.to_file("file.bad_format")
+      lambda {
+        kit.to_file("file.bad_format")
       }.should raise_error(IMGKit::UnknownFormatError)
     end
     it "should not create the file if format is unknown" do
       kit = IMGKit.new("html")
-      kit.to_file("file.bad_format") rescue nil
+      kit.to_file("file.bad_format") rescue nil
       File.exist?("file.bad_format").should be_false
     end
   end
   context "security" do
     before do
       @test_path = File.join(SPEC_ROOT,'fixtures','security-oops')
       File.delete(@test_path) if File.exist?(@test_path)
     end
     after do
       File.delete(@test_path) if File.exist?(@test_path)
     end
     it "should not allow shell injection in options" do
       imgkit = IMGKit.new('html', :password => "blah\"; touch #{@test_path} #")
       imgkit.to_img

metadata CHANGED

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: imgkit
-version: !ruby/object:Gem::Version
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.3.7
   prerelease:
-  segments:
-  - 1
-  - 3
-  - 6
-  version: 1.3.6
 platform: ruby
-authors:
+authors:
 - csquared
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-03-24 00:00:00 -07:00
-default_executable:
+date: 2012-09-19 00:00:00.000000000Z
 dependencies: []
 description: Uses wkhtmltoimage to create Images using HTML
 email: christopher.continanza@gmail.com
-executables:
+executables:
 - imgkit
 extensions: []
 extra_rdoc_files: []
-files:
+files:
 - .document
 - .gitignore
 - .rspec
@@ -52,54 +42,42 @@ files:
 - spec/source_spec.rb
 - spec/spec_helper.rb
 - spec/warning_binary
-has_rdoc: true
 homepage: http://rubygems.org/gems/imgkit
 licenses: []
-post_install_message: |
-  ******************************************************************
-  Now install wkhtmltoimage binaries:
-  Global: sudo `which imgkit` --install-wkhtmltoimage
-          rvmsudo imgkit --install-wkhtmltoimage
-  (installs to default /usr/local/bin/wkhtmltoimage)
-  inside RVM folder: export TO=`which imgkit | sed 's:/imgkit:/wkhtmltoimage:'` && imgkit --install-wkhtmltoimage
-  (you'll have to configure the location of the binary if you do this!)
-  (run imgkit --help to see more options)
-  ******************************************************************
+post_install_message: ! "******************************************************************\n\nNow
+  install wkhtmltoimage binaries:\nGlobal: sudo `which imgkit` --install-wkhtmltoimage\n
+  \       rvmsudo imgkit --install-wkhtmltoimage\n(installs to default /usr/local/bin/wkhtmltoimage)\n\ninside
+  RVM folder: export TO=`which imgkit | sed 's:/imgkit:/wkhtmltoimage:'` && imgkit
+  --install-wkhtmltoimage\n(you'll have to configure the location of the binary if
+  you do this!)\n\n(run imgkit --help to see more options)\n******************************************************************\n"
 rdoc_options: []
-require_paths:
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      hash: 3
-      segments:
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement
+      hash: -4046794491537096375
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      hash: 3
-      segments:
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -4046794491537096375
 requirements: []
 rubyforge_project: imgkit
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key:
 specification_version: 3
 summary: HTML+CSS -> JPG
-test_files:
+test_files:
 - spec/error_binary
 - spec/fixtures/example.css
 - spec/fixtures/example.html