rack-strip-cookies 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7eafe50366d6e4108cceffe2e11c6b252ffef7f9
-  data.tar.gz: a5191640fd78fe70345bf3ee699173cfe352e87b
+SHA256:
+  metadata.gz: 66e97e6cf416eb10f05682f5ccf531f2c95f651e832ceee8ae8387609223afeb
+  data.tar.gz: e9991ec7c0baf84509ddf9ba82eff43c2ae8ff538c1744f0ffb19ca13a7c6318
 SHA512:
-  metadata.gz: 89592d00d384bb07e1f460085a4c9913dc41957a238c052b154cbd554a8872240397fba0be1b81682532c7e233c7197e78ad34b8a9156d027a528ba4ec72873e
-  data.tar.gz: 771c40ff4e8d62fbef97ac7d89899b9116879851d127de1f65d53e75e1b2af443868f0025c89a130f0d8534d7bf55f395b577c89d60aa4bc334c0d544a1b7770
+  metadata.gz: 50a26b18e48cfcc3ae7da149461b85bc94ca490a11014ceb7bbe94f8bb97f1269f217d559a218ca6a194ddab7f87487a77528e8e2084009e2695534e801da6d1
+  data.tar.gz: 7c61e87dd4e6c9fabd721419b8d74f34b28690c45c55b81069809eebf4a6432971a725cdf0e5ca1e7e3c05526b51b1a6b0c6d67dbb56ee3da53103692505164d

data/lib/rack/strip-cookies/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class StripCookies
-    VERSION = '0.0.4'
+    VERSION = "1.0.0"
   end
 end

data/lib/rack/strip-cookies.rb

@@ -1,20 +1,45 @@
 module Rack
   class StripCookies
-    attr_reader :paths
+    attr_reader :app, :paths, :invert
 
+    # Initializes the middleware.
+    #
+    # @param app [Rack application] The Rack application.
+    # @param paths [Array<String>] The paths where cookies should be deleted.
+    # @param invert [Boolean] Whether to invert the paths where cookies are deleted.
     def initialize(app, options = {})
-      @app, @paths = app, Array(options[:paths])
+      @app = app
+      @paths = Array(options[:paths])
+      @invert = options[:invert] || false
     end
 
+    # Entry point of the middleware.
+    #
+    # @param env [Hash] The request environment.
+    # @return [Array] The response containing the status, headers, and body.
     def call(env)
-      path     = Rack::Request.new(env).path
-      included = paths.any? { |s| path.include?(s)}
+      # Extract the path from the request
+      path = Rack::Request.new(env).path
 
-      env.delete('HTTP_COOKIE') if included
+      # Check if the request path is in the list of paths to be stripped
+      included = paths.any? { |s| path.include?(s) }
 
+      # Decide whether to strip cookies based on the request path and the invert flag
+      strip_out = ((included && !invert) || (!included && invert))
+
+      # If cookies are to be stripped, delete the HTTP_COOKIE from the request environment
+      env.delete("HTTP_COOKIE".freeze) if strip_out
+
+      # Call the next middleware/app and get the status, headers, and body of the response
       status, headers, body = @app.call(env)
-      headers.delete('Set-Cookie') if included
 
+      # If cookies are to be stripped, delete the Set-Cookie header from the response
+      headers.delete("set-cookie".freeze) if strip_out
+
+      # If cookies were stripped, insert a custom header indicating that fact
+      headers["cookies-stripped".freeze] = "true" if strip_out
+
+      # Return the response (status, headers, body) to the next middleware or the web server
       [status, headers, body]
     end
   end

data/lib/rack-strip-cookies.rb

@@ -1 +1 @@
-require 'rack/strip-cookies'
+require "rack/strip-cookies"

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rack-strip-cookies
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Claudio Poli
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 5.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 5.18.0
 description: Rack middleware to remove cookies at user-defined paths.
 email:
 - claudio@icorete.ch
@@ -59,24 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - lib/rack-strip-cookies.rb
 - lib/rack/strip-cookies.rb
 - lib/rack/strip-cookies/version.rb
-- rack-strip-cookies.gemspec
-- spec/rack-strip-cookies_spec.rb
 homepage: http://github.com/icoretech/rack-strip-cookies
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,10 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Rack middleware to remove cookies at user-defined paths.
-test_files:
-- spec/rack-strip-cookies_spec.rb
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

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

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.5

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.1
-notifications:
-  email: false
-env:
-  - "rack=1.2.8"
-  - "rack=1.3.10"
-  - "rack=1.4.5"
-  - "rack=1.5.2"
-  - "rack=master"

data/Gemfile

@@ -1,22 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-
-github = 'git://github.com/%s.git'
-repos  = { 'rack' => github % 'rack/rack' }
-
-%w(rack).each do |lib|
-  dep = case ENV[lib]
-        when 'stable', nil then nil
-        when /(\d+\.)+\d+/ then '~> ' + ENV[lib].sub("#{lib}-", '')
-        else { git: repos[lib], branch: dep }
-        end
-  gem lib, dep
-end
-
-group :test do
-  gem 'rack-test'
-  gem 'coveralls', require: false
-end

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Claudio Poli
-
-MIT License
-
-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

@@ -1,47 +0,0 @@
-# Rack::StripCookies [![Build Status](https://secure.travis-ci.org/icoretech/rack-strip-cookies.png)](https://travis-ci.org/icoretech/rack-strip-cookies?branch=master)
-
-Simple Rack middleware to remove cookies at specified paths.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'rack-strip-cookies'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rack-strip-cookies
-
-## Concept
-
-The goal of this gem is not only avoid serving a cookie to a client through the Set-Cookie header, but also to erase cookies sent in the request. In other words the client-sent cookies will not make it to your application layer, provided the middleware is loaded in the correct place in the stack.
-
-## Use cases
-
-- You have a buggy third party library that raises exception when cookies are sent in a request, such as an authentication engine.
-- You are looking for a cheap way to not mess with session cookie disabilitation in your framework.
-- Selectively shut down cookies on specific paths, configurable when adding the middleware.
-
-## Ruby on Rails
-
-To make the middleware available in all environments, open `config/application.rb` and add in `class Application < Rails::Application`:
-
-```ruby
-config.middleware.insert_before(ActionDispatch::Cookies, Rack::StripCookies, paths: %w(/oauth2/token))
-```
-
-If you want to customize the environment in which the middleware is enabled edit the respective environment files instead.
-
-You can verify the middleware positioning by typing `rake middleware` in the root of your application.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-
-require "rake/testtask"
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.test_files = FileList['spec/*_spec.rb']
-  t.verbose = true
-end
-
-task :default => :test

data/rack-strip-cookies.gemspec

@@ -1,24 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rack/strip-cookies/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'rack-strip-cookies'
-  spec.version       = Rack::StripCookies::VERSION
-  spec.authors       = ['Claudio Poli']
-  spec.email         = ['claudio@icorete.ch']
-  spec.summary       = 'Rack middleware to remove cookies at user-defined paths.'
-  spec.description   = 'Rack middleware to remove cookies at user-defined paths.'
-  spec.homepage      = 'http://github.com/icoretech/rack-strip-cookies'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler',   '~> 1.0'
-  spec.add_development_dependency 'rack',      '~> 1.2'
-  spec.add_development_dependency 'rack-test', '~> 0.6.2'
-end

data/spec/rack-strip-cookies_spec.rb

@@ -1,47 +0,0 @@
-require 'rubygems'
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'rack/mock'
-require 'rack/test'
-require 'coveralls'
-
-require_relative '../lib/rack/strip-cookies'
-
-Coveralls.wear!
-
-describe Rack::StripCookies do
-  include Rack::Test::Methods
-
-  def app; Rack::Lint.new(@app); end
-
-  def mock_app(options_or_options_array = {})
-    main_app = lambda { |env|
-      request = Rack::Request.new(env)
-      headers = {'Content-Type' => "text/html"}
-      headers['Set-Cookie'] = "id=1; path=/oauth/token; secure; HttpOnly"
-      [200, headers, ['Hello there']]
-    }
-
-    builder = Rack::Builder.new
-    options_or_options_array = [options_or_options_array] unless options_or_options_array.is_a?(Array)
-    Array(options_or_options_array).each do |options|
-      builder.use Rack::StripCookies, options
-    end
-    builder.run main_app
-    @app = builder.to_app
-  end
-
-  before do
-    mock_app(paths: ["/oauth/token"])
-  end
-
-  it 'does not clean the cookie on another path' do
-    get 'http://www.example.org/oauth'
-    last_response.headers['Set-Cookie'].split("\n").must_equal(["id=1; path=/oauth/token; secure; HttpOnly"])
-  end
-
-  it 'clean the cookie' do
-    get 'http://www.example.org/oauth/token'
-    last_response.headers['Set-Cookie'].must_equal(nil)
-  end
-end