sanford-protocol 0.8.0 → 0.9.0

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'pry'
+gem 'pry', "~> 0.9.0"
 
 gem 'bson_ext', '~>1.7'

data/lib/sanford-protocol/fake_connection.rb

@@ -0,0 +1,46 @@
+module Sanford; end
+module Sanford::Protocol
+
+  class FakeConnection
+
+    attr_accessor :read_data, :peek_data, :write_data
+    attr_accessor :closed, :closed_write
+    attr_reader :read_timeout, :peek_timeout
+
+    def initialize(read_data = nil)
+      @read_data  = read_data || ""
+      @peek_data  = read_data ? read_data[1] : ""
+      @write_data = nil
+
+      @read_timeout = nil
+      @peek_timeout = nil
+
+      @closed = false
+      @closed_write = false
+    end
+
+    def read(timeout = nil)
+      @read_timeout = timeout
+      @read_data
+    end
+
+    def write(data)
+      @write_data = data
+    end
+
+    def peek(timeout = nil)
+      @peek_timeout = timeout
+      @peek_data
+    end
+
+    def close
+      @closed = true
+    end
+
+    def close_write
+      @closed_write = true
+    end
+
+  end
+
+end

data/lib/sanford-protocol/request.rb

@@ -35,6 +35,14 @@ module Sanford::Protocol
       " @params=#{params.inspect}>"
     end
 
+    def ==(other)
+      if other.kind_of?(self.class)
+        self.to_hash == other.to_hash
+      else
+        super
+      end
+    end
+
     protected
 
     def validate!(name, params)

data/lib/sanford-protocol/response.rb

@@ -31,6 +31,14 @@ module Sanford::Protocol
       "#<#{self.class}:#{reference} @status=#{status} @data=#{data.inspect}>"
     end
 
+    def ==(other)
+      if other.kind_of?(self.class)
+        self.to_hash == other.to_hash
+      else
+        super
+      end
+    end
+
     private
 
     def build_status(status)

data/lib/sanford-protocol/version.rb

@@ -1,5 +1,5 @@
 module Sanford
   module Protocol
-    GEM_VERSION = "0.8.0"
+    GEM_VERSION = "0.9.0"
   end
 end

data/sanford-protocol.gemspec

@@ -19,6 +19,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("bson", ["~> 1.7", "< 1.10.0"])
 
-  gem.add_development_dependency("assert",       ["~> 2.10"])
-  gem.add_development_dependency("assert-mocha", ["~> 1.1"])
+  gem.add_development_dependency("assert", ["~> 2.11"])
 end

data/test/helper.rb

@@ -12,7 +12,7 @@ ENV['SANFORD_PROTOCOL_DEBUG'] = 'yes'
 require 'sanford-protocol/fake_socket'
 FakeSocket = Sanford::Protocol::FakeSocket
 
-require 'assert-mocha' if defined?(Assert)
+require 'test/support/factory'
 
 class Assert::Context
 

data/test/support/factory.rb

@@ -0,0 +1,6 @@
+require 'assert/factory'
+
+module Factory
+  extend Assert::Factory
+
+end

data/test/unit/fake_connection_tests.rb

@@ -0,0 +1,80 @@
+require 'assert'
+require 'sanford-protocol/fake_connection'
+
+class Sanford::Protocol::FakeConnection
+
+  class UnitTests < Assert::Context
+    desc "Sanford::Protocol::FakeConnection"
+    setup do
+      @read_data = Factory.binary
+      @fake_connection = Sanford::Protocol::FakeConnection.new(@read_data)
+    end
+    subject{ @fake_connection }
+
+    should have_accessors :read_data, :peek_data, :write_data
+    should have_accessors :closed, :closed_write
+    should have_readers :read_timeout, :peek_timeout
+    should have_imeths :read, :write, :peek, :close, :close_write
+
+    should "know its read data and peek data" do
+      assert_equal @read_data, subject.read_data
+      assert_equal @read_data[1], subject.peek_data
+    end
+
+    should "default its attributes" do
+      fake_connection = Sanford::Protocol::FakeConnection.new
+      assert_equal "", fake_connection.read_data
+      assert_equal "", fake_connection.peek_data
+      assert_nil fake_connection.write_data
+      assert_false fake_connection.closed
+      assert_false fake_connection.closed_write
+      assert_nil fake_connection.read_timeout
+      assert_nil fake_connection.peek_timeout
+    end
+
+    should "allow reading the read data using `read`" do
+      assert_nil subject.read_timeout
+      result = subject.read
+      assert_equal subject.read_data, result
+      assert_nil subject.read_timeout
+
+      timeout = Factory.integer
+      assert_nil subject.read_timeout
+      result = subject.read(timeout)
+      assert_equal timeout, subject.read_timeout
+    end
+
+    should "allow writing to the write data using `write`" do
+      data = Factory.boolean
+      assert_nil subject.write_data
+      subject.write(data)
+      assert_equal data, subject.write_data
+    end
+
+    should "allow reading the peek data using `peek`" do
+      assert_nil subject.peek_timeout
+      result = subject.peek
+      assert_equal subject.peek_data, result
+      assert_nil subject.peek_timeout
+
+      timeout = Factory.integer
+      assert_nil subject.peek_timeout
+      result = subject.peek(timeout)
+      assert_equal timeout, subject.peek_timeout
+    end
+
+    should "close itself using `close`" do
+      assert_false subject.closed
+      subject.close
+      assert_true subject.closed
+    end
+
+    should "close its write using `close_write`" do
+      assert_false subject.closed_write
+      subject.close_write
+      assert_true subject.closed_write
+    end
+
+  end
+
+end

data/test/unit/msg_data_tests.rb

@@ -30,93 +30,87 @@ class Sanford::Protocol::MsgData
   class BadSizeTests < BadMessageTests
     desc "that errors when reading the version part"
     setup do
-      @socket.stubs(:read).  # when reading the version, fail
-        with(Sanford::Protocol.msg_version.bytesize).
-        raises("simulated socket read error!")
-    end
-    teardown do
-      @socket.unstub(:read)
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_version.bytesize) do
+        raises "simulated socket read error!"
+      end
     end
 
     should "raise a BadMessageError with a relevant message" do
       assert_bad_message "Error reading message protocol version"
     end
+
   end
 
   class BadVersionTests < BadMessageTests
     desc "that errors when reading the size part"
     setup do
-      @socket.stubs(:read).  # when reading the version, succeed
-        with(Sanford::Protocol.msg_version.bytesize).
-        returns(Sanford::Protocol.msg_version)
-      @socket.stubs(:read).  # when reading the size, fail
-        with(Sanford::Protocol.msg_size.bytes).
-        raises("simulated socket read error!")
-    end
-    teardown do
-      @socket.unstub(:read)
+      # when reading the version, succeed
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_version.bytesize) do
+        Sanford::Protocol.msg_version
+      end
+      # when reading the size, fail
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_size.bytes) do
+        raise "simulated socket read error!"
+      end
     end
 
     should "raise a BadMessageError with a relevant message" do
       assert_bad_message "Error reading message body size."
     end
+
   end
 
   class BadBodyTests < BadMessageTests
     desc "that errors when reading the body part"
     setup do
-      @socket.stubs(:read).  # when reading the version, succeed
-        with(Sanford::Protocol.msg_version.bytesize).
-        returns(Sanford::Protocol.msg_version)
-      @socket.stubs(:read).  # when reading the size, succeed
-        with(Sanford::Protocol.msg_size.bytes).
-        returns(Sanford::Protocol.msg_size.encode(50))
-      @socket.stubs(:read).  # when reading the body, fail
-        with(50).
-        raises("simulated socket read error!")
-    end
-    teardown do
-      @socket.unstub(:read)
+      # when reading the version, succeed
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_version.bytesize) do
+        Sanford::Protocol.msg_version
+      end
+      # when reading the size, succeed
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_size.bytes) do
+        Sanford::Protocol.msg_size.encode(50)
+      end
+      # when reading the body, fail
+      Assert.stub(@socket, :read).with(50){ raise "simulated socket read error!" }
     end
 
     should "raise a BadMessageError with a relevant message" do
       assert_bad_message "Error reading message body."
     end
+
   end
 
   class NilSizeTests < BadMessageTests
     desc 'that reads a nil size'
     setup do
-      @socket.stubs(:read).  # when reading the version, succeed
-        with(Sanford::Protocol.msg_version.bytesize).
-        returns(Sanford::Protocol.msg_version)
-      @socket.stubs(:read).  # when reading the size, return nil
-        with(Sanford::Protocol.msg_size.bytes).
-        returns(nil)
-    end
-    teardown do
-      @socket.unstub(:read)
+      # when reading the version, succeed
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_version.bytesize) do
+        Sanford::Protocol.msg_version
+      end
+      # when reading the size, return nil
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_size.bytes){ nil }
     end
 
     should "raise a BadMessageError with a relevant message" do
       assert_bad_message "Empty message size"
     end
+
   end
 
   class VersionMismatchTests < BadMessageTests
     desc "with a mismatched protocol version"
     setup do
-      @socket.stubs(:read).  # when reading the version, encode wrong number
-        with(Sanford::Protocol.msg_version.bytesize).
-        returns(Sanford::Protocol::PackedHeader.new(1, 'C').encode(0))
-    end
-    teardown do
-      @socket.unstub(:read)
+      # when reading the version, encode wrong number
+      Assert.stub(@socket, :read).with(Sanford::Protocol.msg_version.bytesize) do
+        Sanford::Protocol::PackedHeader.new(1, 'C').encode(0)
+      end
     end
 
     should "raise a BadMessageError with a relevant message" do
       assert_bad_message "Protocol version mismatch"
     end
+
   end
 
 end

data/test/unit/request_tests.rb

@@ -53,6 +53,17 @@ class Sanford::Protocol::Request
       assert_equal expected, request.to_hash
     end
 
+    should "be comparable" do
+      match_request = Sanford::Protocol::Request.new(
+        subject.name.dup,
+        subject.params.dup
+      )
+      assert_equal match_request, subject
+
+      not_match_request = Sanford::Protocol::Request.new('other', {})
+      assert_not_equal not_match_request, subject
+    end
+
   end
 
   class ValidTests < UnitTests

data/test/unit/response_tests.rb

@@ -45,6 +45,17 @@ class Sanford::Protocol::Response
       assert_equal expected, subject.to_hash
     end
 
+    should "be comparable" do
+      match_response = Sanford::Protocol::Response.new(
+        subject.status.dup,
+        subject.data.dup
+      )
+      assert_equal match_response, subject
+
+      not_match_response = Sanford::Protocol::Response.new(123, {})
+      assert_not_equal not_match_response, subject
+    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: 63
+  hash: 59
   prerelease: 
   segments: 
   - 0
-  - 8
+  - 9
   - 0
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-06-09 00:00:00 Z
+date: 2014-06-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -37,9 +37,9 @@ dependencies:
         - 10
         - 0
         version: 1.10.0
+  version_requirements: *id001
   type: :runtime
   name: bson
-  version_requirements: *id001
   prerelease: false
 - !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
@@ -47,29 +47,14 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 21
         segments: 
         - 2
-        - 10
-        version: "2.10"
-  type: :development
-  name: assert
+        - 11
+        version: "2.11"
   version_requirements: *id002
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 1
-        version: "1.1"
   type: :development
-  name: assert-mocha
-  version_requirements: *id003
+  name: assert
   prerelease: false
 description: Ruby implementation of the Sanford TCP communication protocol.
 email: 
@@ -89,6 +74,7 @@ files:
 - Rakefile
 - lib/sanford-protocol.rb
 - lib/sanford-protocol/connection.rb
+- lib/sanford-protocol/fake_connection.rb
 - lib/sanford-protocol/fake_socket.rb
 - lib/sanford-protocol/msg_data.rb
 - lib/sanford-protocol/request.rb
@@ -98,7 +84,9 @@ files:
 - lib/sanford-protocol/version.rb
 - sanford-protocol.gemspec
 - test/helper.rb
+- test/support/factory.rb
 - test/unit/connection_tests.rb
+- test/unit/fake_connection_tests.rb
 - test/unit/fake_socket_tests.rb
 - test/unit/msg_data_tests.rb
 - test/unit/request_tests.rb
@@ -135,13 +123,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.29
 signing_key: 
 specification_version: 3
 summary: Ruby implementation of the Sanford TCP communication protocol.
 test_files: 
 - test/helper.rb
+- test/support/factory.rb
 - test/unit/connection_tests.rb
+- test/unit/fake_connection_tests.rb
 - test/unit/fake_socket_tests.rb
 - test/unit/msg_data_tests.rb
 - test/unit/request_tests.rb