wiremock_mapper 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3fdaf71440c51a4648dcc4534f688c62abe7755
-  data.tar.gz: 7af614da1cda843e0748057ac7f45e50180b091d
+  metadata.gz: c8b8dde11f7b190ebf968785989ed808421d8856
+  data.tar.gz: '08a392c0088c3190258fd8894e06a6301a603e35'
 SHA512:
-  metadata.gz: 63e5efb18734e6e456a31b7843565f86c865a189b340348acc0608bf89e323ee3b5ac8cc9a1e708838093498ac75cd8bee08ddfad15836249126e50e81d531a7
-  data.tar.gz: f9102da2871d5be756d3c895c790c2ec4b1ddee258299610a2bc82b8a3cc725b7af4aee647f955e14dac2f1e40b86eb026ce3c5497c946193e71134160ba7545
+  metadata.gz: 88ad4b6f724bb95ff9af529bb39c371ba1bf1a613ebeba7f7ee83aa07af3b5d6fbe2105d3aff875075a802b8add0a13a77b2295ce05e5a4927a2aba2d2e54c54
+  data.tar.gz: 76b57620e1af66676ab01f67e0b7f2a516656e50fe12e863dfcfac8f69faac647ab84a368a100f91c0797f6be9cc69561b346097465685f50772cf32bae04e9b

data/.rubocop.yml

@@ -17,3 +17,6 @@ Style/Documentation:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]
 
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']

data/lib/configuration.rb

@@ -5,13 +5,14 @@ require_relative 'builders/scenario_builder'
 module WireMockMapper
   class Configuration
     @wiremock_url = ''
+    @wiremock_headers = {}
 
     @request_builder = Builders::RequestBuilder.new
     @response_builder = Builders::ResponseBuilder.new
     @scenario_builder = Builders::ScenarioBuilder.new
 
     class << self
-      attr_reader :request_builder, :response_builder, :wiremock_url, :scenario_builder
+      attr_reader :request_builder, :response_builder, :wiremock_url, :wiremock_headers, :scenario_builder
 
       # Add mappings to include for all future mappings
       def create_global_mapping
@@ -29,6 +30,12 @@ module WireMockMapper
       def set_wiremock_url(url)
         @wiremock_url = url
       end
+
+      # Set the WireMock headers
+      # @param headers [hash] all the header that we need to set for wiremock
+      def set_wiremock_headers(headers)
+        @wiremock_headers = headers
+      end
     end
   end
 end

data/lib/wiremock_mapper.rb

@@ -40,6 +40,10 @@ module WireMockMapper
     WIREMOCK_CLEAR_MAPPINGS_PATH = "#{WIREMOCK_MAPPINGS_PATH}/reset".freeze
     WIREMOCK_RESET_SCENARIOS_PATH = '__admin/scenarios/reset'.freeze
 
+    def headers
+      { 'Content-Type' => 'application/json' }.merge(Configuration.wiremock_headers)
+    end
+
     def deep_clone(object)
       Marshal.load(Marshal.dump(object))
     end
@@ -48,7 +52,7 @@ module WireMockMapper
       uri = URI([url, WIREMOCK_CLEAR_MAPPINGS_PATH].join('/'))
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.port == 443
-      request = Net::HTTP::Post.new(uri.path)
+      request = Net::HTTP::Post.new(uri.path, headers)
       http.request(request)
     end
 
@@ -56,7 +60,7 @@ module WireMockMapper
       uri = URI([url, WIREMOCK_MAPPINGS_PATH, mapping_id].join('/'))
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.port == 443
-      request = Net::HTTP::Delete.new(uri.path)
+      request = Net::HTTP::Delete.new(uri.path, headers)
       http.request(request)
     end
 
@@ -64,7 +68,7 @@ module WireMockMapper
       uri = URI([url, WIREMOCK_MAPPINGS_PATH].join('/'))
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.port == 443
-      request = Net::HTTP::Post.new(uri.path, 'Content-Type' => 'application/json')
+      request = Net::HTTP::Post.new(uri.path, headers)
       request.body = body.to_json
       http.request(request)
     end
@@ -73,7 +77,7 @@ module WireMockMapper
       uri = URI([url, WIREMOCK_RESET_SCENARIOS_PATH].join('/'))
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.port == 443
-      request = Net::HTTP::Post.new(uri.path)
+      request = Net::HTTP::Post.new(uri.path, headers)
       http.request(request)
     end
   end

data/spec/configuration_spec.rb

@@ -24,4 +24,11 @@ describe WireMockMapper::Configuration do
       expect(WireMockMapper::Configuration.wiremock_url).to eq('http://whereever.com')
     end
   end
+
+  describe 'wiremock_headers' do
+    it 'sets the wiremock headers' do
+      WireMockMapper::Configuration.set_wiremock_headers({ 'Authorization' => 'Bearer ABC123' })
+      expect(WireMockMapper::Configuration.wiremock_headers).to eq({ 'Authorization' => 'Bearer ABC123' })
+    end
+  end
 end

data/spec/wiremock_mapper_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe WireMockMapper do
   before(:each) do
     WireMockMapper::Configuration.reset_global_mappings
+    WireMockMapper::Configuration.set_wiremock_headers({})
   end
 
   describe 'create_mapping' do
@@ -31,6 +32,37 @@ describe WireMockMapper do
       expect(stub).to have_been_requested
     end
 
+    it 'posts custom header to the wiremock url' do
+      url = 'http://nowhere.com'
+      expected_request_body = { request: { 'method' => 'POST',
+                                           'url' => '/some/url',
+                                           'headers' => { 'some_global_header' => { 'equalTo' => 'global value' },
+                                                          'some_header' => { 'equalTo' => 'some header value' } },
+                                           'bodyPatterns' => [
+                                             { 'matches' => 'some request body' }
+                                           ] },
+                                response: { 'body' => 'some response body' } }
+
+      stub = stub_request(:post, "#{url}/__admin/mappings").with(body: expected_request_body)
+                                                           .to_return(body: { id: 'whatevs' }.to_json)
+
+      WireMockMapper::Configuration.create_global_mapping do |request|
+        request.with_header('some_global_header').equal_to('global value')
+      end
+
+      WireMockMapper::Configuration.set_wiremock_headers({ 'header1' => 'header-value1' })
+
+      WireMockMapper.create_mapping(url) do |request, respond|
+        request.is_a_post
+               .with_url.equal_to('/some/url')
+               .with_header('some_header').equal_to('some header value')
+               .with_body.matching('some request body')
+        respond.with_body('some response body')
+      end
+
+      expect(stub).to have_requested(:post, "#{url}/__admin/mappings").with(headers: { 'header1' => 'header-value1' })
+    end
+
     it 'posts the correct json with configured global mappings to the wiremock url' do
       url = 'http://nowhere.com'
       expected_request_body = { request: { 'method' => 'POST',
@@ -129,6 +161,19 @@ describe WireMockMapper do
 
       expect(stub).to have_been_requested
     end
+
+    it 'issues a DELETE with custom headers for the supplied mapping id' do
+      mapping_id = 'james-james-james'
+      url = 'http://nowhere.com'
+      stub = stub_request(:delete, "#{url}/__admin/mappings/#{mapping_id}")
+
+      WireMockMapper::Configuration.set_wiremock_headers({ 'header2' => 'header-value2' })
+
+      WireMockMapper.delete_mapping(mapping_id, url)
+
+      expect(stub).to have_requested(:delete, "#{url}/__admin/mappings/#{mapping_id}")
+        .with(headers: { 'header2' => 'header-value2' })
+    end
   end
 
   describe 'clear_mappings' do
@@ -139,5 +184,39 @@ describe WireMockMapper do
 
       expect(stub).to have_been_requested
     end
+
+    it 'POSTS with custom headers to the wiremock __admin/mappings/reset path' do
+      url = 'http://nowhere.com'
+      stub = stub_request(:post, "#{url}/__admin/mappings/reset")
+
+      WireMockMapper::Configuration.set_wiremock_headers({ 'header3' => 'header-value3' })
+
+      WireMockMapper.clear_mappings(url)
+
+      expect(stub).to have_requested(:post,
+                                     "#{url}/__admin/mappings/reset").with(headers: { 'header3' => 'header-value3' })
+    end
+  end
+
+  describe 'reset_scenarios' do
+    it 'POSTS to the wiremock __admin/scenarios/reset path' do
+      url = 'http://nowhere.com'
+      stub = stub_request(:post, "#{url}/__admin/scenarios/reset")
+      WireMockMapper.reset_scenarios(url)
+
+      expect(stub).to have_been_requested
+    end
+
+    it 'POSTS with custom headers to the wiremock __admin/scenarios/reset path' do
+      url = 'http://nowhere.com'
+      stub = stub_request(:post, "#{url}/__admin/scenarios/reset")
+
+      WireMockMapper::Configuration.set_wiremock_headers({ 'header3' => 'header-value3' })
+
+      WireMockMapper.reset_scenarios(url)
+
+      expect(stub).to have_requested(:post,
+                                     "#{url}/__admin/scenarios/reset").with(headers: { 'header3' => 'header-value3' })
+    end
   end
 end

data/wiremock_mapper.gemspec

@@ -1,8 +1,8 @@
-$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 
 Gem::Specification.new do |spec|
   spec.name             = 'wiremock_mapper'
-  spec.version          = '2.2.0'
+  spec.version          = '3.0.0'
   spec.platform         = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.0.0'
   spec.authors          = ['Isaac Datlof']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wiremock_mapper
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Isaac Datlof
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -173,7 +173,7 @@ homepage: http://github.com/ike18t/wiremock_mapper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,9 +188,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.6.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby DSL for setting up WireMock mappings
 test_files: