serfx 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93d9b356f7f57d5d478e7029cfd102ba0f4df9c9
-  data.tar.gz: 56328c5f96c7b274a1b1e9cafd3e6d34cf0ee989
+  metadata.gz: 2dd4d0d83c82dae09204307da9088059768c893f
+  data.tar.gz: 09a78e804e6b5067ea17b7cc46e493eb7de24935
 SHA512:
-  metadata.gz: d00717242ab33e17855a25952e4d75c820e9cfc4b13aa6a3cabde733701bb6736abf00dcf0d15964398c3eba954fdf14135279e4c1196d023e5a12a22d0c63e6
-  data.tar.gz: b2244787a7fa11cd352b44d74f4ee44dc6b75e47f285fcee053ff1c9e12c448f78d8e1866f3fb63008605a32897fb3b6039e5fa6cdffcca1e0c9327c4884942b
+  metadata.gz: cc00a2d6c5c365ceda4699e36824a16713bba12cc72ce3662b19f6fe993f77280e13482ae7312c5d85062c55c6b994c16c0ce6cca1ed57d0c1fa69d626bcdde7
+  data.tar.gz: 84791215060afa1b18980f66a9fbb335e9bc536b14f952e2e8ca5ef73558c306a55d6cd036947d9acf99b5c120ae06159ba44a69cd878c912f2c40f15fc65359

data/.travis.yml

@@ -2,7 +2,6 @@ before_install:
   - bash download_serf
   - bundle install --path .bundle
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
 branches:

data/README.md

@@ -154,11 +154,21 @@ Serfx.client(host: 'serf1.example.com', port: 7373, authkey: 'secret')
 [Detailed api documentation][api-doc] is accessible via rubydoc.
 [api-doc]: http://rubydoc.info/gems/serfx
 
+## Note
+Currently the response of `members` RPC method returns the ipaddress of cluster members as byte array. You can use `unpack` method to convert it to string.
+
+```ruby
+Serfx.client(host: 'serf1.example.com') do |conn|
+  response = conn.members
+  puts response.body['Members'].first['Addr'] # first member's IP in bytes
+  puts response.body['Members'].first['Addr'].unpack('CCCC').join('.') # Same as string
+end
+```
+
 ## 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*

data/lib/serfx/utils/async_job.rb

@@ -8,20 +8,20 @@ module Serfx
     # in progress. Due to this, long running tasks should not be
     # invoked as serf handler directly.
     #
-    # AsyncJob helps buildng serf handlers that involve long running commands.
+    # AsyncJob helps building serf handlers that involve long running commands.
     # It starts the command in background, allowing handler code to
     # return immediately. It does double fork where the first child process is
     # detached (attached to init as parent process) and and the target long
     # running task is spawned as a second child process. This allows the first
     # child  process to wait and reap the output of actual long running task.
     #
-    # The first child process updates a state file before spawing
-    # the long ranning task(state='invoking'), during the lon running task
+    # The first child process updates a state file before spawning
+    # the long ranning task(state='invoking'), during the long running task
     # execution (state='running') and after the spawned process' return
     # (state='finished'). This state file provides a convenient way to
     # query the current state of an AsyncJob.
     #
-    # AsyncJob porvide four methods to manage jobs. AsyncJob#start will
+    # AsyncJob provides four methods to manage jobs. AsyncJob#start will
     # start the task. Once started, AyncJob#state_info can be used to check
     # whether the job is still running or finished. One started a job can be
     # either in 'running' state or in 'finished' state. AsyncJob#reap
@@ -30,6 +30,10 @@ module Serfx
     # AsyncJob#kill method. A new AyncJob can not be started unless previous
     # AsyncJob with same name/state file is reaped.
     #
+    # If the state file is nil, no state will be persisted for the job.
+    # As such, AsyncJob#state_info, AsyncJob#kill, and AsyncJob#reap will
+    # be a NO-OP.
+    #
     # Following is an example of writing a serf handler using AsyncJob.
     #
     # @example
@@ -86,7 +90,7 @@ module Serfx
       # @option opts [Symbol] :environment a hash containing environment variables
       # @option opts [Symbol] :cwd a string (directory path) containing current directory of the command
       def initialize(opts = {})
-        @state_file = opts[:state] || fail(ArgumentError, 'Specify state file')
+        @state_file = opts[:state]
         @command = opts[:command]
         @stdout_file = opts[:stdout] || File::NULL
         @stderr_file = opts[:stderr] || File::NULL
@@ -96,12 +100,13 @@ module Serfx
 
       # kill an already running task
       #
-      # @param sig [String] kill signal that will sent to the backgroun process
+      # @param sig [String] kill signal that will sent to the background process
       # @return [TrueClass,FalseClass] true on success, false on failure
       def kill(sig = 'KILL')
         if running?
           begin
             Process.kill(sig, stateinfo['pid'].to_i)
+            File.unlink(state_file) if File.exist?(state_file)
             'success'
           rescue Exception
             'failed'
@@ -111,7 +116,7 @@ module Serfx
         end
       end
 
-      # obtain current state information about the task as json
+      # obtain current state information about the task as JSON
       #
       # @return [String] JSON string representing current state of the task
       def state_info
@@ -129,7 +134,7 @@ module Serfx
         JSON.parse(state_info)
       end
 
-      # delete the statefile of a finished task
+      # delete the state file of a finished task
       #
       # @return [String] 'success' if the task is reaped, 'failed' otherwise
       def reap
@@ -203,14 +208,16 @@ module Serfx
       #
       # @return [TrueClass, FalseClass] true if the task exists, else false
       def exists?
-        File.exist?(state_file)
+        state_file.nil? ? false : File.exist?(state_file)
       end
 
-      # writes a hash as json in the state_file
+      # writes a hash as JSON in the state_file
       # @param [Hash] state represented as a hash, to be written
       def write_state(state)
-        File.open(state_file, 'w') do |f|
-          f.write(JSON.generate(state))
+        if state_file
+          File.open(state_file, 'w') do |f|
+            f.write(JSON.generate(state))
+          end
         end
       end
     end

data/lib/serfx/version.rb

@@ -2,5 +2,5 @@
 #
 # Provides version as a contsant for the serf gem
 module Serfx
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serfx
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Rnjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack