rack-idempotency 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a968ee6548a34d9c9847ddb7da52a4f52fd5af8
-  data.tar.gz: c642eca5a95a7fc9a8a589545cea7c43ca71a0c9
+  metadata.gz: d0f2c986509883647740c552f61dac9f5c7bca1b
+  data.tar.gz: ffd45d68ce0a2cab353ebfc69e5c72471d136bd8
 SHA512:
-  metadata.gz: ed16a28b9147de63b309108ca463b52dd5f22d82699f0336e125ca3e116aafed55a8350b0d9ca7c35a894597e9ad2dd9b46ac1ee3e4f4009ffaacfc29e1d0045
-  data.tar.gz: 48e5cd558e95a13c46a8718a267ebf1bcad363a2433a0fad89dc0306115ef0bdd18365249e142655be37497c96023365a59d677be71ca116adbd8094987b0ab6
+  metadata.gz: 2ba38597029bd2dcccb581da0e140aee7306ba0acf09fe17cb14a68cf613af50114fdf97d3d953e3523f4c0475f52804a26b8d458cf79b879d7690bb64749fb1
+  data.tar.gz: bc4879106473268af4ca39be56bcb5df5205f472cc4f1b20962d9b1ddad2f87d462ac8e54b1c7f70ef2c8f0d439c1c2af575f59cde95156016a0c55c5f479da8

data/.travis.yml

@@ -3,3 +3,8 @@ language: ruby
 rvm:
   - 2.4.0
 before_install: gem install bundler -v 1.14.0
+addons:
+  code_climate:
+    repo_token: 20db8d8f86efbab70a903a66606cb5ab8e1aaaae2d76337c4fea3271ae2b2d37
+after_success:
+  - bundle exec codeclimate-test-reporter

data/README.md

@@ -1,4 +1,8 @@
 # Rack::Idempotency
+[![Gem Version](https://badge.fury.io/rb/rack-idempotency.svg)](https://badge.fury.io/rb/rack-idempotency)
+[![Build Status](https://travis-ci.org/guitsaru/rack-idempotency.svg?branch=master)](https://travis-ci.org/guitsaru/rack-idempotency)
+[![Code Climate](https://codeclimate.com/github/guitsaru/rack-idempotency/badges/gpa.svg)](https://codeclimate.com/github/guitsaru/rack-idempotency)
+[![Test Coverage](https://codeclimate.com/github/guitsaru/rack-idempotency/badges/coverage.svg)](https://codeclimate.com/github/guitsaru/rack-idempotency/coverage)
 
 Rack middleware ensuring at most once requests for mutating endpoints.
 
@@ -51,7 +55,7 @@ Rack::Idempotency should handle the following cases:
  - [x] The initial connection to the server fails.
  - [ ] The request fails halfway through, leaving data in limbo.
  - [x] The request succeeds, but the connection to the client is lost.
- 
+
 The second case is much more dependent on implementation.  Rack::Idempotency assumes that the request is in a transaction and
 can be safely retried if it wasn't successful.
 
@@ -69,4 +73,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/guitsa
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/rack/idempotency/null_store.rb

@@ -2,13 +2,9 @@ module Rack
   class Idempotency
     # Basic version of the store.  This class doesn't read or write.
     class NullStore
-      def read(_id)
-        nil
-      end
+      def read(_id); end
 
-      def write(_id, _value)
-        nil
-      end
+      def write(_id, _value); end
     end
   end
 end

data/lib/rack/idempotency/request.rb

@@ -0,0 +1,11 @@
+require "rack/request"
+
+module Rack
+  class Idempotency
+    class Request < Rack::Request
+      def idempotency_key
+        get_header("HTTP_IDEMPOTENCY_KEY")
+      end
+    end
+  end
+end

data/lib/rack/idempotency/request_storage.rb

@@ -0,0 +1,28 @@
+module Rack
+  class Idempotency
+    class RequestStorage
+      def initialize(store, request)
+        @store   = store
+        @request = request
+      end
+
+      def read
+        stored = store.read(storage_key)
+        JSON.parse(stored) if stored
+      end
+
+      def write(response)
+        store.write(storage_key, response.to_json)
+      end
+
+      private
+
+      attr_reader :request
+      attr_reader :store
+
+      def storage_key
+        "rack:idempotency:" + request.idempotency_key
+      end
+    end
+  end
+end

data/lib/rack/idempotency/response.rb

@@ -0,0 +1,31 @@
+require "rack/utils"
+
+module Rack
+  class Idempotency
+    class Response
+      attr_reader :status, :headers, :body
+
+      def initialize(status, headers, body)
+        @status  = status.to_i
+        @headers = Rack::Utils::HeaderHash.new(headers)
+        @body    = body
+      end
+
+      def success?
+        status.to_i >= 200 && status.to_i < 400
+      end
+
+      def to_a
+        [status, headers.to_hash, body.each]
+      end
+
+      def to_json
+        to_a.to_json
+      end
+
+      def idempotency_key
+        headers["Idempotency-Key"]
+      end
+    end
+  end
+end

data/lib/rack/idempotency/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Idempotency
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/lib/rack/idempotency.rb

@@ -4,6 +4,9 @@ require "rack/idempotency/version"
 
 require "rack/idempotency/memory_store"
 require "rack/idempotency/null_store"
+require "rack/idempotency/request"
+require "rack/idempotency/request_storage"
+require "rack/idempotency/response"
 
 module Rack
   # Rack middleware for ensuring mutating endpoints are called at most once.
@@ -18,41 +21,33 @@ module Rack
     end
 
     def call(env)
-      idempotency_key = env["HTTP_IDEMPOTENCY_KEY"]
-      storage_key     = generate_storage_key(idempotency_key)
-      stored          = store.read(storage_key)
-      return JSON.parse(stored) if stored
+      @env     = env
+      @request = Request.new(env.dup.freeze)
 
-      response = @app.call(env)
-      store_response(storage_key, response)
-
-      response
+      lookup || store_response
     end
 
     private
 
-    attr_reader :app, :store
-
-    def store_response(storage_key, response)
-      if successful?(response)
-        marshaled_response = response.to_json
-        store.write(storage_key, marshaled_response)
-      end
+    attr_reader :app
+    attr_reader :env
+    attr_reader :request
+    attr_reader :store
 
-      response
+    def request_store
+      @request_store ||= RequestStorage.new(store, request)
     end
 
-    def successful?(response)
-      status = response.first
-
-      # Treat redirects as a successful response.
-      status.to_i >= 200 && status.to_i < 400
+    def lookup
+      request_store.read
     end
 
-    def generate_storage_key(idempotency_key)
-      namespace = "rack:idempotency"
+    def store_response
+      response = Response.new(*@app.call(env))
+
+      request_store.write(response) if response.success?
 
-      [namespace, idempotency_key.to_s].join(":")
+      response.to_a
     end
   end
 end

data/rack-idempotency.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-idempotency
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Pruitt
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - guitsaru@gmail.com
@@ -86,6 +114,9 @@ files:
 - lib/rack/idempotency.rb
 - lib/rack/idempotency/memory_store.rb
 - lib/rack/idempotency/null_store.rb
+- lib/rack/idempotency/request.rb
+- lib/rack/idempotency/request_storage.rb
+- lib/rack/idempotency/response.rb
 - lib/rack/idempotency/version.rb
 - rack-idempotency.gemspec
 homepage: https://github.com/guitsaru/rack-idempotency