api-client 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v1.3.0
+
+* functionality to read args with a root node added.
+
 ## v1.2.0
 
 * methods put, patch and delete added.

data/examples/controllers/application_controller.rb

@@ -0,0 +1,18 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  respond_to :html
+
+  # NotFound errors will be redirected to the action not_found while any other will be redirected to the action generic.
+  rescue_from ApiClient::Exceptions::NotFound, :with => :not_found
+  rescue_from ApiClient::Exceptions::Generic, :with => :generic
+
+  # This code is only for example purposes.
+  # Any behavior can be executed here. Just write your own.
+  def not_found
+    ApplicationMailer.send_not_found_notice.deliver
+  end
+
+  def generic
+    ApplicationMailer.send_generic_error.deliver
+  end
+end

data/examples/controllers/user_controller.rb

@@ -0,0 +1,8 @@
+class UserController < ApplicationController
+  # It will works with respond_with.
+  # Your action should looks like any other one: A model with a method call. =D
+  def index
+    @user = User.get("api.example.com/users")
+    respond_with(@users)
+  end
+end

data/examples/models/user.rb

@@ -0,0 +1,4 @@
+class User < ApiClient::Base
+  # Any of this fields can be called to manage rails form.
+  attr_accessor :id, :email, :password, :password_confirmation
+end

data/lib/api-client.rb

@@ -3,6 +3,7 @@ require "api-client/version"
 # High Level Namespace of the library ApiClient.
 module ApiClient
   autoload :Exceptions, 'api-client/exceptions'
+  autoload :Errors, 'api-client/errors'
   autoload :Base, 'api-client/base'
   autoload :Dispatcher, 'api-client/dispatcher'
   autoload :Parser, 'api-client/parser'

data/lib/api-client/base.rb

@@ -14,7 +14,10 @@ class ApiClient::Base
   extend ApiClient::Parser
   extend ApiClient::Dispatcher
 
-  # Initialize an object based on a hash of a attributes.
+  # @params [Hash] Hash of errors.
+  attr_writer :errors
+
+  # Initialize an object based on a hash of attributes.
   #
   # @param [Hash] attributes object attributes.
   # @return [Base] the object initialized.
@@ -26,11 +29,18 @@ class ApiClient::Base
 
   # Return if a object is persisted on the database or not.
   #
-  # @return [False] it will always return false.
+  # @return [False] always return false.
   def persisted?
     false
   end
 
+  # Return the an array of errors if existent, otherwise instantiate a new ApiClient::Errors object with self.
+  #
+  # @return [ApiClient::Errors] the validation errors.
+  def errors
+    @errors ||= ApiClient::Errors.new(self)
+  end
+
   # Make a get request and returns a new instance with te response attributes.
   #
   # @param [String] url of the api request.

data/lib/api-client/errors.rb

@@ -0,0 +1,17 @@
+require "active_model"
+
+# ApiClient::Errors provide extra functionality to ActiveModel::Errors.
+class ApiClient::Errors < ActiveModel::Errors
+  # Create a hash of attributes with unique validation error messages.
+  #
+  # Example:
+  #    user.errors.unique_messages   #=> { :name => [ can't be empty and is invalid ]}
+  #
+  # @return [Hash] The hash of attributes with a unique error message.
+  #
+  def unique_messages
+    errors = {}
+    to_hash.each do |attribute, messages| errors[attribute] = messages.join(" and ") end
+    errors
+  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.3.0"
-end
+  VERSION = "1.4.0"
+end

data/spec/api-client/base_spec.rb

@@ -22,4 +22,26 @@ describe ApiClient::Base do
       User.new.should_not be_persisted
     end
   end
+
+  describe "#errors" do
+    context "when @errors is not nil" do
+      before :each do
+        @user = User.new(:errors => {:a => :bc})
+      end
+
+      it "should return the errors" do
+        @user.errors.should == {:a => :bc}
+      end
+    end
+
+    context "when @errors is nil" do
+      before :each do
+        @user = User.new
+      end
+
+      it "should instantiate a new instance of ApiClient::Errors" do
+        @user.errors.should be_an_instance_of(ApiClient::Errors)
+      end
+    end
+  end
 end

data/spec/api-client/errors_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ApiClient::Errors do
+  describe "#unique_messages" do
+    before :each do
+      @user = User.new
+      @user.valid?
+    end
+
+    it "should set #a" do
+      @user.errors.unique_messages.should == { :a => "can't be blank and is not included in the list" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,4 +6,7 @@ require File.dirname(__FILE__) + "/../lib/api-client"
 
 class User < ApiClient::Base
   attr_accessor :a, :b
+
+  validates_presence_of :a
+  validates_inclusion_of :a, :in => %w(a A)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-06 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -123,9 +123,13 @@ files:
 - README.md
 - Rakefile
 - api-client.gemspec
+- examples/controllers/application_controller.rb
+- examples/controllers/user_controller.rb
+- examples/models/user.rb
 - lib/api-client.rb
 - lib/api-client/base.rb
 - lib/api-client/dispatcher.rb
+- lib/api-client/errors.rb
 - lib/api-client/exceptions.rb
 - lib/api-client/exceptions/bad_gateway.rb
 - lib/api-client/exceptions/connection_refused.rb
@@ -144,6 +148,7 @@ files:
 - spec/api-client/base/put_spec.rb
 - spec/api-client/base_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: ''
@@ -158,18 +163,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2404782696775397333
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2404782696775397333
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24