Ruby API wrapper for the PagerDuty REST API
Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
pager_duty-connection.gemspec

README.md

PagerDuty::Connection

PagerDuty::Connection is a Ruby wrapper for the PagerDuty REST API

It has a few design goals:

  • be usable to someone familiar with Ruby
  • be usable to someone familiar with the PagerDuty REST API, or at least able to read the documentation
  • try to be future proof for API additions
  • try not to do too much magic, in order to support the above

In the end, this is what it does:

  • provides methods for each of the HTTP methods you can use on the API, that takes a path (like if you copied from the documentation), and a Hash of request parameters to send
  • provide a simpler way to do pagination (pass :page => to get), because using limit and offset using as described by the API is tedious in practice
  • converts time-like strings in responses to Time objects, since that is what most people will do anyways
  • converts time-like objects in requests to ISO 8601 strings, as this is documented as required by the API but is easy to forget and tedious to do anytime you use time parameters (ie since and until)
  • detect 404 errors, and raise them as PagerDuty::Connection::FileNotFoundError errors
  • detect API errors and raise them as PagerDuty::Connection::ApiError

And this is what it doesn't do:

  • provide first class objects for Incidents, Services, etc (they can change, and have new methods)
  • provide an a ActiveResource interface (ActiveResource libraries can be hard to build wrappers for. Also, it's not conducive to accessing multiple pagerduty accounts)
  • have methods for individual API calls that are possible (ie find_incident, list_users, etc)
  • provide will_paginate or kaminari paginated arrays (They aren't super documented for building a library that works well with them, and have different APIs)

Note: v1 of the Pager Duty REST API is no longer supported with this gem. Please either upgrade to v2 of the API (v2 Migration Documentation) or do not upgrade past version 0.2.0 of this gem.

Installation

Add this line to your application's Gemfile:

gem 'pager_duty-connection'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pager_duty-connection

Usage

Working code is worth a thousand words. The basics:

# setup the connection
pagerduty = PagerDuty::Connection.new(token, version)

# 4 main methods: `get`, `post`, `put`, and `delete`:

response = pagerduty.get('some/relative/path', params)
response = pagerduty.post('some/relative/path', params)
response = pagerduty.delete('some/relative/path', params)
response = pagerduty.put('some/relative/path', params)

# use something like irb or pry to poke around the responses
# the contents will vary a bit between call, ie:

response = pagerduty.get('incidents')
response.incidents # an array of incidents

response = pagerduty.get('incidents/YYZ')
response # the hash/object that represents the array

get, post, put, and delete all take a common parameter params. This parameter contains the query parameters, body, and custom headers needed to perform the request. Params is structured as follows:

params = {
  query_params: {
    param1: "ABCD",
    ids: [ "id1", "id2", "id3" ] # Faraday takes care of encoding the arrays to be `?ids[]=id1&ids[]=id2&ids[]=id3..`
  }, {
    body: { ... }, # Whatever needs to be sent in a `PUT` or `POST` request body
  }, {
    headers: {
      from: "testuser@test.com" # Some requests require a From header
    }
  }
}

For more advanced and realistic examples, check out the examples directory:

In general, you can get/put/post/delete a path, with some attributes. Use the REST API Documentation to get some ideas

If you are working in Rails, and using only a single PagerDuty account, you'll probably want an initializer:

$pagerduty = PagerDuty::Connection.new('your-subdomain', 'your-token')

And if you are using dotenv, you can use environment variables, and stash them in .env:

account = ENV['PAGERDUTY_ACCOUNT'] || raise("Missing ENV['PAGERDUTY_ACCOUNT'], add to .env")
token = ENV['PAGERDUTY_TOKEN'] || raise("Missing ENV['PAGERDUTY_TOKEN'], add to .env.#{Rails.env}")
$pagerduty = PagerDuty::Connection.new(account, token)

Questions and Answers

What about the pagerduty gem?

That is only for PagerDuty's Integration API, ie for triggering/acknowleding/resolinv incidents

What about the pagerduty-full gem?

It tries to be too clever and tightly models the API. For example, by having only Incident & Schedule classes, with specific methods for doing specific API calls, it means having to update the gem anytime new resources are added, and new API methods.

What about pagerduty_tools

That gem is less about being an API, and more about tools for being on call. Also, it took months for my pull request to be reviewed, so didn't give me a lot of hope for changes making it in.

Why not name it pagerduty-rest?

That would suggest a constant like Pagerduty::Rest, which I didn't like

Why not name it pagerduty-connection?

That would suggest a constant like Pagerduty::Connection, where the company is called PagerDuty.

Why the 'connection' thing?

It's an homage to faraday, which this library uses.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request