sanford-protocol 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 68b7b525fe9392a33da58986ca25635e1f7a5d3b85c3693d91c997e590454926b3f4dafdae56ba312c14abb303d71ba63b5b2696daea971ec27e7974d40e72ef
+  data.tar.gz: 463b28ddbf3a33f4e337c632bcd041c3bcbfcdd16c9f2bf2a4acd217c02fdb7befb0d620311c322b01e6b46e9be54a17d7f4f23e93eff1dfda99d3ee00f85961
+SHA1: 
+  metadata.gz: a74f6081b63378c6751e542f72f1567a2bac8b7e
+  data.tar.gz: d6883452581ee91aa26edc5fc6cddaa1d7ef30e7

data/README.md

@@ -144,7 +144,7 @@ incoming_response = Sanford::Protocol::Response.parse(data_hash)
 
 ## Test Helpers
 
-A `FakeSocket` helper class and an associated `Test::Helpers` module are provided to help test receiving and sending Sanford::Protocol messages without using real sockets.
+A `FakeSocket` helper class and an associated `TestHelpers` module are provided to help test receiving and sending Sanford::Protocol messages without using real sockets.
 
 ```ruby
 # fake a socket with some incoming binary

data/lib/sanford-protocol/{test/fake_socket.rb → fake_socket.rb}

@@ -5,7 +5,9 @@ require 'sanford-protocol/request'
 # environment. Instead of passing a real socket, pass an instance of this class.
 # It mimics the socket API that sanford is concerned with.
 
-module Sanford::Protocol::Test
+module Sanford; end
+module Sanford::Protocol
+
   class FakeSocket
 
     def self.with_request(*request_params)
@@ -64,4 +66,5 @@ module Sanford::Protocol::Test
     end
 
   end
+
 end

data/lib/sanford-protocol/request.rb

@@ -17,7 +17,7 @@ module Sanford::Protocol
 
     def initialize(name, params)
       self.validate!(name, params)
-      @name, @params = name, params
+      @name, @params = name.to_s, params
     end
 
     def to_hash
@@ -40,7 +40,7 @@ module Sanford::Protocol
     def validate!(name, params)
       problem = if !name
         "The request doesn't contain a name."
-      elsif !params.kind_of?(Hash)
+      elsif !params.kind_of?(::Hash)
         "The request's params are not a valid BSON document."
       end
       raise(BadRequestError, problem) if problem

data/lib/sanford-protocol/response_status.rb

@@ -3,6 +3,7 @@
 
 module Sanford; end
 module Sanford::Protocol
+
   class ResponseStatus < Struct.new(:code_obj, :message)
 
     def initialize(code, message = nil)
@@ -43,4 +44,5 @@ module Sanford::Protocol
     end
 
   end
+
 end

data/lib/sanford-protocol/{test/helpers.rb → test_helpers.rb}

@@ -1,25 +1,27 @@
-require 'sanford-protocol/test/fake_socket'
+require 'sanford-protocol/fake_socket'
+require 'sanford-protocol/connection'
 require 'sanford-protocol/response'
 
-module Sanford::Protocol::Test
+module Sandord; end
+module Sanford::Protocol
 
-  module Helpers
+  module TestHelpers
     extend self
 
     def fake_socket_with_request(*args)
-      FakeSocket.with_request(*args)
+      Sanford::Protocol::FakeSocket.with_request(*args)
     end
 
     def fake_socket_with_msg_body(*args)
-      FakeSocket.with_msg_body(*args)
+      Sanford::Protocol::FakeSocket.with_msg_body(*args)
     end
 
     def fake_socket_with_encoded_msg_body(*args)
-      FakeSocket.with_encoded_msg_body(*args)
+      Sanford::Protocol::FakeSocket.with_encoded_msg_body(*args)
     end
 
     def fake_socket_with(*args)
-      FakeSocket.new(*args)
+      Sanford::Protocol::FakeSocket.new(*args)
     end
 
     def read_response_from_fake_socket(from_fake_socket)
@@ -28,7 +30,7 @@ module Sanford::Protocol::Test
     end
 
     def read_written_response_from_fake_socket(from_fake_socket)
-      read_response_from_fake_socket(FakeSocket.new(from_fake_socket.out))
+      read_response_from_fake_socket(Sanford::Protocol::FakeSocket.new(from_fake_socket.out))
     end
 
   end

data/lib/sanford-protocol/version.rb

@@ -1,5 +1,5 @@
 module Sanford
   module Protocol
-    GEM_VERSION = "0.6.0"
+    GEM_VERSION = "0.7.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",       ["~> 2.3"])
-  gem.add_development_dependency("assert-mocha", ["~> 1.0"])
+  gem.add_development_dependency("assert",       ["~> 2.10"])
+  gem.add_development_dependency("assert-mocha", ["~> 1.1"])
 end

data/test/helper.rb

@@ -9,14 +9,14 @@ require 'pry'
 
 ENV['SANFORD_PROTOCOL_DEBUG'] = 'yes'
 
-require 'sanford-protocol/test/fake_socket'
-FakeSocket = Sanford::Protocol::Test::FakeSocket
+require 'sanford-protocol/fake_socket'
+FakeSocket = Sanford::Protocol::FakeSocket
 
 require 'assert-mocha' if defined?(Assert)
 
 class Assert::Context
 
-  def setup_some_msg_data(data=nil)
+  def setup_some_msg_data(data = nil)
     @data = data || { 'something' => true }
     @encoded_body    = Sanford::Protocol.msg_body.encode(@data)
     @encoded_size    = Sanford::Protocol.msg_size.encode(@encoded_body.bytesize)

data/test/unit/connection_tests.rb

@@ -3,7 +3,7 @@ require 'sanford-protocol/connection'
 
 class Sanford::Protocol::Connection
 
-  class BaseTests < Assert::Context
+  class UnitTests < Assert::Context
     desc "Sanford::Protocol::Connection"
     setup do
       setup_some_msg_data
@@ -39,7 +39,7 @@ class Sanford::Protocol::Connection
 
   end
 
-  class RealConnectionTests < BaseTests
+  class RealConnectionTests < UnitTests
 
     def start_server(options, &block)
       begin

data/test/unit/fake_socket_tests.rb

@@ -1,11 +1,12 @@
 require 'assert'
-require 'sanford-protocol/test/fake_socket'
+require 'sanford-protocol/fake_socket'
+
 require 'sanford-protocol/request'
 
-class Sanford::Protocol::Test::FakeSocket
+class Sanford::Protocol::FakeSocket
 
-  class BaseTests < Assert::Context
-    desc "a FakeSocket"
+  class UnitTests < Assert::Context
+    desc "Sanford::Protocol::FakeSocket"
     setup do
       @fs = FakeSocket.new
     end
@@ -27,7 +28,7 @@ class Sanford::Protocol::Test::FakeSocket
 
   end
 
-  class WithInDataTests < BaseTests
+  class WithInDataTests < UnitTests
     desc "created given some data"
     setup do
       @in_data = 'some in data'
@@ -51,7 +52,7 @@ class Sanford::Protocol::Test::FakeSocket
 
   end
 
-  class EncodedMessageTests < BaseTests
+  class EncodedMessageTests < UnitTests
     desc "with encoded msg data"
     setup do
       setup_some_msg_data
@@ -69,7 +70,7 @@ class Sanford::Protocol::Test::FakeSocket
 
   end
 
-  class RequestTests < BaseTests
+  class RequestTests < UnitTests
     desc "that is a request"
     setup do
       setup_some_request_data

data/test/unit/msg_data_tests.rb

@@ -1,6 +1,7 @@
 require 'assert'
 require 'sanford-protocol/msg_data'
-require 'sanford-protocol'
+
+require 'sanford-protocol/connection'
 
 class Sanford::Protocol::MsgData
 

data/test/unit/request_tests.rb

@@ -3,21 +3,31 @@ require 'sanford-protocol/request'
 
 class Sanford::Protocol::Request
 
-  class BaseTests < Assert::Context
+  class UnitTests < Assert::Context
     desc "Sanford::Protocol::Request"
     setup do
       @request = Sanford::Protocol::Request.new('some_service', { 'key' => 'value' })
     end
     subject{ @request }
 
-    should have_instance_methods :name, :params, :to_hash
-    should have_class_methods :parse
+    should have_imeths :name, :params, :to_hash
+    should have_cmeths :parse
+
+    should "know its name and params" do
+      assert_equal 'some_service', subject.name
+      assert_equal({ 'key' => 'value' }, subject.params)
+    end
+
+    should "force string request names" do
+      request = Sanford::Protocol::Request.new(:symbol_service_name, {})
+      assert_equal 'symbol_service_name', request.name
+    end
 
     should "return it's name with #to_s" do
       assert_equal subject.name, subject.to_s
     end
 
-    should "return an instance of a Sanford::Protocol::Request given a hash using #parse" do
+    should "parse requests given a body hash" do
       # using BSON messages are hashes
       hash = {
         'name'   => 'service_name',
@@ -33,7 +43,7 @@ class Sanford::Protocol::Request
     should "return the request as a hash with stringified params with #to_hash" do
       # using BSON, messages are hashes
       request = Sanford::Protocol::Request.new('service', {
-        1       => 1,
+        1 => 1,
         :symbol => :symbol
       })
       expected = {
@@ -45,7 +55,7 @@ class Sanford::Protocol::Request
 
   end
 
-  class ValidTests < BaseTests
+  class ValidTests < UnitTests
 
     should "not raise an exception with valid request args" do
       assert_nothing_raised do

data/test/unit/response_status_tests.rb

@@ -3,7 +3,7 @@ require 'sanford-protocol/response_status'
 
 class Sanford::Protocol::ResponseStatus
 
-  class BaseTests < Assert::Context
+  class UnitTests < Assert::Context
     desc "Sanford::Protocol::ResponseStatus"
     setup do
       @status = Sanford::Protocol::ResponseStatus.new(200, "OK")
@@ -11,7 +11,7 @@ class Sanford::Protocol::ResponseStatus
     subject{ @status }
 
     should have_readers :code_obj, :message
-    should have_instance_methods :code, :name, :to_i
+    should have_imeths :code, :name, :to_i
 
     should "know it's code name" do
       named  = Sanford::Protocol::ResponseStatus.new(200)

data/test/unit/response_tests.rb

@@ -3,15 +3,15 @@ require 'sanford-protocol/response'
 
 class Sanford::Protocol::Response
 
-  class BaseTests < Assert::Context
+  class UnitTests < Assert::Context
     desc "Sanford::Protocol::Response"
     setup do
       @response = Sanford::Protocol::Response.new([ 672, 'YAR!' ], { 'something' => true })
     end
     subject{ @response }
 
-    should have_instance_methods :status, :code, :data, :to_hash, :to_s
-    should have_class_methods :parse
+    should have_imeths :status, :code, :data, :to_hash, :to_s
+    should have_cmeths :parse
 
     should "return its status#code with #code" do
       assert_equal subject.status.code, subject.code
@@ -49,7 +49,7 @@ class Sanford::Protocol::Response
 
   # Somewhat of a system test, want to make sure if Response is passed some
   # "fuzzy" args that it will build it's status object as expected
-  class StatusBuildingTests < BaseTests
+  class StatusBuildingTests < UnitTests
 
     should "build a status with it's code set, given an integer" do
       response = Sanford::Protocol::Response.new(574)
@@ -75,8 +75,8 @@ class Sanford::Protocol::Response
     should "build a status with a code and message set, when given both" do
       response = Sanford::Protocol::Response.new([ 348, "my message" ])
 
-      assert_equal 348,           response.status.code
-      assert_equal "my message",  response.status.message
+      assert_equal 348, response.status.code
+      assert_equal "my message", response.status.message
     end
   end
 

data/test/unit/{protocol_tests.rb → sanford-protocol_tests.rb}

@@ -1,16 +1,17 @@
+require 'assert'
+require 'sanford-protocol'
+
 # These tests are intended to be brittle and make sure the protocol conforms to
 # an expected spec. If any of these tests fail, you probably need to modify the
 # protocol's version constant.
 
-require 'assert'
-require 'sanford-protocol'
-
 module Sanford::Protocol
-  class BaseTests < Assert::Context
+
+  class UnitTests < Assert::Context
     desc "Sanford::Protocol"
     subject{ Sanford::Protocol }
 
-    should have_instance_methods :msg_version, :msg_size, :msg_body
+    should have_imeths :msg_version, :msg_size, :msg_body
 
     should "define the protocol version" do
       assert_equal 2, subject::VERSION

data/test/unit/test_helpers_tests.rb

@@ -1,11 +1,13 @@
 require 'assert'
-require 'sanford-protocol/test/helpers'
+require 'sanford-protocol/test_helpers'
 
-module Sanford::Protocol::Test::Helpers
+require 'sanford-protocol/response'
 
-  class BaseTests < Assert::Context
-    desc "the test helpers"
-    subject { Sanford::Protocol::Test::Helpers }
+module Sanford::Protocol::TestHelpers
+
+  class UnitTests < Assert::Context
+    desc "Sanford::Protocol::TestHelpers"
+    subject { Sanford::Protocol::TestHelpers }
 
     should have_imeths :fake_socket_with_request, :fake_socket_with_msg_body
     should have_imeths :fake_socket_with_encoded_msg_body, :fake_socket_with

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanford-protocol
 version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,53 +10,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-14 00:00:00 Z
+date: 2014-06-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 7
         version: "1.7"
   type: :runtime
-  requirement: *id001
-  prerelease: false
+  version_requirements: *id001
   name: bson
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
+        version: "2.10"
   type: :development
-  requirement: *id002
-  prerelease: false
+  version_requirements: *id002
   name: assert
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+        version: "1.1"
   type: :development
-  requirement: *id003
-  prerelease: false
+  version_requirements: *id003
   name: assert-mocha
+  prerelease: false
 description: Ruby implementation of the Sanford TCP communication protocol.
 email: 
 - collin.redding@me.com
@@ -81,63 +60,56 @@ files:
 - Rakefile
 - lib/sanford-protocol.rb
 - lib/sanford-protocol/connection.rb
+- lib/sanford-protocol/fake_socket.rb
 - lib/sanford-protocol/msg_data.rb
 - lib/sanford-protocol/request.rb
 - lib/sanford-protocol/response.rb
 - lib/sanford-protocol/response_status.rb
-- lib/sanford-protocol/test/fake_socket.rb
-- lib/sanford-protocol/test/helpers.rb
+- lib/sanford-protocol/test_helpers.rb
 - lib/sanford-protocol/version.rb
 - sanford-protocol.gemspec
 - test/helper.rb
 - test/unit/connection_tests.rb
 - test/unit/fake_socket_tests.rb
 - test/unit/msg_data_tests.rb
-- test/unit/protocol_tests.rb
 - test/unit/request_tests.rb
 - test/unit/response_status_tests.rb
 - test/unit/response_tests.rb
+- test/unit/sanford-protocol_tests.rb
 - test/unit/test_helpers_tests.rb
 homepage: https://github.com/redding/sanford-protocol
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
+  - &id004 
+    - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id004
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby implementation of the Sanford TCP communication protocol.
 test_files: 
 - test/helper.rb
 - test/unit/connection_tests.rb
 - test/unit/fake_socket_tests.rb
 - test/unit/msg_data_tests.rb
-- test/unit/protocol_tests.rb
 - test/unit/request_tests.rb
 - test/unit/response_status_tests.rb
 - test/unit/response_tests.rb
+- test/unit/sanford-protocol_tests.rb
 - test/unit/test_helpers_tests.rb