logstash-input-github 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf160ba21f59728088732f05133fb4eae72a12c7
-  data.tar.gz: bdf4ce1d331a87ac66c71d40c6c86e426ed17195
+  metadata.gz: 191c502d49792c7c96082837b9dbf5765b52a10a
+  data.tar.gz: 57e1fec008bea6423bdd38fa3413cc27b6e57952
 SHA512:
-  metadata.gz: 7498d2b950ebc1df425e1026a299f18103e7c65036d4cb76e2885f98ced5ec5138e088b4a182609475fbd5adeb710a87590fa10852552dfb345014458dad2f3d
-  data.tar.gz: 4611f1b6acf3f195c3f1bd434b90a9d0f54952c6c4fb6b90038deb6675d39da259f0fc0dfd13a65fd75978c362eb95f77a95faaeb8a9438429b8f74ab2dc1374
+  metadata.gz: ca72bab22c03df6631f838e93e3f116d99cc3360967fe5aafc4398e683039191180bc09161bd320adbc1a609586a7546cfba057ec7e57e3cc17c069fc0ad91b4
+  data.tar.gz: a190dc000faf954ce3e897b1e86fad77620f228f9ef7808feee28db83cdc216fec374359234ac9451fc1898208d85305a6048d11f613a19f61866a52db21a792

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Jason Kendall (coolacid)
+* Pier-Hugues Pellerin (ph)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,35 @@
+logstash-github
+===================
+
+This plugin accepts github webhook connections and passes the data into the logstash pipeline.
+
+Usage
+=====
+
+Example config:
+
+    input {
+        stdin {}
+        github {
+            port => 8080
+        }
+    }
+
+    output {
+        stdout {
+            codec => rubydebug
+        }
+    }
+
+Example Test Case using Curl:
+
+    curl -H "Content-Type: application/json" -d '{"Something":"xyz","somethingelse":"xyz"}' http://localhost:8080/api/login
+
+Configuration
+=============
+
+* ip - The IP you want to listen on (Default: 0.0.0.0)
+* port - The port you want to listen on
+* secret_token - The shared secret set for github webhook
+* drop_invalid - Drop events that don't match the secret_token
+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,35 +1,95 @@
-logstash-github
-===================
+# Logstash Plugin
 
-This plugin accepts github webhook connections and passes the data into the logstash pipeline.
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
 
-Usage
-=====
+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.
 
-Example config:
+## Documentation
 
-    input {
-        stdin {}
-        github {
-            port => 8080
-        }
-    }
+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/).
 
-    output {
-        stdout {
-            codec => rubydebug
-        }
-    }
+- 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
 
-Example Test Case using Curl:
+## Need Help?
 
-    curl -H "Content-Type: application/json" -d '{"Something":"xyz","somethingelse":"xyz"}' http://localhost:8080/api/login
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
 
-Configuration
-=============
+## Developing
 
-* ip - The IP you want to listen on (Default: 0.0.0.0)
-* port - The port you want to listen on
-* secret_token - The shared secret set for github webhook
-* drop_invalid - Drop events that don't match the secret_token
+### 1. Plugin Developement and Testing
 
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/github.rb

@@ -9,7 +9,6 @@ require "rack"
 # Read events from github webhooks
 class LogStash::Inputs::GitHub < LogStash::Inputs::Base
   config_name "github"
-  milestone 1
 
   # The ip to listen on
   config :ip, :validate => :string, :default => "0.0.0.0"

data/logstash-input-github.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-github'
-  s.version         = '0.1.1'
+  s.version         = '0.1.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Accept events from github webhooks."
   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"

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-github
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -20,7 +19,10 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -28,42 +30,42 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
-  name: addressable
-  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'
+  name: addressable
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
 email: jason.kendall@elasticsearch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CONTRIBUTORS
+- DEVELOPER.md
 - Gemfile
 - LICENSE
 - README.md
@@ -93,7 +95,7 @@ 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: Accept events from github webhooks.