mongrel2 0.2.4 → 0.3.0

data/ChangeLog

@@ -1,9 +1,70 @@
+2011-09-23  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.3.0 for changeset 627526429d63
+	[9c054d0e96c0] [tip]
+
+	* .hgsigs:
+	Added signature for changeset 745c431bcc1b
+	[627526429d63] [v0.3.0]
+
+	* History.rdoc, lib/mongrel2.rb:
+	Bump minor version, update History.
+	[745c431bcc1b]
+
+	* lib/mongrel2/control.rb, spec/mongrel2/control_spec.rb:
+	Mongrel2::Client fixes/doc updates:
+	- Added examples for some of the more-complex return values
+	- Fixed wording for some of the methods that I lazily copied from the
+	manual
+	- Client socket sets ZMQ::LINGER to 0 to try to avoid hangs when
+	destroying it without closing its socket first.
+	- Made Mongrel2::Client#time return a Time object directly instead of
+	wrapping it in a Hash. Need more experimentation with multiple
+	servers before I do this for other methods, however.
+	[1722ea9675c8]
+
+	* bin/m2sh.rb:
+	Include FileUtils in the 'm2sh.rb load' context so configs can
+	create run/log directories, etc.
+	[4c93cdb75813]
+
+	* lib/mongrel2/connection.rb:
+	Set SO_LINGER on the sockets so closing the connection doesn't wait
+	for unconsumed events.
+	[5e7a155a054e]
+
+	* lib/mongrel2/handler.rb:
+	Add missing include to Mongrel2::Handler
+	[47c4026c1f8d]
+
+	* lib/mongrel2/connection.rb:
+	Add a bit more debugging to Connection#send and #recv
+	[937683f0be2e]
+
 2011-09-21  Michael Granger  <ged@FaerieMUD.org>
 
+	* .hgtags:
+	Added tag v0.2.4 for changeset d4523fc43396
+	[89029a1edce5]
+
+	* .hgsigs:
+	Added signature for changeset d6797487c359
+	[d4523fc43396] [v0.2.4]
+
+	* History.rdoc, lib/mongrel2.rb:
+	Updated history, bumping patch version for release.
+	[d6797487c359]
+
+	* lib/mongrel2/httprequest.rb, lib/mongrel2/httpresponse.rb,
+	lib/mongrel2/request.rb:
+	Correct body size in inspected request/response output.
+	[e344d8af9fb9]
+
 	* lib/mongrel2/httpresponse.rb, lib/mongrel2/response.rb:
 	Added a cleaned-up Mongrel2::Response#inspect like
 	Mongrel2::Request.
-	[263a11ebf987] [tip]
+	[263a11ebf987]
 
 	* .hgtags:
 	Added tag v0.2.3 for changeset 49b62d1014e9
@@ -68,7 +129,7 @@
 
 	* lib/mongrel2/constants.rb:
 	Whitespace fix; add missing HTTP::CONTINUE constant.
-	[3082d251f00c]
+	[3082d251f00c] [github/master]
 
 2011-09-18  Michael Granger  <ged@FaerieMUD.org>
 
@@ -142,18 +203,14 @@
 	* Automated merge with ssh://deveiate.org/Ruby-Mongrel2
 	[2da76acfb8db]
 
-	* Rakefile:
-	Automated merge with ssh://deveiate.org/Ruby-Mongrel2
-	[e3908fd8e744]
-
-	* Rakefile:
-	Remove ChangeLog task, since hoe-deveiate already does it
-	[5f4982a32949]
-
 	* History.rdoc:
 	Updating History
 	[3b013d4918c6]
 
+	* Rakefile:
+	Automated merge with ssh://deveiate.org/Ruby-Mongrel2
+	[e3908fd8e744]
+
 	* .hgtags:
 	Added tag v0.1.1 for changeset 42da048fe158
 	[2489be2693d5]
@@ -170,6 +227,10 @@
 	Updated rbzmq dependency
 	[758fe465780e]
 
+	* Rakefile:
+	Remove ChangeLog task, since hoe-deveiate already does it
+	[5f4982a32949]
+
 	* .hgtags:
 	Added tag v0.1.0 for changeset 55c8f01c01c6
 	[39b509c68142]
@@ -211,15 +272,11 @@
 	Merged with 3659a56af8fb
 	[f2201728e874]
 
-	* .hgignore:
-	Ignoring packaging directory
-	[0613976b6735]
-
 2011-09-12  Michael Granger  <ged@FaerieMUD.org>
 
 	* README.rdoc:
 	README fixes
-	[3659a56af8fb] [github/master]
+	[3659a56af8fb]
 
 	* Rakefile:
 	Fixing gem name
@@ -283,6 +340,12 @@
 	procedures.
 	[19e0a72320dd]
 
+2011-09-13  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore:
+	Ignoring packaging directory
+	[0613976b6735]
+
 2011-09-10  Michael Granger  <ged@FaerieMUD.org>
 
 	* bin/m2sh.rb:
@@ -323,18 +386,6 @@
 	* Merged with 6ea60b67e106
 	[6d5341f30cc4]
 
-	* Manifest.txt:
-	Updating the manifest for the first release
-	[916a79570cdc]
-
-	* examples/helloworld-handler.rb, lib/mongrel2/handler.rb:
-	More Handler API docs.
-	[47427db9b4fb]
-
-	* lib/mongrel2/handler.rb:
-	Adding some Mongrel2::Handler API docs.
-	[da95bfdf83da]
-
 	* lib/mongrel2/config/host.rb:
 	Adding a many_to_one association for the server belonging to a
 	Mongrel2::Config::Host
@@ -354,6 +405,18 @@
 	Adding a proftools dump of the requestdumper app
 	[00cbc1b89a61]
 
+	* Manifest.txt:
+	Updating the manifest for the first release
+	[916a79570cdc]
+
+	* examples/helloworld-handler.rb, lib/mongrel2/handler.rb:
+	More Handler API docs.
+	[47427db9b4fb]
+
+	* lib/mongrel2/handler.rb:
+	Adding some Mongrel2::Handler API docs.
+	[da95bfdf83da]
+
 2011-09-08  Michael Granger  <ged@FaerieMUD.org>
 
 	* README.rdoc, lib/mongrel2.rb, lib/mongrel2/config.rb,

data/History.rdoc

@@ -1,3 +1,13 @@
+== v0.3.0 [2011-09-23] Michael Granger <ged@FaerieMUD.org>
+
+- Mongrel2::Client fixes/documentation updates.
+- Include FileUtils in the 'm2sh.rb load' context so configs 
+  loaded by it can create run/log directories, etc.
+- Mongrel2::Connection: Set SO_LINGER on the sockets so 
+  closing the connection doesn't wait for unconsumed events.
+- Add missing include to Mongrel2::Handler
+
+
 == v0.2.4 [2011-09-21] Michael Granger <ged@FaerieMUD.org>
 
 - Added a cleaned-up Mongrel2::Response#inspect like

data/bin/m2sh.rb

@@ -2,6 +2,7 @@
 
 require 'pp'
 require 'shellwords'
+require 'fileutils'
 require 'tnetstring'
 
 require 'trollop'
@@ -283,7 +284,7 @@ class Mongrel2::M2SHCommand
 			raise "No configfile specified."
 
 		runspace = Module.new do
-			extend Mongrel2::Config::DSL
+			extend Mongrel2::Config::DSL, FileUtils::Verbose
 		end
 
 		header "Loading config from #{configfile}"

data/lib/mongrel2.rb

@@ -14,10 +14,10 @@ module Mongrel2
 	abort "\n\n>>> Mongrel2 requires Ruby 1.9.2 or later. <<<\n\n" if RUBY_VERSION < '1.9.2'
 
 	# Library version constant
-	VERSION = '0.2.4'
+	VERSION = '0.3.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: d6797487c359 $
+	REVISION = %q$Revision: 745c431bcc1b $
 
 
 	require 'mongrel2/logging'

data/lib/mongrel2/connection.rb

@@ -58,15 +58,15 @@ class Mongrel2::Connection
 		ctx = Mongrel2.zmq_context
 		self.log.debug "0mq Context is: %p" % [ ctx ]
 
-		self.log.info "Connecting request socket (%s)" % [ @sub_addr ]
+		self.log.info "Connecting PULL request socket (%s)" % [ @sub_addr ]
 		@request_sock  = ctx.socket( ZMQ::PULL )
 		@request_sock.setsockopt( ZMQ::LINGER, 0 )
 		@request_sock.connect( @sub_addr )
 
-		self.log.info "Connecting response socket (%s)" % [ @pub_addr ]
+		self.log.info "Connecting PUB response socket (%s)" % [ @pub_addr ]
 		@response_sock  = ctx.socket( ZMQ::PUB )
-		@response_sock.setsockopt( ZMQ::LINGER, 0 )
 		@response_sock.setsockopt( ZMQ::IDENTITY, @app_id )
+		@response_sock.setsockopt( ZMQ::LINGER, 0 )
 		@response_sock.connect( @pub_addr )
 	end
 
@@ -93,7 +93,7 @@ class Mongrel2::Connection
 	def recv
 		self.check_closed
 
-		self.log.debug "Fetching next request"
+		self.log.debug "Fetching next request (PULL)"
 		data = self.request_sock.recv
 		self.log.debug "  got request data: %p" % [ data ]
 		return data
@@ -112,8 +112,9 @@ class Mongrel2::Connection
 		self.check_closed
         header = "%s %d:%s," % [ sender_id, conn_id.to_s.length, conn_id ]
 		buf = header + ' ' + data
-		self.log.debug "Sending response: %p" % [ buf ]
+		self.log.debug "Sending response (PUB): %p" % [ buf ]
 		self.response_sock.send( buf )
+		self.log.debug "  done with send."
 	end
 
 

data/lib/mongrel2/control.rb

@@ -23,6 +23,7 @@ class Mongrel2::Control
 	def initialize( port=DEFAULT_PORT )
 		@ctx = Mongrel2.zmq_context
 		@socket = @ctx.socket( ZMQ::REQ )
+		@socket.setsockopt( ZMQ::LINGER, 0 )
 		@socket.connect( port.to_s )
 	end
 
@@ -35,66 +36,105 @@ class Mongrel2::Control
 	attr_reader :socket
 
 
-	### Stops the server using a SIGINT.
+	### Stops the server using a SIGINT. Returns a hash with a ':msg' key
+	### that describes what happened on success.
 	def stop
 		self.request( :stop )
 	end
 
 
-	### Reloads the server using a SIGHUP.
+	### Reloads the server using a SIGHUP. Returns a hash with a ':msg' key
+	### that describes what happened on success.
 	def reload
 		self.request( :reload )
 	end
+	alias_method :restart, :reload
 
 
-	### Terminates the server with SIGTERM.
+	### Terminates the server with SIGTERM. Returns a hash with a ':msg' key
+	### that describes what happened on success.
 	def terminate
 		self.request( :terminate )
 	end
 
 
-	### Prints out a simple help message.
+	### Return an Array of Hashes, one for each command the server supports.
+	###
+	### Example:
+	###   [
+	###     {:name=>"stop", :help=>"stop the server (SIGINT)"},
+	###     {:name=>"reload", :help=>"reload the server"},
+	###     {:name=>"help", :help=>"this command"},
+	###     {:name=>"control_stop", :help=>"stop control port"},
+	###     {:name=>"kill", :help=>"kill a connection"},
+	###     {:name=>"status", :help=>"status, what=['net'|'tasks']"},
+	###     {:name=>"terminate", :help=>"terminate the server (SIGTERM)"},
+	###     {:name=>"time", :help=>"the server's time"},
+	###     {:name=>"uuid", :help=>"the server's uuid"},
+	###     {:name=>"info", :help=>"information about this server"}
+	###   ]
 	def help
 		self.request( :help )
 	end
 
 
 	### Returns the server’s UUID as a String.
+	###
+	### Example:
+	###   [{:uuid=>"28F6DCCF-28EB-48A4-A5B0-ED71D224FAE0"}]
 	def uuid
 		self.request( :uuid )
 	end
 
 
-	### More information about the server.
+	### Return information about the server.
+	###
+	### Example:
+	###   [{:port=>7337,
+	###     :bind_addr=>"0.0.0.0",
+	###     :uuid=>"28F6DCCF-28EB-48A4-A5B0-ED71D224FAE0",
+	###     :chroot=>"/var/www",
+	###     :access_log=>"/var/www/logs/admin-access.log",
+	###     :error_log=>"/logs/admin-error.log",
+	###     :pid_file=>"./run/admin.pid",
+	###     :default_hostname=>"localhost"}]
 	def info
 		self.request( :info )
 	end
 
 
-	### Returns a Hash of all the currently running tasks and what they’re doing, keyed
-	### by conn_id.
+	### Returns an Array of Hashes, one for each currently running task.
+	###
+	### Example:
+	###   [
+	###     {:id=>1, :system=>false, :name=>"SERVER", :state=>"read fd", :status=>"idle"},
+	###     {:id=>2, :system=>false, :name=>"Handler_task", :state=>"read handler", :status=>"idle"},
+	###     {:id=>3, :system=>false, :name=>"control", :state=>"read handler", :status=>"running"},
+	###     {:id=>4, :system=>false, :name=>"ticker", :state=>"", :status=>"idle"},
+	###     {:id=>5, :system=>true, :name=>"fdtask", :state=>"yield", :status=>"ready"}
+	###   ]
 	def tasklist
 		self.request( :status, :what => 'tasks' )
 	end
 
 
-	### Dumps a JSON dict that matches connections IDs (same ones your handlers 
-	### get) to the seconds since their last ping. In the case of an HTTP 
-	### connection this is how long they’ve been connected. In the case of a 
-	### JSON socket this is the last time a ping message was received.
+	### Returns an Array of Hashes, one for each connection to the server.
+	###
+	### Example:
+	###   [
+	###     {:id=>9, :fd=>27, :type=>1, :last_ping=>0, :last_read=>0, :last_write=>0, 
+	###      :bytes_read=>319, :bytes_written=>1065}
+	###   ]
 	def conn_status
 		self.request( :status, :what => 'net' )
 	end
 
 
-	### Prints the unix time the server thinks it’s using. Useful for synching.
+	### Returns the server's time as a Time object.
 	def time
 		response = self.request( :time )
-		response.each do |row|
-			row[ :time ] = Time.at( row.delete(:time).to_i ) if row[:time]
-		end
-
-		return response
+		return nil if response.empty?
+		return Time.at( response.first[:time].to_i )
 	end
 
 
@@ -111,6 +151,16 @@ class Mongrel2::Control
 	end
 
 
+	### Close the control port connection.
+	def close
+		self.socket.close
+	end
+
+
+	#########
+	protected
+	#########
+
 	### Send a raw request to the server, asking it to perform the +command+ with the specified
 	### +options+ hash and return the results.
 	def request( command, options={} )
@@ -124,12 +174,6 @@ class Mongrel2::Control
 	end
 
 
-	### Close the control port connection.
-	def close
-		self.socket.close
-	end
-
-
 	#######
 	private
 	#######

data/lib/mongrel2/handler.rb

@@ -79,7 +79,8 @@ require 'mongrel2/jsonrequest'
 #     app.run
 #     
 class Mongrel2::Handler
-	include Mongrel2::Loggable
+	include Mongrel2::Loggable,
+	        Mongrel2::Constants
 
 
 	### Create an instance of the handler using the config from the database with

data/spec/mongrel2/control_spec.rb

@@ -30,7 +30,7 @@ describe Mongrel2::Control do
 
 	before( :each ) do
 		@ctx = double( "ZMQ::Context" )
-		@socket = double( "ZMQ REQ socket", :connect => nil )
+		@socket = double( "ZMQ REQ socket", :connect => nil, :setsockopt => nil )
 		@ctx.stub( :socket ).with( ZMQ::REQ ).and_return( @socket )
 
 		Mongrel2.instance_variable_set( :@zmq_ctx, @ctx )
@@ -160,7 +160,7 @@ describe Mongrel2::Control do
 		@socket.should_receive( :send ).with( "10:4:time,0:}]" )
 		@socket.should_receive( :recv ).
 			and_return( "49:7:headers,7:4:time,]4:rows,18:14:10:1315532674,]]}" )
-		@control.time.should == [{ :time => Time.at(1315532674) }]
+		@control.time.should == Time.at( 1315532674 )
 	end
 
 	it "sends a 'kill' command with an ID equal to the argument to the control port when #kill " +

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongrel2
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -48,11 +48,11 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2011-09-22 00:00:00.000000000Z
+date: 2011-09-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70275094474160 !ruby/object:Gem::Requirement
+  requirement: &2170257000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -60,10 +60,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70275094474160
+  version_requirements: *2170257000
 - !ruby/object:Gem::Dependency
   name: sequel
-  requirement: &70275094472460 !ruby/object:Gem::Requirement
+  requirement: &2170254880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,10 +71,10 @@ dependencies:
         version: '3.26'
   type: :runtime
   prerelease: false
-  version_requirements: *70275094472460
+  version_requirements: *2170254880
 - !ruby/object:Gem::Dependency
   name: amalgalite
-  requirement: &70275094471640 !ruby/object:Gem::Requirement
+  requirement: &2170254220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -82,10 +82,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70275094471640
+  version_requirements: *2170254220
 - !ruby/object:Gem::Dependency
   name: tnetstring
-  requirement: &70275094470760 !ruby/object:Gem::Requirement
+  requirement: &2170253640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -93,10 +93,10 @@ dependencies:
         version: '0.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70275094470760
+  version_requirements: *2170253640
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70275094467600 !ruby/object:Gem::Requirement
+  requirement: &2170252900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -104,10 +104,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70275094467600
+  version_requirements: *2170252900
 - !ruby/object:Gem::Dependency
   name: zmq
-  requirement: &70275094462620 !ruby/object:Gem::Requirement
+  requirement: &2170252240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -115,10 +115,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *70275094462620
+  version_requirements: *2170252240
 - !ruby/object:Gem::Dependency
   name: hoe-mercurial
-  requirement: &70275094461620 !ruby/object:Gem::Requirement
+  requirement: &2170251620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -126,10 +126,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70275094461620
+  version_requirements: *2170251620
 - !ruby/object:Gem::Dependency
   name: hoe-highline
-  requirement: &70275094460460 !ruby/object:Gem::Requirement
+  requirement: &2170250880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -137,10 +137,10 @@ dependencies:
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *70275094460460
+  version_requirements: *2170250880
 - !ruby/object:Gem::Dependency
   name: configurability
-  requirement: &70275094459180 !ruby/object:Gem::Requirement
+  requirement: &2170250120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -148,10 +148,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70275094459180
+  version_requirements: *2170250120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70275094457960 !ruby/object:Gem::Requirement
+  requirement: &2170249500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -159,10 +159,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70275094457960
+  version_requirements: *2170249500
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70275094456560 !ruby/object:Gem::Requirement
+  requirement: &2170248800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -170,7 +170,7 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70275094456560
+  version_requirements: *2170248800
 description: ! "A complete Ruby connector for Mongrel2[http://mongrel2.org/].\n\nThis
   library includes configuration-database ORM classes, a Ruby\nimplementation of the
   'm2sh' tool, a configuration DSL for generating config\ndatabases in pure Ruby,