pagerduty 3.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10e8332a28ba06cbed648d66d0ee4c367e9f179fe30ae4903846ab789070e596
-  data.tar.gz: 56d30e6a7276dceff80df33748def18474204b58c4835d2fd2c59cccace8df2f
+  metadata.gz: a795d82c3660da5c30081c2e4753524edfad166388db9ec0c149604945ff2219
+  data.tar.gz: a50d6952570001c10ec07e2a262ad7b727a1539bc56d85675551ce7a281899f0
 SHA512:
-  metadata.gz: 4fc9193a4582aae06a8bbd6c886b99086142c7e9a57a4f09230e7152931f227d04c84007190629a9772a4c4e3a1d4a2f8a8f5fcb023f271c287f27c89f15c69d
-  data.tar.gz: a10af69c0ea9fb5b8cb88bcde086e9abbba12fdade60e08255d2192e75450994527256d0bb47947bb05463871affc427874868c689ba9a87ececf671ec25a257
+  metadata.gz: f24dede2659fa0c7dda59193e384c96d1045ed827de7b65944cfdeb851a8880797f8f7909b8a06fafbc05fa615ec7d03a573026d3d394c2bf5edf7417108ce86
+  data.tar.gz: b26a1dd98ddaff9efc3f84226e6da693ffd10bc8593044a05f2a42fc6c650bdb18ae95d1bc78bcd204aa763b80496d8e7051b75a6564462a52585a7ac45451e3

data/CHANGELOG.md

@@ -10,7 +10,79 @@ The format is based on [Keep a Changelog], and this project adheres to
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/pagerduty/compare/v3.0.0...HEAD
+[Unreleased]: https://github.com/envato/pagerduty/compare/v4.0.1...HEAD
+
+## [4.0.1] - 2024-02-17
+
+### Added
+
+- Test on Ruby 3.2, and 3.3 in the CI build ([#84], [#85]).
+
+### Changed
+
+- Updated authorship details ([#82]).
+- Bump the Rubocop development dependency to version 1 ([#86]).
+
+[4.0.1]: https://github.com/envato/pagerduty/compare/v4.0.0...v4.0.1
+[#82]: https://github.com/envato/pagerduty/pull/82
+[#84]: https://github.com/envato/pagerduty/pull/84
+[#85]: https://github.com/envato/pagerduty/pull/85
+[#86]: https://github.com/envato/pagerduty/pull/86
+
+## [4.0.0] - 2022-02-14
+
+### Removed
+
+- Remove support for Ruby versions lower than 2.3 ([#78]).
+
+- Removed the deprecated way of creating a Pagerduty instance ([#79]).
+
+  ```diff
+  - pagerduty = Pagerduty.new("<integration-key>")
+  + pagerduty = Pagerduty.build(integration_key: "<integration-key>", api_version: 1)
+  pagerduty.trigger("<incident description>")
+  incident.acknowledge
+  incident.resolve
+  ```
+
+- Removed the deprecated `get_incident` and `service_key` methods from the
+  `Pagerduty::EventsApiV1::Incident` class ([#79]). `incident` provides a replacement
+  for the `get_incident` method. The `service_key` method has no replacement.
+
+  ```diff
+  pagerduty = Pagerduty.build(integration_key: "<integration-key>", api_version: 1)
+  - incident = pagerduty.get_incident("<incident-key>")
+  + incident = pagerduty.incident("<incident-key>")
+  incident.trigger("<incident description>")
+  incident.acknowledge
+  incident.resolve
+  ```
+
+- Removed the `PagerdutyIncident` class. Instead, use the
+  `Pagerduty::EventsApiV1::Incident` class ([#79]).
+
+### Added
+
+- Test on Ruby 3.0 and 3.1 in CI build ([#74], [#80]).
+
+### Changed
+
+- The explicit `json` gem runtime dependency has been removed ([#78]).
+- Use GitHub Actions for CI build instead of TravisCI ([#73]).
+- The default git branch has been renamed to `main` ([#77]).
+
+### Fixed
+
+- Resolved `Net::HTTPServerException` deprecation warning in test suite([#75]).
+
+[4.0.0]: https://github.com/envato/pagerduty/compare/v3.0.0...v4.0.0
+[#73]: https://github.com/envato/pagerduty/pull/73
+[#74]: https://github.com/envato/pagerduty/pull/74
+[#75]: https://github.com/envato/pagerduty/pull/75
+[#77]: https://github.com/envato/pagerduty/pull/77
+[#78]: https://github.com/envato/pagerduty/pull/78
+[#79]: https://github.com/envato/pagerduty/pull/79
+[#80]: https://github.com/envato/pagerduty/pull/80
 
 ## [3.0.0] - 2020-04-20
 
@@ -123,7 +195,7 @@ The format is based on [Keep a Changelog], and this project adheres to
   ```
 
 [3.0.0]: https://github.com/envato/pagerduty/compare/v2.1.3...v3.0.0
-[events-v2-docs]: https://v2.developer.pagerduty.com/docs/send-an-event-events-api-v2
+[events-v2-docs]: https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview
 [#64]: https://github.com/envato/pagerduty/pull/64
 [#66]: https://github.com/envato/pagerduty/pull/66
 [#67]: https://github.com/envato/pagerduty/pull/67

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Envato, Charlie Somerville & Orien Madgwick
+Copyright (c) 2010 Envato, Hailey Somerville & Orien Madgwick
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,14 +1,14 @@
 # pagerduty
 
-[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/pagerduty/blob/master/LICENSE.txt)
+[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/pagerduty/blob/HEAD/LICENSE.txt)
 [![Gem Version](https://img.shields.io/gem/v/pagerduty.svg?maxAge=2592000)](https://rubygems.org/gems/pagerduty)
 [![Gem Downloads](https://img.shields.io/gem/dt/pagerduty.svg?maxAge=2592000)](https://rubygems.org/gems/pagerduty)
-[![Build Status](https://travis-ci.org/envato/pagerduty.svg?branch=master)](https://travis-ci.org/envato/pagerduty)
+[![Build Status](https://github.com/envato/pagerduty/workflows/build/badge.svg?branch=main)](https://github.com/envato/pagerduty/actions?query=workflow%3Abuild+branch%3Amain)
 
 Provides a lightweight Ruby interface for calling the [PagerDuty Events
 API][events-v2-docs].
 
-[events-v2-docs]: https://v2.developer.pagerduty.com/docs/send-an-event-events-api-v2
+[events-v2-docs]: https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview
 
 ## Installation
 
@@ -28,6 +28,13 @@ Or install it yourself as:
 
 ## Usage
 
+First, obtain an Events API integration key from PagerDuty. Follow the
+[instructions][integration-key-documentation] in PagerDuty's documentation to
+procure one.
+
+[integration-key-documentation]: https://support.pagerduty.com/docs/services-and-integrations#create-a-generic-events-api-integration
+
+
 ### Events API V2
 
 ```ruby
@@ -207,30 +214,13 @@ begin
     source:   "source",
     severity: "critical"
   )
-rescue Net::HTTPServerException => error
+rescue Net::HTTPClientException => error
   error.response.code    #=> "400"
   error.response.message #=> "Bad Request"
   error.response.body    #=> "{\"status\":\"invalid event\",\"message\":\"Event object is invalid\",\"errors\":[\"Service key is the wrong length (should be 32 characters)\"]}"
 end
 ```
 
-### Legacy Interface
-
-The older Ruby interface from version 2 of the gem is still available.
-However, this is deprecated and will be removed in the next major release.
-
-```ruby
-# Instantiate a Pagerduty with your specific service key
-pagerduty = Pagerduty.new("<my-integration-key>")
-
-# Trigger an incident
-incident = pagerduty.trigger("incident description")
-
-# Acknowledge and resolve the incident
-incident.acknowledge
-incident.resolve
-```
-
 ## Contributing
 
 1. Fork it ( https://github.com/envato/pagerduty/fork )

data/lib/pagerduty/events_api_v1.rb

@@ -176,9 +176,7 @@ module Pagerduty
       # @param (see Pagerduty::EventsApiV1#trigger)
       # @option (see Pagerduty::EventsApiV1#trigger)
       def trigger(description, options = {})
-        if options.key?(:incident_key)
-          raise ArgumentError, "incident_key provided"
-        end
+        raise ArgumentError, "incident_key provided" if options.key?(:incident_key)
 
         options = options.merge(description: description)
         options[:incident_key] = @incident_key unless @incident_key.nil?
@@ -268,9 +266,7 @@ module Pagerduty
           event_type:  event_type,
         )
         response = @transport.send_payload(args)
-        unless response["status"] == "success"
-          raise PagerdutyException.new(self, response, response["message"])
-        end
+        raise PagerdutyException.new(self, response, response["message"]) unless response["status"] == "success"
 
         response
       end

data/lib/pagerduty/events_api_v2.rb

@@ -5,8 +5,8 @@ require "time"
 module Pagerduty
   # Trigger incidents via the PagerDuty Events API version 2.
   #
-  # @see https://v2.developer.pagerduty.com/docs/events-api-v2 PagerDuty Events
-  #   API V2 documentation
+  # @see https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview
+  #   PagerDuty Events API V2 documentation
   #
   # @see Pagerduty.build
   #
@@ -269,9 +269,7 @@ module Pagerduty
           event_action: event_action,
         )
         response = @transport.send_payload(payload)
-        unless response["status"] == "success"
-          raise PagerdutyException.new(self, response, response["message"])
-        end
+        raise PagerdutyException.new(self, response, response["message"]) unless response["status"] == "success"
 
         response
       end

data/lib/pagerduty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pagerduty
-  VERSION = "3.0.0"
+  VERSION = "4.0.1"
 end

data/lib/pagerduty.rb

@@ -4,7 +4,6 @@ require "pagerduty/version"
 require "pagerduty/http_transport"
 require "pagerduty/events_api_v1"
 require "pagerduty/events_api_v2"
-require "pagerduty/legacy"
 
 class PagerdutyException < StandardError
   attr_reader :pagerduty_instance, :api_response
@@ -65,9 +64,7 @@ module Pagerduty
   #   provided. Or if the provided api_version is unsupported.
   #
   def self.build(config)
-    unless config.key?(:integration_key)
-      raise ArgumentError, "integration_key not provided"
-    end
+    raise ArgumentError, "integration_key not provided" unless config.key?(:integration_key)
     raise ArgumentError, "incident_key provided" if config.key?(:incident_key)
 
     version = config.fetch(:api_version) do

metadata

@@ -1,90 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: pagerduty
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.1
 platform: ruby
 authors:
-- Charlie Somerville
+- Hailey Somerville
 - Orien Madgwick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.7
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: 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-given
-  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: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.77'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.77'
-description: Provides a lightweight interface for calling the PagerDuty Integration
-  API
+date: 2024-02-17 00:00:00.000000000 Z
+dependencies: []
+description: Provides a lightweight interface for calling the PagerDuty Events API
 email:
-- charlie@charliesomerville.com
+- hailey@hailey.lol
 - _@orien.io
 executables: []
 extensions: []
@@ -97,17 +26,17 @@ files:
 - lib/pagerduty/events_api_v1.rb
 - lib/pagerduty/events_api_v2.rb
 - lib/pagerduty/http_transport.rb
-- lib/pagerduty/legacy.rb
 - lib/pagerduty/version.rb
-homepage: http://github.com/envato/pagerduty
+homepage: https://github.com/envato/pagerduty
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/envato/pagerduty/issues
-  changelog_uri: https://github.com/envato/pagerduty/blob/v3.0.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/pagerduty/3.0.0
-  source_code_uri: https://github.com/envato/pagerduty/tree/v3.0.0
-post_install_message: 
+  changelog_uri: https://github.com/envato/pagerduty/blob/v4.0.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/pagerduty/4.0.1
+  homepage_uri: https://github.com/envato/pagerduty
+  source_code_uri: https://github.com/envato/pagerduty/tree/v4.0.1
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,15 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
-summary: Pagerduty Integration API client library
+summary: PagerDuty Events API client library
 test_files: []

data/lib/pagerduty/legacy.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# This file contains patches to provide backwards compatibility with version 2
-# of the pagerduty gem. On the release of the next major version (4.0) it will
-# be deleted, thus breaking backwards compatibility.
-
-PagerdutyIncident = Pagerduty::EventsApiV1::Incident
-
-Pagerduty::EventsApiV1::Incident.class_eval do
-  def service_key
-    @integration_key
-  end
-end
-
-Pagerduty::EventsApiV1.class_eval do
-  alias_method :get_incident, :incident
-
-  def service_key
-    @config[:integration_key]
-  end
-end
-
-Pagerduty.class_eval do
-  def self.new(service_key, options = {})
-    build(
-      integration_key: service_key,
-      api_version:     1,
-      http_proxy:      {
-        host:     options[:proxy_host],
-        port:     options[:proxy_port],
-        username: options[:proxy_username],
-        password: options[:proxy_password],
-      },
-    )
-  end
-end