pagerduty_utils 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2734f9242e51882171cf33ec55745551f2ca150d
-  data.tar.gz: 82bc1e579955359c49ef711a768f9920239cd911
+  metadata.gz: b78ef3120e4fcfc5c4579c60e349ff7ccca904ab
+  data.tar.gz: 5a1df5a97c35c826f4c41767ac81488195a21f5d
 SHA512:
-  metadata.gz: fb9671f772b4516e211821437a326b46b81d1aa077b5ea5f0ee56493e04294be11d8830854e423103cfde5adfe1e58a8b7af035236b899620f603d72bf685262
-  data.tar.gz: aaa11e2a2934c29f44b3fc07f8a20cece9d43c080057385525f5df382007305883af1f41cb5f1e608f4399d968e0e738fa4cd413dd7e8abb53c3ba4139402957
+  metadata.gz: 0f0e66729f30f8ac6c05a9574d9214bab47a8380068cb0435d96b819b01df5a761a197072e4863e5a8538f71cd45affb6f1e84e7787c567b14f2c3d423de7fe3
+  data.tar.gz: 51beffa82f6a8f690c2f172bb5bcf893da676a7d4f7e5fc523129f57505a5e336e9ab59199257e47c6db83f222f80a657a093cb0fce60ecfd9acccd514a29051

data/bin/pgutils

@@ -1,16 +1,16 @@
 #!/usr/bin/env ruby -w
-require 'optparse'
+
 require 'pagerduty/base'
-require 'pagerduty/override'
 
-def load_trigger(trigger_name)
+def load_trigger(trigger_name, message)
   config_file = "#{ENV['PAGERDUTY_CONFIG_DIR'] ? ENV['PAGERDUTY_CONFIG_DIR'] + 'triggers.yml' : ENV['HOME'] + '/.pgutils/triggers.yaml'}"
- if File.readable?(config_file)
+  if File.readable?(config_file)
     triggers = YAML.load_file(config_file)
   else
     abort("#{config_file} not found")
   end
-  pg = TapJoy::PagerDuty::Base.new
+  pg = Tapjoy::PagerDuty::Base.new
+  triggers[trigger_name.to_sym][:description] = message if message
   puts pg.post_trigger(**triggers[trigger_name.to_sym])
 end
 
@@ -22,93 +22,42 @@ def get_level_one_users(pg)
   end
 end
 
-options = {}
-
-subtext = <<HELP
-Supported commands are:
-  set_override :
-  trigger :
-  get_on_call :
-
-See '#{File.basename(__FILE__)} COMMAND --help' for more information on a specific command.
-HELP
-
-global = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename(__FILE__)} [options] [subcommand [options]]"
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options[:verbose] = v
-  end
-  opts.separator ""
-  opts.separator subtext
+SUB_COMMANDS = %w(set_override trigger get_on_call)
+Trollop::options do
+  usage '[SUB_COMMAND] [options]'
+  synopsis "\nTool to integrate with PagerDuty API.\nAvailable subcommands are: #{SUB_COMMANDS}"
+  version "#{File.basename($0)} #{Tapjoy::PagerDuty::VERSION} \u00A9 2014-2015 Tapjoy, Inc."
+  stop_on SUB_COMMANDS
 end
 
-subcommands = {
-  'set_override' => OptionParser.new do |opts|
-    opts.banner = <<-EOS
-
-    Usage: #{File.basename(__FILE__)} set_override [options]
-
-    This code is used to temporarily override the primary person on-call for a given schedule.
-
-    EOS
-
-    opts.on('-e', '--email EMAIL', 'Specify email address of override user') do |e|
-      options[:email] = e
-    end
-    opts.on('-s', '--schedule-name SCHEDULE', 'Name of schedule to override') do |s|
-      options[:schedule_name] = s
-    end
-    opts.on('-t', '--override-length TIME', 'Number of seconds to maintain override for') do |t|
-      options[:override_length] = t.to_i
-    end
-  end,
-
-  'trigger' => OptionParser.new do |opts|
-    opts.banner = <<-EOS
-
-    Usage: #{File.basename(__FILE__)} trigger [options]
-
-    This script will create a pagerduty alert, based on the name of the trigger
-    hash as specified in 'triggers.yaml'
-
-    EOS
-
-    opts.on("-t", "--trigger TRIGGER", 'Name of trigger to alert on') do |t|
-      options[:trigger] = t
-    end
-  end,
-
-  'get_on_call' => OptionParser.new do |opts|
-    opts.banner = <<-EOS
-
-    Usage: #{File.basename(__FILE__)} get_on_call
-
-    This script will return the list of each person on-call sorted by schedule.
-    There are no options available for this command at this time.
-
-    EOS
+cmd = ARGV.shift
+case cmd
+when 'set_override'
+  opts = Trollop::options do
+    usage 'set_override [options]'
+    synopsis "\nTemporarily override the primary person on-call for a given schedule."
+    opt(:email, 'Specify email address of override user', required: true, :type => :string)
+    opt(:schedule_name, 'Name of schedule to override', default: 'Default', :type => :string)
+    opt(:override_length, 'Number of seconds to maintain override for', default: 3600, :type => :int)
   end
-}
 
-global.order!
-command = ARGV.shift
-begin
-  subcommands[command].order!
-rescue NoMethodError
-  abort("Invalid Input.\n\n#{subtext}")
-end
-
-case command
+  Tapjoy::PagerDuty::Override.new(opts[:email], opts[:schedule_name], opts[:override_length])
 when 'trigger'
-  raise OptionParser::MissingArgument if options[:trigger].nil?
-  load_trigger(options[:trigger])
-when 'set_override'
-  raise OptionParser::MissingArgument if options[:email].nil?
-  options[:schedule_name] = 'Default' if options[:schedule_name].nil?
-  options[:override_length] = 3600 if options[:override_length].nil?
-  TapJoy::PagerDuty::Override.new(options[:email], options[:schedule_name], options[:override_length])
+  opts = Trollop::options do
+    usage 'trigger [options]'
+    synopsis "\nThis script will create a pagerduty alert, based on the name of the trigger hash as specified in 'triggers.yaml'"
+    opt :trigger, 'Name of trigger to alert on', required: true, type: :string
+    opt :message, 'Message to include in trigger', type: :string
+  end
+
+  load_trigger(opts[:trigger], opts[:message])
 when 'get_on_call'
-  pg = TapJoy::PagerDuty::Base.new
+  Trollop::options do
+    usage 'get_on_call'
+    synopsis "\nThis script will return the list of each person on-call sorted by schedule.\nThere are no options available for this command at this time."
+  end
+
+  pg = Tapjoy::PagerDuty::Base.new
   get_level_one_users(pg).each do |u|
     user = pg.get_user_details(u)['user']
     on_call = user['on_call']
@@ -122,5 +71,5 @@ when 'get_on_call'
     puts '---'
   end
 else
- abort("Unknown command: #{command}")
+  Trollop::educate
 end

data/lib/pagerduty/base.rb

@@ -1,133 +1,137 @@
 require 'httparty'
 require 'json'
 require 'yaml'
-
-module TapJoy
-  module PagerDuty; end
-end
-
-class TapJoy::PagerDuty::Base
-
-  # Initializer services to import values from pg_connect.yaml
-  # to configure organization-specific values (currently, subdomain and api_token)
-  def initialize
-    config_file = "#{ENV['PAGERDUTY_CONFIG_DIR'] ? ENV['PAGERDUTY_CONFIG_DIR'] + 'triggers.yml' : ENV['HOME'] + '/.pgutils/triggers.yaml'}"
-    pg_conn = YAML.load_file(config_file) if File.readable?(config_file)
-
-    @AUTH_HEADER = {
-      :subdomain    => ENV['PAGERDUTY_SUBDOMAIN'] || pg_conn[:subdomain],
-      :token_string => "Token token=#{ENV['PAGERDUTY_API_TOKEN'] || pg_conn[:api_token]}"
-    }
-
-    raise 'Missing subdomain value' if @AUTH_HEADER[:subdomain].nil?
-    raise 'Missing API token' if @AUTH_HEADER[:token_string].nil?
-  end
-
-  # Given an email address return the user_id that pagerduty uses for lookups
-  def get_user_id(email)
-    endpoint = return_pagerduty_url(:users)
-    out_array = get_object(endpoint)['users'].select { |i| i['email'].eql?(email) }
-    return Hash[*out_array]['id']
-  end
-
-  # Given the name of a schedule return the schedule_id that pagerduty uses for lookups
-  def get_schedule_id(schedule_name)
-    endpoint = return_pagerduty_url(:schedules)
-    out_array = get_object(endpoint)['schedules'].select { |i| i['name'].eql?(schedule_name)}
-    return Hash[*out_array]['id']
-  end
-
-  # The set_override method takes in several variables and returns
-  # the REST response upon (attempting) completion of an override action
-  def set_override(query_start:, query_end:, override_start:, override_end:,
-    user_id:, schedule_id:)
-    # Ruby 2.x style kw-args is required here to make hash passing easier
-
-    endpoint = "#{return_pagerduty_url(:schedules)}/#{schedule_id}/overrides?since=#{query_start}&until=#{query_end}"
-
-    data = {
-      override: {
-        user_id: user_id,
-        start: override_start,
-        end: override_end,
-      }
-    }
-
-    post_object(endpoint, data)
-  end
-
-  # Return all users on call for all schedules, which we can parse through later
-  def get_users_on_call
-    endpoint = return_pagerduty_url(:escalation_on_call)
-    return get_object(endpoint)
-  end
-
- # Given a specific user, return all details about the
- # user that we can parse through as needed
-  def get_user_details(user_id)
-    endpoint = return_pagerduty_url(:users) + "/#{user_id}/on_call"
-    return get_object(endpoint)
-  end
-
-  # Create a page to the first person on call for a given service key
-  def post_trigger(service_key:, incident_key:, description:, client:,
-    client_url:, details:)
-
-    # Ruby 2.x style kw-args is required here to make hash passing easier
-    endpoint = return_pagerduty_url(:create_trigger)
-    data = {
-      service_key: service_key,
-      incident_key: incident_key,
-      event_type: 'trigger',
-      description: description,
-      client: client,
-      client_url: client_url,
-      details: details,
-    }
-
-    post_object(endpoint, data)
-  end
-
-  private
-  # Helper method for all GETs
-  def get_object(endpoint)
-    response = HTTParty.get(
-      endpoint,
-      headers: {
-        'Content-Type' => 'application/json', 'Authorization' => @AUTH_HEADER[:token_string]
-      }
-    )
-    return JSON.load(response.body)
-  end
-
-  # Helper method for all PUTs
-  def post_object(endpoint, data)
-    response = HTTParty.post(
-      endpoint,
-      body: data.to_json,
-      headers: {
-        'Content-Type' => 'application/json', 'Authorization' => @AUTH_HEADER[:token_string]
-      }
-    )
-
-    return response.body
-  end
-
-  # Helper method for building PagerDuty URLs
-  def return_pagerduty_url(object_type)
-    rest_api_url = "https://#{@AUTH_HEADER[:subdomain]}.pagerduty.com/api/v1"
-    incident_api_url = 'https://events.pagerduty.com/generic/2010-04-15'
-    case object_type
-    when :users
-      return rest_api_url + '/users'
-    when :schedules
-      return rest_api_url + '/schedules'
-    when :escalation_on_call
-      return rest_api_url + '/escalation_policies/on_call'
-    when :create_trigger
-      return incident_api_url + '/create_event.json'
-    else
-      abort("Unknown object type: #{object_type}. Can't build URL.")
+require 'date'
+require 'trollop'
+require 'pagerduty/override'
+require_relative 'version'
+
+module Tapjoy
+  module PagerDuty
+    class Base
+
+      # Initializer services to import values from pg_connect.yaml
+      # to configure organization-specific values (currently, subdomain and api_token)
+      def initialize
+        config_file = "#{ENV['PAGERDUTY_CONFIG_DIR'] ? ENV['PAGERDUTY_CONFIG_DIR'] + 'pgconnect.yml' : ENV['HOME'] + '/.pgutils/pgconnect.yaml'}"
+        pg_conn = YAML.load_file(config_file) if File.readable?(config_file)
+
+        @AUTH_HEADER = {
+          :subdomain    => ENV['PAGERDUTY_SUBDOMAIN'] || pg_conn[:subdomain],
+          :token_string => "Token token=#{ENV['PAGERDUTY_API_TOKEN'] || pg_conn[:api_token]}"
+        }
+
+        raise 'Missing subdomain value' if @AUTH_HEADER[:subdomain].nil?
+        raise 'Missing API token' if @AUTH_HEADER[:token_string].nil?
+      end
+
+      # Given an email address return the user_id that pagerduty uses for lookups
+      def get_user_id(email)
+        endpoint = return_pagerduty_url(:users)
+        out_array = get_object(endpoint)['users'].select { |i| i['email'].eql?(email) }
+        return Hash[*out_array]['id']
+      end
+
+      # Given the name of a schedule return the schedule_id that pagerduty uses for lookups
+      def get_schedule_id(schedule_name)
+        endpoint = return_pagerduty_url(:schedules)
+        out_array = get_object(endpoint)['schedules'].select { |i| i['name'].eql?(schedule_name)}
+        return Hash[*out_array]['id']
+      end
+
+      # The set_override method takes in several variables and returns
+      # the REST response upon (attempting) completion of an override action
+      def set_override(query_start:, query_end:, override_start:, override_end:,
+        user_id:, schedule_id:)
+        # Ruby 2.x style kw-args is required here to make hash passing easier
+
+        endpoint = "#{return_pagerduty_url(:schedules)}/#{schedule_id}/overrides?since=#{query_start}&until=#{query_end}"
+
+        data = {
+          override: {
+            user_id: user_id,
+            start: override_start,
+            end: override_end,
+          }
+        }
+
+        post_object(endpoint, data)
+      end
+
+      # Return all users on call for all schedules, which we can parse through later
+      def get_users_on_call
+        endpoint = return_pagerduty_url(:escalation_on_call)
+        return get_object(endpoint)
+      end
+
+     # Given a specific user, return all details about the
+     # user that we can parse through as needed
+      def get_user_details(user_id)
+        endpoint = return_pagerduty_url(:users) + "/#{user_id}/on_call"
+        return get_object(endpoint)
+      end
+
+      # Create a page to the first person on call for a given service key
+      def post_trigger(service_key:, incident_key:, description:, client:,
+        client_url:, details:)
+
+        # Ruby 2.x style kw-args is required here to make hash passing easier
+        endpoint = return_pagerduty_url(:create_trigger)
+        data = {
+          service_key: service_key,
+          incident_key: incident_key,
+          event_type: 'trigger',
+          description: description,
+          client: client,
+          client_url: client_url,
+          details: details,
+        }
+
+        post_object(endpoint, data)
+      end
+
+      private
+      # Helper method for all GETs
+      def get_object(endpoint)
+        response = HTTParty.get(
+          endpoint,
+          headers: {
+            'Content-Type' => 'application/json', 'Authorization' => @AUTH_HEADER[:token_string]
+          }
+        )
+        return JSON.load(response.body)
+      end
+
+      # Helper method for all PUTs
+      def post_object(endpoint, data)
+        response = HTTParty.post(
+          endpoint,
+          body: data.to_json,
+          headers: {
+            'Content-Type' => 'application/json', 'Authorization' => @AUTH_HEADER[:token_string]
+          }
+        )
+
+        return response.body
+      end
+
+      # Helper method for building PagerDuty URLs
+      def return_pagerduty_url(object_type)
+        rest_api_url = "https://#{@AUTH_HEADER[:subdomain]}.pagerduty.com/api/v1"
+        incident_api_url = 'https://events.pagerduty.com/generic/2010-04-15'
+        case object_type
+        when :users
+          return rest_api_url + '/users'
+        when :schedules
+          return rest_api_url + '/schedules'
+        when :escalation_on_call
+          return rest_api_url + '/escalation_policies/on_call'
+        when :create_trigger
+          return incident_api_url + '/create_event.json'
+        else
+          abort("Unknown object type: #{object_type}. Can't build URL.")
+        end
+      end
     end
   end
 end

data/lib/pagerduty/override.rb

@@ -1,41 +1,38 @@
-require 'pagerduty/base'
-require 'date'
-
-module TapJoy
-  module PagerDuty; end
-end
-
-class TapJoy::PagerDuty::Override
-
-  # Initializer services to import values from pg_connect.yaml
-  # to configure organization-specific values (currently, subdomain and api_token)
-  def initialize(email, schedule_name, override_length)
-    pg = TapJoy::PagerDuty::Base.new
-    override_window_hash = override_window(override_length)
-    puts pg.set_override(**query_dates, **override_window_hash,
-      user_id: pg.get_user_id(email),
-      schedule_id: pg.get_schedule_id(schedule_name) # case-sensitive
-    )
-  end
-
-  private
-  def time_string(time_object)
-    return time_object.iso8601.to_s
-  end
-
-  def query_dates
-    # This shrinks the query to a one-day window
-    since_date = time_string(Time.now)
-    until_date = time_string((Time.now + (1*86400)))
-
-    return {query_start: since_date, query_end: until_date}
-  end
-
-  def override_window(override_time)
-    from_time = Time.now.iso8601.to_s
-    # 3600 is number of seconds, change this to alter the override window
-    until_time = (Time.now + override_time).iso8601.to_s
-
-    return {override_start: from_time, override_end: until_time}
+module Tapjoy
+  module PagerDuty
+    class Override
+
+      # Initializer services to import values from pg_connect.yaml
+      # to configure organization-specific values (currently, subdomain and api_token)
+      def initialize(email, schedule_name, override_length)
+        pg = Tapjoy::PagerDuty::Base.new
+        override_window_hash = override_window(override_length)
+        puts pg.set_override(**query_dates, **override_window_hash,
+          user_id: pg.get_user_id(email),
+          schedule_id: pg.get_schedule_id(schedule_name) # case-sensitive
+        )
+      end
+
+      private
+      def time_string(time_object)
+        return time_object.iso8601.to_s
+      end
+
+      def query_dates
+        # This shrinks the query to a one-day window
+        since_date = time_string(Time.now)
+        until_date = time_string((Time.now + (1*86400)))
+
+        return {query_start: since_date, query_end: until_date}
+      end
+
+      def override_window(override_time)
+        from_time = Time.now.iso8601.to_s
+        # 3600 is number of seconds, change this to alter the override window
+        until_time = (Time.now + override_time).iso8601.to_s
+
+        return {override_start: from_time, override_end: until_time}
+      end
+    end
   end
 end

data/lib/pagerduty/version.rb

@@ -0,0 +1,11 @@
+module Tapjoy
+  module PagerDuty
+    module Version
+      MAJOR = 0
+      MINOR = 2
+      PATCH = 0
+    end
+
+    VERSION = [Version::MAJOR, Version::MINOR, Version::PATCH].join('.')
+  end
+end

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: pagerduty_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ali Tayarani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
-dependencies: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: A set of tools to make leveraging the PagerDuty APIs easier
 email: ali.tayarani@tapjoy.com
 executables:
@@ -20,6 +76,7 @@ files:
 - bin/pgutils
 - lib/pagerduty/base.rb
 - lib/pagerduty/override.rb
+- lib/pagerduty/version.rb
 homepage: https://github.com/tapjoy/pagerduty_utils
 licenses:
 - MIT
@@ -43,5 +100,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: TapJoy PagerDuty Tools
+summary: Tapjoy PagerDuty Tools
 test_files: []