runscope_statuspage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb62c439ebb1ba9cc983e980d9d33e4a6494ebb9
+  data.tar.gz: 1e9f6d9ab1e33eda9c2bb5cd195c85c277eeb072
+SHA512:
+  metadata.gz: 9d9a8fe2c762af150c9f91b1688b0cba48fa5f11f86b755121e0ddd9671473fa3989e855f2d8415b0f7a7328769161b0d6d9dbd3989df9ebcbda357297455c60
+  data.tar.gz: 78b77b820f0abb1531521a7350d400ec3a1f10516ae49e86ac5e3abefe80a770b1fbb3197fa28d0945a651b56a3ecf0dee6c2dd7ea587b96e20dd07eae3feeb7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'httparty'
+
+# Specify your gem's dependencies in runscope_statuspage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,62 @@
+# 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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "runscope_statuspage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/runscope_statuspage/exceptions.rb

@@ -0,0 +1,13 @@
+module RunscopeStatuspage
+  class RunscopeAPIException < Exception
+  end
+
+  class StatuspageAPIException < Exception
+  end
+
+  class RequestFailedException < Exception
+  end
+
+  class UserInputException < Exception
+  end
+end

data/lib/runscope_statuspage/runscope_api.rb

@@ -0,0 +1,64 @@
+require_relative 'exceptions'
+require 'httparty'
+
+module RunscopeStatuspage
+
+  class RunscopeAPI
+    include HTTParty
+    base_uri 'https://api.runscope.com'
+
+    # Set credentials
+    def initialize(token)
+      @options = { headers: {:Authorization => "Bearer #{token}"} }
+    end
+
+    # Get list of buckets
+    def buckets
+      buckets = self.class.get('/buckets', @options)
+      if buckets.has_key?('meta') and buckets.has_key?('data')
+        if buckets['meta']['status'] == 'success'
+          buckets['data']
+        else
+          raise RunscopeAPIException.new, buckets['error']
+        end
+      end
+    end
+
+    # Get list of radars for bucket
+    def radars(bucket)
+      radars = self.class.get("/buckets/#{bucket}/radar", @options)
+      if radars.has_key?('meta') and radars.has_key?('data')
+        if radars['meta']['status'] == 'success'
+          radars['data']
+        else
+          raise RunscopeAPIException.new, radars['error']
+        end
+      end
+    end
+
+    # Get a radar, from a bucket.
+    def get_radar(bucket, radar)
+      get_radar = self.class.get("/buckets/#{bucket}/radar/#{radar}", @options)
+      if get_radar.has_key?('meta') and get_radar.has_key?('data')
+        if get_radar['meta']['status'] == 'success'
+          get_radar['data']
+        else
+          raise RunscopeAPIException.new, get_radar['error']
+        end
+      end
+    end
+
+    # Get latest result from radar
+    def latest_radar_result(bucket, radar)
+      lrr = self.class.get("/buckets/#{bucket}/radar/#{radar}/results/latest", @options)
+      if lrr.has_key?('meta') and lrr.has_key?('data')
+        if lrr['meta']['status'] == 'success'
+          lrr['data']
+        else
+          raise RunscopeAPIException.new, lrr['error']
+        end
+      end
+    end
+  end
+
+end

data/lib/runscope_statuspage/statuspage_api.rb

@@ -0,0 +1,40 @@
+require_relative 'exceptions'
+require 'httparty'
+
+module RunscopeStatuspage
+
+  class StatuspageAPI
+    include HTTParty
+    base_uri 'https://api.statuspage.io/v1'
+
+    # Set credentials
+    def initialize(token)
+      @options = { headers: {:Authorization => "OAuth #{token}"} }
+    end
+
+    # Create incident
+    def create_realtime_incident(page, name, msg, status, twitter)
+      self.class.post("/pages/#{page}/incidents.json", @options.merge!(body: {:incident => {
+                                                                                :name => name,
+                                                                                :message => msg,
+                                                                                :status => status.nil? ? 'investigating' : status,
+                                                                                :wants_twitter_update => twitter
+      }}))
+    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!(data: {:data => {
+                                                                                                   :value => data,
+                                                                                                   :timestamp => timestamp
+      }})))
+    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)
+    end
+
+  end
+
+end

data/lib/runscope_statuspage/version.rb

@@ -0,0 +1,3 @@
+module RunscopeStatuspage
+  VERSION = "0.1.0"
+end

data/lib/runscope_statuspage.rb

@@ -0,0 +1,132 @@
+require_relative 'runscope_statuspage/version'
+require_relative 'runscope_statuspage/exceptions'
+require_relative 'runscope_statuspage/runscope_api'
+require_relative 'runscope_statuspage/statuspage_api'
+
+module RunscopeStatuspage
+  # Let Ruby write boring getters and setters
+  class << self; attr_accessor :rs_key, :sp_key, :sp_page, :name, :msg; end
+
+  # API credentials and IDs
+  @rs_key = ''
+  @sp_key = ''
+  @sp_page = ''
+
+  # Verbage sent to statuspage
+  @name = 'Suspected issues with /name/'
+  @msg = 'Our automated test detected an issue while testing the /description/ endpoint. We are currently investigating this issue.'
+
+  # As the user may decide (for whatever reason)
+  # to change API keys after one request, we re-initialize
+  # these objects.
+  def self.reinit_rest
+    @rs = RunscopeAPI.new(@rs_key)
+    @sp = StatuspageAPI.new(@sp_key)
+  end
+
+  # Splice radar hash values from keys defined in
+  # @name and @msg.
+  def self.parameterize(radar)
+    rname = @name
+    rmsg = @msg
+
+    @name.scan(/.*?(\/)([A-Za-z]*)(\/)/).each do |set|
+      set.each do |token|
+        if radar.has_key?(token)
+          rname = rname.sub!("/#{token}/", radar[token]) unless (token == "/" and token.length == 1)
+        end
+      end
+    end
+
+    @msg.scan(/.*?(\/)([A-Za-z]*)(\/)/).each do |set|
+      set.each do |token|
+        if radar.has_key?(token)
+          rmsg = rmsg.sub!("/#{token}/", radar[token]) unless (token == "/" and token.length == 1)
+        end
+      end
+    end
+
+    return rname, rmsg
+  end
+
+  # 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
+
+    @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]))
+        end
+      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
+
+    @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]))
+          end
+        end
+      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
+
+    @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_names.include?(radar['name'])
+            @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+          end
+        end
+      end
+    end
+
+  end
+
+  # Update status page with all radars under passed
+  # bucket name.
+  def self.report_bucket(bucket_name, status, twitter_update)
+    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'
+            @sp.create_realtime_incident(@sp_page, *parameterize(radar).concat([status, twitter_update]))
+          end
+        end
+      end
+    end
+
+  end
+
+  # Update status page with all radars under the specified
+  # buckets
+  def self.report_buckets(bucket_names, status, twitter_update)
+    reinit_rest
+
+    @rs.buckets.each do |bucket|
+      if 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]))
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/runscope_statuspage.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runscope_statuspage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'runscope_statuspage'
+  spec.version       = RunscopeStatuspage::VERSION
+  spec.authors       = ['David Stancu']
+  spec.email         = ['dstancu@nyu.edu']
+  spec.summary       = 'Push RunScope data to StatusPage.io'
+  spec.description   = 'Get test data from RunScope and easily report incidents to StatusPage.io, all with one gem.'
+  spec.homepage      = 'https://github.com/mach-kernel/runscope_statuspage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: runscope_statuspage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Stancu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Get test data from RunScope and easily report incidents to StatusPage.io,
+  all with one gem.
+email:
+- dstancu@nyu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/runscope_statuspage.rb
+- lib/runscope_statuspage/exceptions.rb
+- lib/runscope_statuspage/runscope_api.rb
+- lib/runscope_statuspage/statuspage_api.rb
+- lib/runscope_statuspage/version.rb
+- runscope_statuspage.gemspec
+homepage: https://github.com/mach-kernel/runscope_statuspage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Push RunScope data to StatusPage.io
+test_files: []