url2png 0.2.2 → 0.3.0

data/README.markdown

@@ -24,7 +24,7 @@ You must define your public key and shared secret, they are required:
 ##### version
 You can define the api version if you want to use an different version of the url2png api. 
 	
-	Url2png.api_version = "v4"
+	Url2png.api_version = 'v4'
  g
 Available versions:
 
@@ -40,9 +40,16 @@ This is done by setting the mode:
 
 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)
+
+#### default_size
+Default size is set to 400x400. To change the default size:
+
+	Url2png.default_size = '500x500'
+
+<br/>
 
 In Rails you probably want to do configuration in an initializer.
 
@@ -51,19 +58,26 @@ In Rails you probably want to do configuration in an initializer.
 
 Generate an image tag:
 
-    url2png_image_tag [options]
+    url2png_image_tag url, [options]
+    
+    # alias (older version)
+    site_image_tag url, [options]
+
+To only get the image url:
 
+    site_image_url url, [options]
 
 Options differ by version!
 
 
+
 ### Version 6
 
 ##### Thumbnail
 Constrain screenshot based on width or height or both.<br>
 default: no resizing
 		
-	url2png_image_tag :url => 'http://www.zwartopwit.com', 
+	url2png_image_tag 'http://www.zwartopwit.com', 
 					  :thumbnail_max_width => 500, 
 					  :thumbnail_max_height => 500
 	
@@ -72,27 +86,28 @@ default: no resizing
 Set viewport dimensions, adjust to your hearts content.<br>
 default: 1480x1037
 	
-	url2png_image_tag :url => 'http://www.zwartopwit.com', 
-					  :viewport => "1024x900"
+	url2png_image_tag 'http://www.zwartopwit.com',
+					  :viewport => '1024x900'
 
 
 ##### Fullpage
 Will attempt to capture entire document canvas.<br>
 default: false
 	
-	url2png_image_tag :url => 'http://www.zwartopwit.com', 
+	url2png_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>
+
+* min: 1<br>
+* max: 5<br>
 
 example:
 		
-	url2png_image_tag :url => "http://www.zwartopwit.com", 
+	url2png_image_tag 'http://www.zwartopwit.com',
 					  :size => '300x200', 
 					  :delay => 2
 	
@@ -101,74 +116,90 @@ example:
 Forces a fresh screenshot with each request, overwriting the previous copy.<br>
 **You will be charged for every request made using the force option.**
 	
-	= url2png_image_tag :url => 'http://www.zwartopwit.com', 
+	url2png_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:
 
-    url2png_image_tag :url => "http://www.zwartopwit.com", 
-    				  :size => '300x200'
-
-To only get the image url:
-
-    site_image_url :url => "http://www.zwartopwit.com", 
-    			   :size => '300x200'
+##### Size
+By default the size is set to 400 x 400 px.
 
-Options are:
+This is a proportion bounding box. Thumbnails will be resized to fit within this box.
 
-##### Size
-This is a proportion bounding box.<br>
-Thumbnails will be resized to fit within this box.<br>
 default: 'ORIGINAL'<br>
+
 examples:
 
-    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    url2png_image_tag 'http://www.zwartopwit.com', 
     				  :size => '500x500'
 
-    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    url2png_image_tag 'http://www.zwartopwit.com', 
     				  :size => 'ORIGINAL'
 
 ##### Thumbnail (alias for :size)
 
 ##### Browser size
 Set the initial browser screen size.<br>
-default: '1024x768'<br>
-min: '200x200'<br>
-max: '4000x4000'<br>
+
+* default: '1024x768'<br>
+* min: '200x200'<br>
+* max: '4000x4000'<br>
+
 example:
     
-    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    url2png_image_tag 'http://www.zwartopwit.com', 
     				  :size => '300x200', 
     				  :browser_size => '1024x2500'
 
 ##### Delay
 Extra delay (in seconds) forced between page load and screenshot.<br>
-default: 1<br>
-min: 1<br>
-max: 5<br>
+
+* default: 1
+* min: 1
+* max: 5
+
 example:
 
-	url2png_image_tag :url => "http://www.zwartopwit.com", 
+	url2png_image_tag 'http://www.zwartopwit.com', 
 					  :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>
+Will never return screenshot smaller than 'Initial Screen Size'.<br>
 default: false<br>
 
 example:
 
-    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    url2png_image_tag 'http://www.zwartopwit.com', 
     				  :size => '300x200', 
     				  :fullscreen => true
 
 
+### Version 3
+
+##### Size
+
+By default the size is set to 400 x 400 px.
+To generate an image with a specific size:
 
+    url2png_image_tag 'http://www.zwartopwit.com', 
+    				  :size => '300x200'
+    			   
+
+##### Fullscreen
+When true, Will attempt to capture entire document canvas.<br>
+Will never return screenshot smaller than 'Initial Screen Size'.<br>
+default: false<br>
+
+example:
+
+    url2png_image_tag 'http://www.zwartopwit.com', 
+    				  :fullscreen => true
+    			   
+    			   
 ## Important
 
 This gem is written for Rails 3.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/url2png/config.rb

@@ -5,49 +5,64 @@ module Url2png
   MODES = %w{production placehold dummy}
   
   def config c = {}
-    # SET
-    #   api_key
-    #   private_key
-    #   mode        (production[default] placehold dummy)
-    #   version     (v6[default])
+    # mandatory
+    self.api_key = c[:api_key]
+    self.private_key = c[:private_key]
     
-    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
+    # optional
+    self.mode = c[:mode] if c[:mode]
+    self.api_version = c[:api_version] if c[:api_version]
+  end
+  
+  def api_key=api_key
+    @api_key=api_key
   end
   
-
-  # GETTERS
   def api_key
     raise 'Url2png error: No public key defined!' if @api_key.nil?
     @api_key
   end
+  
+  def private_key=private_key
+    @private_key = private_key
+  end
 
   def private_key
     raise 'Url2png error: No private key defined!' if @private_key.nil?
     @private_key
   end
+  
+  def mode=mode
+    raise "Url2png error: Invalid mode, only #{ MODES.join(', ') } are allowed" unless MODES.include?(mode.to_s)
+    @mode = mode
+  end
 
   def mode
     @mode ||= 'production' # default: production
   end
   
+  def api_version=api_version
+    @api_version = api_version || 'v4'
+  end
+  
   def api_version
-    @api_version ||= 'v4' #default: v4
+    @api_version || 'v4' #default: v4
+  end
+  
+  def default_size=default_size
+    @default_size = default_size || "400x400"
   end
   
   def default_size
-    @default_size ||= "400x400"
+    @default_size || "400x400"
+  end
+  
+  def token param
+    case self.api_version
+    when 'v6'
+      Digest::MD5.hexdigest("#{param}#{self.private_key}")
+    when 'v4', 'v3'
+      Digest::MD5.hexdigest("#{self.private_key}+#{param}")
+    end
   end
 end

data/lib/url2png/dimensions.rb

@@ -2,7 +2,9 @@ module Url2png
   module Dimensions
     
     def self.parse options
-      options[:size] ||= "#{options[:thumbnail_max_width]}x#{options[:thumbnail_max_height]}"
+      if Url2png.api_version == "v6"
+        options[:size] ||= "#{options[:thumbnail_max_width]}x#{options[:thumbnail_max_height]}"
+      end
       
       # distill image size
       size   = (options[:size]  || Url2png.default_size).split('x')

data/lib/url2png/helpers/common.rb

@@ -2,20 +2,21 @@ module Url2png
   module Helpers
     module Common
       extend self
-
+      
       # ------------------
       # complete image tag
       
-      def url2png_image_tag options = {}
+      
+      def url2png_image_tag url, options = {}
         # parse size
         dim = Url2png::Dimensions.parse(options)
         
         # ensure image alt 
-        alt = options.key?(:alt) ? options.delete(:alt) : options[:url]
+        alt = options.key?(:alt) ? options.delete(:alt) : url
         
         # build image tag
         img =  '<img'
-        img << " src='#{ site_image_url(options) }'"
+        img << " src='#{ site_image_url(url, options) }'"
         img << " alt='#{ alt }'"
         img << " width='#{ dim[:width] }'" if options[:size]
         img << " height='#{ dim[:height] }'" if options[:size]
@@ -28,20 +29,22 @@ module Url2png
       
       
       def check_options options, options_available
+  
         # filter out unavailable options
         options = options.select do |key, value|
           if options_available.include? key 
             true
           else
             # size is a special option, only usable in the gem
-            warn  "\"#{key}\" is not a valid option" unless key == :size
+            homepage = "https://github.com/robinhoudmeyers/url2png-gem"
+            raise "\"#{key}\" is not a valid option \nCheck the gem homepage for information about options: #{homepage}" unless key == :size
           end
         end
       end
       
       # --------------------------
       # only the url for the image
-      def site_image_url options = {}
+      def site_image_url url, options = {}
         # parse size
         dim = Url2png::Dimensions.parse(options)
         
@@ -86,17 +89,20 @@ module Url2png
             ######
             
             # check for unavailable options
-            options_available = [:url, :force, :fullpage, :thumbnail_max_width, :thumbnail_max_height, :viewport]
+            options_available = [:force, :fullpage, :thumbnail_max_width, :thumbnail_max_height, :viewport]
             options = check_options(options, options_available)
-          
+            
+            # add url to options query
+            options[:url] = url
+            
             query_string = options.
                 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(query_string + Url2png.private_key)
+            token = Url2png.token query_string
           
           
             "http://beta.url2png.com/v6/#{Url2png.api_key}/#{token}/png/?#{query_string}"
@@ -110,14 +116,14 @@ module Url2png
             ######
             
             # check for unavailable options
-            options_available = [:url, :size, :thumbnail, :browser_size, :delay, :fullscreen]
+            options_available = [:size, :thumbnail, :browser_size, :delay, :fullscreen]
             options = check_options(options, options_available)
             
             # escape the url
-            safe_url= CGI::escape(options[:url])
+            safe_url= CGI::escape(url)
             
             # generate token
-            token = Digest::MD5.hexdigest("#{ Url2png.private_key }+#{ safe_url }")
+            token = Url2png.token safe_url
             
             # build options portion of URL
             url_options = []
@@ -136,9 +142,51 @@ module Url2png
               url_options_string,
               safe_url
             )
+            
+          when 'v3'
+            ######
+            # v3 #
+            ######
+
+            # http://api.url2png.com/v3/api_key/security_hash/bounds/url
+
+            options_available = [:fullscreen, :size]
+            options = check_options(options, options_available)
+            
+            # escape the url
+            safe_url= CGI::escape(url)
+
+            # generate token
+            token = Url2png.token safe_url
+
+            # custom size or default_size
+            size = options[:size] || Url2png.default_size
+            
+            # build options portion of URL
+            if options[:fullscreen]
+              bounds = "FULL"
+            else
+              bounds = size
+            end
+            
+            # build image url
+            File.join(
+              "http://api.url2png.com",
+              Url2png.api_version,
+              Url2png.api_key,
+              token,
+              bounds,
+              safe_url
+            )
           end
         end
       end
+
+      # -----
+      # Alias
+      def site_image_tag url, options = {}
+        url2png_image_tag(url, options)
+      end      
     end
   end
 end

data/spec/url2png_spec.rb

@@ -1,7 +1,49 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Url2png" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  describe "attributes" do
+    it "should set mandatory attributes" do
+      my_api_key = "my_api_key"
+      my_private_key = "my_private_key"
+      Url2png.config ({api_key: my_api_key, private_key: my_private_key})
+      Url2png.api_key.should eq my_api_key
+      Url2png.private_key.should eq my_private_key
+    end
+    
+    it "should throw an exception getting nil api_key" do
+      Url2png.config({private_key: "private_key"})
+      expect {Url2png.api_key}.to raise_error
+    end
+    
+    it "should throw an exception getting nil private_key" do
+      Url2png.config({api_key: "private_key"})
+      expect {Url2png.private_key}.to raise_error    end
+    
+    it "should set mode" do
+      mode = "placehold"
+      Url2png.config ({mode: mode})
+      Url2png.mode.should eq mode
+    end
+    
+    it "should throw an exception with an invalid mode" do
+      expect {Url2png.config({mode: "invalid mode"})}.to raise_error
+    end
+  end
+  
+  describe "v3" do
+    it "should generate a valid token for v3" do
+      Url2png.config ({api_key: 'api_key', private_key: 'private_key', api_version: 'v3'})
+      Url2png.token('google.com').should eq '1bf25a84efbd998f2b9f5b4f1b0ad6eb'
+    end
+    
+    it "should generate a valid token for v4" do
+      Url2png.config ({api_key: 'api_key', private_key: 'private_key', api_version: 'v4'})
+      Url2png.token('google.com').should eq '1bf25a84efbd998f2b9f5b4f1b0ad6eb'
+    end
+    
+    it "should generate a valid token for v6" do
+      Url2png.config ({api_key: 'api_key', private_key: 'private_key', api_version: 'v6'})
+      Url2png.token('google.com').should eq 'a6bcacefb7e7b1a89ecd619af960b3b8'
+    end
   end
 end

data/url2png.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "url2png"
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["robinhoudmeyers", "wout fierens", "fuzzyalej", "ceritium", "lukemelia"]
-  s.date = "2012-06-15"
+  s.date = "2012-06-27"
   s.description = "Generate screenshots from websites almost instantly at any preferred size using ruby and the url2png.com API"
   s.email = "houdmeyers@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: url2png
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,11 +13,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-15 00:00:00.000000000 Z
+date: 2012-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170384723740 !ruby/object:Gem::Requirement
+  requirement: &70092339600580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -25,10 +25,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70170384723740
+  version_requirements: *70092339600580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70170384723260 !ruby/object:Gem::Requirement
+  requirement: &70092339599060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -36,10 +36,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70170384723260
+  version_requirements: *70092339599060
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70170384722780 !ruby/object:Gem::Requirement
+  requirement: &70092339613580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -47,10 +47,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70170384722780
+  version_requirements: *70092339613580
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70170384722260 !ruby/object:Gem::Requirement
+  requirement: &70092339611600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -58,10 +58,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170384722260
+  version_requirements: *70092339611600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170384721780 !ruby/object:Gem::Requirement
+  requirement: &70092339606840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -69,7 +69,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70170384721780
+  version_requirements: *70092339606840
 description: Generate screenshots from websites almost instantly at any preferred
   size using ruby and the url2png.com API
 email: houdmeyers@gmail.com
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1190505122960655189
+      hash: -354415127866206290
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: