tanga-http-exceptions 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7aa3cb25bdec012849872b82ffb4f741d22e4c95
+  data.tar.gz: 822d2f792be1db16d6468b463f83cd10af681a17
+SHA512:
+  metadata.gz: cc0c178143e16737806db636a3d2e3a6f4366744c4b68de3bd0fa9d98c5cd0a5cf4966e3f1782c788f1f3b7afdee86dd77643d4ba444bf0f997a7f250812dbee
+  data.tar.gz: 8fdf5bea3299eaa80da4b27acb00949c0416b5e6ffec423d21ea1f033e60c0e831a44e28e6dcc5a27f4bf2f4abbf0417497f1fe0196691ed559d8882d7778509

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.2.0@http-exceptions --create

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in http-exceptions.gemspec
+gemspec
+
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rainforest QA
+
+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,65 @@
+[![Build Status](https://travis-ci.org/rainforestapp/http-exceptions.png?branch=master)](https://travis-ci.org/rainforestapp/http-exceptions)
+
+# Http::Exceptions
+
+Http::Exceptions provides an easy way to rescue exceptions that might be thrown by your Http library.
+
+If you're using a library such as the excellent [HTTParty](https://github.com/jnunemaker/httparty), you still have to deal with various types of exceptions. In an ideal world, the return code of the HTTP request would be the sole indicator of failures, but HTTP libraries can raise a large number of exceptions (such as `SocketError` or `Net::ReadTimeout`) that you need to handle.
+
+Http::Exceptions converts any error that might be raised by your HTTP library and wrap it in a `Http::Exceptions::HttpException`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'http-exceptions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http-exceptions
+
+## Usage
+
+Only rescue raised exceptions.
+
+```ruby
+response = Http::Exceptions.wrap_exception do
+  HTTParty.get "http://www.google.com"
+end
+```
+
+Raise an exception if the return code of the API call is not `2XX`.
+
+```ruby
+response = Http::Exceptions.wrap_and_check do
+  HTTParty.get "http://www.google.com"
+end
+```
+
+You can then rescue the exception in the following way:
+
+```ruby
+begin
+  response = Http::Exceptions.wrap_and_check do
+    HTTParty.get "http://www.google.com"
+  end
+rescue Http::Exceptions::HttpException => e
+  # ...
+end
+```
+
+### Support
+
+Currently, this only has been tested with HTTParty. It should however work with any library that delegates to the ruby http library.
+
+## Contributing
+
+1. Fork it ( https://github.com/rainforestapp/http-exceptions/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/http/exceptions.rb

@@ -0,0 +1,41 @@
+require "http/exceptions/version"
+require "http/exceptions/http_exception"
+
+module Http
+  module Exceptions
+    EXCEPTIONS = [
+      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,
+    ].freeze
+
+    def self.wrap_exception
+      begin
+        yield
+      rescue *Exceptions::EXCEPTIONS => e
+        raise HttpException.new original_exception: e
+      end
+    end
+
+    def self.check_response!(res)
+      raise HttpException.new(response: res) unless (200...300).include?(res.code)
+      res
+    end
+
+    def self.wrap_and_check
+      wrap_exception do
+        check_response! yield
+      end
+    end
+  end
+end

data/lib/http/exceptions/http_exception.rb

@@ -0,0 +1,16 @@
+module Http
+  module Exceptions
+    class HttpException < RuntimeError
+      attr_reader :response, :original_exception
+
+      def initialize(options = {})
+        @original_exception = options[:original_exception]
+        @response = options[:response]
+        msg = "An error as occured while processing response."
+        msg += " Status #{response.code}\n#{response.body}" if response
+        msg += " Original Exception: #{original_exception}" if original_exception
+        super msg
+      end
+    end
+  end
+end

data/lib/http/exceptions/version.rb

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

data/spec/http_exception_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Http::Exceptions do
+  let(:invalid_response) { double(code: 400, body: '') }
+  let(:valid_response) { double(code: 200) }
+
+  class TestException < RuntimeError
+  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
+
+    it "saves the original exception against the HttpException" do
+      begin
+        described_class.wrap_exception do
+          raise SocketError
+        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)
+    end
+  end
+
+  describe ".check_response!" do
+    it "raises exception on non-200 response" do
+      expect do
+        described_class.check_response!(invalid_response)
+      end.to raise_error(Http::Exceptions::HttpException)
+    end
+
+    it "the raised exception contains the response" do
+      begin
+        described_class.check_response!(invalid_response)
+      rescue Http::Exceptions::HttpException => e
+        expect(e.response).to eq(invalid_response)
+      end
+    end
+
+    it "returns the response on valid response" do
+      expect(described_class.check_response!(valid_response)).to eq(valid_response)
+    end
+  end
+
+  describe ".wrap_and_check" do
+    it "raises exception on bad response" do
+      expect do
+        described_class.wrap_and_check do
+          invalid_response
+        end
+      end.to raise_error(Http::Exceptions::HttpException)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'http/exceptions'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/tanga-http-exceptions.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http/exceptions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tanga-http-exceptions"
+  spec.version       = Http::Exceptions::VERSION
+  spec.authors       = ["Simon Mathieu"]
+  spec.email         = ["simon.math@gmail.com"]
+  spec.summary       = %q{An easy way to rescue exceptions that might be thrown by your Http library}
+  spec.description   = %q{An easy way to rescue exceptions that might be thrown by your Http library}
+  spec.homepage      = ""
+  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.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: tanga-http-exceptions
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Simon Mathieu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy way to rescue exceptions that might be thrown by your Http library
+email:
+- simon.math@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/http/exceptions.rb
+- lib/http/exceptions/http_exception.rb
+- lib/http/exceptions/version.rb
+- spec/http_exception_spec.rb
+- spec/spec_helper.rb
+- tanga-http-exceptions.gemspec
+homepage: ''
+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.5
+signing_key: 
+specification_version: 4
+summary: An easy way to rescue exceptions that might be thrown by your Http library
+test_files:
+- spec/http_exception_spec.rb
+- spec/spec_helper.rb