pager_duty-connection 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd585e0292f12142b4deb85820c0bf5f9155f6d7ec607bddf53bceaf131c732
-  data.tar.gz: 8b2f1784f52e3f4d70e135b2d70eff086de47a87b6e24b0079797211634617e3
+  metadata.gz: b054f9ef807fb4106210b76a8a04db02b52599a4c617df4d43f06b3a5f63c67c
+  data.tar.gz: 76f316fd0c10badb260c3353926f9ceb540c5af3b0ae33b597641e0f482ea2a3
 SHA512:
-  metadata.gz: 857ce1740ca088180a548594f38aa8c4ab0af2bb5b3fe002bda1febd00e6a5c83bc89a01803596d5e518562a19186e0fd6c2f868a30f89827d6b39f7ca1988cf
-  data.tar.gz: 7e3f96e3ea4d2eb17714eb2deb090316817cce70c3f2c77dd3cbfe306683ae462adf9e3ec34c5ac6a204523638ad005b7626b07751adf2224dc7ce78e5d20bb6
+  metadata.gz: 99dc2a3a2ba5eedb69ac4ac1f758df7bb54a7a632adb9af8bc4a3093bcc8b4638d637f63dd49221838b81ccd7badb51ba68d9f6cdc12ad1a0c0ed5a9aedcc558
+  data.tar.gz: '08a739a697b4f429e42d584ece06a5d7176fcb2099be85c6d1cdc0c79763bbaca2ff6bfc04ce5a17fe9fcc1102545bec6fb54c7a93d39f948a7ed62359d48373'

data/lib/pager_duty/connection/version.rb

@@ -1,5 +1,5 @@
 module PagerDuty
   class Connection
-    VERSION = "2.2.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/pager_duty/connection.rb

@@ -1,5 +1,5 @@
 require 'faraday'
-require 'faraday_middleware'
+require 'hashie'
 require 'active_support'
 require 'active_support/core_ext'
 require 'active_support/time_with_zone'
@@ -12,15 +12,39 @@ module PagerDuty
     API_VERSION = 2
     API_PREFIX = "https://api.pagerduty.com/"
 
-    class FileNotFoundError < RuntimeError
-    end
+    class FileNotFoundError < RuntimeError; end
+
+    class ApiError < RuntimeError; end
+
+    class RateLimitError < RuntimeError; end
+
+    class UnauthorizedError < RuntimeError; end
+
+    class ForbiddenError < RuntimeError; end
 
-    class ApiError < RuntimeError
+    class RaiseUnauthorizedOn401 < Faraday::Middleware
+      def call(env)
+        response = @app.call(env)
+        if response.status == 401
+          raise PagerDuty::Connection::UnauthorizedError, response.env[:url].to_s
+        else
+          response
+        end
+      end
     end
 
-    class RateLimitError < RuntimeError
+    class RaiseForbiddenOn403 < Faraday::Middleware
+      def call(env)
+        response = @app.call(env)
+        if response.status == 403
+          raise PagerDuty::Connection::ForbiddenError, response.env[:url].to_s
+        else
+          response
+        end
+      end
     end
 
+
     class RaiseFileNotFoundOn404 < Faraday::Middleware
       def call(env)
         response = @app.call env
@@ -40,10 +64,13 @@ module PagerDuty
           message = "Got HTTP #{response.status}: #{response.reason_phrase}\nFrom #{url}"
 
           if error = response.body
-            # TODO May Need to check error.errors too
-            message += "\n#{JSON.parse(error)}"
+            begin
+              # TODO May Need to check error.errors too
+              message += "\n#{JSON.parse(error)}"
+            rescue JSON::ParserError
+              message += "\n#{error}"
+            end
           end
-
           raise ApiError, message
         else
           response
@@ -67,9 +94,11 @@ module PagerDuty
       def call(env)
 
         body = env[:body]
-        TIME_KEYS.each do |key|
-          if body.has_key?(key)
-            body[key] = body[key].iso8601 if body[key].respond_to?(:iso8601)
+        unless body.nil?
+          TIME_KEYS.each do |key|
+            if body.has_key?(key)
+              body[key] = body[key].iso8601 if body[key].respond_to?(:iso8601)
+            end
           end
         end
 
@@ -77,7 +106,7 @@ module PagerDuty
       end
     end
 
-    class ParseTimeStrings < Faraday::Response::Middleware
+    class ParseTimeStrings < Faraday::Middleware
       TIME_KEYS = %w(
         at
         created_at
@@ -108,6 +137,10 @@ module PagerDuty
         pending_actions
       )
 
+      def on_complete(env)
+        parse(env[:body])
+      end
+
       def parse(body)
         case body
         when Hash, ::Hashie::Mash
@@ -150,13 +183,34 @@ 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
         else raise ArgumentError, "invalid token_type: #{token_type.inspect}"
@@ -170,7 +224,7 @@ 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
 
@@ -180,12 +234,20 @@ module PagerDuty
         conn.use RaiseApiErrorOnNon200
         conn.use RaiseFileNotFoundOn404
         conn.use RaiseRateLimitOn429
+        conn.use RaiseForbiddenOn403
+        conn.use RaiseUnauthorizedOn401
 
         conn.adapter  Faraday.default_adapter
       end
     end
 
     def get(path, request = {})
+      # The run_request() method body argument defaults to {}, which is incorrect for GET requests
+      # https://github.com/technicalpickles/pager_duty-connection/issues/56
+      # NOTE: PagerDuty support discourages GET requests with bodies, but not throwing an ArgumentError to prevent breaking
+      #   corner-case implementations.
+      request[:body] = nil if !request[:body]
+
       # paginate anything being 'get'ed, because the offset/limit isn't intuitive
       request[:query_params] = {} if !request[:query_params]
       page = request[:query_params].fetch(:page, 1).to_i
@@ -193,6 +255,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
@@ -211,6 +274,14 @@ 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
 

data/pager_duty-connection.gemspec

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

metadata

@@ -1,43 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: pager_duty-connection
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Josh Nichols
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2024-04-29 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
@@ -124,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Written with the power of faraday, pager_duty-connection tries to be a simple