sanford 0.13.0 → 0.14.0

data/lib/sanford/connection_handler.rb

@@ -2,7 +2,6 @@ require 'benchmark'
 require 'sanford-protocol'
 require 'sanford/error_handler'
 require 'sanford/logger'
-require 'sanford/runner'
 
 module Sanford
 

data/lib/sanford/error_handler.rb

@@ -46,7 +46,7 @@ module Sanford
 
     def response_from_exception(exception)
       case(exception)
-      when Sanford::Protocol::BadMessageError, Sanford::Protocol::BadRequestError
+      when Sanford::Protocol::BadMessageError, Sanford::Protocol::Request::InvalidError
         build_response :bad_request, :message => exception.message
       when Sanford::NotFoundError
         build_response :not_found

data/lib/sanford/process.rb

@@ -48,7 +48,7 @@ module Sanford
       thread = @server.start(@client_fds)
       log "#{@server.name} server started and ready."
       thread.join
-      exec_restart_cmd if @server.paused?
+      run_restart_cmd if @server.paused?
     rescue StandardError => exception
       log "Error: #{exception.message}"
       log "#{@server.name} server never started."
@@ -66,12 +66,12 @@ module Sanford
       @logger.info "[Sanford] #{message}"
     end
 
-    def exec_restart_cmd
+    def run_restart_cmd
       log "Restarting #{@server.name} daemon..."
       ENV['SANFORD_SERVER_FD'] = @server.file_descriptor.to_s
       ENV['SANFORD_CLIENT_FDS'] = @server.client_file_descriptors.join(',')
       ENV['SANFORD_SKIP_DAEMONIZE'] = 'yes'
-      @restart_cmd.exec
+      @restart_cmd.run
     end
 
     def default_if_blank(value, default, &block)
@@ -91,21 +91,22 @@ module Sanford
     def initialize
       require 'rubygems'
       @dir  = get_pwd
-      @argv = [ Gem.ruby, $0, ARGV.dup ].flatten
+      @argv = [Gem.ruby, $0, ARGV.dup].flatten
     end
 
-    def exec
+    def run
       Dir.chdir self.dir
       Kernel.exec(*self.argv)
     end
 
-    protected
+    private
 
     # Trick from puma/unicorn. Favor PWD because it contains an unresolved
     # symlink. This is useful when restarting after deploying; the original
     # directory may be removed, but the symlink is pointing to a new
     # directory.
     def get_pwd
+      return Dir.pwd if ENV['PWD'].nil?
       env_stat = File.stat(ENV['PWD'])
       pwd_stat = File.stat(Dir.pwd)
       if env_stat.ino == pwd_stat.ino && env_stat.dev == pwd_stat.dev

data/lib/sanford/router.rb

@@ -7,14 +7,13 @@ module Sanford
     attr_reader :routes
 
     def initialize(&block)
-      @service_handler_ns = nil
       @routes = []
       self.instance_eval(&block) if !block.nil?
     end
 
     def service_handler_ns(value = nil)
-      @view_handler_ns = value if !value.nil?
-      @view_handler_ns
+      @service_handler_ns = value if !value.nil?
+      @service_handler_ns
     end
 
     def service(name, handler_name)

data/lib/sanford/runner.rb

@@ -19,7 +19,6 @@ module Sanford
 
     def initialize(handler_class, args = nil)
       @handler_class = handler_class
-      @handler = @handler_class.new(self)
 
       a = args || {}
       @request         = a[:request]
@@ -27,6 +26,8 @@ module Sanford
       @logger          = a[:logger] || Sanford::NullLogger.new
       @router          = a[:router] || Sanford::Router.new
       @template_source = a[:template_source] || Sanford::NullTemplateSource.new
+
+      @handler = @handler_class.new(self)
     end
 
     def run

data/lib/sanford/server.rb

@@ -1,6 +1,7 @@
 require 'dat-tcp'
 require 'ns-options'
 require 'ns-options/boolean'
+require 'pathname'
 require 'sanford-protocol'
 require 'socket'
 require 'sanford/logger'

data/lib/sanford/test_runner.rb

@@ -18,10 +18,10 @@ module Sanford
 
       args = (args || {}).dup
       super(handler_class, {
-        :request => args.delete(:request),
-        :params  => args.delete(:params),
-        :logger  => args.delete(:logger),
-        :router  => args.delete(:router),
+        :request         => args.delete(:request),
+        :params          => normalize_params(args.delete(:params) || {}),
+        :logger          => args.delete(:logger),
+        :router          => args.delete(:router),
         :template_source => args.delete(:template_source)
       })
       args.each{ |key, value| @handler.send("#{key}=", value) }
@@ -40,11 +40,18 @@ module Sanford
 
     private
 
+    # Stringify and encode/decode to ensure params are valid and are
+    # in the format they would normally be when a handler is built and run.
+    def normalize_params(params)
+      p = Sanford::Protocol::StringifyParams.new(params)
+      Sanford::Protocol.msg_body.decode(Sanford::Protocol.msg_body.encode(p))
+    end
+
     def build_and_serialize_response(&block)
       build_response(&block).tap do |response|
         # attempt to serialize (and then throw away) the response data
-        # this will error on the developer if BSON can't serialize their response
-        Sanford::Protocol::BsonBody.new.encode(response.to_hash) if response
+        # this will error on the developer if it can't serialize their response
+        Sanford::Protocol.msg_body.encode(response.to_hash) if response
       end
     end
 

data/lib/sanford/version.rb

@@ -1,3 +1,3 @@
 module Sanford
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/sanford.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("dat-tcp",          ["~> 0.6"])
   gem.add_dependency("ns-options",       ["~> 1.1"])
-  gem.add_dependency("sanford-protocol", ["~> 0.10"])
+  gem.add_dependency("sanford-protocol", ["~> 0.11"])
 
-  gem.add_development_dependency("assert", ["~> 2.12"])
+  gem.add_development_dependency("assert", ["~> 2.14"])
 end

data/test/unit/error_handler_tests.rb

@@ -99,8 +99,8 @@ class Sanford::ErrorHandler
       assert_equal 'bad message', response.status.message
     end
 
-    should "build a 400 response with a protocol BadRequestError" do
-      exception = generate_exception(Sanford::Protocol::BadRequestError, 'bad request')
+    should "build a 400 response with a protocol request invalid error" do
+      exception = generate_exception(Sanford::Protocol::Request::InvalidError, 'bad request')
       response = Sanford::ErrorHandler.new(exception, @server_data).run
 
       assert_equal 400, response.code

data/test/unit/process_tests.rb

@@ -87,8 +87,8 @@ class Sanford::Process
       ENV['SANFORD_PORT'] = ''
       ENV['SANFORD_SERVER_FD'] = ''
       process = @process_class.new(@server_spy)
-      assert_equal @server_spy.configured_ip, subject.server_ip
-      assert_equal @server_spy.configured_port, subject.server_port
+      assert_equal @server_spy.configured_ip, process.server_ip
+      assert_equal @server_spy.configured_port, process.server_port
       assert_nil process.server_fd
     end
 
@@ -105,7 +105,7 @@ class Sanford::Process
 
     should "not daemonize by default" do
       process = @process_class.new(@server_spy)
-      assert_false subject.daemonize?
+      assert_false process.daemonize?
     end
 
     should "daemonize if turned on" do
@@ -212,8 +212,8 @@ class Sanford::Process
       assert_true @server_spy.thread.join_called
     end
 
-    should "not have exec'd the restart cmd" do
-      assert_false @restart_cmd_spy.exec_called
+    should "not run the restart cmd" do
+      assert_false @restart_cmd_spy.run_called
     end
 
     should "have removed the PID file" do
@@ -297,15 +297,12 @@ class Sanford::Process
       @process.run
     end
 
-    should "have set env vars for execing the restart cmd" do
+    should "set env vars for restarting and run the restart cmd" do
       assert_equal @server_spy.file_descriptor.to_s, ENV['SANFORD_SERVER_FD']
       expected = @server_spy.client_file_descriptors.join(',')
       assert_equal expected, ENV['SANFORD_CLIENT_FDS']
       assert_equal 'yes', ENV['SANFORD_SKIP_DAEMONIZE']
-    end
-
-    should "have exec'd the restart cmd" do
-      assert_true @restart_cmd_spy.exec_called
+      assert_true @restart_cmd_spy.run_called
     end
 
   end
@@ -313,32 +310,85 @@ class Sanford::Process
   class RestartCmdTests < UnitTests
     desc "RestartCmd"
     setup do
-      @restart_cmd = Sanford::RestartCmd.new
+      @current_pwd = ENV['PWD']
+      ENV['PWD'] = Factory.path
 
-      @chdir_called = false
-      Assert.stub(Dir, :chdir).with(@restart_cmd.dir){ @chdir_called = true }
+      @ruby_pwd_stat = File.stat(Dir.pwd)
+      env_pwd_stat = File.stat('/dev/null')
+      Assert.stub(File, :stat).with(Dir.pwd){ @ruby_pwd_stat }
+      Assert.stub(File, :stat).with(ENV['PWD']){ env_pwd_stat }
 
-      @exec_called = false
-      Assert.stub(Kernel, :exec).with(*@restart_cmd.argv){ @exec_called = true }
+      @chdir_called_with = nil
+      Assert.stub(Dir, :chdir){ |*args| @chdir_called_with = args }
+
+      @exec_called_with = false
+      Assert.stub(Kernel, :exec){ |*args| @exec_called_with = args }
+
+      @cmd_class = Sanford::RestartCmd
+    end
+    teardown do
+      ENV['PWD'] = @current_pwd
     end
     subject{ @restart_cmd }
 
+  end
+
+  class RestartCmdInitTests < RestartCmdTests
+    desc "when init"
+    setup do
+      @restart_cmd = @cmd_class.new
+    end
+
     should have_readers :argv, :dir
+    should have_imeths :run
+
+    should "know its argv" do
+      assert_equal [Gem.ruby, $0, ARGV].flatten, subject.argv
+    end
 
-    should "know its argv and dir" do
-      expected = [ Gem.ruby, $0, ARGV ].flatten
-      assert_equal expected, subject.argv
+    should "change the dir and run a kernel exec when run" do
+      subject.run
+      assert_equal [subject.dir], @chdir_called_with
+      assert_equal subject.argv,  @exec_called_with
+    end
+
+  end
+
+  class RestartCmdWithPWDEnvNoMatchTests < RestartCmdTests
+    desc "when init with a PWD env variable that doesn't point to ruby working dir"
+    setup do
+      @restart_cmd = @cmd_class.new
+    end
+
+    should "know its dir" do
       assert_equal Dir.pwd, subject.dir
     end
 
-    should "change the dir when exec'd" do
-      subject.exec
-      assert_true @chdir_called
+  end
+
+  class RestartCmdWithPWDEnvInitTests < RestartCmdTests
+    desc "when init with a PWD env variable that points to the ruby working dir"
+    setup do
+      # make ENV['PWD'] point to the same file as Dir.pwd
+      Assert.stub(File, :stat).with(ENV['PWD']){ @ruby_pwd_stat }
+      @restart_cmd = @cmd_class.new
     end
 
-    should "kernel exec its argv when exec'd" do
-      subject.exec
-      assert_true @exec_called
+    should "know its dir" do
+      assert_equal ENV['PWD'], subject.dir
+    end
+
+  end
+
+  class RestartCmdWithNoPWDEnvInitTests < RestartCmdTests
+    desc "when init with a PWD env variable set"
+    setup do
+      ENV.delete('PWD')
+      @restart_cmd = @cmd_class.new
+    end
+
+    should "know its dir" do
+      assert_equal Dir.pwd, subject.dir
     end
 
   end
@@ -417,14 +467,14 @@ class Sanford::Process
   end
 
   class RestartCmdSpy
-    attr_reader :exec_called
+    attr_reader :run_called
 
     def initialize
-      @exec_called = false
+      @run_called = false
     end
 
-    def exec
-      @exec_called = true
+    def run
+      @run_called = true
     end
   end
 

data/test/unit/route_tests.rb

@@ -16,6 +16,7 @@ class Sanford::Route
     subject{ @route }
 
     should have_readers :name, :handler_class_name, :handler_class
+    should have_imeths :validate!, :run
 
     should "know its name and handler class name" do
       assert_equal @name, subject.name

data/test/unit/router_tests.rb

@@ -6,7 +6,7 @@ require 'test/support/factory'
 class Sanford::Router
 
   class UnitTests < Assert::Context
-    desc "Sanford::Host"
+    desc "Sanford::Router"
     setup do
       @router = Sanford::Router.new
     end

data/test/unit/test_runner_tests.rb

@@ -22,48 +22,80 @@ class Sanford::TestRunner
     setup do
       @params = { Factory.string => Factory.integer }
       @args = {
-        :request => 'a-request',
-        :params  => @params,
-        :logger  => 'a-logger',
-        :router  => 'a-router',
-        :template_source => 'a-source'
+        :request         => Factory.string,
+        :params          => @params,
+        :logger          => Factory.string,
+        :router          => Factory.string,
+        :template_source => Factory.string,
+        :custom_value    => Factory.integer
       }
-      @runner = @runner_class.new(@handler_class, @args)
+      @original_args = @args.dup
+      @runner  = @runner_class.new(@handler_class, @args)
+      @handler = @runner.handler
     end
     subject{ @runner }
 
     should have_readers :response
     should have_imeths :run
 
-    should "raise an invalid error when not passed a service handler" do
-      assert_raises(Sanford::InvalidServiceHandlerError) do
-        @runner_class.new(Class.new)
-      end
+    should "know its standard attributes" do
+      assert_equal @args[:request],         subject.request
+      assert_equal @params,                 subject.params
+      assert_equal @args[:logger],          subject.logger
+      assert_equal @args[:router],          subject.router
+      assert_equal @args[:template_source], subject.template_source
+    end
+
+    should "write any non-standard args to its handler" do
+      assert_equal @args[:custom_value], @handler.custom_value
     end
 
-    should "super its standard attributes" do
-      assert_equal 'a-request',  subject.request
-      assert_equal @params,      subject.params
-      assert_equal 'a-logger',   subject.logger
-      assert_equal 'a-router',   subject.router
-      assert_equal 'a-source',   subject.template_source
+    should "not alter the args passed to it" do
+      assert_equal @original_args, @args
     end
 
-    should "write any non-standard args on the handler" do
-      runner = @runner_class.new(@handler_class, :custom_value => 42)
-      assert_equal 42, runner.handler.custom_value
+    should "not call its service handlers before callbacks" do
+      assert_nil @handler.before_called
     end
 
-    should "not have called its service handlers before callbacks" do
-      assert_nil subject.handler.before_called
+    should "call its service handlers init" do
+      assert_true @handler.init_called
     end
 
-    should "have called init on its service handler" do
-      assert_true subject.handler.init_called
+    should "not run its service handler" do
+      assert_false @handler.run_called
+    end
+
+    should "not call its service handlers after callbacks" do
+      assert_nil @handler.after_called
     end
 
     should "not have a response by default" do
-      assert_nil subject.response
+      assert_nil @handler.response
+    end
+
+    should "normalize the params passed to it" do
+      params = {
+        Factory.string        => Factory.string,
+        Factory.string.to_sym => Factory.string.to_sym,
+        Factory.integer       => Factory.integer
+      }
+      runner = @runner_class.new(@handler_class, :params => params)
+      exp = Sanford::Protocol::StringifyParams.new(params)
+      assert_equal exp, runner.params
+    end
+
+    should "raise a serialization error if the params can't be serialized" do
+      params = { Factory.string => Class.new }
+      assert_raises(BSON::InvalidDocument) do
+        @runner_class.new(@handler_class, :params => params)
+      end
+    end
+
+    should "raise an invalid error when passed a non service handler" do
+      assert_raises(Sanford::InvalidServiceHandlerError) do
+        @runner_class.new(Class.new)
+      end
     end
 
   end
@@ -80,11 +112,11 @@ class Sanford::TestRunner
       assert_instance_of Sanford::Protocol::Response, subject
     end
 
-    should "have called run on its service handler" do
+    should "run its service handler" do
       assert_true @runner.handler.run_called
     end
 
-    should "not have called its service handlers after callbacks" do
+    should "not call its service handler's after callbacks" do
       assert_nil @runner.handler.after_called
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 39
   prerelease: 
   segments: 
   - 0
-  - 13
+  - 14
   - 0
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-02-04 00:00:00 Z
+date: 2015-06-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -54,11 +54,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 29
         segments: 
         - 0
-        - 10
-        version: "0.10"
+        - 11
+        version: "0.11"
   type: :runtime
   name: sanford-protocol
   version_requirements: *id003
@@ -69,11 +69,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 31
         segments: 
         - 2
-        - 12
-        version: "2.12"
+        - 14
+        version: "2.14"
   type: :development
   name: assert
   version_requirements: *id004