pager_duty-connection 0.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b49a8ad70aa198241f8afcb8371dd05a8712ddbd
-  data.tar.gz: 2289369bc4346458b5073f3f36c57a2499978bb5
+SHA256:
+  metadata.gz: 4c392576dc99307e392b659a3bcdc08a71e93b7a9d1e4d1c1f2d0d1757c78cec
+  data.tar.gz: 710475fc120cf3d3ae18f4eeaeebfbc78d878c80aacc612acbc72fc759405fe5
 SHA512:
-  metadata.gz: bfa193c9691bd50973c71827f66c811827b3f9353b3ff89bce0768bad2383e943a7328b75eb011b7920deac7a352fd89fa67f7a77733ea152ba63abd9ab62c83
-  data.tar.gz: ba0c41b2de447447e538b9ff8ea0c3c08bd0a338df34befc87baa0ad89013b71ad08b332e319634db9fc069b6fb538c12c5c36b88e3af91d48b5fab5f8bec0a5
+  metadata.gz: 22907cfe9371c5767c9341037a14a0df90e5d410faa2302973295a70a8a10d9453f565c3f5d10986d96976d11a6e0d59598e3a8035b2ef391ced4e2f5ef13722
+  data.tar.gz: f0e3c25d24760085ebdaa6dc0c3838e85cc7ead08a12e75e1aa113f8f2be0aa0a2de5e736348a5faf249339cb5cf0759fc5abc492062f287599d2030f0509767

data/README.md

@@ -25,6 +25,8 @@ And this is what it doesn't do:
 * have methods for individual API calls that are possible (ie `find_incident`, `list_users`, etc)
 * provide [will_paginate](https://github.com/mislav/will_paginate) or [kaminari](https://github.com/amatsuda/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)](https://v2.developer.pagerduty.com/docs/migrating-to-api-v2) or do not upgrade past version [0.2.0 of this gem](https://github.com/technicalpickles/pager_duty-connection/tree/v0.2.0).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -45,15 +47,18 @@ Or install it yourself as:
 Working code is worth a thousand words. The basics:
 
 ```ruby
-# setup the connection
-pagerduty = PagerDuty::Connection.new(account, token)
+# setup the connection with API token
+pagerduty = PagerDuty::Connection.new(token)
+
+# setup the connection with OAuth2 token
+pagerduty = PagerDuty::Connection.new(token, token_type: :Bearer)
 
-# 4 main methods: get, post, put, and delete:
+# 4 main methods: `get`, `post`, `put`, and `delete`:
 
-response = pagerduty.get('some/relative/path', :some => 'request', :parameter => 'to pass')
-response = pagerduty.post('some/relative/path', :some => 'request', :parameter => 'to pass')
-response = pagerduty.delete('some/relative/path', :some => 'request', :parameter => 'to pass')
-response = pagerduty.put('some/relative/path', :some => 'request', :parameter => 'to pass')
+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:
@@ -65,6 +70,25 @@ 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:
+
+```ruby
+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:
 
 * [shifts-with-incidents-and-log-entries](examples/shifts-with-incidents-and-log-entries.rb)
@@ -75,7 +99,7 @@ In general, you can get/put/post/delete a path, with some attributes. Use the [R
 If you are working in Rails, and using only a single PagerDuty account, you'll probably want an initializer:
 
 ```ruby
-$pagerduty = PagerDuty::Connection.new('your-subdomain', 'your-token')
+$pagerduty = PagerDuty::Connection.new('your-token')
 ```
 
 And if you are using [dotenv](https://github.com/bkeepers/dotenv), you can use environment variables, and stash them in .env:

data/examples/find-users.rb

@@ -1,17 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'pry'
 require 'dotenv'
 Dotenv.load ".env.development", '.env'
 
-account = ENV['PAGERDUTY_ACCOUNT'] || raise("Missing ENV['PAGERDUTY_ACCOUNT'], add to .env.development")
 token = ENV['PAGERDUTY_TOKEN'] || raise("Missing ENV['PAGERDUTY_TOKEN'], add to .env.development")
 
 require 'pager_duty/connection'
-$pagerduty = PagerDuty::Connection.new(account, token)
+$pagerduty = PagerDuty::Connection.new(token)
 
-# http://developer.pagerduty.com/documentation/rest/users/list
+# https://v2.developer.pagerduty.com/v2/page/api-reference#!/Users/get_users
 response = $pagerduty.get('users')
-response.users.each do |user|
-  puts "#{user.name}: #{user.email}"
+response['users'].each do |user|
+  puts "#{user['name']}: #{user['email']}"
 end

data/examples/shifts-with-incidents-and-log-entries.rb

@@ -3,11 +3,10 @@
 require 'dotenv'
 Dotenv.load ".env.development", '.env'
 
-account = ENV['PAGERDUTY_ACCOUNT'] || raise("Missing ENV['PAGERDUTY_ACCOUNT'], add to .env.development")
 token = ENV['PAGERDUTY_TOKEN'] || raise("Missing ENV['PAGERDUTY_TOKEN'], add to .env.development")
 
 require 'pager_duty/connection'
-$pagerduty = PagerDuty::Connection.new(account, token)
+$pagerduty = PagerDuty::Connection.new(token)
 
 schedule_id = ENV['PAGERDUTY_SCHEDULE_ID'] || raise("Missing ENV['PAGERDUTY_SCHEDULE_ID'], add to .env.development")
 
@@ -15,33 +14,33 @@ schedule_id = ENV['PAGERDUTY_SCHEDULE_ID'] || raise("Missing ENV['PAGERDUTY_SCHE
 time_since = 1.day.ago
 time_until = Time.now
 
-# http://developer.pagerduty.com/documentation/rest/schedules/entries
-response = $pagerduty.get("schedules/#{schedule_id}/entries", 'since' => time_since, 'until' => time_until, :overflow => true)
+# https://v2.developer.pagerduty.com/v2/page/api-reference#!/On-Calls/get_oncalls
+response = $pagerduty.get("oncalls", query_params: { since: time_since, until: time_until, schedule_ids: [schedule_id] })
 
-entries = response['entries'] # note, probably a bug, but response.entries doesn't do what you think it does
+entries = response['oncalls']
 
 entries.each do |entry|
-  puts "#{entry.start} - #{entry.end}: #{entry.user.name}"
+  puts "#{entry['start']} - #{entry['end']}: #{entry['user']['summary']}"
 
   # find incidents during that shift
-  # http://developer.pagerduty.com/documentation/rest/incidents/list
-  response = $pagerduty.get('incidents', :since => entry['start'], :until => entry['end'])
+  # https://v2.developer.pagerduty.com/v2/page/api-reference#!/Incidents/get_incidents
+  response = $pagerduty.get('incidents', query_params: { since: entry['start'], until: entry['end'], user_ids: [entry['user']['id']] })
 
-  response.incidents.each do |incident|
+  response['incidents'].each do |incident|
     puts "\t#{incident.id}"
 
     # find log entries (acknowledged, notifications, etc) for incident:
-    # http://developer.pagerduty.com/documentation/rest/log_entries/incident_log_entries
+    # https://v2.developer.pagerduty.com/v2/page/api-reference#!/Incidents/get_incidents_id_log_entries
     response = $pagerduty.get("incidents/#{incident.id}/log_entries")
 
     # select just the notes
-    notes = response.log_entries.select do |log_entry|
-      log_entry.channel && log_entry.channel.type == 'note'
+    notes = response['log_entries'].select do |log_entry|
+      log_entry['channel'] && log_entry['channel']['type'] == 'note'
     end
 
     # and print them out:
     notes.each do |log_entry|
-      puts "\t\t#{log_entry.channel.summary}"
+      puts "\t\t#{log_entry['channel']['summary']}"
     end
   end
 end

data/lib/pager_duty/connection.rb

@@ -8,7 +8,8 @@ module PagerDuty
 
   class Connection
     attr_accessor :connection
-    attr_accessor :api_version
+
+    API_VERSION = 2
 
     class FileNotFoundError < RuntimeError
     end
@@ -16,6 +17,9 @@ module PagerDuty
     class ApiError < RuntimeError
     end
 
+    class RateLimitError < RuntimeError
+    end
+
     class RaiseFileNotFoundOn404 < Faraday::Middleware
       def call(env)
         response = @app.call env
@@ -45,6 +49,17 @@ module PagerDuty
       end
     end
 
+    class RaiseRateLimitOn429 < Faraday::Middleware
+      def call(env)
+        response = @app.call env
+        if response.status == 429
+          raise RateLimitError, response.env[:url].to_s
+        end
+
+        response
+      end
+    end
+
     class ConvertTimesParametersToISO8601 < Faraday::Middleware
       TIME_KEYS = [:since, :until]
       def call(env)
@@ -56,7 +71,7 @@ module PagerDuty
           end
         end
 
-        response = @app.call env
+        @app.call env
       end
     end
 
@@ -131,58 +146,69 @@ module PagerDuty
       end
     end
 
-    def initialize(account, token, api_version = 1)
-      @api_version = api_version
+    def initialize(token, token_type: :Token, debug: false)
       @connection = Faraday.new do |conn|
-        conn.url_prefix = "https://#{account}.pagerduty.com/api/v#{api_version}"
+        conn.url_prefix = "https://api.pagerduty.com/"
 
-        # use token authentication: http://developer.pagerduty.com/documentation/rest/authentication
-        conn.token_auth token
+        token_arg =
+          case token_type
+          when :Token then { token: token }
+          when :Bearer then token
+          else raise ArgumentError, "invalid token_type: #{token_type.inspect}"
+          end
+        conn.authorization(token_type, token_arg)
 
         conn.use RaiseApiErrorOnNon200
         conn.use RaiseFileNotFoundOn404
+        conn.use RaiseRateLimitOn429
 
         conn.use ConvertTimesParametersToISO8601
 
         # use json
         conn.request :json
+        conn.headers[:accept] = "application/vnd.pagerduty+json;version=#{API_VERSION}"
 
         # json back, mashify it
         conn.use ParseTimeStrings
         conn.response :mashify
         conn.response :json
+        conn.response :logger, ::Logger.new(STDOUT), bodies: true if debug
 
         conn.adapter  Faraday.default_adapter
       end
     end
 
-    def get(path, options = {})
-      # paginate anything being 'get'ed, because the offset/limit isn't intutive
-      page = (options.delete(:page) || 1).to_i
-      limit = (options.delete(:limit) || 100).to_i
+    def get(path, request = {})
+      # paginate anything being 'get'ed, because the offset/limit isn't intuitive
+      request[:query_params] = {} if !request[:query_params]
+      page = (request[:query_params].delete(:page) || 1).to_i
+      limit = (request[:query_params].delete(:limit) || 100).to_i
       offset = (page - 1) * limit
+      request[:query_params] = request[:query_params].merge(offset: offset, limit: limit)
 
-      run_request(:get, path, options.merge(:offset => offset, :limit => limit))
+      run_request(:get, path, **request)
     end
 
-    def put(path, options = {})
-      run_request(:put, path, options)
+    def put(path, request = {})
+      run_request(:put, path, **request)
     end
 
-    def post(path, options = {})
-      run_request(:post, path, options)
+    def post(path, request = {})
+      run_request(:post, path, **request)
     end
 
-    def delete(path, options = {})
-      run_request(:delete, path, options)
+    def delete(path, request = {})
+      run_request(:delete, path, **request)
     end
 
-    def run_request(method, path, options)
+    private
+
+    def run_request(method, path, body: {}, headers: {}, query_params: {})
       path = path.gsub(/^\//, '') # strip leading slash, to make sure relative things happen on the connection
-      headers = nil
-      response = connection.run_request(method, path, options, headers)
+
+      connection.params = query_params
+      response = connection.run_request(method, path, body, headers)
       response.body
     end
-
   end
 end

data/lib/pager_duty/connection/version.rb

@@ -1,5 +1,5 @@
 module PagerDuty
   class Connection
-    VERSION = "0.2.0"
+    VERSION = "1.4.0"
   end
 end

data/pager_duty-connection.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "faraday", "~> 0.8", "< 0.10"
-  gem.add_dependency "faraday_middleware", "~> 0.9.0"
-  gem.add_dependency "activesupport", ">= 3.2", "< 5.0"
-  gem.add_dependency "hashie", ">= 1.2", "< 2.2"
+  gem.add_dependency "faraday", "~> 0.8", "< 1.0"
+  gem.add_dependency "faraday_middleware", "~> 0.8", "< 1.0"
+  gem.add_dependency "activesupport", ">= 3.2", "< 7.0"
+  gem.add_dependency "hashie", ">= 1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pager_duty-connection
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Josh Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: '0.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,27 @@ dependencies:
         version: '0.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +59,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +69,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -71,9 +77,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -81,9 +84,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.2'
 description: Ruby API wrapper for the PagerDuty REST API
 email:
 - josh@technicalpickles.com
@@ -121,11 +121,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Written with the power of faraday, pager_duty-connection tries to be a simple
   and usable Ruby API wrapper for the PagerDuty REST API
 test_files: []
-has_rdoc: