hatchet-hipchat 0.0.2 → 0.0.3

data/lib/hatchet-hipchat/hipchat_appender.rb

@@ -0,0 +1,64 @@
+module Hatchet
+
+  # Public: Class for sending log messages to a HipChat room.
+  #
+  class HipChatAppender
+    include LevelManager
+
+    # Internal: The class to use to create HipChat clients.
+    #
+    CLIENT = HipChat::API
+
+    # Public: The formatter used to format messages before sending them to the
+    # HipChat room.
+    #
+    attr_accessor :formatter
+
+    # Public: The API token to use to connect to HipChat's API.
+    #
+    attr_accessor :api_token
+
+    # Public: The ID of the room to send messages to.
+    #
+    attr_accessor :room_id
+
+    # Public: The name to post the messages as (default: Hatchet).
+    #
+    attr_accessor :name
+
+    # Public: Creates a new instance.
+    #
+    # By default the appender is created with a SimpleFormatter.
+    #
+    # block  - Optional block that can be used to customize the appender. The
+    #          appender itself is passed to the block.
+    #
+    def initialize
+      @name = 'Hatchet'
+      @formatter = SimpleFormatter.new
+      yield self if block_given?
+    end
+
+    # Internal: Sends a message to HipChat.
+    #
+    # level   - The level of the message.
+    # context - The context of the message.
+    # message - The unformatted message.
+    #
+    # Returns nothing.
+    #
+    def add(level, context, message)
+      message = @formatter.format(level, context, message)
+      client.rooms_message @room_id, @name, message, 'text'
+    end
+
+    # Internal: Returns the client used to send messages to HipChat.
+    #
+    def client
+      @client ||= CLIENT.new(@api_token)
+    end
+
+  end
+
+end
+

data/lib/hatchet-hipchat/hipchat_emoticon_formatter.rb

@@ -0,0 +1,55 @@
+module Hatchet
+
+  # Public: Formatter that outputs messages with HipChat emoticons in place of
+  # the level.
+  #
+  # Mapping
+  #
+  #   :debug -> (content)
+  #   :info  -> (wat)
+  #   :warn  -> (ohcrap)
+  #   :error -> (omg)
+  #   :fatal -> (boom)
+  #
+  # Emoticon reference: http://hipchat-emoticons.heroku.com/
+  #
+  class HipChatEmoticonFormatter
+
+    # Internal: Map for converting levels to emoticons.
+    #
+    LEVEL_EMOTICON_MAP = {
+      debug: '(content)',
+      info:  '(wat)',
+      warn:  '(ohcrap)',
+      error: '(omg)',
+      fatal: '(boom)'
+    }
+
+    # Public: Returns the formatted message with HipChat emoticons in place of
+    # the level.
+    #
+    # level   - The severity of the log message.
+    # context - The context of the log message.
+    # message - The message provided by the log caller.
+    #
+    # Mapping
+    #
+    #   :debug -> (content)
+    #   :info  -> (wat)
+    #   :warn  -> (ohcrap)
+    #   :error -> (omg)
+    #   :fatal -> (boom)
+    #
+    # Returns messages in the format:
+    #
+    #   LEVEL - CONTEXT - MESSAGE
+    #
+    def format(level, context, message)
+      message = message.to_s.strip
+      "#{LEVEL_EMOTICON_MAP[level]} - #{context} - #{message}"
+    end
+
+  end
+
+end
+

data/lib/hatchet-hipchat/version.rb

@@ -1,5 +1,5 @@
 module Hatchet
   module Hipchat
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/hatchet-hipchat.rb

@@ -1,62 +1,6 @@
 require 'hatchet-hipchat/version'
 require 'hatchet'
 require 'hipchat-api'
+require 'hatchet-hipchat/hipchat_appender'
+require 'hatchet-hipchat/hipchat_emoticon_formatter'
 
-module Hatchet
-
-  # Public: Class for sending log messages to a HipChat room.
-  #
-  class HipChatAppender
-    include LevelManager
-
-    # Interal: The class to use to create HipChat clients.
-    #
-    CLIENT = HipChat::API
-
-    # Public: The formatter used to format messages before sending them to the
-    # HipChat room.
-    #
-    attr_accessor :formatter
-
-    # Public: The API token to use to connect to HipChat's API.
-    #
-    attr_accessor :api_token
-
-    # Public: The ID of the room to send messages to.
-    #
-    attr_accessor :room_id
-
-    # Public: Creates a new instance.
-    #
-    # By default the appender is created with a SimpleFormatter.
-    #
-    # block  - Optional block that can be used to customize the appender. The
-    #          appender itself is passed to the block.
-    #
-    def initialize
-      @formatter = SimpleFormatter.new
-      yield self if block_given?
-    end
-
-    # Internal: Sends a message to HipChat.
-    #
-    # level   - The level of the message.
-    # context - The context of the message.
-    # message - The unformatted message.
-    #
-    # Returns nothing.
-    #
-    def add(level, context, message)
-      message = @formatter.format(level, context, message)
-      client.rooms_message @room_id, 'Hatchet', message
-    end
-
-    # Internal: Returns the client used to send messages to HipChat.
-    #
-    def client
-      @client ||= CLIENT.new(@api_token)
-    end
-
-  end
-
-end

data/spec/helpers/fake_client.rb

@@ -11,8 +11,8 @@ class FakeClient
     @messages = []
   end
 
-  def rooms_message(room_id, from, message)
-    @messages << OpenStruct.new(room_id: room_id, from: from, message: message)
+  def rooms_message(room_id, from, message, format)
+    @messages << OpenStruct.new(room_id: room_id, from: from, message: message, format: format)
   end
 
 end

data/spec/hipchat_appender_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative 'spec_helper'
 
 describe HipChatAppender do
   before do
@@ -39,6 +39,21 @@ describe HipChatAppender do
       formatted_message = subject.formatter.format(:warn, 'Custom::Context', 'Hello, World')
       assert 'Hatchet' == message.from
       assert formatted_message == message.message
+      assert 'text' == message.format
+    end
+
+    describe 'setting name' do
+      before do
+        subject.name = 'CustomName'
+      end
+
+      before do
+        subject.add :warn, 'Custom::Context', 'Hello, World'
+      end
+
+      it 'sends a message with the configured name' do
+        assert 'CustomName' == message.from
+      end
     end
   end
 end

data/spec/hipchat_emoticon_formatter_spec.rb

@@ -0,0 +1,27 @@
+require_relative 'spec_helper'
+
+describe HipChatEmoticonFormatter do
+  let(:formatter) { HipChatEmoticonFormatter.new }
+  let(:context)   { 'Context' }
+  let(:message)   { 'Hello, World' }
+
+  it 'maps debug to (content)' do
+    assert '(content) - Context - Hello, World' == formatter.format(:debug, context, message)
+  end
+
+  it 'maps info to (wat)' do
+    assert '(wat) - Context - Hello, World' == formatter.format(:info, context, message)
+  end
+
+  it 'maps warn to (ohcrap)' do
+    assert '(ohcrap) - Context - Hello, World' == formatter.format(:warn, context, message)
+  end
+
+  it 'maps debug to (omg)' do
+    assert '(omg) - Context - Hello, World' == formatter.format(:error, context, message)
+  end
+
+  it 'maps debug to (boom)' do
+    assert '(boom) - Context - Hello, World' == formatter.format(:fatal, context, message)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet-hipchat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-22 00:00:00.000000000 Z
+date: 2012-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hatchet
-  requirement: &70125504604660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *70125504604660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.9
 - !ruby/object:Gem::Dependency
   name: hipchat-api
-  requirement: &70125504604160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *70125504604160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 description: Hatchet appender that sends messages to HipChat
 email:
 - garry@robustsoftware.co.uk
@@ -40,13 +50,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/hatchet-hipchat/hipchat_appender.rb
+- lib/hatchet-hipchat/hipchat_emoticon_formatter.rb
 - lib/hatchet-hipchat/version.rb
 - lib/hatchet-hipchat.rb
 - spec/helpers/fake_client.rb
 - spec/hipchat_appender_spec.rb
+- spec/hipchat_emoticon_formatter_spec.rb
 - spec/spec_helper.rb
 - LICENSE
-homepage: ''
+homepage: https://github.com/gshutler/hatchet-hipchat
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -66,11 +79,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Hatchet appender that sends messages to HipChat
 test_files:
 - spec/helpers/fake_client.rb
 - spec/hipchat_appender_spec.rb
+- spec/hipchat_emoticon_formatter_spec.rb
 - spec/spec_helper.rb