api-client 1.9.1 → 1.10.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.coveralls.yml
 *.swp
 Gemfile.lock
 InstalledFiles

data/.ruby-gemset

@@ -0,0 +1 @@
+api-client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p429

data/README.md

@@ -1,6 +1,6 @@
 # ApiClient
 
-[![Build Status](https://secure.travis-ci.org/zertico/api-client.png?branch=master)](http://travis-ci.org/zertico/api-client) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/zertico/api-client)
+[![Gem Version](https://badge.fury.io/rb/api-client.png)](http://badge.fury.io/rb/api-client) [![Build Status](https://secure.travis-ci.org/zertico/api-client.png?branch=master)](http://travis-ci.org/zertico/api-client) [![Dependency Status](https://gemnasium.com/zertico/api-client.png)](https://gemnasium.com/zertico/api-client) [![Coverage Status](https://coveralls.io/repos/zertico/api-client/badge.png?branch=master)](https://coveralls.io/r/zertico/api-client)  [![Code Climate](https://codeclimate.com/github/zertico/api-client.png)](https://codeclimate.com/github/zertico/api-client)
 
 ApiClient handle all the logic necessary to call Some API, catch the response and initialize an object with it for you.
 It is possible to use Typhoeus or the native Ruby Library Net::Http.

data/api-client.gemspec

@@ -6,7 +6,6 @@ Gem::Specification.new do |gem|
   gem.version     = ApiClient::VERSION
   gem.authors     = %q{Paulo Henrique Lopes Ribeiro}
   gem.email       = %q{plribeiro3000@gmail.com}
-  gem.homepage    = ""
   gem.summary     = %q{Client to make Api calls}
 
   gem.files         = `git ls-files`.split("\n")
@@ -18,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "yard"
+  gem.add_development_dependency "coveralls"
 
   gem.add_runtime_dependency "activemodel"
   gem.add_runtime_dependency "json_pure"

data/gemfiles/Gemfile.typhoeus

@@ -1,5 +1,3 @@
 source :rubygems
 
-gem 'typhoeus', '0.4.2'
-
-gemspec :path => '../'
+gemspec :path => '../'

data/lib/api-client.rb

@@ -4,7 +4,27 @@ require "api-client/version"
 module ApiClient
   autoload :Exceptions, 'api-client/exceptions'
   autoload :Errors, 'api-client/errors'
+  autoload :Configuration, 'api-client/configuration'
   autoload :Base, 'api-client/base'
+  autoload :Collection, 'api-client/collection'
   autoload :Dispatcher, 'api-client/dispatcher'
   autoload :Parser, 'api-client/parser'
-end
+  autoload :Builder, 'api-client/builder'
+
+  # Configures global settings
+  #   ApiClient.configure do |config|
+  #     config.url_path = "api.example.com"
+  #   end
+  def self.configure(&block)
+    yield @config ||= ApiClient::Configuration.new
+  end
+
+  # Global settings for ApiClient
+  def self.config
+    @config
+  end
+
+  configure do |config|
+    config.path = ''
+  end
+end

data/lib/api-client/base.rb

@@ -12,6 +12,8 @@ module ApiClient
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
+    extend ApiClient::Builder
+
     # @return [Hash] the request response.
     attr_accessor :response
 
@@ -23,7 +25,7 @@ module ApiClient
     # @param [Hash] attributes object attributes.
     # @return [Base] the object initialized.
     def initialize(attributes = {})
-      @errors = Errors.new(self)
+      @errors = ApiClient::Errors.new(self)
       attributes.each do |name, value|
         send("#{name.to_s}=", value)
       end
@@ -36,6 +38,22 @@ module ApiClient
       false
     end
 
+    # Return the path of the object on the api url.
+    #
+    # @return [String] the api path for this object.
+    def self.path
+      return self.to_s.gsub("::", "/").downcase.pluralize unless @path
+      @path
+    end
+
+    # Set the path of the object on the api url.
+    #
+    # @param [String] path string.
+    def self.path=(path)
+      path = path[1, path.size - 1] if path[0, 1] == "/"
+      @path = path
+    end
+
     # Return the Remote Object Name.
     #
     # @return [String] a string with the remote object class name.
@@ -91,13 +109,20 @@ module ApiClient
     #
     # @return [Hash] instance variables and its values.
     def attributes
-      attributes = {}
-      self.class.instance_variable_get("@attributes").map { |attribute| attributes[attribute.to_sym] = self.send("#{attribute}") }
-      attributes
+      self.class.instance_variable_get("@attributes").inject({}) { |hash, attribute| hash.merge(attribute.to_sym => self.send("#{attribute}")) }
     end
 
     alias_method :to_hash, :attributes
 
+    # Initialize a collection of objects. The collection will be an ApiClient::Collection object.
+    # The objects in the collection will be all instances of this (ApiClient::Base) class.
+    #
+    # @param [String] url to get the collection.
+    # @return [Collection] a collection of objects.
+    def self.collection(url)
+      ApiClient::Collection.new(self, url).collection
+    end
+
     # Set the hash of errors, making keys symbolic.
     #
     # @param [Hash] errors of the object.
@@ -108,13 +133,8 @@ module ApiClient
     protected
 
     def self.method_missing(method, *args)
-      @response = Parser.response(Dispatcher.send(method, *args), *args[0])
-      case true
-        when @response.instance_of?(Array) then return @response.map { |a| new(a.merge(:response => @response)) }
-        when @response.key?(remote_object) then return new(@response[remote_object].merge(:response => @response))
-        when @response.key?(remote_object.pluralize) then return @response[remote_object.pluralize].map { |a| new(a.merge(:response => @response)) }
-        else return new(@response.merge(:response => @response))
-      end
+      @response = ApiClient::Parser.response(ApiClient::Dispatcher.send(method, *args), *args[0])
+      build(self, @response)
     end
   end
 end

data/lib/api-client/builder.rb

@@ -0,0 +1,12 @@
+module ApiClient
+  module Builder
+    def build(object, params)
+      case true
+        when params.instance_of?(Array) then return params.map { |a| new(a.merge(:response => params)) }
+        when params.key?(remote_object) then return new(params[remote_object].merge(:response => params))
+        when params.key?(remote_object.pluralize) then return params[remote_object.pluralize].map { |a| new(a.merge(:response => params)) }
+        else return new(params.merge(:response => params))
+      end
+    end
+  end
+end

data/lib/api-client/collection.rb

@@ -0,0 +1,18 @@
+# ApiClient::Collection handle a collection of objects
+class ApiClient::Collection
+  include Enumerable
+
+  attr_accessor :collection
+
+  # Initialize a collection of given objects
+  #
+  # @param [Class] The class to instantiate the objects.
+  # @param [String] The url to get the data.
+  # @return [Collection] the collection of objects.
+  def initialize(klass, url)
+    @collection = ApiClient::Parser.response(ApiClient::Dispatcher.get(url), url)
+    @collection.map! do |attributes|
+      klass.new(attributes)
+    end
+  end
+end

data/lib/api-client/configuration.rb

@@ -0,0 +1,20 @@
+module ApiClient
+  # ApiClient::Configuration provides a way to configure ApiClient globally.
+  class Configuration
+    # Return the api url.
+    #
+    # @return [String] the api url.
+    def path
+      raise Exceptions::NotConfigured unless @path.size > 1
+      @path
+    end
+
+    # Set the api url.
+    #
+    # @param [String] api url.
+    def path=(path)
+      path = "#{path}/" unless path[path.size - 1, 1] == "/"
+      @path = path
+    end
+  end
+end

data/lib/api-client/dispatcher.rb

@@ -5,9 +5,9 @@ module ApiClient::Dispatcher
 
   def self.method_missing(method, *args)
     if defined?(::Typhoeus)
-        Typhoeus.send(method, *args)
+      Typhoeus.send(method, *args)
     else
-        NetHttp.send(method, *args)
+      NetHttp.send(method, *args)
     end
   end
 end

data/lib/api-client/exceptions.rb

@@ -8,4 +8,5 @@ module ApiClient::Exceptions
   autoload :BadGateway, 'api-client/exceptions/bad_gateway'
   autoload :ServiceUnavailable, 'api-client/exceptions/service_unavailable'
   autoload :ConnectionRefused, 'api-client/exceptions/connection_refused'
-end
+  autoload :NotConfigured, 'api-client/exceptions/not_configured'
+end

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

@@ -0,0 +1,9 @@
+# Exception for requests where the full path is not properly configured.
+class ApiClient::Exceptions::NotConfigured < StandardError
+  # Initialize a new exception.
+  #
+  # @return [NotConfigured] a new exception.
+  def self.initialize
+    super("The api path is not properly configured!")
+  end
+end

data/lib/api-client/version.rb

@@ -1,5 +1,5 @@
 # High Level Namespace of the library ApiClient.
 module ApiClient
   # Version of the library.
-  VERSION = "1.9.1"
+  VERSION = "1.10.0"
 end

data/spec/api-client/base_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe ApiClient::Base do
+  let(:user) { User.new }
+  let(:collection) { Object.new }
+
   describe "#initialize" do
     context "with a hash {:a => 'a', :b => 'b'}" do
       before :each do
@@ -21,6 +24,46 @@ describe ApiClient::Base do
     end
   end
 
+  describe "#path" do
+    describe "when not configured" do
+      it "should return a name based on the class name" do
+        User.path.should == "users"
+      end
+    end
+
+    describe "when properly configured" do
+      before :each do
+        User.path = "admins"
+      end
+
+      it "should return the path value" do
+        User.path.should == "admins"
+      end
+    end
+  end
+
+  describe "#path=" do
+    describe "with a string without '/'" do
+      before :each do
+        User.path = "users"
+      end
+
+      it "should set it as passed" do
+        User.path.should == "users"
+      end
+    end
+
+    describe "with a string with '/'" do
+      before :each do
+        User.path = "/users"
+      end
+
+      it "should set it without the '/'" do
+        User.path.should == "users"
+      end
+    end
+  end
+
   describe "#remote_object" do
     context "on a class without remote object specification" do
       it "should return the class name" do
@@ -73,6 +116,17 @@ describe ApiClient::Base do
     end
   end
 
+  describe "#collection" do
+    before :each do
+      ApiClient::Collection.stub(:new).with(User, "http://api.example.com").and_return(collection)
+      collection.stub(:collection => [ user, user ])
+    end
+
+    it "should return a collection of objects" do
+      User.collection("http://api.example.com").should == [ user, user ]
+    end
+  end
+
   describe "#errors=" do
     before :each do
       @user = User.new(:errors => { "a" => "message", "b" => "message" })

data/spec/api-client/collection_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ApiClient::Collection do
+  let(:user) { User.new }
+
+  before :each do
+    stub_request(:get, "http://api.example.com").to_return(:body => [ {"a" => "b"}, {"a" => "b2"} ].to_json)
+    User.stub(:new => user)
+    @collection = ApiClient::Collection.new(User, "http://api.example.com")
+  end
+
+  it "should include enumerable module" do
+    @collection.should respond_to(:first)
+  end
+
+  describe "#initialize" do
+    it "Should initialize a collection of Objects" do
+      @collection.collection.should == [user, user]
+    end
+  end
+end

data/spec/api-client/configuration_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe ApiClient::Configuration do
+  describe "#path" do
+    describe "when not configured" do
+      it "should raise an error" do
+        lambda { ApiClient.config.path }.should raise_error(ApiClient::Exceptions::NotConfigured)
+      end
+    end
+
+    describe "when properly configured" do
+      before :each do
+        ApiClient.configure do |config|
+          config.path = "api.example.com"
+        end
+      end
+
+      it "should return the path value" do
+        ApiClient.config.path.should_not be_nil
+      end
+    end
+  end
+
+  describe "#path=" do
+    describe "with a string without '/'" do
+      before :each do
+        ApiClient.config.path = "api.example.com"
+      end
+
+      it "should set it with a '/'" do
+        ApiClient.config.path.should == "api.example.com/"
+      end
+    end
+
+    describe "with a string with '/'" do
+      before :each do
+        ApiClient.config.path = "api.example.com/"
+      end
+
+      it "should set it as passed" do
+        ApiClient.config.path.should == "api.example.com/"
+      end
+    end
+  end
+end

data/spec/api-client/parser_spec.rb

@@ -31,7 +31,7 @@ describe ApiClient::Parser do
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
-        it "should return a Unauthorized exception" do
+        it "should raise a Unauthorized exception" do
           lambda { ApiClient::Parser.response(@response, 'http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::Unauthorized)
         end
       end
@@ -42,7 +42,7 @@ describe ApiClient::Parser do
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
-        it "should return a Forbidden exception" do
+        it "should raise a Forbidden exception" do
           lambda { ApiClient::Parser.response(@response, 'http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::Forbidden)
         end
       end
@@ -53,7 +53,7 @@ describe ApiClient::Parser do
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
-        it "should return a NotFound exception" do
+        it "should raise a NotFound exception" do
           lambda { ApiClient::Parser.response(@response, 'http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::NotFound, "http://api.example.com/user/5")
         end
       end
@@ -64,7 +64,7 @@ describe ApiClient::Parser do
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
-        it "should return a InternalServerError exception" do
+        it "should raise a InternalServerError exception" do
           lambda { ApiClient::Parser.response(@response, 'http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::InternalServerError)
         end
       end
@@ -75,7 +75,7 @@ describe ApiClient::Parser do
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
-        it "should return a BadGateway exception" do
+        it "should raise a BadGateway exception" do
           lambda { ApiClient::Parser.response(@response, 'http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::BadGateway)
         end
       end
@@ -86,7 +86,7 @@ describe ApiClient::Parser do
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
-        it "should return a ServiceUnavailable exception" do
+        it "should raise a ServiceUnavailable exception" do
           lambda { ApiClient::Parser.response(@response, 'http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::ServiceUnavailable)
         end
       end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require "rspec"
-require 'webmock/rspec'
+require "webmock/rspec"
 require "json"
+require "coveralls"
+
+Coveralls.wear!
 
 require File.dirname(__FILE__) + "/../lib/api-client"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +131,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -132,6 +149,9 @@ files:
 - gemfiles/Gemfile.typhoeus
 - lib/api-client.rb
 - lib/api-client/base.rb
+- lib/api-client/builder.rb
+- lib/api-client/collection.rb
+- lib/api-client/configuration.rb
 - lib/api-client/dispatcher.rb
 - lib/api-client/dispatcher/net-http.rb
 - lib/api-client/dispatcher/typhoeus.rb
@@ -142,6 +162,7 @@ files:
 - lib/api-client/exceptions/forbidden.rb
 - lib/api-client/exceptions/generic.rb
 - lib/api-client/exceptions/internal_server_error.rb
+- lib/api-client/exceptions/not_configured.rb
 - lib/api-client/exceptions/not_found.rb
 - lib/api-client/exceptions/service_unavailable.rb
 - lib/api-client/exceptions/unauthorized.rb
@@ -149,11 +170,13 @@ files:
 - lib/api-client/parser.rb
 - lib/api-client/version.rb
 - spec/api-client/base_spec.rb
+- spec/api-client/collection_spec.rb
+- spec/api-client/configuration_spec.rb
 - spec/api-client/dispatcher_spec.rb
 - spec/api-client/errors_spec.rb
 - spec/api-client/parser_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: 
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -167,7 +190,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1190097789751108706
+      hash: 4163480247094767209
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -176,10 +199,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1190097789751108706
+      hash: 4163480247094767209
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Client to make Api calls

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@api-client