FEATURE: Allow asserting on requests in tests

lib/webmock/request_registry.rb

@@ -21,6 +21,15 @@ def times_executed(request_pattern)
       end.inject(0) { |sum, (_, times_executed)| sum + times_executed }
     end
 
+    def requests_made
+      to_a
+    end
+
+    def to_a
+      requested_signatures.
+        array
+    end
+
     def to_s
       if requested_signatures.hash.empty?
         "No requests were made."

lib/webmock/request_signature.rb

@@ -44,6 +44,10 @@ def json_headers?
       !!(headers&.fetch('Content-Type', nil)&.start_with?('application/json'))
     end
 
+    def parsed_body
+      JSON.parse(body, symbolize_names: true)
+    end
+
     private
 
     def assign_options(options)

lib/webmock/util/hash_counter.rb

@@ -5,22 +5,36 @@
 module WebMock
   module Util
     class HashCounter
-      attr_accessor :hash
+      attr_accessor :hash, :array
 
       def initialize
         self.hash = Hash.new(0)
         @order = {}
         @max = 0
         @lock = ::Mutex.new
+        self.array = []
+        @request_object_ids = {}
       end
 
       def put(key, num=1)
         @lock.synchronize do
+          store_to_array(key:, num:)
           hash[key] += num
           @order[key] = @max += 1
         end
       end
 
+      def store_to_array(key:, num:)
+        request_object_id = @request_object_ids[key]
+        request_object_id = key.object_id if request_object_id.nil?
+        num.times do
+          array << ObjectSpace._id2ref(request_object_id)
+        rescue RangeError
+          # Points to an invalid or recycled object so ignore
+        end
+        @request_object_ids[key] = key.object_id
+      end
+
       def get(key)
         @lock.synchronize do
           hash[key]

spec/unit/request_registry_spec.rb

@@ -92,4 +92,72 @@
     end
   end
 
+  describe "requests_made" do
+    it "returns the requests made" do
+      request_registry = WebMock::RequestRegistry.instance
+      request_registry.requested_signatures.put(WebMock::RequestSignature.new(:get, "www.example.com"))
+      request_registry.requested_signatures.put(WebMock::RequestSignature.new(:put, "www.example.org"))
+      expect(request_registry.requests_made.count).to eq(2)
+      expect(request_registry.requests_made[0].method).to eq(:get)
+      expect(request_registry.requests_made[0].uri).to eq(Addressable::URI.parse("http://www.example.com/"))
+      expect(request_registry.requests_made[1].method).to eq(:put)
+      expect(request_registry.requests_made[1].uri).to eq(Addressable::URI.parse("http://www.example.org/"))
+    end
+
+    it "returns the headers of the request" do
+      request_registry = WebMock::RequestRegistry.instance
+      request_registry.requested_signatures.put(WebMock::RequestSignature.new(:get, "www.example.com", headers: { 'Content-Type' => 'application/json' }))
+      expect(request_registry.requests_made.first.headers).to eq({ 'Content-Type' => 'application/json' })
+    end
+
+    it "only stores references to existing signatures" do
+      request_registry = WebMock::RequestRegistry.instance
+      signature = WebMock::RequestSignature.new(:get, "www.example.com")
+      duplicate_signature = WebMock::RequestSignature.new(:get, "www.example.com")
+      request_registry.requested_signatures.put(signature)
+      request_registry.requested_signatures.put(duplicate_signature)
+      expect(request_registry.requests_made[0].object_id).to eq(signature.object_id)
+      expect(request_registry.requests_made[1].object_id).to eq(signature.object_id)
+    end
+
+    context "when storing the same signature with a count" do
+      it "adds two references to the signature" do
+        request_registry = WebMock::RequestRegistry.instance
+        signature = WebMock::RequestSignature.new(:get, "www.example.com")
+        request_registry.requested_signatures.put(signature, 2)
+        expect(request_registry.requests_made[0].object_id).to eq(signature.object_id)
+        expect(request_registry.requests_made[1].object_id).to eq(signature.object_id)
+      end
+    end
+
+    context "with a JSON request" do
+      it "returns the parsed JSON body of the request" do
+        request_registry = WebMock::RequestRegistry.instance
+        request_registry.requested_signatures.put(json_request_with_body(a: 1))
+        expect(request_registry.requests_made.first.body).to eq({ a: 1 }.to_json)
+        expect(request_registry.requests_made.first.parsed_body).to eq(a: 1)
+      end
+
+      context "and invalid JSON in the body" do
+        it "crashes" do
+          request_registry = WebMock::RequestRegistry.instance
+          request_registry.requested_signatures.put(json_request_with_raw_body("{ invalid_json }"))
+          expect(request_registry.requests_made.first.body).to eq("{ invalid_json }")
+          expect do
+            request_registry.requests_made.first.parsed_body
+          end.to raise_error JSON::ParserError
+        end
+      end
+    end
+  end
+
+  private
+
+  def json_request_with_body(body)
+    WebMock::RequestSignature.new(:get, "www.example.com", body: JSON.generate(body))
+  end
+
+  def json_request_with_raw_body(body)
+    WebMock::RequestSignature.new(:get, "www.example.com", body: body)
+  end
 end