url2png 0.0.7 → 0.1.0

data/README.markdown

@@ -26,9 +26,10 @@ This is done by setting the mode:
     Url2png::Config.mode = :placehold if Rails.env.development?
 
 Options are:
-  - :production (default; will use the url2png api to generate images)
-  - :placehold (will generate images at http://placehold.it)
-  - :dummy (will give a grey base64 data image)
+
+* :production (default; will use the url2png api to generate images)
+* :placehold (will generate images at http://placehold.it)
+* :dummy (will give a grey base64 data image)
 
 In Rails you probably want to do configuration in an initializer.
 
@@ -50,6 +51,55 @@ To only get the image url:
 
     site_image_url url, :size => '300x200'
 
+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:
+
+    site_image_tag url, :size => '500x500'
+
+    site_image_tag url, :size => 'ORIGINAL'
+
+**:thumbnail** (alias for :size)
+
+**:browser_size**<br>
+  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:
+
+    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
+
+
+Original API docs: https://url2png.com/doc/
+
+
+
+### 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
 

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.1.0

data/lib/url2png/config.rb

@@ -20,7 +20,7 @@ module Url2png
     end
 
     def self.api_version
-      @url2png_version ||= 'v3'
+      @url2png_version ||= 'v4'
     end
 
     # public key setter and getter

data/lib/url2png/dimensions.rb

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

data/lib/url2png/helpers/common.rb

@@ -1,24 +1,36 @@
 module Url2png
   module Helpers
     module Common
-
+      
+      # complete image tag
       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, options) }'"
-        img << " alt='#{ options[:alt] || url }'"
+        img << " src='#{ site_image_url(url, url2png_options) }'"
+        img << " alt='#{ alt }'"
         img << " width='#{ dim[:width] }'"
         img << " height='#{ dim[:height] }'"
         options.each_pair do |k, v|
           img << " #{ k }='#{ v }'" unless v.nil? || v == ''
         end
         img << ' />'
-        img.html_safe
       end
       
+      # only the url for the image
       def site_image_url url, options = {}
+        # parse size
         dim = Url2png::Dimensions.parse(options)
         
         case Url2png::Config.mode
@@ -60,12 +72,27 @@ module Url2png
           # generate token
           token = Digest::MD5.hexdigest("#{ Url2png::Config.shared_secret }+#{ 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(Url2png::Config.api_url(options[:protocol]), Url2png::Config.api_version, Url2png::Config.public_key, token, dim[:size], safe_url)
+          File.join(
+            Url2png::Config.api_url(options[:protocol]),
+            Url2png::Config.api_version,
+            Url2png::Config.public_key,
+            token,
+            url_options_string,
+            safe_url
+          )
         end
         
       end
-        
+      
     end
   end
 end

data/spec/helpers/common_rspec.rb

@@ -1,12 +1,38 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/url2png/helpers/common.rb')
+require 'spec_helper'
+require 'url2png/helpers/common'
 
 describe Url2png do
   include Url2png::Helpers::Common
+  before(:all) do
+    Url2png::Config.public_key = "P4DBEC0200EE98"
+    Url2png::Config.shared_secret = "S169B0E051EAC6794B3EC9F385866187R"
+  end
   
   describe "site_image_tag" do
     it "should return the url of the http://pasparout.com image" do
       site_image_tag('http://pasparout.com').should_not be_nil
     end
   end
+  
+  describe "site_image_url" do
+    it "should encode the thumbnail size when provided" do
+      site_image_url('http://www.nytimes.com/', :thumbnail => '200x300').should =~ %r{t200x300}
+    end
+    
+    it "should encode the initial browser size when provided" do
+      site_image_url('http://www.nytimes.com/', :browser_size => '200x300').should =~ %r{s200x300}
+    end
+    
+    it "should encode the delay when provided" do
+      site_image_url('http://www.nytimes.com/', :delay => 3).should =~ %r{d3}
+    end
+    
+    it "should encode the fullscreen capture flag when provided" do
+      site_image_url('http://www.nytimes.com/', :fullscreen => true).should =~ %r{FULL}
+    end
+
+    it "should concatenate options by using hyphens" do
+      site_image_url('http://www.nytimes.com/', :delay => 3, :fullscreen => true).should =~ %r{d3-FULL}
+    end
+  end
 end

data/url2png.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "url2png"
-  s.version = "0.0.7"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["wout fierens", "fuzzyalej", "ceritium"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: url2png
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157323520 !ruby/object:Gem::Requirement
+  requirement: &2156933760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2157323520
+  version_requirements: *2156933760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157321920 !ruby/object:Gem::Requirement
+  requirement: &2156933160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2157321920
+  version_requirements: *2156933160
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157320760 !ruby/object:Gem::Requirement
+  requirement: &2156932560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *2157320760
+  version_requirements: *2156932560
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2157319780 !ruby/object:Gem::Requirement
+  requirement: &2156931920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157319780
+  version_requirements: *2156931920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157318140 !ruby/object:Gem::Requirement
+  requirement: &2156931280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -67,7 +67,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2157318140
+  version_requirements: *2156931280
 description: Generate screenshots from websites almost instantly at any preferred
   size using ruby and the url2png.com API
 email: wout@impinc.co.uk
@@ -109,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2618384894962089538
+      hash: -928741917321471624
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: