JsonApiClient Build Status Code Climate Code Coverage

This gem is meant to help you build an API client for interacting with REST APIs as laid out by http://jsonapi.org. It attempts to give you a query building framework that is easy to understand (it is similar to ActiveRecord scopes).

Note: This is still a work in progress.

Usage

module MyApi
  class User < JsonApiClient::Resource
    has_many :accounts
  end

  class  < JsonApiClient::Resource
    belongs_to :user
  end
end

MyApi::User.all
MyApi::User.where(account_id: 1).find(1)
MyApi::User.where(account_id: 1).all

MyApi::User.where(name: "foo").order("created_at desc").includes(:preferences, :cars).all

u = MyApi::User.new(foo: "bar", bar: "foo")
u.save

u = MyApi::User.find(1).first
u.update_attributes(
  a: "b",
  c: "d"
)

u = MyApi::User.create(
  a: "b",
  c: "d"
)

u = MyApi::User.find(1).first
u.accounts
=> MyApi::.where(user_id: u.id).all

Connection Options

You can configure your connection using Faraday middleware. In general, you'll want to do this in a base model that all your resources inherit from:

MyApi::Base.connection do |connection|
  # set OAuth2 headers
  connection.use Faraday::Request::Oauth2, 'MYTOKEN'

  # log responses
  connection.use Faraday::Response::Logger

  connection.use MyCustomMiddleware
end

module MyApi
  class User < Base
    # will use the customized connection
  end
end

Custom Connection

You can configure your API client to use a custom connection that implementes the execute instance method. It should return data that your parser can handle.

class NullConnection
  def initialize(*args)
  end

  def execute(query)
  end
end

class CustomConnectionResource < TestResource
  self.connection_class = NullConnection
end

Custom Parser

You can configure your API client to use a custom parser that implements the parse class method. It should return a JsonApiClient::ResultSet instance. You can use it by setting the parser attribute on your model:

class MyCustomParser
  def self.parse(klass, response)
    

Handling Validation Errors

User.create(name: "Bob", email_address: "invalid email")
=> false

user = User.new(name: "Bob", email_address: "invalid email")
user.save
=> false
user.errors
=> ["Email address is invalid"]

user = User.find(1)
user.update_attributes(email_address: "invalid email")
=> false
user.errors
=> ["Email address is invalid"]
user.email_address
=> "invalid email"

Nested Resources

You can force nested resource paths for your models by using a belongs_to association.

module MyApi
  class  < JsonApiClient::Resource
    belongs_to :user
  end
end

Custom Methods

You can create custom methods on both collections (class method) and members (instance methods).

module MyApi
  class User < JsonApiClient::Resource

    # GET /users/search.json
    custom_endpoint :search, on: :collection, request_method: :get

    # PUT /users/:id/verify.json
    custom_endpoint :verify, on: :member, request_method: :put
  end
end

In the above scenario, you can call the class method MyApi::User.search. The results will be parsed like any other query. If the response returns users, you will get back a ResultSet of MyApi::User instances.

You can also call the instance method verify on a MyApi::User instance.