ng 0.0.2 → 0.0.3

data/README.md

@@ -1,24 +1,43 @@
 # ng - Pure-Ruby Nailgun client port
 
-Eliminates the need to shell-out when using Nailgun
+Eliminates the need to shell-out to the `ng` binary when using Nailgun, by implementing the Nailgun Protocol in pure Ruby code.
+
+This was an experiment, so don't consider it stable.
+
+I've noticed that Nailgun doesn't like when its IO buffer fills up, and it will if you don't empty it fast enough. Ruby may not be fast enough to handle this job, so if you're trying to send/receive lots of data, this may not work for you. If you're just sending some signals and getting small return values, it may yet.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install ng
 
-    gem 'ng'
+## Usage
 
-And then execute:
+```Ruby
+# instantiate a new client (optional option overrides may be passed in)
+client = Nailgun::Client.new(port: 2114)
 
-    $ bundle
+# send this command to the server
+client.run('java.Command', :arg1, 2) # args are splatted on the instance method
 
-Or install it yourself as:
+# shouldn't be strictly necessary to close the socket manually, but it's there if you want it
+client.close!
+```
 
-    $ gem install ng
+A class method is also available:
 
-## Usage
+```Ruby
+Nailgun::Client.run('java.Command', [:arg1, 2], port: 2114) # args must be explicitly an array here
+```
+
+Or, if you prefer, there is a block form available, which automatically closes the socket at completion
+
+```Ruby
+Nailgun::Client.new do |client|
+
+  client.run('java.Command', [:arg1, 2])
 
-TODO: Write usage instructions here
+end
+```
 
 ## Contributing
 

data/lib/nailgun/client.rb

@@ -5,6 +5,51 @@ require 'timeout'
 
 module Nailgun
   class Client
+
+    DEFAULTS = {
+      hostname:  'localhost',
+      port:      2113,
+      stdin:     nil,
+      stdout:    STDOUT,
+      stderr:    STDERR,
+      env:       ENV,
+      dir:       Dir.pwd
+    }.freeze
+
+    CHUNK_HEADER_LEN = 5
+
+    TIMEOUT = 5
+
+    TimeoutError             = Class.new(StandardError)
+    SocketFailedError        = Class.new(StandardError)
+    ConnectFailedError       = Class.new(StandardError)
+    UnexpectedChunktypeError = Class.new(StandardError)
+    ServerExceptionError     = Class.new(StandardError)
+    ConnectionBrokenError    = Class.new(StandardError)
+    BadArgumentsError        = Class.new(StandardError)
+    OtherError               = Class.new(StandardError)
+
+    EXIT_CODE_EXCEPTIONS = {
+      999 => SocketFailedError,
+      998 => ConnectFailedError,
+      997 => UnexpectedChunktypeError,
+      996 => ServerExceptionError,
+      995 => ConnectionBrokenError,
+      994 => BadArgumentsError
+    }.freeze
+
+    CHUNK_TYPES = {
+      stdin:     '0',
+      stdout:    '1',
+      stderr:    '2',
+      stdin_eof: '.',
+      arg:       'A',
+      env:       'E',
+      dir:       'D',
+      cmd:       'C',
+      exit:      'X'
+    }.freeze
+
     attr_reader :opts, :socket
 
     # Public: Convinience method to instantiate and run the command
@@ -20,10 +65,16 @@ module Nailgun
 
     # Public: Initialize a Client.
     #
-    # opts = {} - a Hash of options to override the defaults in Nailgun::DEFAULTS
+    # opts = {} - a Hash of options to override the defaults in DEFAULTS
     def initialize(opts = {})
-      @opts = Nailgun::DEFAULTS.merge(opts)
+      @opts = DEFAULTS.merge(opts)
       @socket = TCPSocket.new(*@opts.values_at(:hostname, :port))
+
+      if block_given?
+        yield self
+        @socket.close
+        return nil
+      end
     end
 
     # Public: Run a command on the Client instance
@@ -54,6 +105,11 @@ module Nailgun
         end
       }
     end
+
+    # Public: Explicitly close the TCPSocket
+    def close!
+      socket.close
+    end
 
     private
 
@@ -113,7 +169,7 @@ module Nailgun
 
     # Private: get the next chunk from the socket, and then determine what to do with it.
     def receive_chunk
-      Timeout.timeout(Nailgun::TIMEOUT, Nailgun::TimeoutError) do
+      Timeout.timeout(TIMEOUT, TimeoutError) do
         length, type = receive_header
         if length > 0
           content = socket.read(length)
@@ -127,7 +183,7 @@ module Nailgun
     #
     # Returns [length, type]
     def receive_header
-      socket.read(Nailgun::CHUNK_HEADER_LEN).unpack('NA')
+      socket.read(CHUNK_HEADER_LEN).unpack('NA')
     end
 
     # Private: Determine what to do with the received chunk
@@ -135,24 +191,24 @@ module Nailgun
     # type - chunk type
     # content - chunk content
     def handle_chunk(type, content)
-      case t = Nailgun::CHUNK_TYPES.key(type)
+      case t = CHUNK_TYPES.key(type)
       when :stdout, :stderr
         opts[t].write content
       when :exit
         socket.close
         handle_exit(content.to_i)
       else
-        raise Nailgun::UnexpectedChunktypeError.new([type, content].join(?;))
+        raise UnexpectedChunktypeError.new([type, content].join(?;))
       end
     end
 
     def handle_exit(code)
       if code == 0
         throw :exit
-      elsif ex = Nailgun::EXIT_CODE_EXCEPTIONS[code]
+      elsif ex = EXIT_CODE_EXCEPTIONS[code]
         raise ex.new
       else
-        raise Nailgun::OtherError.new(code.to_s)
+        raise OtherError.new(code.to_s)
       end
     end
 

data/lib/nailgun/client/chunk_header.rb

@@ -2,7 +2,7 @@ module Nailgun
   class Client
     class ChunkHeader
       def initialize(type, content_length)
-        @type = Nailgun::CHUNK_TYPES[type]
+        @type = Client::CHUNK_TYPES[type]
         @content_length = content_length
       end
 

data/lib/nailgun/client/version.rb

@@ -0,0 +1,5 @@
+module Nailgun
+  class Client
+    VERSION = '0.0.3'
+  end
+end

data/lib/ng.rb

@@ -0,0 +1,2 @@
+require_relative 'nailgun/client'
+require_relative 'nailgun/client/version'

data/ng.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/nailgun/version', __FILE__)
+require File.expand_path('../lib/nailgun/client/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Ryan Taylor Long']
@@ -13,5 +13,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'ng'
   gem.require_paths = ['lib']
-  gem.version       = Nailgun::VERSION
+  gem.version       = Nailgun::Client::VERSION
 end

data/test_app/Gemfile

@@ -0,0 +1,7 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'nailgun', github: 'amardaxini/nailgun'
+gem "ng", path: '../'
+
+gem 'pry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ng
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies: []
 description: Pure-Ruby Nailgun client port
 email:
@@ -23,12 +23,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/nailgun.rb
 - lib/nailgun/client.rb
 - lib/nailgun/client/chunk.rb
 - lib/nailgun/client/chunk_header.rb
-- lib/nailgun/version.rb
+- lib/nailgun/client/version.rb
+- lib/ng.rb
 - ng.gemspec
+- test_app/Gemfile
 homepage: ''
 licenses: []
 post_install_message: 

data/lib/nailgun.rb

@@ -1,49 +0,0 @@
-require_relative 'nailgun/version'
-require_relative 'nailgun/client'
-
-module Nailgun
-
-  DEFAULTS = {
-    hostname:  'localhost',
-    port:      2113,
-    stdin:     nil,
-    stdout:    STDOUT,
-    stderr:    STDERR,
-    env:       ENV,
-    dir:       Dir.pwd
-  }.freeze
-
-  CHUNK_HEADER_LEN = 5
-
-  TIMEOUT = 5
-
-  TimeoutError             = Class.new(StandardError)
-  SocketFailedError        = Class.new(StandardError)
-  ConnectFailedError       = Class.new(StandardError)
-  UnexpectedChunktypeError = Class.new(StandardError)
-  ServerExceptionError     = Class.new(StandardError)
-  ConnectionBrokenError    = Class.new(StandardError)
-  BadArgumentsError        = Class.new(StandardError)
-  OtherError               = Class.new(StandardError)
-
-  EXIT_CODE_EXCEPTIONS = {
-    999 => SocketFailedError,
-    998 => ConnectFailedError,
-    997 => UnexpectedChunktypeError,
-    996 => ServerExceptionError,
-    995 => ConnectionBrokenError,
-    994 => BadArgumentsError
-  }.freeze
-
-  CHUNK_TYPES = {
-    stdin:     '0',
-    stdout:    '1',
-    stderr:    '2',
-    stdin_eof: '.',
-    arg:       'A',
-    env:       'E',
-    dir:       'D',
-    cmd:       'C',
-    exit:      'X'
-  }.freeze
-end

data/lib/nailgun/version.rb

@@ -1,3 +0,0 @@
-module Nailgun
-  VERSION = '0.0.2'
-end