charcoal 0.1

data/Appraisals

@@ -0,0 +1,18 @@
+appraise "rails-2.3" do
+  gem "activesupport", "~> 2.3.5"
+  gem "actionpack", "~> 2.3.5"
+end
+
+appraise "rails-3.1" do
+  gem "activesupport", "~> 3.1.0"
+  gem "actionpack", "~> 3.1.0"
+  gem "railties", "~> 3.1.0"
+  gem "tzinfo"
+end
+
+appraise "rails-3.2" do
+  gem "activesupport", "~> 3.2.0"
+  gem "actionpack", "~> 3.2.0"
+  gem "railties", "~> 3.2.0"
+  gem "tzinfo"
+end

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "rake"
+
+gem "activesupport", ">= 2.3.5"
+gem "actionpack", ">= 2.3.5"
+
+gem "yard", "~> 0.7", :group => :development
+gem "bundler", "~> 1.2.0", :group => :development
+gem "jeweler", "~> 1.8.4", :group => :development
+
+gem "appraisal", ">= 0.5.0", :group => :test
+gem "shoulda", ">= 0", :group => :test
+gem "shoulda-context", ">= 0", :group => :test
+gem "mocha", :group => :test

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Steven Davidovitz
+
+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,36 @@
+# charcoal
+
+JSONP ("JSON with padding") and CORS (Cross-Origin Resource Sharing) filtration for Rails versions 2 and above.
+
+## Usage
+
+### JSONP
+
+Include the module `Charcoal::JSONP` in the controller you'd like to allow JSONP.
+You may then use `allow_jsonp` class method with the following options:
+
+
+Requests that come in with a callback parameter (e.g. `http://test.com/users.json?callback=hello`)
+will have the response body wrapped in that callback and the content type changed to `application/javascript`
+
+### CORS
+
+Include the module `Charcoal::CORS` in the controller you'd like to allow CORS.
+Preflight controller...
+
+
+## Contributing to charcoal
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Steven Davidovitz. See LICENSE for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'charcoal/version'
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "charcoal"
+  gem.version = Charcoal::VERSION
+  gem.homepage = "http://github.com/steved555/charcoal"
+  gem.license = "MIT"
+  gem.summary = %Q{Cross-Origin helper for Rails}
+  gem.description = %Q{Helps you support JSONP and CORS in your Rails app}
+  gem.email = "sdavidovitz@zendesk.com"
+  gem.authors = ["Steven Davidovitz"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'appraisal'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc 'Test the plugin under all supported Rails versions.'
+task :all => ["appraisal:cleanup", "appraisal:install"] do
+  exec('rake appraisal test')
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/charcoal.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "charcoal"
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steven Davidovitz"]
+  s.date = "2012-11-21"
+  s.description = "Helps you support JSONP and CORS in your Rails app"
+  s.email = "sdavidovitz@zendesk.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Appraisals",
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "charcoal.gemspec",
+    "gemfiles/rails_2.3.gemfile",
+    "gemfiles/rails_2.3.gemfile.lock",
+    "gemfiles/rails_3.1.gemfile",
+    "gemfiles/rails_3.1.gemfile.lock",
+    "gemfiles/rails_3.2.gemfile",
+    "gemfiles/rails_3.2.gemfile.lock",
+    "lib/charcoal.rb",
+    "lib/charcoal/controller_filter.rb",
+    "lib/charcoal/cors.rb",
+    "lib/charcoal/cors_controller.rb",
+    "lib/charcoal/cors_helper.rb",
+    "lib/charcoal/jsonp.rb",
+    "lib/charcoal/version.rb",
+    "test/cors_controller_test.rb",
+    "test/cors_test.rb",
+    "test/filters_test.rb",
+    "test/helper.rb",
+    "test/jsonp_test.rb"
+  ]
+  s.homepage = "http://github.com/steved555/charcoal"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Cross-Origin helper for Rails"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 2.3.5"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<actionpack>, [">= 2.3.5"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<actionpack>, [">= 2.3.5"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/gemfiles/rails_2.3.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "yard", "~> 0.7", :group=>:development
+gem "bundler", "~> 1.2.0", :group=>:development
+gem "jeweler", "~> 1.8.4", :group=>:development
+gem "appraisal", ">= 0.5.0", :group=>:test
+gem "shoulda", ">= 0", :group=>:test
+gem "shoulda-context", ">= 0", :group=>:test
+gem "mocha", :group=>:test
+gem "activesupport", "~> 2.3.5"
+gem "actionpack", "~> 2.3.5"
+

data/gemfiles/rails_2.3.gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activesupport (2.3.14)
+    appraisal (0.5.1)
+      bundler
+      rake
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.13.0)
+      metaclass (~> 0.0.1)
+    rack (1.1.3)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 2.3.5)
+  activesupport (~> 2.3.5)
+  appraisal (>= 0.5.0)
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  mocha
+  rake
+  shoulda
+  shoulda-context
+  yard (~> 0.7)

data/gemfiles/rails_3.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "yard", "~> 0.7", :group=>:development
+gem "bundler", "~> 1.2.0", :group=>:development
+gem "jeweler", "~> 1.8.4", :group=>:development
+gem "appraisal", ">= 0.5.0", :group=>:test
+gem "shoulda", ">= 0", :group=>:test
+gem "shoulda-context", ">= 0", :group=>:test
+gem "mocha", :group=>:test
+gem "activesupport", "~> 3.1.0"
+gem "actionpack", "~> 3.1.0"
+gem "railties", "~> 3.1.0"
+gem "tzinfo"
+

data/gemfiles/rails_3.1.gemfile.lock

@@ -0,0 +1,88 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.1.8)
+      activemodel (= 3.1.8)
+      activesupport (= 3.1.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.6)
+      rack-cache (~> 1.2)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.4)
+    activemodel (3.1.8)
+      activesupport (= 3.1.8)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.8)
+      multi_json (>= 1.0, < 1.3)
+    appraisal (0.5.1)
+      bundler
+      rake
+    builder (3.0.4)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.13.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.2.0)
+    rack (1.3.6)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.1.8)
+      actionpack (= 3.1.8)
+      activesupport (= 3.1.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
+    sprockets (2.0.4)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    tzinfo (0.3.35)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.1.0)
+  activesupport (~> 3.1.0)
+  appraisal (>= 0.5.0)
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  mocha
+  railties (~> 3.1.0)
+  rake
+  shoulda
+  shoulda-context
+  tzinfo
+  yard (~> 0.7)

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "yard", "~> 0.7", :group=>:development
+gem "bundler", "~> 1.2.0", :group=>:development
+gem "jeweler", "~> 1.8.4", :group=>:development
+gem "appraisal", ">= 0.5.0", :group=>:test
+gem "shoulda", ">= 0", :group=>:test
+gem "shoulda-context", ">= 0", :group=>:test
+gem "mocha", :group=>:test
+gem "activesupport", "~> 3.2.0"
+gem "actionpack", "~> 3.2.0"
+gem "railties", "~> 3.2.0"
+gem "tzinfo"
+

data/gemfiles/rails_3.2.gemfile.lock

@@ -0,0 +1,86 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.5.1)
+      bundler
+      rake
+    builder (3.0.4)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.13.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.7)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    tzinfo (0.3.35)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.2.0)
+  activesupport (~> 3.2.0)
+  appraisal (>= 0.5.0)
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  mocha
+  railties (~> 3.2.0)
+  rake
+  shoulda
+  shoulda-context
+  tzinfo
+  yard (~> 0.7)

data/lib/charcoal.rb

@@ -0,0 +1,19 @@
+module Charcoal
+  def self.configuration
+    @configuration ||= {
+      "credentials" => true,
+      "expose-headers" => %w{},
+      "allow-headers" => %w{X-Requested-With X-Prototype-Version},
+      "max-age" => 86400,
+      "allow-origin" => "*"
+    }
+  end
+
+  autoload :ControllerFilter, 'charcoal/controller_filter'
+  autoload :CORS, 'charcoal/cors'
+  autoload :JSONP, 'charcoal/jsonp'
+
+  autoload :CORSController, 'charcoal/cors_controller'
+  # autoload :ParameterWhitelist, "charcoal/parameter_whitelist"
+end
+

data/lib/charcoal/controller_filter.rb

@@ -0,0 +1,42 @@
+module Charcoal
+  module ControllerFilter
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def allow(filter, &block)
+        define_method "allow_#{filter}" do |*args|
+          # If we don't need 1.8 compat then ->(options = {}) instead of *args and the next line
+          options = args.last.is_a?(Hash) ? args.pop : {}
+          options.assert_valid_keys(:only, :except, :if, :unless)
+
+          methods = args.map(&:to_sym)
+          methods = [:all] if methods.empty?
+
+          if options[:unless]
+            directive = lambda {|c| !parse_directive(options[:unless]).call(c)}
+          else
+            directive = parse_directive(options[:if] || true)
+          end
+
+          methods.each do |method|
+            instance_exec(method, directive, &block)
+          end
+        end
+      end
+    end
+
+    private
+
+    def parse_directive(directive)
+      return directive if directive.respond_to?(:call)
+
+      if directive.respond_to?(:to_sym) && method_defined?(directive.to_sym)
+        lambda {|c| c.send(directive.to_sym)}
+      else
+        lambda {|c| directive}
+      end
+    end
+  end
+end

data/lib/charcoal/cors.rb

@@ -0,0 +1,39 @@
+require 'charcoal/controller_filter'
+
+module Charcoal
+  module CORS
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.after_filter :set_cors_headers, :if => :cors_allowed?
+    end
+
+    module ClassMethods
+      include ControllerFilter
+
+      def cors_allowed
+        @cors_allowed ||= Hash.new(lambda {|_| false})
+      end
+
+      allow :cors do |method, directive|
+        cors_allowed[method.to_sym] = directive
+      end
+
+      def cors_allowed?(instance, action)
+        cors_allowed[action.to_sym].try(:call, instance) ||
+          (action != :all && cors_allowed?(instance, :all))
+      end
+    end
+
+    def cors_allowed?
+      self.class.cors_allowed?(self, params[:action])
+    end
+
+    protected
+
+    def set_cors_headers
+      headers["Access-Control-Allow-Origin"] = Charcoal.configuration["allow-origin"].to_s
+      headers["Access-Control-Allow-Credentials"] = Charcoal.configuration["credentials"].to_s
+      headers["Access-Control-Expose-Headers"] = Charcoal.configuration["expose-headers"].join(",")
+    end
+  end
+end

data/lib/charcoal/cors_controller.rb

@@ -0,0 +1,48 @@
+# This controller handles CORS preflight requests
+# See https://developer.mozilla.org/En/HTTP_access_control for documentation
+
+require 'action_controller'
+require 'active_support/version'
+
+require 'charcoal/cors_helper'
+
+class Charcoal::CORSController < ActionController::Base
+  include Charcoal::CORS
+
+  # OPTIONS *
+  def preflight
+    allowed_methods = ActionController::Routing::HTTP_METHODS.select do |verb|
+      begin
+        route = if ActiveSupport::VERSION::MAJOR >= 3
+          Rails.application.routes.recognize_path(request.path, request.env.merge(:method => verb))
+        else
+          ActionController::Routing::Routes.routes.find {|r| r.recognize(request.path, request.env.merge(:method => verb))}
+        end
+
+        if route
+          route = route.requirements if ActiveSupport::VERSION::MAJOR < 3
+
+          controller = route[:controller].camelize
+          controller = "#{controller}Controller".constantize
+
+          action = route[:action] || params[:path].last.split(".").first
+
+          controller.respond_to?(:cors_allowed) && controller.cors_allowed?(self, action)
+        else
+          false
+        end
+      rescue ActionController::RoutingError
+        false
+      end
+    end
+
+    if allowed_methods.any?
+      set_cors_headers
+      headers["Access-Control-Allow-Methods"] = allowed_methods.join(",").upcase
+      headers["Access-Control-Max-Age"] = Charcoal.configuration["max-age"].to_s
+      headers['Access-Control-Allow-Headers'] = Charcoal.configuration["allow-headers"].join(",")
+    end
+
+    head :ok, :content_type => "text/plain"
+  end
+end

data/lib/charcoal/cors_helper.rb

@@ -0,0 +1,3 @@
+# Rails tries to load this by default
+# and blows up if it can't find it
+module Charcoal::CorsHelper; end

data/lib/charcoal/jsonp.rb

@@ -0,0 +1,46 @@
+require 'charcoal/controller_filter'
+
+module Charcoal
+  module JSONP
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.prepend_around_filter :add_jsonp_callback
+    end
+
+    module ClassMethods
+      include ControllerFilter
+
+      def jsonp_allowed
+        @jsonp_allowed ||= Hash.new(lambda {|_| false})
+      end
+
+      allow :jsonp do |method, directive|
+        jsonp_allowed[method.to_sym] = directive
+      end
+
+      def jsonp_allowed?(instance, action)
+        jsonp_allowed[action.to_sym].try(:call, instance) ||
+          (action != :all && jsonp_allowed?(instance, :all))
+      end
+    end
+
+    def jsonp_allowed?
+      self.class.jsonp_allowed?(self, params[:action])
+    end
+
+    def jsonp_request?
+      params[:callback].present? && jsonp_allowed?
+    end
+
+    protected
+
+    def add_jsonp_callback
+      yield
+
+      if response.status.to_s.starts_with?('200') && jsonp_request?
+        response.body = "#{params[:callback]}(#{response.body})"
+        response.content_type = "application/javascript"
+      end
+    end
+  end
+end

data/lib/charcoal/version.rb

@@ -0,0 +1,3 @@
+module Charcoal
+  VERSION = "0.1"
+end

data/test/cors_controller_test.rb

@@ -0,0 +1,54 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+class TestController < ActionController::Base
+  include Charcoal::CORS
+  allow_cors :test
+
+  # GET, PUT
+  def test; end
+end
+
+class Charcoal::CORSControllerTest < ActionController::TestCase
+  context Charcoal::CORSController do
+    setup do
+      @request.env["HTTPS"] = "on"
+    end
+
+    context "unrecognized path to #preflight" do
+      setup do
+        @request.stubs(:path => "/my_unrecognized_path")
+        get :preflight
+      end
+
+      should "allow proper methods" do
+        assert_nil @response.headers["Access-Control-Allow-Methods"], @response.headers.inspect
+      end
+    end
+
+    context "OPTIONS to #preflight" do
+      context "with request method = OPTIONS" do
+        setup do
+          @request.stubs(:path => "/test")
+          get :preflight
+        end
+
+        should "allow proper methods" do
+          assert_equal "GET,PUT", @response.headers["Access-Control-Allow-Methods"], @response.headers.inspect
+        end
+
+        should "set Access-Control-Allow-Headers header" do
+          assert_equal Charcoal.configuration["allow-headers"].join(","), @response.headers["Access-Control-Allow-Headers"], @response.headers.inspect
+        end
+
+        should "set Access-Control-Max-Age header" do
+          assert_equal Charcoal.configuration["max-age"].to_s, @response.headers["Access-Control-Max-Age"], @response.headers.inspect
+        end
+
+        should "render text/plain response" do
+          assert_equal " ", @response.body
+          assert_match %r[text/plain], @response.headers["Content-Type"], @response.headers.inspect
+        end
+      end
+    end
+  end
+end

data/test/cors_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class TestCorsController < ActionController::Base
+  include Charcoal::CORS
+
+  allow_cors :test_action
+
+  def test_action
+    render :text => "noop"
+  end
+end
+
+class TestCorsControllerTest < ActionController::TestCase
+  context TestCorsController do
+    context "allowing cors" do
+      subject { TestCorsController.new }
+
+      setup do
+        subject.params = { :action => "test_action" }
+      end
+
+      should "allow cors" do
+        assert subject.cors_allowed?
+      end
+    end
+
+    context "cors callback" do
+      {
+        "Access-Control-Allow-Origin" => "allow-origin",
+        "Access-Control-Allow-Credentials" => "credentials",
+      }.each do |header, key|
+        context "CORS header -> #{header}" do
+          setup do
+            @original, Charcoal.configuration[key] = Charcoal.configuration[key], "test"
+
+            get :test_action
+          end
+
+          teardown do
+            Charcoal.configuration[key] = @original
+          end
+
+          should "be the same as the configuration" do
+            assert_equal "test", @response.headers[header], @response.headers.inspect
+          end
+        end
+      end
+
+      context "without any other request method" do
+        setup do
+          @original, Charcoal.configuration["expose-headers"] = Charcoal.configuration["expose-headers"], %w{test 123}
+
+          get :test_action
+        end
+
+        teardown do
+          Charcoal.configuration["expose-headers"] = @original
+        end
+
+        should "render action" do
+          assert_equal "noop", @response.body
+        end
+
+        should "set Access-Control-Expose-Headers" do
+          assert_equal "test,123", @response.headers["Access-Control-Expose-Headers"], @response.headers.inspect
+        end
+      end
+    end
+  end
+end

data/test/filters_test.rb

@@ -0,0 +1,128 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class FiltersControllerTester < ActionController::Base
+  class << self
+    include Charcoal::ControllerFilter
+
+    allow :filtering do |method, directive|
+      filtering_allowed[method] = directive
+    end
+
+    def filtering_allowed
+      @filtering_allowed ||= Hash.new(lambda {|_| false })
+    end
+
+    def filtering_allowed?(instance, action)
+      filtering_allowed[action.to_sym].try(:call, instance) ||
+        (action != :all && filtering_allowed?(instance, :all))
+    end
+  end
+
+  def filtering_allowed?
+    self.class.filtering_allowed?(self, params[:action])
+  end
+
+  def test_action1; true; end
+  def test_action2; false; end
+end
+
+class FiltersTest < ActiveSupport::TestCase
+  context Charcoal::ControllerFilter do
+    subject { FiltersControllerTester.new  }
+    setup do
+      subject.params = {}
+    end
+
+    context "controller action filtering" do
+      teardown do
+        FiltersControllerTester.filtering_allowed.clear
+      end
+
+      context "if" do
+        context "with a lambda" do
+          setup { FiltersControllerTester.allow_filtering :test_action1, :if => lambda {|c| c.test_action1 } }
+
+          should "should allow filtering for test_action1" do
+            subject.params.replace(:action => :test_action1)
+            assert subject.filtering_allowed?
+          end
+        end
+
+        context "with a method" do
+          setup { FiltersControllerTester.allow_filtering :test_action1, :if => :test_action1 }
+
+          should "should allow filtering for test_action1" do
+            subject.params.replace(:action => :test_action1)
+            assert subject.filtering_allowed?
+          end
+        end
+
+        context "with a true/false" do
+          setup { FiltersControllerTester.allow_filtering :test_action1, :if => true }
+
+          should "should allow filtering for test_action1" do
+            subject.params.replace(:action => :test_action1)
+            assert subject.filtering_allowed?
+          end
+        end
+      end
+
+      context "unless" do
+        context "with a lambda" do
+          setup { FiltersControllerTester.allow_filtering :test_action1, :unless => lambda {|c| c.test_action2 } }
+
+          should "should allow filtering for test_action1" do
+            subject.params.replace(:action => :test_action1)
+            assert subject.filtering_allowed?
+          end
+        end
+
+        context "with a method" do
+          setup { FiltersControllerTester.allow_filtering :test_action1, :unless => :test_action2 }
+
+          should "should allow filtering for test_action1" do
+            subject.params.replace(:action => :test_action1)
+            assert subject.filtering_allowed?
+          end
+        end
+
+        context "with a true/false" do
+          setup { FiltersControllerTester.allow_filtering :test_action1, :unless => false }
+
+          should "should allow filtering for test_action1" do
+            subject.params.replace(:action => :test_action1)
+            assert subject.filtering_allowed?
+          end
+        end
+      end
+
+      context "only" do
+        setup { FiltersControllerTester.allow_filtering :test_action1 }
+
+        should "should allow filtering for test_action1" do
+          subject.params.replace(:action => :test_action1)
+          assert subject.filtering_allowed?
+        end
+
+        should "should not allow filtering for test_action2" do
+          subject.params.replace(:action => :test_action2)
+          assert !subject.filtering_allowed?
+        end
+      end
+
+      context "none" do
+        setup { FiltersControllerTester.allow_filtering }
+
+        should "should allow filtering for test_action1" do
+          subject.params.replace(:action => :test_action1)
+          assert subject.filtering_allowed?
+        end
+
+        should "should allow filtering for test_action2" do
+          subject.params.replace(:action => :test_action1)
+          assert subject.filtering_allowed?
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+
+ENV["RAILS_ENV"] = "test"
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'active_support/version'
+
+if ActiveSupport::VERSION::MAJOR >= 3
+  require "action_controller/railtie"
+  require "rails/test_unit/railtie"
+
+  class TestApp < Rails::Application
+    config.active_support.deprecation = :stderr
+    config.logger = Logger.new(RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i ? 'NUL:' : '/dev/null')
+  end
+
+  TestApp.initialize!
+
+  TestApp.routes.draw do
+    match '/test' => "test#test", :via => [:get, :put]
+    match ':controller/:action'
+  end
+
+  class ActionController::TestCase
+    def setup
+      @routes = TestApp.routes
+    end
+  end
+else
+  require "action_controller"
+  require "active_support"
+
+  MissingSourceFile::REGEXPS.push([/^cannot load such file -- (.+)$/i, 1])
+
+  ActionController::Routing::Routes.draw do |map|
+    map.connect '/test', :controller => :test, :action => :test, :conditions => { :method => [:get, :put] }
+    map.connect ':controller/:action'
+  end
+
+  ActionDispatch = ActionController
+end
+
+require 'test/unit'
+require 'shoulda'
+
+require 'charcoal'

data/test/jsonp_test.rb

@@ -0,0 +1,105 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class JSONPControllerTester < ActionController::Base
+  include Charcoal::JSONP
+
+  caches_action :test
+  allow_jsonp :test
+
+  def test
+    render :json => { :key => :value }
+  end
+end
+
+class JSONPTest < ActionController::TestCase
+  tests JSONPControllerTester
+
+  context JSONPControllerTester do
+    context "with caching" do
+      setup do
+        @caching, ActionController::Base.perform_caching = ActionController::Base.perform_caching, true
+        @cache_store, ActionController::Base.cache_store = ActionController::Base.cache_store, :memory_store
+      end
+
+      teardown do
+        ActionController::Base.perform_caching = @caching
+        ActionController::Base.cache_store = @cache_store
+      end
+
+      context "a GET to :test" do
+        setup do
+          get :test, :callback => "hello"
+        end
+
+        should "return a proper response" do
+          assert_match /hello\(.*\)/, @response.body
+        end
+
+        should "return a proper response type" do
+          assert_equal "application/javascript", @response.content_type
+        end
+
+        context "a second call" do
+          setup do
+            get :test, :callback => "hello"
+          end
+
+          should "properly cache the response" do
+            assert_match /hello\(.*\)/, @response.body
+          end
+
+          should "properly cache the response type" do
+            assert_equal "application/javascript", @response.content_type
+          end
+        end
+      end
+    end
+  end
+
+  context Charcoal::JSONP do
+    subject { JSONPControllerTester.new }
+
+    setup do
+      subject.params = {}
+    end
+
+    context "jsonp callback" do
+      setup do
+        @response = '{"test": 123}'
+        @content_type = "application/json"
+
+        subject.response = ActionDispatch::Response.new
+        subject.response.body = @response
+        subject.response.status = '200 OK'
+        subject.response.content_type = @content_type
+      end
+
+      context "with params" do
+        setup do
+          subject.params.replace(:callback => "callback", :action => "test")
+          subject.send(:add_jsonp_callback) {}
+        end
+
+        should "add jsonp if there is a callback" do
+          assert_equal "callback(#{@response})", subject.response.body
+        end
+
+        should "change content-type" do
+          assert_equal "application/javascript", subject.response.content_type
+        end
+      end
+
+      context "without params" do
+        setup { subject.send(:add_jsonp_callback) {} }
+
+        should "not add jsonp callback" do
+          assert_equal @response, subject.response.body
+        end
+
+        should "not change content-type" do
+          assert_equal @content_type, subject.response.content_type
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: charcoal
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Steven Davidovitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Helps you support JSONP and CORS in your Rails app
+email: sdavidovitz@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- charcoal.gemspec
+- gemfiles/rails_2.3.gemfile
+- gemfiles/rails_2.3.gemfile.lock
+- gemfiles/rails_3.1.gemfile
+- gemfiles/rails_3.1.gemfile.lock
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_3.2.gemfile.lock
+- lib/charcoal.rb
+- lib/charcoal/controller_filter.rb
+- lib/charcoal/cors.rb
+- lib/charcoal/cors_controller.rb
+- lib/charcoal/cors_helper.rb
+- lib/charcoal/jsonp.rb
+- lib/charcoal/version.rb
+- test/cors_controller_test.rb
+- test/cors_test.rb
+- test/filters_test.rb
+- test/helper.rb
+- test/jsonp_test.rb
+homepage: http://github.com/steved555/charcoal
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1806808510332302197
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cross-Origin helper for Rails
+test_files: []