http_configuration 1.0.2 → 1.0.3

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Brian Durand
+Copyright (c) 2010 Brian Durand
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README → README.rodc}

@@ -33,24 +33,3 @@ When a configuration is applied to a block, you can also pass in some override v
 If your code has to live in an environment that requires a proxy server, you may have run into problems with externally developed code where the author didn't have to worry about proxies. With this code installed, you don't have to worry about breaking open the code and hacking it up to add proxy support.
 
 Similarly, if you are building a high traffic web site that makes web service calls to external hosts, you may want to set HTTP timeouts to lower values so that if the external server is running slow, your server doesn't end up eating up all its threads waiting on that server. For example, suppose you have a site that handles 10 requests per second and 1% of those requests make a web service request to another server and to handle that traffic, you have 50 mongrel servers available. If the external service goes crazy for some reason and starts taking 60 seconds to serve a response that normally takes less than 1 second, you will start loosing a mongrel server every 10 seconds and your site will be completely down in about 10 minutes. You could significantly lower this risk by setting the open and read timeouts on HTTP to be a much smaller value. You'll still end up with errors, but the site won't go down.
-
-== Fix For Timeouts
-
-One potential issue you can have with the Net::HTTP is that it handles timeouts by throwing interrupts. This is very effective however, interrupts have the unfortunate side effect of killing the current thread. This can be quite a problem. Consider this code:
-
-	loop do
-	  begin
-			begin_really_important_transaction()
-	    Net::HTTP.get('http://www.example.com/really_important_request')
-		rescue => e
-		  logger.warn(e)
-			Notifications.new(:critical).send("The really important request failed; this must be fixed immediately.")
-		ensure
-			finish_really_important_transaction()
-		end
-		sleep(300)
-	end
-
-If the HTTP request times out, the code will not execute they way you'd think. It will receive an interrupt and immediately exit. The log warning and notification will not be sent. Further, the ensure block will not even be executed which could be really bad.
-
-This code simply sets the default exception to be thrown by timeouts in the Net module to Net::NetworkTimeoutError instead of TimeoutError. Since Net::NetworkTimeoutError doesn't extend from Interrupt, your thread can go on its merry way.

data/Rakefile

@@ -1,43 +1,45 @@
 require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'spec/rake/spectask'
 
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test http_configuration.'
-Spec::Rake::SpecTask.new(:test) do |t|
-  t.spec_files = 'spec/**/*_spec.rb'
+begin
+  require 'spec/rake/spectask'
+  desc 'Test the gem.'
+  Spec::Rake::SpecTask.new(:test) do |t|
+    t.spec_files = FileList.new('spec/**/*_spec.rb')
+  end
+rescue LoadError
+  tast :test do
+    STDERR.puts "You must have rspec >= 1.3.0 to run the tests"
+  end
 end
 
-desc 'Generate documentation for http_configuration.'
+desc 'Generate documentation for the gem.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.options << '--title' << 'HTTP Configuration' << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README')
+  rdoc.options << '--title' << 'HTTP Configuration' << '--line-numbers' << '--inline-source' << '--main' << 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-spec = Gem::Specification.new do |s| 
-  s.name = "http_configuration"
-  s.version = "1.0.2"
-  s.author = "Brian Durand"
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Provide configuration options for Net::HTTP"
-  s.files = FileList["lib/*", "init.rb", "MIT-LICENSE", 'Rakefile'].to_a
-  s.require_path = "lib"
-  s.test_files = FileList["{spec}/**/*_spec.rb"].to_a
-  s.has_rdoc = true
-  s.rdoc_options << '--title' << 'HTTP Configuration' << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  s.extra_rdoc_files = ["README"]
-  s.homepage = "http://httpconfig.rubyforge.org"
-  s.rubyforge_project = "httpconfig"
-  s.email = 'brian@embellishedvisions.com'
-  s.requirements = 'rspec 1.0.8 or higher is needed to run the tests'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "http_configuration"
+    gem.summary = %Q{Gem that provides the ability to set defaults for proxies and timeouts for Net::HTTP.}
+    gem.description = %Q(Gem that provides the ability to set defaults for proxies and timeouts for Net::HTTP. Simplifies integration of HTTP calls into any environment and provides a unified interface for setting values.)
+    gem.email = "brian@embellishedvisions.com"
+    gem.homepage = "http://github.com/bdurand/acts_as_revisionable"
+    gem.authors = ["Brian Durand"]
+    gem.rdoc_options = ["--charset=UTF-8", "--main", "README.rdoc"]
+    
+    gem.add_development_dependency('rspec', '>= 1.3.0')
+    gem.add_development_dependency('jeweler')
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
 end
- 
-Rake::GemPackageTask.new(spec) do |pkg| 
-  pkg.need_tar = true 
-end

data/VERSION

@@ -0,0 +1 @@
+1.0.3

data/http_configuration.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{http_configuration}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Durand"]
+  s.date = %q{2010-06-22}
+  s.description = %q{Gem that provides the ability to set defaults for proxies and timeouts for Net::HTTP. Simplifies integration of HTTP calls into any environment and provides a unified interface for setting values.}
+  s.email = %q{brian@embellishedvisions.com}
+  s.extra_rdoc_files = [
+    "README.rodc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rodc",
+     "Rakefile",
+     "VERSION",
+     "http_configuration.gemspec",
+     "lib/http_configuration.rb",
+     "spec/http_configuration_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/bdurand/acts_as_revisionable}
+  s.rdoc_options = ["--charset=UTF-8", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Gem that provides the ability to set defaults for proxies and timeouts for Net::HTTP.}
+  s.test_files = [
+    "spec/http_configuration_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/http_configuration.rb

@@ -2,33 +2,7 @@ require 'net/protocol'
 require 'net/http'
 
 module Net
-  
-  class Protocol
-    
-    private
-    
-    # Default error type to a non-interrupt exception
-    def timeout (secs, errorType = NetworkTimeoutError)
-      super(secs, errorType)
-    end
-    
-  end
-  
-  class BufferedIO
     
-    private
-    
-    # Default error type to a non-interrupt exception
-    def timeout (secs, errorType = NetworkTimeoutError)
-      super(secs, errorType)
-    end
-    
-  end
-  
-  # Error thrown by network timeouts
-  class NetworkTimeoutError < StandardError
-  end
-  
   class HTTP
     
     class << self
@@ -106,37 +80,39 @@ module Net
         end
       end
       
-      def self.no_proxy? (host, options)
-        return false unless options[:no_proxy].kind_of?(Array)
+      class << self
+        def no_proxy? (host, options)
+          return false unless options[:no_proxy].kind_of?(Array)
         
-        host = host.downcase
-        options[:no_proxy].each do |pattern|
-          pattern = pattern.downcase
-          return true if host[-pattern.length, pattern.length] == pattern
-        end
+          host = host.downcase
+          options[:no_proxy].each do |pattern|
+            pattern = pattern.downcase
+            return true if host[-pattern.length, pattern.length] == pattern
+          end
         
-        return false
-      end
+          return false
+        end
       
-      # Set the options for a global configuration used for all HTTP requests. The global configuration can be cleared
-      # by setting nil
-      def self.set_global (options)
-        if options
-          @global = Configuration.new(options)
-        else
-          @global = nil
+        # Set the options for a global configuration used for all HTTP requests. The global configuration can be cleared
+        # by setting nil
+        def set_global (options)
+          if options
+            @global = Configuration.new(options)
+          else
+            @global = nil
+          end
         end
-      end
       
-      def self.global
-        @global
-      end
+        def global
+          @global
+        end
       
-      # Get the current configuration that is in scope.
-      def self.current
-        stack = Thread.current[:net_http_configuration]
-        config = stack.last if stack
-        config || global
+        # Get the current configuration that is in scope.
+        def current
+          stack = Thread.current[:net_http_configuration]
+          config = stack.last if stack
+          config || global
+        end
       end
       
       private

data/spec/http_configuration_spec.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'spec'
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'http_configuration'))
 
-describe "Net::HTTP::Configuration" do
+describe Net::HTTP::Configuration do
   
   it "should set the default configuration options" do
     config = Net::HTTP::Configuration.new(:proxy_host => 'localhost', :proxy_port => 8080, :no_proxy => ['local1', 'local2'])
@@ -145,25 +145,3 @@ describe "Net::HTTP" do
   end
   
 end
-
-describe "Net::BufferedIO" do
-  
-  it "should timeout without an interrupt" do
-    io = Net::BufferedIO.new(StringIO.new)
-    lambda do
-      io.send(:timeout, 1){sleep(2)}
-    end.should raise_error(Net::NetworkTimeoutError)
-  end
-
-end
-
-describe "Net::Protocol" do
-  
-  it "should timeout without an interrupt" do
-    http = Net::HTTP.new('localhost')
-    lambda do
-      http.send(:timeout, 1){sleep(2)}
-    end.should raise_error(Net::NetworkTimeoutError)
-  end
-  
-end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: http_configuration
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Brian Durand
@@ -9,54 +15,91 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-17 00:00:00 -06:00
+date: 2010-06-22 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
-description: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Gem that provides the ability to set defaults for proxies and timeouts for Net::HTTP. Simplifies integration of HTTP calls into any environment and provides a unified interface for setting values.
 email: brian@embellishedvisions.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rodc
 files: 
-- lib/http_configuration.rb
-- init.rb
+- .gitignore
 - MIT-LICENSE
+- README.rodc
 - Rakefile
-- README
+- VERSION
+- http_configuration.gemspec
+- lib/http_configuration.rb
+- spec/http_configuration_spec.rb
 has_rdoc: true
-homepage: http://httpconfig.rubyforge.org
+homepage: http://github.com/bdurand/acts_as_revisionable
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --title
-- HTTP Configuration
-- --line-numbers
-- --inline-source
+- --charset=UTF-8
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
-requirements: 
-- rspec 1.0.8 or higher is needed to run the tests
-rubyforge_project: httpconfig
-rubygems_version: 1.0.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
-summary: Provide configuration options for Net::HTTP
+specification_version: 3
+summary: Gem that provides the ability to set defaults for proxies and timeouts for Net::HTTP.
 test_files: 
 - spec/http_configuration_spec.rb

data/init.rb

@@ -1 +0,0 @@
-require 'http_configuration'