pagerduty_cli 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d4f3f309ba8e989ee26ce922e3a4fd79f6836fc
+  data.tar.gz: 6ad7430c264960dd7f97079ef352dc85b0f47405
+SHA512:
+  metadata.gz: daff2bce60dfda39f8557ccc209ed98ba29c2c8675c7f41aea1e426fd2a0c63bbddcdadf2ee85ff251da9fd71cf4c4b91068dfd2ebad26bc9fa4476d5b9f020b
+  data.tar.gz: 8093c58396762102b66f3a56862f48f7a838dccd40d2c2996cd18a5ffcb3700f9dd2a0d14bce003fa511c796f9cab03585ec714e246b65a8c927ed080afd889a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pagerduty_cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Justin Dossey
+
+MIT License
+
+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,53 @@
+# PagerdutyCli
+
+A Ruby-based CLI to PagerDuty. Supports triggers and resolves.
+
+Inspired by Pinterest's Python implementation:
+https://github.com/pinterest/pagerduty-monit
+
+Requires Ruby >= 1.9.3.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'pagerduty_cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pagerduty_cli
+
+## Usage
+
+Trigger an event with
+```
+pagerduty-trigger -e EVENT_NAME
+```
+
+See all options with:
+```
+pagerduty-trigger -h
+```
+
+Resolve an event with
+```
+pagerduty-resolve -e EVENT_NAME
+```
+See all options with:
+```
+pagerduty-resolve -h
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pagerduty_cli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/pagerduty-resolve

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Resolve a PagerDuty alert.
+
+require 'rubygems'
+require 'pagerduty_cli'
+
+PagerdutyCli::Resolve.resolve(ARGV)

data/bin/pagerduty-trigger

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Trigger a PagerDuty alert.
+
+require 'rubygems'
+require 'pagerduty_cli'
+
+PagerdutyCli::Trigger.trigger(ARGV)

data/lib/pagerduty_cli.rb

@@ -0,0 +1,7 @@
+require 'pagerduty_cli/version'
+require 'pagerduty_cli/trigger'
+require 'pagerduty_cli/resolve'
+
+# PagerDuty CLI module
+module PagerdutyCli
+end

data/lib/pagerduty_cli/common.rb

@@ -0,0 +1,61 @@
+# Module for common functionality to pagerduty CLI classes
+module PagerdutyCli
+  # Common functionality to pagerduty interaction
+  module Common
+    API_KEY_FILE = '/etc/pagerduty_api.key'
+    def load_data
+      @api_key = File.open(@options[:api_key_file]).read.chomp
+    rescue Errno::ENOENT, Errno::EPERM
+      croak("Could not open PD API key file at #{@options[:api_key_file]}.")
+    end
+
+    def croak(message)
+      $stderr.puts "#{@me} Error: #{message} Exiting."
+      exit 1
+    end
+
+    def warn(message)
+      $stderr.puts "#{@me} Warning: #{message}"
+    end
+
+    def incident_key
+      event_key = "#{@options[:host]}:#{@options[:event]}"
+      Digest::SHA1.hexdigest(event_key)
+    end
+
+    # return the name for our incident state file.
+    def incident_file
+      File.join(@options[:tmpdir], "pagerduty-#{incident_key}")
+    end
+
+    # Disabling the MethodLength cop here because any reduction would reduce
+    # readability.
+    # rubocop:disable MethodLength
+    def parse_common_options(opts)
+      opts.banner = "Usage: #{@me} [options]"
+      @options ||= {}
+      @options.merge!(host: ENV['HOSTNAME'],
+                      api_key_file: API_KEY_FILE,
+                      tmpdir: '/tmp')
+      opts.on('-H', '--host HOST', 'Report from the hostname given') do |h|
+        @options[:host] = h
+      end
+      opts.on('-k', '--keyfile KEYFILE',
+              'Use the key specified in file KEYFILE') do |kf|
+        @options[:api_key_file] = kf
+              end
+      opts.on('-e', '--event EVENT', 'Report the event given') do |e|
+        @options[:event] = e
+      end
+      opts.on('-t', '--tmpdir PATH',
+              'location for incident files') do |tmp|
+        @options[:tmpdir] = tmp
+      end
+      opts.on_tail('-h', '--help', 'Show this message') do
+        $stderr.puts opts
+        exit
+      end
+    end
+    # rubocop:enable MethodLength
+  end
+end

data/lib/pagerduty_cli/resolve.rb

@@ -0,0 +1,37 @@
+# Class to send resolutions to PagerDuty.
+module PagerdutyCli
+  # Send a resolve to PagerDuty.
+  class Resolve
+    def initialize(args)
+      @me = 'pagerduty_resolve'
+      parse_opts(args)
+      load_data
+    end
+
+    def self.resolve(args)
+      new(args).send_resolve
+    end
+
+    def send_resolve
+      Pagerduty.new(@api_key).get_incident(incident_key).resolve
+      remove_incident_file
+    end
+
+    private
+
+    include PagerdutyCli::Common
+
+    def parse_opts(args)
+      opt_parser = OptionParser.new do |opts|
+        parse_common_options(opts)
+      end
+      opt_parser.parse! args
+    end
+
+    def remove_incident_file
+      File.delete(incident_file)
+    rescue Errno::ENOENT
+      warn("No incident file found at #{incident_file}")
+    end
+  end
+end

data/lib/pagerduty_cli/trigger.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require 'optparse'
+require 'pagerduty'
+require 'digest/sha1'
+
+require_relative 'common'
+
+# Send a PagerDuty alert.
+module PagerdutyCli
+  # Send a trigger to PagerDuty
+  class Trigger
+    def initialize(args)
+      @me = 'pagerduty_trigger'
+      parse_opts(args)
+      load_data
+      return unless @options[:force] || !incident_is_too_fresh?
+      touch_incident_file unless @options[:no_touch]
+    end
+
+    class << self
+      def trigger(args)
+        new(args).send_trigger
+      end
+    end
+
+    def send_trigger
+      Pagerduty.new(@api_key).trigger(incident_description,
+                                      incident_key: incident_key,
+                                      client: @options[:host])
+    end
+
+    private
+
+    include PagerdutyCli::Common
+
+    # Disabling the MethodLength cop here because any reduction would reduce
+    # readability.
+    # rubocop:disable MethodLength
+    def parse_opts(args)
+      # default options
+      @options = {}
+      @options[:interval] = (4 * 60 * 60 + 1)
+
+      opt_parser = OptionParser.new do |opts|
+        parse_common_options(opts)
+        opts.on('-f', '--force',
+                'Force the event to process, even if not fresh') do
+          @options[:force] = true
+        end
+        opts.on('-n', '--no-incident',
+                'Do not record sending this incident') do
+          @options[:no_touch] = true
+        end
+        opts.on('-i', '--touch-interval INTERVAL',
+                'Specify freshness interval in seconds') do |interval|
+          @options[:interval] = interval.to_i
+        end
+      end
+      opt_parser.parse! args
+    end
+    # rubocop:enable MethodLength
+
+    # return true if this incident has been reported in the past 4 hrs 1 min
+    def incident_is_too_fresh?
+      cutoff = Time.now - @options[:interval]
+      File.exist?(incident_file) && File.mtime(incident_file) > cutoff
+    end
+
+    def incident_description
+      "#{@options[:event]} failed on #{@options[:host]}"
+    end
+
+    def touch_incident_file
+      File.open(incident_file, 'a') do |f|
+        f.puts "#{Time.now}: #{incident_description}"
+      end
+    rescue Errno::EPERM
+      croak("Could not write incident file #{incident_file.inspect}")
+    end
+  end
+end

data/lib/pagerduty_cli/version.rb

@@ -0,0 +1,4 @@
+# PagerDuty CLI
+module PagerdutyCli
+  VERSION = '0.0.3'
+end

data/pagerduty_cli.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pagerduty_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pagerduty_cli'
+  spec.version       = PagerdutyCli::VERSION
+  spec.authors       = ['Justin Dossey']
+  spec.email         = ['justin.dossey@newcontext.com']
+  spec.summary       = 'ruby CLI for PagerDuty API'
+  spec.description   = 'ruby CLI for PagerDuty API. '\
+    'Supports sending triggers and resolves.'
+  spec.homepage      = 'https://github.com/justindossey/pagerduty_cli'
+  spec.license       = 'MIT'
+
+  spec.bindir        = 'bin'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pagerduty', '~> 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/pagerduty_cli_spec.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PagerdutyCli do
+  it 'defines the PagerdutyCli module' do
+    expect(PagerdutyCli).to be_a(Module)
+  end
+  it 'defines the PagerdutyCli::Common module' do
+    expect(PagerdutyCli::Common).to be_a(Module)
+  end
+  it 'croaks properly' do
+    # stub for testing the cli
+    stub_actor = StubPagerdutyCliActor.new
+    out = 'Stub Actor Error: hi Exiting.'
+    allow($stderr).to receive(:puts).with(out).and_return(out)
+    expect { stub_actor.croak('hi') }.to raise_error(SystemExit)
+    expect($stderr).to have_received(:puts).with(out)
+  end
+
+  it 'warns properly' do
+    stub_actor = StubPagerdutyCliActor.new
+    out = 'Stub Actor Warning: hi'
+    allow($stderr).to receive(:puts).with(out).and_return(out)
+    stub_actor.warn('hi')
+    expect($stderr).to have_received(:puts).with(out)
+  end
+
+  it 'generates the same key for triggers and resolves' do
+    stub_actor = StubPagerdutyCliActor.new
+    stub_actor.options[:host] = 'foo'
+    stub_actor.options[:event] = 'bar'
+    allow(Digest::SHA1).to receive(:hexdigest).with('foo:bar')
+    stub_actor.incident_key
+    expect(Digest::SHA1).to have_received(:hexdigest).with('foo:bar')
+  end
+
+  it 'generates a valid incident filename' do
+    stub_actor = StubPagerdutyCliActor.new
+    stub_actor.options[:host] = 'foo'
+    stub_actor.options[:event] = 'bar'
+    stub_actor.options[:tmpdir] = '/FAKETEMP'
+    allow(stub_actor).to receive(:incident_key).and_return('x')
+    expect(stub_actor.incident_file).to eq('/FAKETEMP/pagerduty-x')
+  end
+
+  it 'bails when no API key is loaded' do
+    stub_actor = StubPagerdutyCliActor.new
+    stub_actor.options[:api_key_file] = 'nonexistent_file'
+    allow(stub_actor).to receive(:croak)
+    stub_actor.load_data
+    expect(stub_actor).to have_received(:croak)
+  end
+
+  it 'defines the PagerdutyCli::Trigger class' do
+    expect(PagerdutyCli::Trigger).to be_a(Class)
+  end
+
+  it 'processes common PagerdutyCli options' do
+    args = %w(-H foo -k bar -e baz -t /var/tmp)
+    stub_actor = StubPagerdutyCliActor.new
+    stub_optionparser = OptionParser.new
+    stub_actor.parse_common_options(stub_optionparser)
+    stub_optionparser.parse!(args)
+
+    expect(stub_actor.options[:host]).to eq('foo')
+    expect(stub_actor.options[:api_key_file]).to eq('bar')
+    expect(stub_actor.options[:tmpdir]).to eq('/var/tmp')
+    expect(stub_actor.options[:event]).to eq('baz')
+  end
+
+  it 'supports correct defaults' do
+    args = %w(-e foo)
+    stub_actor = StubPagerdutyCliActor.new
+    stub_optionparser = OptionParser.new
+    stub_actor.parse_common_options(stub_optionparser)
+    stub_optionparser.parse!(args)
+    expect(stub_actor.options[:host]).to eq(ENV['HOSTNAME'])
+    expect(stub_actor.options[:api_key_file])
+      .to eq(PagerdutyCli::Common::API_KEY_FILE)
+    expect(stub_actor.options[:tmpdir]).to eq('/tmp')
+    expect(stub_actor.options[:event]).to eq('foo')
+  end
+
+  it 'prints help and exits with -h' do
+    args = %w(-h)
+    stub_actor = StubPagerdutyCliActor.new
+    stub_optionparser = OptionParser.new
+    stub_actor.parse_common_options(stub_optionparser)
+    allow($stderr).to receive(:puts)
+    expect { stub_optionparser.parse!(args) }.to raise_error(SystemExit)
+    expect($stderr).to have_received(:puts)
+  end
+
+  it 'processes trigger options' do
+    args = %w(-f -n -i 600 -e foo)
+    allow_any_instance_of(PagerdutyCli::Trigger).to receive(:load_data)
+    allow_any_instance_of(PagerdutyCli::Trigger)
+      .to receive(:touch_incident_file)
+    allow_any_instance_of(PagerdutyCli::Trigger)
+      .to receive(:incident_is_too_fresh?).and_return(true)
+    PagerdutyCli::Trigger.class_eval('attr_reader :options')
+    trigger = PagerdutyCli::Trigger.new(args)
+
+    expect(trigger.options).to be_a(Hash)
+    expect(trigger.options[:force]).to be_truthy
+    expect(trigger.options[:no_touch]).to be_truthy
+    expect(trigger.options[:interval]).to eq(600)
+    expect(trigger.options[:event]).to eq('foo')
+  end
+
+  it 'places tmp files in the right location' do
+    args = %w(-e foo)
+    allow_any_instance_of(PagerdutyCli::Trigger)
+      .to receive(:incident_is_too_fresh?).and_return(false)
+    allow_any_instance_of(PagerdutyCli::Trigger).to receive(:load_data)
+    trigger = PagerdutyCli::Trigger.new(args)
+    string_buffer = StringIO.new
+    allow(File).to receive(:open).and_return(string_buffer)
+    allow(trigger).to receive(:incident_key).and_return('abc')
+    trigger.send(:touch_incident_file)
+    expect(File).to have_received(:open).with('/tmp/pagerduty-abc', 'a')
+  end
+
+  it 'allows triggers to be sent via class method' do
+    args = %w(-e foo)
+    allow_any_instance_of(PagerdutyCli::Trigger).to receive(:load_data)
+    allow_any_instance_of(PagerdutyCli::Trigger)
+      .to receive(:send_trigger).and_return('bar')
+
+    expect(PagerdutyCli::Trigger.trigger(args)).to eq('bar')
+  end
+
+  it 'defines the PagerdutyCli::Resolve class' do
+    expect(PagerdutyCli::Resolve).to be_a(Class)
+  end
+
+  it 'processes all options to resolve' do
+    args = %w(-H foo -k bar -e baz -t /var/tmp)
+    allow_any_instance_of(PagerdutyCli::Resolve).to receive(:load_data)
+    PagerdutyCli::Resolve.class_eval('attr_reader :options')
+    resolver = PagerdutyCli::Resolve.new(args)
+    expect(resolver.options[:host]).to eq('foo')
+    expect(resolver.options[:api_key_file]).to eq('bar')
+    expect(resolver.options[:event]).to eq('baz')
+    expect(resolver.options[:tmpdir]).to eq('/var/tmp')
+  end
+
+  it 'removes tmp files in the right location' do
+    # stub pagerduty API so we can resolve without getting too deep
+    class FakePagerDuty
+    end
+    my_fake_pagerduty = FakePagerDuty.new
+    allow(my_fake_pagerduty).to receive(:resolve).and_return(true)
+
+    allow_any_instance_of(Pagerduty)
+      .to receive(:get_incident).and_return(my_fake_pagerduty)
+    allow_any_instance_of(PagerdutyCli::Resolve)
+      .to receive(:incident_file).and_return('foo')
+    allow_any_instance_of(PagerdutyCli::Resolve).to receive(:load_data)
+    allow(File).to receive(:delete).with('foo').and_return(true)
+    PagerdutyCli::Resolve.resolve(%w(-e abc))
+    expect(File).to have_received(:delete).with('foo')
+    expect(my_fake_pagerduty).to have_received(:resolve)
+  end
+
+  it 'allows resolves to be sent via class method' do
+    args = %w(-e foo)
+    allow_any_instance_of(PagerdutyCli::Resolve).to receive(:load_data)
+    allow_any_instance_of(PagerdutyCli::Resolve)
+      .to receive(:send_resolve).and_return('bar')
+    expect(PagerdutyCli::Resolve.resolve(args)).to eq('bar')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'pagerduty_cli'
+require 'rspec'
+
+RSpec.configure
+
+# stub for exercising common
+class StubPagerdutyCliActor
+  include PagerdutyCli::Common
+  attr_accessor :options
+  def initialize
+    @me = 'Stub Actor'
+    @options = {}
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: pagerduty_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Justin Dossey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pagerduty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ruby CLI for PagerDuty API. Supports sending triggers and resolves.
+email:
+- justin.dossey@newcontext.com
+executables:
+- pagerduty-resolve
+- pagerduty-trigger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pagerduty-resolve
+- bin/pagerduty-trigger
+- lib/pagerduty_cli.rb
+- lib/pagerduty_cli/common.rb
+- lib/pagerduty_cli/resolve.rb
+- lib/pagerduty_cli/trigger.rb
+- lib/pagerduty_cli/version.rb
+- pagerduty_cli.gemspec
+- spec/pagerduty_cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/justindossey/pagerduty_cli
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: ruby CLI for PagerDuty API
+test_files:
+- spec/pagerduty_cli_spec.rb
+- spec/spec_helper.rb
+has_rdoc: