sanford 0.1.0

data/test/unit/host_test.rb

@@ -0,0 +1,142 @@
+require 'assert'
+
+module Sanford::Host
+
+  class BaseTest < Assert::Context
+    desc "Sanford::Host"
+    setup do
+      Test::Environment.store_and_clear_hosts
+      @host_class = Class.new do
+        include Sanford::Host
+        name  'anonymous_host'
+        ip    'anonymous.local'
+      end
+      @host = @host_class.new({ :port => 12345 })
+    end
+    teardown do
+      Test::Environment.restore_hosts
+    end
+    subject{ @host }
+
+    should have_instance_methods :name, :config, :run
+
+    should "set name to it's class #name" do
+      assert_equal subject.class.name, subject.name
+    end
+
+    should "proxy missing methods to it's config" do
+      assert_equal subject.config.port, subject.port
+      assert subject.respond_to?(:pid_dir)
+    end
+
+    should "default it's configuration from the class and overwrite with values passed to new" do
+      assert_equal 'anonymous.local', subject.config.ip
+      assert_equal 12345, subject.config.port
+    end
+  end
+
+  class ConfigTest < BaseTest
+    desc "config"
+    setup do
+      @config = @host.config
+    end
+    subject{ @config }
+
+    should have_instance_methods :name, :ip, :port, :pid_dir, :logger
+  end
+
+  class ClassMethodsTest < BaseTest
+    desc "class methods"
+    subject{ @host_class }
+
+    should have_instance_methods :config, :version
+    should have_instance_methods :name, :ip, :port, :pid_dir, :logger
+
+    should "have registered the class with sanford's known hosts" do
+      assert_includes subject, Sanford.config.hosts
+    end
+  end
+
+  class InvalidTest < BaseTest
+    desc "invalid configuration"
+    setup do
+      @host_class = Class.new do
+        include Sanford::Host
+        name 'invalid_host'
+      end
+    end
+
+    should "raise a custom exception" do
+      assert_raises(Sanford::InvalidHostError) do
+        @host_class.new
+      end
+    end
+  end
+
+  class VersionTest < BaseTest
+    desc "version class method"
+    setup do
+      @host_class.version('v1'){ }
+    end
+
+    should "have added a version hash to the versioned_services config" do
+      assert_equal({}, @host_class.config.versioned_services["v1"])
+    end
+  end
+
+  class RunTest < BaseTest
+    desc "run method"
+    setup do
+      @host_class.version('v1') do
+        service 'test', 'DummyHost::Multiply'
+      end
+      @host = @host_class.new({ :port => 12000 })
+      @request = Sanford::Protocol::Request.new('v1', 'test', { 'number' => 2 })
+      @returned = @host.run(@request)
+    end
+    subject{ @returned }
+
+    should "have returned the data of calling the `init` and `run` method of the handler" do
+      expected_status_code = 200
+      expected_data = 2 * @request.params['number']
+
+      assert_equal expected_status_code, subject.first
+      assert_equal expected_data, subject.last
+    end
+  end
+
+  class RunNotFoundTest < BaseTest
+    desc "run method with a service and no matching service handler"
+    setup do
+      @host_class.version('v1') do
+        service 'test', 'DummyHost::Echo'
+      end
+      @host = @host_class.new({ :port => 12000 })
+      @request = Sanford::Protocol::Request.new('v4', 'what', {})
+    end
+
+    should "raise a Sanford::NotFound exception" do
+      assert_raises(Sanford::NotFoundError) do
+        @host.run(@request)
+      end
+    end
+  end
+
+  class RunNoHandlerClassTest < BaseTest
+    desc "run method with a service handler that doesn't exist"
+    setup do
+      @host_class.version('v1') do
+        service 'test', 'DoesntExist::AtAll'
+      end
+      @host = @host_class.new({ :port => 12000 })
+      @request = Sanford::Protocol::Request.new('v1', 'test', {})
+    end
+
+    should "raise a Sanford::NoHandlerClass exception" do
+      assert_raises(Sanford::NoHandlerClassError) do
+        @host.run(@request)
+      end
+    end
+  end
+
+end

data/test/unit/manager_test.rb

@@ -0,0 +1,21 @@
+require 'assert'
+require 'ostruct'
+
+class Sanford::Manager
+
+  class BaseTest < Assert::Context
+    desc "Sanford::Manager"
+    setup do
+      @dummy_host = DummyHost
+      @manager = Sanford::Manager.new(@dummy_host)
+    end
+    subject{ @manager }
+
+    should have_instance_methods :host, :process_name, :call
+    should have_class_methods :call
+  end
+
+  # Sanford::Manager#call methods are tested in the test/system/managing_test.rb
+  # they require mocking the Daemons gem
+
+end

data/test/unit/server_test.rb

@@ -0,0 +1,22 @@
+require 'assert'
+
+class Sanford::Server
+
+  class BaseTest < Assert::Context
+    desc "Sanford::Server"
+    setup do
+      @service_host = DummyHost.new
+      @server = Sanford::Server.new(@service_host)
+    end
+    subject{ @server }
+
+    should "include DatTCP::Server" do
+      assert_includes DatTCP::Server, subject.class.included_modules
+    end
+  end
+
+  # Sanford::Server#serve is tested in test/system/request_handling_test.rb,
+  # it requires multiple parts of Sanford and basically tests a large portion of
+  # the entire system
+
+end

data/test/unit/service_handler_test.rb

@@ -0,0 +1,170 @@
+require 'assert'
+
+module Sanford::ServiceHandler
+
+  class BaseTest < Assert::Context
+    desc "Sanford::ServiceHandler"
+    setup do
+      @handler = StaticServiceHandler.new
+    end
+    subject{ @handler }
+
+    should have_instance_methods :logger, :request, :init, :init!, :run, :run!, :halt, :params
+
+    should "raise a NotImplementedError if run! is not overwritten" do
+      assert_raises(NotImplementedError){ subject.run! }
+    end
+    should "return the request's params with #params" do
+      assert_equal subject.request.params, subject.params
+    end
+  end
+
+  class WithMethodFlagsTest < BaseTest
+    setup do
+      @handler = FlaggedServiceHandler.new
+    end
+
+    should "should call the `init!` method when `init` is called" do
+      subject.init
+
+      assert_equal true, subject.init_bang_called
+    end
+    should "run the `init` and `run!` method when `run` is called" do
+      subject.run
+
+      assert_equal true, subject.init_called
+      assert_equal true, subject.run_bang_called
+    end
+    should "run it's callbacks when `run` is called" do
+      subject.run
+
+      assert_equal true, subject.before_run_called
+      assert_equal true, subject.after_run_called
+    end
+  end
+
+  class ManualWithThrowTest < BaseTest
+    desc "run that manuallly throws `:halt`"
+    setup do
+      handler = ManualThrowServiceHandler.new
+      @returned = handler.run
+    end
+
+    should "catch `:halt` and return what was thrown" do
+      assert_equal 'halted!', @returned
+    end
+  end
+
+  class HaltWithAStatusNameAndMessageTest < BaseTest
+    desc "halt with a status name and a message"
+    setup do
+      @halt_with = { :code => :success, :message => "Just a test" }
+      handler = HaltWithServiceHandler.new(@halt_with)
+      @response_status, @data = handler.run
+    end
+
+    should "return a response with the status passed to halt and a nil data" do
+      assert_equal @halt_with[:code],     @response_status.first
+      assert_equal @halt_with[:message],  @response_status.last
+      assert_equal @halt_with[:data],     @data
+    end
+  end
+
+  class HaltWithAStatusCodeAndDataTest < BaseTest
+    desc "halt with a status code and data"
+    setup do
+      @halt_with = { :code => 648, :data => true }
+      handler = HaltWithServiceHandler.new(@halt_with)
+      @response_status, @data = handler.run
+    end
+
+    should "return a response status and data when passed a number and a data option" do
+      assert_equal @halt_with[:code],     @response_status.first
+      assert_equal @halt_with[:message],  @response_status.last
+      assert_equal @halt_with[:data],     @data
+    end
+  end
+
+  class BeforeRunHaltsTest < BaseTest
+    desc "if 'before_run' halts"
+    setup do
+      @handler = ConfigurableServiceHandler.new({
+        :before_run => proc{ halt 601, :message => "before_run halted" }
+      })
+      @response_status, @data = @handler.run
+    end
+
+    should "only call 'before_run' and 'after_run'" do
+      assert_equal true,  subject.before_run_called
+      assert_equal false, subject.init_called
+      assert_equal false, subject.init_bang_called
+      assert_equal false, subject.run_bang_called
+      assert_equal true,  subject.after_run_called
+    end
+
+    should "return the 'before_run' response" do
+      assert_equal 601,                 @response_status.first
+      assert_equal "before_run halted", @response_status.last
+      assert_equal nil,                 @data
+    end
+  end
+
+  class AfterRunHaltsTest < BaseTest
+    desc "if 'after_run' halts"
+    setup do
+      @after_run = proc{ halt 801, :message => "after_run halted" }
+    end
+
+  end
+
+  class AndBeforeRunHaltsTest < AfterRunHaltsTest
+      desc "and 'before_run' halts"
+      setup do
+        @handler = ConfigurableServiceHandler.new({
+          :before_run => proc{ halt 601, :message => "before_run halted" },
+          :after_run  => @after_run
+        })
+        @response_status, @data = @handler.run
+      end
+
+      should "only call 'before_run' and 'after_run'" do
+        assert_equal true,  subject.before_run_called
+        assert_equal false, subject.init_called
+        assert_equal false, subject.init_bang_called
+        assert_equal false, subject.run_bang_called
+        assert_equal true,  subject.after_run_called
+      end
+
+      should "return the 'after_run' response" do
+        assert_equal 801,                 @response_status.first
+        assert_equal "after_run halted",  @response_status.last
+        assert_equal nil,                 @data
+      end
+    end
+
+    class AndRunBangHaltsTest < AfterRunHaltsTest
+      desc "and 'run!' halts"
+      setup do
+        @handler = ConfigurableServiceHandler.new({
+          :run!       => proc{ halt 601, :message => "run! halted" },
+          :after_run  => @after_run
+        })
+        @response_status, @data = @handler.run
+      end
+
+      should "call 'init!', 'run!' and the callbacks" do
+        assert_equal true,  subject.before_run_called
+        assert_equal true,  subject.init_called
+        assert_equal true,  subject.init_bang_called
+        assert_equal true,  subject.run_bang_called
+        assert_equal true,  subject.after_run_called
+      end
+
+      should "return the 'after_run' response" do
+        assert_equal 801,                 @response_status.first
+        assert_equal "after_run halted",  @response_status.last
+        assert_equal nil,                 @data
+      end
+    end
+
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification 
+name: sanford
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Collin Redding
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  requirement: *id001
+  name: daemons
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  requirement: *id002
+  name: dat-tcp
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+  name: ns-options
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  requirement: *id004
+  name: sanford-protocol
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id005
+  name: assert
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id006
+  name: assert-mocha
+  type: :development
+description: Simple hosts for Sanford services.
+email: 
+- collin.redding@me.com
+- kelly@kellyredding.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bench/client.rb
+- bench/report.txt
+- bench/runner.rb
+- bench/services.rb
+- bench/tasks.rb
+- lib/sanford.rb
+- lib/sanford/config.rb
+- lib/sanford/connection.rb
+- lib/sanford/exception_handler.rb
+- lib/sanford/exceptions.rb
+- lib/sanford/host.rb
+- lib/sanford/manager.rb
+- lib/sanford/rake.rb
+- lib/sanford/server.rb
+- lib/sanford/service_handler.rb
+- lib/sanford/version.rb
+- log/.gitkeep
+- sanford.gemspec
+- test/helper.rb
+- test/support/helpers.rb
+- test/support/service_handlers.rb
+- test/support/services.rb
+- test/support/simple_client.rb
+- test/system/managing_test.rb
+- test/system/request_handling_test.rb
+- test/unit/config_test.rb
+- test/unit/connection_test.rb
+- test/unit/exception_handler_test.rb
+- test/unit/host/version_group_test.rb
+- test/unit/host_test.rb
+- test/unit/manager_test.rb
+- test/unit/server_test.rb
+- test/unit/service_handler_test.rb
+homepage: https://github.com/redding/sanford
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple hosts for Sanford services.
+test_files: 
+- test/helper.rb
+- test/support/helpers.rb
+- test/support/service_handlers.rb
+- test/support/services.rb
+- test/support/simple_client.rb
+- test/system/managing_test.rb
+- test/system/request_handling_test.rb
+- test/unit/config_test.rb
+- test/unit/connection_test.rb
+- test/unit/exception_handler_test.rb
+- test/unit/host/version_group_test.rb
+- test/unit/host_test.rb
+- test/unit/manager_test.rb
+- test/unit/server_test.rb
+- test/unit/service_handler_test.rb