logstash-output-pushover 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27c6825e2be3281fab3feb973a6dc52a6decea27
+  data.tar.gz: 293a469d588327d90389f54eb6606ba889044c52
+SHA512:
+  metadata.gz: efa880e4ab9a8f5cb9b153bd7c64548bb2a509b05390b9b1271a079964d1f345c86d13cf8663c13ce3e111d1806c1bf69db8ff4d83c5ef2129476586f66957ed
+  data.tar.gz: 43045d4ac6614fb842b85fcab91d2e177970ef1019331e5064f1726bc9e1700f61c1063d1d7af217d34c6a32a49fbef14afd9aae4745dc982a2719ed1b71c939

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Jasper Lievisse Adriaanse <j@jasper.la>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+Logstash Plugin for Pushover output
+===
+
+This is a plugin for [logstash](https://www.elastic.co/products/logstash) to send events to [Pushover](https://pushover.net). It's not an official Pushover-service.
+
+Usage
+---
+
+There are two required parameters that need to be set, so at the very least the
+following is required:
+
+    output {
+		pushover {
+			app_token => "YOUR_UNIQUE_APP_TOKEN"
+			user_key => "RECEIVERS_UNIQUE_USER_KEY"
+		}
+	}
+
+No futher configuration parameters that are listed on [the API specification](https://pushover.net/api)
+are currently enabled.
+
+ToDo
+---
+
+- Wire-up additional configuration parameters
+- tests :)
+
+Copyright
+---
+
+- 2015 Jasper Lievisse Adriaanse <j@jasper.la>
+
+Contributing
+---
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/outputs/pushover.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+# Event notification through Pushover.
+# Currently only supports plain messages (event) and no further configuration
+# options are submitted.
+class LogStash::Outputs::Pushover < LogStash::Outputs::Base
+  config_name "pushover"
+
+  # Application token, obtain by registring a new application
+  config :app_token, :validate => :string, :require => true
+
+  # Key for the receiving user
+  config :user_key, :validate => :string, :require => true
+
+  # User device name: https://pushover.net/api#identifiers
+  config :device, :validate => :string
+
+  # Message title: https://pushover.net/api#messages
+  config :title, :validate => :string, :default => "Logstash"
+
+  # Message priority: https://pushover.net/api#priority
+  config :priority, :validate => [-2,-1,0,1,2], :default => 0
+
+  # Timestamp for the message: https://pushover.net/api#timestamp
+  config :timestamp, :validate => :string
+
+  # Notification sound: https://pushover.net/api#sounds
+  config :sound, :validate => :string
+
+  # Supplementary URLs: https://pushover.net/api#urls
+  config :url, :validate => :string # XXX: something://rest
+
+  # Supplementary URL title: https://pushover.net/api#urls
+  config :url_title, :validate => :string
+
+  # Wether to append "tags: <list of tags>" to the event
+  config :add_tags, :validate => :boolean, :default => :false
+
+  # URL of the Pushover API; should generally not be adjusted but it's
+  # configurable for testing or in case the something changes upstream and
+  # this plugin isn't updated quick enough.
+  config :api_url, :validate => :string, :default => 'https://api.pushover.net/1/messages.json'
+
+  public
+  def register
+    require 'net/https'
+    require 'uri'
+    @api_uri = URI.parse(@api_url)
+    @client = Net::HTTP.new(@api_uri.host, @api_uri.port)
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+
+    @logger.info("Pushover event", :event => event)
+
+    # If requested, add any logstash tags to the message
+    message = event.to_s
+    if @add_tags
+      message += " tags: " + @tags.join(',') if @tags
+    end
+
+    begin
+      request = Net::HTTP::Post.new(@api_uri.path)
+      request.set_form_data({
+        :token => @app_token,
+        :user => @user_key,
+        :message => event
+      })
+      # XXX: For any additional configuration keys, add them to the request.
+      response = @client
+      response.use_ssl = true
+      response.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      response.start do |http|
+        r = http.request(request)
+        if status = r.body.match(/"status":(\d+)/)[1] != 1
+          @logger.warn("API error", :status => status)
+        end
+      end
+    rescue Exception => e
+      @logger.warn("Failed to push notification", :event => event, :exception => e,
+        :backtrace => e.backtrace)
+    end
+  end # def event
+end # class LogStash::Outputs::Pushover

data/logstash-output-pushover.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-pushover'
+  s.version = "0.1.0"
+  s.licenses = ["ISC"]
+  s.summary = "Logstash output to Pushover."
+  s.description = "This is a Logstash output for the Pushover push notification service."
+  s.authors = ["Jasper Lievisse Adriaanse"]
+  s.email = "j@jasper.la"
+  s.homepage = "https://github.com/jasperla/logstash-output-pushover"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 2.0.0"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/pushover_spec.rb

@@ -0,0 +1,21 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/example"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Example do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Example.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-pushover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jasper Lievisse Adriaanse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a Logstash output for the Pushover push notification service.
+email: j@jasper.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/outputs/pushover.rb
+- logstash-output-pushover.gemspec
+- spec/outputs/pushover_spec.rb
+homepage: https://github.com/jasperla/logstash-output-pushover
+licenses:
+- ISC
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Logstash output to Pushover.
+test_files:
+- spec/outputs/pushover_spec.rb