pager_duty 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b9212305568b334fa041afcf98f3a1aef6f8102
-  data.tar.gz: 99f4a5c409cde8f9a072f361bfadd1eb46819563
+  metadata.gz: f5c7e9d697088cf476aa25e0e7c82f645b25b6f0
+  data.tar.gz: 6b294a232570d2537433ee9059f58362c66799d6
 SHA512:
-  metadata.gz: f83fd1ddb820962e438dc32a77077444a2fa5e22154df5772a5193693ca424408a898a681325944564b33134f41ae97cf317eb5238834b62722463d56da33bef
-  data.tar.gz: dd5640a3d2feef206d391ae69fcde9a4f51dba1644c7dcda30f06c8f9372b4295967b84769be8a7240468ccff0d4887de92e162068231a17537adba70b1047ed
+  metadata.gz: 81bc454c8fc420166338501b57c5d520026d1ce01e84bd56969c6a1705a0d53deebbd2b177c99e9582e005dfc98c06398a8e23bb08671b19a2450f6e98be6395
+  data.tar.gz: 29238ac01a3e4e194ecdeb5f2a179df9c0ea9cf05f0d6fdf01b3e01603f0b9314f1be9a1bdc442ca0f620b0f4d257bf73a256eeb2f4ea167ebeaaa9ddfef31c2

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+lib/pager_duty/client_gen

data/.travis.yml

@@ -1,5 +1,19 @@
-sudo: false
 language: ruby
+cache: bundler
+
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.14.6
+  - 2.3.3
+  - 2.4.0
+
+notifications:
+  email:
+    recipients:
+      - patrick.veverka@gmail.com
+    on_success: always # default: change
+    on_failure: always # default: always  
+
+sudo: false
+
+env:
+  global:
+    - TEST_API_TOKEN="y_NbAkKc66ryYTWUXYEu"

data/Guardfile

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+group :ruby do
+  guard :minitest do
+    # with Minitest::Unit
+    watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+    watch(%r{^test/.+_test\.rb$})
+    watch('test/test_helper.rb')  { "test" }
+    watch('test/test_helper_integration.rb')  { "test" }
+  end
+  
+end
+
+guard 'yard' do
+  watch(%r{lib\/.+\.rb})
+end

data/README.md

@@ -1,41 +1,282 @@
 # PagerDuty
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pager_duty`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/veverkap/pager_duty.svg?branch=master)](https://travis-ci.org/veverkap/pager_duty)
 
-TODO: Delete this and the text above, and describe your gem
+[![codebeat badge](https://codebeat.co/badges/da87a6f5-34c2-445f-8cc6-62343c5e6acc)](https://codebeat.co/projects/github-com-veverkap-pager_duty-master)
 
-## Installation
+Ruby client for v2 of the [PagerDuty API](https://v2.developer.pagerduty.com/v2/page/api-reference)
 
-Add this line to your application's Gemfile:
+## Table of Contents
+
+1. [Philosophy](#philosophy)
+2. [Quick start](#quick-start)
+3. [Making requests](#making-requests)
+4. [Consuming resources](#consuming-resources)
+6. [Authentication](#authentication)
+   1. [API tokens](#api-tokens)
+7. [Configuration and defaults](#configuration-and-defaults)
+    1. [Configuring module defaults](#configuring-module-defaults)
+    2. [Using ENV variables](#using-env-variables)
+8. [Advanced usage](#advanced-usage)
+    1. [Debugging](#debugging)
+    2. [Caching](#caching)
+9. [Hacking on PagerDuty](#hacking-on-pagerduty)
+    1. [Running and writing new tests](#running-and-writing-new-tests)
+10. [Supported Ruby Versions](#supported-ruby-versions)
+11. [Versioning](#versioning)
+12. [License](#license)
+
+## Philosophy
+
+This gem borrows liberally from the design philosophy of the 
+wonderful [octokit](https://github.com/octokit/octokit.rb) 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.
 
 ```ruby
-gem 'pager_duty'
+# Provide authentication credentials
+PagerDuty.configure do |c|
+  c.api_token = "XXXXXXXX"
+end
+
+# Fetch the current user
+PagerDuty.abilities
 ```
+or
 
-And then execute:
+```ruby
+# Provide authentication credentials
+client = PagerDuty::Client.new(api_token: "XXXXXXXX")
+# Fetch the current user
+client.abilities
+```
 
-    $ bundle
+[API methods]: http://veverkap.github.io/pager_duty/method_list.html
 
-Or install it yourself as:
+### Consuming resources
 
-    $ gem install pager_duty
+Most methods return a `Resource` object which provides dot notation and `[]`
+access for fields returned in the API response.
 
-## Usage
+```ruby
+# 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
 
-TODO: Write usage instructions here
+PagerDuty supports the API token method for authentication:
 
-## Development
+### API Tokens
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+API tokens can be revoked, removing access for only that token without having to change your password everywhere.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To use an access token with the PagerDuty client, pass your token in the `:access_token` options parameter:
 
-## Contributing
+```ruby
+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.
+
+```ruby
+# Given $PAGERDUTY_API_ENDPOINT is "http://api.pagerduty.dev"
+PagerDuty.api_endpoint
+
+# => "http://api.pagerduty.dev"
+```
+
+## Advanced usage
+
+Since PagerDuty employs [Faraday][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:
+
+```ruby
+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\"]}"
+...
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pager_duty. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+See the [Faraday README][faraday] 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][cache].
+
+Add the gem to your Gemfile
+
+    gem 'faraday-http-cache'
+
+Next, construct your own Faraday middleware:
+
+```ruby
+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][cache] for advanced usage.
+
+
+[cache]: https://github.com/plataformatec/faraday-http-cache
+[faraday]: https://github.com/lostisland/faraday
+
+## Hacking on PagerDuty
+
+If you want to hack on PagerDuty locally, we try to make [bootstrapping the
+project][bootstrapping] 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
+
+[bootstrapping]: http://wynnnetherland.com/linked/2013012801/bootstrapping-consistency
+[VCR]: https://github.com/vcr/vcr
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] 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.
+
+[travis]: https://travis-ci.org/veverkap/pager_duty
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. 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][pvc] 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][releases].
+
+[semver]: http://semver.org/
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[releases]: https://github.com/veverkap/pager_duty/releases
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+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.

data/fixtures/vcr_cassettes/abilities/index.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.pagerduty.com/abilities
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.pagerduty+json;version=2
+      User-Agent:
+      - PagerDuty Ruby Gem 0.1.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Token token="y_NbAkKc66ryYTWUXYEu"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      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
+    body:
+      encoding: ASCII-8BIT
+      string: '{"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"]}'
+    http_version: 
+  recorded_at: Fri, 19 May 2017 14:02:43 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/abilities/index_invalid.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.pagerduty.com/abilities
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.pagerduty+json;version=2
+      User-Agent:
+      - PagerDuty Ruby Gem 0.1.0
+      Content-Type:
+      - application/json
+      Authorization:
+      - Token token="y_NbAkKc66ryYTWUYzEu"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 22 May 2017 16:21:20 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 401 Unauthorized
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 9795a47c574d50138040d4c6e83b3e34
+    body:
+      encoding: UTF-8
+      string: " "
+    http_version: 
+  recorded_at: Mon, 22 May 2017 16:21:20 GMT
+recorded_with: VCR 3.0.3