Sha256: 41021a029090e0286efc3cf6d3538a03c7a79e46d6c9e7c8f4fa850e35a2cd04

Contents?: true

Size: 1.28 KB

Versions: 3

Compression:

Stored size: 1.28 KB

Contents

# ApiClient [![Build Status](https://secure.travis-ci.org/plribeiro3000/api-client.png)](http://travis-ci.org/plribeiro3000/api-client)

Client to make Api calls inside Rails easily. The master only supports ruby-1.9.3.
For older versions, check branch retro-compatibility.

## Installation

Add this line to your application's Gemfile:

    gem 'api-client'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install api-client

## Usage

Add this to your ApplicationController:

    rescue_from ApiClient::Exceptions::NotFound, :with => :not_found

    def not_found
       #Specify your own behavior here
    end

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

    class User < ApiClient::Base

Then, on your action, just put into it:

    @user = User.get("http://api.example.com/user/3")

## TODO
   * Add Support to Typhoeus and Faraday
   * Proper Treatment for validation errors
   * Add more Response Handlers

## Contributing

1. Fork 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

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
api-client-1.4.1 README.md
api-client-1.4.0 README.md
api-client-1.3.0 README.md