api-blueprint 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f3b301a57079985d9709f72b0ad1dfe1310e78c
-  data.tar.gz: efd1ede63552fa9489d09b9f45b13cec682e85e2
+  metadata.gz: c71a6912bd0d28aacda1dcc3e9270f589c27bd1a
+  data.tar.gz: c1a7c264ad6a56025a7a92bde195dc450c0a188b
 SHA512:
-  metadata.gz: 0a5732ab57a0b4f02af8f37c2c82571ccd4a3072665272f9d42a6cf30081cb618e9a2f3d33f2900142dc727518f89cb296ec5db0454653564389198959a5a159
-  data.tar.gz: 9ff4723a7a24304da190b4540ff3e277e011faffda39d238da7a638403f59f78fcb8386fbdd4e17220caae358f5da4c6cca71679d2c95f9f42158bd6af903aef
+  metadata.gz: 62c236b537499de0c80d39489c61ae7bdc86235279000a14f86aa0d3db66cacab2eada10b40b38733648263653ce7341c7aa73f75f27d00999f24484ac8169ff
+  data.tar.gz: 6142c601a95a4fa9eefb25653d1e9fc8b459591d8128241ff3ac5d1cf240189bc795a261d2d8ee9e2258fd2012af59c6a2c0e00a0080b5185fa5797dd2d28601

data/README.md

@@ -264,6 +264,20 @@ For example, to not include "X-Real-IP" and "X-Request-Id" headers, which would
  end
 ```
 
+If you would like to override how the cache keys are generated, you can do it for all classes by redefining `generate_cache_key` in your cache class. If you only need to override the cache key for certain models (for example, a public api cache might not want to use the session id to make the cache keys unique), you can do so by implementing a `cache_key_generator` proc on your model config:
+
+```ruby
+class AstronautsInSpace < ApiBlueprint::Model
+  configure do |config|
+    config.cache_key_generator = -> (key, options) do
+      # `key` is the key which you have initialized the instance of the cache class with
+      # `options` is all the api-related options for the request (url, headers, body, etc)
+      "some-custom-cache-key-here"
+    end
+  end
+end
+```
+
 ## A note on Dry::Struct immutability
 
 Models you create use `Dry::Struct` to handle initialization and assignment. `Dry::Struct` is designed with immutability in mind, so if you need to mutate the objects you have, there are two possibilities; explicitly define an `attr_writer` for the attributes which you want to mutate, or do things the "Dry::Struct way" and use the current instance to initialize a new instance:

data/lib/api-blueprint/cache.rb

@@ -20,13 +20,17 @@ module ApiBlueprint
     end
 
     def generate_cache_key(klass, options)
-      if options.is_a? Hash
-        options = options.clone.with_indifferent_access.except :body
-        options[:headers] = options[:headers].except *self.class.config.ignored_headers if options[:headers]
+      if klass&.cache_key_generator&.present?
+        klass.cache_key_generator.call key, options
+      else
+        if options.is_a? Hash
+          options = options.clone.with_indifferent_access.except :body
+          options[:headers] = options[:headers].except *self.class.config.ignored_headers if options[:headers]
+        end
+
+        options_digest = Digest::MD5.hexdigest Marshal::dump(options.to_s.chars.sort.join)
+        "#{key}:#{klass&.name}:#{options_digest}"
       end
-
-      options_digest = Digest::MD5.hexdigest Marshal::dump(options.to_s.chars.sort.join)
-      "#{key}:#{klass&.name}:#{options_digest}"
     end
 
   end

data/lib/api-blueprint/model.rb

@@ -11,6 +11,7 @@ module ApiBlueprint
     setting :builder, Builder.new
     setting :replacements, {}
     setting :log_responses, false
+    setting :cache_key_generator, nil, reader: true
 
     attribute :response_headers, Types::Hash.optional
     attribute :response_status, Types::Integer.optional

data/lib/api-blueprint/version.rb

@@ -1,3 +1,3 @@
 module ApiBlueprint
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-blueprint
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types