flapjack-diner 2.0.0.a4 → 2.0.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c35872e6ac3464aaa55a68f56f14e464ed851018
-  data.tar.gz: 242e30931014bbf5e742d9d1dfe6708442439733
+  metadata.gz: 4ce62bf38cc938f3b7f88f30ba160950e3e5cd1c
+  data.tar.gz: 0490002709d57e4d15b6d3ca7e71c13381177c40
 SHA512:
-  metadata.gz: 6439ef7da96c974172b711920a157e51a5ed79ae659ca3bf9e6578487eaf35171faec21c66599d1e24950ddb3abafca343deff733d41e24ed46e423ad65f735a
-  data.tar.gz: a8c25af98f5c8bd73b798b7f47359222e6a77a8ddbdb731a429df82c201055461c08ff17f84ab92e1e357ee5017488a7ef12b217902efc58cf8b7a298664c64f
+  metadata.gz: 48f6e46083c60efbd5f0b644270123aecd49d384ea73bc04200e081c906532774f6de9635fb58a5992ee6bb8eb93716e91603a5ae6a50368fd3bc3376e2e21be
+  data.tar.gz: 40a15fc6103dd47ec15aac237d983b44f8ec0ce38e4f8a184acd8de0930fa7b146b0a84c1ca20b49708ce95689600e82517516e98974df1e847aa99a34d6c490

data/.travis.yml

@@ -5,17 +5,12 @@ rvm:
 - '2.1'
 - '2.2'
 cache: bundler
-script: "bundle exec rspec"
+script: bundle exec rspec
 notifications:
   irc:
     channels:
-      - 'irc.freenode.net#flapjack'
+    - irc.freenode.net#flapjack
     template:
-      - '%{message} %{repository}#%{build_number} (%{branch} - %{commit} : %{author})'
-  hipchat:
-    template:
-      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}
-        (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
-    format: html
-    rooms:
-      secure: BfENxsVOSS6YKJn/kMr8ctXTvOvZHHlpgRN8AWshCEEaorPwFlCwlQuEYz+DSR7COjwLNZav5xnTFRaPkcCG8wc4ztMgSdv9XkrGjwJHxEEIzsjPT556LtLF4d8U2Di1MNsD6YGU7kvvzhh5hAPpEn0LBGhYlz+TCv+XCjI8/6I=
+    - "%{message} %{repository}#%{build_number} (%{branch} - %{commit} : %{author})"
+  slack:
+    secure: OSSVSOzOOsGV58lo88tiXQiOlFt4YeRz7yQ0r2kaGV1IFpCISbLxMPTCR6qyngGJWV/QB7cgfKs39xUiAD/bU0cqz1D8BgnhLjRKcU53CymMEWV6s/TTyCgoQy+b/7DM3d7ebvEySS7fxWtApJ/DdpqbkhcgGJbNMIpaXuWd5Ro=

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.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).
+Please note that the following documentation refers to the `v2.0.0b1` 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
 
@@ -45,7 +45,7 @@ Flapjack::Diner.open_timeout(30)
 Flapjack::Diner.read_timeout(300)
 ```
 
-If you want the old behaviour wrt returning hashes with keys as strings (they're now symbols by default) then:
+If you want the old behaviour with respect to returning hashes with keys as strings (they're now symbols by default) then:
 
 ```ruby
 Flapjack::Diner.return_keys_as_strings = true
@@ -55,8 +55,8 @@ Flapjack::Diner.return_keys_as_strings = true
 
 Options for all of **flapjack-diner**'s functions are organised as either:
 
-* Ids &emdash; One or more String or Integer values; or
-* Parameters &emdash; One or more Hashes
+* Ids -- One or more String or Integer values; or
+* Parameters -- One or more Hashes
 
 While these can be passed in in any order, the convention is that they will be ordered as listed above.
 
@@ -84,19 +84,12 @@ 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_acceptors">&nbsp;</a>[Acceptors](#section_acceptors)
+### <a name="contents_section_rules">&nbsp;</a>[Rules](#section_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_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_section_tags">&nbsp;</a>[Tags](#section_tags)
 
@@ -143,10 +136,12 @@ Flapjack::Diner.create_checks(CHECK, ...)
 ```
 CHECK
 {
-  :id      => STRING,
+  :id      => UUID_STRING,
   :name    => STRING,
   :enabled => BOOLEAN,
-  :tags    => [TAG_NAME, ...]
+  :initial_failure_delay => INTEGER,
+  :repeat_failure_delay => INTEGER,
+  :tags    => [UUID_STRING, ...]
 }
 ```
 
@@ -160,8 +155,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all checks.
 
 ```ruby
-check = Flapjack::Diner.checks(CHECK_ID)
-some_checks = Flapjack::Diner.checks(CHECK_ID, CHECK_ID, ...)
+check = Flapjack::Diner.checks(UUID_STRING)
+some_checks = Flapjack::Diner.checks(UUID_STRING, UUID_STRING, ...)
 first_page_of_checks = Flapjack::Diner.checks
 ```
 
@@ -174,15 +169,15 @@ Update data for one or more checks.
 
 ```ruby
 # update values for one check
-Flapjack::Diner.update_checks(CHECK_ID, KEY => VALUE, ...)
+Flapjack::Diner.update_checks(UUID_STRING, KEY => VALUE, ...)
 
 # update values for multiple checks
-Flapjack::Diner.update_checks({CHECK_ID, KEY => VALUE, ...}, {CHECK_ID, KEY => VALUE, ...})
+Flapjack::Diner.update_checks({UUID_STRING, KEY => VALUE, ...}, {UUID_STRING, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-`:enabled`, `:name` and `:tags`
+`:enabled`, `:name`, `:initial_failure_delay`, `:repeat_failure_delay` and `:tags`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -195,10 +190,10 @@ Delete one or more checks.
 
 ```ruby
 # delete one check
-Flapjack::Diner.delete_checks(CHECK_ID)
+Flapjack::Diner.delete_checks(UUID_STRING)
 
 # delete multiple check
-Flapjack::Diner.delete_checks(CHECK_ID, CHECK_ID, ...)
+Flapjack::Diner.delete_checks(UUID_STRING, UUID_STRING, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -219,13 +214,13 @@ Create one or more contacts.
 Flapjack::Diner.create_contacts(CONTACT, ...)
 ```
 
-```
-CONTACT
+```ruby
+# CONTACT
 {
-  :id => STRING,
+  :id => UUID_STRING,
   :name => STRING,
   :timezone => STRING,
-  :tags => [TAG_NAME, ...]
+  :tags => [UUID_STRING, ...]
 }
 ```
 
@@ -239,8 +234,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all contacts.
 
 ```ruby
-contact = Flapjack::Diner.contacts(CONTACT_ID)
-some_contacts = Flapjack::Diner.contacts(CONTACT_ID, CONTACT_ID, ...)
+contact = Flapjack::Diner.contacts(UUID_STRING)
+some_contacts = Flapjack::Diner.contacts(UUID_STRING, UUID_STRING, ...)
 first_page_of_contacts = Flapjack::Diner.contacts
 ```
 
@@ -253,10 +248,10 @@ Update data for one or more contacts.
 
 ```ruby
 # update values for one contact
-Flapjack::Diner.update_contacts(CONTACT_ID, KEY => VALUE, ...)
+Flapjack::Diner.update_contacts(UUID_STRING, KEY => VALUE, ...)
 
 # update values for multiple contacts
-Flapjack::Diner.update_contacts({CONTACT_ID, KEY => VALUE, ...}, {CONTACT_ID, KEY => VALUE, ...})
+Flapjack::Diner.update_contacts({UUID_STRING, KEY => VALUE, ...}, {UUID_STRING, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
@@ -274,10 +269,10 @@ Delete one or more contacts.
 
 ```ruby
 # delete one contact
-Flapjack::Diner.delete_contacts(CONTACT_ID)
+Flapjack::Diner.delete_contacts(UUID_STRING)
 
 # delete multiple contacts
-Flapjack::Diner.delete_contacts(CONTACT_ID, CONTACT_ID, ...)
+Flapjack::Diner.delete_contacts(UUID_STRING, UUID_STRING, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -301,7 +296,7 @@ Flapjack::Diner.create_media(MEDIUM, MEDIUM, ...)
 ```ruby
 # MEDIUM
 {
-  :id => UUID,
+  :id => UUID_STRING,
   :transport => STRING,               # required
   :address => STRING,                 # required (context depends on transport)
   :interval => INTEGER,               # required (if transport != 'pagerduty')
@@ -309,9 +304,8 @@ Flapjack::Diner.create_media(MEDIUM, MEDIUM, ...)
   :pagerduty_subdomain => STRING,     # required (if transport == 'pagerduty')
   :pagerduty_token => STRING,         # required (if transport == 'pagerduty')
   :pagerduty_ack_duration => INTEGER, # required (if transport == 'pagerduty')
-  :contact => CONTACT_ID,             # required
-  :acceptors => [ACCEPTOR_ID, ACCEPTOR_ID, ...],
-  :rejectors => [REJECTOR_ID, REJECTOR_ID, ...]
+  :contact => UUID_STRING,            # required
+  :rules => [UUID_STRING, UUID_STRING, ...]
 }
 ```
 
@@ -325,8 +319,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all notification media.
 
 ```ruby
-medium = Flapjack::Diner.media(MEDIUM_ID)
-some_media = Flapjack::Diner.media(MEDIUM_ID, MEDIUM_ID, ...)
+medium = Flapjack::Diner.media(UUID_STRING)
+some_media = Flapjack::Diner.media(UUID_STRING, UUID_STRING, ...)
 first_page_of_media = Flapjack::Diner.media
 ```
 
@@ -339,15 +333,15 @@ Update data for one or more notification media.
 
 ```ruby
 # update values for one medium
-Flapjack::Diner.update_media(MEDIUM_ID, KEY => VALUE, ...)
+Flapjack::Diner.update_media(UUID_STRING, KEY => VALUE, ...)
 
 # update values for multiple media
-Flapjack::Diner.update_media({MEDIUM_ID, KEY => VALUE, ...}, {MEDIUM_ID, KEY => VALUE, ...})
+Flapjack::Diner.update_media({UUID_STRING, KEY => VALUE, ...}, {UUID_STRING, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-`:address`, `:interval`, `:rollup_threshold`, `:pagerduty_subdomain`, `:pagerduty_token`, `:pagerduty_ack_duration`, `:acceptors` and `:rejectors`
+`:address`, `:interval`, `:rollup_threshold`, `:pagerduty_subdomain`, `:pagerduty_token`, `:pagerduty_ack_duration` and `:rules`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -360,10 +354,10 @@ Delete one or more notification media.
 
 ```ruby
 # delete one medium
-Flapjack::Diner.delete_media(MEDIUM_ID)
+Flapjack::Diner.delete_media(UUID_STRING)
 
 # delete multiple media
-Flapjack::Diner.delete_media(MEDIUM_ID, MEDIUM_ID, ...)
+Flapjack::Diner.delete_media(UUID_STRING, UUID_STRING, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -372,175 +366,90 @@ Returns true if deletion succeeded or false if deletion failed.
 
 ---
 
-<a name="section_acceptors">&nbsp;</a>
-### Acceptors [^](#contents_section_acceptors)
+<a name="section_rules">&nbsp;</a>
+### Rules [^](#contents_section_rules)
 
-<a name="create_acceptors">&nbsp;</a>
-#### create_acceptors
+<a name="create_rules">&nbsp;</a>
+#### create_rules
 
-Create one or more notification acceptors.
+Create one or more notification rules.
 
 ```ruby
-Flapjack::Diner.create_acceptors(ACCEPTOR, ...)
+Flapjack::Diner.create_rules(RULE, ...)
 ```
 
-**FIXME** time_restrictions data structure isn't handled yet
-
 ```ruby
-# ACCEPTOR
+# RULE
 {
-  :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, ...]
+  :id                    => UUID_STRING,
+  :name                  => STRING,
+  :enabled               => BOOLEAN,
+  :blackhole             => BOOLEAN,
+  :strategy              => STRING,           # one of ['global', 'all_tags', 'any_tag', 'no_tag']
+  :conditions_list       => STRING,           # which conditions the rule will match;
+                                              #   all if empty, or comma-separated subset
+                                              #   of 'critical,warning,unknown'
+  :time_restriction_ical => STRING,
+  :contact               => UUID_STRING,      # required
+  :media                 => [UUID_STRING, ...]
+  :tags                  => [UUID_STRING, ...]
 }
 ```
 
 Returns false if creation failed, or the created object(s) if it succeeded.
 
-[^](#contents_create_acceptors)
+[^](#contents_create_rules)
 
-<a name="get_acceptors">&nbsp;</a>
-#### acceptors
+<a name="get_rules">&nbsp;</a>
+#### rules
 
-Return data for one, some or all notification acceptors.
+Return data for one, some or all notification rules.
 
 ```ruby
-acceptor = Flapjack::Diner.acceptors(ACCEPTOR_ID)
-some_acceptors = Flapjack::Diner.acceptors(ACCEPTOR_ID, ACCEPTOR_ID, ...)
-first_page_of_acceptors = Flapjack::Diner.acceptors
+rule = Flapjack::Diner.rules(UUID_STRING)
+some_rules = Flapjack::Diner.rules(UUID_STRING, UUID_STRING, ...)
+first_page_of_rules = Flapjack::Diner.rules
 ```
 
-[^](#contents_acceptors)
+[^](#contents_rules)
 
-<a name="update_acceptors">&nbsp;</a>
-#### update_acceptors
+<a name="update_rules">&nbsp;</a>
+#### update_rules
 
-Update data for one or more notification acceptors.
+Update data for one or more notification rules.
 
 ```ruby
-# update values for one acceptor
-Flapjack::Diner.update_acceptors(:id => ACCEPTOR_ID, KEY => VALUE, ...)
+# update values for one rule
+Flapjack::Diner.update_rules(:id => UUID_STRING, KEY => VALUE, ...)
 
-# update values for multiple acceptors
-Flapjack::Diner.update_acceptors({:id => ACCEPTOR_ID, KEY => VALUE, ...}, {:id => ACCEPTOR_ID, KEY => VALUE, ...})
+# update values for multiple rules
+Flapjack::Diner.update_rules({:id => UUID_STRING, KEY => VALUE, ...}, {:id => UUID_STRING, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-  `:conditions_list`, `:is_blackhole`, `:media` and `:tags`
+  `:name`, `:enabled`, `:blackhole`, `:strategy`, `:conditions_list`, `:time_restrictiosn_ical`, `:media` and `:tags`
 
 Returns true if updating succeeded or false if updating failed.
 
-[^](#contents_update_acceptors)
+[^](#contents_update_rules)
 
-<a name="delete_acceptors">&nbsp;</a>
-#### delete_acceptors
+<a name="delete_rules">&nbsp;</a>
+#### delete_rules
 
-Delete one or more notification acceptors.
+Delete one or more notification rules.
 
 ```ruby
-# delete one acceptor
-Flapjack::Diner.delete_acceptors(ACCEPTOR_ID)
+# delete one rule
+Flapjack::Diner.delete_rules(UUID_STRING)
 
-# delete multiple acceptors
-Flapjack::Diner.delete_acceptors(ACCEPTOR_ID, ACCEPTOR_ID, ...)
+# delete multiple rules
+Flapjack::Diner.delete_rules(UUID_STRING, UUID_STRING, ...)
 ```
 
 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,
-  :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'
-  :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_rejectors)
-
-<a name="get_rejectors">&nbsp;</a>
-#### rejectors
-
-Return data for one, some or all notification rejectors.
-
-```ruby
-rejector = Flapjack::Diner.rejectors(REJECTOR_ID)
-some_rejectors = Flapjack::Diner.rejectors(REJECTOR_ID, REJECTOR_ID, ...)
-first_page_of_rejectors = Flapjack::Diner.rejectors
-```
-
-[^](#contents_rejectors)
-
-<a name="update_rejectors">&nbsp;</a>
-#### update_rejectors
-
-Update data for one or more notification rejectors.
-
-```ruby
-# update values for one rejector
-Flapjack::Diner.update_rejectors(:id => REJECTOR_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
-
-  `:conditions_list`, `:is_blackhole`, `:media` and `:tags`
-
-Returns true if updating succeeded or false if updating failed.
-
-[^](#contents_update_rejectors)
-
-<a name="delete_rejectors">&nbsp;</a>
-#### delete_rejectors
-
-Delete one or more notification rejectors.
-
-```ruby
-# delete one rejector
-Flapjack::Diner.delete_rejectors(REJECTOR_ID)
-
-# delete multiple rejectors
-Flapjack::Diner.delete_rejectors(REJECTOR_ID, REJECTOR_ID, ...)
-```
-
-Returns true if deletion succeeded or false if deletion failed.
-
-[^](#contents_delete_rejectors)
+[^](#contents_delete_rules)
 
 ---
 
@@ -559,12 +468,11 @@ Flapjack::Diner.create_tags(TAG, ...)
 ```ruby
 # TAG
 {
+  :id        => UUID_STRING,
   :name      => STRING,         # required
-  :checks    => [CHECK_ID, ...],
-  :contacts  => [CONTACT_ID, ...],
-  :acceptors => [ACCEPTOR_ID, ...],
-  :rejectors => [REJECTOR_ID, ...]
-}
+  :checks    => [UUID_STRING, ...],
+  :contacts  => [UUID_STRING, ...],
+  :rules     => [UUID_STRING, ...]
 ```
 
 Returns false if creation failed, or the created object(s) if it succeeded.
@@ -577,8 +485,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all tags.
 
 ```ruby
-tag = Flapjack::Diner.tags(TAG_NAME)
-some_tags = Flapjack::Diner.tags(TAG_NAME, TAG_NAME, ...)
+tag = Flapjack::Diner.tags(UUID_STRING)
+some_tags = Flapjack::Diner.tags(UUID_STRING, UUID_STRING, ...)
 first_page_of_tags = Flapjack::Diner.tags
 ```
 
@@ -591,15 +499,15 @@ Update data for one or more tags.
 
 ```ruby
 # update values for one tag
-Flapjack::Diner.update_tags(:id => TAG_NAME, KEY => VALUE, ...)
+Flapjack::Diner.update_tags(:id => UUID_STRING, KEY => VALUE, ...)
 
 # update values for multiple tags
-Flapjack::Diner.update_tags({:id => TAG_NAME, KEY => VALUE, ...}, {:id => TAG_NAME, KEY => VALUE, ...})
+Flapjack::Diner.update_tags({:id => UUID_STRING, KEY => VALUE, ...}, {:id => UUID_STRING, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-  `:checks`, `:contacts`, `:acceptors` and `:rejectors`
+  `:checks`, `:contacts` and `:rules`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -612,10 +520,10 @@ Delete one or more tags.
 
 ```ruby
 # delete one tag
-Flapjack::Diner.delete_tags(TAG_NAME)
+Flapjack::Diner.delete_tags(UUID_STRING)
 
 # delete multiple tags
-Flapjack::Diner.delete_tags(TAG_NAME, TAG_NAME, ...)
+Flapjack::Diner.delete_tags(UUID_STRING, UUID_STRING, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -639,12 +547,12 @@ Flapjack::Diner.create_scheduled_maintenances(SCHEDULED_MAINTENANCE, ...)
 ```ruby
 SCHEDULED_MAINTENANCE
 {
-  :id => UUID,
+  :id => UUID_STRING,
   :start_time => DATETIME, # required
   :end_time => DATETIME,   # required
   :summary => STRING,
-  :check => CHECK_ID,      # one (and only one) of :check or :tag must be provided
-  :tag => TAG_NAME         # :tag will create scheduled maintenance periods for all checks that this tag is associated with
+  :check => UUID_STRING,   # one (and only one) of :check or :tag must be provided
+  :tag => UUID_STRING      # :tag will create scheduled maintenance periods for all checks that this tag is associated with
 }
 ```
 
@@ -658,8 +566,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all scheduled maintenance periods.
 
 ```ruby
-scheduled_maintenance = Flapjack::Diner.scheduled_maintenances(SCHEDULED_MAINTENANCE_ID)
-some_scheduled_maintenances = Flapjack::Diner.scheduled_maintenances(SCHEDULED_MAINTENANCE_ID, SCHEDULED_MAINTENANCE_ID, ...)
+scheduled_maintenance = Flapjack::Diner.scheduled_maintenances(UUID_STRING)
+some_scheduled_maintenances = Flapjack::Diner.scheduled_maintenances(UUID_STRING, UUID_STRING, ...)
 first_page_of_scheduled_maintenances = Flapjack::Diner.scheduled_maintenances
 ```
 
@@ -672,10 +580,10 @@ Update data for one or more scheduled maintenance periods.
 
 ```ruby
 # update values for one scheduled maintenance period
-Flapjack::Diner.update_scheduled_maintenances(:id => SCHEDULED_MAINTENANCE_ID, KEY => VALUE, ...)
+Flapjack::Diner.update_scheduled_maintenances(:id => UUID_STRING, KEY => VALUE, ...)
 
 # update values for multiple scheduled maintenance periods
-Flapjack::Diner.update_scheduled_maintenances({:id => SCHEDULED_MAINTENANCE_ID, KEY => VALUE, ...}, {:id => SCHEDULED_MAINTENANCE_ID, KEY => VALUE, ...})
+Flapjack::Diner.update_scheduled_maintenances({:id => UUID_STRING, KEY => VALUE, ...}, {:id => UUID_STRING, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
@@ -694,8 +602,8 @@ Returns true if updating succeeded or false if updating failed.
 Delete one or more scheduled maintenance periods.
 
 ```ruby
-Flapjack::Diner.delete_scheduled_maintenances(SCHEDULED_MAINTENANCE_ID)
-Flapjack::Diner.delete_scheduled_maintenances(SCHEDULED_MAINTENANCE_ID, SCHEDULED_MAINTENANCE_ID, ...)
+Flapjack::Diner.delete_scheduled_maintenances(UUID_STRING)
+Flapjack::Diner.delete_scheduled_maintenances(UUID_STRING, UUID_STRING, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -710,8 +618,8 @@ Returns true if deletion succeeded or false if deletion failed.
 Return data for one, some or all unscheduled maintenance periods.
 
 ```ruby
-unscheduled_maintenance = Flapjack::Diner.unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID)
-some_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID, UNSCHEDULED_MAINTENANCE_ID, ...)
+unscheduled_maintenance = Flapjack::Diner.unscheduled_maintenances(UUID_STRING)
+some_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenances(UUID_STRING, UUID_STRING, ...)
 first_page_of_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenances
 ```
 
@@ -723,10 +631,10 @@ first_page_of_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenance
 Update data for one or more unscheduled maintenance periods.
 
 ```ruby
-Flapjack::Diner.update_unscheduled_maintenances(:id => UNSCHEDULED_MAINTENANCE_ID, KEY => VALUE)
+Flapjack::Diner.update_unscheduled_maintenances(:id => UUID_STRING, KEY => VALUE)
 
-Flapjack::Diner.update_unscheduled_maintenances({:id => UNSCHEDULED_MAINTENANCE_ID, KEY => VALUE},
-  {:id => UNSCHEDULED_MAINTENANCE_ID, KEY => VALUE}, ...)
+Flapjack::Diner.update_unscheduled_maintenances({:id => UUID_STRING, KEY => VALUE},
+  {:id => UUID_STRING, KEY => VALUE}, ...)
 ```
 
 Acceptable update field keys are
@@ -745,8 +653,8 @@ Returns true if updating succeeded or false if updating failed.
 Delete one or more unscheduled maintenance periods.
 
 ```ruby
-Flapjack::Diner.delete_unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID)
-Flapjack::Diner.delete_unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID, UNSCHEDULED_MAINTENANCE_ID, ...)
+Flapjack::Diner.delete_unscheduled_maintenances(UUID_STRING)
+Flapjack::Diner.delete_unscheduled_maintenances(UUID_STRING, UUID_STRING, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -774,8 +682,8 @@ Flapjack::Diner.create_acknowledgements(ACKNOWLEDGEMENT, ...)
 {
   :summary => STRING,
   :duration => INTEGER,
-  :check => CHECK_ID,   # one (and only one) of :check or :tag must be provided
-  :tag => TAG_NAME      # :tag will acknowledge all failing checks that this tag is associated with
+  :check => UUID_STRING,   # one (and only one) of :check or :tag must be provided
+  :tag => UUID_STRING      # :tag will acknowledge all failing checks that this tag is associated with
 }
 ```
 
@@ -796,8 +704,9 @@ Flapjack::Diner.create_test_notifications(TEST_NOTIFICATION, ...)
 # TEST_NOTIFICATION
 {
   :summary => STRING,
-  :check => CHECK_ID, # one (and only one) of :check or :tag must be provided
-  :tag => TAG_NAME    # :tag will send test notifications for all checks that this tag is associated with
+  :condition => STRING,
+  :check => UUID_STRING, # one (and only one) of :check or :tag must be provided
+  :tag => UUID_STRING    # :tag will send test notifications for all checks that this tag is associated with
 }
 ```
 
@@ -816,8 +725,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all check states.
 
 ```ruby
-states = Flapjack::Diner.states(STATE_ID)
-some_states = Flapjack::Diner.states(STATE_ID, STATE_ID, ...)
+states = Flapjack::Diner.states(UUID_STRING)
+some_states = Flapjack::Diner.states(UUID_STRING, UUID_STRING, ...)
 first_page_of_states = Flapjack::Diner.states
 ```
 
@@ -840,8 +749,8 @@ metrics = Flapjack::Diner.metrics
 Return data for one, some or all flapjack processor instances.
 
 ```ruby
-statistics = Flapjack::Diner.statistics(STATISTICS_ID)
-some_statistics = Flapjack::Diner.statistics(STATISTICS_ID, STATISTICS_ID, ...)
+statistics = Flapjack::Diner.statistics(UUID_STRING)
+some_statistics = Flapjack::Diner.statistics(UUID_STRING, UUID_STRING, ...)
 first_page_of_statistics = Flapjack::Diner.statistics
 ```
 
@@ -874,27 +783,21 @@ first_page_of_statistics = Flapjack::Diner.statistics
 | `.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', ...]              |
+| `.contacts`                 | 'rules'                           | ['rule', ...]                  |
 | `.contacts`                 | 'tags'                            | ['tag', ...]                   |
-| `.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', ...]                   |
+| `.media`                    | 'rules'                           | ['rule', ...]                  |
+| `.rules`                    | 'contact'                         | 'contact'                      |
+| `.rules`                    | 'media'                           | ['medium', ...]                |
+| `.rules`                    | 'tags'                            | ['tag', ...]                   |
 | `.scheduled_maintenances`   | 'check'                           | 'check'                        |
 | `.states`                   | 'check'                           | 'check'                        |
-| `.tags`                     | 'acceptors'                       | ['acceptor', ...]              |
 | `.tags`                     | 'checks'                          | ['check', ...]                 |
 | `.tags`                     | 'contacts'                        | ['contact', ...]               |
-| `.tags`                     | 'rejectors'                       | ['acceptor', ...]              |
+| `.tags`                     | 'rules'                           | ['rule', ...]                  |
 | `.unscheduled_maintenances` | 'check'                           | 'check'                        |
 
 NB: these may be chained, as long as they follow the allowed paths above; e.g.
@@ -936,34 +839,27 @@ 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_rejectors(contact_id, opts = {})
+contact_link_rules(contact_id, opts = {})
 contact_link_tags(contact_id, opts = {})
 
-medium_link_acceptors(medium_id, opts = {})
 medium_link_alerting_checks(medium_id, opts = {})
 medium_link_contact(medium_id, opts = {})
-medium_link_rejectors(medium_id, opts = {})
-
-acceptor_link_contact(acceptor_id, opts = {})
-acceptor_link_media(acceptor_id, opts = {})
-acceptor_link_tags(acceptor_id, opts = {})
+medium_link_rules(medium_id, opts = {})
 
-rejector_link_contact(rejector_id, opts = {})
-rejector_link_media(rejector_id, opts = {})
-rejector_link_tags(rejector_id, opts = {})
+rule_link_contact(rule_id, opts = {})
+rule_link_media(rule_id, opts = {})
+rule_link_tags(rule_id, opts = {})
 
 state_link_check(state_id, opts = {})
 
-tag_link_acceptors(tag_name, opts = {})
-tag_link_checks(tag_name, opts = {})
-tag_link_contacts(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 = {})
+tag_link_checks(tag_id, opts = {})
+tag_link_contacts(tag_id, opts = {})
+tag_link_rules(tag_id, opts = {})
+tag_link_scheduled_maintenances(tag_id, opts = {})
+tag_link_states(tag_id, opts = {})
+tag_link_unscheduled_maintenances(tag_id, opts = {})
 ```
 
 All returned results are paginated, and the [common options for GET requests](#common_options_get) apply here too.
@@ -971,56 +867,40 @@ 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 an acceptor 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 rule 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_contact_link_tags(contact_id, *tags_names)
-update_contact_link_tags(contact_id, *tags_names)
-delete_contact_link_tags(contact_id, *tags_names)
-
-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_acceptor_link_media(acceptor_id, *media_ids)
-update_acceptor_link_media(acceptor_id, *media_ids)
-delete_acceptor_link_media(acceptor_id, *media_ids)
+create_check_link_tags(check_id, *tags_ids)
+update_check_link_tags(check_id, *tags_ids)
+delete_check_link_tags(check_id, *tags_ids)
 
-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_contact_link_tags(contact_id, *tags_ids)
+update_contact_link_tags(contact_id, *tags_ids)
+delete_contact_link_tags(contact_id, *tags_ids)
 
-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_medium_link_rules(medium_id, *rules_ids)
+update_medium_link_rules(medium_id, *rules_ids)
+delete_medium_link_rules(medium_id, *rules_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_rule_link_media(rule_id, *media_ids)
+update_rule_link_media(rule_id, *media_ids)
+delete_rule_link_media(rule_id, *media_ids)
 
-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_rule_link_tags(rule_id, *tags_ids)
+update_rule_link_tags(rule_id, *tags_ids)
+delete_rule_link_tags(rule_id, *tags_ids)
 
-create_tag_link_contacts(tag_name, *contacts_ids)
-update_tag_link_contacts(tag_name, *contacts_ids)
-delete_tag_link_contacts(tag_name, *contacts_ids)
+create_tag_link_checks(tag_id, *checks_ids)
+update_tag_link_checks(tag_id, *checks_ids)
+delete_tag_link_checks(tag_id, *checks_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_contacts(tag_id, *contacts_ids)
+update_tag_link_contacts(tag_id, *contacts_ids)
+delete_tag_link_contacts(tag_id, *contacts_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)
+create_tag_link_rules(tag_id, *rules_ids)
+update_tag_link_rules(tag_id, *rules_ids)
+delete_tag_link_rules(tag_id, *rules_ids)
 ```
 
 <a name="object_relationships_write_create">&nbsp;</a>

data/lib/flapjack-diner/configuration.rb

@@ -49,17 +49,23 @@ module Flapjack
           :resource => 'check',
           :requests => {
             :post => {
-              :id       => :uuid,
-              :name     => [:required, :non_empty_string],
-              :enabled  => :boolean,
-              :tags     => :multiple_link_uuid
+              :id                     => :uuid,
+              :name                   => [:required, :non_empty_string],
+              :enabled                => :boolean,
+              :initial_failure_delay  => :positive_integer,
+              :repeat_failure_delay   => :positive_integer,
+              # :initial_recovery_delay => :positive_integer,
+              :tags                   => :multiple_link_uuid
             },
             :get => RESOURCES_GET,
             :patch => {
-              :id       => [:required, :uuid],
-              :name     => :non_empty_string,
-              :enabled  => :boolean,
-              :tags     => :multiple_link_uuid
+              :id                     => [:required, :uuid],
+              :name                   => :non_empty_string,
+              :enabled                => :boolean,
+              :initial_failure_delay  => :positive_integer,
+              :repeat_failure_delay   => :positive_integer,
+              # :initial_recovery_delay => :positive_integer,
+              :tags                   => :multiple_link_uuid
             },
             :delete => {}
           },
@@ -129,7 +135,8 @@ module Flapjack
             :get => RESOURCES_GET,
             :patch => {
               :id                => [:required, :uuid],
-              [:name, :timezone] => :non_empty_string
+              [:name, :timezone] => :non_empty_string,
+              :tags              => :multiple_link_uuid
             },
             :delete => {}
           },
@@ -365,6 +372,7 @@ module Flapjack
           :requests => {
             :post => {
               :summary       => :non_empty_string,
+              :condition     => :non_empty_string,
               [:check, :tag] => :singular_link_uuid
             }
           },

data/lib/flapjack-diner/version.rb

@@ -1,5 +1,5 @@
 module Flapjack
   module Diner
-    VERSION = '2.0.0.a4'
+    VERSION = '2.0.0b1'
   end
 end

data/spec/support/fixture_data.rb

@@ -44,7 +44,9 @@ module FixtureData
     @check_data ||= {
      :id   => '1ed80833-6d28-4aba-8603-d81c249b8c23',
      :name => 'www.example.com:SSH',
-     :enabled => true
+     :enabled => true,
+     :initial_failure_delay => nil,
+     :repeat_failure_delay => nil
     }
   end
 
@@ -52,7 +54,9 @@ module FixtureData
     @check_2_data ||= {
      :id   => '29e913cf-29ea-4ae5-94f6-7069cf4a1514',
      :name => 'www2.example.com:PING',
-     :enabled => true
+     :enabled => true,
+     :initial_failure_delay => nil,
+     :repeat_failure_delay => nil
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flapjack-diner
 version: !ruby/object:Gem::Version
-  version: 2.0.0.a4
+  version: 2.0.0b1
 platform: ruby
 authors:
 - Ali Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty