grape-idempotency 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e458d533c1b108959144d42615dcfbd9b85f741811a3150e0fd64a103469a734
-  data.tar.gz: 55a8de15e2332ff805edd7992dab11ff4bb14576b980ee71e7f699d83fcc6f11
+  metadata.gz: 615bae812ada064af7880ab0553e2608a7f3386ce8c54f437d6b5048e565f256
+  data.tar.gz: 587cc1a7c3a679e347a26a6971c68ece90c836abdade401aa412abedcc5a0f0d
 SHA512:
-  metadata.gz: 720d6987f1007f27656a769ef7cc945d04fbbe2355dac226a2dd38c801d935f674ab11c80409a6c850817ce8f641ecf2fc9d3ed5b7dc6fbe66ee61e664843ded
-  data.tar.gz: a4fe4ca95116844195429b7d54908aee357c59076095749420cce607dd87da005039e1096a436d85b82e7eaa58944c158910a41ec44780238915bbd22b9ab9cd
+  metadata.gz: 44b64241b9f09c5a252a91eba6747da4f77cc590163410ed0396f49ac64016f86e8225c2730ed2cf9545764f3fc3098585e49493fe712e241dda2b7ee674140e
+  data.tar.gz: 3bd18355c4d7053e1d77b283e45c41f670c8a06048f8a37e3f3b1344a51dec704b659e1170e4e2f3fc85c4afd5431993e7272109fe9ac1acca2d112850528ce4

data/CHANGELOG.md

@@ -4,6 +4,25 @@ All changes to `grape-idempotency` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.2] - 2023-01-06
+
+### Fix
+
+- Return correct original response when the endpoint returns a hash in the body
+
+
+## [0.1.1] - 2023-01-06
+
+### Fix
+
+- Return `409 - Conflict` response if idempotency key is provided for same query and body parameters BUT different endpoints.
+- Use `nx: true` when storing the original request in the Redis storage for only setting the key if it does not already exist.
+
+### Changed
+
+- Include `idempotency-key` in the response headers
+  - In the case of a concurrency error when storing the request into the redis storage (because now `nx: true`), a new idempotency key will be generated, so the consumer can check the new one seeing the headers.
+
 ## [0.1.0] - 2023-01-03
 
 - Initial version

data/README.md

@@ -1,10 +1,10 @@
-# grape-idempotency 🍇🔁
+# Grape::Idempotency 🍇🔁
 
 [![Gem Version](https://badge.fury.io/rb/grape-idempotency.svg)](https://badge.fury.io/rb/grape-idempotency)
+[![Build Status](https://github.com/jcagarcia/grape-idempotency/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/jcagarcia/grape-idempotency/actions)
 
 Gem for supporting idempotency in your [Grape](https://github.com/ruby-grape/grape) APIs.
 
-
 Topics covered in this README:
 
 - [Installation](#installation-)
@@ -75,7 +75,7 @@ Keys are automatically removed from the system if they are at least 24 hours old
 
 Results are only saved if an API endpoint begins its execution. If incoming parameters fail validation or if the request conflicts with another one executing concurrently, no idempotent result is stored because no API endpoint has initiated execution. In such cases, retrying these requests is safe.
 
-Additionally, this gem automatically appends the `Original-Request` header to your API's response, enabling you to trace back to the initial request that generated that specific response.
+Additionally, this gem automatically appends the `Original-Request` header and the `Idempotency-Key` header to your API's response, enabling you to trace back to the initial request that generated that specific response.
 
 ## Configuration 🪚
 

data/grape-idempotency.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_runtime_dependency 'grape', '>= 1'
+  spec.add_runtime_dependency 'grape', '~> 1'
   
-  spec.add_development_dependency 'bundler', '>= 2.4'
-  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'mock_redis', '~> 0.38'
+  spec.add_development_dependency 'mock_redis'
 end

data/lib/grape/idempotency/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module Idempotency
-    VERSION = '0.1.0'
+    VERSION = '0.1.2'
   end
 end

data/lib/grape/idempotency.rb

@@ -27,12 +27,13 @@ module Grape
         return block.call unless idempotency_key
 
         cached_request = get_from_cache(idempotency_key)
-        if cached_request && cached_request["params"] != grape.request.params
+        if cached_request && (cached_request["params"] != grape.request.params || cached_request["path"] != grape.request.path)
           grape.status 409
           return configuration.conflict_error_response.to_json
         elsif cached_request
           grape.status cached_request["status"]
           grape.header(ORIGINAL_REQUEST_HEADER, cached_request["original_request"])
+          grape.header(configuration.idempotency_key_header, idempotency_key)
           return cached_request["response"]
         end
 
@@ -40,16 +41,17 @@ module Grape
           block.call
         end
 
-        if response.is_a?(Hash)
-          response = response[:message].to_json
-        end
+        response = response[:message].to_json if is_an_error?(response)
 
         original_request_id = get_request_id(grape.request.headers)
         grape.header(ORIGINAL_REQUEST_HEADER, original_request_id)
-        response
+        grape.body response
       ensure
         validate_config!
-        store_in_cache(idempotency_key, grape.request.params, grape.status, original_request_id, response) unless cached_request
+        unless cached_request
+          stored_key = store_in_cache(idempotency_key, grape.request.path, grape.request.params, grape.status, original_request_id, response)
+          grape.header(configuration.idempotency_key_header, stored_key)
+        end
       end
 
       private
@@ -85,20 +87,42 @@ module Grape
         JSON.parse(value)
       end
 
-      def store_in_cache(idempotency_key, params, status, request_id, response)
+      def store_in_cache(idempotency_key, path, params, status, request_id, response)
         body = {
+          path: path,
           params: params,
           status: status,
           original_request: request_id,
           response: response
         }.to_json
-        storage.set(key(idempotency_key), body, ex: configuration.expires_in)
+
+        result = storage.set(key(idempotency_key), body, ex: configuration.expires_in, nx: true)
+
+        if !result
+          return store_in_cache(random_idempotency_key, path, params, status, request_id, response)
+        else
+          return idempotency_key
+        end
+      end
+
+      def is_an_error?(response)
+        response.is_a?(Hash) && response.has_key?(:message) && response.has_key?(:headers) && response.has_key?(:status)
       end
 
       def key(idempotency_key)
         "grape:idempotency:#{idempotency_key}"
       end
 
+      def random_idempotency_key
+        tentative_key = SecureRandom.uuid
+        already_existing_key = storage.get(key(tentative_key))
+        if already_existing_key
+          return random_idempotency_key
+        else
+          return tentative_key
+        end
+      end
+
       def storage
         configuration.storage
       end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: grape-idempotency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Juan Carlos García
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: '0'
 description: Add idempotency support to your Grape APIs for safely retrying requests
   without accidentally performing the same operation twice. When creating or updating
   an object, use an idempotency key. Then, if a connection error occurs, you can safely