api-client 0.6.0 → 1.0.0

data/README.md

@@ -30,9 +30,17 @@ You can define a more generic rescue that will work for any error:
 
     rescue_from ApiClient::Exceptions::Generic, :with => :generic_error
 
+On Your model, extend ApiClient::Base
+
+    def User < Apiclient::Base
+
 Then, on your action, just put into it:
 
-    @user = ApiClient.get("http://api.example.com/user/3")
+    @user = User.get("http://api.example.com/user/3")
+
+## TODO
+   Add Support to Typhoeus and Faraday
+   Proper Treatment for validation errors
 
 ## Contributing
 
@@ -40,4 +48,4 @@ Then, on your action, just put into it:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/api-client.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "fakeweb"
   gem.add_development_dependency "rspec", "2.9.0"
+
+  gem.add_runtime_dependency "activemodel"
 end

data/lib/api-client.rb

@@ -1,38 +1,8 @@
 require "api-client/version"
 require "net/http"
+require "active_model"
 
 module ApiClient
   autoload :Exceptions, 'api-client/exceptions'
-
-  def self.get(url = '')
-    begin
-      response = Net::HTTP.get_response(URI.parse(url))
-    rescue Errno::ECONNREFUSED
-      raise ApiClient::Exceptions::ConnectionRefused
-    end
-    raise_exception(response.code)
-    response.body
-  end
-
-  def self.post(url = '', args = {})
-    begin
-      response = Net::HTTP.post_form(URI.parse(url), args)
-    rescue Errno::ECONNREFUSED
-      raise ApiClient::Exceptions::ConnectionRefused
-    end
-    raise_exception(response.code)
-    response.body
-  end
-
-  def self.raise_exception(code)
-    case code
-      when '400' then raise ApiClient::Exceptions::BadRequest
-      when '401' then raise ApiClient::Exceptions::Unauthorized
-      when '403' then raise ApiClient::Exceptions::Forbidden
-      when '404' then raise ApiClient::Exceptions::NotFound
-      when '500' then raise ApiClient::Exceptions::InternalServerError
-      when '502' then raise ApiClient::Exceptions::BadGateway
-      when '503' then raise ApiClient::Exceptions::ServiceUnavailable
-    end
-  end
+  autoload :Base, 'api-client/base'
 end

data/lib/api-client/base.rb

@@ -0,0 +1,46 @@
+class ApiClient::Base
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+  extend ActiveModel::Naming
+
+  def initialize(attributes = {})
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+  end
+
+  def persisted?
+    false
+  end
+
+  def self.get(url = '')
+    call do Net::HTTP.get_response(URI.parse(url)) end
+  end
+
+  def self.post(url = '', args = {})
+    call do Net::HTTP.post_form(URI.parse(url), args) end
+  end
+
+  protected
+
+  def self.call
+    begin
+      response = yield
+    rescue Errno::ECONNREFUSED
+      raise ApiClient::Exceptions::ConnectionRefused
+    end
+    raise_exception(response.code)
+    new(JSON.parse(response.body))
+  end
+
+  def self.raise_exception(code)
+    case code
+      when '401' then raise ApiClient::Exceptions::Unauthorized
+      when '403' then raise ApiClient::Exceptions::Forbidden
+      when '404' then raise ApiClient::Exceptions::NotFound
+      when '500' then raise ApiClient::Exceptions::InternalServerError
+      when '502' then raise ApiClient::Exceptions::BadGateway
+      when '503' then raise ApiClient::Exceptions::ServiceUnavailable
+    end
+  end
+end

data/lib/api-client/exceptions.rb

@@ -7,5 +7,4 @@ module ApiClient::Exceptions
   autoload :BadGateway, 'api-client/exceptions/bad_gateway'
   autoload :ServiceUnavailable, 'api-client/exceptions/service_unavailable'
   autoload :ConnectionRefused, 'api-client/exceptions/connection_refused'
-  autoload :BadRequest, 'api-client/exceptions/bad_request'
 end

data/lib/api-client/version.rb

@@ -1,3 +1,3 @@
 module ApiClient
-  VERSION = "0.6.0"
+  VERSION = "1.0.0"
 end

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

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe ApiClient::Base do
+  let(:user) { User.new(:a => "a", :b => "b") }
+
+  describe "#get" do
+    context "when connection is refused" do
+      before :each do
+        Net::HTTP.stub(:get_response).and_raise(Errno::ECONNREFUSED)
+      end
+
+      it "should return a ConnectionRefused exception" do
+        lambda { ApiClient::Base.get('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(:get, "http://api.example.com/user/5", :status => "401")
+      end
+
+      it "should return a Unauthorized exception" do
+        lambda { ApiClient::Base.get('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(:get, "http://api.example.com/user/5", :status => "403")
+      end
+
+      it "should return a Forbidden exception" do
+        lambda { ApiClient::Base.get('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(:get, "http://api.example.com/user/5", :status => "404")
+      end
+
+      it "should return a NotFound exception" do
+        lambda { ApiClient::Base.get('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(:get, "http://api.example.com/user/5", :status => "500")
+      end
+
+      it "should return a InternalServerError exception" do
+        lambda { ApiClient::Base.get('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(:get, "http://api.example.com/user/5", :status => "502")
+      end
+
+      it "should return a BadGateway exception" do
+        lambda { ApiClient::Base.get('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(:get, "http://api.example.com/user/5", :status => "503")
+      end
+
+      it "should return a ServiceUnavailable exception" do
+        lambda { ApiClient::Base.get('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(:get, "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.get('http://api.example.com/user/5').should == user
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe ApiClient::Base do
+  let(:user) { User.new(:a => "a", :b => "b") }
+
+  describe "#post" do
+    context "when connection is refused" do
+      before :each do
+        Net::HTTP.stub(:post_form).and_raise(Errno::ECONNREFUSED)
+      end
+
+      it "should return a ConnectionRefused exception" do
+        lambda { ApiClient::Base.post('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(:post, "http://api.example.com/user/5", :status => "401")
+      end
+
+      it "should return a Unauthorized exception" do
+        lambda { ApiClient::Base.post('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(:post, "http://api.example.com/user/5", :status => "403")
+      end
+
+      it "should return a Forbidden exception" do
+        lambda { ApiClient::Base.post('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(:post, "http://api.example.com/user/5", :status => "404")
+      end
+
+      it "should return a NotFound exception" do
+        lambda { ApiClient::Base.post('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(:post, "http://api.example.com/user/5", :status => "500")
+      end
+
+      it "should return a InternalServerError exception" do
+        lambda { ApiClient::Base.post('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(:post, "http://api.example.com/user/5", :status => "502")
+      end
+
+      it "should return a BadGateway exception" do
+        lambda { ApiClient::Base.post('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(:post, "http://api.example.com/user/5", :status => "503")
+      end
+
+      it "should return a ServiceUnavailable exception" do
+        lambda { ApiClient::Base.post('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(:post, "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.post('http://api.example.com/user/5', {}).should == user
+      end
+    end
+  end
+end

data/spec/api-client/base_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ApiClient::Base do
+  describe "#initialize" do
+    context "with a hash {:a => 'a', :b => 'b'}" do
+      before :each do
+        @user = User.new({:a => "a", :b => "b"})
+      end
+
+      it "should set #a" do
+        @user.a.should == "a"
+      end
+
+      it "should set #b" do
+        @user.b.should == "b"
+      end
+    end
+  end
+
+  describe "#persisted?" do
+    it "should return false" do
+      User.new.should_not be_persisted
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,9 @@
 require "rspec"
 require "fakeweb"
+require "json"
 
-require File.dirname(__FILE__) + "/../lib/api-client"
+require File.dirname(__FILE__) + "/../lib/api-client"
+
+class User < ApiClient::Base
+  attr_accessor :a, :b
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-04 00:00:00.000000000 Z
+date: 2012-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,6 +59,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: plribeiro3000@gmail.com
 executables: []
@@ -75,9 +91,9 @@ files:
 - Rakefile
 - api-client.gemspec
 - lib/api-client.rb
+- lib/api-client/base.rb
 - lib/api-client/exceptions.rb
 - lib/api-client/exceptions/bad_gateway.rb
-- lib/api-client/exceptions/bad_request.rb
 - lib/api-client/exceptions/connection_refused.rb
 - lib/api-client/exceptions/forbidden.rb
 - lib/api-client/exceptions/generic.rb
@@ -86,7 +102,9 @@ files:
 - lib/api-client/exceptions/service_unavailable.rb
 - lib/api-client/exceptions/unauthorized.rb
 - lib/api-client/version.rb
-- spec/api_client_spec.rb
+- spec/api-client/base/get_spec.rb
+- spec/api-client/base/post_spec.rb
+- spec/api-client/base_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []

data/lib/api-client/exceptions/bad_request.rb

@@ -1,5 +0,0 @@
-class ApiClient::Exceptions::BadRequest < ApiClient::Exceptions::Generic
-  def self.initialize
-    super("Bad Request!")
-  end
-end

data/spec/api_client_spec.rb

@@ -1,187 +0,0 @@
-require 'spec_helper'
-
-describe ApiClient do
-  describe "#get" do
-    context "when connection is refused" do
-      before :each do
-        Net::HTTP.stub(:get_response).and_raise(Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient.get('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
-    end
-
-    context "when response code is 400" do
-      before :each do
-        FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "400")
-      end
-
-      it "should return a BadRequest exception" do
-        lambda { ApiClient.get('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::BadRequest)
-      end
-    end
-
-    context "when response code is 401" do
-      before :each do
-        FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "401")
-      end
-
-      it "should return a Unauthorized exception" do
-        lambda { ApiClient.get('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(:get, "http://api.example.com/user/5", :status => "403")
-      end
-
-      it "should return a Forbidden exception" do
-        lambda { ApiClient.get('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(:get, "http://api.example.com/user/5", :status => "404")
-      end
-
-      it "should return a NotFound exception" do
-        lambda { ApiClient.get('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(:get, "http://api.example.com/user/5", :status => "500")
-      end
-
-      it "should return a InternalServerError exception" do
-        lambda { ApiClient.get('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(:get, "http://api.example.com/user/5", :status => "502")
-      end
-
-      it "should return a BadGateway exception" do
-        lambda { ApiClient.get('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(:get, "http://api.example.com/user/5", :status => "503")
-      end
-
-      it "should return a ServiceUnavailable exception" do
-        lambda { ApiClient.get('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(:get, "http://api.example.com/user/5", :status => "201", :body => "User#3333")
-      end
-
-      it "should return the response body" do
-        ApiClient.get('http://api.example.com/user/5').should == "User#3333"
-      end
-    end
-  end
-
-  describe "#post" do
-    context "when connection is refused" do
-      before :each do
-        Net::HTTP.stub(:post_form).and_raise(Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient.post('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
-    end
-
-    context "when response code is 400" do
-      before :each do
-        FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "400")
-      end
-
-      it "should return a BadRequest exception" do
-        lambda { ApiClient.post('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::BadRequest)
-      end
-    end
-
-    context "when response code is 401" do
-      before :each do
-        FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "401")
-      end
-
-      it "should return a Unauthorized exception" do
-        lambda { ApiClient.post('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(:post, "http://api.example.com/user/5", :status => "403")
-      end
-
-      it "should return a Forbidden exception" do
-        lambda { ApiClient.post('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(:post, "http://api.example.com/user/5", :status => "404")
-      end
-
-      it "should return a NotFound exception" do
-        lambda { ApiClient.post('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(:post, "http://api.example.com/user/5", :status => "500")
-      end
-
-      it "should return a InternalServerError exception" do
-        lambda { ApiClient.post('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(:post, "http://api.example.com/user/5", :status => "502")
-      end
-
-      it "should return a BadGateway exception" do
-        lambda { ApiClient.post('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(:post, "http://api.example.com/user/5", :status => "503")
-      end
-
-      it "should return a ServiceUnavailable exception" do
-        lambda { ApiClient.post('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(:post, "http://api.example.com/user/5", :status => "201", :body => "User#3333")
-      end
-
-      it "should return the response body" do
-        ApiClient.post('http://api.example.com/user/5', {}).should == "User#3333"
-      end
-    end
-  end
-end