api-client 1.1.1 → 1.2.0

data/lib/api-client/base.rb

@@ -18,12 +18,24 @@ class ApiClient::Base
     false
   end
 
-  def self.get(url = '')
-    dispatch { _get(url) }
+  def self.get(url = '', header = {})
+    dispatch { _get(url, header) }
   end
 
-  def self.post(url = '', args = {})
-    dispatch { _post(url, args) }
+  def self.post(url = '', args = {}, header = {})
+    dispatch { _post(url, args, header) }
+  end
+
+  def self.put(url = '', args = {}, header = {})
+    dispatch { _put(url, args, header) }
+  end
+
+  def self.patch(url = '', args = {}, header = {})
+    dispatch { _patch(url, args, header) }
+  end
+
+  def self.delete(url = '', header = {})
+    dispatch { _delete(url, header) }
   end
 
   protected

data/lib/api-client/dispatcher.rb

@@ -1,13 +1,35 @@
 require "net/http"
 
 module ApiClient::Dispatcher
-  def _get(url = '')
-    Net::HTTP.get_response(URI.parse(url))
+  def _get(url, header)
+    initialize_connection(url)
+    @http.get(@uri.path, header)
   end
 
-  def _post(url = '', args = {})
-    uri = URI(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.post(uri.path, args.to_json, { 'Content-Type' => 'application/json' })
+  def _post(url, args, header)
+    initialize_connection(url)
+    @http.post(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header))
+  end
+
+  def _put(url, args, header)
+    initialize_connection(url)
+    @http.put(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header))
+  end
+
+  def _patch(url, args, header)
+    initialize_connection(url)
+    @http.patch(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header))
+  end
+
+  def _delete(url, header)
+    initialize_connection(url)
+    @http.delete(@uri.path, header)
+  end
+
+  protected
+
+  def initialize_connection(url = '')
+    @uri = URI(url)
+    @http = Net::HTTP.new(@uri.host, @uri.port)
   end
 end

data/lib/api-client/version.rb

@@ -1,3 +1,3 @@
 module ApiClient
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/api-client/base/delete_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe ApiClient::Base do
+  let(:user) { User.new(:a => "a", :b => "b") }
+
+  describe "#delete" do
+    context "when connection is refused" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
+      end
+
+      it "should return a ConnectionRefused exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
+      end
+    end
+
+    context "when response code is 401" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "401")
+      end
+
+      it "should return a Unauthorized exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::Unauthorized)
+      end
+    end
+
+    context "when response code is 403" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "403")
+      end
+
+      it "should return a Forbidden exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::Forbidden)
+      end
+    end
+
+    context "when response code is 404" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "404")
+      end
+
+      it "should return a NotFound exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::NotFound)
+      end
+    end
+
+    context "when response code is 500" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "500")
+      end
+
+      it "should return a InternalServerError exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::InternalServerError)
+      end
+    end
+
+    context "when response code is 502" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "502")
+      end
+
+      it "should return a BadGateway exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::BadGateway)
+      end
+    end
+
+    context "when response code is 503" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "503")
+      end
+
+      it "should return a ServiceUnavailable exception" do
+        lambda { ApiClient::Base.delete('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::ServiceUnavailable)
+      end
+    end
+
+    context "when response code is 2xx" do
+      before :each do
+        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+        User.stub(:new).and_return(user)
+      end
+
+      it "should return a object intialized with the response" do
+        User.delete('http://api.example.com/user/5').should == user
+      end
+    end
+  end
+end

data/spec/api-client/base/patch_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe ApiClient::Base do
+  let(:user) { User.new(:a => "a", :b => "b") }
+
+  describe "#patch" do
+    context "when connection is refused" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
+      end
+
+      it "should return a ConnectionRefused exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
+      end
+    end
+
+    context "when response code is 401" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "401")
+      end
+
+      it "should return a Unauthorized exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::Unauthorized)
+      end
+    end
+
+    context "when response code is 403" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "403")
+      end
+
+      it "should return a Forbidden exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::Forbidden)
+      end
+    end
+
+    context "when response code is 404" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "404")
+      end
+
+      it "should return a NotFound exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::NotFound)
+      end
+    end
+
+    context "when response code is 500" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "500")
+      end
+
+      it "should return a InternalServerError exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::InternalServerError)
+      end
+    end
+
+    context "when response code is 502" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "502")
+      end
+
+      it "should return a BadGateway exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::BadGateway)
+      end
+    end
+
+    context "when response code is 503" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "503")
+      end
+
+      it "should return a ServiceUnavailable exception" do
+        lambda { ApiClient::Base.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ServiceUnavailable)
+      end
+    end
+
+    context "when response code is 2xx" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+        User.stub(:new).and_return(user)
+      end
+
+      it "should return a object initialized with the response" do
+        User.patch('http://api.example.com/user/5', {}).should == user
+      end
+    end
+
+    context "with a specified port" do
+      before :each do
+        FakeWeb.register_uri(:patch, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+        User.stub(:new).and_return(user)
+      end
+
+      it "should return a object initialized with the response" do
+        User.patch('http://api.example.com:3001/user/5', {}).should == user
+      end
+    end
+  end
+end

data/spec/api-client/base/put_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe ApiClient::Base do
+  let(:user) { User.new(:a => "a", :b => "b") }
+
+  describe "#put" do
+    context "when connection is refused" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
+      end
+
+      it "should return a ConnectionRefused exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
+      end
+    end
+
+    context "when response code is 401" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "401")
+      end
+
+      it "should return a Unauthorized exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::Unauthorized)
+      end
+    end
+
+    context "when response code is 403" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "403")
+      end
+
+      it "should return a Forbidden exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::Forbidden)
+      end
+    end
+
+    context "when response code is 404" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "404")
+      end
+
+      it "should return a NotFound exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::NotFound)
+      end
+    end
+
+    context "when response code is 500" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "500")
+      end
+
+      it "should return a InternalServerError exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::InternalServerError)
+      end
+    end
+
+    context "when response code is 502" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "502")
+      end
+
+      it "should return a BadGateway exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::BadGateway)
+      end
+    end
+
+    context "when response code is 503" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "503")
+      end
+
+      it "should return a ServiceUnavailable exception" do
+        lambda { ApiClient::Base.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ServiceUnavailable)
+      end
+    end
+
+    context "when response code is 2xx" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+        User.stub(:new).and_return(user)
+      end
+
+      it "should return a object initialized with the response" do
+        User.put('http://api.example.com/user/5', {}).should == user
+      end
+    end
+
+    context "with a specified port" do
+      before :each do
+        FakeWeb.register_uri(:put, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+        User.stub(:new).and_return(user)
+      end
+
+      it "should return a object initialized with the response" do
+        User.put('http://api.example.com:3001/user/5', {}).should == user
+      end
+    end
+  end
+end

data/spec/api-client/dispatcher_spec.rb

@@ -7,7 +7,7 @@ describe ApiClient::Dispatcher do
     end
 
     it "should return the response code and body" do
-      ApiClient::Base._get("http://api.example.com/user/5").should be_a(Net::HTTPOK)
+      ApiClient::Base._get("http://api.example.com/user/5", {}).should be_a(Net::HTTPOK)
     end
   end
 
@@ -17,7 +17,37 @@ describe ApiClient::Dispatcher do
     end
 
     it "should return the response code and body" do
-      ApiClient::Base._post("http://api.example.com/user/5", {}).should be_a(Net::HTTPCreated)
+      ApiClient::Base._post("http://api.example.com/user/5", {}, {}).should be_a(Net::HTTPCreated)
+    end
+  end
+
+  describe "#_put" do
+    before :each do
+      FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "200")
+    end
+
+    it "should return the response code and body" do
+      ApiClient::Base._put("http://api.example.com/user/5", {}, {}).should be_a(Net::HTTPOK)
+    end
+  end
+
+  describe "#_patch" do
+    before :each do
+      FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "200")
+    end
+
+    it "should return the response code and body" do
+      ApiClient::Base._patch("http://api.example.com/user/5", {}, {}).should be_a(Net::HTTPOK)
+    end
+  end
+
+  describe "#_delete" do
+    before :each do
+      FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "200")
+    end
+
+    it "should return the response code and body" do
+      ApiClient::Base._delete("http://api.example.com/user/5", {}).should be_a(Net::HTTPOK)
     end
   end
 end

data/spec/api-client/parser_spec.rb

@@ -7,7 +7,7 @@ describe ApiClient::Parser do
         FakeWeb.register_uri(:post, "http://api.example.com/user/5",
                              :body => { :a => :b }.to_json,
                              :status => "201")
-        @response = ApiClient::Base._post('http://api.example.com/user/5', {})
+        @response = ApiClient::Base._post('http://api.example.com/user/5', {}, {})
       end
 
       it "should return the response code and the body parsed" do
@@ -20,7 +20,7 @@ describe ApiClient::Parser do
         FakeWeb.register_uri(:post, "http://api.example.com/user/5",
                              :body => "wrong",
                              :status => "201")
-        @response = ApiClient::Base._post('http://api.example.com/user/5', {})
+        @response = ApiClient::Base._post('http://api.example.com/user/5', {}, {})
       end
 
       it "should return the response code and a nil body" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-03 00:00:00.000000000 Z
+date: 2012-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -120,8 +120,11 @@ files:
 - lib/api-client/exceptions/unauthorized.rb
 - lib/api-client/parser.rb
 - lib/api-client/version.rb
+- spec/api-client/base/delete_spec.rb
 - spec/api-client/base/get_spec.rb
+- spec/api-client/base/patch_spec.rb
 - spec/api-client/base/post_spec.rb
+- spec/api-client/base/put_spec.rb
 - spec/api-client/base_spec.rb
 - spec/api-client/dispatcher_spec.rb
 - spec/api-client/parser_spec.rb
@@ -138,12 +141,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2002336376780002209
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2002336376780002209
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24