http-exceptions 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3cbfab4c8ab282ed02c2aaf6b10d9e4bb8c63a0
-  data.tar.gz: 977eec99de141b1ae88616d289462b2b6f263845
+  metadata.gz: 3dd2e0213e9efb0ed35cb07bd193f9b86ce0f9d5
+  data.tar.gz: 243069506cecfd6c0ddfc1bd547147316a555f18
 SHA512:
-  metadata.gz: aca9e8547cd540fb16e999d39b7843a52e55f09d377d8dcb69b0545e49ca346b1f4f7d3ba228d8ab89719dfdaf8a0b6a41e7d4f20107855288af5c4da9d28e1d
-  data.tar.gz: ebb9b8326a72386e708b22bd1d0b73ffeab46e61ab3257a73c2ad32aa514302ddb4b740570916ee263d77fa673c89906dc67c56dbe7958b22d7c7f5e1ece3721
+  metadata.gz: 7deb67a6d04d8eb57c9e23a57862630f241f1958b5e3fc7378abcd9510ec36fc5f909211a4c07d5ffcef4289877b7ad966c4e7d82d6f6ae6f516737c237ea810
+  data.tar.gz: e106195b15e6c5edb957d7a26549b19c3f8ccabb2af0ab9388d5bae449d9f20a9c0219be35d5a57eafa3ef5a3e6d30ef22d9c3dc092ada8d0d687ddca2dee872

data/.gitignore

@@ -21,3 +21,6 @@ tmp
 *.a
 mkmf.log
 tags
+
+# RubyMine project files
+.idea/

data/.travis.yml

@@ -1,6 +1,20 @@
+# Send builds to container-based infrastructure
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
 language: ruby
+cache:
+  - bundler
 rvm:
-  - 2.1.2
-  - 2.0.0
-  - 1.9.3
+  - 2.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
 script: bundle exec rspec spec
+# ! Update bundler before running test in Travis to avoid buggy version of bundler
+before_install:
+  - gem update bundler
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head

data/lib/http/exceptions/configuration.rb

@@ -0,0 +1,28 @@
+module Http
+  module Exceptions
+    class Configuration
+      DEFAULT_EXCEPTIONS_TO_CONVERT = [
+        SocketError,
+        Errno::ETIMEDOUT,
+        (Net.const_defined?(:ReadTimeout) ? Net::ReadTimeout : EOFError),
+        (Net.const_defined?(:OpenTimeout) ? Net::OpenTimeout : EOFError),
+        Net::ProtocolError,
+        Errno::ECONNREFUSED,
+        Errno::EHOSTDOWN,
+        Errno::ECONNRESET,
+        Errno::ENETUNREACH,
+        Errno::EHOSTUNREACH,
+        Errno::ECONNABORTED,
+        OpenSSL::SSL::SSLError,
+        EOFError,
+      ].uniq.freeze
+
+      # Exception classes to be converted to Http::Exceptions::HttpException
+      attr_accessor :exceptions_to_convert
+
+      def initialize
+        self.exceptions_to_convert = DEFAULT_EXCEPTIONS_TO_CONVERT
+      end
+    end
+  end
+end

data/lib/http/exceptions/version.rb

@@ -1,5 +1,5 @@
 module Http
   module Exceptions
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

data/lib/http/exceptions.rb

@@ -1,4 +1,5 @@
 require "http/exceptions/version"
+require "http/exceptions/configuration"
 require "http/exceptions/http_exception"
 
 module Http
@@ -12,6 +13,9 @@ module Http
       Errno::ECONNREFUSED,
       Errno::EHOSTDOWN,
       Errno::ECONNRESET,
+      Errno::ENETUNREACH,
+      Errno::EHOSTUNREACH,
+      Errno::ECONNABORTED,
       OpenSSL::SSL::SSLError,
       EOFError,
     ].freeze
@@ -19,7 +23,7 @@ module Http
     def self.wrap_exception
       begin
         yield
-      rescue *Exceptions::EXCEPTIONS => e
+      rescue *configuration.exceptions_to_convert => e
         raise HttpException.new original_exception: e
       end
     end
@@ -34,5 +38,23 @@ module Http
         check_response! yield
       end
     end
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   Http::Exceptions.configure do |config|
+    #     config.exceptions_to_convert = [Net::ProtocolError]
+    #     config.exceptions_to_convert << EOFError
+    #   end
+    def self.configure
+      yield(configuration)
+      self
+    end
+
+    # The configuration object.
+    # @see Http::Exceptions.configure
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
   end
 end

data/spec/http/exceptions/configuration_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Http::Exceptions::Configuration do
+  attribute_name_and_default_value_mappings = {
+    exceptions_to_convert: Http::Exceptions::Configuration::DEFAULT_EXCEPTIONS_TO_CONVERT,
+  }.freeze
+
+  describe "default values" do
+    subject(:model) { described_class.new }
+
+    attribute_name_and_default_value_mappings.each do |attribute_name, default_value|
+      context "for attribute #{attribute_name}" do
+        subject { model.public_send(attribute_name) }
+
+        it {should eq(default_value)}
+      end
+    end
+  end
+
+  describe "configurable attributes" do
+    subject(:model) { described_class.new }
+
+    attribute_name_and_default_value_mappings.each_key do |attribute_name|
+      context "for attribute #{attribute_name}" do
+        let(:attribute_name) { attribute_name }
+        let(:new_value) { :dummy_value_for_attribute }
+
+        subject { model.public_send(attribute_name) }
+
+        before do
+          expect(model.public_send(attribute_name)).to_not eq(new_value)
+          model.public_send("#{attribute_name}=", new_value)
+        end
+
+        it {should eq(new_value)}
+      end
+    end
+  end
+end

data/spec/http_exception_spec.rb

@@ -8,30 +8,41 @@ describe Http::Exceptions do
   end
 
   describe ".wrap_exception" do
-    it "raises an HttpException on supported http exceptions" do
-      expect do
-        described_class.wrap_exception do
-          raise SocketError
-        end
-      end.to raise_error(Http::Exceptions::HttpException)
-    end
+    let(:supported_exception_class) { Http::Exceptions::Configuration::DEFAULT_EXCEPTIONS_TO_CONVERT.first }
+    let(:unsupported_exception_class) { TestException }
 
-    it "saves the original exception against the HttpException" do
-      begin
-        described_class.wrap_exception do
-          raise SocketError
+    context "when exception class is supported" do
+      before { expect(Http::Exceptions.configuration.exceptions_to_convert).to include(supported_exception_class) }
+
+      it "raises an HttpException on supported http exceptions" do
+        expect do
+          described_class.wrap_exception do
+            raise supported_exception_class
+          end
+        end.to raise_error(Http::Exceptions::HttpException)
+      end
+
+      it "saves the original exception against the HttpException" do
+        begin
+          described_class.wrap_exception do
+            raise supported_exception_class
+          end
+        rescue Http::Exceptions::HttpException => e
+          expect(e.original_exception).to be_a(supported_exception_class)
         end
-      rescue Http::Exceptions::HttpException => e
-        expect(e.original_exception).to be_a(SocketError)
       end
     end
 
-    it "ignores other exceptions" do
-      expect do
-        described_class.wrap_exception do
-          raise TestException
-        end
-      end.to raise_error(TestException)
+    context "when exception class is NOT supported" do
+      before { expect(Http::Exceptions.configuration.exceptions_to_convert).to_not include(unsupported_exception_class) }
+
+      it "ignores other exceptions" do
+        expect do
+          described_class.wrap_exception do
+            raise unsupported_exception_class
+          end
+        end.to raise_error(unsupported_exception_class)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-exceptions
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Simon Mathieu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,8 +55,10 @@ files:
 - Rakefile
 - http-exceptions.gemspec
 - lib/http/exceptions.rb
+- lib/http/exceptions/configuration.rb
 - lib/http/exceptions/http_exception.rb
 - lib/http/exceptions/version.rb
+- spec/http/exceptions/configuration_spec.rb
 - spec/http_exception_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -79,10 +81,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: An easy way to rescue exceptions that might be thrown by your Http library
 test_files:
+- spec/http/exceptions/configuration_spec.rb
 - spec/http_exception_spec.rb
 - spec/spec_helper.rb
+has_rdoc: