sanford-protocol 0.2.0 → 0.3.0

data/README.md

@@ -42,6 +42,12 @@ Requests are encoded as BSON hashes when transmitted in messages.
   'name':    'some_service',
   'params':  'something'
 }
+
+request = Sanford::Protocol::Request.parse(a_bson_request_hash)
+request.version  #=> "v1"
+request.name     #=> "some_service"
+request.params   #=> "something"
+request.to_s     #=> "[v1] some_service"
 ```
 
 ## Response
@@ -57,6 +63,16 @@ Responses are encoded as BSON hashes when transmitted in messages.
 { 'status': [ 200, 'The request was successful.' ]
   'data':   true
 }
+
+response = Sanford::Protocol::Response.parse(a_bson_response_hash)
+response.status.code    #=> 200
+response.status.to_i    #=> 200
+response.status.name    #=> "OK"
+response.status.message #=> "The request was successful."
+response.status.to_s    #=> "[200, OK]"
+response.code           #=> 200
+response.to_s           #=> "[200, OK]"
+response.data           #=> true
 ```
 
 ### Status Codes

data/lib/sanford-protocol/request.rb

@@ -17,6 +17,8 @@ module Sanford::Protocol
       }
     end
 
+    def to_s; "[#{version}] #{name}"; end
+
     def valid?
       if !version
         [ false, "The request doesn't contain a version." ]

data/lib/sanford-protocol/response.rb

@@ -16,6 +16,9 @@ module Sanford::Protocol
       super(build_status(status), data)
     end
 
+    def code; status.code; end
+    def to_s; status.to_s; end
+
     def to_hash
       { 'status' => [ status.code, status.message ],
         'data'   => data
@@ -24,9 +27,7 @@ module Sanford::Protocol
 
     def inspect
       reference = '0x0%x' % (self.object_id << 1)
-      "#<#{self.class}:#{reference}"\
-      " @status=#{status.inspect}"\
-      " @data=#{data.inspect}>"
+      "#<#{self.class}:#{reference} @status=#{status} @data=#{data.inspect}>"
     end
 
     private

data/lib/sanford-protocol/response_status.rb

@@ -9,14 +9,14 @@ module Sanford::Protocol
     end
 
     def code; code_obj.number; end
+    alias_method :to_i, :code
+
     def name; code_obj.name;   end
     def to_s; code_obj.to_s;   end
 
     def inspect
       reference = '0x0%x' % (self.object_id << 1)
-      "#<#{self.class}:#{reference}"\
-      " @code=#{code_obj}"\
-      " @message=#{message.inspect}>"
+      "#<#{self.class}:#{reference} @code=#{code_obj} @message=#{message.inspect}>"
     end
 
     class Code < Struct.new(:number, :name)

data/lib/sanford-protocol/version.rb

@@ -1,5 +1,5 @@
 module Sanford
   module Protocol
-    GEM_VERSION = "0.2.0"
+    GEM_VERSION = "0.3.0"
   end
 end

data/test/unit/request_tests.rb

@@ -13,6 +13,10 @@ class Sanford::Protocol::Request
     should have_instance_methods :version, :name, :params, :to_hash, :valid?
     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 "return an instance of a Sanford::Protocol::Request given a hash using #parse" do
       # using BSON messages are hashes
       hash = {

data/test/unit/response_status_tests.rb

@@ -11,7 +11,7 @@ class Sanford::Protocol::ResponseStatus
     subject{ @status }
 
     should have_readers :code_obj, :message
-    should have_instance_methods :code, :name
+    should have_instance_methods :code, :name, :to_i
 
     should "know it's code name" do
       named  = Sanford::Protocol::ResponseStatus.new(200)
@@ -21,7 +21,7 @@ class Sanford::Protocol::ResponseStatus
       assert_equal nil,  unamed.name
     end
 
-    should "know it's code numbers" do
+    should "know it's code number" do
       Code::NUMBERS.each do |name, value|
         status = Sanford::Protocol::ResponseStatus.new(name)
         assert_equal value, status.code
@@ -31,6 +31,10 @@ class Sanford::Protocol::ResponseStatus
       assert_equal 0, unamed.code
     end
 
+    should "return it's code number with #to_i" do
+      assert_equal subject.code, subject.to_i
+    end
+
     should "return it's code number and code name with #to_s" do
       named  = Sanford::Protocol::ResponseStatus.new(200)
       unamed = Sanford::Protocol::ResponseStatus.new(999)

data/test/unit/response_tests.rb

@@ -10,9 +10,17 @@ class Sanford::Protocol::Response
     end
     subject{ @response }
 
-    should have_instance_methods :status, :data, :to_hash
+    should have_instance_methods :status, :code, :data, :to_hash, :to_s
     should have_class_methods :parse
 
+    should "return its status#code with #code" do
+      assert_equal subject.status.code, subject.code
+    end
+
+    should "return its status#to_s with #to_s" do
+      assert_equal subject.status.to_s, subject.to_s
+    end
+
     should "return an instance of a Sanford::Protocol::Response given a hash using #parse" do
       # using BSON messages are hashes
       hash = {
@@ -36,6 +44,7 @@ class Sanford::Protocol::Response
 
       assert_equal expected, subject.to_hash
     end
+
   end
 
   # Somewhat of a system test, want to make sure if Response is passed some

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford-protocol
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -19,7 +19,7 @@ cert_chain: []
 date: 2012-11-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
+  name: bson
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +30,11 @@ dependencies:
         - 1
         - 7
         version: "1.7"
-  requirement: *id001
-  name: bson
   type: :runtime
-- !ruby/object:Gem::Dependency 
+  requirement: *id001
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: assert
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,11 +45,11 @@ dependencies:
         - 0
         - 8
         version: "0.8"
-  requirement: *id002
-  name: assert
   type: :development
-- !ruby/object:Gem::Dependency 
+  requirement: *id002
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: assert-mocha
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -60,9 +60,9 @@ dependencies:
         - 0
         - 1
         version: "0.1"
-  requirement: *id003
-  name: assert-mocha
   type: :development
+  requirement: *id003
+  prerelease: false
 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.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby implementation of Sanford's communication protocol.