idempotent-request 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97567b4fefdeb4f2519df13c738a9922c47dcef9
+  data.tar.gz: 95e8440f7d1ed1d84d0b86876609b0a2bd24b14f
+SHA512:
+  metadata.gz: 746a79896a310f59f79179c78459ed25195c30c01a695b759fc0288db9f0ac8502d70f1506e8d97acf3fb208793d665cf875f83b05f614a80ec39620893ab09c
+  data.tar.gz: 8c333a9db17087beb9f3b7bde8bdb31f68c80951eed7b77afc90e681f462520ff6797c7f5a56bcba4dafad30fff5cd9555f1b30ec27f89786ac8fd5b8613d8d6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+deploy:
+  skip_cleanup: true
+  provider: rubygems
+  api_key:
+    secure: JOZUQM6qAYJN/N0k4UmV3jBSKMaW3oMYiZ4boPrGm7MsUY8ETHXSYR+dDhrWOvDR4Wdr6DVbTmMtXkWJHaQaM/LkrjN2FM6mTuDfmhkcvi9VBOMstptwXeHMS9fWeogtQwHyd+pKac9vUlaMhRYyoeYyJ1i6/LHua4NftZZ8oPu/9kMuKDD3Rj8zPJNui+fGcZxq90XdxjafCfRJu7EnzSZXzVi5msaEBKcUVxsHxprBjyjmp/yh/Wn0GLyBkYYXkKEUNx9DhxVtWaNG2FfOzznj3HLXQgBdz1or1tDxG8iIegC5jEj4G+gLtldLhMYWfHDaEr4iqKLF1LkjO9TK0RjcVzGNHNxCTQaDDcjgimcVNozWg707IzT5Ap6jG4Y9JWk5KY4ysOaVFqhemafoDwQcXkPb+39N/tpeBPCByCVNrZ+5lgWaHvs+iDv0X9PyAFs5nTz6/u6bz7GDZ91oJOGs9OW6szzHwkQn5TN4omdGiOFca7lviz6OyjXeSn+a6whU2DsRXxp+omrPT/gELLGl21Wd3GGTpiGAdnu/vwvoKOZqGfkr8HS/Bozc0S/vafFJ5KoPAkNQ9iwxPgL1xcEbSF5uK67T2EYVKg7z4psXDeWGBWzk8657SBCB1VCgujkmhg+lWt0TGgrckupKSyUXL4/nnAECgizSLJSbgRE=
+  gem: idempotent-request
+  on:
+    tags: true
+    repo: qonto/idempotent-request

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dmytro@qonto.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in idempotent-request.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dmytro Zakharov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Idempotent Request [![Build Status](https://travis-ci.org/qonto/idempotent-request.svg?branch=master)](https://travis-ci.org/qonto/idempotent-request)
+
+Rack middleware ensuring at most once requests for mutating endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idempotent-request'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install idempotent-request
+
+## How it works
+
+1.  Front-end generates a unique `key` then a user goes to a specific route (for example, transfer page).
+2.  When user clicks "Submit" button, the `key` is sent in the header `idempotency-key` and back-end stores server response into redis.
+3.  All the consecutive requests with the `key` won't be executer by the server and the result of previous response (2) will be fetched from redis.
+4.  Once the user leaves or refreshes the page, front-end should re-generate the key.
+
+## Configuration
+```ruby
+# application.rb
+config.middleware.use IdempotentRequest::Middleware,
+  storage: IdempotentRequest::RedisStorage.new(::Redis.current, expire_time: 1.day),
+  policy: YOUR_CLASS
+```
+
+To define a policy, whether a request should be idempotent, you have to provider a class with the following interface:
+
+```ruby
+class Policy
+  attr_reader :request
+
+  def initialize(request)
+    @request = request
+  end
+
+  def should?
+    # request is Rack::Request class
+  end
+end
+```
+
+### Example of integration for rails
+
+
+```ruby
+# application.rb
+config.middleware.use IdempotentRequest::Middleware,
+  storage: IdempotentRequest::RedisStorage.new(::Redis.current, expire_time: 1.day),
+  policy: IdempotentRequest::Policy
+
+config.idempotent_routes = [
+  { controller: :'v1/transfers', action: :create },
+]
+```
+
+```ruby
+# lib/idempotent-request/policy.rb
+module IdempotentRequest
+  class Policy
+    attr_reader :request
+
+    def initialize(request)
+      @request = request
+    end
+
+    def should?
+      route = Rails.application.routes.recognize_path(request.path, method: request.request_method)
+      Rails.application.config.idempotent_routes.any? do |idempotent_route|
+        idempotent_route[:controller] == route[:controller].to_sym &&
+          idempotent_route[:action] == route[:action].to_sym
+      end
+    end
+  end
+end
+```
+
+## Custom options
+
+```ruby
+# application.rb
+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')
+```
+
+### Policy
+
+Custom class to decide whether the request should be idempotent.
+
+See *Example of integration for rails*
+
+### Storage
+
+Where the response will be stored. Can be any class that implements the following interface:
+
+```ruby
+def read(key)
+  # read from a storage
+end
+
+def write(key, payload)
+  # write to a storage
+end
+```
+
+### Callback
+
+Get notified when the client sends a request with the same idempotency key:
+
+```ruby
+class RailsCallback
+  attr_reader :request
+  
+  def initialize(request)
+    @request = request
+  end
+  
+  def detected(key:)
+    Rails.logger.warn "IdempotentRequest request detected, key: #{key}"
+  end
+end
+```
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Idempotent::Request project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/idempotent-request/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "idempotent/request"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/idempotent-request.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'idempotent-request'
+  spec.version       = IdempotentRequest::VERSION
+  spec.authors       = ['Dmytro Zakharov']
+  spec.email         = ['dmytro@qonto.eu']
+
+  spec.summary       = %q{Rack middleware ensuring at most once requests for mutating endpoints.}
+  spec.homepage      = 'https://github.com/qonto/idempotent-request'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  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 'rspec', '~> 3.0'
+  spec.add_development_dependency 'fakeredis', '~> 0.6'
+  spec.add_development_dependency 'pry', '~> 0.11'
+end

data/lib/idempotent-request.rb

@@ -0,0 +1,5 @@
+require 'oj'
+require 'idempotent-request/request'
+require 'idempotent-request/request_manager'
+require 'idempotent-request/redis_storage'
+require 'idempotent-request/middleware'

data/lib/idempotent-request/middleware.rb

@@ -0,0 +1,39 @@
+module IdempotentRequest
+  class Middleware
+    def initialize(app, config = {})
+      @app = app
+      @config = config
+      @policy = config.fetch(:policy)
+    end
+
+    def call(env)
+      # dup the middleware to be thread-safe
+      dup.process(env)
+    end
+
+    def process(env)
+      set_request(env)
+      return app.call(request.env) unless process?
+      storage = RequestManager.new(request, config)
+      storage.read || storage.write(*app.call(request.env))
+    end
+
+    private
+
+    attr_reader :app, :env, :config, :request, :policy
+
+    def process?
+      !request.key.to_s.empty? && should_be_idempotent?
+    end
+
+    def should_be_idempotent?
+      return false unless policy
+      policy.new(request).should?
+    end
+
+    def set_request(env)
+      @env = env
+      @request ||= Request.new(env, config)
+    end
+  end
+end

data/lib/idempotent-request/redis_storage.rb

@@ -0,0 +1,29 @@
+module IdempotentRequest
+  class RedisStorage
+    attr_reader :redis, :namespace, :expire_time
+
+    def initialize(redis, config = {})
+      @redis = redis
+      @namespace = config.fetch(:namespace, 'idempotency_keys')
+      @expire_time = config[:expire_time]
+    end
+
+    def read(key)
+      redis.get(namespaced_key(key))
+    end
+
+    def write(key, payload)
+      redis.setnx(namespaced_key(key), payload)
+      redis.expire(namespaced_key(key), expire_time.to_i) if expire_time.to_i > 0
+    end
+
+    private
+
+    def namespaced_key(idempotency_key)
+      [namespace, idempotency_key.strip]
+        .compact
+        .join(':')
+        .downcase
+    end
+  end
+end

data/lib/idempotent-request/request.rb

@@ -0,0 +1,33 @@
+module IdempotentRequest
+  class Request
+    attr_reader :request
+
+    def initialize(env, config = {})
+      @request = Rack::Request.new(env)
+      @header_name = config.fetch(:header_key, 'HTTP_IDEMPOTENCY_KEY')
+    end
+
+    def key
+      request.env[header_name]
+    end
+
+    def method_missing(method, *args)
+      if request.respond_to?(method)
+        request.send(method, *args)
+      else
+        super
+      end
+    end
+
+    private
+
+    def header_name
+      key = @header_name
+        .to_s
+        .upcase
+        .gsub('-', '_')
+
+      key.start_with?('HTTP_') ? key : "HTTP_#{key}"
+    end
+  end
+end

data/lib/idempotent-request/request_manager.rb

@@ -0,0 +1,56 @@
+module IdempotentRequest
+  class RequestManager
+    attr_reader :request, :storage
+
+    def initialize(request, config)
+      @request = request
+      @storage = config.fetch(:storage)
+      @callback = config[:callback]
+    end
+
+    def read
+      status, headers, response = parse_data(storage.read(key)).values
+
+      return unless status
+      run_callback(:detected, key: request.key)
+      [status, headers, response]
+    end
+
+    def write(*data)
+      status, headers, response = data
+      response = response.body if response.respond_to?(:body)
+
+      return data unless status == 200
+
+      storage.write(key, payload(status, headers, response))
+
+      data
+    end
+
+    private
+
+    def parse_data(data)
+      return {} if data.to_s.empty?
+
+      Oj.load(data)
+    end
+
+    def payload(status, headers, response)
+      Oj.dump({
+        status: status,
+        headers: headers.to_h,
+        response: response
+      })
+    end
+
+    def run_callback(action, args)
+      return unless @callback
+
+      @callback.new(request).send(action, args)
+    end
+
+    def key
+      request.key
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module IdempotentRequest
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: idempotent-request
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmytro Zakharov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: 
+email:
+- dmytro@qonto.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- idempotent-request.gemspec
+- lib/idempotent-request.rb
+- lib/idempotent-request/middleware.rb
+- lib/idempotent-request/redis_storage.rb
+- lib/idempotent-request/request.rb
+- lib/idempotent-request/request_manager.rb
+- lib/version.rb
+homepage: https://github.com/qonto/idempotent-request
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Rack middleware ensuring at most once requests for mutating endpoints.
+test_files: []