hatchet-hipchat 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Garry Shutler
+
+MIT License
+
+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/lib/hatchet-hipchat/version.rb

@@ -0,0 +1,5 @@
+module Hatchet
+  module Hipchat
+    VERSION = "0.0.1"
+  end
+end

data/lib/hatchet-hipchat.rb

@@ -0,0 +1,65 @@
+require 'hatchet-hipchat/version'
+require 'hatchet'
+require 'hipchat-api'
+
+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 if the appender is configured to send
+    # messages at the given level for the given context.
+    #
+    # level   - The level of the message.
+    # context - The context of the message.
+    # message - The message to add to the appender if it is configured to log
+    #           messages at the given level for the given context.
+    #
+    # Returns nothing.
+    #
+    def add(level, context, message)
+      return unless enabled? level, context
+      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

@@ -0,0 +1,19 @@
+require 'ostruct'
+
+class FakeClient
+
+  attr_reader :api_token
+
+  attr_reader :messages
+
+  def initialize(api_token)
+    @api_token = api_token
+    @messages = []
+  end
+
+  def rooms_message(room_id, from, message)
+    @messages << OpenStruct.new(room_id: room_id, from: from, message: message)
+  end
+
+end
+

data/spec/hipchat_appender_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe HipChatAppender do
+  before do
+    # Replace the client class.
+    HipChatAppender.send :remove_const, :CLIENT
+    HipChatAppender::CLIENT = FakeClient
+  end
+
+  describe 'default formatter' do
+    let(:subject) { HipChatAppender.new }
+
+    it 'uses the SimpleFormatter by default' do
+      assert_instance_of(SimpleFormatter, subject.formatter)
+    end
+  end
+
+  describe 'sending messages' do
+    let(:subject) do
+      HipChatAppender.new do |appender|
+        appender.level :warn
+        appender.api_token = 'MY_TOKEN'
+        appender.room_id   = 'ROOM_ID'
+      end
+    end
+
+    before do
+      subject.add :warn, 'Custom::Context', 'Hello, World'
+    end
+
+    let(:message) { subject.client.messages.last }
+
+    it 'configures the client with the API token' do
+      assert 'MY_TOKEN' == subject.client.api_token
+    end
+
+    it 'sends a formatted message to the configured room' do
+      assert 'ROOM_ID' == message.room_id
+      formatted_message = subject.formatter.format(:warn, 'Custom::Context', 'Hello, World')
+      assert 'Hatchet' == message.from
+      assert formatted_message == message.message
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require_relative '../lib/hatchet-hipchat'
+require_relative 'helpers/fake_client'
+
+include Hatchet
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: hatchet-hipchat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Garry Shutler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hatchet
+  requirement: &70143422560160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143422560160
+- !ruby/object:Gem::Dependency
+  name: hipchat-api
+  requirement: &70143422559660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143422559660
+description: Hatchet appender that sends messages to HipChat
+email:
+- garry@robustsoftware.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hatchet-hipchat/version.rb
+- lib/hatchet-hipchat.rb
+- spec/helpers/fake_client.rb
+- spec/hipchat_appender_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+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/spec_helper.rb