radiant-basic_page_auth-extension 1.0.0

data/README.md

@@ -0,0 +1,37 @@
+# Basic Page Auth
+
+Protect a page's contents with HTTP Basic Authentication. The user, password, and realm are set up by adding the following Fields to a page:
+
+User (required)  
+Password (required)  
+Realm (optional)
+
+Realm defaults to the page slug. If set to "true" it will use Radiant::Config['site.title'], otherwise set your own value.
+
+
+## TODO
+
+- Write some tests
+
+
+## Installation
+
+This has only been tested on Radiant v1.0.0.rc2 +
+
+Install as a gem :
+
+```
+gem install radiant-basic_page_auth-extension
+```
+
+Include the gem in your environment.rb :
+
+```
+config.gem 'radiant-basic_page_auth-extension', :version => '~> 1.0.0'
+```
+
+Run the update task :
+
+```
+rake radiant:extensions:filter_toolbars:update
+```

data/Rakefile

@@ -0,0 +1,109 @@
+# 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, :features]
+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 basic_page_auth extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BasicPageAuthExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/basic_page_auth_extension.rb

@@ -0,0 +1,14 @@
+require 'radiant-basic_page_auth-extension'
+require 'radiant-basic_page_auth-extension/page'
+require 'radiant-basic_page_auth-extension/site_controller'
+
+class BasicPageAuthExtension < Radiant::Extension
+  version     RadiantBasicPageAuthExtension::VERSION
+  description RadiantBasicPageAuthExtension::DESCRIPTION
+  url         RadiantBasicPageAuthExtension::URL
+
+  def activate
+    Page.send :include, RadiantBasicPageAuthExtension::Page
+    SiteController.send :include, RadiantBasicPageAuthExtension::SiteController
+  end
+end

data/lib/radiant-basic_page_auth-extension.rb

@@ -0,0 +1,8 @@
+module RadiantBasicPageAuthExtension
+  VERSION     = '1.0.0'
+  SUMMARY     = %q{HTTP Basic Authentication for Radiant CMS}
+  DESCRIPTION = %{Protect a page's contents with HTTP Basic Authentication.}
+  URL         = "https://github.com/jsntv200/radiant-basic_page_auth-extension"
+  AUTHORS     = ["Jason Taylor"]
+  EMAIL       = ["jsntv200@gmail.com"]
+end

data/lib/radiant-basic_page_auth-extension/page.rb

@@ -0,0 +1,53 @@
+module RadiantBasicPageAuthExtension
+  module Page
+    def self.included(base)
+      base.instance_eval {
+        include InstanceMethods
+      }
+    end
+
+    module InstanceMethods
+      def protected?
+        self.basic_auth_user && self.basic_auth_pass
+      end
+
+      def basic_auth_user
+        user = self.basic_auth_field('User')
+
+        if user && user.content.present?
+          user.content
+        end
+      end
+
+      def basic_auth_pass
+        pass = self.basic_auth_field('Password')
+
+        if pass && pass.content.present?
+          pass.content
+        end
+      end
+
+      def basic_auth_realm
+        realm = self.basic_auth_field('Realm')
+
+        if realm && realm.content.present?
+          realm = realm.content
+
+          if realm === 'true'
+            realm = Radiant::Config['site.title']
+          end
+
+          realm
+        else
+          realm = self.slug
+        end
+      end
+
+      def basic_auth_field(name)
+        self.fields.detect { |f| f.name.downcase == name.to_s.downcase }
+      end
+    end
+  end
+end
+
+

data/lib/radiant-basic_page_auth-extension/site_controller.rb

@@ -0,0 +1,33 @@
+module RadiantBasicPageAuthExtension
+  module SiteController
+    def self.included(base)
+      base.class_eval {
+        include ClassMethods
+        alias_method_chain :process_page, :basic_auth
+      }
+    end
+
+    module ClassMethods
+      private
+
+      def process_page_with_basic_auth(page)
+        if page.protected?
+          if authenticate_with_http_basic { |u, p| u == page.basic_auth_user && p == page.basic_auth_pass }
+            page.instance_eval do
+              def cache?
+                false
+              end
+            end
+
+            process_page_without_basic_auth(page)
+          else
+            request_http_basic_authentication(page.basic_auth_realm)
+          end
+        else
+          process_page_without_basic_auth(page)
+        end
+      end
+    end
+  end
+end
+

data/lib/tasks/basic_page_auth_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :basic_page_auth do
+      
+      desc "Runs the migration of the Basic Page Auth extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          BasicPageAuthExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          BasicPageAuthExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Basic Page Auth to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from BasicPageAuthExtension"
+        Dir[BasicPageAuthExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(BasicPageAuthExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless BasicPageAuthExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from BasicPageAuthExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join BasicPageAuthExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = BasicPageAuthExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/radiant-basic_page_auth-extension.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-basic_page_auth-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-basic_page_auth-extension"
+  s.version     = RadiantBasicPageAuthExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantBasicPageAuthExtension::AUTHORS
+  s.email       = RadiantBasicPageAuthExtension::EMAIL
+  s.homepage    = RadiantBasicPageAuthExtension::URL
+  s.summary     = RadiantBasicPageAuthExtension::SUMMARY
+  s.description = RadiantBasicPageAuthExtension::DESCRIPTION
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  s.require_paths = ["lib"]
+
+  s.post_install_message = %{
+  Add this to your radiant project with:
+    config.gem 'radiant-basic_page_auth-extension', :version => '~> #{RadiantBasicPageAuthExtension::VERSION}'
+  }
+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,78 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-basic_page_auth-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jason Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-29 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Protect a page's contents with HTTP Basic Authentication.
+email: 
+- jsntv200@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- basic_page_auth_extension.rb
+- lib/radiant-basic_page_auth-extension/page.rb
+- lib/radiant-basic_page_auth-extension/site_controller.rb
+- lib/radiant-basic_page_auth-extension.rb
+- lib/tasks/basic_page_auth_extension_tasks.rake
+- radiant-basic_page_auth-extension.gemspec
+- Rakefile
+- README.md
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/jsntv200/radiant-basic_page_auth-extension
+licenses: []
+
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem 'radiant-basic_page_auth-extension', :version => '~> 1.0.0'\n  "
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: HTTP Basic Authentication for Radiant CMS
+test_files: 
+- spec/spec.opts
+- spec/spec_helper.rb