voog.rb

Ruby toolkit for the Voog API.

Learn more at the Voog developer central and by reading the Voog API documentation.

Getting started

Either add this line to your application's Gemfile:

gem 'voog_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install voog_api

API token

To generate your personal API token for your site, go to Account -> My profile and click on "Generate new API token".

Initializing the client

All requests to the Voog API are done through the Voog::Client class, which takes two parameters: site host and API token.

client = Voog::Client.new('example.com', 'afcf30182aecfc8155d390d7d4552d14', protocol: :http, auto_paginate: true, raise_on_error: false)

Making an API request is as simple as calling a single method on the client:

client.layouts

Most responses from the client are Response objects that provide access to the API resource objects by using both dot and hash notation:

layout = client.layout(1)

puts layout.title
# => "Front page"

puts layout[:title]
# => "Front page"

Optional parameters for client

• protocol - endpoint protocol (http or https default is http).
• auto_paginate - enable auto pagination for list requests. Defaults to false.
• per_page - set default per_page value for list requests. Defaults to nil (API default is 50).
• raise_on_error - interrupts program with error (Faraday::Error) when request response code is between 400 and 600 (default is false).