statusio 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20f98eab4d744044c7cd98bf147b18200815e798
-  data.tar.gz: db1d27c8b34afbd260321557748f87cba6f2c25f
+SHA256:
+  metadata.gz: c0d2d7fc197b696855cc36d6aeab847f3b9166b4f4bb22c403d8782880748e0d
+  data.tar.gz: cd6bdee45fa6289f06c2035c2508bc26bb6d00019829ded80f3c7c61145d72d8
 SHA512:
-  metadata.gz: 765e9b5707282ed3b1e475d43f9cb0d09a8d4b7cf2acccddcd8e7444bf7717927d5577f6769e217a4bf5ec1a87bc5d79086257712579d87226a7fa141570666e
-  data.tar.gz: 6663584894fa49ac6be57983c548883802cb2ae69fc127c138d1f39ebbdafd34f0657cc589f90d791dc3ef56bc052361d49cb8a2f0b38b7bead86b701d0c446c
+  metadata.gz: f5e598031a868cd774b1cb69b50b16780fc6a533d8bcdfe4ea6ebdf2689bfcc95f84615544a1bb9470e9b72c2e7b56e7034dd711fb23cee5d2c0834b86a53afa
+  data.tar.gz: 2c7e0a2ae553f90841b51d4f96ba1ca47ff1c3bddd661b0ec029ed516607115db769fc9edd50cf52fef629b1f69854af8a9cc6e2cf6ed0605613204656b8d18c

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## Change Log
+
+### v0.3.0 (2021/5/17)
+- Added Microsoft Teams
+
+### v0.2.9 (2020/2/17)
+- Fixed the ordering of the message_subject argument for the incident/maintenance methods which was breaking backwards compatibility
+
+### v0.2.8 (2020/2/14)
+- Fix silent parameter type
+
+### v0.2.7 (2020/2/10)
+- Adding message_subject to all incident and maintenance methods
+
+### v0.2.6 (2019/3/26)
+- Force rest-client gem to be version 1.8.0
+
+### v0.2.5 (2018/11/28)
+- Changed variables to proper type (int->str)
+
+### v0.2.4 (2018/2/9)
+- Support retrieving single incident/maintenance events. New incident/maintenance methods to fetch list of IDs
+- Change /component/status/update to use a single component
+
+### v0.2.3 (2017/12/20)
+- Updated incident/create to handle infrastructure_affected combo
+
+### v0.2.2 (2017/12/14)
+- Updated maintenance/schedule to handle infrastructure_affected combos
+
+### v0.2.1 (2016/2/11)
+- Refactor API calls into a #request method (@seanhandley)
+- Depend on rest-client gem in runtime (@Nowaker)
+
+### v0.1.0 (2016/1/19)
+- Initial release

data/Gemfile

@@ -2,7 +2,7 @@ require 'rbconfig'
 
 source 'https://rubygems.org'
 
-gem 'rest-client'
+gem 'rest-client', '=1.8.0'
 
 group :test do
 	gem 'rspec'

data/lib/statusio.rb

@@ -25,6 +25,7 @@ class StatusioClient
   NOTIFY_IRC = 16
   NOTIFY_HIPCHAT = 32
   NOTIFY_SLACK = 64
+  NOTIFY_MSTEAMS = 128
 
   def initialize(api_key, api_id)
     @api_key = api_key
@@ -50,7 +51,8 @@ class StatusioClient
       'social' => '0',
       'irc' => '0',
       'hipchat' => '0',
-      'slack' => '0'
+      'slack' => '0',
+      'msteams' => '0'
     }
 
     if notifications & NOTIFY_EMAIL == NOTIFY_EMAIL
@@ -81,6 +83,10 @@ class StatusioClient
       notify['slack'] = '1'
     end
 
+    if notifications & NOTIFY_MSTEAMS == NOTIFY_MSTEAMS
+      notify['msteams'] = '1'
+    end
+
     return notify
   end
 
@@ -191,9 +197,10 @@ class StatusioClient
   # @param current_state(int) The state of this incident (StatusioClient::STATE_#).
   # @param notifications(int) Bitmasked notifications (StatusioClient::NOTIFY_#). To use multiple just add them up (ie StatusioClient::NOTIFY_SMS + StatusioClient::NOTIFY_SLACK).
   # @param all_infrastructure_affected(string) Affect all components and containers (default = 0)
+  # @param message_subject(string) Message subject for email notifications (default = Status Notification)
   # @return object
 
-  def incident_create(statuspage_id, incident_name, incident_details, infrastructure_affected, current_status, current_state, notifications = 0, all_infrastructure_affected = "0")
+  def incident_create(statuspage_id, incident_name, incident_details, infrastructure_affected, current_status, current_state, notifications = 0, all_infrastructure_affected = "0", message_subject = "Status Notification")
     data = get_notify(notifications)
     data['statuspage_id'] = statuspage_id
     data['incident_name'] = incident_name
@@ -202,6 +209,7 @@ class StatusioClient
     data['current_status'] = current_status
     data['current_state'] = current_state
     data['all_infrastructure_affected'] = all_infrastructure_affected
+    data['message_subject'] = message_subject
 
     request :method  => :post,
     	      :url     => @url + 'incident/create',
@@ -217,15 +225,17 @@ class StatusioClient
   # @param current_status(int) The status of the components and containers affected by this incident (StatusioClient::STATUS_#).
   # @param current_state(int) The state of this incident (StatusioClient::STATE_#).
   # @param notifications(int) Bitmasked notifications (StatusioClient::NOTIFY_#). To use multiple just add them up (ie StatusioClient::NOTIFY_SMS + StatusioClient::NOTIFY_SLACK).
+  # @param message_subject(string) Message subject for email notifications (default = Status Notification)
   # @return object
 
-  def incident_update(statuspage_id, incident_id, incident_details, current_status, current_state, notifications = 0)
+  def incident_update(statuspage_id, incident_id, incident_details, current_status, current_state, notifications = 0, message_subject = "Status Notification")
     data = get_notify(notifications)
     data['statuspage_id'] = statuspage_id
     data['incident_id'] = incident_id
     data['incident_details'] = incident_details
     data['current_status'] = current_status
     data['current_state'] = current_state
+    data['message_subject'] = message_subject
 
     request :method  => :post,
             :url     => @url + 'incident/update',
@@ -241,15 +251,17 @@ class StatusioClient
   # @param current_status(int) The status of the components and containers affected by this incident (StatusioClient::STATUS_#).
   # @param current_state(int) The state of this incident (StatusioClient::STATE_#).
   # @param notifications(int) Bitmasked notifications (StatusioClient::NOTIFY_#). To use multiple just add them up (ie StatusioClient::NOTIFY_SMS + StatusioClient::NOTIFY_SLACK).
+  # @param message_subject(string) Message subject for email notifications (default = Status Notification)
   # @return object
 
-  def incident_resolve(statuspage_id, incident_id, incident_details, current_status, current_state, notifications = 0)
+  def incident_resolve(statuspage_id, incident_id, incident_details, current_status, current_state, notifications = 0, message_subject = "Status Notification")
     data = get_notify(notifications)
     data['statuspage_id'] = statuspage_id
     data['incident_id'] = incident_id
     data['incident_details'] = incident_details
     data['current_status'] = current_status
     data['current_state'] =current_state
+    data['message_subject'] = message_subject
 
     request :method  => :post,
             :url     => @url + 'incident/resolve',
@@ -340,13 +352,14 @@ class StatusioClient
   # @param maintenance_notify_1_hr(string) Notify subscribers 1 hour before scheduled maintenance start time (1 = Send notification)
   # @param maintenance_notify_24_hr(string) Notify subscribers 24 hours before scheduled maintenance start time (1 = Send notification)
   # @param maintenance_notify_72_hr(string) Notify subscribers 72 hours before scheduled maintenance start time (1 = Send notification)
+  # @param message_subject(string) Message subject for email notifications (default = Maintenance Notification)
   # @return object
 
   def maintenance_schedule(statuspage_id, maintenance_name, maintenance_details, infrastructure_affected,
                            date_planned_start, time_planned_start, date_planned_end, time_planned_end,
                            automation = "0", all_infrastructure_affected = "0",
                            maintenance_notify_now = "0", maintenance_notify_1_hr = "0",
-                           maintenance_notify_24_hr = "0", maintenance_notify_72_hr = "0")
+                           maintenance_notify_24_hr = "0", maintenance_notify_72_hr = "0", message_subject = "Maintenance Notification")
     data = {}
     data['statuspage_id'] = statuspage_id
     data['maintenance_name'] = maintenance_name
@@ -362,6 +375,7 @@ class StatusioClient
     data['maintenance_notify_1_hr'] = maintenance_notify_1_hr
     data['maintenance_notify_24_hr'] = maintenance_notify_24_hr
     data['maintenance_notify_72_hr'] = maintenance_notify_72_hr
+    data['message_subject'] = message_subject
 
     request :method  => :post,
             :url     => @url + 'maintenance/schedule',
@@ -375,13 +389,15 @@ class StatusioClient
   # @param maintenance_id(string) Maintenance ID
   # @param maintenance_details(string) Message describing this maintenance update
   # @param notifications(int) Bitmasked notifications (StatusioClient::NOTIFY_#). To use multiple just add them up (ie StatusioClient::NOTIFY_SMS + StatusioClient::NOTIFY_SLACK).
+  # @param message_subject(string) Message subject for email notifications (default = Maintenance Notification)
   # @return object
 
-  def maintenance_start(statuspage_id, maintenance_id, maintenance_details, notifications = 0)
+  def maintenance_start(statuspage_id, maintenance_id, maintenance_details, notifications = 0, message_subject = "Maintenance Notification")
     data = get_notify(notifications)
     data['statuspage_id'] = statuspage_id
     data['maintenance_id'] = maintenance_id
     data['maintenance_details'] = maintenance_details
+    data['message_subject'] = message_subject
 
     request :method  => :post,
             :url     => @url + 'maintenance/start',
@@ -395,13 +411,15 @@ class StatusioClient
   # @param maintenance_id(string) Maintenance ID
   # @param maintenance_details(string) Message describing this maintenance
   # @param notifications(int) Bitmasked notifications (StatusioClient::NOTIFY_#). To use multiple just add them up (ie StatusioClient::NOTIFY_SMS + StatusioClient::NOTIFY_SLACK).
+  # @param message_subject(string) Message subject for email notifications (default = Maintenance Notification)
   # @return object
 
-  def maintenance_update(statuspage_id, maintenance_id, maintenance_details, notifications = 0)
+  def maintenance_update(statuspage_id, maintenance_id, maintenance_details, notifications = 0, message_subject = "Maintenance Notification")
     data = get_notify(notifications)
     data['statuspage_id'] = statuspage_id
     data['maintenance_id'] = maintenance_id
     data['maintenance_details'] = maintenance_details
+    data['message_subject'] = message_subject
 
     request :method  => :post,
             :url     => @url + 'maintenance/update',
@@ -415,13 +433,15 @@ class StatusioClient
   # @param maintenance_id(string) Maintenance ID
   # @param maintenance_details(string) Message describing this maintenance
   # @param notifications(int) Bitmasked notifications (StatusioClient::NOTIFY_#). To use multiple just add them up (ie StatusioClient::NOTIFY_SMS + StatusioClient::NOTIFY_SLACK).
+  # @param message_subject(string) Message subject for email notifications (default = Maintenance Notification)
   # @return object
 
-  def maintenance_finish(statuspage_id, maintenance_id, maintenance_details, notifications = 0)
+  def maintenance_finish(statuspage_id, maintenance_id, maintenance_details, notifications = 0, message_subject = "Maintenance Notification")
     data = get_notify(notifications)
     data['statuspage_id'] = statuspage_id
     data['maintenance_id'] = maintenance_id
     data['maintenance_details'] = maintenance_details
+    data['message_subject'] = message_subject
 
     request :method  => :post,
             :url     => @url + 'maintenance/finish',
@@ -522,11 +542,11 @@ class StatusioClient
   # @param statuspage_id(string) Status page ID
   # @param method(string) Communication method of subscriber. Valid methods are `email`, `sms` or `webhook`
   # @param address(string) Subscriber address (SMS number must include country code ie. +1)
-  # @param silent(int) Supress the welcome message (1 = Do not send notification)
+  # @param silent(string) Suppress the welcome message (1 = Do not send notification)
   # @param granular(string) List of component_container combos
   # @return object
 
-  def subscriber_add(statuspage_id, method, address, silent = 1, granular = '')
+  def subscriber_add(statuspage_id, method, address, silent = '1', granular = '')
     data = {}
     data['statuspage_id'] = statuspage_id
     data['method'] = method

data/lib/statusio/rb/version.rb

@@ -1,3 +1,3 @@
 class StatusioClient
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statusio
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Status.io
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -35,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby library wrapper for Status.io