faraday-hot_mock 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42875d59eb57c21511d1c8edb287415cfae818f0a5af8b3be38f06086c8920f
-  data.tar.gz: 22551de3ae9e35709702c762880abbf797407f4e95e4f84a53e6bc3f930c4337
+  metadata.gz: c7d36fd4d278626550e98a108fb9878190fa829ff10216806897bbcf8601ef20
+  data.tar.gz: 88f1cc037062e2581de849d0043a75f17ef23e5cdbfdb6eabd5311ce90ce0136
 SHA512:
-  metadata.gz: 8bf83f23c923e2459e5cc1d50005959df3f9113cb029c2cdf28f6a28967f67f2c00003d1ee2f4fcd25a00e2787665ea73056759137266f3e22de604c8cda606e
-  data.tar.gz: 30dbdcccbb2bad3aa706614b4b1b759ec18e7e995e422cf8fa6beb568034940732cce587a345e2874fb2afd68d60e1f308817ce815defdcadb95bed016e6ff5a
+  metadata.gz: 2757eff042477296cfc296c8a4c0c2bcab0dd9d411d8406b6147252510ed2cf1a8063d97f2fe754c3195f610ee6e24678766f96a40b0f49f6fc3bcf5555362bb
+  data.tar.gz: c2e8063cd973a938240a2b2835955c80137f50e2f3e4874cebcb9f65a9aa3afacf537a4ef42e19cddb096b3aedf5fceb180458ced84fc3e901a3cb98595da186

data/README.md

@@ -88,9 +88,11 @@ In most cases, it makes sense to not check in the mocks for any environment, so
 lib/faraday/mocks/**
 ```
 
+If you're using scenarios, however, it's probably useful to check in any environment directory that has scenarios since they're only activated when a scenario is directly selected.
+
 ### Scenarios
 
-You can use directories to conditionally group mocks. For example, you might want a "success" scenario and an "failure" scenario.
+You can use directories to conditionally group mocks. For example, you might want a "success" scenario and a "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.
 
@@ -100,6 +102,24 @@ When a scenario is active, only mocks in that scenario directory will be conside
 
 To use the mocks not in the `scenarios` directory again, simply set `Faraday::HotMock.scenario = nil`.
 
+### VCR Mode
+
+VCR mode basically calls `Faraday::HotMock.record` on all requests made until it's turned off. You can start it with:
+
+```ruby
+Faraday::HotMock.vcr = true
+```
+
+Just like using `Faraday::HotMock.record` individually, these mocks are recorded to the main default file (`Faraday::HotMock.hot_mock_file`)
+
+You can also record directly into a scenario, which will create the scenario directory structure, switch the current scenario and begin recording responses. This will continue until you set `Faraday::HotMock.vcr` to `false` or another scenario name.
+
+```ruby
+Faraday::HotMock.vcr = :new_scenario
+```
+
+> NOTE: VCR Mode does not overwrite previously recorded mocks
+
 ### 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.

data/lib/faraday/hot_mock/adapter.rb

@@ -18,19 +18,23 @@ module Faraday
       def call(env)
         super
 
-        if Rails.env.production?
+        if Rails.env.production? || Faraday::HotMock.disabled?
           return @fallback_adapter.new(@app, @options).call(env)
         end
 
-        if Faraday::HotMock.enabled? && (mock = Faraday::HotMock.mocked?(method: env.method, url: env.url))
+        if Faraday::HotMock.vcr && !Faraday::HotMock.mocked?(method: env.method, url: env.url)
+          case Faraday::HotMock.vcr
+          when Symbol, String
+            Faraday::HotMock.record(method: env.method, url: env.url, into_scenario: Faraday::HotMock.vcr)
+          else
+            Faraday::HotMock.record(method: env.method, url: env.url)
+          end
+        end
+
+        if (mock = Faraday::HotMock.mocked?(method: env.method, url: env.url))
           interpolate(mock, env) if mock_interpolated?(mock)
 
-          save_response(
-            env,
-            mock["status"] || 200,
-            mock["body"] || "",
-            (mock["headers"] || {}).merge("x-hot-mocked" => "true")
-          )
+          mock_response!(env, mock)
         else
           @fallback_adapter.new(@app, @options).call(env)
         end
@@ -51,6 +55,15 @@ module Faraday
 
         mock["body"].merge!(interpolated_hash || {})
       end
+
+      def mock_response!(env, mock)
+        save_response(
+          env,
+          mock["status"] || 200,
+          mock["body"] || "",
+          (mock["headers"] || {}).merge(Faraday::HotMock::HEADERS[:mocked] => "true")
+        )
+      end
     end
   end
 end

data/lib/faraday/hot_mock/version.rb

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

data/lib/faraday/hot_mock.rb

@@ -7,7 +7,13 @@ module Faraday
   module HotMock
     extend self
 
-    attr_accessor :scenario
+    attr_accessor :scenario, :vcr
+
+    HEADERS = {
+      recorded: "x-hot-mock-recorded-at",
+      mocked: "x-hot-mocked"
+    }
+    FILE_NAME = "hot_mocks.yml"
 
     def disable!
       FileUtils.rm_f(hot_mocking_file)
@@ -66,22 +72,25 @@ module Faraday
       mocks.find { |entry| entry["method"].to_s.upcase == method.to_s.upcase && Regexp.new(entry["url_pattern"]).match?(url.to_s) } || false
     end
 
-    def record(method:, url:)
+    def record(method:, url:, into_scenario: nil)
+      self.scenario = into_scenario if into_scenario.present?
+
       return false if mocked?(method:, url:)
 
       faraday = Faraday.new
 
       response = faraday.send(method.downcase.to_sym, url)
 
+      FileUtils.mkdir_p(hot_mock_dir)
       FileUtils.touch(hot_mock_file)
 
       hot_mocks = YAML.load_file(hot_mock_file) || []
 
       hot_mocks << {
         "method"      => method.to_s.upcase,
-        "url_pattern" => url,
+        "url_pattern" => url.to_s,
         "status"      => response.status,
-        "headers"     => response.headers.to_h.merge("x-hot-mock-recorded-at" => Time.now.utc.iso8601),
+        "headers"     => response.headers.to_h.merge(HEADERS[:recorded] => Time.now.utc.iso8601),
         "body"        => response.body
       }
 
@@ -103,9 +112,9 @@ module Faraday
 
       hot_mocks << {
         "method"      => method.to_s.upcase,
-        "url_pattern" => url,
+        "url_pattern" => url.to_s,
         "status"      => response.status,
-        "headers"     => response.headers.to_h.merge("x-hot-mock-recorded-at" => Time.now.utc.iso8601, "x-hot-mock" => "true"),
+        "headers"     => response.headers.to_h.merge(HEADERS[:recorded] => Time.now.utc.iso8601, "x-hot-mock" => "true"),
         "body"        => response.body
       }
 
@@ -115,7 +124,11 @@ module Faraday
     end
 
     def hot_mock_dir
-      Rails.root.join "lib/faraday/mocks/#{Rails.env}"
+      if self.scenario
+        Rails.root.join "lib/faraday/mocks/#{Rails.env}/scenarios/#{self.scenario}"
+      else
+        Rails.root.join "lib/faraday/mocks/#{Rails.env}"
+      end
     end
 
     def scenario_dir
@@ -127,7 +140,7 @@ module Faraday
     end
 
     def hot_mock_file
-      Rails.root.join(hot_mock_dir, "hot_mocks.yml")
+      Rails.root.join(hot_mock_dir, FILE_NAME)
     end
 
     def mocks
@@ -144,12 +157,38 @@ module Faraday
     end
 
     def all_hot_mock_files
-      if scenario
-        Dir.glob(File.join(hot_mock_dir, "scenarios", scenario.to_s, "**", "*.{yml,yaml}"))
+      if scenario.present?
+        Dir.glob(File.join(hot_mock_dir, "**", "*.{yml,yaml}"))
       else
         Dir.glob(File.join(hot_mock_dir, "**", "*.{yml,yaml}")).reject { |path| path.include?("/scenarios/") }
       end
     end
+
+    def scenario
+      YAML.load_file(settings_file)["scenario"] rescue nil
+    end
+
+    def scenario=(name)
+      settings = YAML.load_file(settings_file) rescue {}
+
+      settings["scenario"] = name
+      File.write(settings_file, settings.to_yaml)
+    end
+
+    def settings_file
+      Rails.root.join("tmp/hot_mock_settings.yml")
+    end
+
+    def vcr
+      YAML.load_file(settings_file)["vcr"] rescue nil
+    end
+
+    def vcr=(value)
+      settings = YAML.load_file(settings_file) rescue {}
+
+      settings["vcr"] = value
+      File.write(settings_file, settings.to_yaml)
+    end
   end
 end
 

metadata

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