fluent-plugin-websocket 0.1.2 → 0.1.3

data/{README.md → README.rdoc}

@@ -1,17 +1,18 @@
-# Fluent::Plugin::Websocket
+= Fluent::Plugin::Websocket
 
 Fluentd websocket output plugin.
 
-## Installation
+This plugin works as websocket server which can output JSON string or {MessagePack}[http://msgpack.org/] binary.
 
-Copy __out_websocket.rb__ into your fluentd plugin directory.
+In the current version, emitted data will be broadcasted to the all connected clients.
 
-Default plugin directory is _/etc/fluent/plugin_. You can specify additional location by _-p_ option. (Please see _fluentd -h_)
+== Installation
 
-This plugin depends on [__em-websocket__](https://github.com/igrigorik/em-websocket) module. You can  install it by _gem install em-websocket_.
+    gem install fluent-plugin-websocket
 
+This plugin depends on {*em-websocket*}[https://github.com/igrigorik/em-websocket].
 
-## Configuration
+== Configuration
     <match foo.**>
       type websocket
       host 192.168.1.1  # default: 0.0.0.0 (ANY)
@@ -21,13 +22,13 @@ This plugin depends on [__em-websocket__](https://github.com/igrigorik/em-websoc
       add_tag true      # default: true
     </match>
 
-- __host__: WebSocket server IP address.
-- __port__: WebSocket server port.
-- __use\_msgpack__: Send [MessagePack](http://msgpack.org/) format binary. Otherwise, you send JSON format text.
-- __add\_time__: Add timestamp to the data.
-- __add\_tag__: Add fluentd tag to the data.
+* *host*: WebSocket server IP address.
+* *port*: WebSocket server port.
+* <b>use_msgpack</b>: Send {MessagePack}[http://msgpack.org/] format binary. Otherwise, you send JSON format text.
+* <b>add_time</b>: Add timestamp to the data.
+* <b>add_tag</b>: Add fluentd tag to the data.
 
-If there are no websocket connections, this plugin silently discards data. You may use _out\_copy_ plugin like this:
+If there are no websocket connections, this plugin silently discards data. You may use <em>out_copy</em> plugin like this:
 
     <match foo.**>
       type copy
@@ -41,26 +42,26 @@ If there are no websocket connections, this plugin silently discards data. You m
       </store>
     </match>
 
-## Data format
+== Data format
     [tag, timestamp, data_object]
 
-- tag is appended when _add\_tag_ option is true.
-- timespamp is appended when _add\_time_ option is true.
+* tag is appended when <em>add_tag</em> option is true.
+* timespamp is appended when <em>add_time</em> option is true.
 
-### Example
+=== Example
     curl -X POST -d 'json={"action":"login","user":6}' http://localhost:8888/foo/bar
 
     ["foo.bar",1364699026,{"action":"login","user":6}]
 
-## Client sample
-### JSON format (use_msgpack: false)
+== Client sample
+=== JSON format (use_msgpack: false)
     function onMessage(evt) {
       data = JSON.parse(evt.data);
       ...
     }
 
-### Msgpack format binary (use_msgpack: true)
-Extract data by [msgpack.js](https://github.com/msgpack/msgpack-javascript).
+=== Msgpack format binary (use_msgpack: true)
+Extract data by {msgpack.js}[https://github.com/msgpack/msgpack-javascript].
 
     websocket.binaryType = "arraybuffer"
     ...
@@ -69,7 +70,7 @@ Extract data by [msgpack.js](https://github.com/msgpack/msgpack-javascript).
       ...
     }
 
-## Contributing
+== Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -77,3 +78,7 @@ Extract data by [msgpack.js](https://github.com/msgpack/msgpack-javascript).
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+== Copyright
+
+Copyright:: Copyright (c) 2013 IZAWA Tetsu (@moccos)
+License:: Apache License, Version 2.0

data/fluent-plugin-websocket.gemspec

@@ -3,12 +3,12 @@ lib = File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-websocket"
-  gem.version       = "0.1.2"
+  gem.version       = "0.1.3"
   gem.authors       = ["IZAWA Tetsu (@moccos)"]
   gem.email         = ["tt.izawa@gmail.com"]
   gem.homepage      = "https://github.com/moccos/fluent-plugin-websocket"
   gem.summary       = %q{Fluentd websocket output plugin}
-  gem.description   = %q{Fluentd websocket output plugin}
+  gem.description   = %q{Fluentd websocket output plugin which can output JSON string or MessagePack binary to the clients.}
   gem.required_ruby_version = ">= 1.9.2"
 
   gem.files         = `git ls-files`.split($/)
@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "fluentd"
-  gem.add_development_dependency "websocket-ocket-eventmachine-client"
+  gem.add_development_dependency "websocket-eventmachine-client"
   gem.add_development_dependency "msgpack"
   gem.add_runtime_dependency "fluentd"
   gem.add_runtime_dependency "em-websocket"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-websocket
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: websocket-ocket-eventmachine-client
+  name: websocket-eventmachine-client
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -107,7 +107,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Fluentd websocket output plugin
+description: Fluentd websocket output plugin which can output JSON string or MessagePack
+  binary to the clients.
 email:
 - tt.izawa@gmail.com
 executables: []
@@ -117,7 +118,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.rdoc
 - Rakefile
 - fluent-plugin-websocket.gemspec
 - lib/fluent/plugin/out_websocket.rb