ae_network_connection_exception 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b7cafe89fcbcdaf9925c573d2634a2bb132c1e455410a58eb37aec03ee2f08d
-  data.tar.gz: f78429a43ab640d0ebb3c957b35a111811fa6e34a715904bcf9881b06b4a093e
+  metadata.gz: 670bacf7b250485b96be28e6623494ea3ef88e93830b27de6c7141d273d53737
+  data.tar.gz: cdcfd66f3fedd185fdb58fc8f6cdd2da0da799ddb22166a1ce270d608c8378fb
 SHA512:
-  metadata.gz: a571e1b3cc34c30bde269b5a3fcf756e2cd74eeef8d1399b6cc76b22404932d2a87a5988a72c5e20d6f2d7a1c07a02f6018bd5fadc02dfb0387034b7e4456175
-  data.tar.gz: 7b5cab2ccc00495417184b0dbbd7c3a42fd639d8051584273daef29e37f581bfa3004156b36483e6492cb89c9063911021d188559c0f81c44730e181f2a9e765
+  metadata.gz: 371c96edecc48bf85bde49dbe33a12afd216da04f40db63ae9bbbedbdcd200e10fe995467a9d60dc385542f1869e5f39440f77dbc731707cf0555ac1f36f4319
+  data.tar.gz: f0822a534739ba7d31c14b37873236d41c6a8adae6714ecd86f50ae95ee01ea800576963b158fee142ef88349fb3785f4dec8ec21addaeabf220cc851783baa1

data/LICENSE.txt

@@ -1,6 +1,4 @@
-Copyright (c) 2015 AppFolio, inc.
-
-MIT License
+Copyright (c) 2015-2021 AppFolio, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/ae_network_connection_exception.gemspec

@@ -1,21 +1,20 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ae_network_connection_exception/version'
+# frozen_string_literal: true
 
-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"
+require_relative 'lib/ae_network_connection_exception/version'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.require_paths = ["lib"]
+Gem::Specification.new do |spec|
+  spec.name                  = 'ae_network_connection_exception'
+  spec.version               = AeNetworkConnectionException::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.author                = 'AppFolio'
+  spec.email                 = 'opensource@appfolio.com'
+  spec.description           = 'Catch exceptions related to establishing a network connection and return a generic error.'
+  spec.summary               = 'Provides sane exceptions for network failures.'
+  spec.homepage              = 'https://github.com/appfolio/ae_network_connection_exception'
+  spec.license               = 'MIT'
+  spec.files                 = Dir['**/*'].select { |f| f[%r{^(lib/|LICENSE.txt|.*gemspec)}] }
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.3')
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 end

data/lib/ae_network_connection_exception/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AeNetworkConnectionException
-  VERSION = "1.4.0"
+  VERSION = '1.6.0'
 end

data/lib/ae_network_connection_exception.rb

@@ -1,38 +1,30 @@
-require "ae_network_connection_exception/version"
-require "net/http"
-require "socket"
+# frozen_string_literal: true
+
+require 'net/http'
+require 'socket'
 
 module AeNetworkConnectionException
   class ConnectionNotEstablished < StandardError
   end
 
-  OTHER_EXCEPTIONS = []
-  if defined?(RestClient::Exceptions::OpenTimeout)
-    puts "here"
-    OTHER_EXCEPTIONS << RestClient::Exceptions::OpenTimeout
-  end
-  OTHER_EXCEPTIONS.freeze
-
   class << self
     def try
       yield
-    rescue SocketError, Net::OpenTimeout, *OTHER_EXCEPTIONS => 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
-
+    rescue SocketError, Net::OpenTimeout, *other_exceptions
+      # 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.
       raise ConnectionNotEstablished
     rescue Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ENETUNREACH => 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.
+      # Errno::ECONNREFUSED happens when we can not connect to the port.
+      # Errno::ETIMEDOUT happens when we timeout durring the tcp handshake.
+      # 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}"
-
+      # 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
-
+      # Errno::ECONNRESET happens when the connection is reset. This can happen during SSL negotiation.
       raise_if_exception_message_matches(e, /SSL_connect/)
     end
 
@@ -43,7 +35,7 @@ module AeNetworkConnectionException
         Errno::ECONNREFUSED.new('Connection refused - connect(2) for "example.com" port 443'),
         Errno::ETIMEDOUT.new('Connection timed out - connect(2) for "example.com" port 443'),
         Net::OpenTimeout.new('message'),
-        Errno::ECONNRESET.new('Connection reset by peer - SSL_connect', Errno::ECONNREFUSED.new('Connection refused - connect(2) for "example.com" port 443')),
+        Errno::ECONNRESET.new('Connection reset by peer - SSL_connect'),
         Errno::EHOSTUNREACH.new('No route to host - connect(2) for "example.com" port 443'),
         Errno::ENETUNREACH.new('Network is unreachable - connect(2) for "example.com" port 443')
       ]
@@ -51,12 +43,14 @@ module AeNetworkConnectionException
 
     private
 
+    def other_exceptions
+      defined?(RestClient::Exceptions::OpenTimeout) ? [RestClient::Exceptions::OpenTimeout] : []
+    end
+
     def raise_if_exception_message_matches(exception, pattern)
-      if exception.message =~ pattern
-        raise ConnectionNotEstablished
-      else
-        raise exception
-      end
+      raise ConnectionNotEstablished if exception.message =~ pattern
+
+      raise exception
     end
   end
 end

metadata

@@ -1,71 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: ae_network_connection_exception
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
-- Steven Boyd
-autorequire: 
+- AppFolio
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-04 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
+date: 2022-02-22 00:00:00.000000000 Z
+dependencies: []
+description: Catch exceptions related to establishing a network connection and return
+  a generic error.
+email: opensource@appfolio.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".gitignore"
-- ".ruby-version"
-- Appraisals
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
 - ae_network_connection_exception.gemspec
-- gemfiles/ruby_2.3.3.gemfile
-- gemfiles/ruby_2.5.3.gemfile
 - 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
+homepage: https://github.com/appfolio/ae_network_connection_exception
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,15 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
-summary: Provides sane exceptions for network failures
+summary: Provides sane exceptions for network failures.
 test_files: []

data/.circleci/config.yml

@@ -1,30 +0,0 @@
-defaults: &defaults
-  working_directory: ~/repo
-
-  steps:
-    - checkout
-    - run: bundle install
-    - run: bundle exec appraisal install
-    - run: bundle exec appraisal rake test
-
-version: 2
-jobs:
-  test-ruby-2.3.3:
-    <<: *defaults
-    docker:
-      - image: circleci/ruby:2.3.3
-
-  test-ruby-2.5.3:
-    <<: *defaults
-    docker:
-      - image: circleci/ruby:2.5.3-stretch
-
-workflows:
-  version: 2
-  rc:
-    jobs:
-      - test-ruby-2.3.3:
-          context: appfolio_test_context
-      - test-ruby-2.5.3:
-          context: appfolio_test_context
-

data/.gitignore

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

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.3.3

data/Appraisals

@@ -1,11 +0,0 @@
-case(RUBY_VERSION)
-
-  when '2.3.3', '2.5.3' then
-
-    appraise "ruby-#{RUBY_VERSION}" do
-    end
-
-  else
-    raise "Unsupported Ruby version #{RUBY_VERSION}"
-
-end

data/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in ae_network_connection_exception.gemspec
-gemspec
-
-gem 'minitest', '~> 5.0'
-
-source 'https://gemini.atl.appfolio.net' do
-  gem 'af_gems'
-end
-
-gem 'rest-client', '~> 2.0', require: false

data/README.md

@@ -1,36 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require 'af_gems/gem_tasks'
-require 'af_gems/appraisal'
-
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/unit/**/*_test.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-namespace :test do
-  AfGems::RubyAppraisalTask.new(:all, [ 'ruby-2.3.3', 'ruby-2.5.3' ])
-end

data/gemfiles/ruby_2.3.3.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "minitest", "~> 5.0"
-
-source "https://gemini.atl.appfolio.net" do
-  gem "af_gems"
-end
-
-gemspec path: "../"

data/gemfiles/ruby_2.5.3.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "minitest", "~> 5.0"
-
-source "https://gemini.atl.appfolio.net" do
-  gem "af_gems"
-end
-
-gemspec path: "../"

data/test/test_helper.rb

@@ -1,32 +0,0 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'ae_network_connection_exception'
-
-private
-
-class Minitest::Test
-  def assert_connection_not_established_thrown_for(exception)
-    e = return_raised_error do
-      AeNetworkConnectionException.try do
-        raise exception
-      end
-    end
-    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 exception
-      end
-    end
-    assert_equal exception, e
-  end
-
-  def return_raised_error
-    yield
-  rescue => e
-    return e
-  end
-end

data/test/unit/ae_network_connection_exception_test.rb

@@ -1,73 +0,0 @@
-require 'rest-client'
-require 'test_helper'
-
-module AeNetworkConnectionException
-  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_nil parent_exception.cause
-      assert_equal 'Parent Message', parent_exception.message
-
-      begin
-        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
-
-        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
-      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
-      AeNetworkConnectionException.exception_signatures.each do |e|
-        assert_connection_not_established_thrown_for(e)
-      end
-
-      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
-
-    def test_ae_network_connection_exception_try__raises_connection_not_establised_exception_for_rest_client_open_timeout
-      assert_connection_not_established_thrown_for(RestClient::Exceptions::OpenTimeout.new)
-    end
-
-    def test_exception_signatures
-      expected_signatures = [
-        SocketError.new('getaddrinfo: Name or service not known'),
-        Errno::ECONNREFUSED.new('Connection refused - connect(2) for "example.com" port 443'),
-        Errno::ETIMEDOUT.new('Connection timed out - connect(2) for "example.com" port 443'),
-        Net::OpenTimeout.new('message'),
-        Errno::ECONNRESET.new('Connection reset by peer - SSL_connect', Errno::ECONNREFUSED.new('Connection refused - connect(2) for "example.com" port 443')),
-        Errno::EHOSTUNREACH.new('No route to host - connect(2) for "example.com" port 443'),
-        Errno::ENETUNREACH.new('Network is unreachable - connect(2) for "example.com" port 443')
-      ]
-
-      assert_equal expected_signatures.size, AeNetworkConnectionException.exception_signatures.size
-
-      expected_signatures.each do |e|
-        assert_includes AeNetworkConnectionException.exception_signatures, e
-      end
-    end
-  end
-end
-