sanford-protocol 0.1.0 → 0.2.0

data/README.md

@@ -46,16 +46,16 @@ Requests are encoded as BSON hashes when transmitted in messages.
 
 ## Response
 
-A response is made up of 2 parts: the status and the result.
+A response is made up of 2 parts: the status and the data.
 
 * **status** - (tuple, required) A code and message describing the result of the service call.
-* **result** - (object, optional) Result of calling the service. This can be any BSON serializable object.  Typically won't be set if the request is not successful.
+* **data** - (object, optional) Return value of the service call. This can be any BSON serializable object.  Typically won't be set if the request is not successful.
 
 Responses are encoded as BSON hashes when transmitted in messages.
 
 ```ruby
 { 'status': [ 200, 'The request was successful.' ]
-  'result': true
+  'data':   true
 }
 ```
 
@@ -104,7 +104,7 @@ Request and response objects have helpers for sending and receiving data using a
 data_hash = server_connection.read
 incoming_request = Sanford::Protocol::Request.parse(data_hash)
 # use Response#to_hash to send a response
-outgoing_response = Sanford::Protocol::Response.new(status, result)
+outgoing_response = Sanford::Protocol::Response.new(status, data)
 server_connection.write(outgoing_response.to_hash)
 
 # For a client...

data/lib/sanford-protocol.rb

@@ -1,3 +1,5 @@
+module Sanford; end
+
 require 'sanford-protocol/connection'
 require 'sanford-protocol/request'
 require 'sanford-protocol/response'

data/lib/sanford-protocol/request.rb

@@ -1,34 +1,26 @@
 # The Request class models a specific type of Sanford message body and provides
 # a defined structure for it. A request requires a message body to contain a
-# version, name and params. It provides methods for working with message bodies
-# (hashes) with `parse` and `to_hash`. In addition to this, a request has a
-# `valid?` method, that returns whether it is valid and if it isn't why.
+# version, name and params.
 
 module Sanford::Protocol
 
-  class Request
+  class Request < Struct.new(:version, :name, :params)
 
     def self.parse(body)
       self.new(body['version'], body['name'], body['params'])
     end
 
-    attr_reader :version, :name, :params
-
-    def initialize(version, name, params)
-      @version, @name, @params = version, name, params
-    end
-
     def to_hash
-      { 'version' => @version,
-        'name'    => @name,
-        'params'  => @params
+      { 'version' => version,
+        'name'    => name,
+        'params'  => params
       }
     end
 
     def valid?
-      if !@version
+      if !version
         [ false, "The request doesn't contain a version." ]
-      elsif !@name
+      elsif !name
         [ false, "The request doesn't contain a name." ]
       else
         [ true ]
@@ -38,9 +30,9 @@ module Sanford::Protocol
     def inspect
       reference = '0x0%x' % (self.object_id << 1)
       "#<#{self.class}:#{reference}"\
-      " @version=#{@version.inspect}"\
-      " @name=#{@name.inspect}"\
-      " @params=#{@params.inspect}>"
+      " @version=#{version.inspect}"\
+      " @name=#{name.inspect}"\
+      " @params=#{params.inspect}>"
     end
 
   end

data/lib/sanford-protocol/response.rb

@@ -2,41 +2,37 @@ require 'sanford-protocol/response_status'
 
 # The Response class models a specific type of Sanford message body and provides
 # a defined structure for it. A response requires a message body to contain a
-# status (which is a code and optional message) and a result. It provides
-# methods for working with message bodies (hashes) with `parse` and `to_hash`.
+# status and some data.
 
 module Sanford::Protocol
 
-  class Response
+  class Response < Struct.new(:status, :data)
 
     def self.parse(hash)
-      self.new(hash['status'], hash['result'])
+      self.new(hash['status'], hash['data'])
     end
 
-    attr_reader :status, :result
-
-    def initialize(status, result = nil)
-      @status, @result = build_status(status), result
+    def initialize(status, data=nil)
+      super(build_status(status), data)
     end
 
     def to_hash
-      { 'status'  => [ @status.code, @status.message ],
-        'result'  => @result
+      { 'status' => [ status.code, status.message ],
+        'data'   => data
       }
     end
 
     def inspect
       reference = '0x0%x' % (self.object_id << 1)
       "#<#{self.class}:#{reference}"\
-      " @status=#{@status.inspect}"\
-      " @result=#{@result.inspect}>"
+      " @status=#{status.inspect}"\
+      " @data=#{data.inspect}>"
     end
 
     private
 
     def build_status(status)
       return status if status.kind_of?(ResponseStatus)
-
       ResponseStatus.new(*status)
     end
 

data/lib/sanford-protocol/version.rb

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

data/sanford-protocol.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["collin.redding@me.com", "kelly@kellyredding.com"]
   gem.description   = "Ruby implementation of Sanford's communication protocol."
   gem.summary       = "Ruby implementation of Sanford's communication protocol."
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/redding/sanford-protocol"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/test/unit/request_tests.rb

@@ -10,7 +10,7 @@ class Sanford::Protocol::Request
     end
     subject{ @request }
 
-    should have_instance_methods :name, :version, :params, :to_hash, :valid?
+    should have_instance_methods :version, :name, :params, :to_hash, :valid?
     should have_class_methods :parse
 
     should "return an instance of a Sanford::Protocol::Request given a hash using #parse" do

data/test/unit/response_tests.rb

@@ -10,28 +10,28 @@ class Sanford::Protocol::Response
     end
     subject{ @response }
 
-    should have_instance_methods :status, :result, :to_hash
+    should have_instance_methods :status, :data, :to_hash
     should have_class_methods :parse
 
     should "return an instance of a Sanford::Protocol::Response given a hash using #parse" do
       # using BSON messages are hashes
       hash = {
-        'status'  => [ 200, 'OK' ],
-        'result'  => 'yes'
+        'status' => [ 200, 'OK' ],
+        'data'   => 'yes'
       }
       request = Sanford::Protocol::Response.parse(hash)
 
       assert_instance_of Sanford::Protocol::Response, request
-      assert_equal hash['status'].first,   request.status.code
-      assert_equal hash['status'].last,    request.status.message
-      assert_equal hash['result'],         request.result
+      assert_equal hash['status'].first, request.status.code
+      assert_equal hash['status'].last,  request.status.message
+      assert_equal hash['data'],         request.data
     end
 
     should "return the request as a hash with #to_hash" do
       # using BSON messages are hashes
       expected = {
-        'status'  => [ 672, 'YAR!' ],
-        'result'  => { 'something' => true }
+        'status' => [ 672, 'YAR!' ],
+        'data'   => { 'something' => true }
       }
 
       assert_equal expected, subject.to_hash

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford-protocol
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,10 +16,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-14 00:00:00 Z
+date: 2012-11-15 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
@@ -98,7 +98,7 @@ files:
 - test/unit/response_status_tests.rb
 - test/unit/response_tests.rb
 - test/unit/test_helpers_tests.rb
-homepage: ""
+homepage: https://github.com/redding/sanford-protocol
 licenses: []
 
 post_install_message: 
@@ -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.