comsat 0.0.1 → 0.0.2

data/README.md

@@ -14,6 +14,19 @@ for Campfire might look like:
 The schema name maps to the service name, the rest we pass to the service to
 deal with.
 
+## Routes
+
+Routes allow the user to create aliases for contacting one or more services
+for a specific event. An event is one of 'notice', 'alert' or 'resolve'.
+Routes should be named according to their function, and initially are not
+stored longer than a session, but will eventually be created and reside on
+the server.
+
+It is our intention to start developing usage patterns consistent with our
+defined design goals.
+
+The examples below show how routes are created.
+
 ## Messages
 
 Messages should be one of three types, 'notice', 'alert', 'resolve'.
@@ -56,8 +69,13 @@ Or install it yourself as:
 ## Usage
 
 ```
-client = Comsat::Client.new(["campfire://<api_key>:X@blossom.campfirenow.com/Test%20Room"])
-client.send_notice({:message => "message here", :source => "nagios", :message_id => "unique_id"})
+client = Comsat::Client.new
+client.create_route("notify_on_exception", "notice", ["campfire://<api_key>:X@blossom.campfirenow.com/Test%20Room"])
+client.notify("notify_on_exception", {
+  :message => "Exception reached in #function",
+  :source => "my_app",
+  :message_id => "exception-#{rand(1_000)}"
+})
 ```
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,8 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+end

data/comsat.gemspec

@@ -2,10 +2,10 @@
 require File.expand_path('../lib/comsat/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["curt@heroku.com", "gorsuch@heroku.com"]
+  gem.authors       = ["Curt Micol", "Michael Gorsuch"]
   gem.email         = ["ops@heroku.com"]
-  gem.description   = "Early notification gem"
-  gem.summary       = "Early notification gem"
+  gem.description   = "Notifications as a Gem"
+  gem.summary       = "Notifications as a Gem"
   gem.homepage      = ""
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -16,5 +16,9 @@ Gem::Specification.new do |gem|
   gem.version       = Comsat::VERSION
 
   gem.add_runtime_dependency('rest-client')
+  gem.add_runtime_dependency('scrolls')
   gem.add_runtime_dependency('tinder')
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec')
 end

data/lib/comsat/helpers/auth_helper.rb

@@ -0,0 +1,28 @@
+require 'cgi'
+require 'ostruct'
+require 'uri'
+
+module Comsat
+  module AuthHelper
+
+    def self.parse(url)
+      parse_url(url)
+      OpenStruct.new(to_hash)
+    end
+
+    def self.parse_url(url)
+      @uri = URI.parse(url)
+    end
+
+    def self.to_hash
+      {
+        :name     => @uri.scheme,
+        :api_key  => @uri.user,
+        :username => @uri.user,
+        :password => @uri.password,
+        :host     => @uri.host,
+        :scope    => CGI.unescape(@uri.path.gsub(/\A\//, ''))
+      }
+    end
+  end
+end

data/lib/comsat/log.rb

@@ -0,0 +1,16 @@
+module Comsat
+  module Log
+    def self.start
+      Scrolls::Log.start
+      log(ns: "log", fn: "start")
+    end
+
+    def self.merge(data1, data2)
+      data1.merge(data2)
+    end
+
+    def self.log(data, &blk)
+      Scrolls.log(merge({app: "comsat"}, data), &blk)
+    end
+  end
+end

data/lib/comsat/route.rb

@@ -0,0 +1,23 @@
+module Comsat
+  class Route
+    attr_accessor :name, :services, :event_type
+
+    def initialize(route, et, urls)
+      @name = route
+      @event_type = et if %w(alert notice resolve).include?(et)
+      @services = []
+      urls.each do |url|
+        svc = ServiceFactory.create(url)
+        if svc.respond_to?("send_#{@event_type}")
+          @services << svc
+        else
+          next
+        end
+      end
+    end
+
+    def to_s
+      "#<#{self.class} @name='#{@name}', @event='#{@event_type}', @services=#{@services.each {|s| s.to_s }}>"
+    end
+  end
+end

data/lib/comsat/service.rb

@@ -0,0 +1,15 @@
+module Comsat
+  module Service
+    class Base
+      attr_reader :credentials
+
+      def initialize(url)
+        @credentials = Comsat::AuthHelper.parse(url)
+      end
+
+      def to_s
+        "#<#{self.class} @host='#{@credentials.host}', @scope='#{@credentials.scope}'>"
+      end
+    end
+  end
+end

data/lib/comsat/services/campfire.rb

@@ -0,0 +1,33 @@
+module Comsat
+  class Campfire < Service::Base
+    def send_notice(data)
+      # {:messages, :source, :message_id}
+      messages = []
+      messages << "[#{data[:source]}] #{data[:message]}"
+      send_message(messages)
+    end
+    alias :send_alert :send_notice
+    alias :send_resolve :send_notice
+
+    private
+
+    def send_message(msgs)
+      unless room = find_room
+        raise "Unable to find room"
+      end
+      Array(msgs).each {|line| room.speak line }
+    end
+
+    def campfire
+      @campfire = ::Tinder::Campfire.new(
+        @credentials.host.split('.')[0],
+        :ssl => true,
+        :token => @credentials.api_key
+      )
+    end
+
+    def find_room
+      campfire.find_room_by_name(@credentials.scope)
+    end
+  end
+end

data/lib/comsat/services/pagerduty.rb

@@ -0,0 +1,31 @@
+module Comsat
+  class PagerDuty < Service::Base
+    PAGERDUTY_ENDPOINT = 'https://events.pagerduty.com/generic/2010-04-15/create_event.json'
+
+    def send_notice(data)
+      contact_pagerduty(:trigger, data)
+    end
+    alias :send_alert :send_notice
+
+    def send_resolve(data)
+      contact_pagerduty(:resolve, data)
+    end
+
+    private
+
+    def contact_pagerduty(event_type, data)
+      id         = data[:message_id] || SecureRandom.uuid
+      message    = data[:message]
+      source     = data[:source]
+      message = "#{source}: #{message}"
+
+      data = {
+        :service_key => @credentials.api_key,
+        :incident_key => id,
+        :event_type => event_type,
+        :description => message
+      }
+      RestClient.post PAGERDUTY_ENDPOINT, data.to_json, :content_type => :json
+    end
+  end
+end

data/lib/comsat/version.rb

@@ -1,3 +1,3 @@
 module Comsat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/comsat.rb

@@ -1,107 +1,82 @@
 require "cgi"
-require "comsat/version"
 require "json"
 require "rest_client"
+require "scrolls"
 require "securerandom"
+
+# Service includes
 require "tinder"
 
+require "comsat/log"
+require "comsat/route"
+require "comsat/service"
+require "comsat/version"
+
+require "comsat/helpers/auth_helper"
+
+require "comsat/services/campfire"
+require "comsat/services/pagerduty"
+
 module Comsat
   class Client
-    def initialize(urls)
-      @urls = urls
-    end
 
-    def send_notice(data)
-      @urls.each do |url|
-        ServiceFactory.create(url).send_notice(data)
-      end
-    end
+    attr_accessor :routes
 
-    def send_alert(data)
-      @urls.each do |url|
-        ServiceFactory.create(url).send_alert(data)
-      end
+    def initialize
+      @@routes = []
     end
 
-    def send_resolve(data)
-      @urls.each do |url|
-        ServiceFactory.create(url).send_resolve(data)
-      end
+    def routes
+      @@routes
     end
-  end
 
-  class ServiceFactory
-    def self.create(url)
-      uri = URI.parse(url)
-      case uri.scheme
-      when 'campfire'
-        Campfire.new(uri)
-      when 'pagerduty'
-        PagerDuty.new(uri)
+    def create_route(route, event_type, services)
+      unless routes.detect {|r| r.name == route }
+        routes << Route.new(route, event_type, services)
       end
     end
-  end
-
-  class Campfire
-    def initialize(uri)
-      @acct = uri.host.split('.')[0]
-      @api_key = uri.user
-      @room = CGI.unescape(uri.path.gsub(/\A\//, ''))
-    end
-
-    def send_notice(data)
-      # {:messages, :source, :message_id}
-      messages = []
-      messages << "[#{data[:source]}] #{data[:message]}"
-      send_message(messages)
-    end
-    alias :send_alert :send_notice
-    alias :send_resolve :send_notice
 
-    def send_message(msgs)
-      unless room = find_room
-        raise "Unable to find room"
+    def notify(route, message={})
+      notify_route = @@routes.detect {|r| r.name == route } if message
+      event = notify_route.event_type
+      notify_route.services.each do |svc|
+        svc.send("send_#{event}".to_sym, message)
       end
-      Array(msgs).each {|line| room.speak line }
     end
 
-    def campfire
-      @campfire = ::Tinder::Campfire.new(
-        @acct,
-        :ssl => true,
-        :token => @api_key
-      )
+    def send_notice(data)
+      send_event(:notice, data)
     end
 
-    def find_room
-      campfire.find_room_by_name(@room)
+    def send_alert(data)
+      send_event(:alert, data)
     end
-  end
 
-  class PagerDuty
-    ENDPOINT = 'https://events.pagerduty.com/generic/2010-04-15/create_event.json'
-    
-    def initialize(uri)
-      @api_key = uri.user
+    def send_resolve(data)
+      send_event(:resolve, data)
     end
 
-    def contact_pagerduty(event_type, data)
-      id         = data[:message_id] || SecureRandom.uuid
-      message    = data[:message]
-      source     = data[:source]
-      message = "#{source}: #{message}"
+    private
 
-      data = { :service_key => @api_key, :incident_key => id, :event_type => event_type, :description => message }
-      RestClient.post ENDPOINT, data.to_json, :content_type => :json
-    end
-    
-    def send_notice(data)
-      contact_pagerduty(:trigger, data)
+    def send_event(event_type, data)
+      @urls.each do |url|
+        service = ServiceFactory.create(url)
+        if service.respond_to?("send_#{event_type}")
+          service.send("send_#{event_type}".to_sym, data)
+        else
+          next
+        end
+      end
     end
-    alias :send_alert :send_notice
+  end
 
-    def send_resolve(data)
-      contact_pagerduty(:resolve, data)
+  class ServiceFactory
+    def self.create(url)
+      svc_name = URI.parse(url).scheme
+      if Comsat.const_defined?(svc_name.capitalize)
+        svc = Comsat.const_get(svc_name.capitalize)
+        svc.new(url)
+      end
     end
   end
 end

data/spec/client_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe Comsat::Client do
+  subject { described_class.new }
+  let(:undefined_svc) { "svc://api_key:X@host/scope" }
+  let(:defined_svc)   { "campfire://api_key:X@blossom.campfirenow.com/scope" }
+
+  describe "#routes" do
+    it "has zero routes configured by default" do
+      subject.routes.should be_empty
+    end
+  end
+
+  describe "#create_route" do
+    before do
+      subject.create_route("test_route", "notice", [undefined_svc, defined_svc])
+    end
+
+    it "should register a route with base class" do
+      subject.routes.should_not be_empty
+    end
+
+    it "should create a route" do
+      subject.routes.first.name.should == "test_route"
+    end
+
+    it "should have one service initiated" do
+      subject.routes.first.services.length.should == 1
+    end
+
+    it "should have a campfire service initiated" do
+      subject.routes.first.services.first.class.should == Comsat::Campfire
+    end
+
+    it "should provide an event type" do
+      subject.routes.first.event_type == "notice"
+    end
+  end
+end

data/spec/service_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe Comsat::Service::Base do
+  let(:unsupported)     { "svc://api_key:X@host/scope" }
+  subject { described_class.new(unsupported) }
+
+  it "should provide credentials in an object" do
+    subject.credentials.class.should == OpenStruct
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'comsat'
+
+RSpec.configure do |c|
+end

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: comsat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
-- curt@heroku.com
-- gorsuch@heroku.com
+- Curt Micol
+- Michael Gorsuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70113286660760 !ruby/object:Gem::Requirement
+  requirement: &70287816065340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70113286660760
+  version_requirements: *70287816065340
+- !ruby/object:Gem::Dependency
+  name: scrolls
+  requirement: &70287816064720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287816064720
 - !ruby/object:Gem::Dependency
   name: tinder
-  requirement: &70113286659660 !ruby/object:Gem::Requirement
+  requirement: &70287816064080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,8 +44,30 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70113286659660
-description: Early notification gem
+  version_requirements: *70287816064080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70287816063540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287816063540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70287816063020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287816063020
+description: Notifications as a Gem
 email:
 - ops@heroku.com
 executables: []
@@ -48,7 +81,16 @@ files:
 - Rakefile
 - comsat.gemspec
 - lib/comsat.rb
+- lib/comsat/helpers/auth_helper.rb
+- lib/comsat/log.rb
+- lib/comsat/route.rb
+- lib/comsat/service.rb
+- lib/comsat/services/campfire.rb
+- lib/comsat/services/pagerduty.rb
 - lib/comsat/version.rb
+- spec/client_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -72,5 +114,8 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Early notification gem
-test_files: []
+summary: Notifications as a Gem
+test_files:
+- spec/client_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb