ae_network_connection_exception 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c47de028f1f0de4f3625fdf83a28fca3d6bbd1
-  data.tar.gz: 27cbec84b9eaa7002eacaba19b3ace203a8d2b85
+  metadata.gz: 57008730ed008f3e7650a1e544dbdc05a8baebf5
+  data.tar.gz: dbfe0dc6d6ce931af76f6756de8f1f94aedc16b4
 SHA512:
-  metadata.gz: d62132d7ed9febb5a1e1fe2eb0bbac4c33273708161ebad9731f1a1226ac699516c52434b2c29c3517f1493f239a17da11bdb685136aa36f6e071c0a8640a88b
-  data.tar.gz: ca6a7edd4917f54e299ff3374c42e5a74f8a81d31bde26530c471a3d4d3f69ac1f1a234400a2a89a4e6ac2ebe266de6c212961c6f62f643c178d5a5b47694bf2
+  metadata.gz: 556c1d3da505100cc80436e88f041016dbf8ea4e708215d179c1c2bfcff064b949df50c1f4bd1714de1649bee03e528693a1a6b2f0b16a784e767bed0c3c9ca9
+  data.tar.gz: d5b1f855026a713f9c2cfddd1bf3ef8fe8f277f00ddd6199711830c9260bc933fa12db1b5834eecb1890904ec2b2588004729226756bded90f3a5aa488598967

data/.gitignore

@@ -11,4 +11,5 @@
 *.so
 *.o
 *.a
+.idea
 mkmf.log

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in ae_network_connection_exception.gemspec
 gemspec
 
-gem 'test-unit'
+gem 'minitest', '~> 5.0'
 

data/README.md

@@ -19,12 +19,13 @@ Or install it yourself as:
     $ gem install ae_network_connection_exception
 
 ## Usage
-
+```
 AeNetworkConnectionException.try do
   # your code that will make a network call
 end
+```
 
- # If your network call failed to establise a network connection, an exception of type ```AeNetworkConnectionException::ConnectionNotEstablished``` will be thrown
+If your network call failed to establise a network connection, an exception of type ```AeNetworkConnectionException::ConnectionNotEstablished``` will be thrown
 
 ## Contributing
 

data/ae_network_connection_exception.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"

data/lib/ae_network_connection_exception.rb

@@ -4,34 +4,39 @@ require "socket"
 module AeNetworkConnectionException
   
   class ConnectionNotEstablished < StandardError
-    attr_reader :cause
-    
-    def initialize(message = nil, cause = $!)
-      super(message)
-      @cause = cause
-    end
+  end
 
-    def message
-      own_message = super
+  class << self
+    def try
+      yield
+    rescue SocketError, Net::OpenTimeout => e
+      # SocketError happens when we fail to connect to a socket. Common problems here are DNS resolution (i.e. getaddrinfo)
+      # Net::OpenTimeout happens when we are unable to establish an HTTP connection before the open_timeout
 
-      if cause
-        message = "#{own_message}, "
-        message + "cause => #{cause.class}: #{cause.message}"
+      raise ConnectionNotEstablished
+    rescue Errno::ETIMEDOUT, Errno::ECONNREFUSED => e
+      # Errno::ECONNREFUSED happens when we can not connect to the port
+      # Errno::ETIMEDOUT happens when we timeout durring the tcp handshake
+      # It is important to note, Errno::ETIMEDOUT can also happen after we have established a connection and are waiting for a response.
+      # Because of this, we also check that the sys call that was made is connect(2).
+      # Errno::* Exceptions have the following error message format
+      # "#{Message string} - #{syscall} for "#{host}" port #{port}"
+
+      raise_if_exception_message_matches(e, /connect\(2\)/)
+    rescue Errno::ECONNRESET => e
+      # Errno::ECONNRESET happens when the connection is reset. This can happen during ssl negotiation
+      
+      raise_if_exception_message_matches(e, /SSL_connect/)
+    end
+    
+    private
+    
+    def raise_if_exception_message_matches(exception, pattern)
+      if exception.message =~ pattern
+        raise ConnectionNotEstablished
       else
-        own_message
+        raise exception
       end
     end
   end
-
-  def self.try
-    yield
-  rescue SocketError => e
-    raise ConnectionNotEstablished
-  rescue SystemCallError => e
-    if ([Errno::ETIMEDOUT, Errno::ECONNREFUSED].include? e.class) && (e.message =~ /connect\(2\)/)
-      raise ConnectionNotEstablished
-    else
-      raise e
-    end
-  end
 end

data/lib/ae_network_connection_exception/version.rb

@@ -1,3 +1,3 @@
 module AeNetworkConnectionException
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/test_helper.rb

@@ -1,8 +1,4 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..')
-$LOAD_PATH << File.join(File.dirname(__FILE__))
-
 require 'rubygems'
-require 'test/unit'
+require 'minitest/autorun'
 require 'ae_network_connection_exception'
 

data/test/unit/ae_network_connection_exception_test.rb

@@ -1,31 +1,30 @@
 require 'test_helper'
 
 module AeNetworkConnectionException
-  class AeNetworkConnectionExceptionTest < Test::Unit::TestCase
+  class AeNetworkConnectionExceptionTest < Minitest::Test
     def test_connection_not_established_exception
+      # Exception Causes are standard with ruby 2.1
+      # http://devblog.avdi.org/2013/12/25/exception-causes-in-ruby-2-1
+      
       parent_exception = AeNetworkConnectionException::ConnectionNotEstablished.new("Parent Message")
 
       assert_equal nil, parent_exception.cause
       assert_equal "Parent Message", parent_exception.message
 
-      child_exception = StandardError.new("Child Message")
-      parent_exception = AeNetworkConnectionException::ConnectionNotEstablished.new("Parent Message", child_exception)
-
-      assert_equal child_exception, parent_exception.cause
-      assert_equal "Parent Message, cause => StandardError: Child Message", parent_exception.message
-
-      child_exception = nil
-      parent_exception = nil
       begin
-        raise StandardError.new("New Child Message")
-      rescue => e
-        child_exception = e
-        parent_exception = AeNetworkConnectionException::ConnectionNotEstablished.new("New Parent Message")
-      end
+        child_exception = nil
+        begin
+          raise StandardError.new("New Child Message")
+        rescue => e
+          child_exception = e
+          parent_exception = AeNetworkConnectionException::ConnectionNotEstablished.new("New Parent Message")
+        end
+      rescue AeNetworkConnectionException::ConnectionNotEstablished => parent_exception
 
-      assert_not_nil child_exception
-      assert_equal child_exception, parent_exception.cause
-      assert_equal "New Parent Message, cause => StandardError: New Child Message", parent_exception.message
+        refute_nil child_exception
+        assert_equal child_exception, parent_exception.cause
+        assert_equal "New Parent Message, cause => StandardError: New Child Message", parent_exception.message
+      end
     end
 
     def test_ae_network_connection_exception_try__doesnt_catch_non_network_exceptions
@@ -39,50 +38,37 @@ module AeNetworkConnectionException
     end
     
     def test_ae_network_connection_exception_try__raises_connection_not_establised_exception
-      e = return_raised_error do
-        AeNetworkConnectionException.try do
-          raise SocketError.new("getaddrinfo: Name or service not known")
-        end
-      end
-      assert_equal AeNetworkConnectionException::ConnectionNotEstablished, e.class
-      assert_equal SocketError, e.cause.class
-      
-      e = return_raised_error do
-        AeNetworkConnectionException.try do
-          raise Errno::ECONNREFUSED.new('Connection refused - connect(2) for "example.com" port 443')
-        end
-      end
-      assert_equal AeNetworkConnectionException::ConnectionNotEstablished, e.class
-      assert_equal Errno::ECONNREFUSED, e.cause.class
-      
-      e = return_raised_error do
-        AeNetworkConnectionException.try do
-          raise Errno::ETIMEDOUT.new('Connection timed out - connect(2) for "example.com" port 443')
-        end
-      end
-      assert_equal AeNetworkConnectionException::ConnectionNotEstablished, e.class
-      assert_equal Errno::ETIMEDOUT, e.cause.class
-      
+      assert_connection_not_established_thrown_for(SocketError.new("getaddrinfo: Name or service not known"))
+      assert_connection_not_established_thrown_for(Errno::ECONNREFUSED.new('Connection refused - connect(2) for "example.com" port 443'))
+      assert_connection_not_established_thrown_for(Errno::ETIMEDOUT.new('Connection timed out - connect(2) for "example.com" port 443'))
+      assert_connection_not_established_thrown_for(Net::OpenTimeout.new('message'))
+      assert_connection_not_established_thrown_for(Errno::ECONNRESET.new('Connection reset by peer - SSL_connect'))
       
+      assert_connection_not_established_not_thrown_for(Errno::ECONNRESET.new('Connection timed out - connect(2) for "example.com" port 443'))
+      assert_connection_not_established_not_thrown_for(Errno::ETIMEDOUT.new('Connection timed out - recvfrom(2) for "example.com" port 443'))
+    end
 
+    private
+    
+    def assert_connection_not_established_thrown_for(exception)
       e = return_raised_error do
         AeNetworkConnectionException.try do
-          raise Errno::ECONNRESET.new('Connection timed out - connect(2) for "example.com" port 443')
+          raise exception
         end
       end
-      assert_equal Errno::ECONNRESET, e.class
-      
+      assert_equal AeNetworkConnectionException::ConnectionNotEstablished, e.class
+      assert_equal exception, e.cause
+    end
+    
+    def assert_connection_not_established_not_thrown_for(exception)
       e = return_raised_error do
         AeNetworkConnectionException.try do
-          raise Errno::ETIMEDOUT.new('Connection timed out - recvfrom(2) for "example.com" port 443')
+          raise exception
         end
       end
-      assert_equal Errno::ETIMEDOUT, e.class
-      
+      assert_equal exception, e
     end
 
-    private
-
     def return_raised_error
       yield
     rescue => e

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_network_connection_exception
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steven Boyd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,11 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Provides sane exceptions for network failures
-test_files:
-- test/test_helper.rb
-- test/unit/ae_network_connection_exception_test.rb
-has_rdoc: 
+test_files: []