sanford-protocol 0.4.1 → 0.5.0

data/README.md

@@ -82,6 +82,7 @@ This is the list of defined status codes.
 * `200` - `ok` - The request was successful.
 * `400` - `bad_request` - The request couldn't be read. This is usually because it was not formed correctly.
 * `404` - `not_found` - The server couldn't find something requested.
+* `408` - `timeout` - A client connected but didn't write a request before the server timeod out waiting for one.
 * `500` - `error` - The server errored responding to the request.
 
 In addition to these, a service can return custom status codes, but they should use a number greater than or equal to `600` to avoid collisions with Sanford's defined status codes.

data/lib/sanford-protocol/connection.rb

@@ -33,6 +33,10 @@ module Sanford::Protocol
       @socket.write(msg_version, size, body)
     end
 
+    def close
+      @socket.close
+    end
+
     private
 
     def wait_for_data(timeout)
@@ -59,6 +63,10 @@ module Sanford::Protocol
     def write(*binary_strings)
       tcp_socket.send(binary_strings.join, 0)
     end
+
+    def close
+      tcp_socket.close rescue false
+    end
   end
 
   class TimeoutError < RuntimeError

data/lib/sanford-protocol/request.rb

@@ -4,12 +4,21 @@
 
 module Sanford::Protocol
 
-  class Request < Struct.new(:version, :name, :params)
+  BadRequestError = Class.new(RuntimeError)
+
+  class Request
 
     def self.parse(body)
       self.new(body['version'], body['name'], body['params'])
     end
 
+    attr_reader :version, :name, :params
+
+    def initialize(version, name, params)
+      self.validate!(version, name, params)
+      @version, @name, @params = version, name, self.stringify(params)
+    end
+
     def to_hash
       { 'version' => version,
         'name'    => name,
@@ -19,18 +28,6 @@ module Sanford::Protocol
 
     def to_s; "[#{version}] #{name}"; end
 
-    def valid?
-      if !version
-        [ false, "The request doesn't contain a version." ]
-      elsif !name
-        [ false, "The request doesn't contain a name." ]
-      elsif !params.kind_of?(Hash)
-        [ false, "The request's params are not a valid BSON document." ]
-      else
-        [ true ]
-      end
-    end
-
     def inspect
       reference = '0x0%x' % (self.object_id << 1)
       "#<#{self.class}:#{reference}"\
@@ -39,6 +36,30 @@ module Sanford::Protocol
       " @params=#{params.inspect}>"
     end
 
+    protected
+
+    def validate!(version, name, params)
+      problem = if !version
+        "The request doesn't contain a version."
+      elsif !name
+        "The request doesn't contain a name."
+      elsif !params.kind_of?(Hash)
+        "The request's params are not a valid BSON document."
+      end
+      raise(BadRequestError, problem) if problem
+    end
+
+    def stringify(object)
+      case(object)
+      when Hash
+        object.inject({}){|h, (k, v)| h.merge({ k.to_s => self.stringify(v) }) }
+      when Array
+        object.map{|item| self.stringify(item) }
+      else
+        object
+      end
+    end
+
   end
 
 end

data/lib/sanford-protocol/response_status.rb

@@ -24,6 +24,7 @@ module Sanford::Protocol
         'ok'          => 200,
         'bad_request' => 400,
         'not_found'   => 404,
+        'timeout'     => 408,
         'error'       => 500
       }.freeze
 

data/lib/sanford-protocol/test/fake_socket.rb

@@ -47,5 +47,13 @@ module Sanford::Protocol::Test
       @out << bytes
     end
 
+    def close
+      @closed = true
+    end
+
+    def closed?
+      !!@closed
+    end
+
   end
 end

data/lib/sanford-protocol/version.rb

@@ -1,5 +1,5 @@
 module Sanford
   module Protocol
-    GEM_VERSION = "0.4.1"
+    GEM_VERSION = "0.5.0"
   end
 end

data/sanford-protocol.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("bson",        ["~>1.7"])
 
-  gem.add_development_dependency("assert",        ["~> 0.8"])
-  gem.add_development_dependency("assert-mocha",  ["~> 0.1"])
+  gem.add_development_dependency("assert",        ["~> 1.0"])
+  gem.add_development_dependency("assert-mocha",  ["~> 1.0"])
 end

data/test/unit/connection_tests.rb

@@ -12,7 +12,7 @@ class Sanford::Protocol::Connection
     end
     subject{ @connection }
 
-    should have_instance_methods :read, :write
+    should have_instance_methods :read, :write, :close
 
     should "read messages off the socket with #read" do
       assert_equal @data, subject.read
@@ -22,6 +22,11 @@ class Sanford::Protocol::Connection
       subject.write(@data)
       assert_equal @msg, @socket.out
     end
+
+    should "close the socket with #close" do
+      subject.close
+      assert @socket.closed?
+    end
   end
 
   class TimeoutTests < BaseTests

data/test/unit/request_tests.rb

@@ -10,13 +10,22 @@ class Sanford::Protocol::Request
     end
     subject{ @request }
 
-    should have_instance_methods :version, :name, :params, :to_hash, :valid?
+    should have_instance_methods :version, :name, :params, :to_hash
     should have_class_methods :parse
 
     should "return it's version and name with #to_s" do
       assert_equal "[#{subject.version}] #{subject.name}", subject.to_s
     end
 
+    should "stringify params keys" do
+      request = Sanford::Protocol::Request.new('v1', 'service', {
+        1       => 1,
+        :symbol => :symbol
+      })
+      expected = { "1" => 1, "symbol" => :symbol }
+      assert_equal expected, request.params
+    end
+
     should "return an instance of a Sanford::Protocol::Request given a hash using #parse" do
       # using BSON messages are hashes
       hash = {
@@ -45,38 +54,29 @@ class Sanford::Protocol::Request
   end
 
   class ValidTests < BaseTests
-    desc "valid?"
-
-    should "return true and no message with a valid request" do
-      request = Sanford::Protocol::Request.new('v1', 'name', {})
-      is_valid, message = request.valid?
 
-      assert_equal true, is_valid
-      assert_equal nil, message
+    should "not raise an exception with valid request args" do
+      assert_nothing_raised do
+        Sanford::Protocol::Request.new('v1', 'name', {})
+      end
     end
 
-    should "return false and a message when there isn't a name" do
-      request = Sanford::Protocol::Request.new('v1', nil, {})
-      is_valid, message = request.valid?
-
-      assert_equal false, is_valid
-      assert_equal "The request doesn't contain a name.", message
+    should "raise an exception when there isn't a name arg" do
+      assert_raises(Sanford::Protocol::BadRequestError) do
+        Sanford::Protocol::Request.new('v1', nil, {})
+      end
     end
 
     should "return false and a message when there isn't a version" do
-      request = Sanford::Protocol::Request.new(nil, 'name', {})
-      is_valid, message = request.valid?
-
-      assert_equal false, is_valid
-      assert_equal "The request doesn't contain a version.", message
+      assert_raises(Sanford::Protocol::BadRequestError) do
+        Sanford::Protocol::Request.new(nil, 'name', {})
+      end
     end
 
     should "return false and a message when the params are not a Hash" do
-      request = Sanford::Protocol::Request.new('v1', 'name', true)
-      is_valid, message = request.valid?
-
-      assert_equal false, is_valid
-      assert_equal "The request's params are not a valid BSON document.", message
+      assert_raises(Sanford::Protocol::BadRequestError) do
+        Sanford::Protocol::Request.new('v1', 'name', true)
+      end
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford-protocol
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-28 00:00:00 Z
+date: 2012-11-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -40,11 +40,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 15
         segments: 
+        - 1
         - 0
-        - 8
-        version: "0.8"
+        version: "1.0"
   requirement: *id002
   name: assert
   type: :development
@@ -55,11 +55,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 15
         segments: 
-        - 0
         - 1
-        version: "0.1"
+        - 0
+        version: "1.0"
   requirement: *id003
   name: assert-mocha
   type: :development