sanford-protocol 0.4.0 → 0.4.1

data/README.md

@@ -33,20 +33,20 @@ A request is made up of 3 required parts: the version, the name, and the params.
 
 * **version** - (string) version of the requested API.
 * **name**    - (string) name of the requested API service.
-* **params**  - (object) data for the service call - can be any BSON serializable object.
+* **params**  - (document) data for the service call - must be a BSON document (ruby Hash, python dict, Javascript Object).
 
 Requests are encoded as BSON hashes when transmitted in messages.
 
 ```ruby
-{ 'version': 'v1',
-  'name':    'some_service',
-  'params':  'something'
+{ 'version' => 'v1',
+  'name'    => 'some_service',
+  'params'  => { 'key' => 'value' }
 }
 
 request = Sanford::Protocol::Request.parse(a_bson_request_hash)
 request.version  #=> "v1"
 request.name     #=> "some_service"
-request.params   #=> "something"
+request.params   #=> { 'key' => 'value' }
 request.to_s     #=> "[v1] some_service"
 ```
 
@@ -60,8 +60,8 @@ A response is made up of 2 parts: the status and the data.
 Responses are encoded as BSON hashes when transmitted in messages.
 
 ```ruby
-{ 'status': [ 200, 'The request was successful.' ]
-  'data':   true
+{ 'status'  => [ 200, 'The request was successful.' ]
+  'data'    => true
 }
 
 response = Sanford::Protocol::Response.parse(a_bson_response_hash)
@@ -108,7 +108,7 @@ incoming_data = connection.read
 connection.write(outgoing_data)
 ```
 
-For incoming messages, it reads them off the socket, validate them, and return the decoded body data.  For outgoing messages, it encodes the message body from given data, adds the appropiate message headers, and writes the message to the socket.
+For incoming messages, it reads them off the socket, validates them, and returns the decoded body data.  For outgoing messages, it encodes the message body from given data, adds the appropiate message headers, and writes the message to the socket.
 
 #### Timeout
 

data/lib/sanford-protocol/request.rb

@@ -24,6 +24,8 @@ module Sanford::Protocol
         [ 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

data/lib/sanford-protocol/version.rb

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

data/test/unit/request_tests.rb

@@ -6,7 +6,7 @@ class Sanford::Protocol::Request
   class BaseTests < Assert::Context
     desc "Sanford::Protocol::Request"
     setup do
-      @request = Sanford::Protocol::Request.new('v1', 'some_service', [ true ])
+      @request = Sanford::Protocol::Request.new('v1', 'some_service', { 'key' => 'value' })
     end
     subject{ @request }
 
@@ -22,7 +22,7 @@ class Sanford::Protocol::Request
       hash = {
         'name'    => 'service_name',
         'version' => 'service_version',
-        'params'  => 'service_params'
+        'params'  => { 'service_params' => 'yes' }
       }
       request = Sanford::Protocol::Request.parse(hash)
 
@@ -37,7 +37,7 @@ class Sanford::Protocol::Request
       expected = {
         'version' => 'v1',
         'name'    => 'some_service',
-        'params'  => [ true ]
+        'params'  => { 'key' => 'value' }
       }
 
       assert_equal expected, subject.to_hash
@@ -48,7 +48,7 @@ class Sanford::Protocol::Request
     desc "valid?"
 
     should "return true and no message with a valid request" do
-      request = Sanford::Protocol::Request.new('name', 'v1', {})
+      request = Sanford::Protocol::Request.new('v1', 'name', {})
       is_valid, message = request.valid?
 
       assert_equal true, is_valid
@@ -70,6 +70,14 @@ class Sanford::Protocol::Request
       assert_equal false, is_valid
       assert_equal "The request doesn't contain a version.", message
     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
+    end
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford-protocol
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,10 +16,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-15 00:00:00 Z
+date: 2012-11-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bson
+  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +30,11 @@ dependencies:
         - 1
         - 7
         version: "1.7"
-  type: :runtime
   requirement: *id001
-  prerelease: false
+  name: bson
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: assert
+  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,11 +45,11 @@ dependencies:
         - 0
         - 8
         version: "0.8"
-  type: :development
   requirement: *id002
-  prerelease: false
+  name: assert
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: assert-mocha
+  prerelease: false
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -60,9 +60,9 @@ dependencies:
         - 0
         - 1
         version: "0.1"
-  type: :development
   requirement: *id003
-  prerelease: false
+  name: assert-mocha
+  type: :development
 description: Ruby implementation of Sanford's communication protocol.
 email: 
 - collin.redding@me.com
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby implementation of Sanford's communication protocol.