rack-cors 0.2.7 → 0.2.8

data/Gemfile

@@ -5,7 +5,8 @@ gem "rack"
 group :development do
   gem "rake"
   gem "shoulda"
+  gem "mocha"
   gem "rack-test"
-  gem "bundler", "~> 1.1.0"
+  gem "bundler", ">= 1.1.0"
   gem "jeweler", "~> 1.8.3"
 end

data/README.rdoc

@@ -13,7 +13,7 @@ http://www.w3.org/TR/access-control/#simple-cross-origin-request-and-actual-r
 Install the gem:
 
   gem install rack-cors
-  
+
 In your Gemfile:
 
   gem 'rack-cors', :require => 'rack/cors'
@@ -31,7 +31,7 @@ You configure Rack::Cors by passing a block to the <tt>use</tt> command:
 
       resource '/file/list_all/', :headers => 'x-domain-token'
       resource '/file/at/*',
-          :methods => [:get, :post, :put, :delete],
+          :methods => [:get, :post, :put, :delete, :options],
           :headers => 'x-domain-token',
           :expose => ['Some-Custom-Response-Header']
           # headers to expose
@@ -42,3 +42,22 @@ You configure Rack::Cors by passing a block to the <tt>use</tt> command:
       resource '/public/*', :headers => :any, :methods => :get
     end
   end
+
+Put your code in "config/application.rb" on your rails application. For example, this will allow
+from any origins on any resource of your application, methods :get, :post and :options.
+
+  module YourApp
+    class Application < Rails::Application
+
+    # ...
+
+    config.middleware.use Rack::Cors do
+      allow do
+        origins '*'
+        resource '*', :headers => :any, :methods => [:get, :post, :options]
+      end
+    end
+  end
+
+See http://guides.rubyonrails.org/rails_on_rack.html for more details on rack middlewares or
+http://railscasts.com/episodes/151-rack-middleware.

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.2.8

data/lib/rack/cors.rb

@@ -5,11 +5,14 @@ module Rack
     def initialize(app, opts={}, &block)
       @app = app
       @logger = opts[:logger]
+      @debug_mode = !!opts[:debug]
 
-      if block.arity == 1
-        block.call(self)
-      else
-        instance_eval(&block)
+      if block_given?
+        if block.arity == 1
+          block.call(self)
+        else
+          instance_eval(&block)
+        end
       end
     end
 
@@ -61,10 +64,12 @@ module Rack
 
     protected
       def debug(env, message = nil, &block)
-        logger = @logger || env['rack.logger'] || begin
-          @logger = ::Logger.new(STDOUT).tap {|logger| logger.level = ::Logger::Severity::INFO}
+        if @debug_mode
+          logger = @logger || env['rack.logger'] || begin
+            @logger = ::Logger.new(STDOUT).tap {|logger| logger.level = ::Logger::Severity::INFO}
+          end
+          logger.debug(message, &block)
         end
-        logger.debug(message, &block)
       end
 
       def all_resources
@@ -72,17 +77,17 @@ module Rack
       end
 
       def process_preflight(env)
-        resource = find_resource(env['HTTP_ORIGIN'], env['PATH_INFO'])
+        resource = find_resource(env['HTTP_ORIGIN'], env['PATH_INFO'],env)
         resource && resource.process_preflight(env)
       end
 
       def process_cors(env)
-        resource = find_resource(env['HTTP_ORIGIN'], env['PATH_INFO'])
+        resource = find_resource(env['HTTP_ORIGIN'], env['PATH_INFO'],env)
         resource.to_headers(env) if resource
       end
 
-      def find_resource(origin, path)
-        allowed = all_resources.detect {|r| r.allow_origin?(origin)}
+      def find_resource(origin, path, env)
+        allowed = all_resources.detect {|r| r.allow_origin?(origin,env)}
         allowed ? allowed.find_resource(path) : nil
       end
 
@@ -93,14 +98,16 @@ module Rack
           @public_resources = false
         end
 
-        def origins(*args)
+        def origins(*args,&blk)
           @origins = args.flatten.collect do |n|
             case n
             when Regexp, /^https?:\/\// then n
+            when 'file://'              then n
             when '*'                    then @public_resources = true; n
             else                        "http://#{n}"
             end
           end
+          @origins.push(blk) if blk
         end
 
         def resource(path, opts={})
@@ -111,8 +118,15 @@ module Rack
           @public_resources
         end
 
-        def allow_origin?(source)
-          public_resources? || !!@origins.detect {|origin| origin === source}
+        def allow_origin?(source,env = {})
+          return true if public_resources?
+          return !! @origins.detect do |origin|
+            if origin.is_a?(Proc)
+              origin.call(source,env)
+            else
+              origin === source
+            end
+          end
         end
 
         def find_resource(path)
@@ -152,7 +166,8 @@ module Rack
 
         def to_headers(env)
           x_origin = env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']
-          h = { 'Access-Control-Allow-Origin' => credentials ? env['HTTP_ORIGIN'] : public_resource? ? '*' : env['HTTP_ORIGIN'],
+          h = {
+            'Access-Control-Allow-Origin'     => origin_for_response_header(env['HTTP_ORIGIN']),
             'Access-Control-Allow-Methods'    => methods.collect{|m| m.to_s.upcase}.join(', '),
             'Access-Control-Expose-Headers'   => expose.nil? ? '' : expose.join(', '),
             'Access-Control-Max-Age'          => max_age.to_s }
@@ -165,6 +180,11 @@ module Rack
             @public_resource
           end
 
+          def origin_for_response_header(origin)
+            return '*' if public_resource? && !credentials
+            origin == 'file://' ? 'null' : origin
+          end
+
           def to_preflight_headers(env)
             h = to_headers(env)
             if env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']

data/rack-cors.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-cors"
-  s.version = "0.2.7"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Calvin Yu"]
-  s.date = "2012-06-07"
+  s.date = "2013-05-31"
   s.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 project here: http://github.com/cyu/rack-cors"
   s.email = "me@sourcebender.com"
   s.extra_rdoc_files = [
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/cyu/rack-cors"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.23"
   s.summary = "Middleware for enabling Cross-Origin Resource Sharing in Rack apps"
 
   if s.respond_to? :specification_version then
@@ -41,23 +41,26 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rack>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
     else
       s.add_dependency(%q<rack>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<rack-test>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<bundler>, [">= 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     end
   else
     s.add_dependency(%q<rack>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<rack-test>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<bundler>, [">= 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
   end
 end

data/test/unit/cors_test.rb

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'rack/test'
 require 'shoulda'
+require 'mocha'
+require 'rack/cors'
 
 Rack::Test::Session.class_eval do
   def options(uri, params = {}, env = {}, &block)
@@ -26,6 +28,10 @@ class CorsTest < Test::Unit::TestCase
     cors_request :origin => 'http://192.168.0.1:1234'
   end
 
+  should 'support proc origins configuration' do
+    cors_request '/proc-origin', :origin => 'http://10.10.10.10:3000'
+  end
+
   should 'support alternative X-Origin header' do
     header 'X-Origin', 'http://localhost:3000'
     get '/'
@@ -35,7 +41,6 @@ class CorsTest < Test::Unit::TestCase
   should 'support expose header configuration' do
     cors_request '/expose_single_header'
     assert_equal 'expose-test', last_response.headers['Access-Control-Expose-Headers']
-
   end
 
   should 'support expose multiple header configuration' do
@@ -57,6 +62,28 @@ class CorsTest < Test::Unit::TestCase
     assert_nil last_response.headers['Vary'], 'no expecting Vary header'
   end
 
+  should 'not log debug messages if debug option is false' do
+    app = mock
+    app.stubs(:call).returns(200, {}, [''])
+
+    logger = mock
+    logger.expects(:debug).never
+
+    cors = Rack::Cors.new(app, :debug => false, :logger => logger) {}
+    cors.send(:debug, {}, 'testing')
+  end
+
+  should 'log debug messages if debug option is true' do
+    app = mock
+    app.stubs(:call).returns(200, {}, [''])
+
+    logger = mock
+    logger.expects(:debug)
+
+    cors = Rack::Cors.new(app, :debug => true, :logger => logger) {}
+    cors.send(:debug, {}, 'testing')
+  end
+
   context 'preflight requests' do
     should 'fail if origin is invalid' do
       preflight_request('http://allyourdataarebelongtous.com', '/')
@@ -110,6 +137,12 @@ class CorsTest < Test::Unit::TestCase
       assert_equal '*', last_response.headers['Access-Control-Allow-Origin']
     end
 
+    should '"null" origin, allowed as "file://", returned as "null" in header' do
+      preflight_request('null', '/')
+      assert_cors_success
+      assert_equal 'null', last_response.headers['Access-Control-Allow-Origin']
+    end
+
     should 'return a Content-Type' do
       preflight_request('http://localhost:3000', '/')
       assert_cors_success

data/test/unit/dsl_test.rb

@@ -7,7 +7,10 @@ class DSLTest < Test::Unit::TestCase
   should 'support explicit config object dsl mode' do
     cors = Rack::Cors.new(Proc.new {}) do |cfg|
       cfg.allow do |allow|
-        allow.origins 'localhost:3000', '127.0.0.1:3000'
+        allow.origins 'localhost:3000', '127.0.0.1:3000' do |source,env|
+          source == "http://10.10.10.10:3000" &&
+          env["USER_AGENT"] == "test-agent"
+        end
         allow.resource '/get-only', :methods => :get
         allow.resource '/', :headers => :any
       end
@@ -15,12 +18,19 @@ class DSLTest < Test::Unit::TestCase
     resources = cors.send :all_resources
     assert_equal 1, resources.length
     assert resources.first.allow_origin?('http://localhost:3000')
+
+    assert  resources.first.allow_origin?('http://10.10.10.10:3000',{"USER_AGENT" => "test-agent" })
+    assert !resources.first.allow_origin?('http://10.10.10.10:3001',{"USER_AGENT" => "test-agent" })
+    assert !resources.first.allow_origin?('http://10.10.10.10:3000',{"USER_AGENT" => "other-agent"})
   end
 
   should 'support implicit config object dsl mode' do
     cors = Rack::Cors.new(Proc.new {}) do
       allow do
-        origins 'localhost:3000', '127.0.0.1:3000'
+        origins 'localhost:3000', '127.0.0.1:3000' do |source,env|
+          source == "http://10.10.10.10:3000" &&
+          env["USER_AGENT"] == "test-agent"
+        end
         resource '/get-only', :methods => :get
         resource '/', :headers => :any
       end
@@ -28,5 +38,20 @@ class DSLTest < Test::Unit::TestCase
     resources = cors.send :all_resources
     assert_equal 1, resources.length
     assert resources.first.allow_origin?('http://localhost:3000')
+
+    assert  resources.first.allow_origin?('http://10.10.10.10:3000',{"USER_AGENT" => "test-agent" })
+    assert !resources.first.allow_origin?('http://10.10.10.10:3001',{"USER_AGENT" => "test-agent" })
+    assert !resources.first.allow_origin?('http://10.10.10.10:3000',{"USER_AGENT" => "other-agent"})
+  end
+
+  should 'support "file://" origin' do
+    cors = Rack::Cors.new(Proc.new {}) do
+      allow do
+        origins 'file://'
+        resource '/', :headers => :any
+      end
+    end
+    resources = cors.send :all_resources
+    assert resources.first.allow_origin?('file://')
   end
-end
+end

data/test/unit/test.ru

@@ -2,7 +2,7 @@ require 'rack/cors'
 
 use Rack::Cors do
   allow do
-    origins 'localhost:3000', '127.0.0.1:3000', /http:\/\/192\.168\.0\.\d{1,3}(:\d+)?/
+    origins 'localhost:3000', '127.0.0.1:3000', /http:\/\/192\.168\.0\.\d{1,3}(:\d+)?/, 'file://'
 
     resource '/get-only', :methods => :get
     resource '/', :headers => :any
@@ -16,6 +16,13 @@ use Rack::Cors do
     #     :max_age => 0
   end
 
+  allow do
+    origins do |source,env|
+      source.end_with?("10.10.10.10:3000")
+    end
+    resource '/proc-origin'
+  end
+
   allow do
     origins '*'
     resource '/public'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-cors
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +96,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
@@ -88,7 +104,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
@@ -142,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4990705370164666
+      hash: -1437619420423070521
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Middleware for enabling Cross-Origin Resource Sharing in Rack apps