rack-cors 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a4d5e6683440676f486ce61b3c16ff2e7c8f65e
-  data.tar.gz: be95c0c3dce56c965aff4b1cb398f2ad6fb4f6b3
+SHA256:
+  metadata.gz: 4545ac1af54d2749c6f78b031efef78c2d8ec7cb7f5395d64bd79ee4dbd953fc
+  data.tar.gz: 9fac4069c1fdc45c1cbfae5a4cd8cafd83a27533f4f1557b9ff773158343aa57
 SHA512:
-  metadata.gz: 8ae27dfd82bd822e700c476963118b15e68dee7850aaccb8b43a05670903f9f66217c8cd77dcf425f664581ecadf00eb43c1c1926648d97caf07c6d4a4dd0574
-  data.tar.gz: df278b2f1b3e6f0b01305d601fb58f2d41aef0579232d5ae27564be76483afdfb58b9219708d5a944c7db293025d7bacec4924dc63c06aefed2a7df4ad00e9ec
+  metadata.gz: 8752bb4af30efe706487939b2daaa8a5189dafac69935d75d5359273f72bf2260a60570d769695675c69efda9b9ccd86e2cddfe01e6bfff504216cfdb42f856c
+  data.tar.gz: 3bb3628b7b1d7a4cc25651be3dac3848d60e433a7887911a263cae258a619cb30446aa46be2cde278a7ca5176feceeb2f3dbf7394764c1dc4a34737ae58ec6eb

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.2.5
-  - 2.3.0
-  - 2.3.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5

data/{CHANGELOG → CHANGELOG.md}

@@ -1,6 +1,15 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 1.0.3 - 2019-03-24
+### Changed
+- Don't send 'Content-Type' header with pre-flight requests
+- Allow ruby array for  vary header config
+
+## 1.0.2 - 2017-10-22
+### Fixed
+- Automatically allow simple headers when headers are set
+
 ## 1.0.1 - 2017-07-18
 ### Fixed
 - Allow lambda origin configuration

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rack-cors.gemspec
 gemspec
 
-gem 'pry-byebug'
+gem 'pry-byebug', '~> 3.6.0'

data/README.md

@@ -13,7 +13,7 @@ Install the gem:
 Or in your Gemfile:
 
 ```ruby
-gem 'rack-cors', :require => 'rack/cors'
+gem 'rack-cors'
 ```
 
 
@@ -25,7 +25,6 @@ Put something like the code below in `config/application.rb` of your Rails appli
 ```ruby
 module YourApp
   class Application < Rails::Application
-
     # ...
     
     # Rails 5
@@ -33,7 +32,7 @@ module YourApp
     config.middleware.insert_before 0, Rack::Cors do
       allow do
         origins '*'
-        resource '*', :headers => :any, :methods => [:get, :post, :options]
+        resource '*', headers: :any, methods: [:get, :post, :options]
       end
     end
 
@@ -42,15 +41,14 @@ module YourApp
     config.middleware.insert_before 0, "Rack::Cors" do
       allow do
         origins '*'
-        resource '*', :headers => :any, :methods => [:get, :post, :options]
+        resource '*', headers: :any, methods: [:get, :post, :options]
       end
     end
-    
   end
 end
 ```
 
-We use `insert_before` to make sure `Rack::Cors` runs at the beginning of the stack to make sure it isn't interfered with with other middleware (see `Rack::Cache` note in **Common Gotchas** section). Check out the [rails 4 example](https://github.com/cyu/rack-cors/tree/master/examples/rails4) and [rails 3 example](https://github.com/cyu/rack-cors/tree/master/examples/rails3).
+We use `insert_before` to make sure `Rack::Cors` runs at the beginning of the stack to make sure it isn't interfered with by other middleware (see `Rack::Cache` note in **Common Gotchas** section). Check out the [rails 4 example](https://github.com/cyu/rack-cors/tree/master/examples/rails4) and [rails 3 example](https://github.com/cyu/rack-cors/tree/master/examples/rails3).
 
 See The [Rails Guide to Rack](http://guides.rubyonrails.org/rails_on_rack.html) for more details on rack middlewares or watch the [railscast](http://railscasts.com/episodes/151-rack-middleware).
 
@@ -69,16 +67,22 @@ use Rack::Cors do
 
     resource '/file/list_all/', :headers => 'x-domain-token'
     resource '/file/at/*',
-        :methods => [:get, :post, :delete, :put, :patch, :options, :head],
-        :headers => 'x-domain-token',
-        :expose  => ['Some-Custom-Response-Header'],
-        :max_age => 600
+        methods: [:get, :post, :delete, :put, :patch, :options, :head],
+        headers: 'x-domain-token',
+        expose: ['Some-Custom-Response-Header'],
+        max_age: 600
         # headers to expose
   end
 
   allow do
     origins '*'
-    resource '/public/*', :headers => :any, :methods => :get
+    resource '/public/*', headers: :any, methods: :get
+
+    # Only allow a request for a specific host
+    resource '/api/v1/*',
+        headers: :any,
+        methods: :get,
+        if: proc { |env| env['HTTP_HOST'] == 'api.example.com' }
   end
 end
 ```

data/lib/rack/cors.rb

@@ -16,10 +16,8 @@ module Rack
     # retaining the old key for backwards compatibility
     ENV_KEY     = 'rack.cors'.freeze
 
-    OPTIONS      = 'OPTIONS'.freeze
-    VARY         = 'Vary'.freeze
-    CONTENT_TYPE = 'Content-Type'.freeze
-    TEXT_PLAIN   = 'text/plain'.freeze
+    OPTIONS     = 'OPTIONS'.freeze
+    VARY        = 'Vary'.freeze
 
     DEFAULT_VARY_HEADERS = ['Origin'].freeze
 
@@ -117,7 +115,7 @@ module Rack
         else
           DEFAULT_VARY_HEADERS
         end
-        headers[VARY] = ((vary ? vary.split(/,\s*/) : []) + cors_vary_headers).uniq.join(', ')
+        headers[VARY] = ((vary ? ([vary].flatten.map { |v| v.split(/,\s*/) }.flatten) : []) + cors_vary_headers).uniq.join(', ')
       end
 
       if debug? && result = env[RACK_CORS]
@@ -363,7 +361,7 @@ module Rack
         end
 
         def process_preflight(env, result)
-          headers = {CONTENT_TYPE => TEXT_PLAIN}
+          headers = {}
 
           request_method = env[HTTP_ACCESS_CONTROL_REQUEST_METHOD]
           if request_method.nil?

data/lib/rack/cors/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Cors
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/rack-cors.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Rack::Cors::VERSION
   spec.authors       = ["Calvin Yu"]
   spec.email         = ["me@sourcebender.com"]
-  spec.description   = %q{Middleware that will make Rack-based apps CORS compatible.  Read more here: http://blog.sourcebender.com/2010/06/09/introducin-rack-cors.html.  Fork the project here: https://github.com/cyu/rack-cors}
+  spec.description   = %q{Middleware that will make Rack-based apps CORS compatible. Fork the project here: https://github.com/cyu/rack-cors}
   spec.summary       = %q{Middleware for enabling Cross-Origin Resource Sharing in Rack apps}
   spec.homepage      = "https://github.com/cyu/rack-cors"
   spec.license       = "MIT"
@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", ">= 5.3.0"
-  spec.add_development_dependency "mocha", ">= 0.14.0"
-  spec.add_development_dependency "rack-test", ">= 0"
+  spec.add_development_dependency "bundler", ">= 1.16.0", '< 3'
+  spec.add_development_dependency "rake", "~> 12.3.0"
+  spec.add_development_dependency "minitest", "~> 5.11.0"
+  spec.add_development_dependency "mocha", "~> 1.6.0"
+  spec.add_development_dependency "rack-test", "~> 1.1.0"
 end

data/test/cors/test.cors.coffee

@@ -12,6 +12,11 @@ describe 'CORS', ->
       expect(data).to.eql('Hello world')
       done()
 
+  it 'should allow PATCH access to dynamic resource', (done) ->
+    $.ajax("http://#{CORS_SERVER}/", type: 'PATCH').done (data, textStatus, jqXHR) ->
+      expect(data).to.eql('Hello world')
+      done()
+
   it 'should allow HEAD access to dynamic resource', (done) ->
     $.ajax("http://#{CORS_SERVER}/", type: 'HEAD').done (data, textStatus, jqXHR) ->
       expect(jqXHR.status).to.eql(200)

data/test/cors/test.cors.js

@@ -1,4 +1,4 @@
-// Generated by CoffeeScript 1.12.6
+// Generated by CoffeeScript 2.3.1
 (function() {
   var CORS_SERVER;
 
@@ -6,21 +6,29 @@
 
   describe('CORS', function() {
     it('should allow access to dynamic resource', function(done) {
-      return $.get("http://" + CORS_SERVER + "/", function(data, status, xhr) {
+      return $.get(`http://${CORS_SERVER}/`, function(data, status, xhr) {
         expect(data).to.eql('Hello world');
         return done();
       });
     });
     it('should allow PUT access to dynamic resource', function(done) {
-      return $.ajax("http://" + CORS_SERVER + "/", {
+      return $.ajax(`http://${CORS_SERVER}/`, {
         type: 'PUT'
       }).done(function(data, textStatus, jqXHR) {
         expect(data).to.eql('Hello world');
         return done();
       });
     });
+    it('should allow PATCH access to dynamic resource', function(done) {
+      return $.ajax(`http://${CORS_SERVER}/`, {
+        type: 'PATCH'
+      }).done(function(data, textStatus, jqXHR) {
+        expect(data).to.eql('Hello world');
+        return done();
+      });
+    });
     it('should allow HEAD access to dynamic resource', function(done) {
-      return $.ajax("http://" + CORS_SERVER + "/", {
+      return $.ajax(`http://${CORS_SERVER}/`, {
         type: 'HEAD'
       }).done(function(data, textStatus, jqXHR) {
         expect(jqXHR.status).to.eql(200);
@@ -28,7 +36,7 @@
       });
     });
     it('should allow DELETE access to dynamic resource', function(done) {
-      return $.ajax("http://" + CORS_SERVER + "/", {
+      return $.ajax(`http://${CORS_SERVER}/`, {
         type: 'DELETE'
       }).done(function(data, textStatus, jqXHR) {
         expect(data).to.eql('Hello world');
@@ -36,7 +44,7 @@
       });
     });
     it('should allow OPTIONS access to dynamic resource', function(done) {
-      return $.ajax("http://" + CORS_SERVER + "/", {
+      return $.ajax(`http://${CORS_SERVER}/`, {
         type: 'OPTIONS'
       }).done(function(data, textStatus, jqXHR) {
         expect(jqXHR.status).to.eql(200);
@@ -44,7 +52,7 @@
       });
     });
     it('should allow access to static resource', function(done) {
-      return $.get("http://" + CORS_SERVER + "/static.txt", function(data, status, xhr) {
+      return $.get(`http://${CORS_SERVER}/static.txt`, function(data, status, xhr) {
         expect($.trim(data)).to.eql("hello world");
         return done();
       });
@@ -52,7 +60,7 @@
     return it('should allow post resource', function(done) {
       return $.ajax({
         type: 'POST',
-        url: "http://" + CORS_SERVER + "/cors",
+        url: `http://${CORS_SERVER}/cors`,
         beforeSend: function(xhr) {
           return xhr.setRequestHeader('X-Requested-With', 'XMLHTTPRequest');
         },

data/test/unit/cors_test.rb

@@ -19,11 +19,11 @@ end
 
 module MiniTest::Assertions
   def assert_cors_success(response)
-  	assert !response.headers['Access-Control-Allow-Origin'].nil?, "Expected a successful CORS response"
+    assert !response.headers['Access-Control-Allow-Origin'].nil?, "Expected a successful CORS response"
   end
 
   def assert_not_cors_success(response)
-  	assert response.headers['Access-Control-Allow-Origin'].nil?, "Expected a failed CORS response"
+    assert response.headers['Access-Control-Allow-Origin'].nil?, "Expected a failed CORS response"
   end
 end
 
@@ -40,6 +40,18 @@ class CaptureResult
   end
 end
 
+class FakeProxy
+  def initialize(app, options =  {})
+    @app = app
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+    headers['Vary'] = %w(Origin User-Agent)
+    [status, headers, body]
+  end
+end
+
 Rack::MockResponse.infect_an_assertion :assert_cors_success, :must_render_cors_success, :only_one_argument
 Rack::MockResponse.infect_an_assertion :assert_not_cors_success, :wont_render_cors_success, :only_one_argument
 
@@ -48,11 +60,12 @@ describe Rack::Cors do
 
   attr_accessor :cors_result
 
-  def load_app(name)
+  def load_app(name, options = {})
     test = self
     Rack::Builder.new do
       use CaptureResult, :holder => test
       eval File.read(File.dirname(__FILE__) + "/#{name}.ru")
+      use FakeProxy if options[:proxy]
       map('/') do
         run proc { |env|
           [200, {'Content-Type' => 'text/html'}, ['success']]
@@ -133,6 +146,15 @@ describe Rack::Cors do
     last_response.headers['Vary'].must_equal 'Origin, Host'
   end
 
+  describe 'with array of upstream Vary headers' do
+    let(:app) { load_app('test', { proxy: true }) }
+
+    it 'should add to them' do
+      successful_cors_request '/vary_test'
+      last_response.headers['Vary'].must_equal 'Origin, User-Agent, Host'
+    end
+  end
+
   it 'should add Vary header if Access-Control-Allow-Origin header was added and if it is specific' do
     successful_cors_request '/', :origin => "http://192.168.0.3:8080"
     last_response.headers['Access-Control-Allow-Origin'].must_equal 'http://192.168.0.3:8080'
@@ -244,6 +266,19 @@ describe Rack::Cors do
         cors.call({'HTTP_ORIGIN' => 'test.com'})
       end
     end
+
+    it 'should use Logger if none is set' do
+      app = mock
+      app.stubs(:call).returns([200, {}, ['']])
+
+      logger = mock
+      Logger.expects(:new).returns(logger)
+      logger.expects(:tap).returns(logger)
+      logger.expects(:debug)
+
+      cors = Rack::Cors.new(app, :debug => true) {}
+      cors.call({'HTTP_ORIGIN' => 'test.com'})
+    end
   end
 
   describe 'preflight requests' do
@@ -280,6 +315,11 @@ describe Rack::Cors do
       last_response.must_render_cors_success
     end
 
+    it 'allows PATCH method' do
+      preflight_request('http://localhost:3000', '/', :methods => [ :patch ])
+      last_response.must_render_cors_success
+    end
+
     it 'should allow header case insensitive match' do
       preflight_request('http://localhost:3000', '/single_header', :headers => 'X-Domain-Token')
       last_response.must_render_cors_success
@@ -313,12 +353,6 @@ describe Rack::Cors do
       last_response.headers['Access-Control-Allow-Origin'].must_equal 'file://'
     end
 
-    it 'should return a Content-Type' do
-      preflight_request('http://localhost:3000', '/')
-      last_response.must_render_cors_success
-      last_response.headers['Content-Type'].wont_be_nil
-    end
-
     describe '' do
 
       let(:app) do
@@ -332,7 +366,7 @@ describe Rack::Cors do
             end
           end
           map('/') do
-            run ->(env) { [500, {'Content-Type' => 'text/plain'}, ['FAIL!']] }
+            run ->(env) { [500, {}, ['FAIL!']] }
           end
         end
       end
@@ -389,7 +423,7 @@ describe Rack::Cors do
           end
         end
         map('/') do
-          run ->(env) { [200, {'Content-Type' => 'text/plain', 'Access-Control-Allow-Origin' => 'http://foo.net'}, ['success']] }
+          run ->(env) { [200, {'Access-Control-Allow-Origin' => 'http://foo.net'}, ['success']] }
         end
       end
     end

data/test/unit/test.ru

@@ -19,6 +19,7 @@ use Rack::Cors do
     resource '/expose_multiple_headers', :expose => %w{expose-test-1 expose-test-2}
     resource '/conditional', :methods => :get, :if => proc { |env| !!env['HTTP_X_OK'] }
     resource '/vary_test', :methods => :get, :vary => %w{ Origin Host }
+    resource '/patch_test', :methods => :patch
     # resource '/file/at/*',
     #     :methods => [:get, :post, :put, :delete],
     #     :headers => :any,

metadata

@@ -1,87 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: rack-cors
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Calvin Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.0
+        version: 5.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.0
+        version: 5.11.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 'Middleware that will make Rack-based apps CORS compatible.  Read more
-  here: http://blog.sourcebender.com/2010/06/09/introducin-rack-cors.html.  Fork the
+        version: 1.1.0
+description: 'Middleware that will make Rack-based apps CORS compatible. Fork the
   project here: https://github.com/cyu/rack-cors'
 email:
 - me@sourcebender.com
@@ -90,7 +95,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -129,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Middleware for enabling Cross-Origin Resource Sharing in Rack apps