faraday-hot_mock 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56228dde369003b5c2b7a68b7af56e2533c13d07ffc9dc997c8fe3a937c48f55
-  data.tar.gz: bc60f461818b035f6e3d14a28d6b6f9943d47bac85ce398013a91569fba6268f
+  metadata.gz: d42875d59eb57c21511d1c8edb287415cfae818f0a5af8b3be38f06086c8920f
+  data.tar.gz: 22551de3ae9e35709702c762880abbf797407f4e95e4f84a53e6bc3f930c4337
 SHA512:
-  metadata.gz: 6398844d597bda4844ef3967f104dd6300ff9d9226128b34df2ef2ae096e740f0037b9708f53f70acf5151405a581d507a15ff4e3e9db3fc0d590bfabcdd8694
-  data.tar.gz: 3ee86b689589bb1cf24d012a47feddefe1e2d8074497953acf7ee85d1936a02387ec3124b07b2cd366345005a5e5dc73a67507e7b63452f209e05ed226905afa
+  metadata.gz: 8bf83f23c923e2459e5cc1d50005959df3f9113cb029c2cdf28f6a28967f67f2c00003d1ee2f4fcd25a00e2787665ea73056759137266f3e22de604c8cda606e
+  data.tar.gz: 30dbdcccbb2bad3aa706614b4b1b759ec18e7e995e422cf8fa6beb568034940732cce587a345e2874fb2afd68d60e1f308817ce815defdcadb95bed016e6ff5a

data/README.md

@@ -8,15 +8,15 @@ _**This adapter is meant for Faraday usage in Rails, not for Faraday that's used
 
 ## Why Use Faraday::HotMock instead of VCR?
 
-VCR focuses on keeping HTTP requests out of tests - Faraday::HotMock focuses on simulating API responses during development.
+[VCR](https://github.com/vcr/vcr) focuses on keeping HTTP requests out of tests - Faraday::HotMock focuses on simulating API responses during development.
 
-To use VCR in development would require wrapping code in VCR blocks, which must then be undone before deployment. Simple, but tedious and error-prone.
+To use [VCR](https://github.com/vcr/vcr) in development would require wrapping code in [VCR](https://github.com/vcr/vcr) blocks, which must then be undone before deployment. Simple, but tedious and error-prone.
 
 Faraday::HotMock requires no code changes to the application - it doesn't mock anything in production, even if you try. So while the HotMock adapter is "used", it just passes requests to the default or adapter or specified fallback.
 
-VCR works with any HTTP library, Faraday::HotMock only works with Faraday. This is a critical limitation unless you use only or primarily Faraday.
+[VCR](https://github.com/vcr/vcr) works with any HTTP library, Faraday::HotMock only works with Faraday. This is a critical limitation unless you use only or primarily Faraday.
 
-You could, ostensibly, replace VCR with Faraday::HotMock in tests. VCR is battle-tested, well-written and widely used, so it's likely a better choice for testing. But the goal is to make Faraday::HotMock just as useful in all non-production environments.
+You could, ostensibly, replace VCR with Faraday::HotMock in tests. [VCR](https://github.com/vcr/vcr) is battle-tested, well-written and widely used, so it's likely a better choice for testing. But the goal is to make Faraday::HotMock just as useful in all non-production environments.
 
 ## How It Works
 
@@ -81,14 +81,49 @@ It can also be a terrible idea if your mocks are designed for your specific need
 
 It's up to you and your team what makes sense.
 
-In most cases, it makes sense to check in the mocks for the test environment, and ignore all the rest so in most cases you should add to your `.gitignore`:
+In most cases, it makes sense to not check in the mocks for any environment, so in most cases you should add to your `.gitignore`:
 
 ```
 # Ignore Faraday HotMocks except in test env
 lib/faraday/mocks/**
-!lib/faraday/mocks/test
 ```
 
+### Scenarios
+
+You can use directories to conditionally group mocks. For example, you might want a "success" scenario and an "failure" scenario.
+
+To do that, simply create the `/scenarios/success` and `/scenarios/failure` subdirectories within `lib/faraday/mocks/#{Rails.env}/`, and place the appropriate mock files in each, probably with the same endpoints but with different responses.
+
+Then call `Faraday::HotMock.scenario = :success` or `Faraday::HotMock.scenario = :failure` to switch between them.
+
+When a scenario is active, only mocks in that scenario directory will be considered. If no matching mock is found in that scenario, then the real request will be made.
+
+To use the mocks not in the `scenarios` directory again, simply set `Faraday::HotMock.scenario = nil`.
+
+### Testing
+
+In tests, you can certainly use a mocking library of choice. In many cases, that might be easier. This is because Faraday::HotMock is built for quick iteration using runtime-loaded YAML files, which isn't needed in tests.
+
+If instead you want to use Faraday::HotMock, you can create mocked responses by hand, or use `Faraday::HotMock.mock!` to define mocks in a very similar way to other mocking libraries (similar to `stub_request` in WebMock, for example).
+
+The most basic setup would be:
+
+- Call `Faraday::HotMock.enable!` in your test setup
+- Call `Faraday::HotMock.disable!` in your test teardown
+- In a given test/spec or in a method, call `Faraday::HotMock.mock!(method: [method], url_pattern: [url], status: [status code], headers: [headers hash], body: [body])` to define a mock for that test/spec.
+- Remove the mock file in teardown by referencing `Faraday::HotMock.hot_mock_file` (via `File.delete` or `FileUtils.rm`) since you probably don't want them to persist between tests
+
+If you use scenarios, then you can do a bit less:
+
+- Call `Faraday::HotMock.enable!` in your test setup
+- Call `Faraday::HotMock.disable!` in your test teardown
+- Call `Faraday::HotMock.scenario = :your_scenario_name` in a given test/spec
+- Call `Faraday::HotMock.scenario = nil` in your test teardown if using scenarios
+
+Overall, this may be a bit more work but it has the advantage that you can use the same mocking mechanism in both development and testing, which can reduce surprises when moving code between the two.
+
+Small bonus: if you use `Faraday::HotMock` everywhere, you can remove the dependency for whichever mocking library/libraries you were using before.
+
 ### Convenience Methods
 
 You can enable or disable mocking programmatically with these methods:

data/lib/faraday/hot_mock/adapter.rb

@@ -23,11 +23,34 @@ module Faraday
         end
 
         if Faraday::HotMock.enabled? && (mock = Faraday::HotMock.mocked?(method: env.method, url: env.url))
-          save_response(env, mock["status"] || 200, mock["body"] || "", mock["headers"] || {})
+          interpolate(mock, env) if mock_interpolated?(mock)
+
+          save_response(
+            env,
+            mock["status"] || 200,
+            mock["body"] || "",
+            (mock["headers"] || {}).merge("x-hot-mocked" => "true")
+          )
         else
           @fallback_adapter.new(@app, @options).call(env)
         end
       end
+
+      private
+
+      def mock_interpolated?(mock)
+        mock.key?("interpolate") && mock["body"].is_a?(Hash)
+      end
+
+      def interpolate(mock, env)
+        request_hash = JSON.parse(env.request_body) rescue {}
+
+        interpolated_hash = mock["interpolate"].transform_values do |v|
+          v = request_hash[v]
+        end.compact
+
+        mock["body"].merge!(interpolated_hash || {})
+      end
     end
   end
 end

data/lib/faraday/hot_mock/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module HotMock
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/faraday/hot_mock.rb

@@ -7,6 +7,8 @@ module Faraday
   module HotMock
     extend self
 
+    attr_accessor :scenario
+
     def disable!
       FileUtils.rm_f(hot_mocking_file)
     end
@@ -31,7 +33,7 @@ module Faraday
       end
     end
 
-    def delete_mock(method:, url:)
+    def delete(method:, url:)
       return unless File.exist?(hot_mock_file)
 
       mocks = YAML.load_file(hot_mock_file) || []
@@ -42,6 +44,7 @@ module Faraday
     end
 
     def mock!(method:, url:, status:, headers: {}, body: nil)
+      FileUtils.mkdir_p(hot_mock_dir)
       FileUtils.touch(hot_mock_file)
 
       mocks = YAML.load_file(hot_mock_file) || []
@@ -78,7 +81,7 @@ module Faraday
         "method"      => method.to_s.upcase,
         "url_pattern" => url,
         "status"      => response.status,
-        "headers"     => response.headers.to_h.merge("x-hotmock-recorded-at" => Time.now.utc.iso8601),
+        "headers"     => response.headers.to_h.merge("x-hot-mock-recorded-at" => Time.now.utc.iso8601),
         "body"        => response.body
       }
 
@@ -102,7 +105,7 @@ module Faraday
         "method"      => method.to_s.upcase,
         "url_pattern" => url,
         "status"      => response.status,
-        "headers"     => response.headers.to_h.merge("x-hotmock-recorded-at" => Time.now.utc.iso8601),
+        "headers"     => response.headers.to_h.merge("x-hot-mock-recorded-at" => Time.now.utc.iso8601, "x-hot-mock" => "true"),
         "body"        => response.body
       }
 
@@ -115,6 +118,10 @@ module Faraday
       Rails.root.join "lib/faraday/mocks/#{Rails.env}"
     end
 
+    def scenario_dir
+      Rails.root.join "lib/faraday/mocks/#{Rails.env}/scenarios"
+    end
+
     def hot_mocking_file
       Rails.root.join "tmp/mocking-#{Rails.env}.txt"
     end
@@ -137,7 +144,11 @@ module Faraday
     end
 
     def all_hot_mock_files
-      Dir.glob(File.join(hot_mock_dir, "**", "*.{yml,yaml}"))
+      if scenario
+        Dir.glob(File.join(hot_mock_dir, "scenarios", scenario.to_s, "**", "*.{yml,yaml}"))
+      else
+        Dir.glob(File.join(hot_mock_dir, "**", "*.{yml,yaml}")).reject { |path| path.include?("/scenarios/") }
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-hot_mock
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sean Hogge