stubify 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cdf3c98837d99ac32a3638b51ada2857535b84a
-  data.tar.gz: b42efacd614f1adad54dfeecfbc93077509d9f8c
+  metadata.gz: e6608cf445c08d76e4a0e786a72d5edf93a027a1
+  data.tar.gz: c293698b5070df62f1f0bf70e56892881ff1564f
 SHA512:
-  metadata.gz: e24d36514b3f6f23e2c054300ae8fadfa3575e16a59c841083bff1402b37419cc9177008c12b3641c6d330114dff32e444b0c081cc15edfe750b43a579f0c22c
-  data.tar.gz: ac125c537db1958ddcfcfa42b4980cb0bab4d4e40e82e77eb871be40dfb87621b6b1662e90ff13598b8bfb3ffee065ed9fca5acd489b59649eca0745f5817852
+  metadata.gz: 1df5f1ddb5086430488befda366ebe1ffe60bb297e89c9a61715221f0f8c6bc99781f5465196487d149fd819ba47e80944ce63b919531d746f50db5d62eaa8d5
+  data.tar.gz: bd1f256f19e37250e0af0a30e7f1b1fe12b192c863db48c5d2e30d7ab2a42e3af28760d08e826c1aecbd156febe1c08ea673544a6940d8255b88b39d88c68bd0

data/README.md

@@ -26,12 +26,6 @@ Next time a request to `http://localhost:4567/rest_api/user/32325` is made the c
 * Accepts `GET`, `POST`, `PUT` and `DELETE` requests.
 * HTTP headers, query parameters and request bodies are taken into account.
 
-## Roadmap
-
-This is a summary of the ideas which implementation is pending:
-
-* Whitelisting of endpoints to avoid caching.
-
 ## Installation
 
 ```

data/lib/stubify.rb

@@ -18,8 +18,9 @@ module Stubify
         c.syntax = 'server [options]'
         c.description = 'Runs a local environment that will forward the requests received to the host provided. Responses will be cached'
         c.option '--host STRING', String, 'Host the requests will be redirected to. i.e. https://easy-peasy.io'
-        c.option '--directory DIR', String, 'Path where fixtures will be stored. i.e. fixtures/'
         c.option '--port STRING', String, 'Port the local environment will listen to. Default is 4567'
+        c.option '--directory DIR', String, 'Path where fixtures will be stored. i.e. fixtures/'
+        c.option '--whitelist DIR', String, 'Path to the .yaml file with the whitelisted paths'
         c.option '--verbose', 'Increases the amount of information logged'
         c.action do |args, options|
           # Ensure host is set
@@ -31,7 +32,8 @@ module Stubify
           options.default \
             port: '4567',
             directory: 'fixtures',
-            verbose: false
+            verbose: false,
+            whitelisted: parse_whitelist(options.whitelist)
 
           # Set env variables
           ENV['PORT'] = options.port
@@ -46,5 +48,11 @@ module Stubify
       run!
     end
 
+    def parse_whitelist(file_path)
+      require 'yaml'
+      return [] unless !file_path.nil? && Pathname.new(file_path).file?
+      return YAML.load_file(file_path)
+    end
+
   end
 end

data/lib/stubify/io.rb

@@ -9,7 +9,6 @@ module Stubify
 
     def self.write_on_disk(request, body, response)
       path = IO.path_from_request(request)
-      FileUtils.mkdir_p(path)
       file_name = IO.file_name_from_request(request, body)
 
       data = {
@@ -18,6 +17,10 @@ module Stubify
         'body': response.body.to_s
       }
 
+      # Do not persist if path is whitelisted
+      return data if Stubify.options.whitelisted.include?(request.path)
+
+      FileUtils.mkdir_p(path)
       File.open(File.join(path, file_name), "wb") do |file|
         file.puts(data.to_json)
       end
@@ -33,6 +36,10 @@ module Stubify
     end
 
     def self.cached?(request, body)
+      # Do not load cache if path is whitelisted
+      return false if Stubify.options.whitelisted.include?(request.path)
+
+      # Otherwise check there is a cached payload
       path = IO.path_from_request(request)
       file_name = IO.file_name_from_request(request, body)
       return Pathname.new(File.join(path, file_name)).file?

data/lib/stubify/version.rb

@@ -1,6 +1,6 @@
 module Stubify
 
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
     DESCRIPTION = 'Create stub environments the easy way'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stubify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Carlos Vidal