endpointer 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa780a8443a0cfe0a905bfa6ea711c0a336adc74
-  data.tar.gz: 53c1ed73d95fd7bc73fca0617af99e670ed42eb8
+  metadata.gz: ed57fed80944f3216675621c478581a387cfadca
+  data.tar.gz: fa510a7ca1aa6a003eab39ff56dd123fad0390bb
 SHA512:
-  metadata.gz: 0ca015089a8d79e4827f2c57ddd3defa3b354b1cafe884ea7674e6402b14d465e80a7bc7bb6d82ccf310eee7b2cb33b60f00f2a098aa6b527081b31d7448ff61
-  data.tar.gz: bdee2529f5ba34ce2b941a0dfb72ab91f3ef6a1e04be6a922306211b0f291d5ca819cddca0ae71875be7cdf7571277f3a28731e7c42b0bc5ae8cdbdf96e3d45e
+  metadata.gz: a702ca63c58db74696360affe2be6daeec2d86c7952377d1d72c54d89fb0f15b671b80778b9089c53ed5d3a8c4b6b23b8425625667de5f5013e546f390c786f1
+  data.tar.gz: 777d002c2e8bb5d68a0bec8b12328837930320b4e5a23211878ac48a2c1d79cd5ee30ff40bcb112c4763fbd83aab35ba6fbdc18cf3fb2525b03a6d30d8ed9558

data/.travis.yml

@@ -4,7 +4,7 @@ branches:
     - master
     - /^v[0-9]+\.[0-9]+\.[0-9]+/
 rvm:
-- 2.4.0
+- 2.4.1
 - 2.3.3
 - 2.2.6
 - jruby-9.1.6.0

data/README.md

@@ -37,6 +37,9 @@ In order to use Endpointer you need to create a JSON configuration file with the
     "headers": {
       "Authorization": "Bearer test",
       "Accept": "application/json"
+    },
+    "matchers": {
+      "matcher-id": "some regex"
     }
   },
   ...
@@ -85,6 +88,11 @@ If the request is to be executed against the real service the headers defined in
 
     $ curl -H "Accept: text/plain" http://localhost:4567/get
 
+
+### Custom matchers
+
+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).
+
 ### 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.
@@ -115,4 +123,3 @@ As mentioned above I'm actively going to work on improving endpointer and the fo
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/examples/endpointer.json

@@ -6,6 +6,10 @@
     "headers": {
       "Authorization": "Bearer test",
       "Content-Type": "application/json"
+    },
+    "matchers": {
+      "matcher1": "something at the end$",
+      "matcher2": "^starting with"
     }
   },
   {

data/lib/endpointer/cache_key_resolver.rb

@@ -0,0 +1,14 @@
+module Endpointer
+  class CacheKeyResolver
+    def get_key(resource, request_body)
+      return "#{resource.id}.yml" if resource.matchers.nil?
+
+      matches = resource.matchers.select do |_matcher_name, regex|
+        request_body.match(regex)
+      end
+
+      return "#{resource.id}.yml" if matches.empty?
+      "#{resource.id}_#{matches.keys.first}.yml"
+    end
+  end
+end

data/lib/endpointer/cacher.rb

@@ -1,6 +1,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 'yaml'
 
 module Endpointer
@@ -10,15 +11,16 @@ module Endpointer
       initialize_path(path)
     end
 
-    def get(resource)
-      cache_container = retrieve_cache_container(resource)
+    def get(resource, request_body)
+      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
     end
 
-    def set(resource, response)
+    def set(resource, request_body, response)
       cache_container = create_cache_container(resource, response)
-      File.write(File.join(@path, "#{resource.id}.yml"), YAML.dump(cache_container))
+      File.write(File.join(@path, get_cache_key(resource, request_body)), YAML.dump(cache_container))
     end
 
     def invalidate
@@ -32,20 +34,24 @@ module Endpointer
       Endpointer::CacheContainer.new(resource, response, Time.now.utc)
     end
 
-    def retrieve_cache_container(resource)
+    def retrieve_cache_container(cache_key)
       begin
-        YAML.load(File.read(File.join(@path, "#{resource.id}.yml")))
-      rescue
-        raise Endpointer::Errors::CachedItemNotFoundError
+        YAML.load(File.read(File.join(@path, cache_key)))
+      rescue Errno::ENOENT => e
+        raise Endpointer::Errors::CachedItemNotFoundError, e.message
       end
     end
 
+    def get_cache_key(resource, request_body)
+      Endpointer::CacheKeyResolver.new.get_key(resource, request_body)
+    end
+
     def initialize_path(path)
       begin
         @path = path
         Dir.mkdir(@path) unless File.exist?(@path)
       rescue Errno::ENOENT => e
-        raise Endpointer::Errors::InvalidCacheDirError.new(e.message)
+        raise Endpointer::Errors::InvalidCacheDirError, e.message
       end
     end
   end

data/lib/endpointer/resource.rb

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

data/lib/endpointer/resource_executor.rb

@@ -6,10 +6,10 @@ module Endpointer
 
     def perform(request, resource, options)
       begin
-        cache(options.cache_dir).get(resource)
+        cache(options.cache_dir).get(resource, get_request_body(request))
       rescue Endpointer::Errors::CachedItemNotFoundError
         response = Endpointer::PerformerFactory.create(resource.method).execute(request, resource)
-        cache(options.cache_dir).set(resource, response)
+        cache(options.cache_dir).set(resource, get_request_body(request), response)
         response
       end
     end
@@ -19,5 +19,11 @@ module Endpointer
     def cache(cache_dir)
       @cache ||= Endpointer::Cacher.new(cache_dir)
     end
+
+    def get_request_body(request)
+      request_body = request.body.read
+      request.body.rewind
+      request_body
+    end
   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.new(resource["id"], resource["method"].to_sym, resource["url"], resource["headers"], resource["matchers"])
       end
     end
 

data/lib/endpointer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpointer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,6 +176,7 @@ files:
 - lib/endpointer/app_creator.rb
 - lib/endpointer/argument_parser.rb
 - lib/endpointer/cache_container.rb
+- lib/endpointer/cache_key_resolver.rb
 - lib/endpointer/cacher.rb
 - lib/endpointer/configuration.rb
 - lib/endpointer/errors/cached_item_not_found_error.rb