pinch_hitter 0.2 → 0.3

data/Changelog

@@ -3,3 +3,6 @@ Initial release of the gem
 
 === Release 0.2 / 2013-1-27
 Switch json to do overrides by key rather than path (like xml)
+
+=== Release 0.3 / 2013-3-22
+Add ability to register modules for custom message handling

data/features/step_definitions/test_replay_steps.rb

@@ -41,3 +41,15 @@ end
 Then /^I see a definition with a "(.*?)" of "(.*?)"$/ do |key, value|
   @response.body.to_s.should == messages.load(:glossary, { key => value }).squish
 end
+
+Given(/^I want to do some fancy processing$/) do
+  mock.register_module('/service', XmlParser)
+end
+
+When(/^I query my service with (.*?)$/) do |request|
+  @response = app.post '/service', "<request>#{request}</request>"
+end
+
+Then(/^I see (.*?) in the service response$/) do |response|
+  @response.body.to_s.should == "<response>#{response}</response>"
+end

data/features/support/xml_parser.rb

@@ -0,0 +1,10 @@
+module XmlParser
+  def respond_to(message)
+    if message.include? "ABC"
+      result = "123"
+    elsif message.include? "DEF"
+      result = "Comedy Jam"
+    end
+    "<response>#{result}</response>"
+  end
+end

data/features/test_replay.feature

@@ -25,3 +25,13 @@ Feature:  Test WS replay
     Given I want to lookup a definition with a "ID" of "FOO"
     When I query the glossary
     Then I see a definition with a "ID" of "FOO"
+
+  Scenario Outline:  Replay with custom module
+    Given I want to do some fancy processing
+    When I query my service with <request>
+    Then I see <response> in the service response
+
+    Examples:
+      |request| response   |
+      |ABC    | 123        |
+      |DEF    | Comedy Jam |

data/lib/pinch_hitter.rb

@@ -30,4 +30,8 @@ module PinchHitter
     @session.post "/store?endpoint=#{endpoint}", content
   end
 
+  def register_module(endpoint, handler)
+    @session.post "/register_module?endpoint=#{endpoint}", Marshal.dump(handler)
+  end
+
 end

data/lib/pinch_hitter/message/content_type.rb

@@ -1,15 +1,12 @@
 require 'pinch_hitter/message/json'
 
-module PinchHitter
-  module Message
-    module ContentType
-      include Json
+module PinchHitter::Message
+  module ContentType
+    include Json
 
-      def determine_content_type(message)
-        return "application/json" if valid_json? message
-        "text/xml"
-      end
-   
+    def determine_content_type(message)
+      return "application/json" if valid_json? message
+      "text/xml"
     end
   end
 end

data/lib/pinch_hitter/message/json.rb

@@ -1,54 +1,50 @@
-module PinchHitter
-  module Message
-    module Json
-      def json_message(file, overrides={})
-        json_file = load_json_file file
-        replace_json json_file, overrides
-      end
+module PinchHitter::Message
+  module Json
+    def json_message(file, overrides={})
+      json_file = load_json_file file
+      replace_json json_file, overrides
+    end
 
-      def valid_json?(json)
-        begin
-          JSON.parse json
-          return true
-        rescue
-          return false
-        end
+    def valid_json?(json)
+      begin
+        JSON.parse json
+        return true
+      rescue
+        return false
       end
+    end
 
-    private
-      def load_json_file(filename)
-        IO.read filename
-      end
+  private
+    def load_json_file(filename)
+      IO.read filename
+    end
 
-      def replace_json(content, overrides={})
-        return content if overrides.empty?
-        doc = JSON.parse(content)
-        overrides.each do |key, value|
-          hash = find_nested_hash(doc, key)
-          if has_key(hash, key)
-            hash[key] = value
-          end
+    def replace_json(content, overrides={})
+      return content if overrides.empty?
+      doc = JSON.parse(content)
+      overrides.each do |key, value|
+        hash = find_nested_hash(doc, key)
+        if has_key(hash, key)
+          hash[key] = value
         end
-        doc.to_s
       end
+      doc.to_s
+    end
 
-      def find_nested_hash(parent, key)
-        return parent if has_key(parent, key)
-        return nil unless parent.respond_to? :each
-
-        found = nil
-        parent.find do |parent_key, child|
-          found = find_nested_hash(child, key)
-        end
-        found
-      end
+    def find_nested_hash(parent, key)
+      return parent if has_key(parent, key)
+      return nil unless parent.respond_to? :each
 
-      def has_key(hash, key)
-        hash.respond_to?(:key?) && hash.key?(key)
+      found = nil
+      parent.find do |parent_key, child|
+        found = find_nested_hash(child, key)
       end
+      found
+    end
 
-     
-
+    def has_key(hash, key)
+      hash.respond_to?(:key?) && hash.key?(key)
     end
+
   end
 end

data/lib/pinch_hitter/message/message_store.rb

@@ -3,32 +3,30 @@ require 'pinch_hitter/message/json'
 require 'pinch_hitter/message/content_type'
 require 'pinch_hitter/core_ext/string'
 
-module PinchHitter
-  module Message
+module PinchHitter::Message
     class MessageStore
-      include Xml
-      include Json
-      include ContentType
+    include Xml
+    include Json
+    include ContentType
 
-      attr_accessor :message_directory
+    attr_accessor :message_directory
 
-      def initialize(message_directory)
-        @message_directory = message_directory
-      end
-
-      def load(file, overrides={})
-        filename = find_filename file
-        if filename =~ /xml$/
-          xml_message filename, overrides
-        else
-          json_message filename, overrides
-        end
-      end
+    def initialize(message_directory)
+      @message_directory = message_directory
+    end
 
-      def find_filename(file)
-        Dir["#{message_directory}/#{file}*"].first
+    def load(file, overrides={})
+      filename = find_filename file
+      if filename =~ /xml$/
+        xml_message filename, overrides
+      else
+        json_message filename, overrides
       end
+    end
 
+    def find_filename(file)
+      Dir["#{message_directory}/#{file}*"].first
     end
+
   end
 end

data/lib/pinch_hitter/message/xml.rb

@@ -1,37 +1,35 @@
 require 'nokogiri'
 
-module PinchHitter
-  module Message
-    module Xml
-      def xml_message(file, overrides={})
-        xml = load_xml_file(file)
-        overrides.each do |key, text|
-          replace_xml(xml, key, text)
-        end
-        xml.to_s
+module PinchHitter::Message
+  module Xml
+    def xml_message(file, overrides={})
+      xml = load_xml_file(file)
+      overrides.each do |key, text|
+        replace_xml(xml, key, text)
       end
+      xml.to_s
+    end
 
-      private
-      def load_xml_file(filename)
-        Nokogiri::XML File.open filename
-      end
+    private
+    def load_xml_file(filename)
+      Nokogiri::XML File.open filename
+    end
 
-      def replace_xml(xml, key, text)
-        parts = key.split('@')
-        tag = find_node xml, parts.first
+    def replace_xml(xml, key, text)
+      parts = key.split('@')
+      tag = find_node xml, parts.first
 
-        if parts.length == 1
-          #match text node
-          tag.content = text
-        else
-          #match attribute
-          tag[parts.last] = text
-        end
+      if parts.length == 1
+        #match text node
+        tag.content = text
+      else
+        #match attribute
+        tag[parts.last] = text
       end
+    end
 
-      def find_node(xml, tag)
-        xml.at_xpath("//#{tag}", xml.collect_namespaces)
-      end
+    def find_node(xml, tag)
+      xml.at_xpath("//#{tag}", xml.collect_namespaces)
     end
   end
 end

data/lib/pinch_hitter/service/endpoint_handlers.rb

@@ -0,0 +1,45 @@
+require_relative 'message_queue'
+
+module PinchHitter::Service
+  class EndpointHandlers
+    def handlers
+      @handlers ||= {}
+    end
+
+    def store_message(endpoint, body)
+      handler_for(endpoint) << body.squish
+    end
+
+    def respond_to(endpoint='/', request='')
+      message = handler_for(endpoint).respond_to(request)
+      message.squish if message
+    end
+
+    def handler_for(endpoint='/')
+      handlers[normalize(endpoint)] || store_handler(endpoint) 
+    end
+
+    def register_module(endpoint, mod)
+      handler = Object.new
+      handler.extend(mod)
+      store_handler(endpoint, handler)
+    end
+
+    def store_handler(endpoint, handler=MessageQueue.new)
+      handlers[normalize(endpoint)] = handler
+    end
+
+    def normalize(endpoint)
+      return endpoint if endpoint =~ /^\//
+      "/#{endpoint}"
+    end
+
+    def reset
+      handlers.values.each do |handler|
+        if(handler.respond_to? :reset)
+          handler.reset
+        end
+      end
+    end
+  end
+end

data/lib/pinch_hitter/service/message_queue.rb

@@ -0,0 +1,11 @@
+module PinchHitter::Service
+  class MessageQueue < Array
+    def respond_to(msg=nil)
+      shift
+    end
+
+    def reset
+      clear
+    end
+  end
+end

data/lib/pinch_hitter/service/replay_ws.rb

@@ -3,59 +3,66 @@ require 'sinatra/base'
 require 'nokogiri'
 require 'json'
 
-require 'pinch_hitter/service/response_queues'
+require 'pinch_hitter/service/endpoint_handlers'
 require 'pinch_hitter/message/content_type'
 
-module PinchHitter
-  module Service
-    class ReplayWs < Sinatra::Base
-      include PinchHitter::Message::ContentType
-
-      configure do
-        @@responses = ResponseQueues.new
-        #SOAP expects a mime_type of text/xml
-        mime_type :xml, "text/xml"
-        mime_type :json, "application/json"
-      end
-
-      post '/reset' do
-        @@responses.reset
-        status 200
-      end
-
-      post '/store/*' do
-        store "/#{params[:splat].first}", request.body.read
-        status 200
-      end
-
-      post '/store' do
-        store request["endpoint"], request.body.read
-        status 200
-      end
-
-      post '/respond' do
-        respond nil
-      end
-
-      get '/*' do
-        respond params[:splat].first
-      end
-
-      post '/*' do
-        respond params[:splat].first
-      end
-
-      def store(endpoint='/', message=nil)
-        @@responses.store endpoint, message
-      end
-
-      def respond(endpoint='/')
-        message = @@responses.retrieve endpoint
-        content_type determine_content_type message
-        puts "No message found for #{endpoint}" unless message
-        message
-      end
+module PinchHitter::Service
+  class ReplayWs < Sinatra::Base
+    include PinchHitter::Message::ContentType
 
+    configure do
+      @@handlers = EndpointHandlers.new
+      #SOAP expects a mime_type of text/xml
+      mime_type :xml, "text/xml"
+      mime_type :json, "application/json"
     end
+
+    post '/reset' do
+      @@handlers.reset
+      status 200
+    end
+
+    post '/store/*' do
+      store "/#{params[:splat].first}", request.body.read
+      status 200
+    end
+
+    post '/store' do
+      store request["endpoint"], request.body.read
+      status 200
+    end
+
+    post '/register_module' do
+      register_module request["endpoint"], request.body.read
+      status 200
+    end
+
+    post '/respond' do
+      respond nil
+    end
+
+    get '/*' do
+      respond params[:splat].first
+    end
+
+    post '/*' do
+      respond params[:splat].first, request.body.read
+    end
+
+    def store(endpoint='/', message=nil)
+      @@handlers.store_message endpoint, message
+    end
+
+    def respond(endpoint='/', request=nil)
+      message = @@handlers.respond_to endpoint, request
+      content_type determine_content_type message
+      puts "No message found for #{endpoint}" unless message
+      message
+    end
+
+    def register_module(endpoint='/', mod='')
+      @@handlers.register_module endpoint, Marshal.load(mod)
+    end
+
   end
 end

data/lib/pinch_hitter/service/runner.rb

@@ -2,32 +2,27 @@ require 'rack'
 require 'webrick'
 require 'pinch_hitter/service/replay_ws'
 
-module PinchHitter
-  module Service
-    module Runner
-
-      def start_service(host, port, timeout=10)
-        Thread.abort_on_exception = true
-        @app = PinchHitter::Service::ReplayWs.new
-        @replay_service = Thread.new do
-          Rack::Handler::WEBrick.run @app, :Host => host, :Port => port
-        end
-        wait_for_replay(timeout)
-      end
+module PinchHitter::Service::Runner
+  def start_service(host, port, timeout=10)
+    Thread.abort_on_exception = true
+    @app = PinchHitter::Service::ReplayWs.new
+    @replay_service = Thread.new do
+      Rack::Handler::WEBrick.run @app, :Host => host, :Port => port
+    end
+    wait_for_replay(timeout)
+  end
 
-      def stop_service
-        @replay_service.kill
-      end
+  def stop_service
+    @replay_service.kill
+  end
 
-      private 
-      def wait_for_replay(timeout)
-        end_time = ::Time.now + timeout
-        until ::Time.now > end_time
-          return if @replay_service.stop?
-          sleep 0.25
-        end
-        raise 'Timed out waiting for replay service to start'
-      end
+  private 
+  def wait_for_replay(timeout)
+    end_time = ::Time.now + timeout
+    until ::Time.now > end_time
+      sleep 0.25
+      return if @replay_service.stop?
     end
+    raise 'Timed out waiting for replay service to start'
   end
 end

data/lib/pinch_hitter/version.rb

@@ -1,3 +1,3 @@
 module PinchHitter
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/test/message_assertions.rb

@@ -0,0 +1,21 @@
+module MessageAssertions
+  def xml_message
+    message = %Q{<?xml version="1.0" encoding="UTF-8"?>
+      <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:replay="http://www.leandog.com/replay">
+        <env:Body>
+          <replay:Response>BARK!</replay:Response>
+        </env:Body>
+    </env:Envelope>}
+  end
+
+  def yml_message
+   %Q~{"menu": {
+      "id": "file",
+      "value": "File"
+    }}~
+  end
+
+  def assert_received(message)
+    assert_equal message.gsub(/\n\s*/, ''), last_response.body.strip
+  end
+end

data/test/test_endpoint_handlers.rb

@@ -0,0 +1,61 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+require 'pinch_hitter/service/endpoint_handlers'
+
+
+class TestEndpointHandlers < MiniTest::Unit::TestCase
+
+  def setup
+    @handlers = PinchHitter::Service::EndpointHandlers.new
+  end
+
+  def json
+    %Q{{"key"::"value"}}
+  end
+
+  def test_message_queue
+    @handlers.store_message 'endpoint', json 
+    handler = @handlers.handler_for 'endpoint'
+    assert_instance_of(PinchHitter::Service::MessageQueue, handler)
+    assert_equal json, handler.respond_to 
+  end
+
+  def test_defaults_to_message_queue
+    @handlers.store_message 'endpoint', json
+    assert_equal json, @handlers.respond_to('endpoint')
+  end
+
+  def test_register_module
+    @handlers.register_module('endpoint', TestModule)
+    assert_equal "THIS IS A TEST", @handlers.respond_to('endpoint')
+  end
+
+  def test_reset_clears_message_queues
+    @handlers.store_message 'endpoint', json
+    @handlers.reset
+    assert_nil @handlers.respond_to('endpoint')
+  end
+
+  def test_reset_does_not_clear_modules
+    @handlers.register_module('endpoint', TestModule)
+    @handlers.reset
+    assert_equal "THIS IS A TEST", @handlers.respond_to('endpoint')
+  end
+
+  def test_register_module_with_marshalling
+    mod = Marshal.dump(TestModule)
+    @handlers.register_module('endpoint', Marshal.load(mod))
+    assert_equal "THIS IS A TEST", @handlers.respond_to('endpoint')
+  end
+
+
+  module TestModule
+    def respond_to(msg)
+      test_message
+    end
+    def test_message
+      "THIS IS A TEST"
+    end
+  end
+end

data/test/test_service.rb

@@ -4,9 +4,11 @@ require 'pinch_hitter/service/replay_ws'
 require 'minitest/autorun'
 require 'rack/test'
 require 'nokogiri'
+require_relative 'message_assertions'
 
 class TestService < MiniTest::Unit::TestCase
   include Rack::Test::Methods
+  include MessageAssertions
 
   def app
     PinchHitter::Service::ReplayWs
@@ -91,23 +93,18 @@ class TestService < MiniTest::Unit::TestCase
     assert_equal '', last_response.body
   end
 
-  def xml_message
-    message = %Q{<?xml version="1.0" encoding="UTF-8"?>
-      <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:replay="http://www.leandog.com/replay">
-        <env:Body>
-          <replay:Response>BARK!</replay:Response>
-        </env:Body>
-    </env:Envelope>}
-  end
+  def test_module
+    post '/register_module?endpoint=stuff', Marshal.dump(TestModule)
+    post '/stuff', ''
 
-  def yml_message
-   %Q~{"menu": {
-      "id": "file",
-      "value": "File"
-    }}~
+    assert_received xml_message
   end
 
-  def assert_received(message)
-    assert_equal message.gsub(/\n\s*/, ''), last_response.body.strip
+  module TestModule
+    include MessageAssertions
+    def respond_to(message)
+      xml_message
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinch_hitter
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -161,6 +161,7 @@ files:
 - features/step_definitions/test_replay_steps.rb
 - features/support/env.rb
 - features/support/mock_web_service.rb
+- features/support/xml_parser.rb
 - features/test_replay.feature
 - lib/pinch_hitter.rb
 - lib/pinch_hitter/core_ext/string.rb
@@ -168,11 +169,14 @@ files:
 - lib/pinch_hitter/message/json.rb
 - lib/pinch_hitter/message/message_store.rb
 - lib/pinch_hitter/message/xml.rb
+- lib/pinch_hitter/service/endpoint_handlers.rb
+- lib/pinch_hitter/service/message_queue.rb
 - lib/pinch_hitter/service/replay_ws.rb
-- lib/pinch_hitter/service/response_queues.rb
 - lib/pinch_hitter/service/runner.rb
 - lib/pinch_hitter/version.rb
 - pinch_hitter.gemspec
+- test/message_assertions.rb
+- test/test_endpoint_handlers.rb
 - test/test_json_message.rb
 - test/test_message.rb
 - test/test_pinch_hitter.rb
@@ -192,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2707663932851003695
+      hash: 4282640623209066746
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -201,10 +205,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2707663932851003695
+      hash: 4282640623209066746
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Test utility for mocking out external web responses
@@ -214,7 +218,10 @@ test_files:
 - features/step_definitions/test_replay_steps.rb
 - features/support/env.rb
 - features/support/mock_web_service.rb
+- features/support/xml_parser.rb
 - features/test_replay.feature
+- test/message_assertions.rb
+- test/test_endpoint_handlers.rb
 - test/test_json_message.rb
 - test/test_message.rb
 - test/test_pinch_hitter.rb

data/lib/pinch_hitter/service/response_queues.rb

@@ -1,29 +0,0 @@
-module PinchHitter
-  module Service
-    class ResponseQueues
-
-      def reset
-        @responses = {}
-      end
-
-      def responses 
-        @responses ||= {}
-      end
-
-      def store(endpoint, body)
-        endpoint_responses(endpoint) << body.gsub(/\n\s*/, '')
-      end
-
-      def retrieve(endpoint='/')
-        endpoint_responses(endpoint).shift
-      end
-
-      def endpoint_responses(endpoint='/')
-        endpoint = "/#{endpoint}" unless endpoint =~ /^\//
-        queue = responses[endpoint] || []
-        responses[endpoint] = queue
-        queue
-      end
-    end
-  end
-end