Sha256: 9f54b1c8a5314a11c3dbe7cd678996a7ce82a2d471815daa3a7c585c603f4cbb
Contents?: true
Size: 1.82 KB
Versions: 8
Compression:
Stored size: 1.82 KB
Contents
# nationbuilder-rb
[](https://travis-ci.org/3dna/nationbuilder-rb)
A Ruby client for the NationBuilder API.
## Installing
To install this gem to your current gemset, run:
```shell
$ gem install nationbuilder-rb
```
Or, add this to your gemfile:
```ruby
gem 'nationbuilder-rb'
```
## Creating a client
Require the gem:
```ruby
require 'nationbuilder'
```
Then, create a client by specifying the name of your nation and
your API token:
```ruby
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
```ruby
client.call(:people, :show, id: 15)
```
### Creating a person
```ruby
params = {
person: {
email: "bob@example.com",
last_name: "Smith",
first_name: "Bob"
}
}
client.call(:people, :create, params)
```
### Destroying a person
```ruby
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:
```shell
$ nbdoc ENDPOINT_NAME
```
To see all documentation, don't provide a endpoint name:
```shell
$ 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
...
```
Version data entries
8 entries across 8 versions & 1 rubygems