PagerDuty

Ruby client for v2 of the PagerDuty API

Table of Contents

1. Philosophy
2. Quick start
3. Making requests
4. Consuming resources
5. Authentication
   1. API tokens
6. Configuration and defaults
   1. Configuring module defaults
   2. Using ENV variables
7. Advanced usage
   1. Debugging
   2. Caching
8. Hacking on PagerDuty
   1. Running and writing new tests
9. Supported Ruby Versions
10. Versioning
11. License

Philosophy

This gem borrows liberally from the design philosophy of the wonderful octokit library. Most methods have positional arguments for required input and an options hash for optional parameters, headers, or other options:

Quick start

Install via Rubygems

gem install pager_duty

... or add to your Gemfile

gem "pager_duty", "~> 0.1"

Making requests

API methods are available as module methods (consuming module-level configuration) or as client instance methods.

# Provide authentication credentials
PagerDuty.configure do |c|
  c.api_token = "XXXXXXXX"
end

# Fetch the current user
PagerDuty.abilities

or

# Provide authentication credentials
client = PagerDuty::Client.new(api_token: "XXXXXXXX")
# Fetch the current user
client.abilities

Consuming resources

Most methods return a Resource object which provides dot notation and [] access for fields returned in the API response.

# Fetch a user
addon = PagerDuty.addon("P5R5GQ4")
puts addon.name
# => "Great Addon"
puts addon.fields
# => <Set: {:id, :type, :summary, :self, :html_url, :name, :src, :services}>
puts addon[:type]
# => "full_page_addon"

Authentication

PagerDuty supports the API token method for authentication:

API Tokens

API tokens can be revoked, removing access for only that token without having to change your password everywhere.

To use an access token with the PagerDuty client, pass your token in the :access_token options parameter:

client = PagerDuty::Client.new(:access_token => "<your token>")

You can create access tokens through your Account Settings which are typically at https://YOURSUBDOMAIN.pagerduty.com/api_keys

Using ENV variables

Default configuration values are specified in {PagerDuty::Default}. Many attributes will look for a default value from the ENV before returning PagerDuty's default.

# Given $PAGERDUTY_API_ENDPOINT is "http://api.pagerduty.dev"
PagerDuty.api_endpoint

# => "http://api.pagerduty.dev"

Advanced usage

Since PagerDuty employs Faraday under the hood, some behavior can be extended via middleware.

Debugging

Often, it helps to know what PagerDuty is doing under the hood. You can add a logger to the middleware that enables you to peek into the underlying HTTP traffic:

stack = Faraday::RackBuilder.new do |builder|
  builder.response :logger
  builder.use PagerDuty::Response::RaiseError
  builder.adapter Faraday.default_adapter
end
PagerDuty.middleware = stack
PagerDuty.abilities

I, [2017-05-22T12:47:16.335959 #79147]  INFO -- : GET https://api.pagerduty.com/abilities
D, [2017-05-22T12:47:16.336026 #79147] DEBUG -- : "Accept: application/vnd.pagerduty+json;version=2
User-Agent: PagerDuty Ruby Gem 0.1.0
Content-Type: application/json
Authorization: Token token=\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\""
I, [2017-05-22T12:47:16.350493 #79147]  INFO -- : HTTP 200
D, [2017-05-22T12:47:16.350568 #79147] DEBUG -- : "server: nginx
date: Fri, 19 May 2017 14:02:40 GMT
content-type: application/json; charset=utf-8
transfer-encoding: chunked
connection: keep-alive
status: 200 OK
access-control-allow-methods: GET, POST, PUT, DELETE, OPTIONS
access-control-max-age: 1728000
access-control-allow-origin: *
access-control-allow-headers: Authorization, Content-Type
x-ua-compatible: IE=Edge,chrome=1
etag: W/\"0da61ef0d8a5571c22d819a5ed89665e\"
cache-control: max-age=0, private, must-revalidate
x-request-id: 5f125e02489796ac002cf0f7a321fe88

{\"abilities\":[\"sso\",\"advanced_reports\",\"teams\",\"read_only_users\",\"team_responders\",\"service_support_hours\",\"urgencies\",\"manage_schedules\",\"manage_api_keys\",\"coordinated_responding\",\"event_rules\",\"beta_custom_actions\",\"coordinated_responding_preview\",\"preview_incident_alert_split\",\"permissions_service\",\"on_call_selfie\",\"features_in_use_preventing_downgrade_to\",\"feature_to_plan_map\"]}"
...

See the Faraday README for more middleware magic.

Caching

If you want to boost performance, stretch your API rate limit, or avoid paying the hypermedia tax, you can use Faraday Http Cache.

Add the gem to your Gemfile

gem 'faraday-http-cache'

Next, construct your own Faraday middleware:

stack = Faraday::RackBuilder.new do |builder|
  builder.use Faraday::HttpCache, serializer: Marshal, shared_cache: false
  builder.use PagerDuty::Response::RaiseError
  builder.adapter Faraday.default_adapter
end
PagerDuty.middleware = stack

Once configured, the middleware will store responses in cache based on ETag fingerprint and serve those back up for future 304 responses for the same resource. See the project README for advanced usage.

Hacking on PagerDuty

If you want to hack on PagerDuty locally, we try to make bootstrapping the project as painless as possible. To start hacking, clone and run:

script/bootstrap

This will install project dependencies and get you up and running. If you want to run a Ruby console to poke on PagerDuty, you can crank one up with:

script/console

Using the scripts in ./scripts instead of bundle exec rspec, bundle console, etc. ensures your dependencies are up-to-date.

Running and writing new tests

PagerDuty uses VCR for recording and playing back API fixtures during test runs. These cassettes (fixtures) are part of the Git project in the spec/cassettes folder. If you're not recording new cassettes you can run the specs with existing cassettes with:

script/test

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

• Ruby 2.3
• Ruby 2.4

If something doesn't work on one of these Ruby versions, it's a bug.

This library may inadvertently work (or seem to work) on other Ruby implementations, but support will only be provided for the versions listed above.

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions. As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision. For example:

spec.add_dependency 'pager_duty', '~> 3.0'

The changes made between versions can be seen on the project releases page.

License

Copyright (c) 2017 Patrick Veverka

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.