glow 0.0.12 → 0.0.13

data/Gemfile.lock

@@ -1,39 +1,39 @@
 PATH
   remote: .
   specs:
-    glow (0.0.12)
+    glow (0.0.13)
       jquery-rails
       rails (>= 3.0.0, < 4.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.9)
-      actionpack (= 3.2.9)
-      mail (~> 2.4.4)
-    actionpack (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
-      rack (~> 1.4.0)
+      rack (~> 1.4.5)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.9)
-      activesupport (= 3.2.9)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activerecord (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-    activesupport (3.2.9)
-      i18n (~> 0.6)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.4)
@@ -41,53 +41,53 @@ GEM
     hike (1.2.1)
     i18n (0.6.1)
     journey (1.0.4)
-    jquery-rails (2.1.3)
-      railties (>= 3.1.0, < 5.0)
-      thor (~> 0.14)
-    json (1.7.5)
-    mail (2.4.4)
+    jquery-rails (2.1.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    mail (2.5.3)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.7)
+    mime-types (1.21)
+    multi_json (1.7.1)
     polyglot (0.3.3)
-    rack (1.4.1)
+    rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
-    rack-ssl (1.3.2)
+    rack-ssl (1.3.3)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.9)
-      actionmailer (= 3.2.9)
-      actionpack (= 3.2.9)
-      activerecord (= 3.2.9)
-      activeresource (= 3.2.9)
-      activesupport (= 3.2.9)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
       bundler (~> 1.0)
-      railties (= 3.2.9)
-    railties (3.2.9)
-      actionpack (= 3.2.9)
-      activesupport (= 3.2.9)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
       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)
+    rake (10.0.3)
+    rdoc (3.12.2)
       json (~> 1.4)
-    sprockets (2.2.1)
+    sprockets (2.2.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.16.0)
-    tilt (1.3.3)
+    thor (0.17.0)
+    tilt (1.3.6)
     treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,17 +8,21 @@ Fash Hash in Javascript. Depends on jQuery.
 Any flash messages set in ajax responses fire a `glow:flash`
 event on `document`.
 
-    flash[:notice] = 'Ajax man!'
-    respond_to do |format|
-      format.js { head :ok }
-    end
+```ruby
+flash[:notice] = 'Ajax man!'
+respond_to do |format|
+  format.js { head :ok }
+end
+```
 
 Handle it any way you want:
 
-    $(document).bind('glow:flash', function(evt, flash) {
-      alert(flash.type);
-      alert(flash.message);
-    });
+```javascript
+$(document).bind('glow:flash', function(evt, flash) {
+  alert(flash.type);
+  alert(flash.message);
+});
+```
 
 Also adds a `Flash` object that enables you to fire `glow:flash`.
 
@@ -37,6 +41,33 @@ responses).
 
 If you want to skip the glow after_filter just set `flash[:skip_glow]`.
 
+
+You can also use glow with APIs by using `headerize_flash_for` and passing
+in the request formats you want the flash messages passed back.
+
+``` ruby
+class API::Base < ActionController::Base
+  headerize_flash_for :json
+end
+```
+
+Controllers inheriting from a controller using `headerize_format_for` will
+inherit the capability or it can be overridden.
+
+``` ruby
+class API::JSON < API::Base
+  # will headerize flash for JSON requests
+end
+
+class API::XML < API::Base
+  headerize_flash_for :xml
+  # will NOT headerize flash for JSON requests
+  # but will headerize flash for XML requests
+end
+```
+
+
+
 ## Installation
 
 In your gemfile add

data/lib/glow/filter.rb

@@ -4,11 +4,12 @@ module Glow
   module Filter
     extend ActiveSupport::Concern
     included do
-      after_filter :flash_to_headers
+      after_filter    :flash_to_headers
+      class_attribute :glow_request_formats
     end
 
     def flash_to_headers
-      return unless flash.any? && request.xhr?
+      return unless flash.any? && flash_to_headers?
       return if flash[:skip_glow] and flash.delete(:skip_glow)
 
       type, message = flash.first
@@ -17,5 +18,17 @@ module Glow
       flash.discard  # don't want the flash to appear when you reload page
     end
 
+    def flash_to_headers?
+      request.xhr? ||
+      glow_request_formats? && glow_request_formats.include?(request.format.to_sym)
+    end
+
+
+    module ClassMethods
+      def headerize_flash_for *formats
+        self.glow_request_formats = formats
+      end
+    end
+
   end
 end

data/lib/glow/version.rb

@@ -1,3 +1,3 @@
 module Glow
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/test/rails3/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gem 'rails', "~> 3.0.0"
 gem 'jquery-rails'
 gem 'glow', path: '../..'

data/test/rails3/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: ../..
   specs:
-    glow (0.0.10)
+    glow (0.0.13)
       jquery-rails
       rails (>= 3.0.0, < 4.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     abstract (1.0.0)
     actionmailer (3.0.17)

data/test/rails3/app/controllers/flash_controller.rb

@@ -1,20 +1,25 @@
 class FlashController < ApplicationController
+
+  headerize_flash_for :json
+
   def show
     # show.html.erb
   end
 
   def redirect
-    flash[params[:type]] = params[:message]
+    flash[params[:type].to_sym] = params[:message]
     redirect_to action: 'show'
   end
 
   def ajax
     respond_to do |wants|
-      wants.js {
-        flash[params[:type]] = params[:message]
-        flash[:skip_glow] = params[:skip_glow].present?
-        head :ok
-      }
+      [:js, :json, :xml].each do |fmt|
+        wants.send(fmt) {
+          flash[params[:type].to_sym] = params[:message]
+          flash[:skip_glow] = params[:skip_glow].present?
+          head :ok
+        }
+      end
     end
   end
 end

data/test/rails3/spec/controllers/flash_controller_spec.rb

@@ -15,7 +15,7 @@ describe FlashController do
     flash.keep?(:notice).should be true
   end
 
-  it "should display flash message on xhr" do 
+  it "should display flash message on xhr" do
     xhr :get, :ajax, type: :notice, message: 'Glow!'
 
     flash[:notice].should be == 'Glow!'
@@ -35,4 +35,21 @@ describe FlashController do
     xhr :get, :ajax, type: :notice, message: 'utf8: ✓', skip_glow: true
     @response.headers.should_not have_key 'X-Message-Type'
   end
+
+  it "should pass flash message on JSON requests" do
+    get :ajax, type: :notice, message: 'Glow!', format: :json
+
+    flash[:notice].should be == 'Glow!'
+    flash.discard?(:notice).should be true
+
+    @response.headers['X-Message-Type'].should be == 'notice'
+    HTMLEntities.new.decode(@response.headers['X-Message']).should be == 'Glow!'
+  end
+
+  it "should not pass flash message on XML requests" do
+    get :ajax, type: :notice, message: 'Glow!', format: :xml
+
+    @response.headers['X-Message-Type'].should be_nil
+    @response.headers['X-Message'].should be_nil
+  end
 end

data/test/rails31/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    glow (0.0.11)
+    glow (0.0.13)
       jquery-rails
       rails (>= 3.0.0, < 4.0.0)
 

data/test/rails31/app/controllers/flash_controller.rb

@@ -1,4 +1,7 @@
 class FlashController < ApplicationController
+
+  headerize_flash_for :json
+
   def show
     # show.html.erb
   end
@@ -10,11 +13,13 @@ class FlashController < ApplicationController
 
   def ajax
     respond_to do |wants|
-      wants.js {
-        flash[params[:type].to_sym] = params[:message]
-        flash[:skip_glow] = params[:skip_glow].present?
-        head :ok
-      }
+      [:js, :json, :xml].each do |fmt|
+        wants.send(fmt) {
+          flash[params[:type].to_sym] = params[:message]
+          flash[:skip_glow] = params[:skip_glow].present?
+          head :ok
+        }
+      end
     end
   end
 end

data/test/rails31/spec/controllers/flash_controller_spec.rb

@@ -15,7 +15,7 @@ describe FlashController do
     flash.keep?(:notice).should be true
   end
 
-  it "should display flash message on xhr" do 
+  it "should display flash message on xhr" do
     xhr :get, :ajax, type: :notice, message: 'Glow!'
 
     flash[:notice].should be == 'Glow!'
@@ -35,4 +35,21 @@ describe FlashController do
     xhr :get, :ajax, type: :notice, message: 'utf8: ✓', skip_glow: true
     @response.headers.should_not have_key 'X-Message-Type'
   end
+
+  it "should pass flash message on JSON requests" do
+    get :ajax, type: :notice, message: 'Glow!', format: :json
+
+    flash[:notice].should be == 'Glow!'
+    flash.discard?(:notice).should be true
+
+    @response.headers['X-Message-Type'].should be == 'notice'
+    HTMLEntities.new.decode(@response.headers['X-Message']).should be == 'Glow!'
+  end
+
+  it "should not pass flash message on XML requests" do
+    get :ajax, type: :notice, message: 'Glow!', format: :xml
+
+    @response.headers['X-Message-Type'].should be_nil
+    @response.headers['X-Message'].should be_nil
+  end
 end

data/test/rails32/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    glow (0.0.10)
+    glow (0.0.13)
       jquery-rails
       rails (>= 3.0.0, < 4.0.0)
 

data/test/rails32/app/controllers/flash_controller.rb

@@ -1,4 +1,7 @@
 class FlashController < ApplicationController
+
+  headerize_flash_for :json
+
   def show
     # show.html.erb
   end
@@ -10,11 +13,13 @@ class FlashController < ApplicationController
 
   def ajax
     respond_to do |wants|
-      wants.js {
-        flash[params[:type].to_sym] = params[:message]
-        flash[:skip_glow] = params[:skip_glow].present?
-        head :ok
-      }
+      [:js, :json, :xml].each do |fmt|
+        wants.send(fmt) {
+          flash[params[:type].to_sym] = params[:message]
+          flash[:skip_glow] = params[:skip_glow].present?
+          head :ok
+        }
+      end
     end
   end
 end

data/test/rails32/spec/controllers/flash_controller_spec.rb

@@ -15,7 +15,7 @@ describe FlashController do
     flash.keep?(:notice).should be true
   end
 
-  it "should display flash message on xhr" do 
+  it "should display flash message on xhr" do
     xhr :get, :ajax, type: :notice, message: 'Glow!'
 
     flash[:notice].should be == 'Glow!'
@@ -35,4 +35,21 @@ describe FlashController do
     xhr :get, :ajax, type: :notice, message: 'utf8: ✓', skip_glow: true
     @response.headers.should_not have_key 'X-Message-Type'
   end
+
+  it "should pass flash message on JSON requests" do
+    get :ajax, type: :notice, message: 'Glow!', format: :json
+
+    flash[:notice].should be == 'Glow!'
+    flash.discard?(:notice).should be true
+
+    @response.headers['X-Message-Type'].should be == 'notice'
+    HTMLEntities.new.decode(@response.headers['X-Message']).should be == 'Glow!'
+  end
+
+  it "should not pass flash message on XML requests" do
+    get :ajax, type: :notice, message: 'Glow!', format: :xml
+
+    @response.headers['X-Message-Type'].should be_nil
+    @response.headers['X-Message'].should be_nil
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: glow
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Daniel Kirsch
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -210,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3382820471934454932
+      hash: -1114898616114158001
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3382820471934454932
+      hash: -1114898616114158001
   none: false
 requirements: []
 rubyforge_project: