disclaimer 0.0.1 → 0.0.2

data/README.rdoc

@@ -4,7 +4,19 @@ A tool for adding disclaimers to applications.
 
 == Installation
 
-=== Gemfile  TODO - add config option
+To use this engine:
+
+=== Gemfile
+
+Add the following to your Gemfile
+
+    gem 'disclaimer'
+
+=== Migrations
+
+To add disclaimer's migrations to the host apps' migrations, run this command:
+
+    rake disclaimer:install:migrations
 
 === Routing
 
@@ -16,12 +28,15 @@ See test/dummy/config/routes.rb
 
 == Usage
 
-First create a disclaimer document (see below) and give it a name. (The name is in underscore form: like_this).
+First create a disclaimer document (see below) and give it a name. (The name is 
+in underscore form: like_this).
 
-Then in your application controller, define the disclaimer you wish to use with 'disclaimer(:document_name)'.
+Then in your application controller, define the disclaimer you wish to use with 
+'disclaimer(:document_name)'.
 
-So for example, you have a disclaimer document with the name :our_company_disclaimer and you want to make sure that
-everyone who visits your products controller has accepted this disclaimer. Modify the controller like this:
+So for example, you have a disclaimer document with the name :our_company_disclaimer 
+and you want to make sure that everyone who visits your products controller has 
+accepted this disclaimer. Modify the controller like this:
 
     class ProductsController < ApplicationController
 
@@ -32,29 +47,52 @@ everyone who visits your products controller has accepted this disclaimer. Modif
 
     end
 
-Then when a user navigates to the products controller, they will be redirected to the disclaimer document at:
+Then when a user navigates to the products controller, they will be redirected 
+to the disclaimer document at:
 
   /disclaimer/documents/our_company_disclaimer
 
-If they accept the disclaimer, they will be redirected back to the page they were originally aiming for.
+If they accept the disclaimer, they will be redirected back to the page they were 
+originally aiming for.
 
-The acceptance is stored in session and therefore will be remembered for as long as the browser is open.
+The acceptance is stored in session and therefore will be remembered for as long 
+as the browser is open.
 
 === Options
 
-A before_filter is used to provide this functionality, and you can pass before_filter options through from
-the disclaimer declaration. Therefore, to only display a disclaimer for the index and show actions in a controller
+A before_filter is used to provide this functionality, and you can pass 
+before_filter options through from the disclaimer declaration. Therefore, to 
+only display a disclaimer for the index and show actions in a controller
 use:
 
      disclaimer :our_company_disclaimer, :only => [:index, :show]
 
 == Documents and Segments
 
-Documents can be created at /disclaimer/documents, and Segments as /disclaimer/segments. Documents can contain
-many segments, and segments can be shared across many documents (that is, you can share common sections of a disclaimer
-across many documents). This behaviour can be overwritten in the host application.
+Each disclaimer consists of a Disclaimer::Document, and this document can have
+many Segments. Segments can be shared across many documents. 
+
+== Controller CRUD actions
+
+By default, documents#show (GET) and documents#accept (POST) are the only acceptable 
+disclaimer actions.
+
+If you wish to enable all the CRUD actions available in the documents and segments
+controllers, set Disclaimer.enable_crud! in an initializer. For example, see
+test/dummy/config/initializers/disclaimer.rb
+
+With CRUD actions enabled documents can be managed at /disclaimer/documents, and 
+Segments at /disclaimer/segments. If you wish to modify the controller behaviour 
+(for example by adding access control), copy disclaimer's app/disclaimer/controllers 
+to the same location in your application, and modify these copies. The versions 
+in your application will take precedence over those in disclaimer.
+
+== Into production
+
+I would recommend using seeding to generate your initial disclaimer documents, 
+or you could create a custom rake task to do this for you. Alternatively use 
+the option used in test/dummy:
 
-The disclaimer engine does not restrict access to these controllers. Such restriction should be configured in
-the host application. However, everyone needs access to the disclaimer documents#show action so that they can read
-and accept the disclaimer.
+    disclaimer Disclaimer::Document.first.name.to_sym
 
+This will display the first disclaimer document in your database.

data/config/routes.rb

@@ -1,18 +1,32 @@
 Disclaimer::Engine.routes.draw do
   
-  root :to => "documents#index"
-  
-  resources :documents do
-    member do
-      get :delete
-      post :accept
+  if Disclaimer.enable_crud?
+    root :to => "documents#index"
+
+    resources :documents do
+      member do
+        get :delete
+        post :accept
+      end
     end
-  end
+
+    resources :segments do
+      member do
+        get :delete
+      end
+    end
+    
+  else
   
-  resources :segments do
-    member do
-      get :delete
+   resources :documents, :only => :show do
+      member do
+        post :accept
+      end
     end
+    
+
+    
   end
+    
 
 end

data/lib/disclaimer/version.rb

@@ -1,3 +1,3 @@
 module Disclaimer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/disclaimer.rb

@@ -1,6 +1,14 @@
 require "disclaimer/engine"
-require 'rails/actionpack/lib/action_controller/base'
+require File.expand_path('rails/actionpack/lib/action_controller/base', File.dirname(__FILE__))
 
 module Disclaimer
   ACCEPTED = :accepted
+    
+  def self.enable_crud?
+    @enable_crud
+  end
+  
+  def self.enable_crud!
+    @enable_crud = true
+  end
 end

data/test/dummy/config/initializers/disclaimer.rb

@@ -0,0 +1,2 @@
+# Allow CRUD actions from document and segment controllers
+Disclaimer.enable_crud!

data/test/dummy/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-
+  
   resources :sample, :only => [:index] do
     collection do
       get :bypass_disclaimer