timeout_errors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9faa0296a894770ca85ab6d03668ee24dfba3bd8
+  data.tar.gz: 6365ff6f93710aa36e9f1131fa3ab50001099ac9
+SHA512:
+  metadata.gz: e35695f4457163c8980b50d637181639789580529d7635a7440ad24bce6630a2c329741ed7a0d28b7831fb9d3565a85dc9b4ae41061c6a905348e8ac783a9216
+  data.tar.gz: c3d03500061d5d84645c709e93ef69dbb0173c027fca5291fcd8499066e28e505eddb4b9a50544b340439bf7a87f1682eb686a3777cf6942da9e31804f758a69

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in timeout_errors.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genadi Samokovarov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# Timeout Errors
+
+Catch all of them Net::HTTP timeout errors. Why? Because there are lots of
+them.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'timeout_errors'
+```
+
+## Play
+
+Let's playing a game. You do a request. It times out. You try to guess which
+error it timed out with. Here's how you win every time.
+
+```ruby
+require 'uri'
+require 'timeout_errors'
+
+begin
+  uri = URI.parse("http://imsuresomeonewillregisterthatjusttotroll.me/")
+  Net::HTTP.get_response(uri)
+rescue TimeoutErrors => e
+  puts "And the winner is: #{e.inspect}"
+end
+```
+
+Now, imagine your favourite 3rd party HTTP client library, that uses `net/http`
+under the hook invents yet another one of those pesky timeout errors. If you
+play the game with that specific 3rd party library, you are quite likely to
+loose. Here's how you can improve your chances:
+
+```ruby
+require 'best_http_client_ever_because_we_need_yet_another_one'
+require 'timeout_errors'
+
+TimeoutErrors.include_error(
+  BestHttpClientEverBecauseWeNeedYetAnotherOne::YetAnotherTimeoutToSolveItAllError
+)
+
+begin
+  BestHttpClientEverBecauseWeNeedYetAnotherOne.get(
+    "http://imsuresomeonewillregisterthatjusttotroll.me/"
+  )
+rescue TimeoutErrors => e
+  puts "Your favourite timeout error is: #{e.inspect}"
+end
+```
+
+Quite useful, heh?
+
+## Winners
+
+Here's the list of errors caught by `TimeoutErrors` by default.
+
+- `EOFError`
+- `Errno::ECONNREFUSED`
+- `Errno::ECONNRESET`
+- `Errno::EHOSTUNREACH`
+- `Errno::EINVAL`
+- `Errno::ENETUNREACH`
+- `Errno::EPIPE`
+- `Errno::ETIMEDOUT`
+- `Net::HTTPBadResponse`
+- `Net::HTTPHeaderSyntaxError`
+- `Net::ProtocolError`
+- `SocketError`
+- `Timeout::Error`
+
+Not that you can fill this list during runtime with
+`TimeoutErrors.include_error`.
+
+## Why
+
+There is a lot of previous art on this topic. Why create another one?
+
+### [net_http_timeout_errors]
+
+This library is a great choice. It uses standard Ruby interface and clearly
+lists all the errors. However, I wanna catch them all with a single `rescue
+ErrorMatcher` clause. Which leads us to [net_http_exception_fix].
+
+### [net_http_exception_fix]
+
+[net_http_exception_fix] is a hotfix to give those common exceptions that pop
+up from Net:HTTP usage a shared parent exception class. This is the interface I
+like, however it is achieved through polluting builtin' errors ancestor chain.
+
+## How
+
+Instead of introducing extra interface, or monkey patching existing errors,
+this library exploits a fun little fact about Ruby's exception handling. Errors
+listed on the `rescue` clause are matched with the case (`===`) operator.
+
+## Credits
+
+Thanks to the authors and contributors of [net_http_timeout_errors] and
+[net_http_exception_fix].
+
+[net_http_timeout_errors]: https://github.com/barsoom/net_http_timeout_errors
+[net_http_exception_fix]: https://github.com/edward/net_http_exception_fix

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/lib/timeout_errors.rb

@@ -0,0 +1,36 @@
+require "timeout_errors/version"
+require "net/http"
+
+module TimeoutErrors
+  extend self
+
+  def include_error(error)
+    errors << error
+  end
+
+  def ===(other)
+    errors.any? { |error| error === other }
+  end
+
+  private
+
+  def errors
+    @@errors ||= []
+  end
+end
+
+[
+  EOFError,
+  Errno::ECONNREFUSED,
+  Errno::ECONNRESET,
+  Errno::EHOSTUNREACH,
+  Errno::EINVAL,
+  Errno::ENETUNREACH,
+  Errno::EPIPE,
+  Errno::ETIMEDOUT,
+  Net::HTTPBadResponse,
+  Net::HTTPHeaderSyntaxError,
+  Net::ProtocolError,
+  SocketError,
+  Timeout::Error,
+].each(&TimeoutErrors.method(:include_error))

data/lib/timeout_errors/version.rb

@@ -0,0 +1,3 @@
+module TimeoutErrors
+  VERSION = "1.0.0"
+end

data/test/timeout_errors_test.rb

@@ -0,0 +1,47 @@
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require "minitest/autorun"
+require "timeout_errors"
+
+class TimeoutErrorsTest < MiniTest::Test
+  def test_catches_the_default_list_of_errors
+    default_errors.each(&method(:assert_catches))
+  end
+
+  def test_includes_custom_errors
+    custom_error = Class.new(StandardError)
+    TimeoutErrors.include_error(custom_error)
+
+    assert_catches(custom_error)
+  end
+
+  private
+
+  def default_errors
+    [
+      EOFError,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EHOSTUNREACH,
+      Errno::EINVAL,
+      Errno::ENETUNREACH,
+      Errno::EPIPE,
+      Errno::ETIMEDOUT,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      SocketError,
+      Timeout::Error,
+    ]
+  end
+
+  def assert_catches(error)
+    begin
+      raise error
+    rescue TimeoutErrors
+      # Great success!
+    else
+      flunk "Expected to catch #{error}, but didn't"
+    end
+  end
+end

data/timeout_errors.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+
+require "timeout_errors/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "timeout_errors"
+  spec.version       = TimeoutErrors::VERSION
+  spec.authors       = ["Genadi Samokovarov"]
+  spec.email         = ["gsamokovarov@gmail.com"]
+  spec.summary       = %q(Catch all of them Net::HTTP timeout errors)
+  spec.homepage      = "https://github.com/gsamokovarov/timeout_errors"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: timeout_errors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/timeout_errors.rb
+- lib/timeout_errors/version.rb
+- test/timeout_errors_test.rb
+- timeout_errors.gemspec
+homepage: https://github.com/gsamokovarov/timeout_errors
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Catch all of them Net::HTTP timeout errors
+test_files:
+- test/timeout_errors_test.rb