iceburn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15ec7d1bc64d11c601080c499f2dcc3e30996d7d
+  data.tar.gz: de5357cb6bf58044b1db1efcf0777662fe193631
+SHA512:
+  metadata.gz: 651426c46b2296ab7a924c62ccf28c4a65b01496ad0d248167c1d1659412e440da5a7cf7790a0f8c6bcf5c0a25b34d6a172ac38a222501108600799451a16a36
+  data.tar.gz: 6d1e2a9351e5e0e2ece951c705c4e53b36d19ddb231148430d3ed46d4fa73ddc24a5509e8c978b4d4c77187ba72a6917575ef0a8897b41363c74b1b0084618a4

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in iceburn.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    iceburn (0.0.1)
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      mail (~> 2.5.4)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    pg (0.17.1)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.1)
+      actionmailer (= 4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      activemodel (= 4.1.1)
+      activerecord (= 4.1.1)
+      activesupport (= 4.1.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.1)
+      sprockets-rails (~> 2.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.2)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  iceburn!
+  pg
+  rspec
+  rspec-rails

data/LICENSE.txt

@@ -0,0 +1,29 @@
+University of Illinois/NCSA Open Source License
+
+    Copyright (c) 2014 Tom Scott
+    All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the "Software"),
+    to deal with 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:
+
+    Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimers.
+
+    Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimers in the documentation
+    and/or other materials provided with the distribution.
+
+    None of the names of its contributors may be used to endorse or promote
+    products derived from this Software without specific prior written permission.
+
+    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 CONTRIBUTORS 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 WITH THE SOFTWARE.
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,67 @@
+# Iceburn
+
+A quick and dirty Rails plugin for client-side javascript apps. Adds
+filters to your controller and routes to your router to allow a
+client-side JS app to take over the entire page.
+
+## Setup
+
+Install the gem with Bundler:
+
+```ruby
+gem 'iceburn'
+```
+
+## Usage
+
+Add this mixin to **app/controllers/application_controller.rb**:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Iceburn::Filters
+end
+```
+
+And this one to your **config/routes.rb**:
+
+```ruby
+Rails.application.routes.draw do
+  extend Iceburn::Routes
+end
+```
+
+And you'll get a free route that points to 'application#index' and just
+returns an empty string, allowing your JS app to take over the layout.
+
+## License
+
+[University of Illinois/NCSA Open Source License][ncsa]
+
+    Copyright (c) 2014 Tom Scott
+    All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the "Software"),
+    to deal with 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:
+
+    Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimers.
+
+    Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimers in the documentation
+    and/or other materials provided with the distribution.
+
+    None of the names of its contributors may be used to endorse or promote
+    products derived from this Software without specific prior written permission.
+
+    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 CONTRIBUTORS 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 WITH THE SOFTWARE.
+
+[ncsa]: http://opensource.org/licenses/NCSA

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'bundler/gem_helper'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RDoc::Task.new(:docs) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Iceburn'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new :test
+
+task :default => %w(test docs build)

data/config/initializers/generators.rb

@@ -0,0 +1,3 @@
+Rails.application.config.generators do |g|
+  g.test_framework :rspec, fixtures: true, fixture_location: "spec/fixtures"
+end

data/iceburn.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "iceburn/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "iceburn"
+  s.version     = Iceburn::VERSION
+  s.authors     = ["Tom Scott"]
+  s.email       = ["tubbo@psychedeli.ca"]
+  s.homepage    = "http://github.com/tubbo/iceburn"
+  s.summary     = "HTTP request hijacker for ActionController and API-driven Rails apps"
+  s.description = s.summary
+  s.license     = "NCSA"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = s.files.grep(/\Aspec/)
+
+  s.add_dependency "rails"
+
+  s.add_development_dependency "pg"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+end

data/lib/iceburn.rb

@@ -0,0 +1,13 @@
+require 'iceburn/version'
+require 'iceburn/filters'
+require 'iceburn/routes'
+
+# A library for defining "blank" routes that are returned whenever HTML
+# is requested from the Rails router.
+
+module Iceburn
+  # Logging util that defaults to the Rails logger.
+  def self.logger
+    Rails.logger
+  end
+end

data/lib/iceburn/filters.rb

@@ -0,0 +1,39 @@
+require 'active_support/concern'
+
+# The before_filter used to handle HTML requests that aren't caught by
+# the main application routes.
+
+module Iceburn
+  module Filters
+    extend ActiveSupport::Concern
+
+    included { before_filter :handle_html_requests }
+
+    # Return blank on all requests to the root path.
+    def index
+      handle_html_requests
+    end
+
+    # Define this method to enable controllers that have been
+    # whitelisted so users can access their HTML view responses.
+    def whitelisted_controllers
+      []
+    end
+
+    protected
+    def handle_html_requests
+      return if json_request? || whitelisted?
+      return if request.xhr?
+      render text: '', layout: 'application' and return # block the rest of the chain
+    end
+
+    private
+    def whitelisted?
+      whitelisted_controllers.include? params[:controller]
+    end
+
+    def json_request?
+      "#{params[:format]}" == 'json'
+    end
+  end
+end

data/lib/iceburn/routes.rb

@@ -0,0 +1,13 @@
+module Iceburn
+  # Extend your `config/routes.rb` file with these to ensure that the
+  # root path is defined and all HTML requests are proxied to Iceburn.
+  module Routes
+    def iceburn_html!
+      get '/*path' => 'application#index'
+      #put '/*path' => 'application#index'
+      #post '/*path' => 'application#index'
+      #delete '/*path' => 'application#index'
+      root to: 'application#index'
+    end
+  end
+end

data/lib/iceburn/version.rb

@@ -0,0 +1,3 @@
+module Iceburn
+  VERSION = "0.0.1"
+end

data/lib/tasks/iceburn_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :iceburn do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .