http-fake 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f068555328be1d8bab977bd4ada2cbfbc67691714681cbf0065a6cdb5ae797bf
-  data.tar.gz: c28eecb527f8d7588036974c6af8bc87015b4aea516c36c59f5a6a4e5e46789e
+  metadata.gz: ab44f133bb42373588a38aef8c48b9e649617b6a8fa8d1e8583b048c6ac9384c
+  data.tar.gz: e12977c2e7fdefe4bc6a89cd7f6602c3e2f55e690730d97d4ec20f524db51399
 SHA512:
-  metadata.gz: c175d8a7f3c1d910bf4fdb05189bdf509db4f1a6542a678edf521f7ff889378938214408eee380fc8b00e749e8e030a93d2717b69de50c26e54cdf35912402cd
-  data.tar.gz: 7a9e1828ee3f847caedae2d2f7d73b8ccd7adfba6fa3ec837057ed5fec5c7d64b7c68bcfac854d8822ed33e92e614eebd92f799989e290d4a59be2be3a12f661
+  metadata.gz: 3a80c0cba96b9b5f7c55b9de62553b08589a27d864121c6faed25a2b0de53dbbe96a24d0a2f68af31cf34a5a11dcd89dab59b021cb903c8f3c486381efd57dd9
+  data.tar.gz: a8f80331944f0eaaa1a248bee50c102170c235d2976c2d23df281124f559d26df0db5c2aac9ee185b602591836e51221b4b0a8fb7854a9cb9dacb994c7984e88

data/README.adoc

@@ -6,23 +6,16 @@
 
 = HTTP Fake
 
-HTTP Fake is a companion to the {http_link} gem when you want a convenient way to test HTTP requests
-by swapping out your _real_ HTTP client with this _fake_ HTTP client. Using a fake allows you to
-speed up and simplify your test suite by answering fake responses without hitting a live API. You'll
-still want to test against a live API, eventually, within your integration tests but at a lower
-level, like your unit tests, you can use this gem instead. This gem is particularly useful when
-using _Dependency Injection_, especially when coupled with the
-link:https://www.alchemists.io/projects/auto_injector[Auto Injector] gem.
+HTTP Fake is a companion to the {http_link} gem when you want a convenient way to test HTTP requests by swapping out your _real_ HTTP client with this _fake_ HTTP client. Using a fake allows you to improve the performance of your test suite by answering fake responses without hitting a live API. You'll still want to test against a live API, eventually, within your integration tests but at a lower level, like your unit tests, you can use this gem instead. This gem is particularly useful when using _Dependency Injection_, especially when coupled with the link:https://www.alchemists.io/projects/auto_injector[Auto Injector] gem.
 
 toc::[]
 
 == Features
 
 * Provides a fake HTTP client as a testing companion to the {http_link} gem.
-* Supports the following HTTP verbs: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, and
-  TRACE.
+* Supports the following HTTP verbs: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, and TRACE.
 * Uses a simple DSL for defining HTTP endpoints, headers, bodies, and statuses.
-* Works well with objects that use _Dependency Injection_.
+* Works well with objects that use Dependency Injection.
 * Speeds up your test suite when you don't need a live API.
 
 == Requirements
@@ -44,9 +37,7 @@ only meant to aid in writing specs.
 
 == Usage
 
-This gem works with any test framework and, for demonstration purposes, we'll assume you're using
-link:https://rspec.info[RSpec]. You can adapt these examples to your test framework of choice. A
-simple spec might look the this:
+This gem works with any test framework. For demonstration purposes, we'll assume you're using link:https://rspec.info[RSpec] but you can adapt these examples to your test framework of choice. A simple spec might look like this:
 
 [source,ruby]
 ----
@@ -79,16 +70,9 @@ RSpec.describe Endpoint do
 end
 ----
 
-As you can see, our _fake_ `http` client has been defined and injected into our `endpoint` subject.
-When the fake is defined, the path, headers, status, and body are registered as well. This
-allows the fake to match against your real implementation's URL path and swap out making a real HTTP
-call with the canned response defined by the fake. When asking the endpoint for its customers, we
-get back the response as defined by the fake with all of the normal capabilities as if we were using
-the real HTTP client. This works because this gem uses
-link:https://github.com/sinatra/mustermann[Mustermann] for pattern matching against the routes you
-define. This means you can defined routes that are explicit -- as shown above -- or fuzzy based on
-your testing needs. You can also define multiple endpoints for the same fake in case your
-implementation needs to test multiple endpoints at once. Example:
+As you can see, our _fake_ `http` client has been defined and injected into our `endpoint` subject. When the fake is defined, the path, headers, status, and body are registered as well. This allows the fake to match against your real implementation's URL path and swap out acquiring a real HTTP response with fake response instead. When asking the endpoint for its customers, we get back the fake response with all of the normal capabilities of the real HTTP client. This works because this gem uses link:https://github.com/sinatra/mustermann[Mustermann] for pattern matching against the routes you define and also means you can define routes that are explicit -- as shown above -- or fuzzy based on your testing needs.
+
+Here's an example where multiple endpoints are defined for the same fake in case your implementation needs to test multiple endpoints at once:
 
 [source,ruby]
 ----
@@ -134,13 +118,12 @@ let :http do
 end
 ----
 
-Lastly, in the examples above, I've been showing how you can work with JSON responses but you might
-want to use other MIME types. For example, XML:
+So far you've only seen usage of JSON responses but you might want to use other MIME types. For example, XML:
 
 [source,ruby]
 ----
 HTTP::Fake::Client.new do
-  get "/customers" do
+  get "/customers/1" do
     headers["Content-Type"] = "application/xml"
     status 200
 
@@ -164,6 +147,33 @@ HTTP::Fake::Client.new do
     status 200
 
     "1 - Jill Smith"
+    "2 - Tom Bombadill"
+  end
+end
+----
+
+You might even want to import a fixture which is especially handy when the response is verbose or needs to be reused in different ways. Example:
+
+[source,ruby]
+----
+# Single
+HTTP::Fake::Client.new do
+  get "/customers/1" do
+    headers["Content-Type"] = "application/json"
+    status 200
+    Bundler.root.join("spec/support/fixtures/customer.json").read
+  end
+end
+
+# Multiple
+HTTP::Fake::Client.new do
+  get "/customers" do
+    headers["Content-Type"] = "application/json"
+    status 200
+
+    <<~JSON
+      [#{Bundler.root.join("spec/support/fixtures/customer.json").read}]
+    JSON
   end
 end
 ----

data/http-fake.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "http-fake"
-  spec.version = "0.0.0"
+  spec.version = "0.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/http-fake"
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 3.1"
   spec.add_dependency "http", "~> 5.0"
   spec.add_dependency "mustermann", "~> 1.1"
-  spec.add_dependency "refinements", "~> 9.4"
+  spec.add_dependency "refinements", "~> 9.6"
   spec.add_dependency "zeitwerk", "~> 2.5"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data.tar.gz.sig

@@ -1 +1,4 @@
-���@Fp.�S锡���!���`�)5�[��a�{�o�a�0Ƒ��uwj;WH�49G~t	��d�n~�#]<�A�ރ-l�v���³k��+�
b9*��]�qg>��%�}W�8���U6.X����4�(�{��j�;
+t�MU�����X�a�8*v�~�lv�*�B��#�2��{
�M9v�=�.�� �83��W��u1����Q#nP)�6E�2�F�с�7��h�d��DI���$̫SFd�����X̛u�byEY�f��w��(rZ��l��/vl����
+~C�<3Q�t�(1a:D�PDE.���5eȡ����S��x��Q��,iE��\&����7E
+_y�~�<�������
+^��c MK��`��hH,u��A

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-fake
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.4'
+        version: '9.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.4'
+        version: '9.6'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.3.18
 signing_key:
 specification_version: 4
 summary: Provides a fake but equivalent implementation of the HTTP gem for test suites.