pinch_hitter 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 351d287c33f0a63055aa89e9e33dcc0cd5bf8843
-  data.tar.gz: 7373585ec0c9cc3c70767d2bdfae3d9c66b91df8
+  metadata.gz: 61b0f448b1236a0470c64ffdd3015e536db68cf9
+  data.tar.gz: a451b062d54056d41397a2d187d260bf7ec00162
 SHA512:
-  metadata.gz: 4e52306f9da1c7daaccdcb18cfe84444902dd5820e1f5f09cb921e89a39436057795a08b7206e8015ae1610bbf05ba8f79debe1750dfed54a2d0d83d1b7a462c
-  data.tar.gz: 47d3972f594e178de665e4b021943b326e33d1bad41e921ccba42495b6adaeaccdbf5c6ef86e3c025b875c748d882178b8997b82fc1539fdbda47adfbea3a5a6
+  metadata.gz: b266a49251d14f0adb19d9103f9a750eaec21073f32986723d8687aeb8f331d63fb91b61e6dd4baf559d7f16ce3ab088fa13cc3ef7d79bb00a86fb44d9e459aa
+  data.tar.gz: 664117aff93c40d35fd9b09b1cf5257d35c5050c70869c70ae6df49ef64b9c7f7f96a01653f7b52176d41f7b46bb28e189f2e3b01d821e1901c267c193b5314b

data/.travis.yml

@@ -4,3 +4,5 @@ rvm:
   - 2.0.0
   - 2.1.5
   - 2.2.2
+before_install:
+  - gem update bundler

data/Changelog

@@ -32,3 +32,8 @@ test logs.
 
 === Release 0.5.5 / 2015-11-5
 * Allow Cross-Origin requests
+
+=== Release 0.5.6 / 2016-03-19
+* Add ability to disable cache control (useful for IE testing)
+* Allow client to register a module that will hydrate the response object.
+* Break apart recording and responding to better support full response payloads

data/features/response_headers.feature

@@ -0,0 +1,10 @@
+Feature:  Response headers
+  I want to put headers on my responses
+  As a tester trying to test the application
+  So that my application works with something close to my production server
+
+  Scenario:  Disable caching
+    Given I setup my replay service with no-cache
+    When I make a request
+    Then my response has a no-cache,no-store Cache-Control header
+

data/features/step_definitions/response_steps.rb

@@ -0,0 +1,13 @@
+Given(/^I setup my replay service with no\-cache$/) do
+    mock.reset
+    mock.no_cache
+end
+
+When(/^I make a request$/) do
+  mock.prime '/car_rental', :car_rental
+  @response = app.post '/car_rental', '{"reservation": "yes"}'
+end
+
+Then(/^my response has a no\-cache,no\-store Cache\-Control header$/) do
+  @response.header['Cache-Control'].should == 'no-cache, no-store'
+end

data/lib/pinch_hitter/core_ext/nil_class.rb

@@ -0,0 +1,4 @@
+class NilClass
+  def squish
+  end
+end

data/lib/pinch_hitter/message/message_store.rb

@@ -1,7 +1,6 @@
 require 'pinch_hitter/message/xml'
 require 'pinch_hitter/message/json'
 require 'pinch_hitter/message/content_type'
-require 'pinch_hitter/core_ext/string'
 
 module PinchHitter::Message
     class MessageStore

data/lib/pinch_hitter/service/endpoint_handlers.rb

@@ -1,5 +1,6 @@
+require 'pinch_hitter/core_ext/string'
+require 'pinch_hitter/core_ext/nil_class'
 require_relative 'message_queue'
-require_relative 'endpoint_recorder'
 
 module PinchHitter::Service
   class EndpointHandlers
@@ -7,21 +8,22 @@ module PinchHitter::Service
       @handlers ||= {}
     end
 
-    def store_message(endpoint, body)
-      handler_for(endpoint).store body.squish
+    def store_message(endpoint, message)
+      handler = handler_for(endpoint)
+      handler.store(message.squish) if handler.respond_to? :store
     end
 
-    def respond_to(endpoint='/', request=nil)
-      message = handler_for(endpoint).respond_to(request)
-      message.squish if message
-    end
-
-    def requests(endpoint)
-      handler_for(endpoint).requests
+    def respond_to(endpoint='/', body=nil, request=nil, response = nil)
+      handler = handler_for(endpoint)
+      if handler.respond_to?(:handle_request)
+        handler.handle_request(request, response)
+      else
+        handler.respond_to(body).squish
+      end
     end
 
     def handler_for(endpoint='/')
-      handlers[normalize(endpoint)] || store_handler(endpoint)
+      handlers[endpoint] || store_handler(endpoint)
     end
 
     def register_module(endpoint, mod)
@@ -31,16 +33,13 @@ module PinchHitter::Service
     end
 
     def store_handler(endpoint, handler=MessageQueue.new)
-      handlers[normalize(endpoint)] = EndpointRecorder.new handler
-    end
-
-    def normalize(endpoint)
-      return endpoint if endpoint =~ /^\//
-      "/#{endpoint}"
+      handlers[endpoint] = handler
     end
 
     def reset
-      handlers.values.each(&:reset)
+      handlers.values.each do |handler|
+        handler.reset if handler.respond_to? :reset
+      end
     end
   end
 end

data/lib/pinch_hitter/service/endpoint_recorders.rb

@@ -0,0 +1,23 @@
+module PinchHitter::Service
+  class EndpointRecorders
+    def recorders
+      @recorders ||= {}
+    end
+
+    def record(endpoint, request)
+      recorder_for(endpoint) << request
+    end
+
+    def requests(endpoint)
+      recorder_for(endpoint)
+    end
+
+    def recorder_for(endpoint='/')
+      recorders[endpoint] ||= []
+    end
+
+    def reset
+      recorders.clear
+    end
+  end
+end

data/lib/pinch_hitter/service/message_queue.rb

@@ -1,5 +1,9 @@
 module PinchHitter::Service
   class MessageQueue < Array
+    def store(msg)
+      push msg
+    end
+
     def respond_to(msg=nil)
       shift
     end

data/lib/pinch_hitter/service/replay_ws.rb

@@ -5,6 +5,7 @@ require 'nokogiri'
 require 'json'
 
 require 'pinch_hitter/service/endpoint_handlers'
+require 'pinch_hitter/service/endpoint_recorders'
 require 'pinch_hitter/message/content_type'
 
 module PinchHitter::Service
@@ -16,13 +17,21 @@ module PinchHitter::Service
     configure do
       enable :cross_origin
       @@handlers = EndpointHandlers.new
+      @@recorder = EndpointRecorders.new
       #SOAP expects a mime_type of text/xml
       mime_type :xml, "text/xml"
       mime_type :json, "application/json"
+      disable :no_cache
+    end
+
+
+    before do
+      cache_control :no_cache, :no_store if settings.no_cache
     end
 
     post '/reset' do
       @@handlers.reset
+      @@recorder.reset
       status 200
     end
 
@@ -70,32 +79,48 @@ module PinchHitter::Service
     end
 
     def store(endpoint='/', message=nil)
+      endpoint = normalize(endpoint)
       @@handlers.store_message endpoint, message
     end
 
     def respond(endpoint='/', request=nil)
-      message = @@handlers.respond_to endpoint, wrap(request)
-      content_type determine_content_type message
-      puts "No message found for #{endpoint}" unless message
+      endpoint = normalize(endpoint)
+      body, request = wrap(request)
+      @@recorder.record(endpoint, request)
+      message = @@handlers.respond_to(endpoint, body, request, response)
+      if message.is_a? String
+        content_type determine_content_type message
+        puts "No message found for #{endpoint}" unless message
+      end
       message
     end
 
     def register_module(endpoint='/', mod='')
+      endpoint = normalize(endpoint)
       @@handlers.register_module endpoint, Marshal.load(mod)
     end
 
     def requests endpoint
+      endpoint = normalize(endpoint)
       content_type 'application/json'
-      { requests: @@handlers.requests(endpoint) }.to_json
+      { requests: @@recorder.requests(endpoint) }.to_json
     end
 
-    def wrap request
-      return nil unless request
-      { headers: request_headers, body: request.body.read }
+    def wrap(request)
+      return [nil, nil] unless request
+
+      body = request.body.read
+      [body, { headers: request_headers, body: body }]
     end
 
     def request_headers
       env.select { |key, value| key.upcase == key }
     end
+
+    def normalize(endpoint)
+      return endpoint if endpoint =~ /^\//
+      "/#{endpoint}"
+    end
+
   end
 end

data/lib/pinch_hitter/service/runner.rb

@@ -8,9 +8,15 @@ module PinchHitter::Service::Runner
     @silent_console = true
   end
 
+  def no_cache
+    @no_cache = true
+    @app.settings.enable :no_cache if @app
+  end
+
   def start_service(host, port, timeout=10)
     Thread.abort_on_exception = true
     @app = PinchHitter::Service::ReplayWs.new
+    @app.settings.enable :no_cache if @no_cache
     @replay_service = Thread.new do
       Rack::Handler::WEBrick.run @app, service_options(host, port)
     end

data/lib/pinch_hitter/version.rb

@@ -1,3 +1,3 @@
 module PinchHitter
-  VERSION = "0.5.5"
+  VERSION = "0.5.6"
 end

data/test/test_endpoint_handlers.rb

@@ -40,13 +40,12 @@ class TestEndpointHandlers < MiniTest::Test
     assert_equal "THIS IS A TEST", @handlers.respond_to('endpoint')
   end
 
-  def test_requests
-    request = { body: '{"Hot Rod" : "Williams"}' }
-    @handlers.respond_to('endpoint', request)
-    assert_equal [request], @handlers.requests('endpoint')
+  def test_full_request_module_with_marshalling
+    mod = Marshal.dump(RequestHandlerTest)
+    @handlers.register_module('endpoint', Marshal.load(mod))
+    assert_equal "HANDLING REQUESTS", @handlers.respond_to('endpoint')
   end
 
-
   module TestModule
     def respond_to(msg)
       test_message
@@ -55,4 +54,10 @@ class TestEndpointHandlers < MiniTest::Test
       "THIS IS A TEST"
     end
   end
+
+  module RequestHandlerTest
+    def handle_request(request, response)
+      "HANDLING REQUESTS"
+    end
+  end
 end

data/test/test_endpoint_recorders.rb

@@ -0,0 +1,16 @@
+
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+
+class TestEndpointRecorders < MiniTest::Test
+  def setup
+    @recorders = PinchHitter::Service::EndpointRecorders.new
+  end
+
+  def test_requests
+    request = { body: '{"Hot Rod" : "Williams"}' }
+    @recorders.record('endpoint', request)
+    assert_equal [request], @recorders.requests('endpoint')
+  end
+end

data/test/test_service.rb

@@ -131,4 +131,39 @@ class TestService < MiniTest::Test
     assert_equal user_post, response.first['body']
     assert response.first['headers']
   end
+
+  def test_cache_control_defaults_to_nil
+    post "/store", xml_message
+    post "/respond", ''
+
+    assert_nil last_response['Cache-Control']
+  end
+
+  def test_cache_control
+    app.enable :no_cache
+    post "/store", xml_message
+    post "/respond", ''
+
+    assert_equal 'no-cache, no-store', last_response['Cache-Control']
+    app.disable :no_cache
+  end
+
+  def test_request_handler
+    post '/register_module?endpoint=stuff', Marshal.dump(TestRequestHandler)
+    post '/stuff', ''
+
+    assert_received xml_message
+    assert_equal 202, last_response.status
+    assert(last_response.headers.include? "Kyrie")
+  end
+
+  module TestRequestHandler
+    include MessageAssertions
+    def handle_request(request, response)
+      response.status = 202
+      response["Kyrie"] =  "Irving"
+      response.body = xml_message.squish
+      response
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinch_hitter
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Steve Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2016-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -158,20 +158,23 @@ files:
 - features/messages/car_rental.xml
 - features/messages/glossary.json
 - features/replay.feature
+- features/response_headers.feature
 - features/step_definitions/replay_steps.rb
+- features/step_definitions/response_steps.rb
 - features/step_definitions/verify_requests_steps.rb
 - features/support/env.rb
 - features/support/mock_web_service.rb
 - features/support/xml_parser.rb
 - features/verify.feature
 - lib/pinch_hitter.rb
+- lib/pinch_hitter/core_ext/nil_class.rb
 - lib/pinch_hitter/core_ext/string.rb
 - lib/pinch_hitter/message/content_type.rb
 - 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/endpoint_recorder.rb
+- lib/pinch_hitter/service/endpoint_recorders.rb
 - lib/pinch_hitter/service/message_queue.rb
 - lib/pinch_hitter/service/replay_ws.rb
 - lib/pinch_hitter/service/runner.rb
@@ -179,7 +182,7 @@ files:
 - pinch_hitter.gemspec
 - test/message_assertions.rb
 - test/test_endpoint_handlers.rb
-- test/test_endpoint_recorder.rb
+- test/test_endpoint_recorders.rb
 - test/test_json_message.rb
 - test/test_message.rb
 - test/test_pinch_hitter.rb
@@ -213,7 +216,9 @@ test_files:
 - features/messages/car_rental.xml
 - features/messages/glossary.json
 - features/replay.feature
+- features/response_headers.feature
 - features/step_definitions/replay_steps.rb
+- features/step_definitions/response_steps.rb
 - features/step_definitions/verify_requests_steps.rb
 - features/support/env.rb
 - features/support/mock_web_service.rb
@@ -221,7 +226,7 @@ test_files:
 - features/verify.feature
 - test/message_assertions.rb
 - test/test_endpoint_handlers.rb
-- test/test_endpoint_recorder.rb
+- test/test_endpoint_recorders.rb
 - test/test_json_message.rb
 - test/test_message.rb
 - test/test_pinch_hitter.rb

data/lib/pinch_hitter/service/endpoint_recorder.rb

@@ -1,28 +0,0 @@
-module PinchHitter::Service
-  class EndpointRecorder
-    attr_reader :handler
-
-    def initialize(handler)
-      @handler = handler
-    end
-
-    def store message
-      handler << message if handler.respond_to? :<<
-    end
-
-    def respond_to(request)
-      requests << request if request
-      message = request[:body] if request
-      handler.respond_to message
-    end
-
-    def requests
-      @requests ||= []
-    end
-
-    def reset
-      requests.clear
-      handler.reset if handler.respond_to? :reset
-    end
-  end
-end

data/test/test_endpoint_recorder.rb

@@ -1,43 +0,0 @@
-ENV['RACK_ENV'] = 'test'
-
-require 'minitest/autorun'
-
-class TestEndpointRecorder < MiniTest::Test
-
-  def setup
-    @mock = MiniTest::Mock.new
-    @recorder = PinchHitter::Service::EndpointRecorder.new @mock
-  end
-
-  def test_is_facade_for_handler
-    @mock.expect(:<<, nil, ['blah'])
-    @recorder.store 'blah'
-    @mock.verify
-  end
-
-  def test_is_facade_reset
-    @mock.expect(:reset, nil)
-    @recorder.reset
-    @mock.verify
-  end
-
-  def test_stores_request_if_present
-    @mock.expect(:respond_to, '', [String])
-    @recorder.respond_to({ body: 'request' })
-    assert_equal [{body: 'request'}], @recorder.requests
-  end
-
-  def test_passes_body_to_handler_if_present
-    @mock.expect(:respond_to, '', ['request'])
-    @recorder.respond_to({ body: 'request' })
-    @mock.verify
-  end
-
-  def reset_clears_stored_requests
-    @mock.expect(:respond_to, '', [String])
-    @mock.expect(:reset, nil)
-    @recorder.respond_to({ body: 'request' })
-    @recorder.reset
-    assert_empty @recorder.requests
-  end
-end