ae_network_connection_exception 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69c47de028f1f0de4f3625fdf83a28fca3d6bbd1
+  data.tar.gz: 27cbec84b9eaa7002eacaba19b3ace203a8d2b85
+SHA512:
+  metadata.gz: d62132d7ed9febb5a1e1fe2eb0bbac4c33273708161ebad9731f1a1226ac699516c52434b2c29c3517f1493f239a17da11bdb685136aa36f6e071c0a8640a88b
+  data.tar.gz: ca6a7edd4917f54e299ff3374c42e5a74f8a81d31bde26530c471a3d4d3f69ac1f1a234400a2a89a4e6ac2ebe266de6c212961c6f62f643c178d5a5b47694bf2

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,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ae_network_connection_exception.gemspec
+gemspec
+
+gem 'test-unit'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 AppFolio, inc.
+
+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,35 @@
+# AeNetworkConnectionException
+
+A simple gem that will catch all manner of exceptions related to establishing a network connection and return a more generic error.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ae_network_connection_exception'
+```
+
+And then execute:
+
+    $ bundle
+
+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
+
+## Contributing
+
+1. Fork it ( https://github.com/appfolio/ae_network_connection_exception/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/unit/**/*_test.rb'
+  test.verbose = true
+end
+
+

data/ae_network_connection_exception.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ae_network_connection_exception/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ae_network_connection_exception"
+  spec.version       = AeNetworkConnectionException::VERSION
+  spec.authors       = ["Steven Boyd"]
+  spec.email         = ["engineering@appfolio.com"]
+  spec.summary       = "Provides sane exceptions for network failures"
+  spec.description   = "A simple gem that will catch all manner of exceptions related to establishing a network connection and return a more generic error."
+  spec.homepage      = "http://github.com/appfolio/ae_network_connection_exception"
+  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"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ae_network_connection_exception.rb

@@ -0,0 +1,37 @@
+require "ae_network_connection_exception/version"
+require "socket"
+
+module AeNetworkConnectionException
+  
+  class ConnectionNotEstablished < StandardError
+    attr_reader :cause
+    
+    def initialize(message = nil, cause = $!)
+      super(message)
+      @cause = cause
+    end
+
+    def message
+      own_message = super
+
+      if cause
+        message = "#{own_message}, "
+        message + "cause => #{cause.class}: #{cause.message}"
+      else
+        own_message
+      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

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

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$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 'ae_network_connection_exception'
+

data/test/unit/ae_network_connection_exception_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+module AeNetworkConnectionException
+  class AeNetworkConnectionExceptionTest < Test::Unit::TestCase
+    def test_connection_not_established_exception
+      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
+
+      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
+    end
+
+    def test_ae_network_connection_exception_try__doesnt_catch_non_network_exceptions
+      exception = StandardError.new
+      e = return_raised_error do
+        AeNetworkConnectionException.try do
+          raise exception
+        end
+      end
+      assert_equal exception, e
+    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
+      
+      
+
+      e = return_raised_error do
+        AeNetworkConnectionException.try do
+          raise Errno::ECONNRESET.new('Connection timed out - connect(2) for "example.com" port 443')
+        end
+      end
+      assert_equal Errno::ECONNRESET, e.class
+      
+      e = return_raised_error do
+        AeNetworkConnectionException.try do
+          raise Errno::ETIMEDOUT.new('Connection timed out - recvfrom(2) for "example.com" port 443')
+        end
+      end
+      assert_equal Errno::ETIMEDOUT, e.class
+      
+    end
+
+    private
+
+    def return_raised_error
+      yield
+    rescue => e
+      return e
+    end
+  end
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ae_network_connection_exception
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steven Boyd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 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'
+description: A simple gem that will catch all manner of exceptions related to establishing
+  a network connection and return a more generic error.
+email:
+- engineering@appfolio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ae_network_connection_exception.gemspec
+- lib/ae_network_connection_exception.rb
+- lib/ae_network_connection_exception/version.rb
+- test/test_helper.rb
+- test/unit/ae_network_connection_exception_test.rb
+homepage: http://github.com/appfolio/ae_network_connection_exception
+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.4.1
+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: