serfx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3bb17715c2ea3ee4ecb6de764132ba68b69c1c8
+  data.tar.gz: 53c8a46a3907a5218a2a8fe9d7eb66807ae39bb2
+SHA512:
+  metadata.gz: 5dcf2af95c0d178c401604c93954d10772ae769e068f64d1647721c6bda12714de7c39b2398a777396f1e30635563525f22ad27878349a1dcfd34fe0cc412f1b
+  data.tar.gz: 61466ce03edfecc3697c8650841695bd58d7c32f36d48f33884d7fe98a0d2326c78d6ab6b0a78f011f32bc86fc4c61cb6501dfe53b34b0d96a94d3848a4ac39f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+serf_binaries/*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+MethodLength:
+    Max: 15

data/.travis.yml

@@ -0,0 +1,15 @@
+before_install:
+  - bash download_serf
+  - bundle install --path .bundle
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+branches:
+  only:
+    - master
+script: "CODE_COVERAGE=1 bundle exec rake spec"
+addons:
+  code_climate:
+    repo_token: 894a7a896e5ac4a4e7e497051fbc68152f348989a5b930cc3a037c713cf63df0 

data/.yardops

@@ -0,0 +1,4 @@
+--no-private
+--title=""
+--markup=markdown
+--template-path=./yard

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+group :development do
+  gem 'irbtools'
+  gem 'pry'
+  gem 'codeclimate-test-reporter', group: :test, require: nil
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ranjib Dey
+
+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/README.md

@@ -0,0 +1,85 @@
+# Serfx
+
+A bare minimal ruby client for [Serf][serf-homepage].
+
+## Introduction
+
+Serfx uses  Serf's [RPC protocol][rpc-protocol] under the hood. Serf RPC protocol involves communication with a local or remote serf agent over tcp using [msgpack][msgpack] for serialization.
+Serf's RPC protocol mandates `handshake` (followed by `auth` if applicable) to be the first command(s) in an RPC session. Serfx exposes all the low level RPC commands via the `Connection` class, as well  a convenient `connect` method which creates a connection object and does the handshake, auth and connection closing for you.
+If you are creating the `Serfx::Connection` directly, they you have to do the handshake (auth if applicable) and connection closing explicitly.
+For example, the command `members` can be invoked as:
+
+```ruby
+Serfx.connect do |conn|
+  conn.members
+end
+```
+Which is equivalent to
+
+```ruby
+conn = Serfx::Connection.new
+conn.handshake
+conn.members
+conn.close
+```
+
+[serf-homepage]: http://www.serfdom.io
+[rpc-protocol]: http://www.serfdom.io/docs/agent/rpc.html
+[msgpack]: http://msgpack.org
+
+## Sending custom events
+Serf allows creating user events. An user event must have a name and can have an optional payload.
+Following will create an user event named `play` with payload `PinkFloyd`
+
+```ruby
+conn.event('play', 'PinkFloyd')
+```
+
+Serf agents can be configured to invoke arbtrary script as [event handlers][event-handlers]. When serf agents receive the `play` event thay'll invoke the corresponding handler(s) and pass the payload 'PinkFloyd' via standard input.
+[event-handlers]: http://www.serfdom.io/docs/agent/event-handlers.html
+
+## Query and response
+
+Serf queries are special events that can be fired against a set of node(s) and the target node(s) can respond to aginst the queried event. Since Serf's event pipeline is asyn, every query event is timeboxed (by default 15s) and only those responses that are received within the timeout period is yield-ed. Following is an example will fire a query event name 'foo' with 'bar' payload and print the incoming responses from any node within the default timeout(15s).
+
+```ruby
+conn.query('foo', 'bar') do |response|
+  p response
+end
+```
+
+## Specifying connection details
+By default Serfx will try to connect to localhost at port 7373 (serf agent's default RPC port). Both `Serfx::Connection#new` as well as `Serfx.connect` accepts a hash specifying connection options i.e host, port, encryption, which can be used to specify non-default values.
+
+```ruby
+Serfx.client(host: 'serf1.example.com', port: 7373, authkey: 'secret')
+```
+
+## API documentation
+
+[Detailed api documentation][api-doc] is accessible via rubydoc.
+[api-doc]: http://rubydoc.info/gems/serfx
+
+## Supported ruby versions
+
+Serfx aims to support and is [tested against][serfx-travis] the following Ruby implementations:
+
+* *Ruby 1.9.2*
+* *Ruby 1.9.3*
+* *Ruby 2.0.0*
+* *Ruby 2.1.0*
+
+[serfx-travis]: https://travis-ci.org/ranjib/serfx
+
+## License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new("spec")
+
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+end
+
+YARD::Rake::YardocTask.new do |task|
+  task.files   = ['README.md', 'lib/**/*.rb']
+  task.options = [
+    '--output-dir', 'doc/yard',
+    '--markup', 'markdown'
+  ]
+end

data/download_serf

@@ -0,0 +1,5 @@
+#!/bin/bash
+mkdir serf_binaries
+cd serf_binaries
+wget -c https://dl.bintray.com/mitchellh/serf/0.6.0_linux_amd64.zip
+unzip 0.6.0_linux_amd64.zip

data/lib/serfx/commands.rb

@@ -0,0 +1,171 @@
+# encoding: UTF-8
+#
+require 'thread'
+
+Thread.abort_on_exception = true
+
+module Serfx
+  # Implements all of Serf's rpc commands using
+  # Serfx::Connection#request method
+  module Commands
+
+    # performs initial hanshake of an RPC session. Handshake has to be the
+    # first command to be invoked during an RPC session.
+    #
+    # @return  [Response]
+    def handshake
+      tcp_send(:handshake, 'Version' => 1)
+      read_response(:handshake)
+    end
+
+    # authenticate against the serf agent. if RPC credentials are setup, then
+    # `auth` has to be second command, immediately after `handshake`.
+    #
+    # @return  [Response]
+    def auth
+      tcp_send(:auth, 'AuthKey' => @authkey)
+      read_response(:auth)
+    end
+    # fires an user event
+    #
+    # @param name [String] a string representing name of the event
+    # @param payload [String] payload, default is nil
+    # @param coalesce [Boolena] whether serf should coalesce events within
+    # same name during  similar time frame
+    # @return  [Response]
+    def event(name, payload = nil, coalesce = true)
+      event = {
+        'Name' => name,
+        'Coalesce' => coalesce
+      }
+      event['Payload'] = payload unless payload.nil?
+      request(:event, event)
+    end
+
+    # force a failed node to leave the cluster
+    # 
+    # @param node [String] name of the failed node
+    # @return  [Response]
+    def force_leave(node)
+      request(:force_leave, 'Node' => node)
+    end
+    
+    # join an existing cluster.
+    #
+    # @param existing [Array] an array of existing serf agents
+    # @param replay [Boolean] Whether events should be replayed upon joining
+    # @return  [Response]
+    def join(existing, replay = false)
+      request(:join, 'Existing' => existing, 'Replay' => replay)
+    end
+    
+    # obtain the list of existing members
+    #
+    # @return  [Response]
+    def members
+      request(:members)
+    end
+
+    # obatin the list of cluster members, filtered by tags.
+    #
+    # @param tags [Array] an array of tags for filter
+    # @param status [Boolean] filter members based on their satatus
+    # @param name [String] filter based on exact name or pattern.
+    # @return  [Response]
+    def members_filtered(tags, status = 'alive', name = nil)
+      filter = {
+        'Tags' => tags,
+        'Status' => status
+        }
+      filter['Name'] = name unless name.nil?
+      request(:members_filtered, filter)
+    end
+
+    # alter the tags on a Serf agent while it is running. A member-update
+    # event will be triggered immediately to notify the other agents in the
+    # cluster of the change. The tags command can add new tags, modify
+    # existing tags, or delete tags
+    #
+    # @param tags [Hash] a hash representing tags as key-value pairs
+    # @param delete_tags [Array] an array of tags to be deleted
+    # @return  [Response]
+    def tags(tags, delete_tags = [])
+      request(:tags, 'Tags' => tags, 'DeleteTags' => delete_tags)
+    end
+
+    # subscribe to a stream of all events matching a given type filter.
+    # Events will continue to be sent until the stream is stopped
+    #
+    # @param types [String] comma separated list of events
+    # @return  [Thread, Response]
+    def stream(types, &block)
+      res = request(:stream, 'Type' => types)
+      t = Thread.new do
+        loop do
+          header = read_data
+          check_rpc_error!(header)
+          if header['Seq'] == res.header.seq
+            ev = read_data
+            block.call(ev) if block
+          else
+            break
+          end
+        end
+      end
+      [res, t]
+    end
+      
+    # monitor is similar to the stream command, but instead of events it
+    # subscribes the channel to log messages from the agent
+    #
+    # @param loglevel [String]
+    # @return  [Response]
+    def monitor(loglevel = 'debug')
+      request(:monitor, 'LogLevel' => loglevel.upcase)
+    end
+    
+    # stop is used to stop either a stream or monitor
+    def stop(sequence_number)
+      tcp_send(:stop, 'Stop' => sequence_number)
+    end
+    
+    # leave is used trigger a graceful leave and shutdown of the current agent
+    #
+    # @return  [Response]
+    def leave
+      request(:leave)
+    end
+
+    # query is used to issue a new query
+    #
+    # @param name [String] name of the query
+    # @param payload [String] payload for this query event
+    # @param opts [Hash] additional query options
+    # @return  [Response]
+    def query(name, payload, opts = {}, &block)
+      params = { 'Name' => name, 'Payload' => payload }
+      params.merge!(opts)
+      res = request(:query, params)
+      loop do
+        header = read_data
+        check_rpc_error!(header)
+        ev = read_data
+        if ev['Type'] == 'done'
+          break
+        else
+          block.call(ev) if block
+        end
+      end
+      res
+    end
+
+    # respond is used with `stream` to subscribe to queries and then respond.
+    #
+    # @param id [Integer] an opaque value that is assigned by the IPC layer
+    # @param payload [String] payload for the response event
+    # @return  [Response]
+    def respond(id, payload)
+      request(:respond, 'ID' => id, 'Payload' => payload)
+    end
+  end
+end

data/lib/serfx/connection.rb

@@ -0,0 +1,133 @@
+# encoding: UTF-8
+#
+require 'msgpack'
+require 'timeout'
+require 'serfx/log'
+require 'serfx/response'
+require 'serfx/commands'
+require 'serfx/exceptions'
+require 'socket'
+
+module Serfx
+  # This class wraps the low level msgpack data transformation and tcp
+  # communication for the RPC session. methods in this module are used to
+  # implement the actual RPC commands available via [Commands]
+  class Connection
+    COMMANDS = {
+      handshake:        [:header],
+      auth:             [:header],
+      event:            [:header],
+      force_leave:      [:header],
+      join:             [:header, :body],
+      members:          [:header, :body],
+      members_filtered: [:header, :body],
+      tags:             [:header],
+      stream:           [:header],
+      monitor:          [:header],
+      stop:             [:header],
+      leave:            [:header],
+      query:            [:header],
+      respond:          [:header]
+      }
+
+    include Serfx::Commands
+    extend Forwardable
+
+    attr_reader :host, :port, :seq
+    def_delegators :@socket, :close, :closed?
+
+    # @param  opts [Hash] Specify the RPC connection details
+    # @option opts [Symbol] :host ipaddreess of the target serf agent
+    # @option opts [Symbol] :port port of target serf agents RPC
+    # @option opts [Symbol] :authkey encryption key for RPC communication
+    def initialize(opts = {})
+      @host = opts[:host] || '127.0.0.1'
+      @port = opts[:port] || 7373
+      @seq = 0
+      @authkey = opts[:authkey]
+      @requests = {}
+      @responses = {}
+    end
+
+    # creates a tcp socket if does not exist already, against RPC host/port
+    #
+    # @return [TCPSocket]
+    def socket
+      @socket ||= TCPSocket.new(host, port)
+    end
+
+    # creates a MsgPack un-packer object from the tcp socket unless its
+    # already present
+    #
+    # @return [MessagePack::Unpacker]
+    def unpacker
+      @unpacker ||= MessagePack::Unpacker.new(socket)
+    end
+    
+    # read data from tcp socket and pipe it through msgpack unpacker for
+    # deserialization
+    #
+    # @return [Hash]
+    def read_data
+      unpacker.read
+    end
+    
+    # takes raw RPC command name and an optional request body
+    # and convert them to msgpack encoded data and then send
+    # over tcp
+    #
+    # @param command [String] RPC command name
+    # @param body [Hash] request body of the RPC command
+    #
+    # @return [Integer]
+    def tcp_send(command, body = nil)
+      @seq += 1
+      header = {
+        'Command' => command.to_s.gsub('_', '-'),
+        'Seq' => seq
+        }
+      Log.info("#{__method__}|Header: #{header.inspect}")
+      buff = MessagePack::Buffer.new
+      buff << header.to_msgpack
+      buff << body.to_msgpack unless body.nil?
+      res = socket.send(buff.to_str, 0)
+      Log.info("#{__method__}|Res: #{res.inspect}")
+      @requests[seq] = { header: header, ack?: false }
+      seq
+    end
+    
+    # checks if the RPC response header has `error` field popular or not
+    # raises [RPCError] exception if error string is not empty
+    # 
+    # @param header [Hash] RPC response header as hash
+    def check_rpc_error!(header)
+      fail RPCError, header['Error'] unless header['Error'].empty?
+    end
+
+
+    # read data from the tcp socket. and convert it to a [Response] object
+    #
+    # @param command [String] RPC command name for which response will be read
+    # @return [Response]
+    def read_response(command)
+      header =  read_data
+      check_rpc_error!(header)
+      if COMMANDS[command].include?(:body)
+        body = read_data
+        Response.new(header, body)
+      else
+        Response.new(header)
+      end
+    end
+
+    # make an RPC request against the serf agent
+    #
+    # @param command [String] name of the RPC command
+    # @param body [Hash] an optional request body for the RPC command
+    # @return [Response]
+    def request(command, body = nil)
+      tcp_send(command, body)
+      read_response(command)
+    end
+  end
+end

data/lib/serfx/exceptions.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module Serfx
+  class RPCError < RuntimeError ; end
+end

data/lib/serfx/log.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+require 'mixlib/log'
+
+module Serfx
+  # Provides singleton logger using mixlib/log library
+  class Log
+    extend Mixlib::Log
+  end
+end

data/lib/serfx/response.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+#
+module Serfx
+  # Store agent rpc response data
+  # All RPC responses in Serf composed of an header and an optional
+  # body.
+  #
+  class Response
+
+    # Header is composed of two sub-parts
+    # - Seq : an integer representing the original request
+    # - Error: a string that represent whether the request made, was
+    #   successfull or no. For all successful RPC requests, Error should
+    #   be an empty string
+    #
+    # `{"Seq": 0, "Error": ""}`
+    #
+    Header = Struct.new(:seq, :error)
+    attr_reader :header, :body
+
+    # Constructs a response object from a given header and body.
+    #
+    # @param header [Hash] header of the response as hash
+    # @param body [Hash] body of the response as hash
+    def initialize(header, body = nil)
+      @header = Header.new(header['Seq'], header['Error'])
+      @body = body
+    end
+  end
+end

data/lib/serfx/utils.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+module Serfx
+  # Helper methods for string manipulation
+  module Utils
+    # snakecase to camelcase converter. Taken from chef
+    # (mixin/convert_to_class_name.rb)
+    def camel_case(str)
+      str = str.dup
+      str.gsub!(/[^A-Za-z0-9_]/, '_')
+      rname = nil
+      regexp = /^(.+?)(_(.+))?$/
+      mn = str.match(regexp)
+      if mn
+        rname = mn[1].capitalize
+        while mn && mn[3]
+          mn = mn[3].match(regexp)
+          rname << mn[1].capitalize if mn
+        end
+      end
+      rname
+    end
+    # camelcase to snakecase converter
+    def snake_case(str)
+      str.gsub(/[A-Z]/) { |s| '_' + s }.downcase.sub(/^\_/, '')
+    end
+  end
+end

data/lib/serfx/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+#
+# Provides version as a contsant for the serf gem
+module Serfx
+  VERSION = '0.0.1'
+end

data/lib/serfx.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require 'serfx/log'
+require 'serfx/version'
+require 'serfx/connection'
+
+# Serfx is a minimal ruby client for serf.
+module Serfx
+  # Creates a serf rpc connection, performs handshake and auth
+  # (if authkey is supplied), if
+  # a block if provided, the connection will be closed after the block's
+  # execution.
+  # Params:
+  # +opts+:: An optional hash which can have following keys:
+  # * host => Serf host's rpc bind address (127.0.0.1 by default)
+  # * port => Serf host's rpc port (7373 by default)
+  # * authkey => Encryption key for RPC communiction
+  def self.connect(opts = {})
+    conn = Serfx::Connection.new(opts)
+    conn.handshake
+    conn.auth if opts.key?(:authkey)
+    if block_given?
+      yield conn
+      conn.close unless conn.closed?
+    else
+      conn
+    end
+  end
+end

data/serfx.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serfx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'serfx'
+  spec.version       = Serfx::VERSION.dup
+  spec.authors       = ['Rnjib Dey']
+  spec.email         = ['dey.ranjib@gmail.com']
+  spec.summary       = %q{A barebone ruby client for serf}
+  spec.description   = %q{Serfx is a minimal ruby client for serf, an event based, distributed, fault tolerant orchestration system}
+  spec.homepage      = 'https://github.com/ranjib/serfx'
+  spec.license       = 'Apache'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'msgpack'
+  spec.add_dependency 'mixlib-log'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'yard'
+end

data/spec/data/config.json

@@ -0,0 +1,3 @@
+{
+  "rpc_auth" : "awesomesecret"
+}

data/spec/serfx/client_spec.rb

@@ -0,0 +1,132 @@
+# encoding: UTF-8
+#
+require 'spec_helper'
+require 'timeout'
+require 'thread'
+
+describe Serfx do
+
+  before(:all) do
+    start_cluster(5)
+  end
+
+  after(:all) do
+    stop_cluster
+  end
+
+  before(:each) do
+    @conn = Serfx::Connection.new(port: 5000, authkey: 'awesomesecret')
+    @conn.handshake
+    @conn.auth
+  end
+
+  after(:each) do
+    @conn.close
+  end
+
+  let(:new_connection) do
+    Serfx::Connection.new(port: 5000, authkey: 'awesomesecret')
+  end
+
+  it '#handshake' do
+    conn = new_connection
+    response = conn.handshake
+    conn.close
+    expect(response.header.error).to be_empty
+    expect(response.header.seq).to eq(1)
+  end
+
+  it '#auth' do
+    conn = new_connection
+    conn.handshake
+    response = conn.auth
+    conn.close
+    expect(response.header.error).to be_empty
+  end
+
+  it '#event' do
+    response = @conn.event('seriously')
+    expect(response.header.error).to be_empty
+  end
+
+  it '#force-leave' do
+    last_pid = Serfx::SpecHelper::Spawner.instance.pids.pop
+    Process.kill('TERM', last_pid)
+    response = @conn.force_leave('node_4')
+    expect(response.header.error).to be_empty
+    time = 0
+    expect do
+      Timeout.timeout(10) do
+        node = @conn.members.body['Members'].find do |n|
+          n['Name'] == 'node_4'
+        end
+        until node['Status'] == 'left'
+          time += 1
+          sleep 1
+          node = @conn.members.body['Members'].find do |n|
+            n['Name'] == 'node_4'
+          end
+        end
+      end
+    end.to_not raise_error
+  end
+
+  it '#join' do
+    Serfx::SpecHelper::Spawner.instance.start(1, join: false)
+    sleep 3
+    @conn.join(['127.0.0.1:4000'])
+    sleep 2
+    expect(@conn.members.body['Members'].size).to eq(5)
+  end
+
+  it '#members' do
+    response = @conn.members
+    expect(response.header.error).to be_empty
+    expect(response.body['Members'].size).to eq(5)
+  end
+
+  it '#members-filtered' do
+    response = @conn.members_filtered('group' => 'odd')
+    expect(response.header.error).to be_empty
+    tags = response.body['Members'].map { |x|x['Tags']['group'] }
+    expect(tags.all? { |t| t == 'odd' }).to be_true
+  end
+
+  it '#tags' do
+    response = @conn.tags('service' => 'foo')
+    expect(response.header.error).to be_empty
+    response = @conn.members_filtered('service' => 'foo')
+    expect(response.body['Members']).to_not be_empty
+  end
+
+  it '#stream and stop' do
+    Serfx.connect(port: 5000, authkey: 'awesomesecret') do |c|
+      data = nil
+      _, t = c.stream('user:test') do |event|
+        data = event
+      end
+      sleep 2
+      @conn.event('test', 'whoa')
+      sleep 2
+      t.kill
+      expect(data['Name']).to eq('test')
+      expect(data['Payload']).to eq('whoa')
+      expect(data['Coalesce']).to be_true
+      expect(data['Event']).to eq('user')
+    end
+  end
+
+  it '#stream, query, respond and stop' do
+    Serfx.connect(port: 5000, authkey: 'awesomesecret') do |c|
+      res, t = c.stream('query') do |q|
+        c.respond(q['ID'], q['Payload'].to_s.upcase) if q['ID']
+      end
+      sleep 3
+      @conn.query('test', 'whoa') do |r|
+        expect(r['Payload']).to eq('WHOA')
+      end
+      c.stop(res.header.seq)
+      t.kill
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../spec', __FILE__))
+require 'rspec'
+require 'serfx'
+require 'singleton'
+require 'tmpdir'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start if ENV['CODE_COVERAGE']
+
+module Serfx
+  # adds helper method for unit testing
+  module SpecHelper
+  # provides serf cluster setup helper methods
+    class Spawner
+      include Singleton
+      attr_reader :pids
+
+      def initialize
+        @pids = []
+      end
+
+      def servers
+        @pids.size.times.reduce([]) { |a, e| a << { port: (7373 + e) } }
+      end
+
+      def start(numbers = 1, opts = {})
+        (numbers).times do |n|
+          join = if @pids.empty?
+                   false
+                 elsif opts.key?(:join)
+                   opts[:join]
+                 else
+                   true
+                 end
+          @pids << daemonize(Dir.mktmpdir, join)
+        end
+      end
+
+      def daemonize(dir, join = false)
+        command = serf_command(join)
+        pid = spawn(command, out: '/dev/null', chdir: dir)
+        Process.detach(pid)
+        pid
+      end
+
+      def serf_command(join)
+        n = @pids.size
+        group = n.even? ? 'even' : 'odd'
+        config = File.expand_path('../data/config.json', __FILE__)
+        args = " -bind 127.0.0.1:#{4000 + n} -rpc-addr 127.0.0.1:#{5000 + n} "
+        args << "-config-file #{config} -node node_#{n} -tag group=#{group}"
+        args << ' -join 127.0.0.01:4000' if join
+        serf_binary + ' agent ' + args
+      end
+
+      def serf_binary
+        path = File.expand_path('../../serf_binaries/serf', __FILE__)
+        if File.exist?(path)
+          path
+        elsif ENV['SERF_BIN']
+          ENV['SERF_BIN']
+        else
+          fail 'serf binary not found., you need to set SERF_BIN'
+        end
+      end
+
+      def stop
+        @pids.each do |pid|
+          Process.kill('TERM', pid)
+        end
+        FileUtils.remove_entry_secure(@tmpdir, true)
+        @pids.clear
+      end
+    end
+
+    def start_cluster(numbers = 1, opts = {})
+      Spawner.instance.start(numbers, opts)
+      sleep 1
+    end
+
+    def stop_cluster
+      Spawner.instance.stop
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include Serfx::SpecHelper
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: serfx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rnjib Dey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-log
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Serfx is a minimal ruby client for serf, an event based, distributed,
+  fault tolerant orchestration system
+email:
+- dey.ranjib@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardops"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- download_serf
+- lib/serfx.rb
+- lib/serfx/commands.rb
+- lib/serfx/connection.rb
+- lib/serfx/exceptions.rb
+- lib/serfx/log.rb
+- lib/serfx/response.rb
+- lib/serfx/utils.rb
+- lib/serfx/version.rb
+- serfx.gemspec
+- spec/data/config.json
+- spec/serfx/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ranjib/serfx
+licenses:
+- Apache
+metadata: {}
+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.2
+signing_key: 
+specification_version: 4
+summary: A barebone ruby client for serf
+test_files:
+- spec/data/config.json
+- spec/serfx/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: