pagerduty-sdk 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c566e34664d47191d4b62a94200716047dde2a7
-  data.tar.gz: aa2b3c6ad33da171fcce26177f8fba1e304823de
+  metadata.gz: fb62479652d262b0920666828da1fcf7742dde8a
+  data.tar.gz: 4d3ce2efa6fcb9ac163af176f9d406fb1aa431b5
 SHA512:
-  metadata.gz: e46045601e5253ca1bd77883d3b92e2080ad8e6d332c2d8bbdab8b146adb6d5b1a7a2a86c63975d5e3f7ad70dfea493faddeb76a0b0351d8f143278850e64acb
-  data.tar.gz: 5ce61ddb93cd3ef5326bcbd273e1416755454bd6a115822b5d2443571025bb9d7f3062a0a02682ee2af2b105cf43a4f0fd553c335f4203a082bbaec219f861d3
+  metadata.gz: fc7611edc60bb045e1cc14599fc519565b45a05331ae6a0008b5bfdd20ecf197608e53283adc8cc2fae2a0ce7b6e2afc248496d2da2d6a6af46da26c70df2809
+  data.tar.gz: c44e5ff4d83db5e29cd8aedcb3462b05b90e122bd0b3fad820ca76715bf7c32d25f56c9b305a326d86f19e0f009a51c0225baeeae21b938f7c106f2d75b35d44

data/README.md

@@ -1,7 +1,7 @@
 pagerduty-sdk
 =============
 
-pagerduty-sdk is a Ruby Gem for communicating with the
+pagerduty-sdk is a Ruby Gem for communicating with the entire
 [Pagerduty](http://www.pagerduty.com) API. It was designed to be as
 fully object-oriented as possible. Although it is still under some
 construction, it is functional and ready for use. 
@@ -9,160 +9,21 @@ construction, it is functional and ready for use.
 I plan to do much more work on this gem, and your feedback is greatly
 appreciated!
 
-2013-10-31
-=============
-
-I have just pushed my first commit of this gem to Github. I will be
-refactoring a lot of the code (and completing the last couple of
-functions) as soon as I can. Since I haven't generated any documentation
-for the gem, please know that you can pass the parameters as expected by
-any of the API methods below to the functions I've listed at the end of
-this README. 
-
-Example: If the `get_user` Users API method expects a user id, you would
-call the Pagerduty function as follows: `pagerduty.get_user(id:
-"#{USERID}")`
-
-This Gem is under construction!
-
-#### Alerts
-http://developer.pagerduty.com/documentation/rest/alerts
-
-#### Users
-http://developer.pagerduty.com/documentation/rest/users
-
-#### Incidents
-http://developer.pagerduty.com/documentation/rest/incidents
-
-#### Escalation Policies
-http://developer.pagerduty.com/documentation/rest/escalation_policies
-
-#### Escalation Rules
-http://developer.pagerduty.com/documentation/rest/escalation_policies/escalation_rules
-
-#### Log Entries
-http://developer.pagerduty.com/documentation/rest/log_entries
-
-#### Maintenance Windows
-http://developer.pagerduty.com/documentation/rest/maintenance_windows
-
-#### Reports
-http://developer.pagerduty.com/documentation/rest/reports
-
-#### Schedules
-http://developer.pagerduty.com/documentation/rest/schedules
-- [x] GET schedules	List existing on-call schedules.
-- [x] GET schedules/:id	Show detailed information about a schedule, including entries for each layer and sub-schedule.
-- [x] GET schedules/:id/users	List all the users on-call in a given schedule for a given time range.
-- [ ] POST schedules	Create a new on-call schedule.
-- [ ] PUT schedules/:id	Update an existing on-call schedule.
-- [ ] POST schedules/preview	Preview the configuration of an on-call schedule.
-- [ ] DELETE schedules/:id	Delete an on-call schedule.
-- [ ] GET schedules/:id/entries	List schedule entries that are active for a given time range for a specified on-call schedule.
-
-#### Services
-http://developer.pagerduty.com/documentation/rest/services
-- [x] GET services	List existing services.
-- [x] GET services/:id	Get details about an existing service.
-- [x] POST services	Create a new service.
-- [ ] PUT services/:id	Update an existing service.
-- [ ] DELETE services/:id	Delete an existing service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.
-- [ ] PUT services/:id/disable	Disable a service. Once a service is disabled, it will not be able to create incidents until it is enabled again.
-- [ ] PUT services/:id/enable	Enable a previously disabled service.
-- [ ] POST services/:id/regenerate_key	Regenerate a new service key for an existing service.
-
-
+## Requirements
+* Ruby 1.9.3+
+* A Pagerduty account token
 
 ## Installation
-
 ```
 gem install pagerduty-sdk
 ```
 
-
 ## Usage
-
-Example of getting all incidents within the past 24 hours:
-
 ```ruby
 require 'pagerduty'
 
 pagerduty = Pagerduty.new(token: "#{token}", subdomain: "#{subdomain}")
 #<Pagerduty:0x007f9a340fc410>
-
-pagerduty.incidents
-
-[<Pagerduty::Incident
-	id=
-	incident_number=
-	created_on=
-	status=
-	html_url=
-	incident_key=
-	service=#<Service:0x007f9a35106dd8 @id="", @name="", @html_url="", @delete_at=nil>
-	escalation_policy=#<EscalationPolicy:0x007f9a35105168 @id="", @name="", @description=nil, @escalation_rules=[], @services=#<Set: {}>, @num_loops=nil>
-	assigned_to_user=nil
-	trigger_summary_data=#<TriggerSummaryData:0x007f9a3510d6d8 @subject="">
-	trigger_details_html_url=""
-	trigger_type=""
-	last_status_change_on=""
-	last_status_change_by=#<LastStatusChangeBy:0x007f9a3510c440 @id="", @name="", @email="", @html_url="">
-	number_of_escalations=0
-	resolved_by_user=#<ResolvedByUser:0x007f9a3511cd90 @id="", @name="", @email="", @html_url="">
->]
-```
-
-You can filter the incidents returned by their status (triggered,
-acknowledged, resolved) by using the accessor method on the array of
-incidents (`pagerduty.incidents.triggered`)
-
-You can acknowledge or resolve an incident easily by calling the
-`acknowledge` or `resolve` methods of the `Pagerduty::Incident` object
-
-You can also reassign the incident to another user by calling the
-`reassign` method. This method takes accepts a hash with the expected
-API parameters which you can see from the Pagerduty documentation link
-above. 
-
-
-Here's a list of other supported functions (until I have the full
-documentation up)
-
-```
-> pagerduty.interesting_methods
-[
-    [ 0] :alerts,
-    [ 1] :alerts_per_time,
-    [ 2] :create_escalation_policy,
-    [ 3] :create_maintenance_window,
-    [ 4] :create_service,
-    [ 5] :create_user,
-    [ 6] :curl,
-    [ 7] :escalation_policies,
-    [ 8] :escalation_rules,
-    [ 9] :get_escalation_policy,
-    [10] :get_escalation_rule,
-    [11] :get_incident,
-    [12] :get_incident_counts,
-    [13] :get_log_entries,
-    [14] :get_log_entry,
-    [15] :get_maintenance_window,
-    [16] :get_maintenance_windows,
-    [17] :get_schedule,
-    [18] :get_schedule_users,
-    [19] :get_schedules,
-    [20] :get_service,
-    [21] :get_services,
-    [22] :get_user,
-    [23] :get_users,
-    [24] :has_requirements?,
-    [25] :incidents,
-    [26] :incidents_per_time,
-    [27] :notes,
-    [28] :subdomain,
-    [29] :token
-]
 ```
 
-
-
+See [YARD documentation](http://rubydoc.info/gems/pagerduty-sdk/1.0.2/frames) for specific function usage.

data/lib/pagerduty.rb

@@ -8,8 +8,11 @@ require 'net/https'
 require 'uri'
 require 'virtus'
 
+# Core
 require 'pagerduty/core'
 require 'pagerduty/pagerduty'
+
+# Models
 require 'pagerduty/models/report'
 require 'pagerduty/models/agent'
 require 'pagerduty/models/assigneduser'
@@ -25,7 +28,13 @@ require 'pagerduty/models/notification'
 require 'pagerduty/models/log_entry'
 require 'pagerduty/models/channels'
 require 'pagerduty/models/alert'
+require 'pagerduty/models/alerts'
 require 'pagerduty/models/note'
+require 'pagerduty/models/notes'
 require 'pagerduty/models/incident'
+require 'pagerduty/models/incidents'
 require 'pagerduty/models/services'
 
+# Requests
+require 'pagerduty/requests/incident'
+#require 'pagerduty/requests/alerts'

data/lib/pagerduty/core.rb

@@ -1,12 +1,94 @@
-class Array
-
-  def method_missing(meth, *args, &block)
-    if meth.to_s =~ /^(open|triggered|acknowledged|resolved)$/
-      self.select { |incident| incident.status == meth.to_s }
-    else
-      # Call super so we don't mess up ruby's method lookup
-      super
+class Pagerduty
+  module Core
+
+    ###################################################################################
+    # def curl
+    #
+    # Purpose: Performs a CURL request
+    #
+    # Params: options<~Hash> - The options Hash to send
+    #           uri<~String> - The URI to curl
+    #           ssl<~Boolean><Optional> - Whether or not to use SSL
+    #           port<~Integer><Optional> - The port number to connect to
+    #           params<~Hash><Optional> - The params to send in the curl request
+    #           headers<~Hash><Optional> - The headers to send in the curl request
+    #           method<~String> - The HTTP method to perform
+    #           basic_auth<~Hash><Optional>
+    #             user<~String> - Basic auth user
+    #             password<~String> - Basic auth password
+    #
+    # Returns: <String>
+    ###################################################################################
+    def curl(options)
+
+      curl_request = {
+        ssl: true,
+        port: 443,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Token token=#{Pagerduty.class_variable_get(:@@token)}",
+        },
+      }
+
+      options.merge! curl_request
+
+      url = URI.parse(options[:uri])
+
+      if options[:params]
+        parameters = options[:params].map { |k,v| "#{k}=#{v}" }.join("&")
+        url += "?#{parameters}"
+      end
+
+      http = Net::HTTP.new(url.host, 443)
+      http.use_ssl = true
+
+      request = case options[:method]
+                when 'DELETE'
+                  Net::HTTP::Delete.new(url)
+                when 'GET'
+                  Net::HTTP::Get.new(url)
+                when 'POST'
+                  Net::HTTP::Post.new(url)
+                when 'PUT'
+                  Net::HTTP::Put.new(url)
+                end
+
+      if options.has_key?(:data)
+        request.set_form_data(options[:data])
+      end
+
+      if options.has_key?(:basic_auth)
+        request.basic_auth options[:basic_auth][:user], options[:basic_auth][:password]
+      end
+
+      request.body = options[:body]
+
+      options[:headers].each { |key,val| request.add_field(key,val) }
+
+      response = if options[:method] == 'POST'
+                   http.post(url.path,options[:data].to_json,options[:headers])
+                 elsif options[:method] == 'PUT'
+                   http.put(url.path,options[:data].to_json,options[:headers])
+                 else
+                   http.request(request)
+                 end
+
+      options[:raw_response] == true ? response : JSON.parse(response.body)
     end
-  end
 
+
+    # Check a Hash object for expected keys
+    #
+    # ==== Parameters
+    # * 'keys'<~Array><~Object> - An array of objects expected to be found as keys in the supplied Hash
+    # * 'options'<~Hash> - The Hash to perform the check on
+    #
+    # ==== Returns
+    # * Boolean
+    #
+    def has_requirements?(keys,options)
+      (keys - options.keys).empty?
+    end
+
+  end
 end

data/lib/pagerduty/models/alerts.rb

@@ -0,0 +1,6 @@
+class Alerts
+  include Virtus.model
+
+  attribute :alerts, Array[Alert]
+
+end

data/lib/pagerduty/models/escalationpolicies.rb

@@ -52,18 +52,19 @@ class EscalationRule < Pagerduty
   def delete
     res = curl({
       uri: "https://#@@subdomain.pagerduty.com/api/v1/escalation_policies/#{parent_policy.id}/escalation_rules/#{self.id}",
-      method: 'DELETE'
+      method: 'DELETE',
+      raw_response: true
     })
 
     res.code == '200' ? 'Successfully deleted' : JSON.parse(res.body)
   end
 
   def save
-    self.attributes = JSON.parse(curl({
+    self.attributes = curl({
       uri: "https://#@@subdomain.pagerduty.com/api/v1/escalation_policies/#{parent_policy.id}/escalation_rules/#{self.id}",
       data: self.hashify,
       method: 'PUT'
-    }).body)['escalation_rule']
+    })['escalation_rule']
   end
 
 end

data/lib/pagerduty/models/incident.rb

@@ -1,74 +1,26 @@
-class Incident < Pagerduty
-  include Virtus.model
-
-  attribute :id
-  attribute :incident_number
-  attribute :created_on
-  attribute :status
-  attribute :html_url
-  attribute :incident_key
-  attribute :service, Service
-  attribute :escalation_policy, EscalationPolicy
-  attribute :assigned_to_user, AssignedUser
-  attribute :trigger_summary_data, TriggerSummaryData
-  attribute :trigger_details_html_url
-  attribute :trigger_type
-  attribute :last_status_change_on
-  attribute :last_status_change_by, LastStatusChangeBy
-  attribute :number_of_escalations
-  attribute :resolved_by_user, ResolvedByUser
-
-  def inspect
-    puts "<Pagerduty::#{self.class}"
-    self.attributes.each { |attr,val| 
-      puts "\t#{attr}=#{val.class == Class ? "BLOCK" : val.inspect}"
-    }
-    puts ">"
-
-    self.attributes
-  end
-
-  def notes
-    super(self.id)
-  end
-
-  def acknowledge
-    JSON.parse(curl({
-      uri: "https://#@@subdomain.pagerduty.com/api/v1/incidents/#{self.id}/acknowledge",
-      data: { 'requester_id' => self.assigned_to_user.id },
-      method: 'PUT'
-    }).body)
-  end
-
-  def resolve
-    JSON.parse(curl({
-      uri: "https://#@@subdomain.pagerduty.com/api/v1/incidents/#{self.id}/resolve",
-      data: { 'requester_id' => self.assigned_to_user.id },
-      method: 'PUT'
-    }).body)
-  end
-
-  def reassign(options={})
-
-    unless has_requirements?([:escalation_level, :assigned_to_user], options)
-      puts "#> This function requires arguments :escalation_level, :assigned_to_user"
-      puts "Please see: http://developer.pagerduty.com/documentation/rest/incidents/reassign"
-      return
+class Pagerduty
+  class Incidents
+
+    class Incident
+      include Virtus.model
+
+      attribute :id
+      attribute :incident_number
+      attribute :created_on
+      attribute :status
+      attribute :html_url
+      attribute :incident_key
+      attribute :service, Service
+      attribute :escalation_policy, EscalationPolicy
+      attribute :assigned_to_user, AssignedUser
+      attribute :trigger_summary_data, TriggerSummaryData
+      attribute :trigger_details_html_url
+      attribute :trigger_type
+      attribute :last_status_change_on
+      attribute :last_status_change_by, LastStatusChangeBy
+      attribute :number_of_escalations
+      attribute :resolved_by_user, ResolvedByUser
     end
 
-    JSON.parse(curl({
-      uri: "https://#@@subdomain.pagerduty.com/api/v1/incidents/#{self.id}/resolve",
-      data: { 'requester_id' => self.assigned_to_user.id, }.merge(options),
-      method: 'PUT'
-    }).body)
-  end
-
-  def log_entries(options={})
-    LogEntries.new(JSON.parse(curl({
-      uri: "https://#@@subdomain.pagerduty.com/api/v1/incidents/#{self.id}/log_entries",
-      params: options,
-      method: 'GET'
-    }).body))
   end
 end
-

data/lib/pagerduty/models/incidents.rb

@@ -0,0 +1,18 @@
+class Pagerduty
+  class Incidents
+    include Virtus.model
+
+    attribute :incidents, Array[Pagerduty::Incidents::Incident]
+
+    self.instance_eval do
+      %w(triggered open acknowledged resolved).each do |status|
+        define_method(status) {
+          self.incidents.select { |incident|
+            incident.status == "#{status}"
+          }
+        }
+      end
+    end
+
+  end
+end