Zaikio::Client::Helpers

A small gem which includes helpers for parsing & pagination when working with Zaikio APIs using the Spyke library. Parts of this are referenced in:

• Zaikio Hub Client
• Zaikio Procurement Client

1. Add to your gemspec or Gemfile:

spec.add_dependency "zaikio-client-helpers"

2. Require it when your code is loaded:

require "zaikio-client-helpers"

3. Extend the base class for your models:

class User < Zaikio::Client::Model
  # ...
end

Spyke needs a couple of extra things in addition to JSON parsing, so this library exposes a Spyke-compatible JSON parser that raises the correct exceptions when things go wrong:

Faraday.new do |f|
  f.use Zaikio::Client::Helpers::JSONParser
  ...
end

Note: if you're also using the pagination middleware below, you should set this middleware after the pagination middleware, because it needs to run before pagination can happen.

First, we need to configure the Faraday middleware, wherever the Faraday::Connection is constructed:

Faraday.new do |f|
  f.use Zaikio::Client::Helpers::Pagination::FaradayMiddleware
  f.use Zaikio::Client::Helpers::JSONParser
  ...
end

If you aren't inheriting Zaikio::Client::Model, you should mixin our pagination library like so: include Zaikio::Client::Helpers::Pagination.

The library works by overriding the #all method on a relation, so it will keep fetching pages from the remote API until there are none left:

Model.all.map(&:id)
#=> There are 3 pages, I will load more pages automatically
#=> [1,2,3]

If you wish to opt-out of automatic pagination, you can use the Lazy version (don't forget to call each or to_a to materialize the records):

Model.all.lazy.take(2).map(&:id).to_a

Note that if the endpoint doesn't support pagination (i.e. doesn't return a Current-Page header), pagination is automatically disabled.