sanford 0.3.0 → 0.4.0

data/README.md

@@ -144,14 +144,16 @@ Define a `name` on a Host to set a string name for your host that can be used to
 
 ### Loading An Application
 
-Typically, a Sanford host is part of a larger application and parts of the application need to be setup or loaded when you start your Sanford server. The task `sanford:setup` is called before running any start, stop, or restart task; override it to hook in your application setup code:
+Typically, a Sanford host is part of a larger application and parts of the application need to be setup or loaded when you start your Sanford server. to support this, Sanford provides a `setup` hook for hosts. The proc that is defined will be called before the Sanford server is started, properly running the server in your application's environment:
 
 ```ruby
-# In your Rakefile
-namespace :sanford do
-  task :setup do
-    require 'config/environment'
+class MyHost
+  include Sanford::Host
+
+  setup do
+    require File.expand_path("../config/environment", __FILE__)
   end
+
 end
 ```
 

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 
-ENV['SANFORD_SERVICES_CONFIG'] = 'bench/services'
+ENV['SANFORD_SERVICES_FILE'] = 'bench/services'
 require 'sanford/rake'
 require 'bench/tasks'
 

data/bench/report.txt

@@ -2,39 +2,39 @@ Running benchmark report...
 
 Hitting "simple" service with {}, 10000 times
 ....................................................................................................
-Total Time:   10195.4432ms
-Average Time:     1.0195ms
-Min Time:         0.7040ms
-Max Time:       117.8309ms
+Total Time:   10515.3759ms
+Average Time:     1.0515ms
+Min Time:         0.7140ms
+Max Time:       114.8610ms
 
 Distribution (number of requests):
-  0ms: 8897
-    0.7ms: 6897
-    0.8ms: 1451
-    0.9ms: 549
-  1ms: 1049
-    1.0ms: 308
-    1.1ms: 236
-    1.2ms: 198
-    1.3ms: 134
-    1.4ms: 66
-    1.5ms: 44
-    1.6ms: 26
-    1.7ms: 18
-    1.8ms: 15
+  0ms: 8614
+    0.7ms: 4945
+    0.8ms: 2641
+    0.9ms: 1028
+  1ms: 1339
+    1.0ms: 612
+    1.1ms: 370
+    1.2ms: 172
+    1.3ms: 90
+    1.4ms: 39
+    1.5ms: 19
+    1.6ms: 16
+    1.7ms: 10
+    1.8ms: 7
     1.9ms: 4
-  117ms: 1
-  2ms: 24
-  3ms: 7
-  4ms: 2
-  82ms: 1
-  83ms: 1
-  84ms: 3
-  85ms: 2
-  86ms: 2
-  88ms: 3
-  89ms: 4
-  90ms: 2
+  2ms: 15
+  3ms: 10
+  4ms: 1
+  66ms: 1
+  86ms: 3
+  87ms: 4
+  89ms: 2
+  90ms: 3
   91ms: 2
+  92ms: 2
+  93ms: 1
+  94ms: 2
+  114ms: 1
 
 Done running benchmark report

data/lib/sanford/error_handler.rb

@@ -7,8 +7,9 @@ module Sanford
 
     attr_reader :exception, :host_data, :request
 
-    def initialize(exception, host_data, request = nil)
+    def initialize(exception, host_data = nil, request = nil)
       @exception, @host_data, @request = exception, host_data, request
+      @error_proc = @host_data ? @host_data.error_proc : proc{ }
     end
 
     # The exception that we are generating a response for can change in the case
@@ -19,7 +20,7 @@ module Sanford
 
     def run
       begin
-        result = @host_data.error_proc.call(@exception, @host_data, @request)
+        result = @error_proc.call(@exception, @host_data, @request)
       rescue Exception => proc_exception
         @exception = proc_exception
       end

data/lib/sanford/exceptions.rb

@@ -5,7 +5,6 @@ module Sanford
   NotFoundError = Class.new(RuntimeError)
 
   class NoHostError < BaseError
-    attr_reader :message
 
     def initialize(host_name)
       message = if Sanford.hosts.empty?

data/lib/sanford/host.rb

@@ -25,6 +25,7 @@ module Sanford
       option :logger,                     :default => proc{ Sanford::NullLogger.new }
       option :verbose_logging,            :default => true
       option :error_proc,       Proc,     :default => proc{ }
+      option :setup_proc,       Proc,     :default => proc{ }
 
       def initialize(host)
         self.name = host.class.to_s
@@ -75,6 +76,10 @@ module Sanford
       self.configuration.error_proc = block
     end
 
+    def setup(&block)
+      self.configuration.setup_proc = block
+    end
+
     def version(name, &block)
       version_group = Sanford::Host::VersionGroup.new(name, &block)
       @versioned_services.merge!(version_group.to_hash)

data/lib/sanford/host_data.rb

@@ -20,14 +20,21 @@ module Sanford
       @pid_dir            = configuration[:pid_dir]
       @logger, @verbose   = configuration[:logger], configuration[:verbose_logging]
       @error_proc         = configuration[:error_proc]
+      @setup_proc         = configuration[:setup_proc]
 
-      @handlers = service_host.versioned_services.inject({}) do |hash, (version, services)|
-        hash.merge({ version => self.constantize_services(services) })
-      end
+      @versioned_services = service_host.versioned_services
+      @handlers = {}
 
       raise Sanford::InvalidHostError.new(service_host) if !self.port
     end
 
+    def setup
+      @setup_proc.call
+      @handlers = @versioned_services.inject({}) do |hash, (version, services)|
+        hash.merge({ version => self.constantize_services(services) })
+      end
+    end
+
     def handler_class_for(version, service)
       version_group = @handlers[version] || {}
       version_group[service] || raise(Sanford::NotFoundError)

data/lib/sanford/manager.rb

@@ -19,18 +19,18 @@ module Sanford
       self.new(service_host, options).call(action)
     end
 
-    attr_reader :host, :process_name
+    attr_reader :host_data, :process_name
 
     def initialize(service_host, options = {})
-      @host = Sanford::HostData.new(service_host, options)
-      @process_name = [ self.host.ip, self.host.port, self.host.name ].join('_')
+      @host_data = Sanford::HostData.new(service_host, options)
+      @process_name = [ self.host_data.ip, self.host_data.port, self.host_data.name ].join('_')
     end
 
     def call(action)
       daemons_options = self.default_options.merge({ :ARGV => [ action.to_s ] })
       FileUtils.mkdir_p(daemons_options[:dir])
       ::Daemons.run_proc(self.process_name, daemons_options) do
-        server = Sanford::Server.new(self.host)
+        server = Sanford::Server.new(self.host_data)
         server.start
         server.join_thread
       end
@@ -40,7 +40,7 @@ module Sanford
 
     def default_options
       { :dir_mode   => :normal,
-        :dir        => self.host.pid_dir
+        :dir        => self.host_data.pid_dir
       }
     end
 

data/lib/sanford/rake.rb

@@ -6,11 +6,7 @@ module Sanford::Rake
     def self.load
       namespace :sanford do
 
-        # Overwrite this to load your application's environment so that it can
-        # be used with Sanford
-        task :setup
-
-        task :load_manager => :setup do
+        task :load_manager do
           require 'sanford'
           require 'sanford/manager'
           Sanford.init

data/lib/sanford/server.rb

@@ -13,6 +13,7 @@ module Sanford
 
     def initialize(host, options = {})
       @host_data = host.kind_of?(Sanford::HostData) ? host : Sanford::HostData.new(host)
+      @host_data.setup
       super(@host_data.ip, @host_data.port, options)
     end
 

data/lib/sanford/version.rb

@@ -1,3 +1,3 @@
 module Sanford
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/sanford/worker.rb

@@ -34,21 +34,42 @@ module Sanford
     protected
 
     def run!
-      request, handler_class, response, exception = nil, nil, nil, nil
+      service = ProcessedService.new
       begin
         request = Sanford::Protocol::Request.parse(@connection.read_data)
         self.log_request(request)
+        service.request = request
+
         handler_class = @host_data.handler_class_for(request.version, request.name)
         self.log_handler_class(handler_class)
+        service.handler_class = handler_class
+
         response = Sanford::Runner.new(handler_class, request, @host_data.logger).run
+        service.response = response
       rescue Exception => exception
-        error_handler = Sanford::ErrorHandler.new(exception, @host_data, request)
-        response = error_handler.run
-        self.log_exception(error_handler.exception)
+        self.handle_exception(service, exception, @host_data)
       ensure
-        @connection.write_data response.to_hash
+        self.write_response(service)
       end
-      ProcessedService.new(request, handler_class, response, exception)
+      service
+    end
+
+    def write_response(service)
+      begin
+        @connection.write_data service.response.to_hash
+      rescue Exception => exception
+        service = self.handle_exception(service, exception)
+        @connection.write_data service.response.to_hash
+      end
+      service
+    end
+
+    def handle_exception(service, exception, host_data = nil)
+      error_handler = Sanford::ErrorHandler.new(exception, host_data, service.request)
+      service.response  = error_handler.run
+      service.exception = error_handler.exception
+      self.log_exception(service.exception)
+      service
     end
 
     def raise_if_debugging!(exception)

data/test/support/fake_connection.rb

@@ -2,16 +2,21 @@ class FakeConnection
 
   attr_reader :read_data, :response
 
-  def self.with_request(version, name, params = {})
+  def self.with_request(version, name, params = {}, raise_on_write = false)
     request = Sanford::Protocol::Request.new(version, name, params)
-    self.new(request.to_hash)
+    self.new(request.to_hash, raise_on_write)
   end
 
-  def initialize(read_data)
+  def initialize(read_data, raise_on_write = false)
+    @raise_on_write = raise_on_write
     @read_data = read_data
   end
 
   def write_data(data)
+    if @raise_on_write
+      @raise_on_write = false
+      raise 'test fail'
+    end
     @response = Sanford::Protocol::Response.parse(data)
   end
 

data/test/support/services.rb

@@ -3,6 +3,12 @@ require 'logger'
 class TestHost
   include Sanford::Host
 
+  attr_accessor :setup_has_been_called
+
+  setup do
+    self.setup_has_been_called = true
+  end
+
   ip      'localhost'
   port    12000
   pid_dir File.expand_path('../../../tmp/', __FILE__)
@@ -107,6 +113,8 @@ end
 class UndefinedHandlersHost
   include Sanford::Host
 
+  port 12345
+
   version 'v1' do
     service 'undefined', 'ThisIsNotDefined'
   end

data/test/unit/host_data_test.rb

@@ -12,7 +12,7 @@ class Sanford::HostData
     subject{ @host_data }
 
     should have_instance_methods :name, :ip, :port, :pid_dir, :logger, :verbose,
-      :error_proc, :handler_class_for
+      :error_proc, :handler_class_for, :setup
 
     should "default it's configuration from the service host, but allow overrides" do
       host_data = Sanford::HostData.new(TestHost, :ip => '1.2.3.4', :port => 12345)
@@ -22,16 +22,6 @@ class Sanford::HostData
       assert_equal 12345,       host_data.port
     end
 
-    should "constantize a host's handlers" do
-      handlers = subject.instance_variable_get("@handlers")
-
-      assert_equal TestHost::Authorized,  handlers['v1']['authorized']
-      assert_equal TestHost::Bad,         handlers['v1']['bad']
-      assert_equal TestHost::Echo,        handlers['v1']['echo']
-      assert_equal TestHost::HaltIt,      handlers['v1']['halt_it']
-      assert_equal TestHost::Multiply,    handlers['v1']['multiply']
-    end
-
     should "ignore nil values passed as overrides" do
       host_data = Sanford::HostData.new(TestHost, :ip => nil)
 
@@ -44,7 +34,31 @@ class Sanford::HostData
       end
     end
 
-    should "look up handler classes with #handler_class_for" do
+  end
+
+  class SetupTest < BaseTest
+    desc "after calling setup"
+    setup do
+      TestHost.setup_has_been_called = false
+      @host_data.setup
+    end
+
+    should "have called the setup proc" do
+      assert_equal true, TestHost.setup_has_been_called
+
+      TestHost.setup_has_been_called = false
+    end
+
+    should "constantize a host's handlers" do
+      handlers = subject.instance_variable_get("@handlers")
+      assert_equal TestHost::Authorized,  handlers['v1']['authorized']
+      assert_equal TestHost::Bad,         handlers['v1']['bad']
+      assert_equal TestHost::Echo,        handlers['v1']['echo']
+      assert_equal TestHost::HaltIt,      handlers['v1']['halt_it']
+      assert_equal TestHost::Multiply,    handlers['v1']['multiply']
+    end
+
+        should "look up handler classes with #handler_class_for" do
       assert_equal TestHost::Echo, subject.handler_class_for('v1', 'echo')
     end
 
@@ -56,7 +70,7 @@ class Sanford::HostData
 
     should "raise a custom error when a service is configured with an undefined class" do
       assert_raises(Sanford::NoHandlerClassError) do
-        Sanford::HostData.new(UndefinedHandlersHost)
+        Sanford::HostData.new(UndefinedHandlersHost).setup
       end
     end
 

data/test/unit/host_test.rb

@@ -13,15 +13,13 @@ module Sanford::Host
     subject{ MyHost.instance }
 
     should have_instance_methods :configuration, :name, :ip, :port, :pid_dir, :logger,
-      :verbose_logging, :error, :version, :versioned_services
+      :verbose_logging, :error, :setup, :version, :versioned_services
 
     should "get and set it's configuration options with their matching methods" do
       subject.name 'my_awesome_host'
 
       assert_equal 'my_awesome_host',           subject.name
       assert_equal subject.configuration.port,  subject.port
-
-
     end
 
     should "add a version group with #version" do

data/test/unit/manager_test.rb

@@ -11,7 +11,7 @@ class Sanford::Manager
     end
     subject{ @manager }
 
-    should have_instance_methods :host, :process_name, :call
+    should have_instance_methods :host_data, :process_name, :call
     should have_class_methods :call
   end
 

data/test/unit/worker_test.rb

@@ -24,7 +24,7 @@ class Sanford::Worker
 
     desc "Sanford::Worker"
     setup do
-      @host_data = Sanford::HostData.new(TestHost)
+      @host_data = Sanford::HostData.new(TestHost).tap{|hd| hd.setup }
       @connection = FakeConnection.with_request('version', 'service', {})
       @worker = Sanford::Worker.new(@host_data, @connection)
     end
@@ -192,4 +192,22 @@ class Sanford::Worker
 
   end
 
+  class WithBadResponseHashTest < BaseTest
+    desc "running a request that builds an object that can't be encoded"
+    setup do
+      @connection = FakeConnection.with_request('v1', 'echo', { :message => 'cant encode' }, true)
+      @worker = Sanford::Worker.new(@host_data, @connection)
+    end
+
+    should "return the response that was halted" do
+      assert_raises(RuntimeError){ @worker.run }
+      response = @connection.response
+
+      assert_equal 500,                             response.status.code
+      assert_equal "An unexpected error occurred.", response.status.message
+      assert_equal nil,                             response.data
+    end
+
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-24 00:00:00 Z
+date: 2013-01-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false