Aptible::Gridiron

Ruby client for gridiron.aptible.com. The Gridiron server is built on top of HAL+JSON, and so this client is just a thin layer on top of the HyperResource gem.

Installation

Add the following lines to your application's Gemfile.

gem 'aptible-gridiron'

And then run bundle install.

Usage

First, get a token:

token = Aptible::Auth::Token.create(email: 'user0@example.com', password: 'password')

From here, you can interact with the Gridiron server however you wish:

gridiron = Aptible::Gridiron::Agent.new(token: token)
protocol = gridiron.protocols.first
protocol.procedures.count
# => 356
procedure = protocol.procedures.first
# => "Obtain and review IT acquisition policy and procedures..."
procedure.criteria.count
# => 1
criterion = procedure.criteria.first
criterion.name
# => "Policy Manual"

To work with organization-specific evidence (i.e., documents and events), you may pass :organization as a parameter in any initializer. For example:

organization = Aptible::Auth::Organization.all(token: token).first
gridiron = Aptible::Gridiron::Agent.new(token: token, organization: organization)
criterion = gridiron.protocols.first.procedures.first.criteria.first
criterion.documents.count
# => 1
document = criterion.create_document!(
  print_version: 'http://knowyourmeme.com/photos/11296-success'
)
document.print_version.href
# => "http://knowyourmeme.com/photos/11296-success"
document.expires_at
# => 2015-07-08 00:10:31 UTC

Configuration

Parameter	Description	Default
`root_url`	Root URL of the Gridiron server	`ENV['GRIDIRON_ROOT_URL']` or https://gridiron.aptible.com

To point the client at a different server (e.g., during development), add the following to your application's initializers (or set the GRIDIRON_ROOT_URL environment variable):

Aptible::Gridiron.configure do |config|
  config.root_url = 'http://some.other.url'
end

Contributing

Fork the project.
Commit your changes, with specs.
Ensure that your code passes specs (rake spec) and meets Aptible's Ruby style guide (rake rubocop).
Create a new pull request on GitHub.

Copyright and License

MIT License, see LICENSE for details.