idempotent-request 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1408d4cc1f8842db0668e7a857a9d0dc461f0d82
-  data.tar.gz: f26a1f4dd85c156717b08bd308df2dcfc1c07706
+SHA256:
+  metadata.gz: cee83a3ed2329dd90ca0e12a8720c46225e90e2334a0a1d614cd911dbcfe02b4
+  data.tar.gz: 4d48b2dc61f9c7561788676d0cb9c3ada34edd1ff244f80e86c796236be7c819
 SHA512:
-  metadata.gz: 37d1cb66a774f725ebceb176ec8ac013f8699b87983a8dc64d78beb32a8864fb9dcf93857a6e463f45d75f885c0bf6d4718e54d07dc5403c60e0566333473b52
-  data.tar.gz: 8289a677da35316332fe57eb6167e412aaff6078d1aa4ed2a6813b715bda991c0e41c311f2b890ce8f5e68840959fb23b9fed14ec8f6e8d602fee513bd4e1d5c
+  metadata.gz: d0d61d258911181604c231b43e8711c09be4d74be10d7ed7d278fc28a438a1ec9f89a4a6e65cfdd0a0ae404f126058159ed55874bfcb71251514c1c27293ee01
+  data.tar.gz: 55308b0cf3a655fdb9f0c0d192e87f248ebfd2a966447df893000de29f5e5b6531816890f3b90a47c6087a09ffad0df58cb5ba04e07c3ba8262b068ecadf85d3

data/.travis.yml

@@ -1,7 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 deploy:
   skip_cleanup: true
   provider: rubygems

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Idempotent Request Changelog #
 
+## v0.1.5 ##
+
+* use ActiveSupport::Notifications to instrument events
+* fix an issue when getting an exception inside application would not delete lock, so client could receive 429 after 500
+
 ## v0.1.4 ##
 
 * Fix an issue, when http response from backend != 200..226 caused lock to be taken

data/README.md

@@ -84,6 +84,23 @@ module IdempotentRequest
 end
 ```
 
+
+### Use ActiveSupport::Notifications to read events
+
+```ruby
+# config/initializers/idempotent_request.rb
+ActiveSupport::Notifications.subscribe('idempotent.request') do |name, start, finish, request_id, payload|
+  notification = payload[:request].env['idempotent.request']
+  if notification['read']
+    Rails.logger.info "IdempotentRequest: Hit cached response from key #{notification['key']}, response: #{notification['read']}"
+  elsif notification['write']
+    Rails.logger.info "IdempotentRequest: Write: key #{notification['key']}, status: #{notification['write'][0]}, headers: #{notification['write'][1]}, unlocked? #{notification['unlocked']}"
+  elsif notification['concurrent_request_response']
+    Rails.logger.warn "IdempotentRequest: Concurrent request detected with key #{notification['key']}"
+  end
+end
+```
+
 ## Custom options
 
 ```ruby
@@ -92,7 +109,8 @@ config.middleware.use IdempotentRequest::Middleware,
   header_key: 'X-Qonto-Idempotency-Key', # by default Idempotency-key
   policy: IdempotentRequest::Policy,
   callback: IdempotentRequest::RailsCallback,
-  storage: IdempotentRequest::RedisStorage.new(::Redis.current, expire_time: 1.day, namespace: 'idempotency_keys')
+  storage: IdempotentRequest::RedisStorage.new(::Redis.current, expire_time: 1.day, namespace: 'idempotency_keys'),
+  conflict_response_status: 409
 ```
 
 ### Policy
@@ -117,7 +135,7 @@ end
 
 ### Callback
 
-Get notified when the client sends a request with the same idempotency key:
+Get notified when a client sends a request with the same idempotency key:
 
 ```ruby
 class RailsCallback
@@ -133,6 +151,10 @@ class RailsCallback
 end
 ```
 
+### Conflict response status
+
+Define http status code that should be returned when a client sends concurrent requests with the same idempotency key.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idempotent-request. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/idempotent-request.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack', '~> 2.0'
   spec.add_dependency 'oj', '~> 3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'fakeredis', '~> 0.6'
   spec.add_development_dependency 'byebug', '~> 10.0'

data/lib/idempotent-request/middleware.rb

@@ -5,6 +5,7 @@ module IdempotentRequest
       @config = config
       @policy = config.fetch(:policy)
       @notifier = ActiveSupport::Notifications if defined?(ActiveSupport::Notifications)
+      @conflict_response_status = config.fetch(:conflict_response_status, 429)
     end
 
     def call(env)
@@ -45,7 +46,7 @@ module IdempotentRequest
     end
 
     def concurrent_request_response
-      status = 429
+      status = @conflict_response_status
       headers = { 'Content-Type' => 'application/json' }
       body = [ Oj.dump('error' => 'Concurrent requests detected') ]
       request.env['idempotent.request']['concurrent_request_response'] = true

data/lib/idempotent-request/request_manager.rb

@@ -49,10 +49,10 @@ module IdempotentRequest
               response: Array(response))
     end
 
-    def run_callback(action, args)
+    def run_callback(action, **args)
       return unless @callback
 
-      @callback.new(request).send(action, args)
+      @callback.new(request).send(action, **args)
     end
 
     def key

data/lib/version.rb

@@ -1,3 +1,3 @@
 module IdempotentRequest
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idempotent-request
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Dmytro Zakharov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -152,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Rack middleware ensuring at most once requests for mutating endpoints.