blanket_wrapper 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80891d01cd391a6ca57b8cd1d2d266a479529a25
-  data.tar.gz: 8276eaabece824b10f87d5c05bfa043218ca4538
+  metadata.gz: d4919971f12da2062b5d5cd9b0152d820acce367
+  data.tar.gz: d5ffa6e823b1a2a00647d13b23a85c78a71b52ae
 SHA512:
-  metadata.gz: 1206873393b17fc7f110f04d019cc083f0a7b6bd6ef6c2fa2a8ac2741f093b3458d61e5267b5236cefd12f423f7ba2a8b4191ddd0756fc5751f1b5b220652b01
-  data.tar.gz: c6591d74a75cc068784d9fa9e9327f8d6ebcea80265bb8c6ebf30f6e69268dd093dbfcb8d92172b015010bee2a2ed81a182f11b592bcda40292ce84300834b2b
+  metadata.gz: 1e489971f0588e4d32bc874e22fbe088f13d34cddacd67966e4fb71deb60d234285d8b48c8200114dcb28bdf36cb93654b54bfbf4dc4e0ee8690bd8f5563586d
+  data.tar.gz: 23a7795896868c49f0df75162fc0093f34e9ab63f2f83eb8a09624df8da7c30326cd722fd699922c07db432922ca586da8d79f5e625390b9400c11cb7fd359fc

data/README.md

@@ -7,6 +7,19 @@
 
 A dead simple API wrapper.
 
+**Table of Contents**
+
+- [Installation](#installation)
+- [Usage](#usage)
+	- [Quick demo](#quick-demo)
+	- [How it works](#how-it-works)
+	- [Responses](#responses)
+	- [Request Parameters](#request-parameters)
+	- [Headers](#headers)
+	- [Extensions](#extensions)
+	- [Handling Exceptions](#handling-exceptions)
+- [Contributing](#contributing)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,6 +41,8 @@ Or install it yourself as:
 ### Quick demo
 
 ```ruby
+require 'blanket'
+
 github = Blanket.wrap("https://api.github.com")
 
 # Get some user's info
@@ -104,6 +119,14 @@ repos.map(&:name)
 # => ["analytics-ios", "aztec", "fusebox", ...]
 ```
 
+### Request Body
+You can make requests with body using the `body` option:
+
+```ruby
+api = Blanket::wrap("http://api.example.org")
+api.messages.post(body: 'Hello')
+```
+
 ### Request Parameters
 Blanket supports appending parameters to your requests:
 
@@ -112,6 +135,12 @@ api.users(55).get(params: {foo: 'bar'})
 # => "http://api.example.org/users/55?foo=bar"
 ```
 
+You can also set default params for all your requests on initialization:
+
+```ruby
+api = Blanket::wrap("http://api.example.org", params: {access_token: 'my secret token'})
+```
+
 ### Headers
 HTTP Headers are always useful when accessing an API, so Blanket makes it easy for you to specify them, either globally or on a per-request basis:
 
@@ -157,7 +186,7 @@ end
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/blanket/fork )
+1. Fork it ( https://github.com/inf0rmer/blanket/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`)

data/lib/blanket/exception.rb

@@ -1,28 +1,7 @@
 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
-
+  # A Map of "error" HTTP status codes and their names
+  STATUSES = {
               400 => 'Bad Request',
               401 => 'Unauthorized',
               402 => 'Payment Required',
@@ -101,21 +80,24 @@ module Blanket
       "#{message}: #{body}"
     end
 
-    # Returns a stringified error message
-    def to_s
-      inspect
-    end
+    alias_method :to_s, :inspect
   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 = {}
+
+    def self.generate_from_response(response)
+      (EXCEPTIONS_MAP[response.code] || Exception).new(response)
+    end
   end
 
   STATUSES.each_pair do |code, message|
     klass = Class.new(Exception) do
-      send(:define_method, :message) {"#{code ? "#{code} " : ''}#{message}"}
+      define_method :message do
+        "#{code} #{message}"
+      end
     end
 
     klass_constant = const_set message.delete(' \-\''), klass

data/lib/blanket/response.rb

@@ -21,22 +21,19 @@ module Blanket
     # Allows accessing the payload's JSON keys through methods.
     def method_missing(method, *args, &block)
       if payload.respond_to? method
-        payload.send method, *args, &block
+        payload.public_send method, *args, &block
       else
         super
       end
     end
 
     def payload_from_json(json)
-      if json
-        parsed = [json].flatten.map do |item|
-          RecursiveOpenStruct.new item, :recurse_over_arrays => true
-        end
-
-        (parsed.count == 1) ? parsed.first : parsed
-      else
-        nil
+      parsed = [json].flatten.map do |item|
+        RecursiveOpenStruct.new item, recurse_over_arrays: true
       end
+
+      (parsed.count == 1) ? parsed.first : parsed
     end
+
   end
 end

data/lib/blanket/version.rb

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

data/lib/blanket/wrapper.rb

@@ -1,5 +1,4 @@
 module Blanket
-  # The Wrapper class wraps an API
   class Wrapper
     class << self
       private
@@ -7,7 +6,7 @@ module Blanket
       #   @method $1()
       #   Performs a $1 request on the wrapped URL
       #   @param [String, Symbol, Numeric] id The resource identifier to attach to the last part of the request
-      #   @param [Hash] options An options hash with values for :headers, :extension and :params
+      #   @param [Hash] options An options hash with values for :headers, :extension, :params and :body
       #   @return [Blanket::Response, Array] A wrapped Blanket::Response or an Array
       def add_action(action)
         define_method(action) do |id=nil, options={}|
@@ -20,6 +19,10 @@ module Blanket
     # should be applied to all requests
     attr_accessor :headers
 
+    # Attribute accessor for  params that
+    # should be applied to all requests
+    attr_accessor :params
+
     # Attribute accessor for file extension that
     # should be appended to all requests
     attr_accessor :extension
@@ -32,12 +35,13 @@ module Blanket
 
     # Wraps the base URL for an API
     # @param [String, Symbol] base_uri The root URL of the API you wish to wrap.
-    # @param [Hash] options An options hash with global values for :headers and :extension
+    # @param [Hash] options An options hash with global values for :headers, :extension and :params
     # @return [Blanket] The Blanket object wrapping the API
     def initialize(base_uri, options={})
       @base_uri = base_uri
       @uri_parts = []
-      @headers = (options[:headers].nil?) ? {} : options[:headers]
+      @headers = options[:headers] || {}
+      @params = options[:params] || {}
       @extension = options[:extension]
     end
 
@@ -46,7 +50,8 @@ module Blanket
     def method_missing(method, *args, &block)
       Wrapper.new uri_from_parts([method, args.first]), {
         headers: @headers,
-        extension: @extension
+        extension: @extension,
+        params: @params
       }
     end
 
@@ -57,34 +62,37 @@ module Blanket
       end
 
       headers = merged_headers(options[:headers])
+      params = merged_params(options[:params])
       uri = uri_from_parts([id])
 
       if @extension
         uri = "#{uri}.#{extension}"
       end
 
-      response = HTTParty.send(method, uri, {
-        query:   options[:params],
-        headers: headers
-      }.reject { |k, v| v.nil? || v.empty? })
+      response = HTTParty.public_send(method, uri, {
+        query:   params,
+        headers: headers,
+        body:    options[:body]
+      }.reject { |_, value| value.nil? || value.empty? })
 
       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)
+        raise Blanket::Exceptions.generate_from_response(response)
       end
     end
 
     def merged_headers(headers)
-      headers = @headers.merge(headers != nil ? headers : {})
+      @headers.merge(headers || {})
+    end
+
+    def merged_params(params)
+      @params.merge(params || {})
     end
 
     def uri_from_parts(parts)
-      parts
-        .clone
-        .compact
-        .inject(@base_uri.clone) { |memo, part| memo << "/#{part}" }
+      ([@base_uri] + parts).compact.join('/')
     end
   end
 end

data/spec/blanket/wrapper_spec.rb

@@ -45,6 +45,16 @@ describe "Blanket::Wrapper" do
           expect { api.users.get }.to raise_exception(Blanket::InternalServerError)
         end
       end
+
+      describe "522, a non registered invalid status code" do
+        before :each do
+          stub_request(:get, "http://api.example.org/users").to_return(status: 522, body: "You've been met with a terrible fate, haven't you?")
+        end
+
+        it "raises a generic instance of Blanket::Exception" do
+          expect { api.users.get }.to raise_exception(Blanket::Exception)
+        end
+      end
     end
 
     describe 'Resource identification' do
@@ -104,6 +114,13 @@ describe "Blanket::Wrapper" do
 
         expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', query: {foo: 'bar'})
       end
+
+      it 'allows setting parameters globally' do
+        api = Blanket::wrap("http://api.example.org", params: {token: 'my secret token'})
+        api.users(55).get(params: {foo: 'bar'})
+
+        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', query: {token: 'my secret token', foo: 'bar'})
+      end
     end
 
     describe 'URL Extension' do
@@ -126,6 +143,19 @@ describe "Blanket::Wrapper" do
         expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55.xml', anything())
       end
     end
+
+    describe 'Body' do
+      before :each do
+        allow(HTTParty).to receive(:post) { StubbedResponse.new }
+      end
+
+      it 'allows setting the body for a request' do
+        api = Blanket::wrap("http://api.example.org")
+        api.users(55).post(body: { this_key: :this_value }.to_json)
+
+        expect(HTTParty).to have_received(:post).with('http://api.example.org/users/55', body: { this_key: :this_value }.to_json)
+      end
+    end
   end
 
   describe '#get' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blanket_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Bruno Abrantes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -220,7 +220,6 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - blanket.gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Bruno Abrantes
-
-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.