ruby-nuggets 0.7.7 → 0.7.8

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to ruby-nuggets version 0.7.7
+This documentation refers to ruby-nuggets version 0.7.8
 
 
 == DESCRIPTION

data/lib/nuggets/uri/exist_mixin.rb

@@ -25,32 +25,29 @@
 ###############################################################################
 #++
 
+require 'nuggets/uri/redirect_mixin'
 require 'nuggets/net/success'
 
 module Nuggets
   module URI
     module ExistMixin
 
-  URI_EXIST_HTTP_CACHE = ::Hash.new { |h, k| h[k] = ::Net::HTTP.new(*k) }
+  def self.extended(base)
+    base.extend Nuggets::URI::RedirectMixin
+  end
 
   # call-seq:
-  #   URI.exist?(uri) => +true+ or +false+
+  #   URI.exist?(uri) => +true+, +false+ or +nil+
+  #   URI.exist?(uri) { |res| ... } => anObject, +false+ or +nil+
   #
-  # Return +true+ if the URI +uri+ exists.
-  def exist?(uri, cache = URI_EXIST_HTTP_CACHE, steps = 20, &block)
-    uri = ::URI.parse(uri.to_s)
-    return unless uri.is_a?(::URI::HTTP)
-
-    res = cache[[uri.host, uri.port]].head(uri.request_uri)
-
-    if res.is_a?(::Net::HTTPRedirection)
-      exist?(res['Location'], cache, steps - 1, &block) if steps > 0
-    elsif res.success?
-      block ? block[res] : true
-    else
-      false
-    end
-  rescue ::SocketError, ::Errno::EHOSTUNREACH
+  # Checks whether the URI +uri+ exists by performing a +HEAD+ request. If
+  # successful, yields the response to the given block and returns its return
+  # value, or +true+ if no block was given. Returns +false+ in case of failure,
+  # or +nil+ if the redirect limit has been exceeded.
+  #
+  # See Nuggets::URI::RedirectMixin#follow_redirect for more information.
+  def exist?(uri)
+    head_redirect(uri) { |res| res.success? && (!block_given? || yield(res)) }
   end
 
   alias_method :exists?, :exist?

data/lib/nuggets/uri/redirect.rb

@@ -0,0 +1,5 @@
+require 'nuggets/uri/redirect_mixin'
+
+module URI
+  extend Nuggets::URI::RedirectMixin
+end

data/lib/nuggets/uri/redirect_mixin.rb

@@ -0,0 +1,102 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2011 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU Affero General Public License as published by    #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License #
+# for more details.                                                           #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.        #
+#                                                                             #
+###############################################################################
+#++
+
+require 'net/https'
+
+module Nuggets
+  module URI
+    module RedirectMixin
+
+  # Maximum number of redirects to follow.
+  URI_REDIRECT_MAX_STEPS = 20
+
+  # Cache for HTTP objects to reuse.
+  URI_REDIRECT_HTTP_CACHE = ::Hash.new { |h, k| h[k] = ::Net::HTTP.new(*k) }
+
+  # call-seq:
+  #   URI.follow_redirect(uri[, steps]) { |req, path| ... } => aResponse or +nil+
+  #
+  # Performs any HTTP request on +uri+ while following at most +steps+ redirects.
+  # Accepts both strings and URI objects for +uri+. Defers to the given block to
+  # perform the actual request; yields the request object and the request URI
+  # string.
+  #
+  # Returns the response object if successful, or +nil+ if +uri+ is not an HTTP
+  # URI, the redirect limit has been exceeded, or any connection error occurs.
+  def follow_redirect(uri, steps = URI_REDIRECT_MAX_STEPS, cache = URI_REDIRECT_HTTP_CACHE)
+    unless uri.is_a?(::URI::HTTP)
+      uri = ::URI.parse(uri.to_s)
+      return unless uri.is_a?(::URI::HTTP)
+    end
+
+    req = cache[[uri.host, uri.port]]
+    req.use_ssl = uri.is_a?(::URI::HTTPS)
+
+    ctx = req.instance_variable_get(:@ssl_context) if req.use_ssl?
+    ctx.verify_mode ||= ::OpenSSL::SSL::VERIFY_NONE if ctx
+
+    res = yield req, uri.request_uri
+    return res unless res.is_a?(::Net::HTTPRedirection)
+    return nil unless steps > 0
+
+    follow_redirect(res['Location'], steps - 1, cache) { |*a| yield(*a) }
+  rescue ::SocketError, ::Errno::EHOSTUNREACH
+  end
+
+  # call-seq:
+  #   URI.head_redirect(uri[, steps]) => aResponse or +nil+
+  #   URI.head_redirect(uri[, steps]) { |res| ... } => anObject or +nil+
+  #
+  # Performs a +HEAD+ request on +uri+ while following at most +steps+ redirects.
+  # If successful, yields the response to the given block and returns its return
+  # value, or the response itself if no block was given. Returns +nil+ in case
+  # of failure.
+  #
+  # See Nuggets::URI::RedirectMixin#follow_redirect for more information.
+  def head_redirect(uri, steps = URI_REDIRECT_MAX_STEPS)
+    res = follow_redirect(uri, steps) { |req, path| req.head(path) }
+    res && block_given? ? yield(res) : res
+  end
+
+  # call-seq:
+  #   URI.get_redirect(uri[, steps]) => aResponse or +nil+
+  #   URI.get_redirect(uri[, steps]) { |res| ... } => anObject or +nil+
+  #
+  # Performs a +GET+ request on +uri+ while following at most +steps+ redirects.
+  # If successful, yields the response to the given block and returns its return
+  # value, or the response itself if no block was given. Returns +nil+ in case
+  # of failure.
+  #
+  # See Nuggets::URI::RedirectMixin#follow_redirect for more information.
+  def get_redirect(uri, steps = URI_REDIRECT_MAX_STEPS)
+    res = follow_redirect(uri, steps) { |req, path| req.get(path) }
+    res && block_given? ? yield(res) : res
+  end
+
+    end
+  end
+end

data/lib/nuggets/version.rb

@@ -4,7 +4,7 @@ module Nuggets
 
     MAJOR = 0
     MINOR = 7
-    TINY  = 7
+    TINY  = 8
 
     class << self
 

data/spec/nuggets/uri/content_type_spec.rb

@@ -14,12 +14,17 @@ describe URI, 'when extended by', Nuggets::URI::ContentTypeMixin do
   %w[
     htp://www.google.de
     www.google.de
-    http://blackwinter.de/bla
     http://blawinter.de
   ].each { |u|
     example { URI.content_type(u).should == nil }
   }
 
+  %w[
+    http://blackwinter.de/bla
+  ].each { |u|
+    example { URI.content_type(u).should == false }
+  }
+
   {
     'http://blackwinter.de/misc/ww.png'                  => 'image/png',
     'http://blackwinter.de/misc/suicide_is_painless.mid' => 'audio/midi',

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-nuggets
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 7
-  - 7
-  version: 0.7.7
+  - 8
+  version: 0.7.8
 platform: ruby
 authors: 
 - Jens Wille
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-24 00:00:00 Z
+date: 2011-10-28 00:00:00 Z
 dependencies: []
 
 description: Some extensions to the Ruby programming language.
@@ -143,6 +143,8 @@ files:
 - lib/nuggets/io/null.rb
 - lib/nuggets/io/agrep.rb
 - lib/nuggets/uri/content_type.rb
+- lib/nuggets/uri/redirect_mixin.rb
+- lib/nuggets/uri/redirect.rb
 - lib/nuggets/uri/exist_mixin.rb
 - lib/nuggets/uri/content_type_mixin.rb
 - lib/nuggets/uri/exist.rb
@@ -199,7 +201,7 @@ rdoc_options:
 - UTF-8
 - --all
 - --title
-- ruby-nuggets Application documentation (v0.7.7)
+- ruby-nuggets Application documentation (v0.7.8)
 - --line-numbers
 require_paths: 
 - lib