comsat 0.0.4 → 0.0.5

data/README.md

@@ -68,7 +68,7 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 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", {
@@ -78,6 +78,22 @@ client.notify("notify_on_exception", {
 })
 ```
 
+You can also instrument Comsat with your favorite logger (which should be
+Scrolls by now :)):
+
+```ruby
+require "scrolls"
+require "comsat"
+
+module MyLogger
+  def self.log(data, &blk)
+    Scrolls.log(data, &blk)
+  end
+end
+
+Comsat.instrument_with(MyLogger.method(:log))
+```
+
 ## Contributing
 
 1. Fork it

data/lib/comsat/client.rb

@@ -0,0 +1,59 @@
+module Comsat
+  class Client
+    attr_accessor :routes
+
+    def initialize
+      @@routes = []
+    end
+
+    def routes
+      @@routes
+    end
+
+    def create_route(route, event_type, services)
+      start = Time.now
+      Comsat.log(:fn => :create_route, :at => :start)
+      unless routes.detect {|r| r.name == route }
+        routes << Route.new(route, event_type, services)
+      end
+      Comsat.log(:fn => :create_route, :at => :finish, :elapsed => Time.now - start)
+    end
+
+    def notify(route, message={})
+      start = Time.now
+      Comsat.log(:fn => :notify, :at => :start)
+      notify_route = @@routes.detect {|r| r.name == route } if message
+      event = notify_route.event_type
+      notify_route.services.each do |svc|
+        Comsat.log(:fn => :notify, :service => "#{svc.class.to_s.downcase}", :event => event)
+        svc.send("send_#{event}".to_sym, message)
+      end
+      Comsat.log(:fn => :notify, :at => :finish, :elapsed => Time.now - start)
+    end
+
+    def send_notice(data)
+      send_event(:notice, data)
+    end
+
+    def send_alert(data)
+      send_event(:alert, data)
+    end
+
+    def send_resolve(data)
+      send_event(:resolve, data)
+    end
+
+    private
+
+    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
+  end
+end

data/lib/comsat/service.rb

@@ -12,4 +12,14 @@ module Comsat
       end
     end
   end
+
+  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/lib/comsat/version.rb

@@ -1,3 +1,3 @@
 module Comsat
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/comsat.rb

@@ -1,9 +1,8 @@
 require "cgi"
 require "json"
 require "rest_client"
-require "scrolls"
 
-require "comsat/log"
+require "comsat/client"
 require "comsat/route"
 require "comsat/service"
 require "comsat/version"
@@ -14,65 +13,20 @@ require "comsat/services/campfire"
 require "comsat/services/pagerduty"
 
 module Comsat
-  class Client
 
-    attr_accessor :routes
-
-    def initialize
-      @@routes = []
-    end
-
-    def routes
-      @@routes
-    end
-
-    def create_route(route, event_type, services)
-      unless routes.detect {|r| r.name == route }
-        routes << Route.new(route, event_type, services)
-      end
-    end
-
-    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
-    end
-
-    def send_notice(data)
-      send_event(:notice, data)
-    end
-
-    def send_alert(data)
-      send_event(:alert, data)
-    end
-
-    def send_resolve(data)
-      send_event(:resolve, data)
-    end
+  def self.merge(data1, data2)
+    data1.merge(data2)
+  end
 
-    private
+  def self.instrument_with(logger)
+    @logger = logger
+  end
 
-    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
+  def self.logger
+    @logger || STDOUT.method(:puts)
   end
 
-  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
+  def self.log(data, &blk)
+    logger.call({:lib => :comsat}.merge(data), &blk)
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,18 @@
 $: << File.expand_path("../../lib", __FILE__)
 
 require 'comsat'
+require 'scrolls'
+require 'stringio'
+
+Scrolls::Log.start(StringIO.new)
+
+module TestLogger
+  def self.log(data, &blk)
+    Scrolls.log(data, &blk)
+  end
+end
+
+Comsat.instrument_with(TestLogger.method(:log))
 
 RSpec.configure do |c|
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comsat
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000 Z
+date: 2012-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70177295796840 !ruby/object:Gem::Requirement
+  requirement: &70103077796900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70177295796840
+  version_requirements: *70103077796900
 - !ruby/object:Gem::Dependency
   name: scrolls
-  requirement: &70177295796100 !ruby/object:Gem::Requirement
+  requirement: &70103077794340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70177295796100
+  version_requirements: *70103077794340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70177295795660 !ruby/object:Gem::Requirement
+  requirement: &70103077792600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177295795660
+  version_requirements: *70103077792600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70177295795180 !ruby/object:Gem::Requirement
+  requirement: &70103077791160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177295795180
+  version_requirements: *70103077791160
 description: Notifications as a Gem
 email:
 - ops@heroku.com
@@ -70,8 +70,8 @@ files:
 - Rakefile
 - comsat.gemspec
 - lib/comsat.rb
+- lib/comsat/client.rb
 - lib/comsat/helpers/auth_helper.rb
-- lib/comsat/log.rb
 - lib/comsat/route.rb
 - lib/comsat/service.rb
 - lib/comsat/services/campfire.rb

data/lib/comsat/log.rb

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