url2png 0.1.2 → 0.2.0

data/Gemfile

@@ -7,7 +7,7 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.6.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
+  gem "bundler", "~> 1.1.3"
+  gem "jeweler", "~> 1.8.3"
   gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -3,11 +3,11 @@ GEM
   specs:
     diff-lcs (1.1.2)
     git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
+    rake (0.9.2.2)
     rcov (0.9.9)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
@@ -22,7 +22,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  bundler (~> 1.1.3)
+  jeweler (~> 1.8.3)
   rcov
   rspec (~> 2.6.0)

data/README.markdown

@@ -17,13 +17,25 @@ Any Ruby on Rails developer who wants/needs to generate screenshots from sites u
 
 First define your public key and shared secret:
 
-    Url2png::Config.public_key = 'PXXXXXXXXXXXXX'
-    Url2png::Config.shared_secret = 'SXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+    Url2png.api_key = 'PXXXXXXXXXXXXX'
+    Url2png.privat_key = 'SXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
 
+##### version
+You can define the api version if you want to use an older version of the url2png api. 
+	
+	Url2png.api_version = "v4"
+
+Available versions:
+
+* v6 (default)
+* v4
+
+
+##### mode
 If you are generating local urls in development you can use a placeholder or dummy image.
 This is done by setting the mode:
 
-    Url2png::Config.mode = :placehold if Rails.env.development?
+    Url2png.mode = :placehold if Rails.env.development?
 
 Options are:
 
@@ -40,7 +52,52 @@ Generate an image tag:
 
     site_image_tag url, [options]
 
-Options are the same as the image_tag in Rails.
+
+Options differ by version!
+
+
+### Version 6
+
+##### Thumbnail
+Constrain screenshot based on width or height or both.<br>
+default: no resizing
+		
+	= site_image_tag 'http://www.zwartopwit.com', :thumbnail_max_width => 500, :thumbnail_max_height => 500
+	
+
+##### Viewport
+Set viewport dimensions, adjust to your hearts content.<br>
+default: 1480x1037
+	
+	= site_image_tag 'http://www.zwartopwit.com', :viewport => "1024x900"
+
+
+##### Fullpage
+Will attempt to capture entire document canvas.<br>
+default: false
+	
+	= site_image_tag 'http://www.zwartopwit.com', :fullpage => true
+	
+
+##### Delay
+Extra delay (in seconds) forced between page load and screenshot.<br>
+default: 1<br>
+min: 1<br>
+max: 5<br>
+
+example:
+		
+	site_image_tag url, :size => '300x200', :delay => 2
+	
+	
+##### Force
+Forces a fresh screenshot with each request, overwriting the previous copy.<br>
+**You will be charged for every request made using the force option.**
+	
+	= site_image_tag 'http://www.zwartopwit.com', :force => true
+
+	
+### Version 4
 
 By default the size is set to 400 x 400 px.
 To generate an image with a specific size:
@@ -53,52 +110,45 @@ To only get the image url:
 
 Options are:
 
-**:size**<br>
-  This is a proportion bounding box.<br>
-  Thumbnails will be resized to fit within this box.<br>
-  default: 'ORIGINAL'<br>
-  examples:
+##### Size
+This is a proportion bounding box.<br>
+Thumbnails will be resized to fit within this box.<br>
+default: 'ORIGINAL'<br>
+examples:
 
     site_image_tag url, :size => '500x500'
 
     site_image_tag url, :size => 'ORIGINAL'
 
-**:thumbnail** (alias for :size)
+##### Thumbnail (alias for :size)
 
-**:browser_size**<br>
-  Set the initial browser screen size.<br>
-  default: '1024x768'<br>
-  min: '200x200'<br>
-  max: '4000x4000'<br>
-  example:
+##### Browser size
+Set the initial browser screen size.<br>
+default: '1024x768'<br>
+min: '200x200'<br>
+max: '4000x4000'<br>
+example:
     
     site_image_tag url, :size => '300x200', :browser_size => '1024x2500'
 
-**:delay**<br>
-  Extra delay (in seconds) forced between page load and screenshot.<br>
-  default: 1<br>
-  min: 1<br>
-  max: 5<br>
-  example:
+##### Delay
+Extra delay (in seconds) forced between page load and screenshot.<br>
+default: 1<br>
+min: 1<br>
+max: 5<br>
+example:
 
-    site_image_tag url, :size => '300x200', :delay => 2
-
-**:fullscreen**<br>
-  When true, Will attempt to capture entire document canvas.<br>
-  Will never return screenshot smaller than "Initial Screen Size".<br>
-  default: false<br>
-  example:
-
-    site_image_tag url, :size => '300x200', :fullscreen => true
+	site_image_tag url, :size => '300x200', :delay => 2
 
+##### Fullscreen
+When true, Will attempt to capture entire document canvas.<br>
+Will never return screenshot smaller than "Initial Screen Size".<br>
+default: false<br>
 
-Original API docs: https://url2png.com/doc/
-
+example:
 
+    site_image_tag url, :size => '300x200', :fullscreen => true
 
-### API Version
-From version 0.1.0 and up this gem is using version 4 of the url2png API.<br>
-Version 0.0.7 is the last one using version 3 of the API.
 
 
 ## Important
@@ -119,6 +169,12 @@ Note that this gem is still under development.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+Original API docs: 
+
+* v4: https://url2png.com/doc/
+* v6: http://staging.url2png.com/docs/v6.php
+
+
 ## Copyright
 
 Copyright (c) 2011 Wout Fierens. See LICENSE.txt for

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{A ruby gem wrapping the url2png.com screenshot service API}
   gem.description = %Q{Generate screenshots from websites almost instantly at any preferred size using ruby and the url2png.com API}
   gem.email = "wout@impinc.co.uk"
-  gem.authors = ["wout fierens", "fuzzyalej", "ceritium", "lukemelia"]
+  gem.authors = ["wout fierens", "fuzzyalej", "ceritium", "lukemelia", "robinhoudmeyers"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/url2png.rb

@@ -1,5 +1,5 @@
-require 'uri'
 require 'digest'
+require 'cgi' unless defined?(CGI)
 
 require 'url2png/config'
 require 'url2png/rails'

data/lib/url2png/config.rb

@@ -1,59 +1,53 @@
 module Url2png
+  extend self
   
-  module Config
-    
-    # modes
-    MODES = %w{production placehold dummy}
-    
-    def self.mode= mode
-      raise "Url2png error: Invalid mode, only #{ MODES.join(', ') } are allowed" unless MODES.include?(mode.to_s)
-      @url2png_mode ||= mode.to_s
-    end
-    
-    def self.mode
-      @url2png_mode ||= 'production'
-    end
+  # modes
+  MODES = %w{production placehold dummy}
+  
+  def config c = {}
+    # SET
+    #   api_key
+    #   private_key
+    #   mode        (production[default] placehold dummy)
+    #   version     (v6[default])
     
-    # api settings
-    def self.api_url protocol
-      @url2png_url ||= "#{ protocol }api.url2png.com"
-    end
-
-    def self.api_version
-      @url2png_version ||= 'v4'
-    end
-
-    # public key setter and getter
-    def self.public_key= key
-      raise 'Url2png error: Invalid public key!' unless key.match(/^P/)
-      @url2png_key ||= key
-    end
-
-    def self.public_key
-      raise 'Url2png error: No public key defined!' if @url2png_key.nil?
-      @url2png_key
-    end
-
-    # shared secret setter and getter
-    def self.shared_secret= secret
-      raise 'Url2png error: Invalid shared secret!' unless secret.match(/^S/)
-      @url2png_secret ||= secret
+    c.each do |key, value|
+      case key
+        
+      when :api_key   
+        @api_key = value
+      when :private_key
+        @private_key = value
+      when :mode
+        raise "Url2png error: Invalid mode, only #{ MODES.join(', ') } are allowed" unless MODES.include?(value.to_s)
+        @mode = value
+      when :api_version
+        @api_version = value
+      end
     end
+  end
+  
 
-    def self.shared_secret
-      raise 'Url2png error: No shared secret defined!' if @url2png_secret.nil?
-      @url2png_secret
-    end
+  # GETTERS
+  def api_key
+    raise 'Url2png error: No public key defined!' if @api_key.nil?
+    @api_key
+  end
 
-    # size
-    def self.default_size= size
-      @url2png_size ||= size
-    end
+  def private_key
+    raise 'Url2png error: No private key defined!' if @private_key.nil?
+    @private_key
+  end
 
-    def self.default_size
-      @url2png_size ||= '400x400'
-    end
-    
+  def mode
+    @mode ||= 'production' # default: production
   end
   
+  def api_version
+    @api_version ||= 'v6' #default: v6
+  end
+  
+  def default_size
+    @default_size ||= "400x400"
+  end
 end

data/lib/url2png/dimensions.rb

@@ -2,11 +2,10 @@ module Url2png
   module Dimensions
     
     def self.parse options
-      # convert tumbnail to size to ensure compatibility with older gem versions
-      options[:size] ||= options[:thumbnail]
+      options[:size] ||= "#{options[:thumbnail_max_width]}x#{options[:thumbnail_max_height]}"
       
       # distill image size
-      size   = (options[:size]  || Url2png::Config.default_size).split('x')
+      size   = (options[:size]  || Url2png.default_size).split('x')
       width  = options[:width]  || size[0]
       height = options[:height] || size[1]
       

data/lib/url2png/helpers/common.rb

@@ -7,24 +7,18 @@ module Url2png
       def site_image_tag url, options = {}
         # parse size
         dim = Url2png::Dimensions.parse(options)
-        
+                                
         # ensure image alt
         alt = options.key?(:alt) ? options.delete(:alt) : url
         
-        # filter options
-        url2png_options = {}
-        [:size, :thumbnail, :browser_size, :delay, :fullscreen].each do |key|
-          url2png_options[key] = options.delete(key) if options.key?(key)
-        end
-        
         # build image tag
         img =  '<img'
-        img << " src='#{ site_image_url(url, url2png_options) }'"
+        img << " src='#{ site_image_url(url, options) }'"
         img << " alt='#{ alt }'"
-        img << " width='#{ dim[:width] }'"
-        img << " height='#{ dim[:height] }'"
+        img << " width='#{ dim[:width] }'" if options[:size]
+        img << " height='#{ dim[:height] }'" if options[:size]
         options.each_pair do |k, v|
-          img << " #{ k }='#{ v }'" unless v.nil? || v == ''
+          img << " #{ k }=#{ v }" unless v.nil? || v == ''
         end
         img << ' />'
         img.html_safe
@@ -35,7 +29,7 @@ module Url2png
         # parse size
         dim = Url2png::Dimensions.parse(options)
         
-        case Url2png::Config.mode
+        case Url2png.mode
         when 'dummy'
           'data:image/png;base64,
           iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAADHmlDQ1BJQ0MgUHJvZmlsZQAAeAGF
@@ -65,36 +59,71 @@ module Url2png
         when 'placehold'
           "http://placehold.it/#{ dim[:size] }"
           
-        else
-          options[:protocol] ||= 'http://'
+        else               
+          # build parameters portion of URL
+          case Url2png.api_version
+
+          when 'v6'
+            ######
+            # v6 #
+            ######
+            
+            # http://beta.url2png.com/v6/<APIKEY>/<TOKEN>/png/?url=google.com
+                        
+            query = {
+              :url       => url,
+              :force     => options[:force],     # [false,always,timestamp] Default: false
+              :fullpage  => options[:fullpage],  # [true,false] Default: false
+              :thumbnail_max_width => options[:thumbnail_max_width], # scaled img width px; Default no-scaling
+              :thumbnail_max_height => options[:thumbnail_max_height],
+              :viewport  => options[:viewport],  # Max 5000x5000; Default 1280x1024
+            }
           
-          # escape the url
-          safe_url = URI.escape(url)
+            query_string = query.
+                sort_by {|s| s[0].to_s }. # sort query by keys for uniformity
+                select {|s| s[1] }.       # skip empty options
+                map {|s| s.map {|v| CGI::escape(v.to_s) }.join('=') }. # escape keys & vals
+                join('&')
           
-          # generate token
-          token = Digest::MD5.hexdigest("#{ Url2png::Config.shared_secret }+#{ safe_url }")
+            # generate token
+            token = Digest::MD5.hexdigest(query_string + Url2png.private_key)
           
-          # build options portion of URL
-          url_options = []
-          url_options << "t#{ dim[:size]             }" if dim[:size]
-          url_options << "s#{ options[:browser_size] }" if options[:browser_size]
-          url_options << "d#{ options[:delay]        }" if options[:delay]
-          url_options << "FULL"                         if options[:fullscreen]
-          url_options_string = url_options.join('-')
           
-          # build image url
-          File.join(
-            Url2png::Config.api_url(options[:protocol]),
-            Url2png::Config.api_version,
-            Url2png::Config.public_key,
-            token,
-            url_options_string,
-            safe_url
-          )
+            "http://beta.url2png.com/v6/#{Url2png.api_key}/#{token}/png/?#{query_string}"
+            
+          when 'v4'
+            ######
+            # v4 #
+            ######
+            
+            # http://beta.url2png.com/v4/<APIKEY>/<TOKEN>/<VIEWPORT>-<THUMBNAIL>-<FULL>/<TARGET>
+            
+            # escape the url
+            safe_url= CGI::escape(url)
+            
+            # generate token
+            token = Digest::MD5.hexdigest("#{ Url2png.private_key }+#{ safe_url }")
+            
+            # build options portion of URL
+            url_options = []
+            url_options << "t#{ dim[:size] }" if dim[:size]
+            url_options << "s#{ options[:browser_size] }" if options[:browser_size]
+            url_options << "d#{ options[:delay] }" if options[:delay]
+            url_options << "FULL" if options[:fullscreen]
+            url_options_string = url_options.join('-')
+            
+            # build image url
+            File.join(
+              "http://beta.url2png.com",
+              Url2png.api_version,
+              Url2png.api_key,
+              token,
+              url_options_string,
+              safe_url
+            )
+          end
         end
-        
       end
-      
     end
   end
 end

data/url2png.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "url2png"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["wout fierens", "fuzzyalej", "ceritium", "lukemelia"]
-  s.date = "2011-12-07"
+  s.authors = ["wout fierens", "fuzzyalej", "ceritium", "lukemelia", "robinhoudmeyers"]
+  s.date = "2012-05-25"
   s.description = "Generate screenshots from websites almost instantly at any preferred size using ruby and the url2png.com API"
   s.email = "wout@impinc.co.uk"
   s.extra_rdoc_files = [
@@ -38,34 +38,29 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/wout/url2png-gem"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.17"
   s.summary = "A ruby gem wrapping the url2png.com screenshot service API"
-  s.test_files = [
-    "spec/helpers/common_rspec.rb",
-    "spec/spec_helper.rb",
-    "spec/url2png_spec.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["> 2.6.0"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<rspec>, ["> 2.6.0"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<rspec>, ["> 2.6.0"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: url2png
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,15 @@ authors:
 - fuzzyalej
 - ceritium
 - lukemelia
+- robinhoudmeyers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154802540 !ruby/object:Gem::Requirement
+  requirement: &70159176153680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,32 +25,32 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2154802540
+  version_requirements: *70159176153680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154801920 !ruby/object:Gem::Requirement
+  requirement: &70159176152600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *2154801920
+  version_requirements: *70159176152600
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2154801320 !ruby/object:Gem::Requirement
+  requirement: &70159176166560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2154801320
+  version_requirements: *70159176166560
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2154800700 !ruby/object:Gem::Requirement
+  requirement: &70159176163480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +58,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154800700
+  version_requirements: *70159176163480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154800080 !ruby/object:Gem::Requirement
+  requirement: &70159176201400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -68,7 +69,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2154800080
+  version_requirements: *70159176201400
 description: Generate screenshots from websites almost instantly at any preferred
   size using ruby and the url2png.com API
 email: wout@impinc.co.uk
@@ -110,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1197006310147786361
+      hash: 3789530823502758367
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,11 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: A ruby gem wrapping the url2png.com screenshot service API
-test_files:
-- spec/helpers/common_rspec.rb
-- spec/spec_helper.rb
-- spec/url2png_spec.rb
+test_files: []