radiant-enabler-extension 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README.md

@@ -0,0 +1,15 @@
+= Enabler
+
+Enabler can enable and disable a site remotely. Here's how it works:
+
+1. You setup an API key for your site in `Radiant::Config['application.api_key']` such as `1eukshp8c4rchbkoep9d4ntbekp4208`
+2. Then you post to `yoursite.com/admin/disable/1eukshp8c4rchbkoep9d4ntbekp4208?message=Site%20is%20down.`
+3. The site will return all requests with a message such as `Site is down.`
+
+To re-enable a site (the default state) you can post to `yoursite.com/admin/enable/1eukshp8c4rchbkoep9d4ntbekp4208`
+
+Each time you post to enable or disable the cache is cleared. The messages displayed to a visitor when a site is disabled are cached for 24 hours, so your application won't be bogged down by requests.
+
+So that your sites don't reveal whether or not this extension is installed, if you post an invalid api key it will respond with the usual Radiant response for any url. Responding to an invalid key with a 403 (as you might expect from this) would allow someone to scan your site for this url and a 403 response. To avoid that, it'll just render your FileNotFound page.
+
+Built by [Saturn Flyer](http://www.saturnflyer.com)

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-enabler-extension"
+    gem.summary = %Q{Enabler Extension for Radiant CMS}
+    gem.description = %Q{Post to a Radiant CMS site to enable or disable it.}
+    gem.email = "jim@saturnflyer.com"
+    gem.homepage = "http://github.com/saturnflyer/radiant-enabler-extension"
+    gem.authors = ["Jim Gay"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the enabler extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EnablerExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the enabler extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/admin/enabler_controller.rb

@@ -0,0 +1,32 @@
+require 'cgi'
+class Admin::EnablerController < ApplicationController
+  no_login_required
+  skip_before_filter :validate_authenticity
+  
+  def enable
+    if Radiant::Config['application.api_key'] == params[:api_key] && request.post?
+      Radiant::Config['application.enabled?'] = true
+      Radiant::Cache.clear
+      respond_to do |format|
+        format.any { head :ok }
+      end
+    else
+      Page.find_by_url(request.request_uri).process(request, response)
+    end
+  end
+  
+  def disable
+    if Radiant::Config['application.api_key'] == params[:api_key] && request.post?
+      Radiant::Config['application.enabled?'] = false
+      if params[:message]
+        Radiant::Config['application.disabled_message'] = CGI.unescape(params[:message])
+      end
+      Radiant::Cache.clear
+      respond_to do |format|
+        format.any { head :ok }
+      end
+    else
+      Page.find_by_url(request.request_uri).process(request, response)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+ActionController::Routing::Routes.draw do |map|  
+  map.namespace :admin do |admin|
+    admin.enable_application 'enable/:api_key', :controller => 'enabler', :action => 'enable'
+    admin.disable_application 'disable/:api_key', :controller => 'enabler', :action => 'disable'
+  end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/enabler_extension.rb

@@ -0,0 +1,26 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+
+class EnablerExtension < Radiant::Extension
+  version "#{File.read(File.expand_path(File.dirname(__FILE__)) + '/VERSION')}"
+  description "Keeps your site going"
+  url "http://www.saturnflyer.com"
+  
+  def activate
+    Radiant::Config['application.enabled?'] = true if Radiant::Config['application.enabled?'].nil?
+    if Radiant::Config['application.disabled_message'].nil?
+      Radiant::Config['application.disabled_message'] = "Sorry, but this site has been disabled."
+    end
+    SiteController.class_eval {
+      before_filter :filter_by_application_status
+      
+      def filter_by_application_status
+        unless Radiant::Config['application.enabled?']
+          expires_in 24.hours, :public => true, :private => false
+          headers['ETag'] = ''
+          render :text => Radiant::Config['application.disabled_message'] and return
+        end
+      end
+    }
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :enabler
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/lib/tasks/enabler_extension_tasks.rake

@@ -0,0 +1,36 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :enabler do
+      
+      desc "Runs the migration of the Enabler extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          EnablerExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          EnablerExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Enabler to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from EnablerExtension"
+        Dir[EnablerExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(EnablerExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless EnablerExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from EnablerExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join EnablerExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+    end
+  end
+end

data/radiant-enabler-extension.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-enabler-extension}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Gay"]
+  s.date = %q{2010-04-26}
+  s.description = %q{Post to a Radiant CMS site to enable or disable it.}
+  s.email = %q{jim@saturnflyer.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/admin/enabler_controller.rb",
+     "config/routes.rb",
+     "cucumber.yml",
+     "enabler_extension.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "lib/radiant-enabler-extension.rb",
+     "lib/tasks/enabler_extension_tasks.rake",
+     "radiant-enabler-extension.gemspec",
+     "spec/controllers/admin/enabler_controller_spec.rb",
+     "spec/controllers/site_controller_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/saturnflyer/radiant-enabler-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Enabler Extension for Radiant CMS}
+  s.test_files = [
+    "spec/controllers/admin/enabler_controller_spec.rb",
+     "spec/controllers/site_controller_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/controllers/admin/enabler_controller_spec.rb

@@ -0,0 +1,62 @@
+require 'cgi'
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::EnablerController do  
+  dataset :pages, :file_not_found
+  before do
+    Radiant::Config['application.api_key'] = '12345'
+    Radiant::Config['application.enabled?'] = true
+  end
+  context "with a valid api key" do
+    context "for the disable action" do
+      it "should set the Radiant::Config['application.enabled?'] to false" do
+        Radiant::Config['application.enabled?'] = 'true'
+        post :disable, :api_key => '12345'
+        Radiant::Config['application.enabled?'].should == false
+      end
+      it "should set the disabled message with the message parameter" do
+        post :disable, :api_key => '12345', :message => 'Site%20is%20down.'
+        Radiant::Config['application.disabled_message'].should == 'Site is down.'
+      end
+      it "should respond to with a 200 code" do
+        post :disable, :api_key => '12345'
+        response.code.should == '200'
+      end
+      context "with a disabled message" do
+        it "should unescape the message string" do
+          post :disable, :api_key => '12345', :message => "This+is+the+message+about+the+site+%26+it%27s+downtime%21"
+          Radiant::Config['application.disabled_message'].should == "This is the message about the site & it's downtime!"
+        end
+      end
+    end
+    context "for the enable action" do
+      it "should set the Radiant::Config['application.enabled?'] to true" do
+        Radiant::Config['application.enabled?'] = false
+        Radiant::Config['application.enabled?'].should == false
+        post :enable, :api_key => '12345'
+        Radiant::Config['application.enabled?'].should == true
+      end  
+      it "should respond to with a 200 code" do
+        post :enable, :api_key => '12345'
+        response.code.should == '200'
+      end
+    end
+  end
+  context "with an invalid api key" do
+    before do
+      pages(:file_not_found).part('body').update_attribute(:content, 'Oops! We could not find that page.')
+    end
+    it "should render the response from the page found for the given url" do
+      post :enable, :api_key => 'abcde'
+        pages(:file_not_found).process(request, response) # only passes after this ...?
+      response.body.should == 'Oops! We could not find that page.'
+    end
+    context "with a disable message" do
+      it "should render the response from the page found for the given url" do
+        post :disable, :api_key => 'abcde', :message => 'Site%20is%20down'
+          pages(:file_not_found).process(request, response) # only passes after this ...?
+        response.body.should == 'Oops! We could not find that page.'
+      end
+    end
+  end
+end

data/spec/controllers/site_controller_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SiteController do  
+  context "when the site is disabled" do
+    it "should return text with the disabled message" do
+      Radiant::Config['application.enabled?'] = false
+      Radiant::Config['application.disabled_message'] = 'Site is down.'
+      get :show_page, :url => '/any'
+      response.body.should match('Site is down')
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-enabler-extension
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jim Gay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Post to a Radiant CMS site to enable or disable it.
+email: jim@saturnflyer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- app/controllers/admin/enabler_controller.rb
+- config/routes.rb
+- cucumber.yml
+- enabler_extension.rb
+- features/support/env.rb
+- features/support/paths.rb
+- lib/radiant-enabler-extension.rb
+- lib/tasks/enabler_extension_tasks.rake
+- radiant-enabler-extension.gemspec
+- spec/controllers/admin/enabler_controller_spec.rb
+- spec/controllers/site_controller_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/saturnflyer/radiant-enabler-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Enabler Extension for Radiant CMS
+test_files: 
+- spec/controllers/admin/enabler_controller_spec.rb
+- spec/controllers/site_controller_spec.rb
+- spec/spec_helper.rb