url2png 0.2.1 → 0.2.2

data/README.markdown

@@ -6,9 +6,8 @@ A Ruby gem wrapping the url2png.com API.
 ## Who should use it?
 Any Ruby on Rails developer who wants/needs to generate screenshots from sites using url2png.com.
 
-## Usage
 
-### Installation
+## Installation
 
     gem install url2png
 
@@ -26,7 +25,7 @@ You must define your public key and shared secret, they are required:
 You can define the api version if you want to use an different version of the url2png api. 
 	
 	Url2png.api_version = "v4"
-
+ g
 Available versions:
 
 * v4 (default)
@@ -48,11 +47,11 @@ Options are:
 In Rails you probably want to do configuration in an initializer.
 
 
-### Helpers
+## Usage
 
 Generate an image tag:
 
-    site_image_tag url, [options]
+    url2png_image_tag [options]
 
 
 Options differ by version!
@@ -64,21 +63,25 @@ Options differ by version!
 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
+	url2png_image_tag :url => '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"
+	url2png_image_tag :url => '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
+	url2png_image_tag :url => 'http://www.zwartopwit.com', 
+					  :fullpage => true
 	
 
 ##### Delay
@@ -89,14 +92,17 @@ max: 5<br>
 
 example:
 		
-	site_image_tag url, :size => '300x200', :delay => 2
+	url2png_image_tag :url => "http://www.zwartopwit.com", 
+					  :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
+	= url2png_image_tag :url => 'http://www.zwartopwit.com', 
+						:force => true
 
 	
 ### Version 4
@@ -104,11 +110,13 @@ Forces a fresh screenshot with each request, overwriting the previous copy.<br>
 By default the size is set to 400 x 400 px.
 To generate an image with a specific size:
 
-    site_image_tag url, :size => '300x200'
+    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    				  :size => '300x200'
 
 To only get the image url:
 
-    site_image_url url, :size => '300x200'
+    site_image_url :url => "http://www.zwartopwit.com", 
+    			   :size => '300x200'
 
 Options are:
 
@@ -118,9 +126,11 @@ Thumbnails will be resized to fit within this box.<br>
 default: 'ORIGINAL'<br>
 examples:
 
-    site_image_tag url, :size => '500x500'
+    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    				  :size => '500x500'
 
-    site_image_tag url, :size => 'ORIGINAL'
+    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    				  :size => 'ORIGINAL'
 
 ##### Thumbnail (alias for :size)
 
@@ -131,7 +141,9 @@ min: '200x200'<br>
 max: '4000x4000'<br>
 example:
     
-    site_image_tag url, :size => '300x200', :browser_size => '1024x2500'
+    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    				  :size => '300x200', 
+    				  :browser_size => '1024x2500'
 
 ##### Delay
 Extra delay (in seconds) forced between page load and screenshot.<br>
@@ -140,7 +152,9 @@ min: 1<br>
 max: 5<br>
 example:
 
-	site_image_tag url, :size => '300x200', :delay => 2
+	url2png_image_tag :url => "http://www.zwartopwit.com", 
+					  :size => '300x200', 
+					  :delay => 2
 
 ##### Fullscreen
 When true, Will attempt to capture entire document canvas.<br>
@@ -149,7 +163,9 @@ default: false<br>
 
 example:
 
-    site_image_tag url, :size => '300x200', :fullscreen => true
+    url2png_image_tag :url => "http://www.zwartopwit.com", 
+    				  :size => '300x200', 
+    				  :fullscreen => true
 
 
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/url2png/helpers/common.rb

@@ -3,17 +3,19 @@ module Url2png
     module Common
       extend self
 
+      # ------------------
       # complete image tag
-      def site_image_tag url, options = {}
+      
+      def url2png_image_tag options = {}
         # parse size
         dim = Url2png::Dimensions.parse(options)
-                                
-        # ensure image alt
-        alt = options.key?(:alt) ? options.delete(:alt) : url
+        
+        # ensure image alt 
+        alt = options.key?(:alt) ? options.delete(:alt) : options[:url]
         
         # build image tag
         img =  '<img'
-        img << " src='#{ site_image_url(url, options) }'"
+        img << " src='#{ site_image_url(options) }'"
         img << " alt='#{ alt }'"
         img << " width='#{ dim[:width] }'" if options[:size]
         img << " height='#{ dim[:height] }'" if options[:size]
@@ -24,8 +26,22 @@ module Url2png
         img.html_safe
       end
       
+      
+      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
+          end
+        end
+      end
+      
+      # --------------------------
       # only the url for the image
-      def site_image_url url, options = {}
+      def site_image_url options = {}
         # parse size
         dim = Url2png::Dimensions.parse(options)
         
@@ -66,20 +82,14 @@ module Url2png
           when 'v6'
             ######
             # v6 #
+            # http://beta.url2png.com/v6/<APIKEY>/<TOKEN>/png/?url=google.com
             ######
             
-            # 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
-            }
+            # check for unavailable options
+            options_available = [:url, :force, :fullpage, :thumbnail_max_width, :thumbnail_max_height, :viewport]
+            options = check_options(options, options_available)
           
-            query_string = query.
+            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
@@ -90,16 +100,21 @@ module Url2png
           
           
             "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>
             ######
             
-            # http://beta.url2png.com/v4/<APIKEY>/<TOKEN>/<VIEWPORT>-<THUMBNAIL>-<FULL>/<TARGET>
+            # check for unavailable options
+            options_available = [:url, :size, :thumbnail, :browser_size, :delay, :fullscreen]
+            options = check_options(options, options_available)
             
             # escape the url
-            safe_url= CGI::escape(url)
+            safe_url= CGI::escape(options[:url])
             
             # generate token
             token = Digest::MD5.hexdigest("#{ Url2png.private_key }+#{ safe_url }")

data/url2png.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "url2png"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   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-13"
+  s.date = "2012-06-15"
   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.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,11 +13,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70331926041900 !ruby/object:Gem::Requirement
+  requirement: &70170384723740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -25,10 +25,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70331926041900
+  version_requirements: *70170384723740
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70331926041380 !ruby/object:Gem::Requirement
+  requirement: &70170384723260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -36,10 +36,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70331926041380
+  version_requirements: *70170384723260
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70331926040900 !ruby/object:Gem::Requirement
+  requirement: &70170384722780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -47,10 +47,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70331926040900
+  version_requirements: *70170384722780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70331926040420 !ruby/object:Gem::Requirement
+  requirement: &70170384722260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -58,10 +58,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331926040420
+  version_requirements: *70170384722260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70331926039940 !ruby/object:Gem::Requirement
+  requirement: &70170384721780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -69,7 +69,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70331926039940
+  version_requirements: *70170384721780
 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: 3943409547938200852
+      hash: 1190505122960655189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: