and-son 0.3.0 → 0.3.1

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in and-son.gemspec
 gemspec
 
-gem 'bundler', '~>1.1'
-gem 'rake',    '~>0.9.2'
+gem 'rake'
+gem 'pry'
 gem 'bson_ext'

data/lib/and-son/client.rb

@@ -86,7 +86,16 @@ module AndSon
         client_response ||= self.call!(name, params)
       end
 
-      self.logger_value.info("[AndSon] #{summary_line(name, params, benchmark, client_response)}")
+      summary_line = SummaryLine.new({
+        'time'    => RoundedTime.new(benchmark.real),
+        'status'  => client_response.protocol_response.code,
+        'host'    => "#{self.host}:#{self.port}",
+        'version' => self.version,
+        'service' => name,
+        'params'  => params
+      })
+      self.logger_value.info("[AndSon] #{summary_line}")
+
       if block_given?
         yield client_response.protocol_response
       else
@@ -98,6 +107,7 @@ module AndSon
       call_params = self.params_value.merge(params)
       AndSon::Connection.new(host, port).open do |connection|
         connection.write(Sanford::Protocol::Request.new(version, name, call_params).to_hash)
+        connection.close_write
         if !connection.peek(timeout_value).empty?
           AndSon::Response.parse(connection.read(timeout_value))
         else
@@ -106,44 +116,6 @@ module AndSon
       end
     end
 
-    protected
-
-    def summary_line(name, params, benchmark, client_response)
-      response = client_response.protocol_response
-      SummaryLine.new.tap do |line|
-        line.add 'host',    "#{self.host}:#{self.port}"
-        line.add 'version',  self.version
-        line.add 'service',  name
-        line.add 'params',   params
-        line.add 'status',   response.code
-        line.add 'duration', self.round_time(benchmark.real)
-      end
-    end
-
-    ROUND_PRECISION = 2
-    ROUND_MODIFIER = 10 ** ROUND_PRECISION
-    def round_time(time_in_seconds)
-      (time_in_seconds * 1000 * ROUND_MODIFIER).to_i / ROUND_MODIFIER.to_f
-    end
-
-  end
-
-  class SummaryLine
-
-    def initialize
-      @hash = {}
-    end
-
-    def add(key, value)
-      @hash[key] = value.inspect if value
-    end
-
-    def to_s
-      [ 'host', 'version', 'service', 'status', 'duration', 'params' ].map do |key|
-        "#{key}=#{@hash[key]}" if @hash[key]
-      end.compact.join(" ")
-    end
-
   end
 
   class ConnectionClosedError < RuntimeError
@@ -158,4 +130,19 @@ module AndSon
     end
   end
 
+  module SummaryLine
+    def self.new(line_attrs)
+      attr_keys = %w{time status host version service params}
+      attr_keys.map{ |k| "#{k}=#{line_attrs[k].inspect}" }.join(' ')
+    end
+  end
+
+  module RoundedTime
+    ROUND_PRECISION = 2
+    ROUND_MODIFIER = 10 ** ROUND_PRECISION
+    def self.new(time_in_seconds)
+      (time_in_seconds * 1000 * ROUND_MODIFIER).to_i / ROUND_MODIFIER.to_f
+    end
+  end
+
 end

data/lib/and-son/version.rb

@@ -1,3 +1,3 @@
 module AndSon
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/helper.rb

@@ -1,11 +1,9 @@
-require 'ostruct'
+# this file is automatically required when you run `assert`
+# put any test helpers here
 
-ROOT = File.expand_path('../..', __FILE__)
+# add the root dir to the load path
+$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 
-require 'and-son'
-
-require 'test/support/fake_server'
-
-if defined?(Assert)
-  require 'assert-mocha'
-end
+# require pry for debugging (`binding.pry`)
+require 'pry'
+require 'assert-mocha' if defined?(Assert)

data/test/support/fake_connection.rb

@@ -0,0 +1,28 @@
+class FakeConnection
+  attr_reader :written
+
+  def initialize
+    @written = []
+  end
+
+  def peek(*args)
+    "peek_data"
+  end
+
+  def read(*args)
+    { 'status' => [ 200 ], 'data' => {} }
+  end
+
+  def write(request_hash)
+    @written << request_hash
+  end
+
+  def close_write
+    @write_stream_closed = true
+  end
+
+  def write_stream_closed?
+    !!@write_stream_closed
+  end
+
+end

data/test/support/fake_server.rb

@@ -1,3 +1,5 @@
+require 'socket'
+
 class FakeServer
 
   def initialize(port, options = nil)
@@ -6,6 +8,7 @@ class FakeServer
     @handlers = {}
 
     @closing_server = !!options[:closing_server]
+    @slow = !!options[:slow]
   end
 
   def add_handler(version, name, &block)
@@ -20,6 +23,8 @@ class FakeServer
       sleep 0.1 # ensure the connection isn't closed before a client can run
                 # IO.select
       socket.close
+    elsif @slow
+      sleep 0.5
     else
       serve(socket)
     end
@@ -35,6 +40,7 @@ class FakeServer
     status, result = route(request)
     response = Sanford::Protocol::Response.new(status, result)
     connection.write(response.to_hash)
+    connection.close_write
   end
 
   def route(request)
@@ -62,6 +68,11 @@ class FakeServer
       run_fake_server(server, &block)
     end
 
+    def start_slow_server(port, &block)
+      server = FakeServer.new(port, :slow => true)
+      run_fake_server(server, &block)
+    end
+
   end
 
 end

data/test/system/{making_requests_test.rb → making_requests_tests.rb}

@@ -1,6 +1,8 @@
 require 'assert'
+require 'test/support/fake_server'
+require 'and-son'
 
-class MakingRequestsTest < Assert::Context
+class MakingRequestsTests < Assert::Context
   include FakeServer::Helper
 
   desc "making a request that"
@@ -8,7 +10,7 @@ class MakingRequestsTest < Assert::Context
     @fake_server = FakeServer.new(12000)
   end
 
-  class SuccessTest < MakingRequestsTest
+  class SuccessTests < MakingRequestsTests
     desc "returns a successful response"
     setup do
       @fake_server.add_handler('v1', 'echo'){|params| [ 200, params['message'] ] }
@@ -29,7 +31,7 @@ class MakingRequestsTest < Assert::Context
 
   end
 
-  class WithStoredResponsesTest < MakingRequestsTest
+  class WithStoredResponsesTests < MakingRequestsTests
     desc "is stored with and-son and with testing ENV var set"
     setup do
       ENV['ANDSON_TEST_MODE'] = 'yes'
@@ -51,7 +53,7 @@ class MakingRequestsTest < Assert::Context
 
   end
 
-  class AuthorizeTest < MakingRequestsTest
+  class AuthorizeTests < MakingRequestsTests
     setup do
       @fake_server.add_handler('v1', 'authorize_it') do |params|
         if params['api_key'] == 12345
@@ -87,9 +89,10 @@ class MakingRequestsTest < Assert::Context
 
       end
     end
+
   end
 
-  class Failure400Test < MakingRequestsTest
+  class Failure400Tests < MakingRequestsTests
     desc "when a request fails with a 400"
     setup do
       @fake_server.add_handler('v1', '400'){|params| [ 400, false ] }
@@ -105,9 +108,10 @@ class MakingRequestsTest < Assert::Context
 
       end
     end
+
   end
 
-  class Failure404Test < MakingRequestsTest
+  class Failure404Tests < MakingRequestsTests
     desc "when a request fails with a 404"
     setup do
       @fake_server.add_handler('v1', '404'){|params| [ 404, false ] }
@@ -123,9 +127,10 @@ class MakingRequestsTest < Assert::Context
 
       end
     end
+
   end
 
-  class Failure4xxTest < MakingRequestsTest
+  class Failure4xxTests < MakingRequestsTests
     desc "when a request fails with a 4xx"
     setup do
       @fake_server.add_handler('v1', '4xx'){|params| [ 402, false ] }
@@ -141,9 +146,10 @@ class MakingRequestsTest < Assert::Context
 
       end
     end
+
   end
 
-  class Failure5xxTest < MakingRequestsTest
+  class Failure5xxTests < MakingRequestsTests
     desc "when a request fails with a 5xx"
     setup do
       @fake_server.add_handler('v1', '5xx'){|params| [ 500, false ] }
@@ -159,9 +165,10 @@ class MakingRequestsTest < Assert::Context
 
       end
     end
+
   end
 
-  class TimeoutErrorTest < MakingRequestsTest
+  class TimeoutErrorTests < MakingRequestsTests
     desc "when a request takes to long to respond"
     setup do
       @fake_server.add_handler('v1', 'forever') do |params|
@@ -180,6 +187,7 @@ class MakingRequestsTest < Assert::Context
 
       end
     end
+
   end
 
 end

data/test/unit/{and-son_test.rb → and-son_tests.rb}

@@ -1,8 +1,9 @@
 require 'assert'
+require 'and-son'
 
 module AndSon
 
-  class BaseTest < Assert::Context
+  class BaseTests < Assert::Context
     desc "AndSon"
     subject{ AndSon }
 

data/test/unit/{client_test.rb → client_tests.rb}

@@ -1,9 +1,12 @@
 require 'assert'
+require 'test/support/fake_connection'
+require 'test/support/fake_server'
 require 'and-son/stored_responses'
+require 'and-son/client'
 
 class AndSon::Client
 
-  class BaseTest < Assert::Context
+  class BaseTests < Assert::Context
     include FakeServer::Helper
 
     desc "AndSon::Client"
@@ -65,19 +68,56 @@ class AndSon::Client
         subject.params('test')
       end
     end
+    should "track its stored responses" do
+      assert_kind_of AndSon::StoredResponses, subject.responses
+    end
+
+  end
+
+  class CallTest < BaseTests
+    desc "call"
+    setup do
+      @connection = AndSon::Connection.new('localhost', 12001)
+      @response = AndSon::Response.parse({ 'status' => [200] })
+      @fake_connection = FakeConnection.new
+      AndSon::Connection.stubs(:new).returns(@connection)
+    end
+    teardown do
+      AndSon::Connection.unstub(:new)
+    end
+
+    should "write a request to the connection" do
+      @connection.stubs(:open).yields(@fake_connection).returns(@response)
+
+      client = AndSon::Client.new('localhost', 12001, 'v1').call('echo', {
+        :message => 'test'
+      })
+
+      request_data = @fake_connection.written.first
+      assert_equal 'v1',                    request_data['version']
+      assert_equal 'echo',                  request_data['name']
+      assert_equal({ 'message' => 'test' }, request_data['params'])
+    end
+
+    should "close the write stream" do
+      @connection.stubs(:open).yields(@fake_connection).returns(@response)
+
+      client = AndSon::Client.new('localhost', 12001, 'v1').call('echo', {
+        :message => 'test'
+      })
+
+      assert @fake_connection.write_stream_closed?
+    end
 
     should "raise an ArgumentError when #call is not passed a Hash for params" do
-      runner = subject.timeout(0.1) # in case it actually tries to make the request
+      client = AndSon::Client.new('localhost', 12001, 'v1')
+      runner = client.timeout(0.1) # in case it actually tries to make the request
 
       assert_raises(ArgumentError) do
         runner.call('something', 'test')
       end
     end
 
-    should "track its stored responses" do
-      assert_kind_of AndSon::StoredResponses, subject.responses
-    end
-
     should "raise a ConnectionClosedError when the server closes the connection" do
       self.start_closing_server(12001) do
         client = AndSon::Client.new('localhost', 12001, 'v1')
@@ -90,7 +130,4 @@ class AndSon::Client
 
   end
 
-  # the `call` method is tested in the file test/system/making_requests_test.rb,
-  # because there is a lot of setup needed to call this method
-
 end

data/test/unit/{response_test.rb → response_tests.rb}

@@ -1,8 +1,9 @@
 require 'assert'
+require 'and-son/response'
 
 class AndSon::Response
 
-  class BaseTest < Assert::Context
+  class BaseTests < Assert::Context
     desc "AndSon::Response"
     setup do
       @protocol_response = Sanford::Protocol::Response.new([ 200, 'message' ], 'data')
@@ -10,8 +11,8 @@ class AndSon::Response
     end
     subject{ @response }
 
-    should have_instance_methods :data, :code_is_5xx?, :code_is_404?, :code_is_400?, :code_is_4xx?
-    should have_class_methods :parse
+    should have_imeths :data, :code_is_5xx?, :code_is_404?, :code_is_400?, :code_is_4xx?
+    should have_cmeths :parse
 
     should "return the protocol response's data with #data" do
       assert_equal @protocol_response.data, subject.data
@@ -22,9 +23,10 @@ class AndSon::Response
       assert_equal false, subject.code_is_400?
       assert_equal false, subject.code_is_4xx?
     end
+
   end
 
-  class FailedResponseTest < BaseTest
+  class FailedResponseTests < BaseTests
     desc "given a failed response"
     setup do
       @protocol_response = Sanford::Protocol::Response.new([ 500, 'message' ])
@@ -40,9 +42,10 @@ class AndSon::Response
       assert_equal @protocol_response.status.message, exception.message
       assert_equal @protocol_response,                exception.response
     end
+
   end
 
-  class Response5xxTest < BaseTest
+  class Response5xxTests < BaseTests
     desc "given a 5xx response"
     setup do
       @protocol_response = Sanford::Protocol::Response.new(500)
@@ -55,9 +58,10 @@ class AndSon::Response
       assert_equal false, subject.code_is_400?
       assert_equal false, subject.code_is_4xx?
     end
+
   end
 
-  class Response404Test < BaseTest
+  class Response404Tests < BaseTests
     desc "given a 404 response"
     setup do
       @protocol_response = Sanford::Protocol::Response.new(404)
@@ -71,9 +75,10 @@ class AndSon::Response
       assert_equal false, subject.code_is_400?
       assert_equal true,  subject.code_is_4xx?
     end
+
   end
 
-  class Response400Test < BaseTest
+  class Response400Tests < BaseTests
     desc "given a 400 response"
     setup do
       @protocol_response = Sanford::Protocol::Response.new(400)
@@ -87,9 +92,10 @@ class AndSon::Response
       assert_equal true,  subject.code_is_400?
       assert_equal true,  subject.code_is_4xx?
     end
+
   end
 
-  class Response4xxTest < BaseTest
+  class Response4xxTests < BaseTests
     desc "given a 4xx response"
     setup do
       @protocol_response = Sanford::Protocol::Response.new(402)
@@ -102,6 +108,7 @@ class AndSon::Response
       assert_equal false, subject.code_is_400?
       assert_equal true,  subject.code_is_4xx?
     end
+
   end
 
 end

data/test/unit/{stored_responses_test.rb → stored_responses_tests.rb}

@@ -1,4 +1,5 @@
 require 'assert'
+require 'and-son/stored_responses'
 
 class AndSon::StoredResponses
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: and-son
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-07 00:00:00 Z
+date: 2013-03-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -87,12 +87,13 @@ files:
 - lib/and-son/stored_responses.rb
 - lib/and-son/version.rb
 - test/helper.rb
+- test/support/fake_connection.rb
 - test/support/fake_server.rb
-- test/system/making_requests_test.rb
-- test/unit/and-son_test.rb
-- test/unit/client_test.rb
-- test/unit/response_test.rb
-- test/unit/stored_responses_test.rb
+- test/system/making_requests_tests.rb
+- test/unit/and-son_tests.rb
+- test/unit/client_tests.rb
+- test/unit/response_tests.rb
+- test/unit/stored_responses_tests.rb
 homepage: https://github.com/redding/and-son
 licenses: []
 
@@ -128,9 +129,10 @@ specification_version: 3
 summary: Simple Sanford client for Ruby.
 test_files: 
 - test/helper.rb
+- test/support/fake_connection.rb
 - test/support/fake_server.rb
-- test/system/making_requests_test.rb
-- test/unit/and-son_test.rb
-- test/unit/client_test.rb
-- test/unit/response_test.rb
-- test/unit/stored_responses_test.rb
+- test/system/making_requests_tests.rb
+- test/unit/and-son_tests.rb
+- test/unit/client_tests.rb
+- test/unit/response_tests.rb
+- test/unit/stored_responses_tests.rb