victor_ops-client 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef7b0ede3d1b7572df728e8824d3999c05391f1b
+  data.tar.gz: 37c171cd2e582019d437e5dfdf09c4932dab4fed
+SHA512:
+  metadata.gz: 7947fbdd8c0ecc7d81206aacee0fb41464525b34c858e8562fd4663b26f98cc808c4c3757397703e0c1fd8ea75512f6500dd4aeb7f4efd938544d018c19a9102
+  data.tar.gz: 2b218795188a34caea06f4a0332f063ea030ddecb1a2ff2d67e9a337b062e1b00b6fcc57584fcec5e96cdec32a7f587fb3166ed7b34e07e1f67086a39f4131de

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+addons:
+  code_climate:
+    repo_token: 86322de3b5909460dccb9d35d43d90178899a4887fefc28b2bf6ac5818708918

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+gem 'rest-client'
+gem 'awesome_print'
+gem 'daybreak'
+
+group :test do
+  gem 'rspec',    '~> 3.1'
+  gem 'simplecov', require: false
+  gem 'codeclimate-test-reporter', require: false
+end

data/History

@@ -0,0 +1,20 @@
+== 0.3.0 2015-04-09
+
+* refactored payload generation
+
+== 0.2.1 2015-04-08
+
+* minor change to default naming
+
+== 0.2.0 2015-04-08
+
+* added persistence layer
+* ability to track and update incidents between Client runs
+
+== 0.1.0 2015-04-04
+
+* Initial deployment
+
+== 0.0.1 2015-04-03
+
+* Initial development

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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,60 @@
+[![Gem Version](https://img.shields.io/gem/v/victor_ops-client.svg)](https://rubygems.org/gems/victor_ops-client)
+[![Build Status](https://travis-ci.org/clok/victor-ops-client.svg?branch=master)](https://travis-ci.org/clok/victor-ops-client)
+[![Code Climate](https://codeclimate.com/github/clok/victor-ops-client/badges/gpa.svg)](https://codeclimate.com/github/clok/victor-ops-client)
+[![Test Coverage](https://codeclimate.com/github/clok/victor-ops-client/badges/coverage.svg)](https://codeclimate.com/github/clok/victor-ops-client)
+
+VictorOps Ruby Client
+---
+
+A simple REST API client for use with the [VictorOps REST API](http://victorops.force.com/knowledgebase/articles/Integration/Alert-Ingestion-API-Documentation/)
+
+# Install
+
+```
+gem install victor_ops-client
+```
+
+## Requirements
+
+- Ruby 1.9.3 or higher
+- `rest-client` & `awesome_print`
+- VictorOps API Access
+
+## Example
+
+``` ruby
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require 'victor_ops/client'
+
+# Required for Initializing Client
+API_URL = 'https://alert.victorops.com/REST_END_POINT/API_KEY'
+ROUTING_KEY = 'example_routing_key'
+
+client = VictorOps::Client.new api_url: API_URL, routing_key: ROUTING_KEY
+
+# Send a CRITICAL alert
+client.critical 'THE DISK IS FULL!!!'
+
+# Send a WARNING alert
+client.warn desc: 'Disk is nearing capacity', stats: `df -h`
+
+# Send an INFO alert
+client.info [ 'this', 'is', 'an', 'array' ]
+
+# Send an ACKNOWLEDGMENT
+client.ack 'bot ack'
+
+# Send a RECOVERY
+client.recovery desc: 'Disk has space', emoji: ':saiyan:'
+```
+
+## Contributing
+
+* Fork the project.
+* Run `bundle install`
+* Run `bundle exec rake`
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Run `bundle exec rake` (No, REALLY :))
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,9 @@
+ENV['CODECLIMATE_REPO_TOKEN'] = '86322de3b5909460dccb9d35d43d90178899a4887fefc28b2bf6ac5818708918'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: [:spec]

data/examples/test.rb

@@ -0,0 +1,25 @@
+#! /usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require 'victor_ops/client'
+
+# Required for Initializing Client
+API_URL = 'INSERT_URL_HERE'
+ROUTING_KEY = 'INSERT_ROUTING_KEY_HERE'
+
+client = VictorOps::Client.new api_url: API_URL, routing_key: ROUTING_KEY
+
+# Send a CRITICAL alert
+client.critical 'THE DISK IS FULL!!!'
+
+# Send a WARNING alert
+client.warn desc: 'Disk is nearing capacity', stats: `df -h`
+
+# Send an INFO alert
+client.info [ 'this', 'is', 'an', 'array' ]
+
+# Send an ACKNOWLEDGMENT
+client.ack 'bot ack'
+
+# Send a RECOVERY
+client.recovery desc: 'Disk has space', emoji: ':saiyan:'

data/lib/victor_ops/client.rb

@@ -0,0 +1,155 @@
+require 'victor_ops/defaults'
+require 'victor_ops/client/version'
+require 'victor_ops/client/exceptions'
+require 'victor_ops/client/persistence'
+
+module VictorOps
+  class Client
+    require 'ostruct'
+    require 'awesome_print'
+    require 'json'
+    require 'rest-client'
+
+    attr_accessor :settings
+
+    def initialize(opts)
+      @settings = OpenStruct.new opts
+      AwesomePrint.defaults = { indent: -2, plain: true }
+      set_default_settings
+      configure_data_store unless settings.persist.nil?
+      raise VictorOps::Client::MissingSettings unless valid_settings?
+    end
+
+    def entity_display_name
+      if settings.entity_display_name.nil?
+        "#{settings.host}/#{settings.name}"
+      else
+        settings.entity_display_name
+      end
+    end
+
+    def entity_display_name=(str)
+      settings.entity_display_name = str
+    end
+
+    def monitoring_tool
+      if settings.monitoring_tool.nil?
+        "#{settings.routing_key}::#{settings.name}"
+      else
+        settings.monitoring_tool
+      end
+    end
+
+    def monitoring_tool=(str)
+      settings.monitoring_tool = str
+    end
+
+    def critical(data)
+      post critical_payload(data)
+    end
+
+    def warn(data)
+      post warn_payload(data)
+    end
+
+    def info(data)
+      post info_payload(data)
+    end
+
+    def ack(data)
+      post ack_payload(data)
+    end
+
+    def recovery(data)
+      post recovery_payload(data)
+    end
+
+  private
+
+    def epochtime
+      Time.now.to_i
+    end
+
+    def set_default_settings
+      settings.host = VictorOps::Defaults::HOST if settings.host.nil?
+      settings.name = VictorOps::Defaults::NAME if settings.name.nil?
+    end
+
+    def endpoint
+      "#{settings.api_url}/#{settings.routing_key}"
+    end
+
+    def post(payload)
+      resp = nil
+      begin
+        json = RestClient.post endpoint, payload.to_json
+        resp = JSON::parse(json)
+        raise VictorOps::Client::PostFailure, "Response from VictorOps contains a failure message: #{resp.ai}" if resp['result'] == 'failure'
+      rescue Exception => e
+        raise VictorOps::Client::PostFailure, "Error posting to VictorOps: #{e}"
+      end
+      resp
+    end
+
+    def generate_payload(data)
+      if data.nil? || data[:vo_alert_type].nil?
+        raise VictorOps::Client::MissingMessageType
+      end
+      payload = {
+        message_type: data.delete(:vo_alert_type),
+        state_start_time: epochtime,
+        entity_display_name: entity_display_name,
+        monitoring_tool: monitoring_tool,
+      }
+      payload.merge! data
+      payload.delete_if { |k,v| v.nil? }
+    end
+
+    def critical_payload(data)
+      generate_payload data.merge({
+        vo_alert_type: VictorOps::Defaults::MessageTypes::CRITICAL,
+        state_message: data[:message].nil? ? nil : data.delete(:message).ai
+      })
+    end
+
+    def warn_payload(data)
+      generate_payload data.merge({
+        vo_alert_type: VictorOps::Defaults::MessageTypes::WARN,
+        state_message: data[:message].nil? ? nil : data.delete(:message).ai
+      })
+    end
+
+    def info_payload(data)
+      generate_payload data.merge({
+        vo_alert_type: VictorOps::Defaults::MessageTypes::INFO,
+        state_message: data[:message].nil? ? nil : data.delete(:message).ai
+      })
+    end
+
+    def ack_payload(data)
+      generate_payload data.merge({
+        vo_alert_type: VictorOps::Defaults::MessageTypes::ACK,
+        ack_msg: data[:message].nil? ? nil : data.delete(:message).ai,
+        ack_author: data[:author].nil? ? monitoring_tool : data.delete(:author)
+      })
+    end
+
+    def recovery_payload(data)
+      generate_payload data.merge({
+        vo_alert_type: VictorOps::Defaults::MessageTypes::RECOVERY,
+        state_message: data[:message].nil? ? nil : data.delete(:message).ai
+      })
+    end
+
+    def valid_settings?
+      valid = true
+      [:api_url, :routing_key].each do |k|
+        next if valid == false
+        valid = false unless settings.send(k)
+      end
+      settings.api_url.chop! if settings.api_url =~ /\/$/
+      valid
+    end
+
+  end
+end

data/lib/victor_ops/client/exceptions.rb

@@ -0,0 +1,15 @@
+module VictorOps
+  class Client
+
+    class Error < StandardError; end
+
+    class MissingSettings < Error; end
+
+    class PostFailure < Error; end
+
+    class MissingMessageType < Error; end
+
+    class NotYetImplemented < Error; end
+
+  end
+end

data/lib/victor_ops/client/persistence.rb

@@ -0,0 +1,31 @@
+module VictorOps
+  class Client
+    require 'daybreak'
+    
+    attr_accessor :db
+
+    def configure_data_store
+      settings.store_file = VictorOps::Defaults::Daybreak::PATH unless settings.store_file
+      @db = Daybreak::DB.new settings.store_file
+      ObjectSpace.define_finalizer(self, proc { shutdown })
+    end
+
+    def set(key, value)
+      db.set! key, value
+    end
+
+    def retrieve(key)
+      db[key]
+    end
+
+    def delete(key)
+      db.delete! key
+    end
+
+    def shutdown
+      db.flush
+      db.compact
+      db.close
+    end
+  end
+end

data/lib/victor_ops/client/version.rb

@@ -0,0 +1,5 @@
+module VictorOps
+  class Client
+    VERSION = '0.3.0'
+  end
+end

data/lib/victor_ops/defaults.rb

@@ -0,0 +1,18 @@
+module VictorOps
+  module Defaults
+  	HOST = 'localhost'
+  	NAME = 'ruby REST client'
+    
+    module MessageTypes
+      INFO = 'INFO'
+      WARN = 'WARNING'
+      ACK  = 'ACKNOWLEDGEMENT'
+      CRITICAL = 'CRITICAL'
+      RECOVERY = 'RECOVERY'
+    end
+
+    module Daybreak
+      PATH = '/tmp/victor_ops-client.db'
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,407 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+RSpec.describe VictorOps::Client do
+  before do
+    @valid_params = { api_url: 'test url', routing_key: 'test key' }
+  end
+
+  describe 'settings' do
+    before do
+      @client = VictorOps::Client.new @valid_params.merge(option: 'this is working')
+    end
+
+    it 'should return an OpenStruct hash with the input options hash as settings methods' do
+      expect(@client.settings).to be_a(OpenStruct)
+      expect(@client.settings.api_url).to eq 'test url'
+      expect(@client.settings.routing_key).to eq 'test key'
+      expect(@client.settings.option).to eq 'this is working'
+      expect(@client.settings.not_a_passed_option).to be_nil
+    end
+  end
+
+  describe '.monitoring_tool' do
+    context 'a parameter is provided on initialization' do
+      before do
+        @client = VictorOps::Client.new @valid_params.merge(monitoring_tool: 'monitorting tool')
+      end
+
+      it 'should return the passed in name' do
+        expect(@client.monitoring_tool).to eq 'monitorting tool'
+      end
+    end
+
+    context 'default initialization' do
+      before do
+        @client = VictorOps::Client.new @valid_params
+      end
+
+      it 'should return the default name' do
+        expect(@client.monitoring_tool).to eq 'test key::ruby REST client'
+      end
+    end
+  end
+
+  describe '.monitoring_tool=' do
+    it 'should set the entity_display_name name' do
+      @client = VictorOps::Client.new @valid_params
+      @client.monitoring_tool = 'cool name bro'
+      expect(@client.monitoring_tool).to eq 'cool name bro'
+    end
+  end
+
+  describe '.entity_display_name' do
+    context 'a parameter is provided on initialization' do
+      before do
+        @client = VictorOps::Client.new @valid_params.merge(entity_display_name: 'super cool tool')
+      end
+
+      it 'should return the passed in nanme' do
+        expect(@client.entity_display_name).to eq 'super cool tool'
+      end
+    end
+
+    context 'default initialization' do
+      before do
+        @client = VictorOps::Client.new @valid_params
+      end
+
+      it 'should return the default name' do
+        expect(@client.entity_display_name).to eq 'localhost/ruby REST client'
+      end
+    end
+  end
+
+  describe '.entity_display_name=' do
+    it 'should set the entity_display_name' do
+      @client = VictorOps::Client.new @valid_params
+      @client.entity_display_name = 'cool name bro'
+      expect(@client.entity_display_name).to eq 'cool name bro'
+    end
+  end
+
+  describe '.critical' do
+    before do
+      @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+      allow(@client).to receive(:post).and_return(file_fixture_to_json('victor_ops_success.json'))
+    end
+
+    it 'should resturn the result of the post to VictorOps' do
+      resp = @client.critical(message: 'test')
+      expect(resp).to be_a(Hash)
+      expect(resp['result']).to eq 'success'
+    end
+  end
+
+  describe '.warn' do
+    before do
+      @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+      allow(@client).to receive(:post).and_return(file_fixture_to_json('victor_ops_success.json'))
+    end
+
+    it 'should resturn the result of the post to VictorOps' do
+      resp = @client.warn(message: 'test')
+      expect(resp).to be_a(Hash)
+      expect(resp['result']).to eq 'success'
+    end
+  end
+
+  describe '.info' do
+    before do
+      @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+      allow(@client).to receive(:post).and_return(file_fixture_to_json('victor_ops_success.json'))
+    end
+
+    it 'should resturn the result of the post to VictorOps' do
+      resp = @client.info(message: 'test')
+      expect(resp).to be_a(Hash)
+      expect(resp['result']).to eq 'success'
+    end
+  end
+
+  describe '.ack' do
+    before do
+      @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+      allow(@client).to receive(:post).and_return(file_fixture_to_json('victor_ops_success.json'))
+    end
+
+    it 'should resturn the result of the post to VictorOps' do
+      resp = @client.ack(message: 'test')
+      expect(resp).to be_a(Hash)
+      expect(resp['result']).to eq 'success'
+    end
+  end
+
+  describe '.recovery' do
+    before do
+      @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+      allow(@client).to receive(:post).and_return(file_fixture_to_json('victor_ops_success.json'))
+    end
+
+    it 'should resturn the result of the post to VictorOps' do
+      resp = @client.recovery(message: 'test')
+      expect(resp).to be_a(Hash)
+      expect(resp['result']).to eq 'success'
+    end
+  end
+
+  context 'private methods' do
+  	describe '.valid_settings?' do
+      context 'settings include required items' do
+        before do
+          @client = VictorOps::Client.new @valid_params
+        end
+
+        it 'should return true' do
+          expect(@client.send(:valid_settings?)).to be_truthy
+        end
+      end
+
+      context 'the api url has a slash at the end' do
+        before do
+          @client = VictorOps::Client.new api_url: 'slashy/url/', routing_key: 'test key'
+        end
+
+        it 'should return true' do
+          expect(@client.send(:valid_settings?)).to be_truthy
+          expect(@client.settings.api_url).to_not end_with('/')
+          expect(@client.settings.api_url).to eq 'slashy/url'
+        end
+      end
+
+      context 'the api url has no slash at the end' do
+        before do
+          @client = VictorOps::Client.new api_url: 'no/slashy/url', routing_key: 'test key'
+        end
+
+        it 'should return true' do
+          expect(@client.send(:valid_settings?)).to be_truthy
+          expect(@client.settings.api_url).to_not end_with('/')
+          expect(@client.settings.api_url).to eq 'no/slashy/url'
+        end
+      end
+
+      context 'settings do not include required items' do
+        before do
+          @client = VictorOps::Client.new @valid_params
+          @client.settings.routing_key = nil
+        end
+
+        it 'should return false' do
+          expect(@client.send(:valid_settings?)).to be_falsey
+        end
+      end
+    end
+
+    describe '.generate_payload' do
+      before do
+        @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+      end
+
+      context 'a nil hash was passed in' do
+        it 'should raise an expetion for no message_type provided' do
+          expect { @client.send(:generate_payload, nil) }.to raise_exception(VictorOps::Client::MissingMessageType)
+        end
+      end
+
+      context 'a hash without required message_type' do
+        it 'should raise an expetion for no message_type provided' do
+          expect { @client.send(:generate_payload, {stuff: 'test'}) }.to raise_exception(VictorOps::Client::MissingMessageType)
+        end
+      end
+
+      context 'a properly formed hash is passed in' do
+        it 'should return a payload hash' do
+          payload = @client.send(:generate_payload, {vo_alert_type: 'TEST'})
+          expect(payload[:message_type]).to eq 'TEST'
+          expect(payload[:state_start_time]).to be_a(Fixnum)
+          expect(payload[:entity_display_name]).to be_a(String)
+          expect(payload[:monitoring_tool]).to be_a(String)
+        end
+      end
+
+      context 'a properly formed hash is passed in with extra variables' do
+        it 'should return a payload hash' do
+          payload = @client.send(:generate_payload, {vo_alert_type: 'TEST', special_var: 'i am special'})
+          expect(payload[:message_type]).to eq 'TEST'
+          expect(payload[:special_var]).to eq 'i am special'
+          expect(payload[:state_start_time]).to be_a(Fixnum)
+          expect(payload[:entity_display_name]).to be_a(String)
+          expect(payload[:monitoring_tool]).to be_a(String)
+        end
+      end
+
+      context 'a properly formed hash is passed in with nil values' do
+        it 'should return a payload hash with the nil values removed' do
+          payload = @client.send(:generate_payload, {vo_alert_type: 'TEST', special_var: 'i am special', nil_value: nil})
+          expect(payload[:message_type]).to eq 'TEST'
+          expect(payload[:special_var]).to eq 'i am special'
+          expect(payload[:state_start_time]).to be_a(Fixnum)
+          expect(payload[:entity_display_name]).to be_a(String)
+          expect(payload[:monitoring_tool]).to be_a(String)
+          expect(payload.has_key?(:nil_value)).to be_falsey
+        end
+      end
+    end
+
+    context 'utility methods' do
+      before do
+        @client = VictorOps::Client.new @valid_params
+      end
+
+      describe '.epochtime' do
+        it 'should return the current time in intenger form' do
+          expect(@client.send(:epochtime)).to be_a(Fixnum)
+        end
+      end
+
+      describe '.set_default_settings' do
+        context 'no overides provided' do
+          it 'should set the default settings for the client' do
+            expect(@client.settings.host).to eq 'localhost'
+            expect(@client.settings.name).to eq 'ruby REST client'
+          end
+        end
+
+        context 'overides provided' do
+          before do
+            @client = VictorOps::Client.new @valid_params.merge(host: 'db1.com', name: 'jester')
+          end
+
+          it 'should set the settings to the overides for the client' do
+            expect(@client.settings.host).to eq 'db1.com'
+            expect(@client.settings.name).to eq 'jester'
+          end
+        end
+      end
+
+      describe '.endpoint' do
+        before do
+          @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+        end
+
+        it 'should provide the proper REST endpoint to post to' do
+          expect(@client.send(:endpoint)).to eq 'http://victorops.com/1234'
+        end
+      end
+
+      describe '.post' do
+        context 'there is a failure response from VictorOps' do
+          before do
+            @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+            allow(RestClient).to receive(:post).and_return(file_fixture('victor_ops_failure.json'))
+          end
+
+          it 'should raise an exception' do
+            expect { @client.send(:post, { test: 'hash' } ) }.to raise_exception(VictorOps::Client::PostFailure)
+          end
+        end
+
+        context 'there is a failure while posting to VictorOps' do
+          before do
+            @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+            allow(RestClient).to receive(:post).and_raise(Exception.new('test exception'))
+          end
+
+          it 'should raise an exception' do
+            expect { @client.send(:post, { test: 'hash' } ) }.to raise_exception(VictorOps::Client::PostFailure)
+          end
+        end
+
+        context 'the POST is successful' do
+          before do
+            @client = VictorOps::Client.new api_url: 'http://victorops.com', routing_key: '1234'
+            allow(RestClient).to receive(:post).and_return(file_fixture('victor_ops_success.json'))
+          end
+
+          it 'return the parsed response' do
+            resp = @client.send(:post, { test: 'hash' } )
+            expect(resp).to be_a(Hash)
+            expect(resp['result']).to eq 'success'
+            expect(resp['entity_id']).to be_a(String)
+          end
+        end
+      end
+
+      describe '.critical_payload' do
+        it 'should return a Hash without duplicate data' do
+          data = @client.send(:critical_payload, message: 'test')
+          expect(data).to be_a(Hash)
+          expect(data[:message_type]).to eql 'CRITICAL'
+          expect(data[:entity_display_name]).to_not be_nil
+          expect(data[:monitoring_tool]).to_not be_nil
+          expect(data[:state_message]).to eq '"test"'
+          expect(data[:message]).to be_nil
+        end
+      end
+
+      describe '.warn_payload' do
+        it 'should return a Hash without duplicate data' do
+          data = @client.send(:warn_payload, message: 'test')
+          expect(data).to be_a(Hash)
+          expect(data[:message_type]).to eql 'WARNING'
+          expect(data[:entity_display_name]).to_not be_nil
+          expect(data[:monitoring_tool]).to_not be_nil
+          expect(data[:state_message]).to eq '"test"'
+          expect(data[:message]).to be_nil
+        end
+      end
+
+      describe '.info_payload' do
+        it 'should return a Hash without duplicate data' do
+          data = @client.send(:info_payload, message: 'test')
+          expect(data).to be_a(Hash)
+          expect(data[:message_type]).to eql 'INFO'
+          expect(data[:entity_display_name]).to_not be_nil
+          expect(data[:monitoring_tool]).to_not be_nil
+          expect(data[:state_message]).to eq '"test"'
+          expect(data[:message]).to be_nil
+        end
+      end
+
+      describe '.ack_payload' do
+        context 'no author provided' do
+          it 'should return a Hash without duplicate data' do
+            data = @client.send(:ack_payload, message: 'test')
+            expect(data).to be_a(Hash)
+            expect(data[:message_type]).to eql 'ACKNOWLEDGEMENT'
+            expect(data[:entity_display_name]).to_not be_nil
+            expect(data[:monitoring_tool]).to_not be_nil
+            expect(data[:state_message]).to be_nil
+            expect(data[:ack_msg]).to eq '"test"'
+            expect(data[:ack_author]).to eq data[:monitoring_tool]
+            expect(data[:message]).to be_nil
+          end
+        end
+
+        context 'an author is provieded' do
+          it 'should return a Hash without duplicate data' do
+            data = @client.send(:ack_payload, message: 'test', author: 'test author')
+            expect(data).to be_a(Hash)
+            expect(data[:message_type]).to eql 'ACKNOWLEDGEMENT'
+            expect(data[:entity_display_name]).to_not be_nil
+            expect(data[:monitoring_tool]).to_not be_nil
+            expect(data[:state_message]).to be_nil
+            expect(data[:ack_msg]).to eq '"test"'
+            expect(data[:ack_author]).to eq 'test author'
+            expect(data[:message]).to be_nil
+            expect(data[:author]).to be_nil
+          end
+        end
+      end
+
+      describe '.recovery_payload' do
+        it 'should return a Hash without duplicate data' do
+          data = @client.send(:recovery_payload, message: 'test')
+          expect(data).to be_a(Hash)
+          expect(data[:message_type]).to eql 'RECOVERY'
+          expect(data[:entity_display_name]).to_not be_nil
+          expect(data[:monitoring_tool]).to_not be_nil
+          expect(data[:state_message]).to eq '"test"'
+          expect(data[:message]).to be_nil
+        end
+      end
+    end
+
+  end
+
+end

data/spec/defaults_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+RSpec.describe VictorOps::Defaults do
+  describe 'MessageTypes' do
+  	it 'should be have VictorOps defined values' do
+      expect(VictorOps::Defaults::MessageTypes::INFO).to eq 'INFO'
+      expect(VictorOps::Defaults::MessageTypes::WARN).to eq 'WARNING'
+      expect(VictorOps::Defaults::MessageTypes::CRITICAL).to eq 'CRITICAL'
+      expect(VictorOps::Defaults::MessageTypes::ACK).to eq 'ACKNOWLEDGEMENT'
+      expect(VictorOps::Defaults::MessageTypes::RECOVERY).to eq 'RECOVERY'
+    end
+  end
+
+  describe 'client defautlts' do
+  	it 'should have generic defaults set' do
+      expect(VictorOps::Defaults::HOST).to eq 'localhost'
+      expect(VictorOps::Defaults::NAME).to eq 'ruby REST client'
+  	end
+  end
+
+  describe 'daybreak defaults' do
+    it 'should have defaults needed for daybreak persistence' do
+      expect(VictorOps::Defaults::Daybreak::PATH).to eq '/tmp/victor_ops-client.db'
+    end
+  end
+end

data/spec/fixtures/victor_ops_failure.json

@@ -0,0 +1,4 @@
+{
+  "result": "failure",
+  "entity_id": "Missing something important"
+}

data/spec/fixtures/victor_ops_success.json

@@ -0,0 +1,4 @@
+{
+  "result": "success",
+  "entity_id": "392c55f1-f5b6-42fa-b6d9-8aa033465ce6"
+}

data/spec/persistence_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+RSpec.describe VictorOps::Client do
+  before do
+    @valid_params = { api_url: 'test url', routing_key: 'test key' }
+  end
+
+  context 'persistence layer' do
+  	describe 'client does not want persistence' do
+      before do
+        @client = VictorOps::Client.new @valid_params.merge(persist: nil)
+      end
+
+    	it 'should not configure daybreak' do
+        expect(@client.settings.test).to be_nil
+      end
+    end
+
+    context 'client does want persistence' do
+      before do
+        @client = VictorOps::Client.new @valid_params.merge(persist: true, store_file: 'tmp/test.db')
+      end
+
+      after do
+        @client.shutdown
+      end
+
+      it 'should configure daybreak' do
+        expect(@client.settings.store_file).to eq 'tmp/test.db'
+        expect(@client.db).to be_a(Daybreak::DB)
+      end
+
+      it 'should allow for interactions with the database directly' do
+        @client.db.set! 'test', 'worked'
+        expect(@client.db['test']).to eq 'worked'
+        expect(@client.db.include?('test')).to be_truthy
+        @client.db.delete 'test'
+        expect(@client.db.include?('test')).to be_falsey
+        expect(@client.db['test']).to be_nil
+      end
+
+      describe '.set' do
+        it 'will allow the setting of persisted values' do
+          @client.set('answer to all', 42)
+          expect(@client.db['answer to all']).to eq 42
+          @client.shutdown
+          @client = VictorOps::Client.new @valid_params.merge(persist: true, store_file: 'tmp/test.db')
+          expect(@client.db['answer to all']).to eq 42
+        end
+      end
+
+      describe '.retrieve' do
+        it 'will retrieve a persisted value' do
+          @client.set('tester', 'woot')
+          expect(@client.retrieve('tester')).to eq 'woot'
+          expect(@client.retrieve('not in here')).to be_nil
+          @client.shutdown
+          @client = VictorOps::Client.new @valid_params.merge(persist: true, store_file: 'tmp/test.db')
+          expect(@client.retrieve('tester')).to eq 'woot'
+          expect(@client.retrieve('not in here')).to be_nil
+        end
+      end
+
+      describe '.delete' do
+        it 'will delete a persisted value' do
+          @client.set('this will be deleted', 'woot')
+          expect(@client.delete('this will be deleted')).to eq 'woot'
+          @client.shutdown
+          @client = VictorOps::Client.new @valid_params.merge(persist: true, store_file: 'tmp/test.db')
+          expect(@client.delete('this will be deleted')).to be_nil
+        end
+      end      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  CodeClimate::TestReporter::Formatter
+]
+SimpleCov.start
+
+require 'victor_ops/client'
+require 'json'
+
+def file_fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+end
+
+def file_fixture_to_json(filename)
+  JSON::parse(open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read)
+end
+
+def file_fixture_path(filename)
+  File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")
+end
+
+def open_tmp_file(filename)
+  open(File.join(File.dirname(__FILE__), '..', 'tmp', "#{filename.to_s}")).read
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = false
+  end
+
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+  # config.profile_examples = 10
+
+  config.disable_monkey_patching!
+
+  config.warnings = false
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.after(:suite) do
+    FileUtils.rm('tmp/test.db') if File.exist? 'tmp/test.rb'
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+RSpec.describe VictorOps::Client do
+  describe "version" do
+    it 'should be a string type' do
+      expect(VictorOps::Client::VERSION).to be_a(String)
+    end
+  end
+end

data/victor_ops-client.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'victor_ops/client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'victor_ops-client'
+  s.version     = VictorOps::Client::VERSION
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = "VictorOps Client"
+  s.description = "A gem that will allow for consistent usage of the VictorOps service from within a script or daemon."
+  s.authors     = ["Derek Smith"]
+  s.email       = 'derek@clokwork.net'
+  s.homepage    = 'http://clokwork.net'
+  
+  s.files         = `git ls-files`.split("\n").compact
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_dependency 'rest-client', '~> 1.8', '>= 1.8.0'
+  s.add_dependency 'awesome_print', '~> 1.6', '>= 1.6.1'
+  s.add_dependency 'daybreak', '~> 0.3', '>= 0.3.0'
+  s.add_development_dependency "rspec", '~> 3.0'
+
+  s.license = 'MIT'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: victor_ops-client
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Derek Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: daybreak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem that will allow for consistent usage of the VictorOps service from
+  within a script or daemon.
+email: derek@clokwork.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- History
+- MIT-LICENSE
+- README.md
+- Rakefile
+- db/.keep
+- examples/test.rb
+- lib/victor_ops/client.rb
+- lib/victor_ops/client/exceptions.rb
+- lib/victor_ops/client/persistence.rb
+- lib/victor_ops/client/version.rb
+- lib/victor_ops/defaults.rb
+- spec/client_spec.rb
+- spec/defaults_spec.rb
+- spec/fixtures/.keep
+- spec/fixtures/victor_ops_failure.json
+- spec/fixtures/victor_ops_success.json
+- spec/persistence_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- tmp/.keep
+- victor_ops-client.gemspec
+homepage: http://clokwork.net
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: VictorOps Client
+test_files: []