faraday-hot_mock 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7155695e309162e7cc229f4954856d783aaf0eb628d6308b54cd4dacdd7eedef
-  data.tar.gz: 3fd121884c136ef252c655f649f68bf2b235d76eea1e55cda5e70c9ccde0d5f2
+  metadata.gz: ca41f6d974866b895fa2ce0da58d30c61120d63c342dcb39d353346156692abe
+  data.tar.gz: f45729e717e06848776bca596533d8e4af59cf22eebd83ee5a0e4405ff003ec1
 SHA512:
-  metadata.gz: 9723060205d8b5fc9c84b6545fc594a6355f56a0dce8f7a3b938efacd94933b5aefb220be446490fdecacb2632382d546bca2cea6b77410fe41fe5c36ba731ff
-  data.tar.gz: c264d25bf46fe7ca705308bb6af50c69a2488a4adc761a12cc52964214038998b553b9cb9ff93b75b05cd885db3b36af1316da800c9917338da759d82eba8b0b
+  metadata.gz: af9f9770c7e9893202512044fc30502871766c4056541eb3f723fc4975948fa72d6d8567e4a751085dbbfd2f0fbbb0b32bcd4dae06d93862575763e9b1045a57
+  data.tar.gz: f99a15ab120d185c605ba7f9982c1e9925ca9fe8065645152236c3094fc6bcfe5db1878f6a8fcac5f1ae321cad235b97330ba58fe03e735f953882ac15a22f56

data/README.md

@@ -7,9 +7,13 @@ This adapter attempts to make that simpler by parsing YAML files at runtime. If
 _**This adapter is meant for Faraday usage in Rails, not for Faraday that's used in other frameworks or situations.**_
 
 
-## Usage
+## How It Works
+
+When a request is made, Faraday::HotMock checks for the presence of a file named `tmp/mocking-#{Rails.env}.txt`. If that file exists, HotMock is enabled.
+
+When HotMock is enabled, it looks for YAML files in `lib/faraday/mocks/#{Rails.env}`. Each YAML file can contain one or more mock definitions.
 
-Create YAML files in `lib/faraday/mocks/#{Rails.env}` - the name of the files doesn't matter, and you can nest them in subdirectories.
+For the YAML files in `lib/faraday/mocks/#{Rails.env}`, the name of the files don't matter, and you can nest them in subdirectories.
 
 This means that if you have a Staging environment, or a UAT environment along with a Demo and Development environment, you can mock each separately.
 
@@ -29,7 +33,10 @@ And then execute:
 $ bundle
 ```
 
-Then, use this adapter in your middleware pipeline, making sure that it's last:
+
+## Usage
+
+Add this adapter to your middleware pipeline, making sure that it's last:
 
 ```ruby
 @conn = Faraday.new(url: "https://dog.ceo/api/") do |faraday|
@@ -59,6 +66,27 @@ Now, create the directory `lib/faraday/mocks/` and a subdirectory for each envir
 
 Consider adding these directories to .gitignore unless you want mocks to be shared.
 
+### Convenience Methods
+
+You can enable or disable mocking programmatically with these methods:
+
+```ruby
+Faraday::HotMock.enable!   # creates tmp/mocking-#{Rails.env}.txt
+Faraday::HotMock.disable!  # deletes tmp/mocking-#{Rails.env}.txt
+Faraday::HotMock.toggle!  # creates tmp/mocking-#{Rails.env}.txt if missing, deletes if present
+```
+
+In addition, you can check if mocking is enabled with:
+
+```ruby
+Faraday::HotMock.enabled?  # returns true/false;
+Faraday::HotMock.disabled?  # returns true/false;
+```
+
+These methods have limited use, but can be helpful in scripting scenarios.
+
+### Defining Mocks
+
 ```yaml
 # lib/faraday/mocks/development/vendor_name_mocks.yml
 - url_pattern: vendorname.com.*/endpoint
@@ -97,6 +125,7 @@ If you want to disable mocks, you can:
 - Delete the entry
 - Delete the file(s)
 - Delete the directory
+- Use the [convenience methods](#convenience-methods)
 
 If you'd rather keep the file(s) around, just delete `tmp/mocking-development.txt`. That will globally disable any mocked responses.
 

data/lib/faraday/hot_mock/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module HotMock
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/faraday/hot_mock.rb

@@ -5,6 +5,31 @@ require "faraday"
 
 module Faraday
   module HotMock
+    module_function
+
+    def disable!
+      FileUtils.rm_f(Rails.root.join("tmp/mocking-#{Rails.env}.txt"))
+    end
+
+    def disabled?
+      !File.exist?(Rails.root.join("tmp/mocking-#{Rails.env}.txt"))
+    end
+
+    def enable!
+      FileUtils.touch(Rails.root.join("tmp/mocking-#{Rails.env}.txt"))
+    end
+
+    def enabled?
+      File.exist?(Rails.root.join("tmp/mocking-#{Rails.env}.txt"))
+    end
+
+    def toggle!
+      if File.exist?(Rails.root.join("tmp/mocking-#{Rails.env}.txt"))
+        disable!
+      else
+        enable!
+      end
+    end
   end
 end
 

metadata

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