flapjack-diner 2.0.0.pre.alpha.2 → 2.0.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac8e83fdc9d402c3e60acfeb01b64a0d8f352ad6
-  data.tar.gz: ce8eecce83ca64e01dca304c8a453eb019c5c313
+  metadata.gz: 599102638a3e2c603d40621b1a2ce0dfc90617e2
+  data.tar.gz: 34d37da6991efd2358a854edb134c32e780abd08
 SHA512:
-  metadata.gz: d5b3c08505bea0ed12897b2b437cc418f6194f09d4d6041a8155b86be638b5f8ce86538d1be8d30deb969c46c45db07f1ae959dc59ce8a6255c7ae292f308251
-  data.tar.gz: e741106cde2ec5631730f27708f0d775c806250c6850f3c05d6559e218ec2e635b888923265caab155cc97ea424448778bb000ead02340ef5f7e9db99868bdaf
+  metadata.gz: 75f53d41a4a2a7535e3462b5a1ae679337fe983fb2e15423ad64e9d041f94b7c2fd2b83f2a90bd09bc6e898a584468977757c72e92be15d87416569b28586c5f
+  data.tar.gz: d53cd21dfbec4da23832197bc0b8f1bc5b7a20df927a7c5f9dc524b9486929ee178cfb9882fe474617349aba0fb227204a0cef053ab2bb9aefd017cdd208a709

data/README.md

@@ -7,7 +7,7 @@
 
 Access the JSON API of a [Flapjack](http://flapjack.io/) system monitoring server.
 
-Please note that the following documentation refers to the `v2.0.0-alpha.1` pre-release of this gem. You may instead be looking for [documentation for the latest stable version](https://github.com/flapjack/flapjack-diner/blob/maint/1.x/README.md).
+Please note that the following documentation refers to the `v2.0.0-alpha.3` pre-release of this gem. You may instead be looking for [documentation for the latest stable version](https://github.com/flapjack/flapjack-diner/blob/maint/1.x/README.md).
 
 ## Installation
 
@@ -84,12 +84,19 @@ If any operation fails (returning nil), the `Flapjack::Diner.last_error` method
 * <a name="contents_update_media">&nbsp;</a>[update_media](#update_media)
 * <a name="contents_delete_media">&nbsp;</a>[delete_media](#delete_media)
 
-### <a name="contents_section_rules">&nbsp;</a>[Rules](#section_rules)
+### <a name="contents_section_acceptors">&nbsp;</a>[Acceptors](#section_acceptors)
 
-* <a name="contents_create_rules">&nbsp;</a>[create_rules](#create_rules)
-* <a name="contents_rules">&nbsp;</a>[rules](#get_rules)
-* <a name="contents_update_rules">&nbsp;</a>[update_rules](#update_rules)
-* <a name="contents_delete_rules">&nbsp;</a>[delete_rules](#delete_rules)
+* <a name="contents_create_acceptors">&nbsp;</a>[create_acceptors](#create_acceptors)
+* <a name="contents_acceptors">&nbsp;</a>[acceptors](#get_acceptors)
+* <a name="contents_update_acceptors">&nbsp;</a>[update_acceptors](#update_acceptors)
+* <a name="contents_delete_acceptors">&nbsp;</a>[delete_acceptors](#delete_acceptors)
+
+### <a name="contents_section_rejectors">&nbsp;</a>[Rejectors](#section_rejectors)
+
+* <a name="contents_create_rejectors">&nbsp;</a>[create_rejectors](#create_rejectors)
+* <a name="contents_rejectors">&nbsp;</a>[rejectors](#get_rejectors)
+* <a name="contents_update_rejectors">&nbsp;</a>[update_rejectors](#update_rejectors)
+* <a name="contents_delete_rejectors">&nbsp;</a>[delete_rejectors](#delete_rejectors)
 
 ### <a name="contents_section_tags">&nbsp;</a>[Tags](#section_tags)
 
@@ -303,7 +310,8 @@ Flapjack::Diner.create_media(MEDIUM, MEDIUM, ...)
   :pagerduty_token => STRING,         # required (if transport == 'pagerduty')
   :pagerduty_ack_duration => INTEGER, # required (if transport == 'pagerduty')
   :contact => CONTACT_ID,             # required
-  :rules => [RULE_ID, RULE_ID, ...]
+  :acceptors => [ACCEPTOR_ID, ACCEPTOR_ID, ...],
+  :rejectors => [REJECTOR_ID, REJECTOR_ID, ...]
 }
 ```
 
@@ -339,7 +347,7 @@ Flapjack::Diner.update_media({MEDIUM_ID, KEY => VALUE, ...}, {MEDIUM_ID, KEY =>
 
 Acceptable update field keys are
 
-`:address`, `:interval`, `:rollup_threshold`, `:pagerduty_subdomain`, `:pagerduty_token`, `:pagerduty_ack_duration` and `:rules`
+`:address`, `:interval`, `:rollup_threshold`, `:pagerduty_subdomain`, `:pagerduty_token`, `:pagerduty_ack_duration`, `:acceptors` and `:rejectors`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -364,31 +372,115 @@ Returns true if deletion succeeded or false if deletion failed.
 
 ---
 
-<a name="section_rules">&nbsp;</a>
-### Rules [^](#contents_section_rules)
+<a name="section_acceptors">&nbsp;</a>
+### Acceptors [^](#contents_section_acceptors)
 
-<a name="create_rules">&nbsp;</a>
-#### create_rules
+<a name="create_acceptors">&nbsp;</a>
+#### create_acceptors
 
-Create one or more notification rules.
+Create one or more notification acceptors.
 
 ```ruby
-Flapjack::Diner.create_rules(RULE, ...)
+Flapjack::Diner.create_acceptors(ACCEPTOR, ...)
 ```
 
 **FIXME** time_restrictions data structure isn't handled yet
 
-**FIXME** should empty `conditions_list` implicitly specify blackhole -- thus
-remove the `is_blackhole` boolean?
+```ruby
+# ACCEPTOR
+{
+  :id              => UUID_STRING,
+  :name            => STRING,
+  :all             => BOOLEAN,          # apply to all checks, ignore tag linkages
+  :conditions_list => STRING,           # which conditions the acceptor will match;
+                                        # all if empty, or comma-separated subset
+                                        # of 'critical,warning,unknown'
+  :contact         => CONTACT_ID,       # required
+  :media           => [MEDIUM_ID, ...]
+  :tags            => [TAG_NAME, ...]
+}
+```
+
+Returns false if creation failed, or the created object(s) if it succeeded.
+
+[^](#contents_create_acceptors)
+
+<a name="get_acceptors">&nbsp;</a>
+#### acceptors
+
+Return data for one, some or all notification acceptors.
+
+```ruby
+acceptor = Flapjack::Diner.acceptors(ACCEPTOR_ID)
+some_acceptors = Flapjack::Diner.acceptors(ACCEPTOR_ID, ACCEPTOR_ID, ...)
+first_page_of_acceptors = Flapjack::Diner.acceptors
+```
+
+[^](#contents_acceptors)
+
+<a name="update_acceptors">&nbsp;</a>
+#### update_acceptors
+
+Update data for one or more notification acceptors.
+
+```ruby
+# update values for one acceptor
+Flapjack::Diner.update_acceptors(:id => ACCEPTOR_ID, KEY => VALUE, ...)
+
+# update values for multiple acceptors
+Flapjack::Diner.update_acceptors({:id => ACCEPTOR_ID, KEY => VALUE, ...}, {:id => ACCEPTOR_ID, KEY => VALUE, ...})
+```
+
+Acceptable update field keys are
+
+  `:conditions_list`, `:is_blackhole`, `:media` and `:tags`
+
+Returns true if updating succeeded or false if updating failed.
+
+[^](#contents_update_acceptors)
+
+<a name="delete_acceptors">&nbsp;</a>
+#### delete_acceptors
+
+Delete one or more notification acceptors.
 
 ```ruby
-# RULE
+# delete one acceptor
+Flapjack::Diner.delete_acceptors(ACCEPTOR_ID)
+
+# delete multiple acceptors
+Flapjack::Diner.delete_acceptors(ACCEPTOR_ID, ACCEPTOR_ID, ...)
+```
+
+Returns true if deletion succeeded or false if deletion failed.
+
+[^](#contents_delete_acceptors)
+
+---
+
+<a name="section_rejectors">&nbsp;</a>
+### Rules [^](#contents_section_rejectors)
+
+<a name="create_rejectors">&nbsp;</a>
+#### create_rejectors
+
+Create one or more notification rejectors.
+
+```ruby
+Flapjack::Diner.create_rejectors(REJECTOR, ...)
+```
+
+**FIXME** time_restrictions data structure isn't handled yet
+
+```ruby
+# REJECTOR
 {
   :id              => UUID_STRING,
-  :conditions_list => STRING,           # which conditions the rule will match;
+  :name            => STRING,
+  :all             => BOOLEAN,          # apply to all checks, ignore tag linkages
+  :conditions_list => STRING,           # which conditions the rejector will match;
                                         # all if empty, or comma-separated subset
                                         # of 'critical,warning,unknown'
-  :is_blackhole    => BOOLEAN,
   :contact         => CONTACT_ID,       # required
   :media           => [MEDIUM_ID, ...]
   :tags            => [TAG_NAME, ...]
@@ -397,32 +489,32 @@ remove the `is_blackhole` boolean?
 
 Returns false if creation failed, or the created object(s) if it succeeded.
 
-[^](#contents_create_rules)
+[^](#contents_create_rejectors)
 
-<a name="get_rules">&nbsp;</a>
-#### rules
+<a name="get_rejectors">&nbsp;</a>
+#### rejectors
 
-Return data for one, some or all notification rules.
+Return data for one, some or all notification rejectors.
 
 ```ruby
-rule = Flapjack::Diner.rules(RULE_ID)
-some_rules = Flapjack::Diner.rules(RULE_ID, RULE_ID, ...)
-first_page_of_rules = Flapjack::Diner.rules
+rejector = Flapjack::Diner.rejectors(REJECTOR_ID)
+some_rejectors = Flapjack::Diner.rejectors(REJECTOR_ID, REJECTOR_ID, ...)
+first_page_of_rejectors = Flapjack::Diner.rejectors
 ```
 
-[^](#contents_rules)
+[^](#contents_rejectors)
 
-<a name="update_rules">&nbsp;</a>
-#### update_rules
+<a name="update_rejectors">&nbsp;</a>
+#### update_rejectors
 
-Update data for one or more notification rules.
+Update data for one or more notification rejectors.
 
 ```ruby
-# update values for one rule
-Flapjack::Diner.update_rules(:id => RULE_ID, KEY => VALUE, ...)
+# update values for one rejector
+Flapjack::Diner.update_rejectors(:id => REJECTOR_ID, KEY => VALUE, ...)
 
-# update values for multiple rules
-Flapjack::Diner.update_rules({:id => RULE_ID, KEY => VALUE, ...}, {:id => RULE_ID, KEY => VALUE, ...})
+# update values for multiple rejectors
+Flapjack::Diner.update_rejectors({:id => REJECTOR_ID, KEY => VALUE, ...}, {:id => REJECTOR_ID, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
@@ -431,24 +523,24 @@ Acceptable update field keys are
 
 Returns true if updating succeeded or false if updating failed.
 
-[^](#contents_update_rules)
+[^](#contents_update_rejectors)
 
-<a name="delete_rules">&nbsp;</a>
-#### delete_rules
+<a name="delete_rejectors">&nbsp;</a>
+#### delete_rejectors
 
-Delete one or more notification rules.
+Delete one or more notification rejectors.
 
 ```ruby
-# delete one rule
-Flapjack::Diner.delete_rules(RULE_ID)
+# delete one rejector
+Flapjack::Diner.delete_rejectors(REJECTOR_ID)
 
-# delete multiple rules
-Flapjack::Diner.delete_rules(RULE_ID, RULE_ID, ...)
+# delete multiple rejectors
+Flapjack::Diner.delete_rejectors(REJECTOR_ID, REJECTOR_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
 
-[^](#contents_delete_rules)
+[^](#contents_delete_rejectors)
 
 ---
 
@@ -467,9 +559,10 @@ Flapjack::Diner.create_tags(TAG, ...)
 ```ruby
 # TAG
 {
-  :name    => STRING,         # required
-  :checks  => [CHECK_ID, ...]
-  :rules   => [RULE_ID, ...]
+  :name      => STRING,         # required
+  :checks    => [CHECK_ID, ...],
+  :acceptors => [ACCEPTOR_ID, ...],
+  :rejectors => [REJECTOR_ID, ...]
 }
 ```
 
@@ -505,7 +598,7 @@ Flapjack::Diner.update_tags({:id => TAG_NAME, KEY => VALUE, ...}, {:id => TAG_NA
 
 Acceptable update field keys are
 
-  `:checks` and `:rules`
+  `:checks`, `:acceptors` and `:rejectors`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -771,29 +864,35 @@ first_page_of_statistics = Flapjack::Diner.statistics
 <a name="common_options_get_include">&nbsp;</a>
 ### Associated data allowed for the include parameter
 
-| Method    |  Association | Assoc. Type |
-|-----------|--------------|-------------|
-| `.checks` | 'alerting_media'    | ['medium', ...] |
-| `.checks` | 'contacts'    | ['contact', ...] |
-| `.checks` | 'current_scheduled_maintenances'    | ['scheduled_maintenance', ...] |
-| `.checks` | 'current_state'    | 'state' |
-| `.checks` | 'current_unscheduled_maintenance'    | 'unscheduled_maintenance' |
-| `.checks` | 'latest_notifications'    | ['state', ...] |
-| `.checks` | 'tags'    | ['tag', ...] |
-| `.contacts` | 'checks' | ['check', ...] |
-| `.contacts` | 'media' | ['medium', ...] |
-| `.contacts` | 'rules' | ['rule', ...] |
-| `.media` | 'alerting_checks' | ['check', ...] |
-| `.media` | 'contact' | 'contact' |
-| `.media` | 'rules' | ['rule', ...] |
-| `.rules` | 'contact' | 'contact' |
-| `.rules` | 'media' | ['medium', ...] |
-| `.rules` | 'tags'    | ['tag', ...] |
-| `.scheduled_maintenances` | 'check' | 'check' |
-| `.states` | 'check' | 'check' |
-| `.tags` | 'checks' | ['check', ...] |
-| `.tags` | 'rules' | ['rule', ...] |
-| `.unscheduled_maintenances` | 'check' | 'check' |
+| Method                      |  Association                      | Assoc. Type                    |
+|-----------------------------|-----------------------------------|--------------------------------|
+| `.checks`                   | 'alerting_media'                  | ['medium', ...]                |
+| `.checks`                   | 'contacts'                        | ['contact', ...]               |
+| `.checks`                   | 'current_scheduled_maintenances'  | ['scheduled_maintenance', ...] |
+| `.checks`                   | 'current_state'                   | 'state'                        |
+| `.checks`                   | 'current_unscheduled_maintenance' | 'unscheduled_maintenance'      |
+| `.checks`                   | 'latest_notifications'            | ['state', ...]                 |
+| `.checks`                   | 'tags'                            | ['tag', ...]                   |
+| `.contacts`                 | 'acceptors'                       | ['acceptor', ...]              |
+| `.contacts`                 | 'checks'                          | ['check', ...]                 |
+| `.contacts`                 | 'media'                           | ['medium', ...]                |
+| `.contacts`                 | 'rejectors'                       | ['rejector', ...]              |
+| `.media`                    | 'acceptors'                       | ['acceptor', ...]              |
+| `.media`                    | 'alerting_checks'                 | ['check', ...]                 |
+| `.media`                    | 'contact'                         | 'contact'                      |
+| `.media`                    | 'rejectors'                       | ['rejector', ...]              |
+| `.acceptors`                | 'contact'                         | 'contact'                      |
+| `.acceptors`                | 'media'                           | ['medium', ...]                |
+| `.acceptors`                | 'tags'                            | ['tag', ...]                   |
+| `.rejectors`                | 'contact'                         | 'contact'                      |
+| `.rejectors`                | 'media'                           | ['medium', ...]                |
+| `.rejectors`                | 'tags'                            | ['tag', ...]                   |
+| `.scheduled_maintenances`   | 'check'                           | 'check'                        |
+| `.states`                   | 'check'                           | 'check'                        |
+| `.tags`                     | 'acceptors'                       | ['acceptor', ...]              |
+| `.tags`                     | 'checks'                          | ['check', ...]                 |
+| `.tags`                     | 'rejectors'                       | ['acceptor', ...]              |
+| `.unscheduled_maintenances` | 'check'                           | 'check'                        |
 
 NB: these may be chained, as long as they follow the allowed paths above; e.g.
 
@@ -834,22 +933,32 @@ check_link_states(check_id, opts = {})
 check_link_tags(check_id, opts = {})
 check_link_unscheduled_maintenances(check_id, opts = {})
 
+contact_link_acceptors(contact_id, opts = {})
 contact_link_checks(contact_id, opts = {})
 contact_link_media(contact_id, opts = {})
-contact_link_rules(contact_id, opts = {})
+contact_link_rejectors(contact_id, opts = {})
 
+medium_link_acceptors(medium_id, opts = {})
 medium_link_alerting_checks(medium_id, opts = {})
 medium_link_contact(medium_id, opts = {})
-medium_link_rules(medium_id, opts = {})
+medium_link_rejectors(medium_id, opts = {})
 
-rule_link_contact(rule_id, opts = {})
-rule_link_media(rule_id, opts = {})
-rule_link_tags(rule_id, opts = {})
+acceptor_link_contact(acceptor_id, opts = {})
+acceptor_link_media(acceptor_id, opts = {})
+acceptor_link_tags(acceptor_id, opts = {})
+
+rejector_link_contact(rejector_id, opts = {})
+rejector_link_media(rejector_id, opts = {})
+rejector_link_tags(rejector_id, opts = {})
 
 state_link_check(state_id, opts = {})
 
+tag_link_acceptors(tag_name, opts = {})
 tag_link_checks(tag_name, opts = {})
-tag_link_rules(tag_name, opts = {})
+tag_link_rejectors(tag_name, opts = {})
+tag_link_scheduled_maintenances(tag_name, opts = {})
+tag_link_states(tag_name, opts = {})
+tag_link_unscheduled_maintenances(tag_name, opts = {})
 ```
 
 All returned results are paginated, and the [common options for GET requests](#common_options_get) apply here too.
@@ -857,32 +966,48 @@ All returned results are paginated, and the [common options for GET requests](#c
 <a name="object_relationships_write">&nbsp;</a>
 ### Manipulating object relationships
 
-The following operations are supported; please note that some associations (e.g. associating a rule with a contact) must be made on object creation, via the secondary resource's create method, and cannot be altered later.
+The following operations are supported; please note that some associations (e.g. associating an acceptor with a contact) must be made on object creation, via the secondary resource's create method, and cannot be altered later.
 
 ```
 create_check_link_tags(check_id, *tags_names)
 update_check_link_tags(check_id, *tags_names)
 delete_check_link_tags(check_id, *tags_names)
 
-create_medium_link_rules(medium_id, *rules_ids)
-update_medium_link_rules(medium_id, *rules_ids)
-delete_medium_link_rules(medium_id, *rules_ids)
+create_medium_link_acceptors(medium_id, *acceptors_ids)
+update_medium_link_acceptors(medium_id, *acceptors_ids)
+delete_medium_link_acceptors(medium_id, *acceptors_ids)
+
+create_medium_link_rejectors(medium_id, *rejectors_ids)
+update_medium_link_rejectors(medium_id, *rejectors_ids)
+delete_medium_link_rejectors(medium_id, *rejectors_ids)
 
-create_rule_link_media(rule_id, *media_ids)
-update_rule_link_media(rule_id, *media_ids)
-delete_rule_link_media(rule_id, *media_ids)
+create_acceptor_link_media(acceptor_id, *media_ids)
+update_acceptor_link_media(acceptor_id, *media_ids)
+delete_acceptor_link_media(acceptor_id, *media_ids)
 
-create_rule_link_tags(rule_id, *tags_names)
-update_rule_link_tags(rule_id, *tags_names)
-delete_rule_link_tags(rule_id, *tags_names)
+create_acceptor_link_tags(acceptor_id, *tags_names)
+update_acceptor_link_tags(acceptor_id, *tags_names)
+delete_acceptor_link_tags(acceptor_id, *tags_names)
+
+create_rejector_link_media(rejector_id, *media_ids)
+update_rejector_link_media(rejector_id, *media_ids)
+delete_rejector_link_media(rejector_id, *media_ids)
+
+create_rejector_link_tags(rejector_id, *tags_names)
+update_rejector_link_tags(rejector_id, *tags_names)
+delete_rejector_link_tags(rejector_id, *tags_names)
 
 create_tag_link_checks(tag_name, *checks_ids)
 update_tag_link_checks(tag_name, *checks_ids)
 delete_tag_link_checks(tag_name, *checks_ids)
 
-create_tag_link_rules(tag_name, *rules_ids)
-update_tag_link_rules(tag_name, *rules_ids)
-delete_tag_link_rules(tag_name, *rules_ids)
+create_tag_link_acceptors(tag_name, *acceptors_ids)
+update_tag_link_acceptors(tag_name, *acceptors_ids)
+delete_tag_link_acceptors(tag_name, *acceptors_ids)
+
+create_tag_link_rejectors(tag_name, *rejectors_ids)
+update_tag_link_rejectors(tag_name, *rejectors_ids)
+delete_tag_link_rejectors(tag_name, *rejectors_ids)
 ```
 
 <a name="object_relationships_write_create">&nbsp;</a>

data/lib/flapjack-diner.rb

@@ -4,7 +4,7 @@ require 'json'
 require 'flapjack-diner/version'
 require 'flapjack-diner/argument_validator'
 
-%w(blackholes checks contacts events maintenance_periods media metrics rules
+%w(acceptors checks contacts events maintenance_periods media metrics rejectors
    states statistics tags relationships).each do |resource|
   require "flapjack-diner/resources/#{resource}"
 end
@@ -26,14 +26,14 @@ module Flapjack
     class << self
       attr_accessor :logger, :return_keys_as_strings
 
-      include Flapjack::Diner::Resources::Blackholes
+      include Flapjack::Diner::Resources::Acceptors
       include Flapjack::Diner::Resources::Checks
       include Flapjack::Diner::Resources::Contacts
       include Flapjack::Diner::Resources::Events
       include Flapjack::Diner::Resources::MaintenancePeriods
       include Flapjack::Diner::Resources::Media
       include Flapjack::Diner::Resources::Metrics
-      include Flapjack::Diner::Resources::Rules
+      include Flapjack::Diner::Resources::Rejectors
       include Flapjack::Diner::Resources::States
       include Flapjack::Diner::Resources::Statistics
       include Flapjack::Diner::Resources::Tags