flapjack-diner 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bc53c0acbb77a8fc45124c30169732da0100e08
-  data.tar.gz: d410e73ad72d5a2abe8cecb51feebf18624e63db
+  metadata.gz: 4628fa35a6db22f5a6318835a606b1622f355dec
+  data.tar.gz: 548b762bb9f80d2180be0c74f12b73b32f6f60f5
 SHA512:
-  metadata.gz: 1fe5070021949b3011cc81ca5d72c2b546d25e53a0c70a8b8d235cae5b2035252a9519629fd7ddfe3d531e3c83b000cf715cee8ac7d9c5bf83cfae1889a613c6
-  data.tar.gz: 9e8f1f80171a83a223b92aaf2ac39a73bf23b08adcd2d9abc4487a980e1df636d45d1ebda78268850e466a6ba2e93a4c19e05abacb938dfb4abe25b43978032d
+  metadata.gz: c8bcacc5f5c584dad6cc3b6f928233eac11acb68a5830d5a676611d123eb1d4f0d83eaf2fdc6308236a243d2f0b8a9ba116680f7811b2968c8d676b59e867559
+  data.tar.gz: fad9ad761c145505b1a0e5fbdb79d146e6cc6226b3966481da3388e35828e444eb7a612c4d66a5406d4efd0880df77575c136f4dfa6f62b8e37877f9733b7e2e

data/.gitignore

@@ -3,12 +3,12 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
 doc/
 lib/bundler/man
+log/
 pkg
 rdoc
 spec/reports

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'lib/flapjack-diner.rb'
+
+# doesn't handle multi-file state
+Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space

data/.rubocop_todo.yml

@@ -0,0 +1,135 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+# AccessorMethodName:
+#   Enabled: false
+
+# AlignArray:
+#   Enabled: false
+
+# AlignHash:
+#   Enabled: false
+
+# AlignParameters:
+#   Enabled: false
+
+# AndOr:
+#   Enabled: false
+
+# AssignmentInCondition:
+#   Enabled: false
+
+# BlockAlignment:
+#   Enabled: false
+
+# BlockNesting:
+#   Max: 4
+
+# Blocks:
+#   Enabled: false
+
+# BracesAroundHashParameters:
+#   Enabled: false
+
+# CaseIndentation:
+#   Enabled: false
+
+# ClassLength:
+#   Max: 221
+
+# CollectionMethods:
+#   Enabled: false
+
+# CommentAnnotation:
+#   Enabled: false
+
+# CyclomaticComplexity:
+#   Max: 32
+
+# DotPosition:
+#   Enabled: false
+
+# EmptyLines:
+#   Enabled: false
+
+# EmptyLinesAroundBody:
+#   Enabled: false
+
+# EndAlignment:
+#   Enabled: false
+
+# FavorUnlessOverNegatedIf:
+#   Enabled: false
+
+# FinalNewline:
+#   Enabled: false
+
+# HashMethods:
+#   Enabled: false
+
+# IfUnlessModifier:
+#   Enabled: false
+
+# IndentationWidth:
+#   Enabled: false
+
+# LineLength:
+#   Max: 120
+
+# MethodCallParentheses:
+#   Enabled: false
+
+# MethodLength:
+#   Max: 95
+
+# MultilineBlockChain:
+#   Enabled: false
+
+# ParenthesesAroundCondition:
+#   Enabled: false
+
+# PredicateName:
+#   Enabled: false
+
+# RaiseArgs:
+#   Enabled: false
+
+# RedundantSelf:
+#   Enabled: false
+
+# RescueException:
+#   Enabled: false
+
+# Semicolon:
+#   Enabled: false
+
+# ShadowingOuterLocalVariable:
+#   Enabled: false
+
+# SpaceAfterNot:
+#   Enabled: false
+
+# SpaceAroundOperators:
+#   Enabled: false
+
+# SpaceInsideHashLiteralBraces:
+#   Enabled: false
+
+# SpaceInsideParens:
+#   Enabled: false
+
+# SpecialGlobalVars:
+#   Enabled: false
+
+# StringLiterals:
+#   Enabled: false
+
+# TrivialAccessors:
+#   Enabled: false
+
+# UselessAssignment:
+#   Enabled: false
+
+# WordArray:
+#   Enabled: false

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in flapjack-diner.gemspec
 gemspec
+
+group :test do
+  gem 'rspec', '>= 3.0'
+  gem 'webmock'
+  gem 'simplecov', :require => false
+  gem 'pact'
+end

data/README.md

@@ -36,6 +36,16 @@ Optionally, set a logger to log requests & responses:
 Flapjack::Diner.logger = Logger.new('logs/flapjack_diner.log')
 ```
 
+If you want to alter timeout periods for HTTP connection open and reading responses:
+
+```ruby
+# Set HTTP connect timeout to 30 seconds
+Flapjack::Diner.open_timeout(30)
+
+# Set HTTP read timeout to 5 minutes
+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:
 
 ```ruby
@@ -52,7 +62,7 @@ Parameters for all of **flapjack-diner**'s functions are organised into three ca
 
 While these can be passed in in any order, the convention is that they will be ordered as listed above.
 
-If any operation fails, `Flapjack::Diner.last_error` will contain an error message regarding the failure.
+If any operation fails (returning nil), `Flapjack::Diner.last_error` will contain an error message regarding the failure.
 
 ### Contacts
 
@@ -86,6 +96,7 @@ If any operation fails, `Flapjack::Diner.last_error` will contain an error messa
 
 * [create_entities](#create_entities)
 * [entities](#entities)
+* [entities_matching](#entities_matching)
 * [update_entities](#update_entities)
 
 * [create_scheduled_maintenances_entities](#create_scheduled_maintenances_entities)
@@ -98,7 +109,9 @@ If any operation fails, `Flapjack::Diner.last_error` will contain an error messa
 
 ### Checks
 
+* [create_checks](#create_checks)
 * [checks](#checks)
+* [update_checks](#update_checks)
 
 * [create_scheduled_maintenances_checks](#create_scheduled_maintenances_checks)
 * [delete_scheduled_maintenances_checks](#delete_scheduled_maintenances_checks)
@@ -144,7 +157,7 @@ CONTACT
 }
 ```
 
-Returns true if creation succeeded or false if creation failed.
+Returns an array of contact ids if creation succeeded, or false if creation failed.
 
 <a name="contacts">&nbsp;</a>
 #### contacts
@@ -172,18 +185,18 @@ Flapjack::Diner.update_contacts(ID1, ID2, ..., :key => value, ...)
 
 Acceptable update field keys are
 
-`:first_name`, `:last_name`, `:email`, and `:tags`
+`:first_name`, `:last_name`, `:email`
 
 as well as the linkage operations
 
 `:add_entity`, `:remove_entity`
 `:add_notification_rule`, `:remove_notification_rule`
 
-which take the id of the relevant resource as the value.
+which take the id (for entity and notification rule) of the relevant resource as the value.
 
-(NB: `:add_medium` and `:remove_medium` are not supported in Flapjack v1.0 but should be in future versions.)
+(NB: `:add_medium` and `:remove_medium` are not supported in Flapjack v1.x but will be in future versions.)
 
-Returns true if updating succeeded or false if updating failed.
+Returns true if updating succeeded, false if updating failed.
 
 <a name="delete_contacts">&nbsp;</a>
 #### delete_contacts
@@ -221,12 +234,12 @@ MEDIUM
 }
 ```
 
-Returns true if creation succeeded or false if creation failed.
+Returns an array of media ids if creation succeeded, or false if creation failed. (Ids cannot be passed in for media records in Flapjack v1.x.)
 
 <a name="media">&nbsp;</a>
 #### media
 
-Return data for one, some or all notification media. Notification media ids are formed by compounding their linked contact's ID and their type in a string (e.g. '23_sms')
+Return data for one, some or all notification media. Notification media ids are formed by compounding their linked contact's ID and their type in a string (e.g. '23_sms').
 
 ```ruby
 medium = Flapjack::Diner.media(ID)
@@ -271,7 +284,7 @@ Returns true if deletion succeeded or false if deletion failed.
 ---
 
 <a name="create_contact_pagerduty_credentials">&nbsp;</a>
-#### create_contact_media
+#### create_contact_pagerduty_credentials
 
 Create pagerduty credentials for a contact.
 
@@ -289,7 +302,7 @@ PAGERDUTY_CREDENTIALS
 }
 ```
 
-Returns true if creation succeeded or false if creation failed.
+Returns an array of contact ids if creation succeeded, or false if creation failed. (As contacts may only have one set of pagerduty credentials, Flapjack v1.x does not store a separate data model, thus theses objects have no separate ids.)
 
 <a name="pagerduty_credentials">&nbsp;</a>
 #### pagerduty_credentials
@@ -365,7 +378,7 @@ NOTIFICATION_RULE
 }
 ```
 
-Returns true if creation succeeded or false if creation failed.
+Returns an array of notification rule ids if creation succeeded, or false if creation failed.
 
 <a name="notification_rules">&nbsp;</a>
 #### notification_rules
@@ -398,7 +411,7 @@ Acceptable update field keys are
 Returns true if updating succeeded or false if updating failed.
 
 <a name="delete_notification_rules">&nbsp;</a>
-#### delete_contacts
+#### delete_notification_rules
 
 Delete one or more notification rules.
 
@@ -432,7 +445,7 @@ ENTITY
 }
 ```
 
-Returns true if creation succeeded or false if creation failed.
+Returns an array of entity ids if creation succeeded, or false if creation failed.
 
 <a name="entities">&nbsp;</a>
 ### entities
@@ -445,6 +458,15 @@ some_entities = Flapjack::Diner.entities(ID1, ID2, ...)
 all_entities = Flapjack::Diner.entities
 ```
 
+<a name="entities_matching">&nbsp;</a>
+### entities_matching
+
+Returns an array of entities matching a given regular expression
+
+```ruby
+entities = Flapjack::Diner.entities_matching(/^db-app-01/)
+```
+
 <a name="update_entities">&nbsp;</a>
 ### update_entities
 
@@ -458,15 +480,14 @@ Flapjack::Diner.update_entities(ID, :key => value, ...)
 Flapjack::Diner.update_entities(ID1, ID2, ..., :key => value, ...)
 ```
 
-Acceptable update field keys are
-
-`:name` and `:tags`
+There are no valid update field keys yet.
 
-as well as the linkage operations
+The linkage operations
 
 `:add_contact` and `:remove_contact`
+`:add_tag` and `:remove_tag`
 
-which take the id of the relevant contact as the value.
+take the id (for contact) or the name (for tag) of the relevant resource as the value.
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -552,17 +573,62 @@ Returns true if creation succeeded or false if creation failed.
 
 ---
 
+<a name="create_checks">&nbsp;</a>
+### create_checks
+
+Create one or more checks.
+
+```ruby
+Flapjack::Diner.create_checks([CHECK, ...])
+```
+
+```
+CHECK
+{
+  :entity_id => STRING,
+  :name      => STRING,
+  :tags      => [STRING, ...]
+}
+```
+
+Returns an array of check ids if creation succeeded, or false if creation failed. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
 <a name="checks">&nbsp;</a>
 ### checks
 
 Return basic identity data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
 
 ```ruby
-check = Flapjack::Diner.check(ID)
+check = Flapjack::Diner.checks(ID)
 some_checks = Flapjack::Diner.checks(ID1, ID2, ...)
 all_checks = Flapjack::Diner.checks
 ```
 
+<a name="update_checks">&nbsp;</a>
+### update_checks
+
+Update data for one or more checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
+```ruby
+# update values for one checks
+Flapjack::Diner.update_checks(ID, :key => value, ...)
+
+# update values for multiple checks
+Flapjack::Diner.update_checks(ID1, ID2, ..., :key => value, ...)
+```
+
+Acceptable update field keys are
+
+`:enabled`
+
+as well as the linkage operations
+
+`:add_tag` and `:remove_tag`
+
+which take the name of the tag as the value.
+
+Returns true if updating succeeded or false if updating failed.
+
 ---
 
 <a name="create_scheduled_maintenances_checks">&nbsp;</a>
@@ -737,7 +803,7 @@ report_all = Flapjack::Diner.unscheduled_maintenance_report_checks
 <a name="downtime_report_checks">&nbsp;</a>
 ### downtime_report_checks
 
-Return a report on downtim data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+Return a report on downtime data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
 
 ```ruby
 report = Flapjack::Diner.downtime_report_checks(CHECK_ID)

data/flapjack-diner.gemspec

@@ -2,25 +2,21 @@
 require File.expand_path('../lib/flapjack-diner/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Ali Graham"]
-  gem.email         = ["ali.graham@bulletproof.net"]
-  gem.summary       = %q{Access the API of a Flapjack system monitoring server}
-  gem.description   = %q{Wraps raw API calls to a Flapjack server API with friendlier ruby methods.}
+  gem.authors       = ['Ali Graham']
+  gem.email         = ['ali.graham@bulletproof.net']
+  gem.summary       = 'Access the API of a Flapjack system monitoring server'
+  gem.description   = 'Wraps raw API calls to a Flapjack server API with ' \
+                      'friendlier ruby methods.'
   gem.homepage      = 'https://github.com/flapjack/flapjack-diner'
 
-  gem.files         = `git ls-files`.split($\) - ['Gemfile.lock']
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "flapjack-diner"
-  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR) -
+                      ['Gemfile.lock']
+  gem.executables   = gem.files.grep(/^bin\//).map {|f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.name          = 'flapjack-diner'
+  gem.require_paths = ['lib']
   gem.version       = Flapjack::Diner::VERSION
 
   gem.add_dependency('httparty', '>= 0.10')
   gem.add_dependency('json', '>= 1.7.7')
-
-  gem.add_development_dependency('bundler')
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('rspec', '~> 2.0')
-  gem.add_development_dependency('simplecov')
-  gem.add_development_dependency('webmock')
 end