pdrc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad88a28463c4f3146a5f822594932fb41baba97fa5e4e3f9c2894b40ba7d65b8
+  data.tar.gz: c0861d9d00e1e109beee2faf2b0bc029228a1326c6247efdb5a3a618caf00b80
+SHA512:
+  metadata.gz: 69fa2eae94c04370bacee17cd2e0d2011c099569e9c11cc705d43d0a40f03d7b19771666608a4f04b41467fcefb036cc2fee1f16bb8a2e1cea5024450fe2f12a
+  data.tar.gz: a42d91d8517b08e8bce03c4415e2e47c11c1d808d0fb134fb6604cbeac1950bdcc3bb317625f2a0f7e3c6a6b771f31d6c22ef46a3f11dac2bbfb94c62ffcf0e4

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp
+
+bin
+cache
+gems
+specifications
+Gemfile.lock
+.rvmrc

data/.ruby-gemset

@@ -0,0 +1 @@
+pdrc

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.3

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+sudo: false
+cache: bundler
+before_install:
+  - gem install bundler # -v 1.7.14 if a specific version is needed
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+  - 2.3.3

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased][unreleased]
+
+## [1.0.0] - 2018-07-21
+- Ported amro/gibbon over to use the Pagerduty API, including:
+  - Using an Authorization header instead of a token parameter
+  - Streamlining all datacenter-related URL componentry
+  - Removing Export API functionality
+  - Updating README to reflect new status
+
+[unreleased]: https://github.com/ltw/pdrc/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/ltw/pdrc/compare/...v1.0.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.2.0'
+  gem 'rubinius-developer_tools'
+end
+
+group :development, :test do
+  gem 'webmock', '~>1.24.0'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2017 Amro Mousa & Lucas Willett
+
+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.

data/README.markdown

@@ -0,0 +1,213 @@
+# pdrc
+
+pdrc is an API wrapper for Pagerduty's [REST API v2](https://v2.developer.pagerduty.com/docs/rest-api), based off amro's great MailChimp client [Gibbon](https://github.com/amro/gibbon).
+
+[![Build Status](https://secure.travis-ci.org/ltw/pdrc.svg)](http://travis-ci.org/ltw/pdrc)
+
+## Important Notes
+
+Please read Pagerduty's [Overview documentation](https://v2.developer.pagerduty.com/docs/rest-api).
+
+pdrc returns a `PDRC::Response` instead of the response body directly. `PDRC::Response` exposes the parsed response `body` and `headers`.
+
+## Installation
+
+    $ gem install pdrc
+
+## Requirements
+
+A Pagerduty account and a v2 API key. Only administrators can generate API keys.
+
+## Usage
+
+First, create a *one-time use instance* of `PDRC::Request`:
+
+```ruby
+pdrc = PDRC::Request.new(api_key: "your_api_key")
+```
+
+***Note*** Only reuse instances of pdrc after terminating a call with a verb, which makes a request. Requests are light weight objects that update an internal path based on your call chain. When you terminate a call chain with a verb, a request instance makes a request and resets the path.
+
+You can set an individual request's `timeout` and `open_timeout` like this:
+
+```ruby
+pdrc.timeout = 30
+pdrc.open_timeout = 30
+```
+
+You can read about `timeout` and `open_timeout` in the [Net::HTTP](https://ruby-doc.org/stdlib-2.3.3/libdoc/net/http/rdoc/Net/HTTP.html) doc.
+
+Now you can make requests using the resources defined in [Pagerduty's docs](https://v2.developer.pagerduty.com/v2/page/api-reference). Resource IDs are specified inline and a `CRUD` (`create`, `retrieve`, `update`, or `delete`) verb initiates the request.
+
+You can specify `headers`, `params`, and `body` when calling a `CRUD` method. For example:
+
+```ruby
+pdrc.teams.retrieve(headers: {"SomeHeader": "SomeHeaderValue"}, params: {"query_param": "query_param_value"})
+```
+
+Of course, `body` is only supported on `create` and `update` calls. Those map to HTTP `POST`, `PATCH`, and `PUT` verbs respectively.
+
+You can set `api_key`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, and `debug` globally:
+
+```ruby
+PDRC::Request.api_key = "your_api_key"
+PDRC::Request.timeout = 15
+PDRC::Request.open_timeout = 15
+PDRC::Request.symbolize_keys = true
+PDRC::Request.debug = false
+```
+
+For example, you could set the values above in an `initializer` file in your `Rails` app (e.g. your\_app/config/initializers/pdrc.rb).
+
+Assuming you've set an `api_key` on PDRC, you can conveniently make API calls on the class itself:
+
+```ruby
+PDRC::Request.teams.retrieve
+```
+
+You can also set the environment variable `PAGERDUTY_API_KEY` and PDRC will use it when you create an instance:
+
+```ruby
+pdrc = PDRC::Request.new
+```
+
+***Note*** Substitute an underscore if a resource name contains a hyphen.
+
+Pass `symbolize_keys: true` to use symbols (instead of strings) as hash keys in API responses.
+
+```ruby
+pdrc = PDRC::Request.new(api_key: "your_api_key", symbolize_keys: true)
+```
+
+Pagerduty's [REST API documentation](https://v2.developer.pagerduty.com/v2/page/api-reference) is a list of available resources.
+
+## Debug Logging
+
+Pass `debug: true` to enable debug logging to STDOUT.
+
+```ruby
+pdrc = PDRC::Request.new(api_key: "your_api_key", debug: true)
+```
+
+### Custom logger
+
+Ruby `Logger.new` is used by default, but it can be overrided using:
+
+```ruby
+pdrc = PDRC::Request.new(api_key: "your_api_key", debug: true, logger: MyLogger.new)
+```
+
+Logger can be also set by globally:
+
+```ruby
+PDRC::Request.logger = MyLogger.new
+```
+
+## Examples
+
+### Teams
+
+Fetch all teams:
+
+```ruby
+pdrc.teams.retrieve
+```
+
+Retrieving a specific team looks like:
+
+```ruby
+pdrc.teams(team_id).retrieve
+```
+
+Create a team:
+
+```ruby
+pdrc.teams.create(body: {team: { type: "team", name: "Engineering", description: "The engineering team"}})
+```
+
+You can also delete a team:
+
+```ruby
+pdrc.teams(team_id).delete
+```
+
+### Schedules
+
+Get all schedules:
+
+```ruby
+pdrc.schedules.retrieve(params: {"query": "Primary"})
+```
+
+By default the Pagerduty API returns 25 results. To set the count to 50 (Note: it cannot exceed 100):
+
+```ruby
+pdrc.schedules.retrieve(params: {"limit": "50"})
+```
+
+And to retrieve the next 50 schedules:
+
+```ruby
+pdrc.schedules.retrieve(params: {"limit": "50", "offset": "50"})
+```
+
+And to retrieve only the schedules with the title containing "Primary":
+
+```ruby
+pdrc.schedules.retrieve(params: {"limit": "50", "offset": "50", "query": "Primary"})
+```
+
+Get a list of overrides for a schedule:
+
+```ruby
+pdrc.schedules(schedule_id).overrides.retrieve
+```
+
+Or to list users on-call for a schedule:
+
+```ruby
+pdrc.schedules(schedule_id).users.retrieve
+```
+
+To narrow the range of on-call users down to a specific date range:
+
+```ruby
+pdrc.schedules(schedule_id).users.retrieve(params: {"since": "2018-06-01T00:00:00Z", "until": "2018-09-01T00:00:00Z"})
+```
+
+### Error handling
+
+PDRC raises an error when the API returns an error.
+
+`PDRC::PagerdutyError` has the following attributes: `title`, `detail`, `body`, `raw_body`, `status_code`. Some or all of these may not be
+available depending on the nature of the error. For example:
+
+```ruby
+begin
+  pdrc.teams(team_id).create(body: body)
+rescue PDRC::PagerdutyError => e
+  puts "Houston, we have a problem: #{e.message} - #{e.raw_body}"
+end
+```
+
+### Other
+
+You can set an optional proxy url like this (or with an environment variable MAILCHIMP_PROXY):
+
+```ruby
+pdrc.proxy = 'http://your_proxy.com:80'
+```
+
+You can set a different [Faraday adapter](https://github.com/lostisland/faraday) during initialization:
+
+```ruby
+pdrc = PDRC::Request.new(api_key: "your_api_key", faraday_adapter: :net_http)
+```
+
+## Thanks
+
+Thanks to everyone who has [contributed](https://github.com/amro/gibbon/contributors) to Gibbon's development which has been so integral to PDRC's development.
+
+## Copyright
+
+* Copyright (c) 2010-2018 Amro Mousa & Lucas Willett. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rspec/core/rake_task'
+require 'rubygems/specification'
+require 'bundler/gem_tasks'
+
+task :default => :spec
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(-fd --color)
+end

data/lib/pdrc.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'multi_json'
+require 'cgi'
+require 'logger'
+
+require 'pdrc/pdrc_error'
+require 'pdrc/pagerduty_error'
+require 'pdrc/request'
+require 'pdrc/api_request'
+require 'pdrc/response'
+
+module PDRC
+end

data/lib/pdrc/api_request.rb

@@ -0,0 +1,189 @@
+module PDRC
+  class APIRequest
+    def initialize(builder: nil)
+      @request_builder = builder
+    end
+
+    def post(params: nil, headers: nil, body: nil)
+      validate_api_key
+
+      begin
+        response = self.rest_client.post do |request|
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    def patch(params: nil, headers: nil, body: nil)
+      validate_api_key
+
+      begin
+        response = self.rest_client.patch do |request|
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    def put(params: nil, headers: nil, body: nil)
+      validate_api_key
+
+      begin
+        response = self.rest_client.put do |request|
+          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    def get(params: nil, headers: nil)
+      validate_api_key
+
+      begin
+        response = self.rest_client.get do |request|
+          configure_request(request: request, params: params, headers: headers)
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    def delete(params: nil, headers: nil)
+      validate_api_key
+
+      begin
+        response = self.rest_client.delete do |request|
+          configure_request(request: request, params: params, headers: headers)
+        end
+        parse_response(response)
+      rescue => e
+        handle_error(e)
+      end
+    end
+
+    protected
+
+    # Convenience accessors
+
+    def api_key
+      @request_builder.api_key
+    end
+
+    def api_endpoint
+      @request_builder.api_endpoint
+    end
+
+    def timeout
+      @request_builder.timeout
+    end
+
+    def open_timeout
+      @request_builder.open_timeout
+    end
+
+    def proxy
+      @request_builder.proxy
+    end
+
+    def adapter
+      @request_builder.faraday_adapter
+    end
+
+    def symbolize_keys
+      @request_builder.symbolize_keys
+    end
+
+    # Helpers
+
+    def handle_error(error)
+      error_params = {}
+
+      begin
+        if error.is_a?(Faraday::Error::ClientError) && error.response
+          error_params[:status_code] = error.response[:status]
+          error_params[:raw_body] = error.response[:body]
+
+          parsed_response = MultiJson.load(error.response[:body], symbolize_keys: symbolize_keys)
+
+          if parsed_response
+            error_params[:body] = parsed_response
+
+            title_key = symbolize_keys ? :title : "title"
+            detail_key = symbolize_keys ? :detail : "detail"
+
+            error_params[:title] = parsed_response[title_key] if parsed_response[title_key]
+            error_params[:detail] = parsed_response[detail_key] if parsed_response[detail_key]
+          end
+
+        end
+      rescue MultiJson::ParseError
+      end
+
+      error_to_raise = PagerdutyError.new(error.message, error_params)
+
+      raise error_to_raise
+    end
+
+    def configure_request(request: nil, params: nil, headers: nil, body: nil)
+      if request
+        request.params.merge!(params) if params
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['Accept'] = 'application/vnd.pagerduty+json;version=2'
+        request.headers.merge!(headers) if headers
+        request.body = body if body
+        request.options.timeout = self.timeout
+        request.options.open_timeout = self.open_timeout
+      end
+    end
+
+    def rest_client
+      client = Faraday.new(self.api_url, proxy: self.proxy, ssl: { version: "TLSv1_2" }) do |faraday|
+        faraday.response :raise_error
+        faraday.adapter adapter
+        if @request_builder.debug
+          faraday.response :logger, @request_builder.logger, bodies: true
+        end
+      end
+      client.authorization(:Token, token: self.api_key)
+      client
+    end
+
+    def parse_response(response)
+      parsed_response = nil
+
+      if response.body && !response.body.empty?
+        begin
+          headers = response.headers
+          body = MultiJson.load(response.body, symbolize_keys: symbolize_keys)
+          parsed_response = Response.new(headers: headers, body: body)
+        rescue MultiJson::ParseError
+          error_params = { title: "UNPARSEABLE_RESPONSE", status_code: 500 }
+          error = PagerdutyError.new("Unparseable response: #{response.body}", error_params)
+          raise error
+        end
+      end
+
+      parsed_response
+    end
+
+    def validate_api_key
+      raise PDRC::PDRCError, "You must set an api_key prior to making a call" unless self.api_key
+    end
+
+    def api_url
+      base_api_url + @request_builder.path
+    end
+
+    def base_api_url
+      "https://api.pagerduty.com/"
+    end
+  end
+end

data/lib/pdrc/pagerduty_error.rb

@@ -0,0 +1,29 @@
+module PDRC
+  class PagerdutyError < StandardError
+    attr_reader :title, :detail, :body, :raw_body, :status_code
+
+    def initialize(message = "", params = {})
+      @title       = params[:title]
+      @detail      = params[:detail]
+      @body        = params[:body]
+      @raw_body    = params[:raw_body]
+      @status_code = params[:status_code]
+
+      super(message)
+    end
+
+    def to_s
+      super + " " + instance_variables_to_s
+    end
+
+    private
+
+    def instance_variables_to_s
+      [:title, :detail, :body, :raw_body, :status_code].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end.join(", ")
+    end
+  end
+end

data/lib/pdrc/pdrc_error.rb

@@ -0,0 +1,3 @@
+module PDRC
+  class PDRCError < StandardError; end
+end

data/lib/pdrc/request.rb

@@ -0,0 +1,87 @@
+module PDRC
+  class Request
+    attr_accessor :api_key, :api_endpoint, :timeout, :open_timeout, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
+
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_OPEN_TIMEOUT = 60
+
+    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil)
+      @path_parts = []
+      @api_key = api_key || self.class.api_key || ENV['PAGERDUTY_API_KEY']
+      @api_key = @api_key.strip if @api_key
+      @api_endpoint = api_endpoint || self.class.api_endpoint
+      @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
+      @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
+      @proxy = proxy || self.class.proxy || ENV['PAGERDUTY_PROXY']
+      @faraday_adapter = faraday_adapter || Faraday.default_adapter
+      @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
+      @debug = debug || self.class.debug || false
+      @logger = logger || self.class.logger || ::Logger.new(STDOUT)
+    end
+
+    def method_missing(method, *args)
+      @path_parts << method.to_s.downcase
+      @path_parts << args if args.length > 0
+      @path_parts.flatten!
+      self
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+
+    def send(*args)
+      if args.length == 0
+        method_missing(:send, args)
+      else
+        __send__(*args)
+      end
+    end
+
+    def path
+      @path_parts.join('/')
+    end
+
+    def create(params: nil, headers: nil, body: nil)
+      APIRequest.new(builder: self).post(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def update(params: nil, headers: nil, body: nil)
+      APIRequest.new(builder: self).patch(params: params, headers: headers, body: body)
+    ensure
+      reset
+    end
+
+    def retrieve(params: nil, headers: nil)
+      APIRequest.new(builder: self).get(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    def delete(params: nil, headers: nil)
+      APIRequest.new(builder: self).delete(params: params, headers: headers)
+    ensure
+      reset
+    end
+
+    protected
+
+    def reset
+      @path_parts = []
+    end
+
+    class << self
+      attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
+
+      def method_missing(sym, *args, &block)
+        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
+    end
+  end
+end

data/lib/pdrc/response.rb

@@ -0,0 +1,10 @@
+module PDRC
+  class Response
+    attr_accessor :body, :headers
+
+    def initialize(body: {}, headers: {})
+      @body = body
+      @headers = headers
+    end
+  end
+end

data/lib/pdrc/version.rb

@@ -0,0 +1,3 @@
+module PDRC
+  VERSION = "1.0.0"
+end

data/pdrc.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'pdrc/version'
+
+Gem::Specification.new do |s|
+  s.name        = "pdrc"
+  s.version     = PDRC::VERSION
+  s.authors     = ["Lucas Willett", "Amro Mousa"]
+  s.email       = ["me@ltw.io", "amromousa@gmail.com"]
+  s.homepage    = "http://github.com/ltw/pdrc"
+
+  s.summary     = %q{A wrapper for the Pagerduty REST API v2}
+  s.description = %q{A wrapper for the Pagerduty REST API v2}
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_dependency('faraday', '>= 0.9.1')
+  s.add_dependency('multi_json', '>= 1.11.0')
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency "rspec", "3.7.0"
+  s.add_development_dependency 'webmock', '~> 1.21.0'
+end

data/spec/pdrc/api_request_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+describe PDRC::APIRequest do
+  it 'raises a PDRC::PDRCError if an API key is not specified' do
+    @pdrc = PDRC::Request.new
+    expect { @pdrc.teams.retrieve }.to raise_error(PDRC::PDRCError)
+  end
+
+  context 'with an API key' do
+    let(:api_key) { "XFZ8MisS7d9IytnVniqS" }
+
+    before do
+      @pdrc = PDRC::Request.new(api_key: api_key)
+      @api_root = "https://api.pagerduty.com"
+    end
+
+    it "surfaces client request exceptions as a PDRC::PagerdutyError" do
+      exception = Faraday::Error::ClientError.new("the server responded with status 503")
+      stub_request(:get, "#{@api_root}/teams").to_raise(exception)
+      expect { @pdrc.teams.retrieve }.to raise_error(PDRC::PagerdutyError)
+    end
+
+    it "surfaces an unparseable response body as a PDRC::PagerdutyError" do
+      response_values = {:status => 503, :headers => {}, :body => '[foo]'}
+      exception = Faraday::Error::ClientError.new("the server responded with status 503", response_values)
+
+      stub_request(:get, "#{@api_root}/teams").to_raise(exception)
+      expect { @pdrc.teams.retrieve }.to raise_error(PDRC::PagerdutyError)
+    end
+
+    context 'parse_response' do
+      it 'raises a PagerdutyError when the response is successful but contains an unparseable response body' do
+      end
+    end
+
+    context "handle_error" do
+      it "includes status and raw body even when json can't be parsed" do
+        response_values = {:status => 503, :headers => {}, :body => 'A non JSON response'}
+        exception = Faraday::Error::ClientError.new("the server responded with status 503", response_values)
+        api_request = PDRC::APIRequest.new(builder: PDRC::Request)
+        begin
+          api_request.send(:handle_error, exception)
+        rescue => boom
+          expect(boom.status_code).to eq 503
+          expect(boom.raw_body).to eq "A non JSON response"
+        end
+      end
+
+      context "when symbolize_keys is true" do
+        it "sets title and detail on the error params" do
+          response_values = {:status => 422, :headers => {}, :body => '{"title": "foo", "detail": "bar"}'}
+          exception = Faraday::Error::ClientError.new("the server responded with status 422", response_values)
+          api_request = PDRC::APIRequest.new(builder: PDRC::Request.new(symbolize_keys: true))
+          begin
+            api_request.send(:handle_error, exception)
+          rescue => boom
+            expect(boom.title).to eq "foo"
+            expect(boom.detail).to eq "bar"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pdrc/pagerduty_error_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe PDRC::PagerdutyError do
+  let(:message) { 'Foo' }
+  let(:params) do
+    {
+      title: 'error_title',
+      detail: 'error_detail',
+      body: 'error_body',
+      raw_body: 'error_raw_body',
+      status_code: 'error_status_code'
+    }
+  end
+
+  before do
+    @pdrc = PDRC::PagerdutyError.new(message, params)
+  end
+
+  it "adds the error params to the error message" do
+    expected_message = "Foo "                               \
+                       "@title=\"error_title\", "           \
+                       "@detail=\"error_detail\", "         \
+                       "@body=\"error_body\", "             \
+                       "@raw_body=\"error_raw_body\", "     \
+                       "@status_code=\"error_status_code\""
+
+    expect(@pdrc.message).to eq(expected_message)
+  end
+
+  it 'sets the title attribute' do
+    expect(@pdrc.title).to eq(params[:title])
+  end
+
+  it 'sets the detail attribute' do
+    expect(@pdrc.detail).to eq(params[:detail])
+  end
+
+  it 'sets the body attribute' do
+    expect(@pdrc.body).to eq(params[:body])
+  end
+
+  it 'sets the raw_body attribute' do
+    expect(@pdrc.raw_body).to eq(params[:raw_body])
+  end
+
+  it 'sets the status_code attribute' do
+    expect(@pdrc.status_code).to eq(params[:status_code])
+  end
+end

data/spec/pdrc/pdrc_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+require 'cgi'
+
+describe PDRC do
+  describe "attributes" do
+    before do
+      PDRC::APIRequest.send(:public, *PDRC::APIRequest.protected_instance_methods)
+
+      @api_key = "y_NbAkKc66ryYTWUXYEu"
+      @proxy = 'the_proxy'
+    end
+
+    it "have no API by default" do
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.api_key).to be_nil
+    end
+    it "sets an API key in the constructor" do
+      @pdrc = PDRC::Request.new(api_key: @api_key)
+      expect(@pdrc.api_key).to eq(@api_key)
+    end
+
+    it "sets an API key from the 'PAGERDUTY_API_KEY' ENV variable" do
+      ENV['PAGERDUTY_API_KEY'] = @api_key
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.api_key).to eq(@api_key)
+      ENV.delete('PAGERDUTY_API_KEY')
+    end
+
+    it "sets an API key via setter" do
+      @pdrc = PDRC::Request.new
+      @pdrc.api_key = @api_key
+      expect(@pdrc.api_key).to eq(@api_key)
+    end
+
+    it "sets timeout and get" do
+      @pdrc = PDRC::Request.new
+      timeout = 30
+      @pdrc.timeout = timeout
+      expect(timeout).to eq(@pdrc.timeout)
+    end
+
+    it "sets the open_timeout and get" do
+      @pdrc = PDRC::Request.new
+      open_timeout = 30
+      @pdrc.open_timeout = open_timeout
+      expect(open_timeout).to eq(@pdrc.open_timeout)
+    end
+
+    it "timeout properly passed to APIRequest" do
+      @pdrc = PDRC::Request.new
+      timeout = 30
+      @pdrc.timeout = timeout
+      @request = PDRC::APIRequest.new(builder: @pdrc)
+      expect(timeout).to eq(@request.timeout)
+    end
+
+    it "timeout properly based on open_timeout passed to APIRequest" do
+      @pdrc = PDRC::Request.new
+      open_timeout = 30
+      @pdrc.open_timeout = open_timeout
+      @request = PDRC::APIRequest.new(builder: @pdrc)
+      expect(open_timeout).to eq(@request.open_timeout)
+    end
+
+    it "detect api endpoint from initializer parameters" do
+      api_endpoint = 'https://api.pagerduty.com'
+      @pdrc = PDRC::Request.new(api_key: @api_key, api_endpoint: api_endpoint)
+      expect(api_endpoint).to eq(@pdrc.api_endpoint)
+    end
+
+    it "has no Proxy url by default" do
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.proxy).to be_nil
+    end
+
+    it "sets an proxy url key from the 'PAGERDUTY_PROXY_URL' ENV variable" do
+      ENV['PAGERDUTY_PROXY'] = @proxy
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.proxy).to eq(@proxy)
+      ENV.delete('PAGERDUTY_PROXY')
+    end
+
+    it "sets an API key via setter" do
+      @pdrc = PDRC::Request.new
+      @pdrc.proxy = @proxy
+      expect(@pdrc.proxy).to eq(@proxy)
+    end
+
+    it "sets an adapter in the constructor" do
+      adapter = :em_synchrony
+      @pdrc = PDRC::Request.new(faraday_adapter: adapter)
+      expect(@pdrc.faraday_adapter).to eq(adapter)
+    end
+
+    it "symbolize_keys false by default" do
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.symbolize_keys).to be false
+    end
+
+    it "sets symbolize_keys in the constructor" do
+      @pdrc = PDRC::Request.new(symbolize_keys: true)
+      expect(@pdrc.symbolize_keys).to be true
+    end
+
+    it "sets symbolize_keys in the constructor" do
+      @pdrc = PDRC::Request.new(symbolize_keys: true)
+      expect(@pdrc.symbolize_keys).to be true
+    end
+    it "debug false by default" do
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.debug).to be false
+    end
+
+    it "sets debug in the constructor" do
+      @pdrc = PDRC::Request.new(debug: true)
+      expect(@pdrc.debug).to be true
+    end
+
+    it "sets logger in constructor" do
+      logger = double(:logger)
+      @pdrc = PDRC::Request.new(logger: logger)
+      expect(@pdrc.logger).to eq(logger)
+    end
+
+    it "is a Logger instance by default" do
+      @pdrc = PDRC::Request.new
+      expect(@pdrc.logger).to be_a Logger
+    end
+
+  end
+
+  describe "class variables" do
+    let(:logger) { double(:logger) }
+
+    before do
+      PDRC::Request.api_key = "XFZ8MisS7d9IytnVniqS"
+      PDRC::Request.timeout = 15
+      PDRC::Request.api_endpoint = 'https://api.pagerduty.com'
+      PDRC::Request.logger = logger
+      PDRC::Request.proxy = "http://1234.com"
+      PDRC::Request.symbolize_keys = true
+      PDRC::Request.faraday_adapter = :net_http
+      PDRC::Request.debug = true
+    end
+
+    after do
+      PDRC::Request.api_key = nil
+      PDRC::Request.timeout = nil
+      PDRC::Request.api_endpoint = nil
+      PDRC::Request.logger = nil
+      PDRC::Request.proxy = nil
+      PDRC::Request.symbolize_keys = nil
+      PDRC::Request.faraday_adapter = nil
+      PDRC::Request.debug = nil
+    end
+
+    it "set api key on new instances" do
+      expect(PDRC::Request.new.api_key).to eq(PDRC::Request.api_key)
+    end
+
+    it "set timeout on new instances" do
+      expect(PDRC::Request.new.timeout).to eq(PDRC::Request.timeout)
+    end
+
+    it "set api_endpoint on new instances" do
+      expect(PDRC::Request.api_endpoint).not_to be_nil
+      expect(PDRC::Request.new.api_endpoint).to eq(PDRC::Request.api_endpoint)
+    end
+
+    it "set proxy on new instances" do
+      expect(PDRC::Request.new.proxy).to eq(PDRC::Request.proxy)
+    end
+
+    it "set symbolize_keys on new instances" do
+      expect(PDRC::Request.new.symbolize_keys).to eq(PDRC::Request.symbolize_keys)
+    end
+
+    it "set debug on new instances" do
+      expect(PDRC::Request.new.debug).to eq(PDRC::Request.debug)
+    end
+
+    it "set faraday_adapter on new instances" do
+      expect(PDRC::Request.new.faraday_adapter).to eq(PDRC::Request.faraday_adapter)
+    end
+
+    it "set logger on new instances" do
+      expect(PDRC::Request.new.logger).to eq(logger)
+    end
+  end
+
+  describe "missing methods" do
+    it "respond to .method call on class" do
+      expect(PDRC::Request.method(:teams)).to be_a(Method)
+    end
+    it "respond to .method call on instance" do
+      expect(PDRC::Request.new.method(:teams)).to be_a(Method)
+    end
+  end
+
+  describe 'path building using method missing invocations' do
+    it 'constructs a path' do
+      expect(PDRC::Request.teams.path).to eq "teams"
+    end
+
+    it 'expands the paths over multiple invocations' do
+      expect(PDRC::Request.teams.users.path).to eq "teams/users"
+    end
+
+    it 'includes ids passed in as arguments' do
+      expect(PDRC::Request.teams("1234MYTEAM").path).to eq "teams/1234MYTEAM"
+    end
+
+    it 'expands multiple paths with arguments' do
+      expect(PDRC::Request.teams("1234-team").users("4321").path).to eq "teams/1234-team/users/4321"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :development)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pdrc'
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: pdrc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Willett
+- Amro Mousa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+description: A wrapper for the Pagerduty REST API v2
+email:
+- me@ltw.io
+- amromousa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/pdrc.rb
+- lib/pdrc/api_request.rb
+- lib/pdrc/pagerduty_error.rb
+- lib/pdrc/pdrc_error.rb
+- lib/pdrc/request.rb
+- lib/pdrc/response.rb
+- lib/pdrc/version.rb
+- pdrc.gemspec
+- spec/pdrc/api_request_spec.rb
+- spec/pdrc/pagerduty_error_spec.rb
+- spec/pdrc/pdrc_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ltw/pdrc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A wrapper for the Pagerduty REST API v2
+test_files: []