blanket_wrapper 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4028f6fe83d360d8cdc4bc7af5d2c25b1c9b30f1
-  data.tar.gz: f94aded281f1b23a9e2f4a311dcee1ae071a23f7
+  metadata.gz: 80891d01cd391a6ca57b8cd1d2d266a479529a25
+  data.tar.gz: 8276eaabece824b10f87d5c05bfa043218ca4538
 SHA512:
-  metadata.gz: 2e2b774f5d56de52201ff07bcae76b2b85ccd1c9cbda67d7c2f7cb8de488e6e69acd35dcf45adc40f1540e1538782ac0454995c162ecddd90a1eb4fe49555efa
-  data.tar.gz: 56f747dd7b792f21ecc8df6bc028d802e85a3b00bc9d43d04e40c4da448b7f7fe5cf06ab1aa4adc98141c5aeaae1db1f1cdca814fb9f060539ad0f0a7dfc26a5
+  metadata.gz: 1206873393b17fc7f110f04d019cc083f0a7b6bd6ef6c2fa2a8ac2741f093b3458d61e5267b5236cefd12f423f7ba2a8b4191ddd0756fc5751f1b5b220652b01
+  data.tar.gz: c6591d74a75cc068784d9fa9e9327f8d6ebcea80265bb8c6ebf30f6e69268dd093dbfcb8d92172b015010bee2a2ed81a182f11b592bcda40292ce84300834b2b

data/README.md

@@ -2,6 +2,7 @@
 [![Build Status](https://travis-ci.org/inf0rmer/blanket.svg?branch=master)](https://travis-ci.org/inf0rmer/blanket)
 [![Coverage Status](https://img.shields.io/coveralls/inf0rmer/blanket.svg)](https://coveralls.io/r/inf0rmer/blanket?branch=master)
 [![Code Climate](https://codeclimate.com/github/inf0rmer/blanket/badges/gpa.svg)](https://codeclimate.com/github/inf0rmer/blanket)
+[![Inline docs](http://inch-ci.org/github/inf0rmer/blanket.svg?branch=master)](http://inch-ci.org/github/inf0rmer/blanket)
 
 
 A dead simple API wrapper.
@@ -11,7 +12,7 @@ A dead simple API wrapper.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'blanket'
+gem 'blanket_wrapper'
 ```
 
 And then execute:
@@ -20,7 +21,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install blanket
+    $ gem install blanket_wrapper
 
 ## Usage
 
@@ -134,6 +135,26 @@ users_endpoint = api.users(55)
 users_endpoint.extension = :xml
 ```
 
+### Handling Exceptions
+
+Blanket will raise exceptions for HTTP errors encountered while making requests. Exception subclasses are raised for well known errors (404, 500, etc.) but for other status codes a default `Blanket::Exception` will be raised instead.
+
+```ruby
+begin
+  api.thingamajig.get
+rescue Blanket::ResourceNotFound => e
+  e.code
+  # => 404
+
+  e.message
+  # => "404: Resource Not Found"
+
+  # The HTTP body, ie. the error message sent by the server
+  e.body
+  # => "Could not find this resource!"
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/blanket/fork )

data/lib/blanket.rb

@@ -1,8 +1,10 @@
-require "blanket/version"
-require "blanket/response"
-require "blanket/wrapper"
+require_relative "blanket/version"
+require_relative "blanket/response"
+require_relative "blanket/exception"
+require_relative "blanket/wrapper"
 require 'httparty'
 
+# The main Blanket module
 module Blanket
   # Wraps an API using Blanket::Wrapper
   def self.wrap(*args)

data/lib/blanket/exception.rb

@@ -0,0 +1,124 @@
+module Blanket
+
+  # A Map of HTTP status codes and their names
+  STATUSES = {100 => 'Continue',
+              101 => 'Switching Protocols',
+              102 => 'Processing', #WebDAV
+
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+              203 => 'Non-Authoritative Information', # http/1.1
+              204 => 'No Content',
+              205 => 'Reset Content',
+              206 => 'Partial Content',
+              207 => 'Multi-Status', #WebDAV
+
+              300 => 'Multiple Choices',
+              301 => 'Moved Permanently',
+              302 => 'Found',
+              303 => 'See Other', # http/1.1
+              304 => 'Not Modified',
+              305 => 'Use Proxy', # http/1.1
+              306 => 'Switch Proxy', # no longer used
+              307 => 'Temporary Redirect', # http/1.1
+
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              402 => 'Payment Required',
+              403 => 'Forbidden',
+              404 => 'Resource Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              407 => 'Proxy Authentication Required',
+              408 => 'Request Timeout',
+              409 => 'Conflict',
+              410 => 'Gone',
+              411 => 'Length Required',
+              412 => 'Precondition Failed',
+              413 => 'Request Entity Too Large',
+              414 => 'Request-URI Too Long',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+              418 => 'I\'m A Teapot', #RFC2324
+              421 => 'Too Many Connections From This IP',
+              422 => 'Unprocessable Entity', #WebDAV
+              423 => 'Locked', #WebDAV
+              424 => 'Failed Dependency', #WebDAV
+              425 => 'Unordered Collection', #WebDAV
+              426 => 'Upgrade Required',
+              428 => 'Precondition Required', #RFC6585
+              429 => 'Too Many Requests', #RFC6585
+              431 => 'Request Header Fields Too Large', #RFC6585
+              449 => 'Retry With', #Microsoft
+              450 => 'Blocked By Windows Parental Controls', #Microsoft
+
+              500 => 'Internal Server Error',
+              501 => 'Not Implemented',
+              502 => 'Bad Gateway',
+              503 => 'Service Unavailable',
+              504 => 'Gateway Timeout',
+              505 => 'HTTP Version Not Supported',
+              506 => 'Variant Also Negotiates',
+              507 => 'Insufficient Storage', #WebDAV
+              509 => 'Bandwidth Limit Exceeded', #Apache
+              510 => 'Not Extended',
+              511 => 'Network Authentication Required', # RFC6585
+  }
+
+  # The base class for all Blanket Exceptions
+  class Exception < RuntimeError
+    # Attribute writer for the Exception message
+    attr_writer :message
+    # Attribute reader for the Exception http response
+    attr_reader :response
+
+    # Creates a new exception
+    # @param [HTTParty::Response] response the HTTP Response
+    # @return [Blanket::Exception] The Blanket Exception object
+    def initialize(response = nil)
+      @response = response
+    end
+
+    # Returns the HTTP response body
+    def body
+      @response.body.to_s if @response
+    end
+
+    # Returns the HTTP status code
+    def code
+      @response.code.to_i if @response
+    end
+
+    # Returns a formatted error message
+    def message
+      @message || self.class.name
+    end
+
+    # Returns a stringified error message
+    def inspect
+      "#{message}: #{body}"
+    end
+
+    # Returns a stringified error message
+    def to_s
+      inspect
+    end
+  end
+
+  # We will a create an exception for each status code, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+  module Exceptions
+    # Map http status codes to the corresponding exception class
+    EXCEPTIONS_MAP = {}
+  end
+
+  STATUSES.each_pair do |code, message|
+    klass = Class.new(Exception) do
+      send(:define_method, :message) {"#{code ? "#{code} " : ''}#{message}"}
+    end
+
+    klass_constant = const_set message.delete(' \-\''), klass
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+end

data/lib/blanket/response.rb

@@ -2,6 +2,8 @@ require 'recursive-open-struct'
 require 'json'
 
 module Blanket
+
+  # The Response class wraps HTTP responses
   class Response
     # Attribute reader for the original JSON payload string
     attr_reader :payload

data/lib/blanket/version.rb

@@ -1,4 +1,4 @@
 module Blanket
   # Current gem version
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/blanket/wrapper.rb

@@ -1,4 +1,5 @@
 module Blanket
+  # The Wrapper class wraps an API
   class Wrapper
     class << self
       private
@@ -67,9 +68,12 @@ module Blanket
         headers: headers
       }.reject { |k, v| v.nil? || v.empty? })
 
-      body = (response.respond_to? :body) ? response.body : nil
-
-      (body.is_a? Array) ? body.map(Response.new) : Response.new(body)
+      if response.code <= 400
+        body = (response.respond_to? :body) ? response.body : nil
+        (body.is_a? Array) ? body.map(Response.new) : Response.new(body)
+      else
+        raise Blanket::Exceptions::EXCEPTIONS_MAP[response.code].new(response)
+      end
     end
 
     def merged_headers(headers)

data/spec/blanket/exception_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'blanket/exception'
+
+describe Blanket::Exception do
+  describe "#message" do
+    context "When a message is not set" do
+      let :e do
+        Blanket::Exception.new
+      end
+
+      it "returns its Class name" do
+        expect(e.message).to eq("Blanket::Exception")
+      end
+    end
+
+    context "When a message is set" do
+      let :message do
+        "A custom exception message"
+      end
+
+      let :e do
+        e = Blanket::Exception.new
+        e.message = message
+        e
+      end
+
+      it "returns the custom message" do
+        expect(e.message).to eq(message)
+      end
+    end
+  end
+
+  describe "#response" do
+    let :response do
+      double("HTTP Response", code: 500)
+    end
+
+    let :e do
+      Blanket::InternalServerError.new(response)
+    end
+
+    it "allows access to the HTTP status code" do
+      expect(e.response).to eq(response)
+    end
+  end
+
+  describe "#code" do
+    let :response do
+      double("HTTP Response", code: 500)
+    end
+
+    let :e do
+      Blanket::InternalServerError.new(response)
+    end
+
+    it "allows access to the HTTP status code" do
+      expect(e.code).to eq(response.code)
+    end
+  end
+
+  describe "#body" do
+    let :body do
+      "Internal Server Error"
+    end
+
+    let :response do
+      double("HTTP Response", code: 500, body: body)
+    end
+
+    let :e do
+      Blanket::InternalServerError.new(response)
+    end
+
+    it "allows access to the HTTP response body" do
+      expect(e.body).to eq(body)
+    end
+  end
+end
+
+describe Blanket::ResourceNotFound do
+  let :e do
+    e = Blanket::ResourceNotFound.new
+  end
+
+  it "inherits from Blanket::Exception" do
+    expect(e).to be_kind_of(Blanket::Exception)
+  end
+
+  it "has a '404 Resource Not Found' message" do
+    expect(e.message).to eq("404 Resource Not Found")
+  end
+end
+
+describe Blanket::InternalServerError do
+  let :e do
+    e = Blanket::InternalServerError.new
+  end
+
+  it "inherits from Blanket::Exception" do
+    expect(e).to be_kind_of(Blanket::Exception)
+  end
+
+  it "has a '500 Internal Server Error' message" do
+    expect(e.message).to eq("500 Internal Server Error")
+  end
+end

data/spec/blanket/wrapper_spec.rb

@@ -7,11 +7,9 @@ describe "Blanket::Wrapper" do
   end
 
   describe 'Making Requests' do
-    before :each do
-      allow(HTTParty).to receive(:get)
-    end
-
     it 'resets after performing a request' do
+      allow(HTTParty).to receive(:get) { StubbedResponse.new }
+
       api.users.get()
       api.videos.get()
 
@@ -20,11 +18,12 @@ describe "Blanket::Wrapper" do
 
     describe "Response" do
       before :each do
-        stub_request(:get, "http://api.example.org/users").to_return(:body => '{"title": "Something"}')
+        stub_request(:get, "http://api.example.org/users")
+        .to_return(:body => '{"title": "Something"}')
       end
 
       let :response do
-        api.users.get()
+        api.users.get
       end
 
       it "returns a Blanket::Response instance" do
@@ -32,7 +31,27 @@ describe "Blanket::Wrapper" do
       end
     end
 
+    describe "Exceptions" do
+      let :api do
+        Blanket::wrap("http://api.example.org")
+      end
+
+      describe "500" do
+        before :each do
+          stub_request(:get, "http://api.example.org/users").to_return(:status => 500, :body => "You've been met with a terrible fate, haven't you?")
+        end
+
+        it "raises a Blanket::InternalServerError exception" do
+          expect { api.users.get }.to raise_exception(Blanket::InternalServerError)
+        end
+      end
+    end
+
     describe 'Resource identification' do
+      before do
+        allow(HTTParty).to receive(:get) { StubbedResponse.new }
+      end
+
       context 'When using a resource method' do
         it 'allows identifying a resource' do
           api.users(55).get()
@@ -57,6 +76,10 @@ describe "Blanket::Wrapper" do
     end
 
     describe 'Headers' do
+      before :each do
+        allow(HTTParty).to receive(:get) { StubbedResponse.new }
+      end
+
       it 'allows sending headers in a request' do
         api.users(55).get(headers: {foo: 'bar'})
 
@@ -72,6 +95,10 @@ describe "Blanket::Wrapper" do
     end
 
     describe 'Parameters' do
+      before :each do
+        allow(HTTParty).to receive(:get) { StubbedResponse.new }
+      end
+
       it 'allows sending parameters in a request' do
         api.users(55).get(params: {foo: 'bar'})
 
@@ -80,7 +107,11 @@ describe "Blanket::Wrapper" do
     end
 
     describe 'URL Extension' do
-      it 'allows setting an extension for a request', :wip => true do
+      before :each do
+        allow(HTTParty).to receive(:get) { StubbedResponse.new }
+      end
+
+      it 'allows setting an extension for a request' do
         users_endpoint = api.users(55)
         users_endpoint.extension = :json
         users_endpoint.get
@@ -98,8 +129,8 @@ describe "Blanket::Wrapper" do
   end
 
   describe '#get' do
-    before :each do
-      allow(HTTParty).to receive(:get)
+    before do
+      allow(HTTParty).to receive(:get) { StubbedResponse.new }
     end
 
     it 'GETs a resource' do
@@ -110,8 +141,8 @@ describe "Blanket::Wrapper" do
   end
 
   describe '#post' do
-    before :each do
-      allow(HTTParty).to receive(:post)
+    before do
+      allow(HTTParty).to receive(:post) { StubbedResponse.new }
     end
 
     it 'POSTs a resource' do
@@ -122,8 +153,8 @@ describe "Blanket::Wrapper" do
   end
 
   describe '#put' do
-    before :each do
-      allow(HTTParty).to receive(:put)
+    before do
+      allow(HTTParty).to receive(:put) { StubbedResponse.new }
     end
 
     it 'PUTs a resource' do
@@ -134,8 +165,8 @@ describe "Blanket::Wrapper" do
   end
 
   describe '#patch' do
-    before :each do
-      allow(HTTParty).to receive(:patch)
+    before do
+      allow(HTTParty).to receive(:patch) { StubbedResponse.new }
     end
 
     it 'PATCHes a resource' do
@@ -146,8 +177,8 @@ describe "Blanket::Wrapper" do
   end
 
   describe '#delete' do
-    before :each do
-      allow(HTTParty).to receive(:delete)
+    before do
+      allow(HTTParty).to receive(:delete) { StubbedResponse.new }
     end
 
     it 'DELETEs a resource' do

data/spec/spec_helper.rb

@@ -4,6 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'coveralls'
 Coveralls.wear!
 
+class StubbedResponse
+  def code
+    200
+  end
+end
+
 require 'pry'
 require 'webmock/rspec'
 require 'blanket'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blanket_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Bruno Abrantes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -225,9 +225,11 @@ files:
 - Rakefile
 - blanket.gemspec
 - lib/blanket.rb
+- lib/blanket/exception.rb
 - lib/blanket/response.rb
 - lib/blanket/version.rb
 - lib/blanket/wrapper.rb
+- spec/blanket/exception_spec.rb
 - spec/blanket/response_spec.rb
 - spec/blanket/wrapper_spec.rb
 - spec/blanket_spec.rb
@@ -257,6 +259,7 @@ signing_key:
 specification_version: 4
 summary: A dead simple API wrapper. Access your data with style.
 test_files:
+- spec/blanket/exception_spec.rb
 - spec/blanket/response_spec.rb
 - spec/blanket/wrapper_spec.rb
 - spec/blanket_spec.rb