blanket_wrapper 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cff9cb20ef0765b3930bcc0b4851c512a6939c9c
-  data.tar.gz: e91335deca8e2f7b337b91e8931f60318b7aef1c
+  metadata.gz: 4028f6fe83d360d8cdc4bc7af5d2c25b1c9b30f1
+  data.tar.gz: f94aded281f1b23a9e2f4a311dcee1ae071a23f7
 SHA512:
-  metadata.gz: ff4050a1fb7668fb018a69c882b23aa9ab79fa0ee52ad0d8f7f0d668f8f705fb726215d9a27f4936e6477b21a80f4c5bd73601d9b3c8302fff9e72f461ed87fc
-  data.tar.gz: c88e157f9c79c2599872baffbb5ad252b5c5b0f7de30c4a3f5e822102fc80610f5b9fa4f644cb38c56d1cbaf783077a2fbae2094de610c2f5bd1a9b7e6575376
+  metadata.gz: 2e2b774f5d56de52201ff07bcae76b2b85ccd1c9cbda67d7c2f7cb8de488e6e69acd35dcf45adc40f1540e1538782ac0454995c162ecddd90a1eb4fe49555efa
+  data.tar.gz: 56f747dd7b792f21ecc8df6bc028d802e85a3b00bc9d43d04e40c4da448b7f7fe5cf06ab1aa4adc98141c5aeaae1db1f1cdca814fb9f060539ad0f0a7dfc26a5

data/.yardopts

@@ -0,0 +1,7 @@
+--protected
+--no-private
+--hide-tag yard.tag
+--hide-tag yard.directive
+--hide-tag yard.signature
+--main README
+--files LICENSE

data/blanket.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
 end

data/lib/blanket.rb

@@ -1,71 +1,11 @@
 require "blanket/version"
 require "blanket/response"
+require "blanket/wrapper"
 require 'httparty'
 
 module Blanket
+  # Wraps an API using Blanket::Wrapper
   def self.wrap(*args)
-    Blanket.new *args
-  end
-
-  class Blanket
-    attr_accessor :headers
-    attr_accessor :extension
-
-    def initialize(base_uri, options={})
-      @base_uri = base_uri
-      @uri_parts = []
-      @headers = (options[:headers].nil?) ? {} : options[:headers]
-      @extension = options[:extension]
-    end
-
-    # RESTful actions
-    [:get, :post, :put, :patch, :delete].each do |action|
-      define_method(action) do |id=nil, options={}|
-        request(action, id, options)
-      end
-    end
-
-    def method_missing(method, *args, &block)
-      Blanket.new uri_from_parts([method, args.first]), {
-        headers: @headers,
-        extension: @extension
-      }
-    end
-
-    private
-
-    def request(method, id=nil, options={})
-      if id.is_a? Hash
-        options = id
-        id = nil
-      end
-
-      headers = merged_headers(options[:headers])
-      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? })
-
-      body = (response.respond_to? :body) ? response.body : nil
-
-      (body.is_a? Array) ? body.map(Response.new) : Response.new(body)
-    end
-
-    def merged_headers(headers)
-      headers = @headers.merge(headers != nil ? headers : {})
-    end
-
-    def uri_from_parts(parts)
-      parts
-        .clone
-        .compact
-        .inject(@base_uri.clone) { |memo, part| memo << "/#{part}" }
-    end
+    Wrapper.new *args
   end
 end

data/lib/blanket/response.rb

@@ -3,13 +3,20 @@ require 'json'
 
 module Blanket
   class Response
+    # Attribute reader for the original JSON payload string
     attr_reader :payload
 
+    # A Blanket HTTP response wrapper.
+    # @param [String] json_string A string containing data in the JSON format
+    # @return [Blanket::Response] The wrapped Response object
     def initialize(json_string)
       json_string ||= "{}"
       @payload = payload_from_json(JSON.parse(json_string))
     end
 
+    private
+
+    # 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
@@ -18,8 +25,6 @@ module Blanket
       end
     end
 
-    private
-
     def payload_from_json(json)
       if json
         parsed = [json].flatten.map do |item|

data/lib/blanket/version.rb

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

data/lib/blanket/wrapper.rb

@@ -0,0 +1,86 @@
+module Blanket
+  class Wrapper
+    class << self
+      private
+      # @macro [attach] REST action
+      #   @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
+      #   @return [Blanket::Response, Array] A wrapped Blanket::Response or an Array
+      def add_action(action)
+        define_method(action) do |id=nil, options={}|
+          request(action, id, options)
+        end
+      end
+    end
+
+    # Attribute accessor for HTTP Headers that
+    # should be applied to all requests
+    attr_accessor :headers
+
+    # Attribute accessor for file extension that
+    # should be appended to all requests
+    attr_accessor :extension
+
+    add_action :get
+    add_action :post
+    add_action :put
+    add_action :patch
+    add_action :delete
+
+    # 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
+    # @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]
+      @extension = options[:extension]
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      Wrapper.new uri_from_parts([method, args.first]), {
+        headers: @headers,
+        extension: @extension
+      }
+    end
+
+    def request(method, id=nil, options={})
+      if id.is_a? Hash
+        options = id
+        id = nil
+      end
+
+      headers = merged_headers(options[:headers])
+      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? })
+
+      body = (response.respond_to? :body) ? response.body : nil
+
+      (body.is_a? Array) ? body.map(Response.new) : Response.new(body)
+    end
+
+    def merged_headers(headers)
+      headers = @headers.merge(headers != nil ? headers : {})
+    end
+
+    def uri_from_parts(parts)
+      parts
+        .clone
+        .compact
+        .inject(@base_uri.clone) { |memo, part| memo << "/#{part}" }
+    end
+  end
+end

data/spec/blanket/wrapper_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+require 'blanket/wrapper'
+
+describe "Blanket::Wrapper" do
+  let :api do
+    Blanket::wrap("http://api.example.org")
+  end
+
+  describe 'Making Requests' do
+    before :each do
+      allow(HTTParty).to receive(:get)
+    end
+
+    it 'resets after performing a request' do
+      api.users.get()
+      api.videos.get()
+
+      expect(HTTParty).to have_received(:get).with("http://api.example.org/videos", anything())
+    end
+
+    describe "Response" do
+      before :each do
+        stub_request(:get, "http://api.example.org/users").to_return(:body => '{"title": "Something"}')
+      end
+
+      let :response do
+        api.users.get()
+      end
+
+      it "returns a Blanket::Response instance" do
+        expect(response).to be_kind_of(Blanket::Response)
+      end
+    end
+
+    describe 'Resource identification' do
+      context 'When using a resource method' do
+        it 'allows identifying a resource' do
+          api.users(55).get()
+
+          expect(HTTParty).to have_received(:get).with("http://api.example.org/users/55", anything())
+        end
+
+        it 'only allows one identifier per resource' do
+          api.users(55, 37).get()
+
+          expect(HTTParty).not_to have_received(:get).with("http://api.example.org/users/55/37", anything())
+        end
+      end
+
+      context 'When using #get' do
+        it 'allows identifying the last resource' do
+          api.users(55).videos.get(15)
+
+          expect(HTTParty).to have_received(:get).with("http://api.example.org/users/55/videos/15", anything())
+        end
+      end
+    end
+
+    describe 'Headers' do
+      it 'allows sending headers in a request' do
+        api.users(55).get(headers: {foo: 'bar'})
+
+        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', headers: {foo: 'bar'})
+      end
+
+      it 'allows setting headers globally' do
+        api = Blanket::wrap("http://api.example.org", headers: {token: 'my secret token'})
+        api.users(55).get()
+
+        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', headers: {token: 'my secret token'})
+      end
+    end
+
+    describe 'Parameters' do
+      it 'allows sending parameters in a request' do
+        api.users(55).get(params: {foo: 'bar'})
+
+        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', query: {foo: 'bar'})
+      end
+    end
+
+    describe 'URL Extension' do
+      it 'allows setting an extension for a request', :wip => true do
+        users_endpoint = api.users(55)
+        users_endpoint.extension = :json
+        users_endpoint.get
+
+        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55.json', anything())
+      end
+
+      it 'allows setting an extension globally' do
+        api = Blanket::wrap("http://api.example.org", extension: :xml)
+        api.users(55).get
+
+        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55.xml', anything())
+      end
+    end
+  end
+
+  describe '#get' do
+    before :each do
+      allow(HTTParty).to receive(:get)
+    end
+
+    it 'GETs a resource' do
+      api.users.get()
+
+      expect(HTTParty).to have_received(:get).with("http://api.example.org/users", anything())
+    end
+  end
+
+  describe '#post' do
+    before :each do
+      allow(HTTParty).to receive(:post)
+    end
+
+    it 'POSTs a resource' do
+      api.users.post()
+
+      expect(HTTParty).to have_received(:post).with("http://api.example.org/users", anything())
+    end
+  end
+
+  describe '#put' do
+    before :each do
+      allow(HTTParty).to receive(:put)
+    end
+
+    it 'PUTs a resource' do
+      api.users.put()
+
+      expect(HTTParty).to have_received(:put).with("http://api.example.org/users", anything())
+    end
+  end
+
+  describe '#patch' do
+    before :each do
+      allow(HTTParty).to receive(:patch)
+    end
+
+    it 'PATCHes a resource' do
+      api.users.patch()
+
+      expect(HTTParty).to have_received(:patch).with("http://api.example.org/users", anything())
+    end
+  end
+
+  describe '#delete' do
+    before :each do
+      allow(HTTParty).to receive(:delete)
+    end
+
+    it 'DELETEs a resource' do
+      api.users.delete()
+
+      expect(HTTParty).to have_received(:delete).with("http://api.example.org/users", anything())
+    end
+  end
+end

data/spec/blanket_spec.rb

@@ -1,158 +1,9 @@
 require 'spec_helper'
 
 describe Blanket do
-  let :api do
-    Blanket::wrap("http://api.example.org")
-  end
-
-  describe 'Making Requests' do
-    before :each do
-      allow(HTTParty).to receive(:get)
-    end
-
-    it 'resets after performing a request' do
-      api.users.get()
-      api.videos.get()
-
-      expect(HTTParty).to have_received(:get).with("http://api.example.org/videos", anything())
-    end
-
-    describe "Response" do
-      before :each do
-        stub_request(:get, "http://api.example.org/users").to_return(:body => '{"title": "Something"}')
-      end
-
-      let :response do
-        api.users.get()
-      end
-
-      it "returns a Blanket::Response instance" do
-        expect(response).to be_kind_of(Blanket::Response)
-      end
-    end
-
-    describe 'Resource identification' do
-      context 'When using a resource method' do
-        it 'allows identifying a resource' do
-          api.users(55).get()
-
-          expect(HTTParty).to have_received(:get).with("http://api.example.org/users/55", anything())
-        end
-
-        it 'only allows one identifier per resource' do
-          api.users(55, 37).get()
-
-          expect(HTTParty).not_to have_received(:get).with("http://api.example.org/users/55/37", anything())
-        end
-      end
-
-      context 'When using #get' do
-        it 'allows identifying the last resource' do
-          api.users(55).videos.get(15)
-
-          expect(HTTParty).to have_received(:get).with("http://api.example.org/users/55/videos/15", anything())
-        end
-      end
-    end
-
-    describe 'Headers' do
-      it 'allows sending headers in a request' do
-        api.users(55).get(headers: {foo: 'bar'})
-
-        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', headers: {foo: 'bar'})
-      end
-
-      it 'allows setting headers globally' do
-        api = Blanket::wrap("http://api.example.org", headers: {token: 'my secret token'})
-        api.users(55).get()
-
-        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', headers: {token: 'my secret token'})
-      end
-    end
-
-    describe 'Parameters' do
-      it 'allows sending parameters in a request' do
-        api.users(55).get(params: {foo: 'bar'})
-
-        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55', query: {foo: 'bar'})
-      end
-    end
-
-    describe 'URL Extension' do
-      it 'allows setting an extension for a request', :wip => true do
-        users_endpoint = api.users(55)
-        users_endpoint.extension = :json
-        users_endpoint.get
-
-        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55.json', anything())
-      end
-
-      it 'allows setting an extension globally' do
-        api = Blanket::wrap("http://api.example.org", extension: :xml)
-        api.users(55).get
-
-        expect(HTTParty).to have_received(:get).with('http://api.example.org/users/55.xml', anything())
-      end
-    end
-  end
-
-  describe '#get' do
-    before :each do
-      allow(HTTParty).to receive(:get)
-    end
-
-    it 'GETs a resource' do
-      api.users.get()
-
-      expect(HTTParty).to have_received(:get).with("http://api.example.org/users", anything())
-    end
-  end
-
-  describe '#post' do
-    before :each do
-      allow(HTTParty).to receive(:post)
-    end
-
-    it 'POSTs a resource' do
-      api.users.post()
-
-      expect(HTTParty).to have_received(:post).with("http://api.example.org/users", anything())
-    end
-  end
-
-  describe '#put' do
-    before :each do
-      allow(HTTParty).to receive(:put)
-    end
-
-    it 'PUTs a resource' do
-      api.users.put()
-
-      expect(HTTParty).to have_received(:put).with("http://api.example.org/users", anything())
-    end
-  end
-
-  describe '#patch' do
-    before :each do
-      allow(HTTParty).to receive(:patch)
-    end
-
-    it 'PATCHes a resource' do
-      api.users.patch()
-
-      expect(HTTParty).to have_received(:patch).with("http://api.example.org/users", anything())
-    end
-  end
-
-  describe '#delete' do
-    before :each do
-      allow(HTTParty).to receive(:delete)
-    end
-
-    it 'DELETEs a resource' do
-      api.users.delete()
-
-      expect(HTTParty).to have_received(:delete).with("http://api.example.org/users", anything())
+  describe '.wrap' do
+    it "creates a new Blanket::Wrapper instance" do
+      expect(Blanket.wrap("a_url")).to be_kind_of(Blanket::Wrapper)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blanket_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bruno Abrantes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2014-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -192,6 +192,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: 
 email:
 - bruno@brunoabrantes.com
@@ -202,6 +216,7 @@ files:
 - .coveralls.yml
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - Guardfile
 - LICENSE
@@ -212,7 +227,9 @@ files:
 - lib/blanket.rb
 - lib/blanket/response.rb
 - lib/blanket/version.rb
+- lib/blanket/wrapper.rb
 - spec/blanket/response_spec.rb
+- spec/blanket/wrapper_spec.rb
 - spec/blanket_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/inf0rmer/blanket
@@ -241,5 +258,7 @@ specification_version: 4
 summary: A dead simple API wrapper. Access your data with style.
 test_files:
 - spec/blanket/response_spec.rb
+- spec/blanket/wrapper_spec.rb
 - spec/blanket_spec.rb
 - spec/spec_helper.rb
+has_rdoc: