fastimage 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b171e7bf1f4fd89ec28ce3b4f3ddfb3686a71d00
-  data.tar.gz: a851e15026cdd61e9e13923b73c73b0a004a4f13
+  metadata.gz: 7228e29b8a52ce589113f051bc142a9e55fefe86
+  data.tar.gz: 6b50be8521f450dd9da08ab018e9a2467c66e62c
 SHA512:
-  metadata.gz: 6f0891068f233455992127dedeea3e11c69cf17c292c08b8ce18aad3e20582921f1f3d7b109c35ad2b70e64b082157525546f3326c7592d6fef5012d75199a94
-  data.tar.gz: a28dae9ccdd8aa0741e8fb45dc9f8078c10ca3ebecaa872a234e0a7f5c79c2428622e0077d6e9667eb0d39d46b5e79757ee46a230b4c126a61815176ece50cf7
+  metadata.gz: 279f60c5b465c44af94619671f803bac088e7b457a41b4b4c203dcbfbf0c0a44a08fd70cafa0740686f00b1b3f01f4efe1f272faac9add9602234aba804be95a
+  data.tar.gz: b8bc0f0ed9d6fb0944f5c28121a3f7d17a70f16eeee80bd4fb3a46525cd2153b59df5c959f8817a70cec395d50c5b61e599595d6f706fe9b56f094a139c88bff

data/README.textile

@@ -34,6 +34,8 @@ FastImage normally replies will nil if it encounters an error, but you can pass
 
 FastImage also provides a reader for the content length header provided in HTTP. This may be useful to assess the file size of an image, but do not rely on it exclusively - it will not be present in chunked responses for instance.
 
+FastImage accepts additional HTTP headers. This can be used to set a user agent or referrer which some servers require. Pass an :http_header argument to specify headers, e.g., :http_header => {'User-Agent' => 'Fake Browser'}.
+
 h2. Security
 
 As of v1.6.7 FastImage no longer uses openuri to open files, but directly calls File.open. But take care to sanitise the strings passed to FastImage; it will try to read from whatever is passed.
@@ -55,6 +57,8 @@ FastImage.size("http://upload.wikimedia.org/wikipedia/commons/b/b4/Mardin_135066
 => [9545, 6623]
 FastImage.new("http://stephensykes.com/images/pngimage").content_length
 => 432
+FastImage.size("http://stephensykes.com/images/ss.com_x.gif", :http_header => {'User-Agent' => 'Fake Browser'})
+=> [266, 56]
 </code></pre>
 
 h2. Installation
@@ -67,6 +71,8 @@ h4. Rails
 
 Add fastimage to your Gemfile, and bundle.
 
+bc. gem 'fastimage'
+
 Then you're off - just use @FastImage.size()@ and @FastImage.type()@ in your code as in the examples.
 
 h2. Documentation

data/lib/fastimage.rb

@@ -24,6 +24,10 @@
 # This may be useful to assess the file size of an image, but do not rely on it exclusively -
 # it will not be present in chunked responses for instance.
 #
+# FastImage accepts additional HTTP headers. This can be used to set a user agent
+# or referrer which some servers require. Pass an :http_header argument to specify headers,
+# e.g., :http_header => {'User-Agent' => 'Fake Browser'}.
+#
 # === Examples
 #   require 'fastimage'
 #
@@ -162,10 +166,16 @@ class FastImage
   end
 
   def initialize(uri, options={})
-    @property = options[:type_only] ? :type : :size
-    @timeout = options[:timeout] || DefaultTimeout
-    @proxy_url = options[:proxy]
     @uri = uri
+    @options = {
+      :type_only        => false,
+      :timeout          => DefaultTimeout,
+      :raise_on_failure => false,
+      :proxy            => nil,
+      :http_header      => {}
+    }.merge(options)
+
+    @property = @options[:type_only] ? :type : :size
 
     if uri.respond_to?(:read)
       fetch_using_read(uri)
@@ -185,17 +195,17 @@ class FastImage
 
     uri.rewind if uri.respond_to?(:rewind)
 
-    raise SizeNotFound if options[:raise_on_failure] && @property == :size && !@size
+    raise SizeNotFound if @options[:raise_on_failure] && @property == :size && !@size
 
   rescue Timeout::Error, SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ECONNRESET,
     ImageFetchFailure, Net::HTTPBadResponse, EOFError, Errno::ENOENT
-    raise ImageFetchFailure if options[:raise_on_failure]
+    raise ImageFetchFailure if @options[:raise_on_failure]
   rescue NoMethodError  # 1.8.7p248 can raise this due to a net/http bug
-    raise ImageFetchFailure if options[:raise_on_failure]
+    raise ImageFetchFailure if @options[:raise_on_failure]
   rescue UnknownImageType
-    raise UnknownImageType if options[:raise_on_failure]
+    raise UnknownImageType if @options[:raise_on_failure]
   rescue CannotParseImage
-    if options[:raise_on_failure]
+    if @options[:raise_on_failure]
       if @property == :size
         raise SizeNotFound
       else
@@ -214,8 +224,10 @@ class FastImage
   end
 
   def fetch_using_http_from_parsed_uri
+    http_header = {'Accept-Encoding' => 'identity'}.merge(@options[:http_header])
+
     setup_http
-    @http.request_get(@parsed_uri.request_uri, 'Accept-Encoding' => 'identity') do |res|
+    @http.request_get(@parsed_uri.request_uri, http_header) do |res|
       if res.is_a?(Net::HTTPRedirection) && @redirect_count < 4
         @redirect_count += 1
         begin
@@ -266,8 +278,8 @@ class FastImage
 
   def proxy_uri
     begin
-      if @proxy_url
-        proxy = Addressable::URI.parse(@proxy_url)
+      if @options[:proxy]
+        proxy = Addressable::URI.parse(@options[:proxy])
       else
         proxy = ENV['http_proxy'] && ENV['http_proxy'] != "" ? Addressable::URI.parse(ENV['http_proxy']) : nil
       end
@@ -287,8 +299,8 @@ class FastImage
     end
     @http.use_ssl = (@parsed_uri.scheme == "https")
     @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    @http.open_timeout = @timeout
-    @http.read_timeout = @timeout
+    @http.open_timeout = @options[:timeout]
+    @http.read_timeout = @options[:timeout]
   end
 
   def fetch_using_read(readable)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastimage
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Stephen Sykes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable