logstash-output-hipchat 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f868fcfecff4b8e60158c837f7f0574f779bd5c7
-  data.tar.gz: bb904b0d9c27320edffa2e52e5b10c1335e5ddc5
+  metadata.gz: ccdb664543fb032e93e7682e9defa67641ac7efe
+  data.tar.gz: b252c880912a19bdedd31e6474cccad146cda363
 SHA512:
-  metadata.gz: 2544424102bc6593ab23606ebdb6b6b96f110f63d17e7733c39966e73dbe3b02c378ec522476f9e5886bd8b16add604657de6a1ae99dd3ebb78d7ff39e3a15ae
-  data.tar.gz: d8c1a8a43ade709e0712f85612d16f5a881820f6e2cea1be75e62b512de47a0c28d250404f92a336671f94705e1b98161d859b6ee36b6de3d512682b57b13bf1
+  metadata.gz: 5d879dedf4aef41344e43877440c566aef2f11ee294d9cce284ba17b60393e37cbfb36e4c6b276280a8f6a756583f72e53213d1ae79a9456798f6207efc66b6e
+  data.tar.gz: ec09e5901bd30f6083a44c775e042132686674b08d29f4f9b974392878d292a1aef8379ef6e681e20aa1d59bbfc9bf9c9470089351b6a6ef47ae173bcf08dbe6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 2.0.0
+- Use hipchat official gem
+- support v2 version of the api and HipChat cloud server.
+- Added a few tests
+- more options of this plugin now support fieldref

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/hipchat.rb

@@ -1,20 +1,21 @@
 # encoding: utf-8
+require "logstash/outputs/base"
 require "logstash/namespace"
-require "logstash/outputs/http"
 
 # This output allows you to write events to https://www.hipchat.com/[HipChat].
 #
+# Make sure your API token have the appropriate permissions and support
+# sending  messages.
 class LogStash::Outputs::HipChat < LogStash::Outputs::Base
-
   config_name "hipchat"
 
   # The HipChat authentication token.
   config :token, :validate => :string, :required => true
 
-  # The ID or name of the room.
+  # The ID or name of the room, support fieldref
   config :room_id, :validate => :string, :required => true
 
-  # The name the message will appear be sent from.
+  # The name the message will appear be sent from, you can use fieldref
   config :from, :validate => :string, :default => "logstash"
 
   # Whether or not this message should trigger a notification for people in the room.
@@ -22,58 +23,49 @@ class LogStash::Outputs::HipChat < LogStash::Outputs::Base
 
   # Background color for message.
   # HipChat currently supports one of "yellow", "red", "green", "purple",
-  # "gray", or "random". (default: yellow)
+  # "gray", or "random". (default: yellow), support fieldref
   config :color, :validate => :string, :default => "yellow"
 
   # Message format to send, event tokens are usable here.
   config :format, :validate => :string, :default => "%{message}"
 
+  # Specify `Message Format`
+  config :message_format, :validate => ["html", "text"], :default => "html"
+
+  # HipChat host to use
+  config :host, :validate => :string
+
   public
   def register
-    require "ftw"
-    require "uri"
+    require "hipchat"
+  end
 
-    @agent = FTW::Agent.new
+  def client
+    @client ||= if @host.nil? || @host.empty? 
+                  HipChat::Client.new(@token, :api_version => "v2")
+                else
+                  HipChat::Client.new(@token, :api_version => "v2", :server_url => server_url)
+                end
+  end
 
-    @url = "https://api.hipchat.com/v1/rooms/message?auth_token=" + @token
-    @content_type = "application/x-www-form-urlencoded"
-  end # def register
+  def server_url
+    "https://#{@host}"
+  end
 
-  public
   def receive(event)
     return unless output?(event)
 
-    hipchat_data = Hash.new
-    hipchat_data['room_id'] = event.sprintf(@room_id)
-    hipchat_data['from']    = @from
-    hipchat_data['color']   = @color
-    hipchat_data['notify']  = @trigger_notify ? "1" : "0"
-    hipchat_data['message'] = event.sprintf(@format)
+    message = event.sprintf(@format)
+    from = event.sprintf(@from)
+    color = event.sprintf(@color)
+    room = event.sprintf(@room_id)
 
-    @logger.debug("HipChat data", :hipchat_data => hipchat_data)
+    @logger.debug("HipChat data", :from => from , :message => message, :notify => trigger_notify, :color => color, :message_format => @message_format) if @logger.debug?
 
     begin
-      request = @agent.post(@url)
-      request["Content-Type"] = @content_type
-      request.body = encode(hipchat_data)
-
-      response = @agent.execute(request)
-
-      # Consume body to let this connection be reused
-      rbody = ""
-      response.read_body { |c| rbody << c }
-      #puts rbody
+      client[room].send(from, message, :notify => trigger_notify, :color => color, :message_format => @message_format)
     rescue Exception => e
-      @logger.warn("Unhandled exception", :request => request, :response => response, :exception => e, :stacktrace => e.backtrace)
+      logger.warn("Unhandled exception", :exception => e, :stacktrace => e.backtrace)
     end
-  end # def receive
-
-  # shamelessly lifted this from the LogStash::Outputs::Http, I'd rather put this
-  # in a common place for both to use, but unsure where that place is or should be
-  def encode(hash)
-    return hash.collect do |key, value|
-      CGI.escape(key) + "=" + CGI.escape(value)
-    end.join("&")
-  end # def encode
-
-end # class LogStash::Outputs::HipChat
+  end
+end

data/logstash-output-hipchat.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-hipchat'
-  s.version         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output allows you to write events to Hipchat"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
-
-  s.add_runtime_dependency 'ftw', ['~> 0.0.40']
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "hipchat"
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/outputs/hipchat_spec.rb

@@ -1 +1,80 @@
-require "logstash/devutils/rspec/spec_helper"
+# encoding: utf-8
+require "logstash/outputs/hipchat"
+require "logstash/event"
+require_relative "../spec_helper"
+
+describe LogStash::Outputs::HipChat do
+  let(:token) { "secret" }
+  let(:message) { "foobar" }
+  let(:event) { LogStash::Event.new({ "message" => message }) }
+  let(:room_id) { "secret-lair" }
+  let(:from) { "computer" }
+  let(:trigger_notify) { true }
+  let(:color) { "yellow" }
+  let(:message_format) { "html" }
+  let(:options) {
+    { 
+      "token" => token,
+      "room_id" => room_id,
+      "from" => from,
+      "color" => color,
+      "trigger_notify" => trigger_notify
+    }
+  }
+  let(:hipchat) { double("hipchat") }
+  let(:output) { LogStash::Outputs::HipChat.new(options) }
+
+  before do
+    output.register
+  end
+
+  shared_examples "sending events" do
+    it "send the events" do
+      expect(hipchat).to receive(:send).with(from, message, :notify => trigger_notify, :color => color, :message_format => message_format)
+      output.receive(event)
+    end
+
+    context "String interpolation" do
+      let(:event) {
+        LogStash::Event.new({ "message" => message,
+                              "my_room" => room_id,
+                              "my_color" => color,
+                              "from_who" => from})
+      }
+
+      let(:options) {
+        super.merge({
+          "token" => "secret",
+          "room_id" => "%{my_room}",
+          "from" => "%{from_who}",
+          "color" => "%{my_color}",
+          "trigger_notify" => trigger_notify
+        })
+      }
+
+      it "applies string interpolation" do
+        expect(hipchat).to receive(:send).with(from, message, :notify => trigger_notify, :color => color, :message_format => message_format)
+        output.receive(event)
+      end
+    end
+  end
+
+  context "default host" do
+    before do
+      expect(HipChat::Client).to receive(:new).with(token, :api_version => "v2").and_return({ room_id => hipchat })
+    end
+
+    include_examples "sending events"
+  end
+
+  context "specified host" do
+    let(:host) { "local.dev" }
+    let(:options) { super.merge({ "host" => host }) }
+
+    before do
+      expect(HipChat::Client).to receive(:new).with(token, :api_version => "v2", :server_url => "https://#{host}").and_return({ room_id => hipchat })
+    end
+
+    include_examples "sending events"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-hipchat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -31,17 +31,31 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: ftw
+  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.40
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.40
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -64,17 +78,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- lib/logstash/outputs/hipchat.rb
+- spec/spec_helper.rb
+- spec/outputs/hipchat_spec.rb
+- logstash-output-hipchat.gemspec
+- README.md
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
-- README.md
-- Rakefile
-- lib/logstash/outputs/hipchat.rb
-- logstash-output-hipchat.gemspec
-- spec/outputs/hipchat_spec.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -97,9 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: This output allows you to write events to Hipchat
 test_files:
+- spec/spec_helper.rb
 - spec/outputs/hipchat_spec.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"