charcoal 0.1 → 0.1.1

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - gemfiles/rails_2.3.gemfile
+  - gemfiles/rails_3.1.gemfile
+  - gemfiles/rails_3.2.gemfile

data/Appraisals

@@ -1,18 +1,11 @@
 appraise "rails-2.3" do
-  gem "activesupport", "~> 2.3.5"
-  gem "actionpack", "~> 2.3.5"
+  gem "rails", "~> 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"
+  gem "rails", "~> 3.1.0"
 end
 
 appraise "rails-3.2" do
-  gem "activesupport", "~> 3.2.0"
-  gem "actionpack", "~> 3.2.0"
-  gem "railties", "~> 3.2.0"
-  gem "tzinfo"
+  gem "rails", "~> 3.2.0"
 end

data/Gemfile

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

data/README.md

@@ -9,15 +9,99 @@ JSONP ("JSON with padding") and CORS (Cross-Origin Resource Sharing) filtration
 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:
 
+```ruby
+# directive is a method (symbol) or block (taking one argument, the controller instance)
+allow_jsonp method [method2 ...], :if => directive, :unless => directive
+```
+
+`:all` is also a valid argument that applies to all methods. The default (with no arguments) is the same as `:all`.
 
 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
 
+Please familiarize yourself with the [documentation](https://developer.mozilla.org/En/HTTP_access_control) ([wikipedia](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) before proceeding.
+
 Include the module `Charcoal::CORS` in the controller you'd like to allow CORS.
-Preflight controller...
+`allow_cors` accepts the same arguments as `allow_jsonp`
+
+Included is a CORS pre-flight controller that must be hooked up to the Rails router:
+
+Rails 2:
+```ruby
+map.connect "*path.:format", :conditions => { :method => :options }, :action => "preflight", :controller => "CORS", :namespace => "charcoal"
+```
+
+Rails 3:
+```ruby
+TODO
+```
+
+#### Configuration
+
+The configuration options and defaults for CORS are as follows:
+
+```ruby
+# Access-Control-Allow-Origin
+"allow-origin" => "*"
+
+# Access-Control-Allow-Headers
+"allow-headers" => ["X-Requested-With", "X-Prototype-Version"]
+
+# Sets Access-Control-Allow-Credentials
+"credentials" => true
+
+# Access-Control-Allow-Headers
+"expose-headers" => []
+
+# Access-Control-Max-Age
+"max-age" => 86400
+```
+
+### Creating Your Own Filter
+
+It's possible to create your own controller filter like so:
+
+```ruby
+require 'charcoal/controller_filter'
+
+module MyFilter
+  def self.included(klass)
+    klass.extend(ClassMethods)
+    klass.before_filter :quack, :if => :animals_allowed?
+  end
+
+  module ClassMethods
+    include Charcoal::ControllerFilter
+
+    def animals_allowed
+      @animals_allowed ||= Hash.new(lambda {|_| false})
+    end
+
+    allow :animals do |method, directive|
+      animals_allowed[method] = directive
+    end
+  end
+
+  def animals_allowed?
+    self.class.animals_allowed[params[:action]].call(self)
+  end
+
+  protected
+
+  def quack
+    Rails.logger.info("QUACK!")
+  end
+end
+```
+
+This example adds the `allow_animals` directive that logs "QUACK!" if an applicable request is received.
+
+## Supported Versions
 
+Tested with Ruby 1.8.7 and 1.9.3 and Rails 2.3, 3.1, and 3.2.
+[![Build Status](https://secure.travis-ci.org/steved555/charcoal.png?branch=master)](http://travis-ci.org/steved555/charcoal)
 
 ## Contributing to charcoal
 

data/charcoal.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "charcoal"
-  s.version = "0.1"
+  s.version = "0.1.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.date = "2012-11-27"
   s.description = "Helps you support JSONP and CORS in your Rails app"
   s.email = "sdavidovitz@zendesk.com"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".travis.yml",
     "Appraisals",
     "Gemfile",
     "LICENSE",
@@ -52,24 +53,24 @@ Gem::Specification.new do |s|
     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<rake>, [">= 0"])
       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<rake>, [">= 0"])
       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<rake>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
     s.add_dependency(%q<bundler>, ["~> 1.2.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])

data/gemfiles/rails_2.3.gemfile

@@ -2,14 +2,15 @@
 
 source "http://rubygems.org"
 
-gem "rake"
+gem "activesupport", ">= 2.3.5"
+gem "actionpack", ">= 2.3.5"
+gem "rake", :group=>:development
 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"
+gem "mocha", :require=>false, :group=>:test
+gem "rails", "~> 2.3.5"
 

data/gemfiles/rails_2.3.gemfile.lock

@@ -1,9 +1,15 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (2.3.14)
+      actionpack (= 2.3.14)
     actionpack (2.3.14)
       activesupport (= 2.3.14)
       rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activeresource (2.3.14)
+      activesupport (= 2.3.14)
     activesupport (2.3.14)
     appraisal (0.5.1)
       bundler
@@ -19,13 +25,20 @@ GEM
     mocha (0.13.0)
       metaclass (~> 0.0.1)
     rack (1.1.3)
+    rails (2.3.14)
+      actionmailer (= 2.3.14)
+      actionpack (= 2.3.14)
+      activerecord (= 2.3.14)
+      activeresource (= 2.3.14)
+      activesupport (= 2.3.14)
+      rake (>= 0.8.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-context (1.0.1)
     shoulda-matchers (1.0.0)
     yard (0.8.3)
 
@@ -33,12 +46,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 2.3.5)
-  activesupport (~> 2.3.5)
+  actionpack (>= 2.3.5)
+  activesupport (>= 2.3.5)
   appraisal (>= 0.5.0)
   bundler (~> 1.2.0)
   jeweler (~> 1.8.4)
   mocha
+  rails (~> 2.3.5)
   rake
   shoulda
   shoulda-context

data/gemfiles/rails_3.1.gemfile

@@ -2,16 +2,15 @@
 
 source "http://rubygems.org"
 
-gem "rake"
+gem "activesupport", ">= 2.3.5"
+gem "actionpack", ">= 2.3.5"
+gem "rake", :group=>:development
 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"
+gem "mocha", :require=>false, :group=>:test
+gem "rails", "~> 3.1.0"
 

data/gemfiles/rails_3.1.gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.1.8)
+      actionpack (= 3.1.8)
+      mail (~> 2.3.3)
     actionpack (3.1.8)
       activemodel (= 3.1.8)
       activesupport (= 3.1.8)
@@ -16,11 +19,20 @@ GEM
       activesupport (= 3.1.8)
       builder (~> 3.0.0)
       i18n (~> 0.6)
+    activerecord (3.1.8)
+      activemodel (= 3.1.8)
+      activesupport (= 3.1.8)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.8)
+      activemodel (= 3.1.8)
+      activesupport (= 3.1.8)
     activesupport (3.1.8)
       multi_json (>= 1.0, < 1.3)
     appraisal (0.5.1)
       bundler
       rake
+    arel (2.2.3)
     builder (3.0.4)
     erubis (2.7.0)
     git (1.2.5)
@@ -32,10 +44,16 @@ GEM
       rake
       rdoc
     json (1.7.5)
+    mail (2.3.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
     metaclass (0.0.1)
+    mime-types (1.19)
     mocha (0.13.0)
       metaclass (~> 0.0.1)
     multi_json (1.2.0)
+    polyglot (0.3.3)
     rack (1.3.6)
     rack-cache (1.2)
       rack (>= 0.4)
@@ -45,6 +63,14 @@ GEM
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
+    rails (3.1.8)
+      actionmailer (= 3.1.8)
+      actionpack (= 3.1.8)
+      activerecord (= 3.1.8)
+      activeresource (= 3.1.8)
+      activesupport (= 3.1.8)
+      bundler (~> 1.0)
+      railties (= 3.1.8)
     railties (3.1.8)
       actionpack (= 3.1.8)
       activesupport (= 3.1.8)
@@ -55,11 +81,11 @@ GEM
     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)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.1)
       activesupport (>= 3.0.0)
     sprockets (2.0.4)
       hike (~> 1.2)
@@ -67,6 +93,9 @@ GEM
       tilt (~> 1.1, != 1.3.0)
     thor (0.14.6)
     tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
     tzinfo (0.3.35)
     yard (0.8.3)
 
@@ -74,15 +103,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 3.1.0)
-  activesupport (~> 3.1.0)
+  actionpack (>= 2.3.5)
+  activesupport (>= 2.3.5)
   appraisal (>= 0.5.0)
   bundler (~> 1.2.0)
   jeweler (~> 1.8.4)
   mocha
-  railties (~> 3.1.0)
+  rails (~> 3.1.0)
   rake
   shoulda
   shoulda-context
-  tzinfo
   yard (~> 0.7)

data/gemfiles/rails_3.2.gemfile

@@ -2,16 +2,15 @@
 
 source "http://rubygems.org"
 
-gem "rake"
+gem "activesupport", ">= 2.3.5"
+gem "actionpack", ">= 2.3.5"
+gem "rake", :group=>:development
 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"
+gem "mocha", :require=>false, :group=>:test
+gem "rails", "~> 3.2.0"
 

data/gemfiles/rails_3.2.gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
     actionpack (3.2.8)
       activemodel (= 3.2.8)
       activesupport (= 3.2.8)
@@ -14,12 +17,21 @@ GEM
     activemodel (3.2.8)
       activesupport (= 3.2.8)
       builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
     activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     appraisal (0.5.1)
       bundler
       rake
+    arel (3.0.2)
     builder (3.0.4)
     erubis (2.7.0)
     git (1.2.5)
@@ -32,10 +44,16 @@ GEM
       rdoc
     journey (1.0.4)
     json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
     metaclass (0.0.1)
+    mime-types (1.19)
     mocha (0.13.0)
       metaclass (~> 0.0.1)
     multi_json (1.3.7)
+    polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
       rack (>= 0.4)
@@ -43,6 +61,14 @@ GEM
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
     railties (3.2.8)
       actionpack (= 3.2.8)
       activesupport (= 3.2.8)
@@ -53,11 +79,11 @@ GEM
     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)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.1)
       activesupport (>= 3.0.0)
     sprockets (2.1.3)
       hike (~> 1.2)
@@ -65,6 +91,9 @@ GEM
       tilt (~> 1.1, != 1.3.0)
     thor (0.16.0)
     tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
     tzinfo (0.3.35)
     yard (0.8.3)
 
@@ -72,15 +101,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 3.2.0)
-  activesupport (~> 3.2.0)
+  actionpack (>= 2.3.5)
+  activesupport (>= 2.3.5)
   appraisal (>= 0.5.0)
   bundler (~> 1.2.0)
   jeweler (~> 1.8.4)
   mocha
-  railties (~> 3.2.0)
+  rails (~> 3.2.0)
   rake
   shoulda
   shoulda-context
-  tzinfo
   yard (~> 0.7)

data/lib/charcoal/controller_filter.rb

@@ -6,7 +6,8 @@ module Charcoal
 
     module ClassMethods
       def allow(filter, &block)
-        define_method "allow_#{filter}" do |*args|
+        action = "allow_#{filter}"
+        define_method action 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)
@@ -24,6 +25,8 @@ module Charcoal
             instance_exec(method, directive, &block)
           end
         end
+
+        hide_action action if respond_to?(:hide_action)
       end
     end
 

data/lib/charcoal/version.rb

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

data/test/helper.rb

@@ -11,6 +11,13 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+require 'test/unit'
+require 'mocha/setup'
+
+# https://github.com/freerange/mocha/issues/94
+Mocha::Integration::TestUnit::AssertionCounter = Mocha::Integration::AssertionCounter
+
+require 'shoulda'
 require 'active_support/version'
 
 if ActiveSupport::VERSION::MAJOR >= 3
@@ -48,7 +55,4 @@ else
   ActionDispatch = ActionController
 end
 
-require 'test/unit'
-require 'shoulda'
-
 require 'charcoal'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charcoal
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,9 +26,9 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.5
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -44,21 +44,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.3.5
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.5
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,7 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- .travis.yml
 - Appraisals
 - Gemfile
 - LICENSE
@@ -154,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1806808510332302197
+      hash: -2919837306301132765
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: