faraday_bang 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c86ab07973616e783fc90b028611e2553f8d9cd
+  data.tar.gz: c954035229658542ea9be28c378bac598a405704
+SHA512:
+  metadata.gz: fbf870ac82be8668c9bd567385bc64c0ac77615017ecbdb48b0f07f7b0c756d7131bcfedac3d3095d19018dd473d66b7df3b7f19a8ae1fede9c83d5b56f50d45
+  data.tar.gz: 090a6094059669e372f5e8672e8596ec0a1adc036d970f727432f4a669e0ee50c4a030cc739867033c2ed964df2733a6a961ce4ed26467a6f316a15b4a2232d0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+install: bundle install
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_bang.gemspec
+gemspec
+gem 'm', github: "unmanbearpig/m"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Bates
+
+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,61 @@
+# Faraday!
+[![Build Status](https://travis-ci.org/markbates/faraday_bang.png)](https://travis-ci.org/markbates/faraday_bang) [![Code Climate](https://codeclimate.com/github/markbates/faraday_bang.png)](https://codeclimate.com/github/markbates/faraday_bang)
+
+[Faraday](https://github.com/lostisland/faraday) is a great HTTP library, but it would be even better if had ! versions of all it's methods to raise errors when the request does not receive a successful response. Enter Farady! (pronounced Faraday Bang).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_bang'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install faraday_bang
+```
+
+## Usage
+
+Using Faraday! is just as easy as using Faraday, except all you have to do is add a `!` to the Faraday methods.
+
+```ruby
+response = Faraday.get!('http://sushi.com/nigiri/sake.json')
+```
+
+If a response is not successful, then a `Faraday::Bang::ResponseError` error will be raised.
+
+Each of the HTTP error status codes have been given their own sub-class to make catching them even easier. Here are a few examples:
+
+```ruby
+Faraday::Bang::Response401Error
+Faraday::Bang::Response404Error
+Faraday::Bang::Response500Error
+Faraday::Bang::Response503Error
+```
+
+## But Wait! There's More!
+
+As a special added bonus an `as_json` method has been added to `Faraday::Response` to make it easier to JSON bodies back as a Ruby Hash.
+
+```ruby
+response = Faraday.get!('http://example.com/example.json')
+json = response.as_json
+puts json # => {"name"=>"Mark"}
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/faraday_bang/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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:default) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end

data/faraday_bang.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_bang/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_bang"
+  spec.version       = FaradayBang::VERSION
+  spec.authors       = ["Mark Bates"]
+  spec.email         = ["mark@markbates.com"]
+  spec.summary       = %q{Adds error raising ! methods to Farday.}
+  spec.description   = %q{Adds error raising ! methods to Farday.}
+  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_dependency "faraday"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "minitest", '>=5.2.3'
+end

data/lib/faraday_bang/bang.rb

@@ -0,0 +1,23 @@
+module Faraday::Bang
+  ERROR_CODES = [(400..417).to_a, (500..505).to_a].flatten
+
+  Faraday::Connection::METHODS.each do |verb|
+    define_method("#{verb}!") do |*args|
+      response = self.send(verb, *args)
+      if response.status >= 400
+        err_name = "Response#{response.status}Error"
+        if Faraday::Bang.const_defined?(err_name)
+          klass = Faraday::Bang.const_get(err_name)
+          raise klass.new(response)
+        else
+          raise Faraday::Bang::ResponseError.new(response)
+        end
+      end
+      return response
+    end
+  end
+
+end
+
+Faraday.extend(Faraday::Bang)
+Faraday::Connection.send(:include, Faraday::Bang)

data/lib/faraday_bang/errors.rb

@@ -0,0 +1,13 @@
+class Faraday::Bang::ResponseError < StandardError
+  attr_reader :response
+
+  def initialize(response)
+    @response = response
+    super("Error making request to #{response.env.url} (#{response.status})")
+  end
+
+end
+
+Faraday::Bang::ERROR_CODES.each do |code|
+  Faraday::Bang.const_set("Response#{code}Error", Class.new(Faraday::Bang::ResponseError))
+end

data/lib/faraday_bang/json.rb

@@ -0,0 +1,7 @@
+class Faraday::Response
+
+  def as_json
+    @_json ||= JSON.parse(body)
+  end
+
+end

data/lib/faraday_bang/version.rb

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

data/lib/faraday_bang.rb

@@ -0,0 +1,6 @@
+require 'faraday'
+require 'json'
+require "faraday_bang/version"
+require "faraday_bang/bang"
+require "faraday_bang/json"
+require "faraday_bang/errors"

data/test/lib/faraday_bang/bang_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+describe Faraday::Bang do
+
+  let(:url) { 'http://example.com' }
+  let(:args) { {a: 'b'} }
+  let(:body) { {foo: 'bar'}.to_json }
+
+  [Faraday, Faraday.new].each do |klass|
+
+    Faraday::Connection::METHODS.each do |verb|
+
+      describe "##{verb}!" do
+
+        let(:response) { mock(body: body, status: 200) }
+
+        before do
+          klass.expects(verb).with(url, args).returns(response)
+        end
+
+        describe 'successful response' do
+
+          it 'passes the call onto Faraday' do
+            res = klass.send("#{verb}!", url, args)
+            res.body.must_equal body
+          end
+
+        end
+
+        describe 'unsuccessful response' do
+
+          let(:env) { OpenStruct.new(url: 'http://example.com') }
+          let(:response) { OpenStruct.new(body: body, status: 506, env: env) }
+
+          it 'raises an error if its a non-200 response without an explicit exception' do
+            ->{klass.send("#{verb}!", url, args)}.must_raise Faraday::Bang::ResponseError, body
+          end
+
+          Faraday::Bang::ERROR_CODES.each do |code|
+
+            context code do
+
+              let(:response) { OpenStruct.new(body: body, status: code, env: env) }
+
+              it "raises a Faraday::Bang::Response#{code}Error" do
+                ->{klass.send("#{verb}!", url, args)}.must_raise Faraday::Bang.const_get("Response#{code}Error")
+              end
+
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/test/lib/faraday_bang/errors_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+describe Faraday::Bang::ResponseError do
+
+  let(:env) { OpenStruct.new(url: 'http://example.com') }
+  let(:response) { OpenStruct.new(status: 500, env: env) }
+  let(:error) { Faraday::Bang::ResponseError.new(response) }
+
+  it 'has a useful error message' do
+    error.response.must_equal response
+    error.message.must_equal "Error making request to http://example.com (500)"
+  end
+
+end

data/test/lib/faraday_bang/json_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+describe Faraday::Response do
+
+  let(:response) { Faraday::Response.new(body: {'foo' => 'bar'}.to_json) }
+
+  it 'has an as_json method' do
+    response.as_json.must_equal('foo' => 'bar')
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+
+require 'faraday_bang' # and any other gems you need
+
+require 'ostruct'
+require 'minitest/autorun'
+require "mocha/setup"
+require 'mocha/mini_test'
+
+class MiniTest::Spec
+
+  class << self
+    alias :context :describe
+  end
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: faraday_bang
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+description: Adds error raising ! methods to Farday.
+email:
+- mark@markbates.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday_bang.gemspec
+- lib/faraday_bang.rb
+- lib/faraday_bang/bang.rb
+- lib/faraday_bang/errors.rb
+- lib/faraday_bang/json.rb
+- lib/faraday_bang/version.rb
+- test/lib/faraday_bang/bang_test.rb
+- test/lib/faraday_bang/errors_test.rb
+- test/lib/faraday_bang/json_test.rb
+- test/test_helper.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Adds error raising ! methods to Farday.
+test_files:
+- test/lib/faraday_bang/bang_test.rb
+- test/lib/faraday_bang/errors_test.rb
+- test/lib/faraday_bang/json_test.rb
+- test/test_helper.rb