http_stub 0.22.2 → 0.22.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4c4645eda720411e136a1e6b217cc9ee3fde9f2
-  data.tar.gz: 5b6592c82b4e506028076c326b39fc6d0214dbf4
+  metadata.gz: 4c80f3899b852c169dc4f860759ae6c096e29fdb
+  data.tar.gz: 4a56c16de077939fb79a6152f4d98dcf7ff1c6b7
 SHA512:
-  metadata.gz: 0a5971eca0c6d1e0ade4f7963a00f4259e2fd14d3274d5a1af9ef817b2ea597666f84a445b4bfcb584b369987742ec730ac896710af9c695a685d7e0b4de25be
-  data.tar.gz: 11933cc237590fb5b30e6e1f96eef69461d3f7b8281cb44d1f8756261e944330ab54acbcb9d093f08e62e594c60cc6f78822edf3399c3f4b184b3bfe4bdf8d30
+  metadata.gz: 3940ab6caac7e382d473acefc9fa09e8f3232b56ae5430df606bd50761a081c1962d5f1321d2ff8582e027e7e33d588e67eaf67e3b94edac705a4556cb669214
+  data.tar.gz: 4aea566a355af20b43c457819319cd22ed412d5555fb7a76d77a5f797857899ce334adfb8d834c576fe6bb5d2e22c5cc3cd9acaacead541cefd67b696aefda35

data/lib/http_stub.rb

@@ -59,6 +59,7 @@ require_relative 'http_stub/server/scenario/activator'
 require_relative 'http_stub/server/scenario/controller'
 require_relative 'http_stub/server/scenario'
 require_relative 'http_stub/server/response_pipeline'
+require_relative 'http_stub/server/application_helpers'
 require_relative 'http_stub/server/application'
 require_relative 'http_stub/server/daemon'
 require_relative 'http_stub/configurer/request/http/basic'

data/lib/http_stub/configurer/request/stub_response.rb

@@ -8,7 +8,7 @@ module HttpStub
           @id               = id
           @status           = args[:status] || ""
           @headers          = (args[:headers] || {}).with_indifferent_and_insensitive_access
-          @body             = args[:body]
+          @body             = args[:json].try(:to_json) || args[:body]
           @delay_in_seconds = args[:delay_in_seconds] || ""
         end
 

data/lib/http_stub/server/application.rb

@@ -7,7 +7,8 @@ module HttpStub
 
       register Sinatra::Partial
 
-      enable :dump_errors, :logging, :partial_underscores
+      enable  :dump_errors, :logging, :partial_underscores
+      disable :protection
 
       def initialize
         super()
@@ -102,13 +103,7 @@ module HttpStub
         @response_pipeline.process(response)
       end
 
-      helpers do
-
-        def h(text)
-          Rack::Utils.escape_html(text)
-        end
-
-      end
+      helpers { include HttpStub::Server::ApplicationHelpers }
 
     end
 

data/lib/http_stub/server/application_helpers.rb

@@ -0,0 +1,21 @@
+module HttpStub
+  module Server
+
+    module ApplicationHelpers
+
+      def h(text)
+        Rack::Utils.escape_html(text)
+      end
+
+      def pp(text)
+        begin
+          text ? JSON.pretty_generate(JSON.parse(text)) : ""
+        rescue JSON::ParserError
+          text
+        end
+      end
+
+    end
+
+  end
+end

data/lib/http_stub/server/views/_match.haml

@@ -1,16 +1,7 @@
-%table{ class: :match }
-  %tr
-    %td Type:
-    %td Match
-  %tr
-    %td Request:
-    %td= partial :request, locals: { request: match.request }
-  %tr
-    %td Response:
-    %td
-      %table{ class: :response }
-        = partial :response, locals: { response: match.stub.response }
-  %tr
-    %td Stub:
-    %td
-      %a{ href: match.stub.stub_uri, class: :stub } Stub
+%article
+  %h3 Request
+  = partial :request, locals: { request: match.request }
+  %h3 Response
+  =partial :response, locals: { response: match.stub.response }
+  %h3 Matched Stub
+  %a{ href: match.stub.stub_uri, class: [:stub, :link] } Match

data/lib/http_stub/server/views/_request.haml

@@ -1,16 +1,16 @@
 %table
   %tr
-    %td URI:
+    %td.title URI:
     %td=h(request.uri)
   %tr
-    %td Method:
+    %td.title Method:
     %td=request.method
   %tr
-    %td Headers:
+    %td.title Headers:
     %td=h(request.headers)
   %tr
-    %td Parameters:
+    %td.title Parameters:
     %td=h(request.parameters)
   %tr
-    %td Body:
+    %td.title Body:
     %td=h(request.body)

data/lib/http_stub/server/views/_response.haml

@@ -1,9 +1,14 @@
-%tr
-  %td Status:
-  %td=response.status
+%table
   %tr
-    %td Headers:
+    %td.title Status:
+    %td=response.status
+  %tr
+    %td.title Headers:
     %td=h(response.headers)
   %tr
-    %td Body:
-    %td=partial "#{response.type}_response".to_sym, locals: { response: response }
+    %td.title Body:
+    %td
+      %pre=partial "#{response.type}_response".to_sym, locals: { response: response }
+  %tr
+    %td.title Delay:
+    %td=h(response.delay_in_seconds)

data/lib/http_stub/server/views/_stub.haml

@@ -1,18 +1,8 @@
-%table
-  %tr
-    %td Request:
-    %td=partial :request, locals: { request: the_stub }
-  %tr
-    %td Response:
-    %td
-      %table
-        =partial :response, locals: { response: the_stub.response }
-        %tr
-          %td Delay:
-          %td=h(the_stub.response.delay_in_seconds)
-  %tr
-    %td Triggers:
-    %td
-      - the_stub.triggers.each do |trigger|
-        = partial :stub, locals: { the_stub: trigger }
-        %br
+%article
+  %h3 Request
+  = partial :request, locals: { request: the_stub }
+  %h3 Response
+  =partial :response, locals: { response: the_stub.response }
+  %h3 Triggers
+  - the_stub.triggers.each do |trigger|
+    = partial :stub, locals: { the_stub: trigger }

data/lib/http_stub/server/views/_text_response.haml

@@ -1 +1 @@
-=h(response.body)
+=pp(response.body)

data/lib/http_stub/server/views/application.sass

@@ -1,10 +1,54 @@
-table
-  :border 1px solid black
+$color_highlight: #D7B2EA
+$color_background: #EEEEEE
+$color_content_bg: white
+$color_dark_border: grey
+$color_border: lightgrey
+$color_font: black
+$color_peach: #FFF6EF
+
+body
+  :background $color_background
+  :font-family "Helvetica Neue", Helvetica, Arial, sans-serif
+  :display flex
+  :flex-direction column
+  :align-items center
+
+header
+  :padding-left 1rem
+
+section
+  :max-width 800px
+  :border-radius 10px
+  :background white
+  :padding 1rem
+  :display inline-block
 
 table
-  table
-    :border 1px solid grey
+  :padding 1rem
+  :border-collapse collapse
+  tr
+    :background $color_content_bg
+    td
+      :padding 1rem
+      :max-width 600px
+      &.name
+        :font-weight bold
+      &.title
+        :font-weight bold
+
+.header-rule
+  :border-bottom 1px solid $color_border
+
+a.link
+  :border 1px solid $color_dark_border
+  :border-radius 3px
+  :padding 0.5rem
+  :text-decoration none
+  :color $color_font
+  &:hover
+    :background $color_highlight
 
-table.scenarios
-  tr:hover
-    :background lightgray
+pre
+  :white-space pre-wrap !important
+  :word-wrap break-word !important
+  :max-width 600px

data/lib/http_stub/server/views/index.haml

@@ -1,6 +1,6 @@
 %h1 http_stub diagnostics
-%a{ href: "/http_stub/stubs", id: :stubs } List Stubs
+%a{ href: "/http_stub/stubs", id: :stubs, class: :link } List Stubs
 %br
-%a{ href: "/http_stub/scenarios", id: :scenarios } List Scenarios
+%a{ href: "/http_stub/scenarios", id: :scenarios, class: :link } List Scenarios
 %br
-%a{ href: "/http_stub/stubs/matches", id: :stub_matches } List Stub Matches & Misses
+%a{ href: "/http_stub/stubs/matches", id: :stub_matches, class: :link } List Stub Matches & Misses

data/lib/http_stub/server/views/matches.haml

@@ -0,0 +1,5 @@
+%header
+  %h1 Matches
+%section
+  - matches.each do |match|
+    = partial :match, locals: { match: match }

data/lib/http_stub/server/views/scenario.haml

@@ -1,17 +1,12 @@
-%table{ class: :scenario }
-  %tr
-    %td Name:
-    %td
-      %a{ href: scenario.links.activate, class: :activate_scenario, data: { name: scenario.name } }= scenario.name
-  %tr
-    %td Stubs:
-    %td
-      - scenario.stubs.each do |the_stub|
-        = partial :stub, locals: { the_stub: the_stub }
-  %tr
-    %td Triggered Scenario's:
-    %td
-      - scenario.triggered_scenarios.each do |triggered_scenario|
-        %a{ href: triggered_scenario.links.detail, class: :triggered_scenario_detail }= triggered_scenario.name
-  %br
+%header
+  %h1= scenario.name
+%section
+  %a{ href: scenario.links.activate, class: [:scenario, :link, :activate_scenario], data: { name: scenario.name } } Activate
+  %h2 Stubs
+  - scenario.stubs.each do |the_stub|
+    = partial :stub, locals: { the_stub: the_stub }
+  - if scenario.triggered_scenarios.present?
+    %h2 Triggered Scenarios
+    - scenario.triggered_scenarios.each do |triggered_scenario|
+      %a{ href: triggered_scenario.links.detail, class: :triggered_scenario_detail }= triggered_scenario.name
 = partial :activate_scenario

data/lib/http_stub/server/views/scenarios.haml

@@ -1,10 +1,12 @@
-%h1 Scenarios
-%table{ class: :scenarios }
-  - scenarios.each do |scenario|
-    %tr
-      %td{ class: :scenario_name }= scenario.name
-      %td
-        %a{ href: scenario.links.activate, class: :activate_scenario, data: { name: scenario.name } } Activate
-      %td
-        %a{ href: scenario.links.detail, class: :view_scenario } View Detail
+%header
+  %h1 Scenarios
+%section
+  %table{ class: :scenarios }
+    - scenarios.each do |scenario|
+      %tr
+        %td{ class: [:scenario_name, :'header-rule'] }= scenario.name
+        %td{ class: :'header-rule' }
+          %a{ href: scenario.links.activate, class: [:scenario, :link, :activate_scenario], data: { name: scenario.name } } Activate
+        %td{ class: :'header-rule' }
+          %a{ href: scenario.links.detail, class: [:scenario, :link, :view_scenario] } View Detail
 = partial :activate_scenario

data/lib/http_stub/server/views/stubs.haml

@@ -1,4 +1,6 @@
-%h1 Stubs
-- stubs.each do |the_stub|
-  = partial :stub, locals: { the_stub: the_stub }
-  %br
+%header
+  %h1 Stubs
+%section
+  - stubs.each do |the_stub|
+    = partial :stub, locals: { the_stub: the_stub }
+    .header-rule

data/lib/http_stub/version.rb

@@ -1,3 +1,3 @@
 module HttpStub
-  VERSION = "0.22.2".freeze
+  VERSION = "0.22.3".freeze
 end

data/spec/acceptance/scenario_spec.rb

@@ -1,7 +1,7 @@
 describe "Scenario acceptance" do
   include_context "configurer integration"
 
-  context "when a configurer that contains scenario's is initialized" do
+  context "when a configurer that contains scenarios is initialized" do
 
     let(:configurer)  { HttpStub::Examples::ConfigurerWithTrivialScenarios.new }
 

data/spec/lib/http_stub/configurer/request/stub_response_spec.rb

@@ -45,8 +45,32 @@ describe HttpStub::Configurer::Request::StubResponse do
 
     end
 
-    it "has an entry for the response body argument" do
-      expect(subject).to include(body: fixture.body)
+    context "when a response body argument is provided" do
+
+      before(:example) do
+        fixture.body = "some body"
+        fixture.json = nil
+      end
+
+      it "has a response body entry that contains the body argument" do
+        expect(subject).to include(body: fixture.body)
+      end
+
+    end
+
+    context "when a response json argument is provided" do
+
+      let(:json_object) { { some_key: "some value" } }
+
+      before(:example) do
+        fixture.body = nil
+        fixture.json = json_object
+      end
+
+      it "has a response body entry that contains the json argument converted to JSON" do
+        expect(subject).to include(body: json_object.to_json)
+      end
+
     end
 
     context "when a delay option is provided" do

data/spec/lib/http_stub/server/application_helpers_spec.rb

@@ -0,0 +1,53 @@
+describe HttpStub::Server::ApplicationHelpers do
+
+  let(:helpers) { Class.new.extend(described_class) }
+
+  describe "::h" do
+
+    let(:text) { "<tag>Some text</tag>" }
+
+    subject { helpers.h(text) }
+
+    it "should escape the provided HTML" do
+      expect(subject).to eq("&lt;tag&gt;Some text&lt;&#x2F;tag&gt;")
+    end
+
+  end
+
+  describe "::pp" do
+
+    subject { helpers.pp(text) }
+
+    context "when the text is JSON" do
+
+      let(:text) { "{\"key\":\"value\"}" }
+
+      it "returns a pretty JSON string" do
+        expect(subject).to eql("{\n  \"key\": \"value\"\n}")
+      end
+
+    end
+
+    context "when the text is not JSON" do
+
+      let(:text) { "some text" }
+
+      it "returns the string unchanged" do
+        expect(subject).to eql(text)
+      end
+
+    end
+
+    context "when the text is nil" do
+
+      let(:text) { nil }
+
+      it "returns an empty string" do
+        expect(subject).to eql("")
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/http_stub/server/application_integration_spec.rb

@@ -179,11 +179,11 @@ describe HttpStub::Server::Application, "when the server is running" do
         end
 
         it "returns a response whose body contains the response body of stub returning JSON" do
-          expect(response.body).to match(/#{escape_html({ "key" => "JSON body" }.to_json)}/)
+          expect(response.body).to match(/#{encode_whitespace(JSON.pretty_generate({ key: "JSON body" }))}/)
         end
 
         it "returns a response whose body contains the response body of stub returning HTML" do
-          expect(response.body).to match(/#{escape_html("<html><body>HTML body</body></html>")}/)
+          expect(response.body).to match(/#{encode_whitespace("<html><body>HTML body</body></html>")}/)
         end
 
         it "returns a response whose body contains the response body of a stub returning a file" do
@@ -340,11 +340,11 @@ describe HttpStub::Server::Application, "when the server is running" do
           end
 
           it "returns a response whose body supports JSON responses" do
-            expect(response.body).to match(/#{escape_html({ "key" => "JSON body" }.to_json)}/)
+            expect(response.body).to match(/#{encode_whitespace(JSON.pretty_generate({ "key" => "JSON body" }))}/)
           end if stub_number == 1
 
           it "returns a response whose body supports HTML responses" do
-            expect(response.body).to match(/#{escape_html("<html><body>HTML body</body></html>")}/)
+            expect(response.body).to match(/#{encode_whitespace("<html><body>HTML body</body></html>")}/)
           end if stub_number == 2
 
           it "returns a response whose body supports file responses" do

data/spec/lib/http_stub/server/application_spec.rb

@@ -298,4 +298,8 @@ describe HttpStub::Server::Application do
 
   end
 
+  it "disables all standard HTTP security measures to allow stubs full control of responses" do
+    expect(app.settings.protection).to eql(false)
+  end
+
 end

data/spec/lib/http_stub/server/scenario/activator_spec.rb

@@ -56,7 +56,7 @@ describe HttpStub::Server::Scenario::Activator do
         subject
       end
 
-      context "when the triggered scenario's are found" do
+      context "when the triggered scenarios are found" do
 
         class HttpStub::Server::Scenario::ActivatorRetainingActivateArgs < HttpStub::Server::Scenario::Activator
 
@@ -76,7 +76,7 @@ describe HttpStub::Server::Scenario::Activator do
 
         let(:activator_class) { HttpStub::Server::Scenario::ActivatorRetainingActivateArgs }
 
-        it "activates the scenario's" do
+        it "activates the scenarios" do
           expected_activate_args = triggered_scenarios.reduce([ [ scenario, logger ] ]) do |result, triggered_scenario|
             result << [ triggered_scenario, logger ]
           end

data/spec/spec_helper.rb

@@ -50,5 +50,6 @@ require_relative 'support/http_stub/server/stub/match/result_fixture'
 require_relative 'support/http_stub/stub_fixture'
 require_relative 'support/http_stub/scenario_fixture'
 require_relative 'support/http_stub/empty_configurer'
+require_relative 'support/html_helpers'
 require_relative 'support/server_integration'
 require_relative 'support/configurer_integration'

data/spec/support/html_helpers.rb

@@ -0,0 +1,5 @@
+module HtmlHelpers
+  include Haml::Helpers
+
+  alias_method :encode_whitespace, :preserve
+end

data/spec/support/server_integration.rb

@@ -1,5 +1,6 @@
 shared_context "server integration" do
   include Rack::Utils
+  include HtmlHelpers
 
   before(:context) do
     @pid = Process.spawn("rake example_server:start:foreground --trace")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_stub
 version: !ruby/object:Gem::Version
-  version: 0.22.2
+  version: 0.22.3
 platform: ruby
 authors:
 - Matthew Ueckerman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -137,20 +137,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: travis-lint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -249,20 +235,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 description: fakeweb for a HTTP server, informing it to stub / fake responses
 email: matthew.ueckerman@myob.com
 executables: []
@@ -302,6 +302,7 @@ files:
 - "./lib/http_stub/rake/server_tasks.rb"
 - "./lib/http_stub/rake/task_generators.rb"
 - "./lib/http_stub/server/application.rb"
+- "./lib/http_stub/server/application_helpers.rb"
 - "./lib/http_stub/server/daemon.rb"
 - "./lib/http_stub/server/formatted_hash.rb"
 - "./lib/http_stub/server/header_parser.rb"
@@ -356,6 +357,7 @@ files:
 - "./lib/http_stub/server/views/index.haml"
 - "./lib/http_stub/server/views/layout.haml"
 - "./lib/http_stub/server/views/match_results.haml"
+- "./lib/http_stub/server/views/matches.haml"
 - "./lib/http_stub/server/views/scenario.haml"
 - "./lib/http_stub/server/views/scenarios.haml"
 - "./lib/http_stub/server/views/stub.haml"
@@ -402,6 +404,7 @@ files:
 - "./spec/lib/http_stub/rake/server_daemon_tasks_smoke_spec.rb"
 - "./spec/lib/http_stub/rake/server_tasks_smoke_spec.rb"
 - "./spec/lib/http_stub/rake/server_tasks_spec.rb"
+- "./spec/lib/http_stub/server/application_helpers_spec.rb"
 - "./spec/lib/http_stub/server/application_integration_spec.rb"
 - "./spec/lib/http_stub/server/application_spec.rb"
 - "./spec/lib/http_stub/server/daemon_integration_spec.rb"
@@ -450,6 +453,7 @@ files:
 - "./spec/resources/sample.txt"
 - "./spec/spec_helper.rb"
 - "./spec/support/configurer_integration.rb"
+- "./spec/support/html_helpers.rb"
 - "./spec/support/http_stub/empty_configurer.rb"
 - "./spec/support/http_stub/scenario_fixture.rb"
 - "./spec/support/http_stub/server/request_fixture.rb"
@@ -523,6 +527,7 @@ test_files:
 - "./spec/lib/http_stub/rake/server_daemon_tasks_smoke_spec.rb"
 - "./spec/lib/http_stub/rake/server_tasks_smoke_spec.rb"
 - "./spec/lib/http_stub/rake/server_tasks_spec.rb"
+- "./spec/lib/http_stub/server/application_helpers_spec.rb"
 - "./spec/lib/http_stub/server/application_integration_spec.rb"
 - "./spec/lib/http_stub/server/application_spec.rb"
 - "./spec/lib/http_stub/server/daemon_integration_spec.rb"
@@ -571,6 +576,7 @@ test_files:
 - "./spec/resources/sample.txt"
 - "./spec/spec_helper.rb"
 - "./spec/support/configurer_integration.rb"
+- "./spec/support/html_helpers.rb"
 - "./spec/support/http_stub/empty_configurer.rb"
 - "./spec/support/http_stub/scenario_fixture.rb"
 - "./spec/support/http_stub/server/request_fixture.rb"