opsgenie-schedule 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc6e0e949d909c453328c4ad695aebb4b4c05d6aefe60c71926112ed1376f18b
-  data.tar.gz: 7f5732c274402cea99e7be2c595c39bb0008894856aea5678609c471503c0ac8
+  metadata.gz: 30a5116e9d7df158ef1d36af1d2ef9161649ad9daf2f595b9f2baae6024752ac
+  data.tar.gz: fa55ef6189912822f61e5c89a8d3d0277898fadb4e24bdab10f1919477716a7e
 SHA512:
-  metadata.gz: e48d76aa2f7e2cbb6f1b27f33f9626c315ebfe5695acac88dedb39cb290ec96592039332999b41505e505ed2884e407b0993636d62a178d70b46e374684933f5
-  data.tar.gz: 672a690dd7a6f9713a1922df8f7f0227052137b29a1cbe7052dda7c2a3db047745bde455634905ab10642cc5516da41dc58e4f946f70e1a7e03bee1db58d1110
+  metadata.gz: 59feea9672af23f41393fd19c8f214df82167d289205534ff21eae7bb60ce565da504480816124849408eec2b94e42f26062f5fd7e7f6fcf630af64cc1d8fe66
+  data.tar.gz: 2b4133e8e963682a795e4044d79b41334d6892423ef710a82e0cae450cf7368113f251f7b042260dc6e50aa9c893e0d64fda59705304aaf2fe2d38f35137abfd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    opsgenie-schedule (0.1.0)
+    opsgenie-schedule (0.1.1)
       httparty (~> 0.17)
 
 GEM
@@ -16,12 +16,12 @@ GEM
     diff-lcs (1.3)
     dotenv (2.7.5)
     hashdiff (1.0.0)
-    httparty (0.17.1)
+    httparty (0.18.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     jaro_winkler (1.5.3)
     method_source (0.9.2)
-    mime-types (3.3)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.1009)
     multi_xml (0.6.0)
@@ -81,4 +81,4 @@ DEPENDENCIES
   webmock (~> 3.5)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -50,7 +50,10 @@ You can then fetch the people scheduled for today like so:
 
 ```ruby
 schedule.on_calls
-#=> ["someone@example.com", "someone-else@example.com"]
+#=> [
+#     <Opsgenie::User @full_name="Someone", @id=1234, @username="someone@example.com">,
+#     <Opsgenie::User @full_name="Someone Else", @id=1236, @username="somesomeone-elseone@example.com">
+#]
 ```
 
 Or a given date time like so:
@@ -58,7 +61,64 @@ Or a given date time like so:
 ```ruby
 date = DateTime.parse("2019-01-01T10:00:00")
 schedule.on_calls(date)
-#=> ["someone@example.com", "someone-else@example.com"]
+#=> [
+#     <Opsgenie::User @full_name="Someone", @id=1234, @username="someone@example.com">,
+#     <Opsgenie::User @full_name="Someone Else", @id=1236, @username="somesomeone-elseone@example.com">
+#]
+```
+
+You can also fetch a timeline for a schedule:
+
+```ruby
+schedule.timeline
+```
+
+Or a specific rotation:
+
+```ruby
+schedule.rotation[0].timeline
+```
+
+You can also specify where you want a timeline to start from:
+
+```ruby
+schedule.timeline(date: Date.parse("2019-01-01"))
+# => [#<Opsgenie::TimelineRotation:0x00007f9b2f974cb8
+#   @id="69e7d46d-538e-4fca-95d0-5c316a54424e",
+#   @name="On Call Phone",
+#   @periods=
+#    [#<Opsgenie::TimelinePeriod:0x00007f9b2f974c40
+#      @end_date=#<DateTime: 2019-12-05T11:55:29+00:00 ((2458823j,42929s,816000000n),+0s,2299161j)>,
+#      @start_date=#<DateTime: 2019-12-02T00:00:00+00:00 ((2458820j,0s,0n),+0s,2299161j)>,
+#      @user=
+#       #<Opsgenie::User:0x00007f9b2f329520
+#        @full_name="On Call Phone",
+#        @id="19e39115-07d5-4924-8295-332a66dd1569",
+#        @username="systems@dxw.com">>,
+#     ...]
+#    ],
+#    ...
+#   ]
+#  >
+```
+
+As well as the interval you want to see a timeline for:
+
+```ruby
+# `interval_unit` can be one of `:days`, `:weeks` or `:months`
+schedule.timeline(interval: 1, interval_unit: :months)
+#=> [...]
+```
+
+These options also work for a rotation's timeline too:
+
+```ruby
+schedule.rotation[0].timeline(
+  date: Date.parse("2019-01-01"),
+  interval: 1,
+  interval_unit: :months
+)
+#=> <Opsgenie::TimelineRotation:0x00007f9b2f974cb8>
 ```
 
 ## Development

data/lib/opsgenie.rb

@@ -3,7 +3,10 @@ require "httparty"
 require "opsgenie/client"
 require "opsgenie/schedule"
 require "opsgenie/rotation"
+require "opsgenie/user"
 require "opsgenie/config"
+require "opsgenie/timeline_rotation"
+require "opsgenie/timeline_period"
 
 module Opsgenie
   def self.configure(api_key:)

data/lib/opsgenie/rotation.rb

@@ -35,7 +35,17 @@ module Opsgenie
       )
 
       on_calls = schedule.on_calls((time + 60).to_datetime)
-      on_calls.select { |name| participant_usernames.include?(name) }
+      on_calls.select { |user| participant_usernames.include?(user.username) }
+    end
+
+    def timeline(date: Date.today, interval: nil, interval_unit: nil)
+      rotations = schedule.timeline(
+        date: date,
+        interval: interval,
+        interval_unit: interval_unit
+      )
+
+      rotations.find { |r| r.name == name }
     end
 
     private

data/lib/opsgenie/schedule.rb

@@ -32,9 +32,22 @@ module Opsgenie
 
     def on_calls(datetime = nil)
       endpoint = "schedules/#{id}/on-calls"
-      endpoint += "?date=#{CGI.escape datetime.to_s}" unless datetime.nil?
+      endpoint += "?date=#{escape_datetime(datetime)}" unless datetime.nil?
       body = Opsgenie::Client.get(endpoint)
-      get_participants(body).map { |u| u["name"] }
+      get_participants(body).map { |u| User.find_by_username(u["name"]) }
+    end
+
+    def timeline(date: Date.today, interval: nil, interval_unit: nil)
+      check_interval_unit(interval_unit) if interval_unit
+
+      datetime = date.to_datetime
+      endpoint = "schedules/#{id}/timeline?date=#{escape_datetime(datetime)}"
+      endpoint += "&interval=#{interval}" if interval
+      endpoint += "&intervalUnit=#{interval_unit}" if interval_unit
+      body = Opsgenie::Client.get(endpoint)
+      body.dig("data", "finalTimeline", "rotations").map do |rotation|
+        TimelineRotation.new(rotation)
+      end
     end
 
     private
@@ -44,5 +57,19 @@ module Opsgenie
         p["type"] == "user"
       end
     end
+
+    def escape_datetime(datetime)
+      CGI.escape(datetime.to_s)
+    end
+
+    def check_interval_unit(value)
+      return if valid_intervals.include?(value)
+
+      raise ArgumentError, "`interval_unit` must be one of `#{valid_intervals}``"
+    end
+
+    def valid_intervals
+      %i[days weeks months]
+    end
   end
 end

data/lib/opsgenie/timeline_period.rb

@@ -0,0 +1,10 @@
+module Opsgenie
+  class TimelinePeriod
+    attr_reader :start_date, :end_date, :user
+    def initialize(attrs)
+      @start_date = DateTime.parse(attrs["startDate"])
+      @end_date = DateTime.parse(attrs["endDate"])
+      @user = Opsgenie::User.find(attrs["recipient"]["id"])
+    end
+  end
+end

data/lib/opsgenie/timeline_rotation.rb

@@ -0,0 +1,11 @@
+module Opsgenie
+  class TimelineRotation
+    attr_reader :id, :name, :periods
+
+    def initialize(attrs)
+      @id = attrs["id"]
+      @name = attrs["name"]
+      @periods = attrs["periods"].map { |p| TimelinePeriod.new(p) }
+    end
+  end
+end

data/lib/opsgenie/user.rb

@@ -0,0 +1,35 @@
+require "date"
+
+module Opsgenie
+  class User
+    class << self
+      def all
+        body = Opsgenie::Client.get("users?limit=500")
+        body["data"].map { |s| new(s) }
+      end
+
+      def find_by_username(username)
+        find_by(:username, username)
+      end
+
+      def find(id)
+        find_by(:id, id)
+      end
+
+      private
+
+      def find_by(key, value)
+        @users ||= all
+        @users.find { |user| user.send(key) == value }
+      end
+    end
+
+    attr_reader :id, :username, :full_name
+
+    def initialize(attrs)
+      @id = attrs["id"]
+      @username = attrs["username"]
+      @full_name = attrs["fullName"]
+    end
+  end
+end

data/opsgenie-schedule.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = "opsgenie-schedule"
-  spec.version = "0.1.0"
+  spec.version = "0.1.1"
   spec.authors = ["Stuart Harrison"]
   spec.email = ["stuart@dxw.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opsgenie-schedule
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stuart Harrison
@@ -145,6 +145,9 @@ files:
 - lib/opsgenie/config.rb
 - lib/opsgenie/rotation.rb
 - lib/opsgenie/schedule.rb
+- lib/opsgenie/timeline_period.rb
+- lib/opsgenie/timeline_rotation.rb
+- lib/opsgenie/user.rb
 - opsgenie-schedule.gemspec
 homepage: https://github.com/dxw/opsgenie-schedule
 licenses: