endpointer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed57fed80944f3216675621c478581a387cfadca
-  data.tar.gz: fa510a7ca1aa6a003eab39ff56dd123fad0390bb
+  metadata.gz: 54a06e9c23fe3e2534949eb3592bdb353b94825f
+  data.tar.gz: e63af05bc1595772ab7f240164519d541a417336
 SHA512:
-  metadata.gz: a702ca63c58db74696360affe2be6daeec2d86c7952377d1d72c54d89fb0f15b671b80778b9089c53ed5d3a8c4b6b23b8425625667de5f5013e546f390c786f1
-  data.tar.gz: 777d002c2e8bb5d68a0bec8b12328837930320b4e5a23211878ac48a2c1d79cd5ee30ff40bcb112c4763fbd83aab35ba6fbdc18cf3fb2525b03a6d30d8ed9558
+  metadata.gz: 98b40910be28f25ea528f485160f58784b041ea0635da0b065a120e3ec36d1a9114d238e69a359205b5822e84f5d8bf74437dfbc1e1ffdb91621f7d6bd233703
+  data.tar.gz: af82f344e594cadbd8eedc24f257f55b3cf07d23919e2f7d992b25e5aa3049745c6583e6dd1975ec4303a0eeeea98269c44f8bb22c866885c4e15f4bb7afde73

data/README.md

@@ -40,7 +40,15 @@ In order to use Endpointer you need to create a JSON configuration file with the
     },
     "matchers": {
       "matcher-id": "some regex"
-    }
+    },
+    "substitutions": [
+      {
+        "from_request": "Some regex with a named matcher called match (?<match\\w+)",
+        "to_response": "Some regex with a named matcher called match (?<match\\w+)",
+      },
+      ...
+    ],
+
   },
   ...
 ]
@@ -93,6 +101,10 @@ If the request is to be executed against the real service the headers defined in
 
 Endpointer now supports custom matchers with the goal to give you more fine grained control of what gets cached. This allows you to cache different requests using a regex separately. You just define your resource with its custom matchers as shown above. Endpointer will then attempt to match the regex against the request body and store the response separately if it matches. If no matcher matches it will default to the default cache key for the resource(resource id).
 
+### Substitutions
+
+Endpointer can take a list of regexes to copy values from the request and replace into the response. This is particularly useful if your use case needs a cached response that needs different values based on the request.
+
 ### Caching
 
 By default endpointer will use your operating system's temp directory to store its cache files `(TMP_DIR/endpointer_cache)`. In order to configure the cache path you need to pass the `--cache-dir=<path>` argument.
@@ -119,6 +131,7 @@ As mentioned above I'm actively going to work on improving endpointer and the fo
 * A `--debug` flag to the command line that will give a pry window on every request allowing you to play with the Request and Response objects.
 * Configurable port(this can already be done if using config.ru)
 * Support multiple key/value stores for caching. Currently only uses local YAML files. One Suggestion is Redis support.
+* Support response manipulator plugins that can pre-process responses
 
 ## License
 

data/lib/endpointer/cacher.rb

@@ -2,6 +2,7 @@ require 'endpointer/errors/cached_item_not_found_error'
 require 'endpointer/errors/invalid_cache_dir_error'
 require 'endpointer/cache_container'
 require 'endpointer/cache_key_resolver'
+require 'endpointer/response_presenter'
 require 'yaml'
 
 module Endpointer
@@ -15,7 +16,7 @@ module Endpointer
       cache_key = get_cache_key(resource, request_body)
       cache_container = retrieve_cache_container(cache_key)
       raise Endpointer::Errors::CachedItemNotFoundError unless cache_container.resource == resource
-      cache_container.response
+      present_response(resource, request_body, cache_container)
     end
 
     def set(resource, request_body, response)
@@ -54,5 +55,15 @@ module Endpointer
         raise Endpointer::Errors::InvalidCacheDirError, e.message
       end
     end
+
+    def present_response(resource, request_body, cache_container)
+      Endpointer::ResponsePresenter.new.present(
+        status: cache_container.response.code,
+        body: cache_container.response.body,
+        headers: cache_container.response.headers,
+        request_body: request_body,
+        resource: resource
+      )
+    end
   end
 end

data/lib/endpointer/performers/get.rb

@@ -19,7 +19,10 @@ module Endpointer
         rescue RestClient::ExceptionWithResponse => e
           response = e.response
         end
-        Endpointer::ResponsePresenter.new.present(status: response.code, body: response.body, headers: response.headers)
+
+        request_body = request.body.read
+        request.body.rewind
+        Endpointer::ResponsePresenter.new.present(status: response.code, body: response.body, headers: response.headers, request_body: request_body, resource: resource)
       end
     end
   end

data/lib/endpointer/performers/post.rb

@@ -14,10 +14,12 @@ module Endpointer
       private
 
       def execute_method(method, request, resource)
+        request_body = request.body.read
+
         begin
           response = RestClient.send(method,
             construct_uri(request, resource),
-            request.body.read,
+            request_body,
             create_headers(request, resource)
           )
           request.body.rewind
@@ -25,7 +27,7 @@ module Endpointer
           response = e.response
         end
 
-        Endpointer::ResponsePresenter.new.present(status: response.code, body: response.body, headers: response.headers)
+        Endpointer::ResponsePresenter.new.present(status: response.code, body: response.body, headers: response.headers, request_body: request_body, resource: resource)
       end
     end
   end

data/lib/endpointer/resource.rb

@@ -1,4 +1,4 @@
 module Endpointer
-  class Resource < Struct.new(:id, :method, :url, :headers, :matchers)
+  class Resource < Struct.new(:id, :method, :url, :headers, :matchers, :substitutions)
   end
 end

data/lib/endpointer/resource_parser.rb

@@ -5,7 +5,7 @@ module Endpointer
   class ResourceParser
     def parse(resource_config)
       parse_config(resource_config).map do |resource|
-        Resource.new(resource["id"], resource["method"].to_sym, resource["url"], resource["headers"], resource["matchers"])
+        Resource.new(resource["id"], resource["method"].to_sym, resource["url"], resource["headers"], resource["matchers"], resource["substitutions"])
       end
     end
 

data/lib/endpointer/response_presenter.rb

@@ -1,10 +1,11 @@
+require 'endpointer/response_substitutioner'
 module Endpointer
   class ResponsePresenter
 
-    def present(status: , body: , headers: )
+    def present(status: , body: , headers: , request_body: , resource: )
       Response.new(
         status,
-        body,
+        substituted_body(request_body, body, resource),
         sanitise_headers(uglify_headers(headers))
       )
     end
@@ -24,5 +25,9 @@ module Endpointer
       }
     end
 
+    def substituted_body(request_body, response_body, resource)
+      Endpointer::ResponseSubstitutioner.new.substitute(request_body, response_body, resource.substitutions)
+    end
+
   end
 end

data/lib/endpointer/response_substitutioner.rb

@@ -0,0 +1,26 @@
+module Endpointer
+  class ResponseSubstitutioner
+
+    def substitute(request_body, response_body, substitutions)
+      return response_body if substitutions.nil?
+
+      substitutions.inject(response_body) do |output, substitution|
+        value_to_use = get_value_for(request_body, substitution.fetch('from_request'))
+        value_to_replace = get_value_for(response_body, substitution.fetch('to_response'))
+        output.gsub(value_to_replace, value_to_use)
+      end
+    end
+
+    private
+
+    def get_value_for(string, regex)
+      match_data = string.match(Regexp.new(regex))
+
+      if match_data
+        match_data[:match]
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/endpointer/version.rb

@@ -1,3 +1,3 @@
 module Endpointer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpointer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -193,6 +193,7 @@ files:
 - lib/endpointer/resource_parser.rb
 - lib/endpointer/response.rb
 - lib/endpointer/response_presenter.rb
+- lib/endpointer/response_substitutioner.rb
 - lib/endpointer/version.rb
 homepage: https://github.com/zenonas/endpointer
 licenses: