url2png 0.3.0 → 0.3.1

data/README.markdown

@@ -28,8 +28,9 @@ You can define the api version if you want to use an different version of the ur
  g
 Available versions:
 
-* v4 (default)
-* v6 (in beta, only for enabled users)
+* v3
+* v4
+* v6 (default)
 
 
 ##### mode
@@ -65,6 +66,9 @@ Generate an image tag:
 
 To only get the image url:
 
+    url2png_image_url url, [options]
+    
+    # alias (older version)
     site_image_url url, [options]
 
 Options differ by version!
@@ -80,7 +84,11 @@ default: no resizing
 	url2png_image_tag 'http://www.zwartopwit.com', 
 					  :thumbnail_max_width => 500, 
 					  :thumbnail_max_height => 500
-	
+					  
+					  # alias for :thumbnail_...
+					  :max_width => 500
+					  :max_height => 500
+
 
 ##### Viewport
 Set viewport dimensions, adjust to your hearts content.<br>
@@ -118,17 +126,21 @@ Forces a fresh screenshot with each request, overwriting the previous copy.<br>
 	
 	url2png_image_tag 'http://www.zwartopwit.com', 
 						:force => true
+						
+						
+##### Size
+Sets width and height attributes from the html \<img> tag.
+	
+	url2png_image_tag 'http://www.zwartopwit.com',
+					  :size => "800x600"
 
 	
 ### Version 4
 
+##### Thumbnail
 
-##### Size
 By default the size is set to 400 x 400 px.
-
-This is a proportion bounding box. Thumbnails will be resized to fit within this box.
-
-default: 'ORIGINAL'<br>
+Proportions are constrained.
 
 examples:
 
@@ -137,8 +149,10 @@ examples:
 
     url2png_image_tag 'http://www.zwartopwit.com', 
     				  :size => 'ORIGINAL'
+##### Size
+
+This is a proportion bounding box. Almost the same as :thumbnail, but thumbnails will be resized to fit within this box. Width and height attribute of the html \<img> tag will be set.
 
-##### Thumbnail (alias for :size)
 
 ##### Browser size
 Set the initial browser screen size.<br>
@@ -150,7 +164,6 @@ Set the initial browser screen size.<br>
 example:
     
     url2png_image_tag 'http://www.zwartopwit.com', 
-    				  :size => '300x200', 
     				  :browser_size => '1024x2500'
 
 ##### Delay

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/url2png/config.rb

@@ -42,7 +42,7 @@ module Url2png
   end
   
   def api_version=api_version
-    @api_version = api_version || 'v4'
+    @api_version = api_version || 'v6' # set default to latest open version
   end
   
   def api_version

data/lib/url2png/dimensions.rb

@@ -2,9 +2,9 @@ module Url2png
   module Dimensions
     
     def self.parse options
-      if Url2png.api_version == "v6"
-        options[:size] ||= "#{options[:thumbnail_max_width]}x#{options[:thumbnail_max_height]}"
-      end
+      # 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

@@ -16,7 +16,7 @@ module Url2png
         
         # build image tag
         img =  '<img'
-        img << " src='#{ site_image_url(url, options) }'"
+        img << " src='#{ url2png_image_url(url, options) }'"
         img << " alt='#{ alt }'"
         img << " width='#{ dim[:width] }'" if options[:size]
         img << " height='#{ dim[:height] }'" if options[:size]
@@ -28,23 +28,9 @@ module Url2png
       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
-            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 url, options = {}
+      def url2png_image_url url, options = {}
         # parse size
         dim = Url2png::Dimensions.parse(options)
         
@@ -81,7 +67,6 @@ module Url2png
         else               
           # build parameters portion of URL
           case Url2png.api_version
-
           when 'v6'
             ######
             # v6 #
@@ -89,7 +74,31 @@ module Url2png
             ######
             
             # check for unavailable options
+            options_alias = [:max_width, :max_height]
             options_available = [:force, :fullpage, :thumbnail_max_width, :thumbnail_max_height, :viewport]
+            
+            # assign alias to valid option
+            options_alias.each do |key|
+              if options.key?(key)
+                case key
+                # when :size
+                #   options[:thumbnail_max_width] = options[:size].split('x')[0] if options[:thumbnail_max_width].nil?
+                #   options[:thumbnail_max_height] = options[:size].split('x')[1] if options[:thumbnail_max_height].nil?
+                when :max_width
+                  options[:thumbnail_max_width] = options[key] if options[:thumbnail_max_width].nil?
+                  options.delete(key)
+                when :max_height
+                  options[:thumbnail_max_height] = options[key] if options[:thumbnail_max_height].nil?
+                  options.delete(key)
+                end
+              end
+            end
+            
+            # options_alias.each do |key|
+            #   if options.include?(key) then options.delete(key) end
+            # end
+          
+            
             options = check_options(options, options_available)
             
             # add url to options query
@@ -105,9 +114,7 @@ module Url2png
             token = Url2png.token query_string
           
           
-            "http://beta.url2png.com/v6/#{Url2png.api_key}/#{token}/png/?#{query_string}"
-          
-          
+            "http://beta.url2png.com/v6/#{Url2png.api_key}/#{token}/png/?#{query_string}"          
           
           when 'v4'
             ######
@@ -127,7 +134,11 @@ module Url2png
             
             # build options portion of URL
             url_options = []
-            url_options << "t#{ dim[:size] }" if dim[:size]
+            
+            # set thumbnail
+            options[:thumbnail] ||= options[:size]
+              
+            url_options << "t#{ options[:thumbnail] }"
             url_options << "s#{ options[:browser_size] }" if options[:browser_size]
             url_options << "d#{ options[:delay] }" if options[:delay]
             url_options << "FULL" if options[:fullscreen]
@@ -147,18 +158,18 @@ module Url2png
             ######
             # 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
             
@@ -179,14 +190,34 @@ module Url2png
               safe_url
             )
           end
+          
         end
       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
+            homepage = "https://github.com/robinhoudmeyers/url2png-gem"
+            raise "#{options} \n \"#{key}\" is not a valid option \nCheck the gem homepage for information about options: #{homepage}" unless key == :size
+            
+          end
+        end
+      end
+      
       # -----
       # Alias
       def site_image_tag url, options = {}
         url2png_image_tag(url, options)
-      end      
+      end
+      
+      def site_image_url url, options = {}
+        url2png_image_url(url, options)
+      end
     end
   end
 end

data/url2png.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "url2png"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   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-27"
+  s.date = "2012-08-14"
   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.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,11 +13,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70092339600580 !ruby/object:Gem::Requirement
+  requirement: &70337114355240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -25,10 +25,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70092339600580
+  version_requirements: *70337114355240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70092339599060 !ruby/object:Gem::Requirement
+  requirement: &70337114354700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -36,10 +36,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70092339599060
+  version_requirements: *70337114354700
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70092339613580 !ruby/object:Gem::Requirement
+  requirement: &70337114354220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -47,10 +47,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70092339613580
+  version_requirements: *70337114354220
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70092339611600 !ruby/object:Gem::Requirement
+  requirement: &70337114353720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -58,10 +58,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092339611600
+  version_requirements: *70337114353720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70092339606840 !ruby/object:Gem::Requirement
+  requirement: &70337114353200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -69,7 +69,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70092339606840
+  version_requirements: *70337114353200
 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: -354415127866206290
+      hash: 1894113596075630694
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: