and-son 0.2.1 → 0.3.0

data/Rakefile

@@ -1,4 +1 @@
 require "bundler/gem_tasks"
-
-require "assert/rake_tasks"
-Assert::RakeTasks.install

data/and-son.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("sanford-protocol",  ["~>0.5"])
 
-  gem.add_development_dependency("assert",        ["~>1.0"])
+  gem.add_development_dependency("assert",        ["~>2.0"])
   gem.add_development_dependency("assert-mocha",  ["~>1.0"])
 end

data/lib/and-son/client.rb

@@ -1,3 +1,5 @@
+require 'benchmark'
+require 'logger'
 require 'ostruct'
 require 'sanford-protocol'
 require 'and-son/connection'
@@ -14,7 +16,7 @@ module AndSon
     # called on a client, but returns the chained instance if called on a runner
 
     def timeout(seconds)
-      self.call_runner.tap{|r| r.timeout_value = seconds.to_f}
+      self.call_runner.tap{|r| r.timeout_value = seconds.to_f }
     end
 
     def params(hash = nil)
@@ -24,6 +26,10 @@ module AndSon
       self.call_runner.tap{|r| r.params_value.merge!(self.stringify_keys(hash)) }
     end
 
+    def logger(passed_logger)
+      self.call_runner.tap{|r| r.logger_value = passed_logger }
+    end
+
     protected
 
     def stringify_keys(hash)
@@ -55,13 +61,15 @@ module AndSon
         :version  => version,
         :timeout_value => (ENV['ANDSON_TIMEOUT'] || DEFAULT_TIMEOUT).to_f,
         :params_value  => {},
+        :logger_value  => NullLogger.new,
         :responses     => @responses,
       })
     end
   end
 
   class CallRunner < OpenStruct
-    # {:host, :port, :version, :timeout_value, :params_value, :responses}
+    # { :host, :port, :version, :timeout_value, :params_value, :logger_value,
+    #   :responses }
     include CallRunnerMethods
 
     # chain runner methods by returning itself
@@ -72,9 +80,13 @@ module AndSon
       if !params.kind_of?(Hash)
         raise ArgumentError, "expected params to be a Hash instead of a #{params.class}"
       end
-      client_response = self.responses.find(name, params) if ENV['ANDSON_TEST_MODE']
-      client_response ||= self.call!(name, params)
+      client_response = nil
+      benchmark = Benchmark.measure do
+        client_response = self.responses.find(name, params) if ENV['ANDSON_TEST_MODE']
+        client_response ||= self.call!(name, params)
+      end
 
+      self.logger_value.info("[AndSon] #{summary_line(name, params, benchmark, client_response)}")
       if block_given?
         yield client_response.protocol_response
       else
@@ -86,10 +98,64 @@ 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)
-        AndSon::Response.parse(connection.read(timeout_value))
+        if !connection.peek(timeout_value).empty?
+          AndSon::Response.parse(connection.read(timeout_value))
+        else
+          raise AndSon::ConnectionClosedError.new
+        end
       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
+    def initialize
+      super "The server closed the connection, no response was written."
+    end
+  end
+
+  class NullLogger
+    ::Logger::Severity.constants.each do |name|
+      define_method(name.downcase){|*args| } # no-op
+    end
   end
 
 end

data/lib/and-son/response.rb

@@ -1,7 +1,5 @@
 require 'sanford-protocol'
 
-require 'and-son/exceptions'
-
 module AndSon
 
   class Response < Struct.new(:protocol_response)
@@ -41,4 +39,19 @@ module AndSon
 
   end
 
+  class RequestError < RuntimeError
+    attr_reader :response
+
+    def initialize(protocol_response)
+      super(protocol_response.status.message)
+      @response = protocol_response
+    end
+  end
+
+  ClientError     = Class.new(RequestError)
+  BadRequestError = Class.new(ClientError)
+  NotFoundError   = Class.new(ClientError)
+
+  ServerError     = Class.new(RequestError)
+
 end

data/lib/and-son/version.rb

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

data/test/support/fake_server.rb

@@ -1,8 +1,11 @@
 class FakeServer
 
-  def initialize(port)
+  def initialize(port, options = nil)
+    options ||= {}
     @port = port
     @handlers = {}
+
+    @closing_server = !!options[:closing_server]
   end
 
   def add_handler(version, name, &block)
@@ -13,7 +16,13 @@ class FakeServer
     server = TCPServer.new("localhost", @port)
     socket = server.accept
 
-    serve(socket)
+    if @closing_server
+      sleep 0.1 # ensure the connection isn't closed before a client can run
+                # IO.select
+      socket.close
+    else
+      serve(socket)
+    end
 
     server.close rescue false
   end
@@ -37,21 +46,22 @@ class FakeServer
 
     def run_fake_server(server, &block)
       begin
-        pid = fork do
-          trap("TERM"){ exit }
-          server.run
-        end
-
-        sleep 0.3 # Give time for the socket to start listening.
+        thread = Thread.new{ server.run }
         yield
       ensure
-        if pid
-          Process.kill("TERM", pid)
-          Process.wait(pid)
+        begin
+          TCPSocket.open("localhost", server.instance_variable_get("@port"))
+        rescue Exception
         end
+        thread.join
       end
     end
 
+    def start_closing_server(port, &block)
+      server = FakeServer.new(port, :closing_server => true)
+      run_fake_server(server, &block)
+    end
+
   end
 
 end

data/test/unit/client_test.rb

@@ -1,8 +1,11 @@
 require 'assert'
+require 'and-son/stored_responses'
 
 class AndSon::Client
 
   class BaseTest < Assert::Context
+    include FakeServer::Helper
+
     desc "AndSon::Client"
     setup do
       @host, @port, @version = '0.0.0.0', 8000, "v1"
@@ -10,8 +13,8 @@ class AndSon::Client
     end
     subject{ @client }
 
-    should have_imeths :host, :port, :version
-    should have_imeths :call_runner, :call, :timeout
+    should have_imeths :host, :port, :version, :responses
+    should have_imeths :call_runner, :call, :timeout, :logger, :params
 
     should "know its default call runner" do
       default_runner = subject.call_runner
@@ -20,6 +23,7 @@ class AndSon::Client
       assert_equal @port, default_runner.port
       assert_equal @version, default_runner.version
       assert_equal 60.0, default_runner.timeout_value
+      assert_instance_of AndSon::NullLogger, default_runner.logger_value
     end
 
     should "override the default call runner timeout with an env var" do
@@ -48,6 +52,14 @@ class AndSon::Client
       assert_equal({ "api_key" => 12345 }, runner.params_value)
     end
 
+    should "return a CallRunner with a logger value set #logger" do
+      runner = subject.logger(logger = Logger.new(STDOUT))
+
+      assert_kind_of AndSon::CallRunner, runner
+      assert_respond_to :call, runner
+      assert_equal logger, runner.logger_value
+    end
+
     should "raise an ArgumentError when #params is not passed a Hash" do
       assert_raises(ArgumentError) do
         subject.params('test')
@@ -61,6 +73,21 @@ class AndSon::Client
         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')
+
+        assert_raises(AndSon::ConnectionClosedError) do
+          client.call('anything')
+        end
+      end
+    end
+
   end
 
   # the `call` method is tested in the file test/system/making_requests_test.rb,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: and-son
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-05 00:00:00 Z
+date: 2013-03-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -40,11 +40,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 3
         segments: 
-        - 1
+        - 2
         - 0
-        version: "1.0"
+        version: "2.0"
   requirement: *id002
   name: assert
   type: :development
@@ -83,7 +83,6 @@ files:
 - lib/and-son.rb
 - lib/and-son/client.rb
 - lib/and-son/connection.rb
-- lib/and-son/exceptions.rb
 - lib/and-son/response.rb
 - lib/and-son/stored_responses.rb
 - lib/and-son/version.rb

data/lib/and-son/exceptions.rb

@@ -1,19 +0,0 @@
-module AndSon
-
-  class RequestError < RuntimeError
-    attr_reader :response
-
-    def initialize(protocol_response)
-      super(protocol_response.status.message)
-      @response = protocol_response
-    end
-  end
-
-  ClientError     = Class.new(RequestError)
-
-  BadRequestError = Class.new(ClientError)
-  NotFoundError   = Class.new(ClientError)
-
-  ServerError     = Class.new(RequestError)
-
-end