beaneater 0.2.2 → 0.3.0

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # CHANGELOG for Beaneater
 
-## 0.2.3 (Unreleased)
+## 0.3.1 (Unreleased)
+
+## 0.3.0 (Jan 23 2013)
+
+* Replace Telnet with tcpsocket thanks @vidarh
 
 ## 0.2.2 (Dec 2 2012)
 

data/lib/beaneater.rb

@@ -1,4 +1,3 @@
-require 'net/telnet'
 require 'thread' unless defined?(Mutex)
 
 %w(version configuration errors pool_command pool connection stats tube job).each do |f|

data/lib/beaneater/connection.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'socket'
 
 module Beaneater
   # Represents a connection to a beanstalkd instance.
@@ -16,9 +17,9 @@ module Beaneater
     #  @return [Integer] returns Beanstalkd server port
     #  @example
     #    @conn.port # => "11300"
-    # @!attribute telnet_connection
-    #   @return [Net::Telnet] returns Telnet connection object
-    attr_reader :address, :host, :port, :telnet_connection
+    # @!attribute connection
+    #   @return [Net::TCPSocket] returns connection object
+    attr_reader :address, :host, :port, :connection
 
     # Default port value for beanstalk connection
     DEFAULT_PORT = 11300
@@ -32,28 +33,26 @@ module Beaneater
     #
     def initialize(address)
       @address = address
-      @telnet_connection = establish_connection
+      @connection = establish_connection
       @mutex = Mutex.new
     end
 
-    # Send commands to beanstalkd server via telnet_connection.
+    # Send commands to beanstalkd server via connection.
     #
+    # @param [Hash{String => String, Number}>] options Retained for compatibility
     # @param [String] command Beanstalkd command
-    # @param [Hash{Symbol => String,Boolean}] options Settings for telnet
-    # @option options [Boolean] FailEOF raises EOF Exeception
-    # @option options [Integer] Timeout number of seconds before timeout
     # @return [Array<Hash{String => String, Number}>] Beanstalkd command response
     # @example
     #   @conn.transmit('bury 123')
     #
-    def transmit(command, options={}, &block)
+    def transmit(command, options={})
       @mutex.lock
-      if telnet_connection
+      if connection
         command = command.force_encoding('ASCII-8BIT') if command.respond_to?(:force_encoding)
-        options.merge!("String" => command, "FailEOF" => true, "Timeout" => false)
-        parse_response(command, telnet_connection.cmd(options, &block))
-      else # no telnet_connection
-        raise NotConnected, "Connection to beanstalk '#{@host}:#{@port}' is closed!" unless telnet_connection
+        connection.write(command+"\r\n")
+        parse_response(command, connection.gets)
+      else # no connection
+        raise NotConnected, "Connection to beanstalk '#{@host}:#{@port}' is closed!" unless connection
       end
     ensure
       @mutex.unlock
@@ -65,8 +64,8 @@ module Beaneater
     #  @conn.close
     #
     def close
-      @telnet_connection.close
-      @telnet_connection = nil
+      @connection.close
+      @connection = nil
     end
 
     # Returns string representation of job.
@@ -81,9 +80,9 @@ module Beaneater
 
     protected
 
-    # Establish a telnet connection based on beanstalk address.
+    # Establish a connection based on beanstalk address.
     #
-    # @return [Net::Telnet] telnet connection for specified address.
+    # @return [Net::TCPSocket] connection for specified address.
     # @raise [Beanstalk::NotConnected] Could not connect to specified beanstalkd instance.
     # @example
     #  establish_connection('localhost:3005')
@@ -91,14 +90,15 @@ module Beaneater
     def establish_connection
       @match = address.split(':')
       @host, @port = @match[0], Integer(@match[1] || DEFAULT_PORT)
-      Net::Telnet.new('Host' => @host, "Port" => @port, "Prompt" => /\n/)
+      TCPSocket.new @host, @port
     rescue Errno::ECONNREFUSED => e
       raise NotConnected, "Could not connect to '#{@host}:#{@port}'"
     rescue Exception => ex
       raise NotConnected, "#{ex.class}: #{ex}"
     end
 
-    # Parses the telnet response and returns the useful beanstalk response.
+    # Parses the response and returns the useful beanstalk response.
+    # Will read the body if one is indicated by the status.
     #
     # @param [String] cmd Beanstalk command transmitted
     # @param [String] res Telnet command response
@@ -109,12 +109,19 @@ module Beaneater
     #   # => { :body => "FOO", :status => "DELETED", :id => 56, :connection => <Connection>  }
     #
     def parse_response(cmd, res)
-      res_lines = res.split(/\r?\n/)
-      status = res_lines.first
-      status, id = status.split(/\s/)
+      status = res.chomp
+      body_values = status.split(/\s/)
+      status = body_values[0]
       raise UnexpectedResponse.from_status(status, cmd) if UnexpectedResponse::ERROR_STATES.include?(status)
-      raw_body = res_lines[1..-1].join("\n")
-      body = ['FOUND', 'RESERVED'].include?(status) ? config.job_parser.call(raw_body) : YAML.load(raw_body)
+      body = nil
+      if ['OK','FOUND', 'RESERVED'].include?(status)
+        bytes_size = body_values[-1].to_i
+        raw_body = connection.read(bytes_size)
+        body = status == 'OK' ? YAML.load(raw_body) : config.job_parser.call(raw_body)
+        crlf = connection.read(2) # \r\n
+        raise ExpectedCRLFError if crlf != "\r\n"
+      end
+      id = body_values[1]
       response = { :status => status, :body => body }
       response[:id] = id if id
       response[:connection] = self
@@ -127,5 +134,6 @@ module Beaneater
     def config
       Beaneater.configuration
     end
+
   end # Connection
-end # Beaneater
+end # Beaneater

data/lib/beaneater/pool.rb

@@ -52,8 +52,8 @@ module Beaneater
     # Sends command to every beanstalkd server set in the pool.
     #
     # @param [String] command Beanstalkd command
-    # @param [Hash{String => String, Boolean}] options telnet connections options
-    # @param [Proc] block Block passed to telnet connection during transmit
+    # @param [Hash{String => String, Boolean}] options socket connections options
+    # @param [Proc] block Block passed to socket connection during transmit
     # @return [Array<Hash{String => String, Number}>] Beanstalkd command response from each instance
     # @example
     #   @pool.transmit_to_all("stats")
@@ -75,8 +75,8 @@ module Beaneater
     # Send command to each beanstalkd servers until getting response expected
     #
     # @param [String] command Beanstalkd command
-    # @param [Hash{String => String, Boolean}] options telnet connections options
-    # @param [Proc] block Block passed in telnet connection object
+    # @param [Hash{String => String, Boolean}] options socket connections options
+    # @param [Proc] block Block passed in socket connection object
     # @return [Array<Hash{String => String, Number}>] Beanstalkd command response from the instance
     # @example
     #   @pool.transmit_until_res('peek-ready', :status => "FOUND", &block)
@@ -99,8 +99,8 @@ module Beaneater
     # Sends command to a random beanstalkd server in the pool.
     #
     # @param [String] command Beanstalkd command
-    # @param [Hash{String => String,Boolean}] options telnet connections options
-    # @param [Proc] block Block passed in telnet connection object
+    # @param [Hash{String => String,Boolean}] options socket connections options
+    # @param [Proc] block Block passed in socket connection object
     # @return [Array<Hash{String => String, Number}>] Beanstalkd command response from the instance
     # @example
     #   @pool.transmit_to_rand("stats", :match => /\n/)

data/lib/beaneater/pool_command.rb

@@ -17,9 +17,9 @@ module Beaneater
     # Delegate to Pool#transmit_to_all and if needed will merge responses from beanstalkd.
     #
     # @param [String] body Beanstalkd command
-    # @param [Hash{String => String, Boolean}] options telnet connections options
+    # @param [Hash{String => String, Boolean}] options socket connections options
     # @option options [Boolean] merge Ask for merging responses or not
-    # @param [Proc] block Block passed in telnet connection object
+    # @param [Proc] block Block passed in socket connection object
     # @example
     #   @pool.transmit_to_all("stats")
     #

data/lib/beaneater/tube/record.rb

@@ -36,7 +36,7 @@ module Beaneater
         options = { :pri => config.default_put_pri, :delay => config.default_put_delay,
                     :ttr => config.default_put_ttr }.merge(options)
         cmd_options = "#{options[:pri]} #{options[:delay]} #{options[:ttr]} #{body.bytesize}"
-        transmit_to_rand("put #{cmd_options}\n#{body}")
+        transmit_to_rand("put #{cmd_options}\r\n#{body}")
       end
     end
 

data/lib/beaneater/version.rb

@@ -1,4 +1,4 @@
 module Beaneater
   # Current version of gem.
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/test/connection_test.rb

@@ -16,11 +16,10 @@ describe Beaneater::Connection do
       assert_equal 11300, @bc.port
     end
 
-    it "should init telnet connection" do
-      telops = @bc.telnet_connection.instance_variable_get(:@options)
-      assert_kind_of Net::Telnet, @bc.telnet_connection
-      assert_equal 'localhost', telops["Host"]
-      assert_equal 11300, telops["Port"]
+    it "should init connection" do
+      assert_kind_of TCPSocket, @bc.connection
+      assert_equal '127.0.0.1', @bc.connection.peeraddr[3]
+      assert_equal 11300, @bc.connection.peeraddr[1]
     end
 
     it "should raise on invalid connection" do
@@ -41,18 +40,26 @@ describe Beaneater::Connection do
     end
 
     it "should return id" do
-      Net::Telnet.any_instance.expects(:cmd).with(has_entries('String' => 'foo')).returns('INSERTED 254')
-      res = @bc.transmit 'foo'
-      assert_equal '254', res[:id]
+      res = @bc.transmit "put 0 0 100 1\r\nX"
+      assert res[:id]
       assert_equal 'INSERTED', res[:status]
     end
 
     it "should support dashes in response" do
-      Net::Telnet.any_instance.expects(:cmd).with(has_entries('String' => 'bar')).returns('USING foo-bar')
-      res = @bc.transmit 'bar'
+      res = @bc.transmit "use foo-bar\r\n"
       assert_equal 'USING', res[:status]
       assert_equal 'foo-bar', res[:id]
     end
+
+    it "should pass crlf through without changing its length" do
+      res = @bc.transmit "put 0 0 100 2\r\n\r\n"
+      assert_equal 'INSERTED', res[:status]
+    end
+
+    it "should handle *any* byte value without changing length" do
+      res = @bc.transmit "put 0 0 100 256\r\n"+(0..255).to_a.pack("c*")
+      assert_equal 'INSERTED', res[:status]
+    end
   end # transmit
 
   describe 'for #close' do
@@ -61,11 +68,11 @@ describe Beaneater::Connection do
       @bc = Beaneater::Connection.new(@host)
     end
 
-    it "should clear telnet connection" do
-      assert_kind_of Net::Telnet, @bc.telnet_connection
+    it "should clear connection" do
+      assert_kind_of TCPSocket, @bc.connection
       @bc.close
-      assert_nil @bc.telnet_connection
+      assert_nil @bc.connection
       assert_raises(Beaneater::NotConnected) { @bc.transmit 'stats' }
     end
   end # close
-end # Beaneater::Connection
+end # Beaneater::Connection

data/test/pool_test.rb

@@ -19,10 +19,10 @@ describe Beaneater::Pool do
         @host_num = '1.1.1.1:11303'
         @hosts = [@host_string_port, @host_num_port, @host_string, @host_num]
 
-        Net::Telnet.expects(:new).with('Host' => 'localhost', "Port" => 11301, "Prompt" => /\n/).once
-        Net::Telnet.expects(:new).with('Host' => '127.0.0.1', "Port" => 11302, "Prompt" => /\n/).once
-        Net::Telnet.expects(:new).with('Host' => 'host.local', "Port" => 11300, "Prompt" => /\n/).once
-        Net::Telnet.expects(:new).with('Host' => '1.1.1.1', "Port" => 11303, "Prompt" => /\n/).once
+        TCPSocket.expects(:new).with('localhost',11301).once
+        TCPSocket.expects(:new).with('127.0.0.1',11302).once
+        TCPSocket.expects(:new).with('host.local',11300).once
+        TCPSocket.expects(:new).with('1.1.1.1',11303).once
 
         @bp = Beaneater::Pool.new(@hosts)
       end
@@ -110,7 +110,7 @@ describe Beaneater::Pool do
     end
 
     it "should return id" do
-      Net::Telnet.any_instance.expects(:cmd).with(has_entries('String' => 'foo')).returns('INSERTED 254')
+      Beaneater::Connection.any_instance.expects(:transmit).with("foo",{}).returns({:id => "254", :status => "INSERTED"})
       res = @bp.transmit_to_rand 'foo'
       assert_equal '254', res[:id]
       assert_equal 'INSERTED', res[:status]
@@ -139,31 +139,30 @@ describe Beaneater::Pool do
 
   describe "for #safe_transmit" do
     it "should retry 3 times for temporary failed connection" do
-      Net::Telnet.any_instance.expects(:cmd).raises(EOFError).then.
+      TCPSocket.any_instance.expects(:write).times(3)
+      TCPSocket.any_instance.expects(:gets).raises(Errno::ECONNRESET).then.
         raises(Errno::ECONNRESET).then.returns('INSERTED 254').times(3)
-      res = @bp.transmit_to_rand 'foo'
+      res = @bp.transmit_to_rand "put 0 0 10 2\r\nxy"
       assert_equal '254', res[:id]
       assert_equal 'INSERTED', res[:status]
     end
 
-    it "should retry on fail 3 times for dead connection" do
-      Net::Telnet.any_instance.expects(:cmd).raises(EOFError).times(3)
-      assert_raises(Beaneater::NotConnected) { @bp.transmit_to_rand 'foo' }
-    end
-
     it 'should raise proper exception for invalid status NOT_FOUND' do
-      Net::Telnet.any_instance.expects(:cmd).returns('NOT_FOUND')
+      TCPSocket.any_instance.expects(:write).once
+      TCPSocket.any_instance.expects(:gets).returns('NOT_FOUND')
       assert_raises(Beaneater::NotFoundError) { @bp.transmit_to_rand 'foo' }
     end
 
     it 'should raise proper exception for invalid status BAD_FORMAT' do
-      Net::Telnet.any_instance.expects(:cmd).returns('BAD_FORMAT')
+      TCPSocket.any_instance.expects(:write).once
+      TCPSocket.any_instance.expects(:gets).returns('BAD_FORMAT')
       assert_raises(Beaneater::BadFormatError) { @bp.transmit_to_rand 'foo' }
     end
 
     it 'should raise proper exception for invalid status DEADLINE_SOON' do
-      Net::Telnet.any_instance.expects(:cmd).returns('DEADLINE_SOON')
-      assert_raises(Beaneater::DeadlineSoonError) { @bp.transmit_to_rand 'foo' }
+      TCPSocket.any_instance.expects(:write).once
+      TCPSocket.any_instance.expects(:gets).once.returns('DEADLINE_SOON')
+      assert_raises(Beaneater::DeadlineSoonError) { @bp.transmit_to_rand 'expecting deadline' }
     end
   end
 
@@ -172,10 +171,10 @@ describe Beaneater::Pool do
       connection = @bp.connections.first
       assert_equal 2, @bp.connections.size
       assert_kind_of Beaneater::Connection, connection
-      assert_kind_of Net::Telnet, connection.telnet_connection
+      assert_kind_of TCPSocket, connection.connection
       @bp.close
       assert_equal 0, @bp.connections.size
-      assert_nil connection.telnet_connection
+      assert_nil connection.connection
     end
   end # close
-end # Beaneater::Pool
+end # Beaneater::Pool

data/test/prompt_regexp_test.rb

@@ -0,0 +1,45 @@
+# test/prompt_regexp_test.rb
+
+require File.expand_path('../test_helper', __FILE__)
+require 'socket'
+
+describe "Reading from socket client" do
+  before do
+    @fake_port = 11301
+    @tube_name = 'tube.to.test'
+
+    @fake_server = Thread.start do
+      server = TCPServer.new(@fake_port)
+      loop do
+        IO.select([server])
+        client = server.accept_nonblock
+        while line = client.gets
+          case line
+          when /list-tubes-watched/i
+            client.print "OK #{7+@tube_name.size}\r\n---\n- #{@tube_name}\n\r\n"
+          when /watch #{@tube_name}/i
+            client.print "WATCHING 1\r\n"
+          when /reserve/i
+            client.print "RESERVED 17 25\r\n"
+            client.print "[first part]"
+            # Emulate network delay
+            sleep 0.5
+            client.print "[second part]\r\n"
+          else
+            client.print "ERROR\r\n"
+          end
+        end
+      end
+    end
+  end
+
+  it 'should reserve job with full body' do
+    pool = Beaneater::Pool.new("localhost:#{@fake_port}")
+    job = pool.tubes[@tube_name].reserve
+    assert_equal '[first part][second part]', job.body
+  end
+
+  after do
+    @fake_server.kill
+  end
+end

data/test/tube_test.rb

@@ -83,6 +83,17 @@ describe Beaneater::Tube do
       assert_equal 'hi', JSON.parse(@tube.peek(:ready).body)['message']
     end
 
+    it "supports passing crlf through" do
+      @tube.put("\r\n")
+      assert_equal "\r\n", @tube.peek(:ready).body
+    end
+
+    it "supports passing any byte value through" do
+      bytes = (0..255).to_a.pack("c*")
+      @tube.put(bytes)
+      assert_equal bytes, @tube.peek(:ready).body
+    end
+
     it "should support custom parser" do
       Beaneater.configure.job_parser = lambda { |b| JSON.parse(b) }
       json = '{"message":"hi"}'
@@ -195,4 +206,4 @@ describe Beaneater::Tube do
   after do
     cleanup_tubes!(['baz'])
   end
-end # Beaneater::Tubes
+end # Beaneater::Tubes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaneater
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-02 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -147,6 +147,7 @@ files:
 - test/jobs_test.rb
 - test/pool_command_test.rb
 - test/pool_test.rb
+- test/prompt_regexp_test.rb
 - test/stat_struct_test.rb
 - test/stats_test.rb
 - test/test_helper.rb
@@ -164,12 +165,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -394754542791428871
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -394754542791428871
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -184,6 +191,7 @@ test_files:
 - test/jobs_test.rb
 - test/pool_command_test.rb
 - test/pool_test.rb
+- test/prompt_regexp_test.rb
 - test/stat_struct_test.rb
 - test/stats_test.rb
 - test/test_helper.rb