nationbuilder-rb

A Ruby client for the NationBuilder API.

Installing

To install this gem to your current gemset, run:

$ gem install nationbuilder-rb

Or, add this to your gemfile:

gem 'nationbuilder-rb'

Creating a client

Require the gem:

require 'nationbuilder'

Then, create a client by specifying the name of your nation and your API token:

client = NationBuilder::Client.new('my_nation_name', 'my_api_token')

Calling the API

There is only a single method for calling the NationBuilder API in nationbuilder-rb, and that's the #call method on a client. The #call method takes three parameters: the name of the endpoint, the name of the method, and an optional hash containing arguments for the method.

Examples

Fetching a person

client.call(:people, :show, id: 15)

Creating a person

params = {
  person: {
    email: "bob@example.com",
    last_name: "Smith",
    first_name: "Bob"
  }
}

client.call(:people, :create, params)

Destroying a person

client.call(:people, :destroy, id: 15)

Documentation

This gem includes a command line utility that prints out all covered endpoints, methods, and parameters. To see documentation for a single endpoint, run:

$ nbdoc ENDPOINT_NAME

To see all documentation, don't provide a endpoint name:

$ nbdoc

Example

$ nbdoc basic_pages

=====================
Endpoint: basic_pages
=====================

  Method: index
  Description: Shows a list of the basic pages in the system
  Required parameters: site_slug

  Method: create
  Description: Creates a basic page for a site
  Required parameters: site_slug

...