runscope_statuspage 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072d8026be2be560c5ea87d6a207440caade1bb6
-  data.tar.gz: fab756dc2cd925e61df9eaf4f8c63ce737b76a93
+  metadata.gz: 741e2f3f579b40a040daf84442387a29148392a7
+  data.tar.gz: 536405a3f5bf68fe04c57efe35384f0cfdc51893
 SHA512:
-  metadata.gz: f87d62c2bfe99465ca9c4cca2c67cd5959eb5bc709fbb483edcf948c41698c485b6594eb4763d31719fe0b80f63ad3a6f701a60a6a18a0939406e775839b1318
-  data.tar.gz: f9c693e0c1c6272be2c8504c5222dd88e7f865016d20054895dcbfc1137158e2b31ebafb752e972116e98cda060448545feb754709983ef4d9212e8d278c654d
+  metadata.gz: 0bbb5735fb83c37953b4105ac655772bf6a5e589724b7793283481e556d5878914cf6e855ba2966055a22daed242ce67262a9b60f285b0ec987143b854b0bdfd
+  data.tar.gz: 8462ec592908dc9d11715843832758864e321258178050eea037173d813175306bdb477daf0b39114d2e41b5febfe229f9aee45f52568edcbf88a65ea71d1cb8

data/README.md

@@ -1,62 +1,159 @@
-# RunscopeStatuspage
-
-Do you use [RunScope](https://runscope.com) to test your API, and [StatusPage](https://statuspage.io) to show it all off to your customers? Don't want to write bindings for both APIs? If yes, RunscopeStatuspage is perfect for you.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'runscope_statuspage'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install runscope_statuspage
-
-## Usage
-
-In a nutshell, each call will grab metrics from RunScope then send them over to StatusPage, once per call. There is no scheduling done by this gem, it is left as an exercise for the reader. Ideally, you will want to use something such as [Sidekiq](https://github.com/mperham/sidekiq) or [Resque](https://github.com/resque/resque) to fire these jobs off every few minutes/hours. Keep in mind that StatusPage will rate-limit requests to its API, one request per minute. 
-
-### You can...
-
-* from general to specific *
-
-- report_everything(page, status, twitter_update)
-- report_buckets(bucket_names, status, twitter_update)
-- report_bucket(bucket_name, status, twitter_update)
-- report_radars(bucket_name, radar_names, status, twitter_update)
-- report_radar(bucket_name, radar_name, status, twitter_update)
-
-#### Important Notes
-
-- `status` must be either `investigating|identified|monitoring|resolved`.
-- RunScope likes to throw ISEs if you specify invalid IDs or names, just keep this in mind.
-
-#### I want bindings!
-
-Have them! `RunscopeStatuspage::RunscopeAPI` and `RunscopeStatuspage::StatuspageAPI` contain partial coverage of each service's API.
-
-### Glossary
-
-- bucket: A group of radars/tests.
-- radar: A test with one or more assertions.
-- twitter_update parameter: StatusPage can spit incidents out to Twitter, this is a toggle for this functionality.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/runscope_statuspage/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+# RunscopeStatuspage
+
+Do you use [RunScope](https://runscope.com) to test your API, and [StatusPage](https://statuspage.io) to show it all off to your customers? Don't want to write bindings for both APIs? If yes, RunscopeStatuspage is perfect for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'runscope_statuspage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install runscope_statuspage
+
+## Usage
+
+In a nutshell, each call will grab metrics from RunScope then send them over to StatusPage, once per call. There is no scheduling done by this gem, it is left as an exercise for the reader. Ideally, you will want to use something such as [Sidekiq](https://github.com/mperham/sidekiq) or [Resque](https://github.com/resque/resque) to fire these jobs off every few minutes/hours. Keep in mind that StatusPage will rate-limit requests to its API, one request per minute. 
+
+
+### Poll for incidents
+
+*from general to specific:*
+
+- *report_everything:* Report all radars of all buckets.
+```ruby
+opts = {:status => "page status (either 'investigating|identified|monitoring|resolved')",
+:twitter_update => 'do you want to post status to twitter (bool)',
+:fail_on => 'number of failures to induce statuspage update (int, default 0)'}
+```
+- *report_buckets:* Report all radars of buckets in list.
+```ruby
+opts = {:bucket_names => 'list of names of buckets containing radars',
+:status => "page status (either 'investigating|identified|monitoring|resolved')",
+:twitter_update => 'do you want to post status to twitter (bool)',
+:fail_on => 'number of failures to induce statuspage update (int, default 0)'}
+```
+- *report_bucket:* Report all radars in bucket.
+```ruby
+opts = {:bucket_name => 'name of bucket containing radars',
+:status => "page status (either 'investigating|identified|monitoring|resolved')",
+:twitter_update => 'do you want to post status to twitter (bool)',
+:fail_on => 'number of failures to induce statuspage update (int, default 0)'}
+```
+- *report_radars:* Report radars in list for given bucket.
+```ruby
+opts = {:bucket_name => 'name of bucket containing radars',
+:radar_names => 'list of names of radars within bucket',
+:status => "page status (either 'investigating|identified|monitoring|resolved')",
+:twitter_update => 'do you want to post status to twitter (bool)',
+:fail_on => 'number of failures to induce statuspage update (int, default 0)'}
+```
+- *report_radar:* Report one radar in bucket.
+```ruby
+opts = {:bucket_name => 'name of bucket containing radars',
+:radar_name => 'name of radar within bucket',
+:status => "page status (either 'investigating|identified|monitoring|resolved')",
+:twitter_update => 'do you want to post status to twitter (bool)',
+:fail_on => 'number of failures to induce statuspage update (int, default 0)'}
+```
+
+#### Important Notes
+
+- `status` must be either `investigating|identified|monitoring|resolved`.
+- RunScope likes to throw ISEs if you specify invalid IDs or names, just keep this in mind.
+- If an exception is thrown while calling `latest_radar_result` in any of the above, it will not halt execution. This is to prevent breaking integrations when a new test is added and `runscope_statuspage` polls before it has the chance to run.
+
+#### Runscope Bindings
+Usage: 
+
+```ruby
+@client = RunscopeStatuspage::RunscopeAPI.new "token"
+```
+
+- **buckets**: Get list of buckets.
+- **bucket_id_by_name(name)**: Get bucket ID from its name.
+- **radars(bucket)**: Get list of radars for bucket (by ID).
+- **get_radar(bucket, radar)**: Get radar from bucket (by both IDs)
+- **latest_radar_result(bucket, radar)**: Get latest result from a radar, by ID.
+- **messages(bucket, count)**: Get latest messages for bucket (by name).
+- **message_detail(bucket, message)**: Get message detail (both by ID).
+
+#### Statuspage Bindings 
+Usage: 
+
+```ruby
+@client = RunscopeStatuspage::StatspageAPI.new "token"
+```
+
+- **create_realtime_incident(page, name, msg, status, twitter)**: Creates a realtime incident.
+- **push_metric_data(page_id, metric_id, data, timestamp)**: Publish data for a page metric. Data must be either int/float.
+- **clear_metric_data(page_id, metric_id)**: Clear metric data for a specific page, for a specific metric.
+
+### Glossary
+
+- bucket: A group of radars/tests.
+- radar: A test with one or more assertions.
+- twitter_update parameter: StatusPage can spit incidents out to Twitter, this is a toggle for this functionality.
+
+## Changelog
+
+0.1.3
+* Changed all functions in `RunscopeStatuspage` to use `options = {}` hash for better readability.
+* Added `opts[:fail_on]` threshold parameter for greater granularity.
+* Fixed no parameter issue on `StatuspageAPI.clear_metric_data`
+* More informative exception messages
+* Better error handling (not being able to retrieve a radar's latest result will not bring the whole sweep of operations for that bucket down).
+
+0.1.2
+* Added Statuspage metrics bindings.
+
+0.1.1
+* Fixed bugs + edge cases that shipped with release.
+
+0.1.0
+* Initial Release
+
+## Development and Contributions
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+----
+
+1. Fork it ( https://github.com/[my-github-username]/runscope_statuspage/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 David Stancu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/runscope_statuspage/exceptions.rb

@@ -5,9 +5,7 @@ module RunscopeStatuspage
   class StatuspageAPIException < Exception
   end
 
-  class RequestFailedException < Exception
-  end
+  class MissingArgumentException < Exception
 
-  class UserInputException < Exception
   end
 end

data/lib/runscope_statuspage/runscope_api.rb

@@ -24,9 +24,10 @@ module RunscopeStatuspage
       end
     end
 
+    # Get bucket ID by name
     def bucket_id_by_name(name)
       self.buckets.each do |bucket|
-        return bucket["key"] if bucket["name"] == name 
+        return bucket["key"] if bucket["name"] == name
       end
     end
 
@@ -49,7 +50,8 @@ module RunscopeStatuspage
         if get_radar['meta']['status'] == 'success'
           get_radar['data']
         else
-          raise RunscopeAPIException.new, get_radar['error']
+          raise RunscopeAPIException.new,
+                "Error attempting to get radar info for #{bucket}, #{radar}: #{get_radar['error']}"
         end
       end
     end
@@ -61,7 +63,8 @@ module RunscopeStatuspage
         if lrr['meta']['status'] == 'success'
           lrr['data']
         else
-          raise RunscopeAPIException.new, lrr['error']
+          raise RunscopeAPIException.new,
+                "Error attempting to fetch latest radar result for #{bucket}, #{radar}: #{lrr['error']}"
         end
       end
     end
@@ -73,7 +76,8 @@ module RunscopeStatuspage
         if messages['meta']['status'] == 'success'
           messages['data']
         else
-          raise RunscopeAPIException.new, messages['error']
+          raise RunscopeAPIException.new,
+                "Error attempting to fetch messages for #{bucket}: #{detail['error']}"
         end
       end
     end
@@ -85,7 +89,8 @@ module RunscopeStatuspage
         if detail['meta']['status'] == 'success'
           detail['data']
         else
-          raise RunscopeAPIException.new, detail['error']
+          raise RunscopeAPIException.new,
+                "Error attempting to fetch message detail for #{bucket}, #{message}: #{detail['error']}"
         end
       end
     end

data/lib/runscope_statuspage/statuspage_api.rb

@@ -14,25 +14,34 @@ module RunscopeStatuspage
 
     # Create incident
     def create_realtime_incident(page, name, msg, status, twitter)
-      self.class.post("/pages/#{page}/incidents.json", @options.merge!(body: {"incident" => {
+      incident = self.class.post("/pages/#{page}/incidents.json", @options.merge!(body: {"incident" => {
                                                                                 "name" => name,
                                                                                 "message" => msg,
                                                                                 "status" => status.nil? ? 'investigating' : status,
                                                                                 "wants_twitter_update" => twitter
       }}))
+
+      raise StatuspageAPIException.new,
+            "Could not create incident: #{incident}" if incident.key?('error')
     end
 
     # Publish data for a custom page metric
     def push_metric_data(page_id, metric_id, data, timestamp)
-      self.class.post("/pages/#{page_id}/metrics/#{metric_id}/data.json", @options.merge!(body: {"data" => {
+      reply = self.class.post("/pages/#{page_id}/metrics/#{metric_id}/data.json", @options.merge!(body: {"data" => {
                                                                                                    "value" => data,
                                                                                                    "timestamp" => timestamp
       }}))
+
+      raise StatuspageAPIException.new,
+            "Could not push to #{page_id}/#{metric_id}: #{reply}" if reply.key?('error')
     end
 
     # Delete all data for a custom page metric
-    def clear_metric_data
-      self.class.delete("/pages/#{page_id}/metrics/#{metric_id}/data.json", @options)
+    def clear_metric_data(page_id, metric_id)
+      reply = self.class.delete("/pages/#{page_id}/metrics/#{metric_id}/data.json", @options)
+
+      raise StatuspageAPIException.new,
+            "Could not delete all data for #{page_id}/#{metric_id}: #{reply}" if reply.key?('error')
     end
 
   end

data/lib/runscope_statuspage/version.rb

@@ -1,3 +1,3 @@
 module RunscopeStatuspage
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/runscope_statuspage.rb

@@ -8,9 +8,7 @@ module RunscopeStatuspage
   class << self; attr_accessor :rs_key, :sp_key, :sp_page, :name, :msg; end
 
   # API credentials and IDs
-  @rs_key = ''
-  @sp_key = ''
-  @sp_page = ''
+  @rs_key, @sp_key, @sp_page = ''
 
   # Verbage sent to statuspage
   @name = 'Suspected issues with /name/'
@@ -51,82 +49,189 @@ module RunscopeStatuspage
 
   # Update status page with all radars, from all buckets.
   # An error will most likely be thrown if you have empty buckets.
-  def self.report_everything(page, status, twitter_update)
-    reinit_rest
+  #
+  # Parameters: {:status => page status (either 'investigating|identified|monitoring|resolved'),
+  #              :twitter_update => do you want to post status to twitter (bool),
+  #              :fail_on => number of failures to induce statuspage update (int, default 0)}
+  def self.report_everything(opts={})
+    raise MissingArgumentException.new, 'report_everything is missing arguments' \
+      if not (opts.key?(:status) or opts.key?(:twitter_update))
+
+    opts[:fail_on] = opts.key?(:fail_on) ? opts[:fail_on] : 0
+    failed_radars = []
 
+    reinit_rest
     @rs.buckets.each do |bucket|
       @rs.radars(bucket['key']).each do |radar|
-        if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass'
-          @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+        begin
+          if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass'
+            failed_radars.push radar
+          end
+        rescue RunscopeAPIException => r
+          p r
+          next
         end
       end
     end
+
+    if failed_radars.length >= opts[:fail_on]
+      failed_radars.each do |radar|
+        @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([opts[:status], opts[:twitter_update]]))
+      end
+    end
   end
 
   # Update status page with one radar, from one bucket.
-  def self.report_radar(bucket_name, radar_name, status, twitter_update)
-    reinit_rest
+  #
+  # Parameters: {:bucket_name => name of bucket containing radars,
+  #              :radar_name => name of radar within bucket,
+  #              :status => page status (either 'investigating|identified|monitoring|resolved'),
+  #              :twitter_update => do you want to post status to twitter (bool),
+  #              :fail_on => number of failures to induce statuspage update (int, default 0)}
+  def self.report_radar(opts = {})
+    raise MissingArgumentException.new, 'report_radar is missing arguments' \
+      if not (opts.key?(:status) or opts.key?(:twitter_update) \
+      or opts.key?(:bucket_name) or opts.key?(:radar_name))
+
+    opts[:fail_on] = opts.key?(:fail_on) ? opts[:fail_on] : 0
+    failed_radars = []
 
+    reinit_rest
     @rs.buckets.each do |bucket|
       if bucket['name'] == bucket_name
         @rs.radars(bucket['key']).each do |radar|
-          if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass' and radar['name'] == radar_name
-            @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+          begin
+            if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass' and radar['name'] == radar_name
+              failed_radars.push radar
+            end
+          rescue RunscopeAPIException => r
+            p r
+            next
           end
         end
       end
     end
 
+    if failed_radars.length >= opts[:fail_on]
+      failed_radars.each do |radar|
+        @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([opts[:status], opts[:twitter_update]]))
+      end
+    end
   end
 
   # Update status page with list of radars, from one bucket.
-  def self.report_radars(bucket_name, radar_names, status, twitter_update)
-    reinit_rest
+  #
+  # Parameters: {:bucket_name => name of bucket containing radars,
+  #              :radar_names => list of names of radars within bucket,
+  #              :status => page status (either 'investigating|identified|monitoring|resolved'),
+  #              :twitter_update => do you want to post status to twitter (bool),
+  #              :fail_on => number of failures to induce statuspage update (int, default 0)}
+  def self.report_radars(opts = {})
+    raise MissingArgumentException.new, 'report_radars is missing arguments' \
+      if not (opts.key?(:status) or opts.key?(:twitter_update) \
+      or opts.key?(:bucket_name) or opts.key?(:radar_names))
+
+    opts[:fail_on] = opts.key?(:fail_on) ? opts[:fail_on] : 0
+    failed_radars = []
 
+    reinit_rest
     @rs.buckets.each do |bucket|
-      if bucket['name'] == bucket_name
+      if bucket['name'] == opts[:bucket_name]
         @rs.radars(bucket['key']).each do |radar|
-          if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass' and radar_names.include?(radar['name'])
-            @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+          begin
+            if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass' and opts[:radar_names].include?(radar['name'])
+              failed_radars.push radar
+            end
+          rescue RunscopeAPIException => r
+            p r
+            next
           end
         end
       end
     end
 
+    if failed_radars.length >= opts[:fail_on]
+      failed_radars.each do |radar|
+        @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([opts[:status], opts[:twitter_update]]))
+      end
+    end
   end
 
   # Update status page with all radars under passed
   # bucket name.
-  def self.report_bucket(bucket_name, status, twitter_update)
-    reinit_rest
+  #
+  # Parameters: {:bucket_name => name of bucket containing radars,
+  #              :status => page status (either 'investigating|identified|monitoring|resolved'),
+  #              :twitter_update => do you want to post status to twitter (bool),
+  #              :fail_on => number of failures to induce statuspage update (int, default 0)}
+  def self.report_bucket(opts={})
+    raise MissingArgumentException.new, 'report_bucket is missing arguments' \
+      if not (opts.key?(:status) or opts.key?(:twitter_update) \
+      or opts.key?(:bucket_name))
+
+    opts[:fail_on] = opts.key?(:fail_on) ? opts[:fail_on] : 0
+    failed_radars = []
 
+    reinit_rest
     @rs.buckets.each do |bucket|
-      if bucket['name'] == bucket_name
+      if bucket['name'] == opts[:bucket_name]
         @rs.radars(bucket['key']).each do |radar|
-          if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass'
-            @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+          begin
+            if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass'
+              failed_radars.push radar
+            end
+          rescue RunscopeAPIException => r
+            p r
+            next
           end
         end
       end
     end
 
+    if failed_radars.length >= opts[:fail_on]
+      failed_radars.each do |radar|
+        @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([opts[:status], opts[:twitter_update]]))
+      end
+    end
   end
 
   # Update status page with all radars under the specified
   # buckets
+  #
+  # Parameters: {:bucket_names => list of names of buckets containing radars,
+  #              :status => page status (either 'investigating|identified|monitoring|resolved'),
+  #              :twitter_update => do you want to post status to twitter (bool),
+  #              :fail_on => number of failures to induce statuspage update (int, default 0)}
   def self.report_buckets(bucket_names, status, twitter_update)
+    raise MissingArgumentException.new, 'report_buckets is missing arguments' \
+      if not (opts.key?(:status) or opts.key?(:twitter_update) \
+      or opts.key?(:bucket_name))
+
+    opts[:fail_on] = opts.key?(:fail_on) ? opts[:fail_on] : 0
+    failed_radars = []
+
     reinit_rest
 
     @rs.buckets.each do |bucket|
-      if bucket_names.include?(bucket['name'])
+      if opts[:bucket_names].include?(bucket['name'])
         @rs.radars(bucket['key']).each do |radar|
-          if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass'
-            @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+          begin
+            if @rs.latest_radar_result(bucket['key'], radar['uuid'])['result'] != 'pass'
+              failed_radars.push radar
+            end
+          rescue RunscopeAPIException => r
+            p r
+            next
           end
         end
       end
     end
 
+    if failed_radars.length >= opts[:fail_on]
+      failed_radars.each do |radar|
+        @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([opts[:status], opts[:twitter_update]]))
+      end
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runscope_statuspage
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Stancu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler