pd_event_v2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e58d9de22d4605cf35d2bd096b8c1b4c5c389bb24190d1b4f21223bf53c45e8c
+  data.tar.gz: bc0e61b89e8ba97eb340e2f3b430a62b944dcfedfa8fb87659daea18604939bf
+SHA512:
+  metadata.gz: 85f5777d327aa17be3427b7a172fc0dfe30473e809cb85b1c5a6f49e0376b67c3aa256b1de2748c07b157aec9b1220c7dffdfe7bbc111c71c6f2c2d82ad1cefd
+  data.tar.gz: 5e7ec4f6343e163e5816674dfde544207676801f2e1179bd85f62411133a0ac7d9178272eee869e0fe01bdd95de25127dcdfbe74cc9e289da284ccbda50cab56

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test.rb
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - test.rb
+    - vendor/bundle/**/*
+Metrics/LineLength:
+  Max: 120
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/Documentation:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pd_event_v2.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    pd_event_v2 (0.1.0)
+      faraday (~> 0.17)
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    faraday (0.17.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    jaro_winkler (1.5.4)
+    multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pd_event_v2!
+  rake
+  rspec (>= 3)
+  rubocop
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Genki Sugawara
+
+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/README.md

@@ -0,0 +1,46 @@
+# PdEventV2
+
+[PagerDuty Events API v2](https://v2.developer.pagerduty.com/docs/events-api-v2) Ruby Client.
+
+[![Gem Version](https://badge.fury.io/rb/pd_event_v2.svg)](http://badge.fury.io/rb/pd_event_v2)
+[![Build Status](https://travis-ci.org/winebarrel/pd_event_v2.svg?branch=master)](https://travis-ci.org/winebarrel/pd_event_v2)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pd_event_v2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pd_event_v2
+
+## Usage
+
+```ruby
+require 'pd_event_v2'
+
+# routing_key: Integration Key
+client = PdEventV2::Client.new(routing_key: 'ZAPZAPZAP')
+
+# see https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2
+res = client.trigger(
+  payload: {
+    summary: 'Example alert on host1.example.com',
+    source: 'monitoringtool:cloudvendor:central-region-dc-01:852559987:cluster/api-stats-prod-003',
+    severity: 'info'
+  }
+)
+
+p res #=> {
+      #     'status' => 'success',
+      #     'message' => 'Event processed',
+      #     'dedup_key' => '3c053fc438cc4608b8382b28adc0af8d'
+      #   }
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new do |task|
+  task.options = %w[-c .rubocop.yml]
+end
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pd_event_v2'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pd_event_v2.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'pd_event_v2/client'
+require 'pd_event_v2/version'

data/lib/pd_event_v2/client.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module PdEventV2
+  class Client
+    INITIALIZE_OPTIONS = %i[
+      routing_key
+      debug
+    ].freeze
+
+    DEFAULT_ADAPTERS = [
+      Faraday::Adapter::NetHttp,
+      Faraday::Adapter::Test,
+    ].freeze
+
+    USER_AGENT = "PagerDuty Events API v2 Ruby Client #{PdEventV2::VERSION}"
+
+    # https://v2.developer.pagerduty.com/docs/events-api-v2#making-a-request
+    DEFAULT_API_URL = 'https://events.pagerduty.com/v2/enqueue'
+
+    # https://v2.developer.pagerduty.com/docs/events-api-v2#event-action
+    EVENT_ACTIONS = %i[
+      trigger
+      acknowledge
+      resolve
+    ].freeze
+
+    # https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2
+    PAYLOAD_KEYS = {
+      summary: true,
+      source: true,
+      severity: true,
+      timestamp: false,
+      component: false,
+      group: false,
+      class: false,
+      custom_details: false,
+    }.freeze
+
+    def initialize(options)
+      unless options.is_a?(Hash)
+        raise ArgumentError, "wrong type argument (given: #{options}:#{options.class}, expected Hash)"
+      end
+
+      @options = {}
+
+      INITIALIZE_OPTIONS.each do |key|
+        @options[key] = options.delete(key)
+      end
+
+      raise ArgumentError, ':routing_key is required for initialize' unless @options[:routing_key]
+
+      options[:url] ||= DEFAULT_API_URL
+
+      @conn = Faraday.new(options) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :json, content_type: /\bjson\b/
+        faraday.response :raise_error
+        faraday.response :logger, ::Logger.new(STDOUT), bodies: true if @options[:debug]
+
+        yield(faraday) if block_given?
+
+        unless DEFAULT_ADAPTERS.any? { |i| faraday.builder.handlers.include?(i) }
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      @conn.headers[:user_agent] = USER_AGENT
+    end
+
+    EVENT_ACTIONS.each do |action|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{action}(**args)
+          send_event(event_action: '#{action}', **args)
+        end
+      RUBY
+    end
+
+    private
+
+    # https://v2.developer.pagerduty.com/v2/docs/send-an-event-events-api-v2
+    def send_event(event_action:, dedup_key: nil, payload:, images: nil, links: nil)
+      unless payload.is_a?(Hash)
+        raise ArgumentError, "wrong type payload (given: #{payload}:#{payload.class}, expected Hash)"
+      end
+
+      payload = payload.map do |key, val|
+        [key.to_sym, val]
+      end.to_h
+
+      PAYLOAD_KEYS.each do |key, required|
+        raise ArgumentError, "missing payload key: #{key}" if required && !payload.key?(key)
+      end
+
+      routing_key = @options.fetch(:routing_key)
+
+      params = {
+        routing_key: routing_key,
+        event_action: event_action,
+        payload: payload,
+      }
+
+      params[:dedup_key] = dedup_key if dedup_key
+      params[:images] = images if images
+      params[:links] = links if links
+
+      res = @conn.post do |req|
+        req.body = JSON.dump(params)
+        yield(req) if block_given?
+      end
+
+      res.body
+    end
+  end
+end

data/lib/pd_event_v2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PdEventV2
+  VERSION = '0.1.0'
+end

data/pd_event_v2.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pd_event_v2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pd_event_v2'
+  spec.version       = PdEventV2::VERSION
+  spec.authors       = ['winebarrel']
+  spec.email         = ['sugawara@winebarrel.jp']
+
+  spec.summary       = 'PagerDuty Events API v2 Ruby Client.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/winebarrel/pd_event_v2'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.17'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: pd_event_v2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- winebarrel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: PagerDuty Events API v2 Ruby Client.
+email:
+- sugawara@winebarrel.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pd_event_v2.rb
+- lib/pd_event_v2/client.rb
+- lib/pd_event_v2/version.rb
+- pd_event_v2.gemspec
+homepage: https://github.com/winebarrel/pd_event_v2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/winebarrel/pd_event_v2
+  source_code_uri: https://github.com/winebarrel/pd_event_v2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: PagerDuty Events API v2 Ruby Client.
+test_files: []