idempo 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5d862a9c8b731c1678447b00637cbeee39a0713503455f39c6bbbe1906090e
-  data.tar.gz: e482c6af0896c61131373ce7446557bb2ce57be5f2efc120241ac814fc28de5c
+  metadata.gz: 057a7d3947de8a08ae62e9f7de2f2b05fae6607c1662aac78c7b12544050f41d
+  data.tar.gz: d0d8a84c2b208fd27b2301f975a3cf582d0c7b9e1b572d61574febf1f9f31cf4
 SHA512:
-  metadata.gz: 9bdd48ca7387d456e52d7ea1813116761399d7586353f56885b6458361078b32ba0a93edcd160d874623ed9313bfc39be6a81cd2d70f32c4863b5dc60134cf4f
-  data.tar.gz: 458308ac0a75adda6ed83d6b018670d709ff5e5908ed3d0845da2b57d78100f3c9d5a6b432463908378c16637ef6ae14e607c9e3d5edde196068b12c72272646
+  metadata.gz: bb98caf618c0c0c8987de2bd3e9e3a277c0d23d72d7b24ae90c22a678e44675bfb5a23468d23d0b73e9ccc7ec8e90704df553852b72a346b4f28e00d7a441fcc
+  data.tar.gz: 4c66050b6e219abd0922bd9a3e72740344c78c65bf0d35af08e2f423f4f2b835da377662b785802a37db4806f996e565027f1e3bdceff9d5344d59fa03344930

data/README.md

@@ -32,9 +32,23 @@ use Idempo, backend: Idempo::RedisBackend.new(Rails.application.config.redis_con
 and to initialize with a memory store as backend:
 
 ```ruby
-use Idempo, backend: Idempo::MemoryBackend.new)
+use Idempo, backend: Idempo::MemoryBackend.new
 ```
 
+In principle, the following requests qualify to be cached used the idempotency key:
+
+* Any request which is not a `GET`, `HEAD` or `OPTIONS` and...
+* Provides an `Idempotency-Key` or `X-Idempotency-Key` header
+
+The default time for storing the cache is 30 seconds from the moment the request has finished generating. The response is going to be buffered, then serialized using msgpack, then deflated. Idempo will not cache the response if its size cannot be known in advance, and if the size of the response body exceeds a reasonable size (4 MB is our limit for the time being) - this is to prevent your storage from filling up with very large responses.
+
+## Controlling the behavior of Idempo
+
+You can control the behavior of Idempo using special headers:
+
+* Set `X-Idempo-Policy` to `no-store` to disable retention of the response even though it otherwise could be cached
+* Set `X-Idempo-Persist-For-Seconds` to decimal number of seconds to store your response fo 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/idempo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Idempo
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/idempo.rb

@@ -141,6 +141,7 @@ class Idempo
     d = Digest::SHA256.new
     d << req.url << "\n"
     d << req.request_method << "\n"
+    d << req.get_header('HTTP_AUTHORIZATION').to_s << "\n"
     while chunk = req.env['rack.input'].read(1024 * 65)
       d << chunk
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idempo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack