pager_duty-connection 2.3.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38445eaf7e12ef537c66dca5286ec2e35cc5b76659c1df5d0972c11479f6bb56
-  data.tar.gz: bc79b9edd688055b9fb06631cc1573bfc4a148f5994397b39b5ffe617c771e18
+  metadata.gz: 62d5837515647a768626a48a20621bf19c937139f0bf10605d4aa945cdd0bb0a
+  data.tar.gz: c25658b8e8b25eeb8b18839490c90e4c28c424f08cbaaa4a8d209775dcb77d98
 SHA512:
-  metadata.gz: 57d66bf01db4ae1de573d108609503e877d77be6d2b9f31cb8d02cf45ba8e61c73154db44ec658191466042ba60932f4bfb17e3a58e63d8c844c380d86beab2f
-  data.tar.gz: 6ca00d5ce74e0cd573c052db347f7eddf371d0e80949b526d711747b04e289f61c2bc5f5977dcc85d605aad0972ed0c9d4269c108892ca10b9fc737abe369cb6
+  metadata.gz: 9cd5c6cb6967d8f2936e2063d3f898ca007045eb94c1bebb48da18a8e259a40edcc8a6e23cc1b3487e480742415c5196aa1759573fd74e30c201cfb8398a5c26
+  data.tar.gz: 42b5626e27ac9a4be206aed56d07546a02f252e8632704d9e997969d11ae3358ef0845ef8d7f9b7ccdf277952e06707fca32649b10e2c28c440024a690d280e5

data/.github/workflows/standardrb.yaml

@@ -0,0 +1,13 @@
+name: StandardRB
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: StandardRB Linter
+      uses: standardrb/standard-ruby-action@v0.0.5
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/Gemfile

@@ -1,10 +1,11 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in pager_duty-connection.gemspec
 gemspec
 
 # for tests & running examples
 group :development do
-  gem 'dotenv'
-  gem 'pry'
+  gem "dotenv"
+  gem "pry"
+  gem "standardrb"
 end

data/README.md

@@ -31,7 +31,9 @@ And this is what it doesn't do:
 
 Add this line to your application's Gemfile:
 
-    gem 'pager_duty-connection'
+```ruby
+gem "pager_duty-connection"
+```
 
 And then execute:
 
@@ -54,22 +56,22 @@ pagerduty = PagerDuty::Connection.new(token)
 pagerduty = PagerDuty::Connection.new(token, token_type: :Bearer)
 
 # setup to use a custom domain
-pagerduty = PagerDuty::Connection.new(token, token_type: :Bearer, url: 'https://custom.domain.com')
+pagerduty = PagerDuty::Connection.new(token, token_type: :Bearer, url: "https://custom.domain.com")
 
 # 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)
+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 = pagerduty.get("incidents")
 response.incidents # an array of incidents
 
-response = pagerduty.get('incidents/YYZ')
+response = pagerduty.get("incidents/YYZ")
 response # the hash/object that represents the array
 ```
 
@@ -102,14 +104,14 @@ 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-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:
 
 ```ruby
-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}")
+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)
 ```
 

data/examples/find-users.rb

@@ -1,15 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'dotenv'
-Dotenv.load ".env.development", '.env'
+require "dotenv"
+Dotenv.load ".env.development", ".env"
 
-token = ENV['PAGERDUTY_TOKEN'] || raise("Missing ENV['PAGERDUTY_TOKEN'], 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(token)
+require "pager_duty/connection"
+pagerduty = PagerDuty::Connection.new(token)
 
 # 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 = pagerduty.get("users")
+response["users"].each do |user|
+  puts "#{user["name"]}: #{user["email"]}"
 end

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

@@ -1,46 +1,46 @@
 #!/usr/bin/env ruby
 
-require 'dotenv'
-Dotenv.load ".env.development", '.env'
+require "dotenv"
+Dotenv.load ".env.development", ".env"
 
-token = ENV['PAGERDUTY_TOKEN'] || raise("Missing ENV['PAGERDUTY_TOKEN'], 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(token)
+require "pager_duty/connection"
+pagerduty = PagerDuty::Connection.new(token)
 
-schedule_id = ENV['PAGERDUTY_SCHEDULE_ID'] || raise("Missing ENV['PAGERDUTY_SCHEDULE_ID'], add to .env.development")
+schedule_id = ENV["PAGERDUTY_SCHEDULE_ID"] || raise("Missing ENV['PAGERDUTY_SCHEDULE_ID'], add to .env.development")
 
 # pull down schedule entires for XXX schedule in the last day (ie who has been on call, and when
 time_since = 1.day.ago
 time_until = Time.now
 
 # 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] })
+response = pagerduty.get("oncalls", query_params: {since: time_since, until: time_until, schedule_ids: [schedule_id]})
 
-entries = response['oncalls']
+entries = response["oncalls"]
 
 entries.each do |entry|
-  puts "#{entry['start']} - #{entry['end']}: #{entry['user']['summary']}"
+  puts "#{entry["start"]} - #{entry["end"]}: #{entry["user"]["summary"]}"
 
   # find incidents during that shift
   # 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 = 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:
     # https://v2.developer.pagerduty.com/v2/page/api-reference#!/Incidents/get_incidents_id_log_entries
-    response = $pagerduty.get("incidents/#{incident.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/version.rb

@@ -1,5 +1,5 @@
 module PagerDuty
   class Connection
-    VERSION = "2.3.0"
+    VERSION = "3.1.0"
   end
 end

data/lib/pager_duty/connection.rb

@@ -1,11 +1,10 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_support/time_with_zone'
+require "faraday"
+require "hashie"
+require "active_support"
+require "active_support/core_ext"
+require "active_support/time_with_zone"
 
 module PagerDuty
-
   class Connection
     attr_accessor :connection
 
@@ -44,7 +43,6 @@ module PagerDuty
       end
     end
 
-
     class RaiseFileNotFoundOn404 < Faraday::Middleware
       def call(env)
         response = @app.call env
@@ -59,11 +57,13 @@ module PagerDuty
     class RaiseApiErrorOnNon200 < Faraday::Middleware
       def call(env)
         response = @app.call env
-        unless [200, 201, 204].include?(response.status)
+        if [200, 201, 204].include?(response.status)
+          response
+        else
           url = response.env[:url].to_s
           message = "Got HTTP #{response.status}: #{response.reason_phrase}\nFrom #{url}"
 
-          if error = response.body
+          if (error = response.body)
             begin
               # TODO May Need to check error.errors too
               message += "\n#{JSON.parse(error)}"
@@ -72,8 +72,6 @@ module PagerDuty
             end
           end
           raise ApiError, message
-        else
-          response
         end
       end
     end
@@ -92,7 +90,6 @@ module PagerDuty
     class ConvertTimesParametersToISO8601 < Faraday::Middleware
       TIME_KEYS = [:since, :until]
       def call(env)
-
         body = env[:body]
         unless body.nil?
           TIME_KEYS.each do |key|
@@ -106,8 +103,8 @@ module PagerDuty
       end
     end
 
-    class ParseTimeStrings < Faraday::Response::Middleware
-      TIME_KEYS = %w(
+    class ParseTimeStrings < Faraday::Middleware
+      TIME_KEYS = %w[
         at
         created_at
         created_on
@@ -118,9 +115,9 @@ module PagerDuty
         start
         started_at
         start_time
-      )
+      ]
 
-      OBJECT_KEYS = %w(
+      OBJECT_KEYS = %w[
         alert
         entry
         incident
@@ -129,13 +126,17 @@ module PagerDuty
         note
         override
         service
-      )
+      ]
 
-      NESTED_COLLECTION_KEYS = %w(
+      NESTED_COLLECTION_KEYS = %w[
         acknowledgers
         assigned_to
         pending_actions
-      )
+      ]
+
+      def on_complete(env)
+        parse(env[:body])
+      end
 
       def parse(body)
         case body
@@ -169,7 +170,7 @@ module PagerDuty
       end
 
       def parse_object_times(object)
-        time = Time.zone ? Time.zone : Time
+        time = Time.zone || Time
 
         TIME_KEYS.each do |key|
           if object.has_key?(key) && object[key].present?
@@ -179,15 +180,36 @@ module PagerDuty
       end
     end
 
+    class Mashify < Faraday::Middleware
+      def on_complete(env)
+        env[:body] = parse(env[:body])
+      end
+
+      def parse(body)
+        case body
+        when Hash
+          ::Hashie::Mash.new(body)
+        when Array
+          body.map { |item| parse(item) }
+        else
+          body
+        end
+      end
+    end
+
     def initialize(token, token_type: :Token, url: API_PREFIX, debug: false)
       @connection = Faraday.new do |conn|
         conn.url_prefix = url
 
         case token_type
         when :Token
-          conn.request :token_auth, token
+          if faraday_v1?
+            conn.request :token_auth, token
+          else
+            conn.request :authorization, "Token", token
+          end
         when :Bearer
-          conn.request :authorization, 'Bearer', token
+          conn.request :authorization, "Bearer", token
         else raise ArgumentError, "invalid token_type: #{token_type.inspect}"
         end
 
@@ -199,9 +221,9 @@ module PagerDuty
 
         # json back, mashify it
         conn.use ParseTimeStrings
-        conn.response :mashify
+        conn.use Mashify
         conn.response :json
-        conn.response :logger, ::Logger.new(STDOUT), bodies: true if debug
+        conn.response :logger, ::Logger.new($stdout), bodies: true if debug
 
         # Because Faraday::Middleware executes in reverse order of
         # calls to conn.use, status code error handling goes at the
@@ -212,7 +234,7 @@ module PagerDuty
         conn.use RaiseForbiddenOn403
         conn.use RaiseUnauthorizedOn401
 
-        conn.adapter  Faraday.default_adapter
+        conn.adapter Faraday.default_adapter
       end
     end
 
@@ -230,6 +252,7 @@ module PagerDuty
       offset = (page - 1) * limit
 
       query_params = request[:query_params].merge(offset: offset, limit: limit)
+      query_params.delete(:page)
 
       run_request(:get, path, **request.merge(query_params: query_params))
     end
@@ -248,8 +271,16 @@ module PagerDuty
 
     private
 
+    def faraday_v1?
+      faraday_version < Gem::Version.new("2")
+    end
+
+    def faraday_version
+      @faraday_version ||= Gem.loaded_specs["faraday"].version
+    end
+
     def run_request(method, path, body: {}, headers: {}, query_params: {})
-      path = path.gsub(/^\//, '') # strip leading slash, to make sure relative things happen on the connection
+      path = path.gsub(/^\//, "") # strip leading slash, to make sure relative things happen on the connection
 
       connection.params = query_params
       response = connection.run_request(method, path, body, headers)

data/lib/pager_duty.rb

@@ -1,6 +1,5 @@
-require 'pager_duty/connection/version'
+require "pager_duty/connection/version"
 
 module PagerDuty
-  autoload :Connection, 'pager_duty/connection'
+  autoload :Connection, "pager_duty/connection"
 end
-

data/pager_duty-connection.gemspec

@@ -1,25 +1,22 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pager_duty/connection/version'
+require "pager_duty/connection/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = "pager_duty-connection"
-  gem.version       = PagerDuty::Connection::VERSION
-  gem.authors       = ["Josh Nichols"]
-  gem.email         = ["josh@technicalpickles.com"]
-  gem.description   = %q{Ruby API wrapper for the PagerDuty REST API}
-  gem.summary       = %q{Written with the power of faraday, pager_duty-connection tries to be a simple and usable Ruby API wrapper for the PagerDuty REST API}
-  gem.homepage      = "http://github.com/technicalpickles/pager_duty-connection"
+  gem.name = "pager_duty-connection"
+  gem.version = PagerDuty::Connection::VERSION
+  gem.authors = ["Josh Nichols"]
+  gem.email = ["josh@technicalpickles.com"]
+  gem.description = "Ruby API wrapper for the PagerDuty REST API"
+  gem.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"
+  gem.homepage = "http://github.com/technicalpickles/pager_duty-connection"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "faraday", "~> 1.0"
-  gem.add_dependency "faraday_middleware", "~> 1.0"
-  gem.add_dependency "activesupport", ">= 3.2", "< 8.0"
+  gem.add_dependency "faraday", ">= 1.10", "< 3"
+  gem.add_dependency "activesupport", ">= 3.2", "< 9.0"
   gem.add_dependency "hashie", ">= 1.2"
 
   gem.add_development_dependency "rake"

metadata

@@ -1,43 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: pager_duty-connection
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Josh Nichols
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +39,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +49,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +85,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/standardrb.yaml"
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
@@ -124,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Written with the power of faraday, pager_duty-connection tries to be a simple