fine_print 0.0.1

data/app/controllers/fine_print/agreements_controller.rb~

@@ -0,0 +1,113 @@
+require_dependency "fine_print/application_controller"
+
+module FinePrint
+  class AgreementsController < ApplicationController
+    # GET /agreements
+    # GET /agreements.json
+    def index
+      raise SecurityTransgression unless Agreement.can_be_listed_by?(@user)
+      @agreements = Agreement.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @agreements }
+      end
+    end
+  
+    # GET /agreements/1
+    # GET /agreements/1.json
+    def show
+      @agreement = Agreement.find(params[:id])
+      raise SecurityTransgression unless @agreement.can_be_read_by?(@user)
+      @user_agreement = UserAgreement.new(:agreement => @agreement) if @agreement.can_be_accepted_by?(@user)
+      @accept_path = session.delete(:fine_print_accept_path)
+      @url = session.delete(:fine_print_request_url)
+      @ref = session.delete(:fine_print_request_ref)
+  
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @agreement }
+      end
+    end
+  
+    # GET /agreements/new
+    # GET /agreements/new.json
+    def new
+      @agreement = Agreement.new
+      raise SecurityTransgression unless @agreement.can_be_created_by?(@user)
+  
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render json: @agreement }
+      end
+    end
+  
+    # GET /agreements/1/edit
+    def edit
+      @agreement = Agreement.find(params[:id])
+      raise SecurityTransgression unless @agreement.can_be_edited_by?(@user)
+    end
+
+    # GET /agreements/1/new_version
+    def new_version
+      @agreement = Agreement.find(params[:agreement_id]).dup
+      raise SecurityTransgression unless @agreement.can_be_created_by?(@user)
+
+      respond_to do |format|
+        format.html # new_version.html.erb
+        format.json { render json: @agreement }
+      end
+    end
+  
+    # POST /agreements
+    # POST /agreements.json
+    def create
+      @agreement = Agreement.new(params[:agreement])
+      raise SecurityTransgression unless @agreement.can_be_created_by?(@user)
+      @agreement.version = Agreement.next_version(@agreement.name)
+  
+      respond_to do |format|
+        if @agreement.save
+          format.html { redirect_to @agreement, notice: 'Agreement was successfully created.' }
+          format.json { render json: @agreement, status: :created, location: @agreement }
+        else
+          format.html { render action: "new" }
+          format.json { render json: @agreement.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /agreements/1
+    # PUT /agreements/1.json
+    def update
+      @agreement = Agreement.find(params[:id])
+      raise SecurityTransgression unless @agreement.can_be_edited_by?(@user)
+      if params[:agreement][:name].try(:downcase) != @agreement.name.downcase
+        params[:agreement][:version] = Agreement.next_version(params[:agreement][:name])
+      end
+  
+      respond_to do |format|
+        if @agreement.update_attributes(params[:agreement])
+          format.html { redirect_to @agreement, notice: 'Agreement was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render action: "edit" }
+          format.json { render json: @agreement.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    # DELETE /agreements/1
+    # DELETE /agreements/1.json
+    def destroy
+      @agreement = Agreement.find(params[:id])
+      raise SecurityTransgression unless @agreement.can_be_destroyed_by?(@user)
+      @agreement.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to agreements_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/app/controllers/fine_print/application_controller.rb

@@ -0,0 +1,13 @@
+module FinePrint
+  class ApplicationController < ActionController::Base
+    before_filter :get_user
+    
+    rescue_from SecurityTransgression, :with => lambda { redirect_to FinePrint.redirect_path }
+    
+    protected
+    
+    def get_user
+      @user = self.send FinePrint.current_user_method
+    end
+  end
+end

data/app/controllers/fine_print/application_controller.rb~

@@ -0,0 +1,13 @@
+module FinePrint
+  class ApplicationController < ActionController::Base
+    before_filter :get_user
+    helper MyEngine::Engine.helpers
+    rescue_from SecurityTransgression, :with => lambda { redirect_to FinePrint.redirect_path }
+    
+    protected
+    
+    def get_user
+      @user = self.send FinePrint.current_user_method
+    end
+  end
+end

data/app/controllers/fine_print/home_controller.rb

@@ -0,0 +1,14 @@
+require_dependency "fine_print/application_controller"
+
+module FinePrint
+  class HomeController < ApplicationController
+    # GET /fine_print
+    def index
+      raise SecurityTransgression unless Agreement.can_be_listed_by?(@user) && UserAgreement.can_be_listed_by?(@user)
+  
+      respond_to do |format|
+        format.html # index.html.erb
+      end
+    end
+  end
+end

data/app/controllers/fine_print/home_controller.rb~

@@ -0,0 +1,15 @@
+require_dependency "fine_print/application_controller"
+
+module FinePrint
+  class HomeController < ApplicationController
+    # GET /fine_print
+    def index
+      raise SecurityTransgression unless Agreement.can_be_listed_by?(@user) && UserAgreement.can_be_listed_by?(@user)
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @agreements }
+      end
+    end
+  end
+end

data/app/controllers/fine_print/user_agreements_controller.rb

@@ -0,0 +1,63 @@
+require_dependency "fine_print/application_controller"
+
+module FinePrint
+  class UserAgreementsController < ApplicationController
+    # GET /user_agreements
+    # GET /user_agreements.json
+    def index
+      raise SecurityTransgression unless UserAgreement.can_be_listed_by?(@user)
+      @user_agreements = UserAgreement.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @user_agreements }
+      end
+    end
+  
+    # POST /user_agreements
+    # POST /user_agreements.json
+    def create
+      @agreement = Agreement.find(params[:agreement_id])
+      raise SecurityTransgression unless @agreement.can_be_accepted_by?(@user)
+
+      if params[:cancel] || (@agreement.display_confirmation && !params[:confirmation_checkbox])
+        respond_to do |format|
+          format.html { redirect_to params[:ref] || FinePrint.get_option(params, :cancel_path) }
+          format.js { render 'cancel' }
+        end
+        return
+      end
+
+      @index = params[:index].to_i
+      @user_agreement = UserAgreement.new
+      @user_agreement.agreement = @agreement
+      @user_agreement.user = @user
+      redirect_path = params[:url] || FinePrint.get_option(params, :accept_path)
+  
+      respond_to do |format|
+        if @user_agreement.save
+          format.html { redirect_to redirect_path, notice: "#{@user_agreement.agreement.name} accepted." }
+          format.json { render json: @user_agreement, status: :created, location: @user_agreement }
+          format.js
+        else
+          format.html { redirect_to redirect_path, notice: "You have already accepted this agreement." }
+          format.json { render json: @user_agreement.errors, status: :unprocessable_entity }
+          format.js { redirect_to redirect_path, notice: "You have already accepted this agreement." }
+        end
+      end
+    end
+  
+    # DELETE /user_agreements/1
+    # DELETE /user_agreements/1.json
+    def destroy
+      @user_agreement = UserAgreement.find(params[:id])
+      raise SecurityTransgression unless @user_agreement.can_be_destroyed_by?(@user)
+      @user_agreement.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to user_agreements_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/app/controllers/fine_print/user_agreements_controller.rb~

@@ -0,0 +1,63 @@
+require_dependency "fine_print/application_controller"
+
+module FinePrint
+  class UserAgreementsController < ApplicationController
+    # GET /user_agreements
+    # GET /user_agreements.json
+    def index
+      raise SecurityTransgression unless UserAgreement.can_be_listed_by?(@user)
+      @user_agreements = UserAgreement.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @user_agreements }
+      end
+    end
+  
+    # POST /user_agreements
+    # POST /user_agreements.json
+    def create
+      @agreement = Agreement.find(params[:agreement_id])
+      raise SecurityTransgression unless @agreement.can_be_accepted_by?(@user)
+
+      if params[:cancel] || (@agreement.display_confirmation && !params[:confirmation_checkbox])
+        respond_to do |format|
+          format.html { redirect_to params[:ref] || FinePrint.get_option(params, :cancel_path) }
+          format.js { render 'cancel' }
+        end
+        return
+      end
+
+      @index = params[:index].to_i
+      @user_agreement = UserAgreement.new
+      @user_agreement.agreement = @agreement
+      @user_agreement.user = @user
+      redirect_path = params[:url] || FinePrint.get_option(params, :redirect_path)
+  
+      respond_to do |format|
+        if @user_agreement.save
+          format.html { redirect_to redirect_path, notice: "#{@user_agreement.agreement.name} accepted." }
+          format.json { render json: @user_agreement, status: :created, location: @user_agreement }
+          format.js
+        else
+          format.html { redirect_to redirect_path, notice: "You have already accepted this agreement." }
+          format.json { render json: @user_agreement.errors, status: :unprocessable_entity }
+          format.js { redirect_to redirect_path, notice: "You have already accepted this agreement." }
+        end
+      end
+    end
+  
+    # DELETE /user_agreements/1
+    # DELETE /user_agreements/1.json
+    def destroy
+      @user_agreement = UserAgreement.find(params[:id])
+      raise SecurityTransgression unless @user_agreement.can_be_destroyed_by?(@user)
+      @user_agreement.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to user_agreements_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/app/models/fine_print/agreement.rb

@@ -0,0 +1,50 @@
+module FinePrint
+  class Agreement < ActiveRecord::Base
+    attr_accessible :name, :version, :content, :confirmation_text, :display_name, :display_version, :display_updated, :display_confirmation, :ready
+
+    has_many :user_agreements
+
+    validates_presence_of :name, :content, :version
+    validates_uniqueness_of :name, :scope => :version, :case_sensitive => false
+
+    default_scope order(:name, :version)
+
+    def self.latest(name)
+      find(:last, :conditions => ["LOWER(name) = ?", name.try(:downcase)])
+    end
+
+    def self.next_version(name)
+      (latest(name).try(:version) || 0) + 1
+    end
+
+    def self.latest_ready(name)
+      where(:ready => true).find(:last, :conditions => ["LOWER(name) = ?", name.try(:downcase)])
+    end
+
+    def accepted_by?(user)
+      !user.nil? && !user_agreements.where(:user_type => user.class.to_s, :user_id => user.id).empty?
+    end
+
+    def self.can_be_listed_by?(user)
+      FinePrint.is_admin?(user)
+    end
+
+    def can_be_read_by?(user)
+      ready || FinePrint.is_admin?(user)
+    end
+
+    def can_be_accepted_by?(user)
+      ready && !user.nil?
+    end
+
+    def can_be_created_by?(user)
+      FinePrint.is_admin?(user)
+    end
+
+    def can_be_edited_by?(user)
+      FinePrint.is_admin?(user) && user_agreements.empty?
+    end
+
+    alias_method :can_be_destroyed_by?, :can_be_edited_by?
+  end
+end

data/app/models/fine_print/agreement.rb~

@@ -0,0 +1,50 @@
+module FinePrint
+  class Agreement < ActiveRecord::Base
+    attr_accessible :name, :version, :content, :display_name, :display_version, :display_updated, :display_confirmation, :ready
+
+    has_many :user_agreements
+
+    validates_presence_of :name, :content, :version
+    validates_uniqueness_of :name, :scope => :version, :case_sensitive => false
+
+    default_scope order(:name, :version)
+
+    def self.latest(name)
+      find(:last, :conditions => ["LOWER(name) = ?", name.try(:downcase)])
+    end
+
+    def self.next_version(name)
+      (latest(name).try(:version) || 0) + 1
+    end
+
+    def self.latest_ready(name)
+      where(:ready => true).find(:last, :conditions => ["LOWER(name) = ?", name.try(:downcase)])
+    end
+
+    def accepted_by?(user)
+      !user.nil? && !user_agreements.where(:user_type => user.class.to_s, :user_id => user.id).empty?
+    end
+
+    def self.can_be_listed_by?(user)
+      FinePrint.is_admin?(user)
+    end
+
+    def can_be_read_by?(user)
+      ready || FinePrint.is_admin?(user)
+    end
+
+    def can_be_accepted_by?(user)
+      ready && !user.nil?
+    end
+
+    def can_be_created_by?(user)
+      FinePrint.is_admin?(user)
+    end
+
+    def can_be_edited_by?(user)
+      FinePrint.is_admin?(user) && user_agreements.empty?
+    end
+
+    alias_method :can_be_destroyed_by?, :can_be_edited_by?
+  end
+end

data/app/models/fine_print/user_agreement.rb

@@ -0,0 +1,19 @@
+module FinePrint
+  class UserAgreement < ActiveRecord::Base
+    belongs_to :agreement
+    belongs_to :user, :polymorphic => true
+
+    validates_presence_of :agreement, :user
+    validates_uniqueness_of :user_id, :scope => [:agreement_id, :user_type]
+
+    default_scope order(:agreement_id, :user_type, :user_id)
+
+    def self.can_be_listed_by?(user)
+      FinePrint.is_admin?(user)
+    end
+
+    def can_be_destroyed_by?(user)
+      FinePrint.is_admin?(user)
+    end
+  end
+end

data/app/models/fine_print/user_agreement.rb~

@@ -0,0 +1,21 @@
+module FinePrint
+  class UserAgreement < ActiveRecord::Base
+    attr_accessible :agreement
+
+    belongs_to :agreement
+    belongs_to :user, :polymorphic => true
+
+    validates_presence_of :agreement, :user
+    validates_uniqueness_of :user_id, :scope => [:agreement_id, :user_type]
+
+    default_scope order(:agreement_id, :user_type, :user_id)
+
+    def self.can_be_listed_by?(user)
+      FinePrint.is_admin?(user)
+    end
+
+    def can_be_destroyed_by?(user)
+      FinePrint.is_admin?(user)
+    end
+  end
+end

data/app/views/fine_print/agreements/_agreement.html.erb

@@ -0,0 +1,77 @@
+<% # Clients of this partial must supply the following variable:
+   # agreement
+   # user
+   #
+   # Additionally, they can override the following variables:
+   index ||= 0
+   notice ||= nil
+   accept_path ||= nil
+   cancel_path ||= nil
+   url ||= nil
+   ref ||= nil
+   remote ||= false %>
+
+<% unless notice.nil? %>
+  <p id="notice" class = "fine_print notice"><%= notice %></p>
+<% end %>
+
+<% if agreement.display_name %>
+  <h1 class="fine_print agreement name">
+    <%= agreement.name %>
+  </h1>
+<% end %>
+
+<% if agreement.display_version %>
+  <h3 class="fine_print agreement version">
+    Version: <%= agreement.version %>
+  </h3>
+<% end %>
+
+<% if agreement.display_updated %>
+  <h3 class="fine_print agreement updated">
+    Last updated: <%= agreement.updated_at %>
+  </h3>
+<% end %>
+
+<pre class="fine_print agreement content">
+  <%= agreement.content %>
+</pre>
+
+<% if agreement.can_be_accepted_by?(user) %>
+  <%= form_tag fine_print.user_agreements_path, :remote => remote do %>
+    <%= hidden_field_tag :agreement_id, agreement.id %>
+    <%= hidden_field_tag :index, index %>
+    <% unless accept_path.nil? %>
+      <%= hidden_field_tag :accept_path, accept_path %>
+    <% end %>
+    <% unless cancel_path.nil? %>
+      <%= hidden_field_tag :cancel_path, cancel_path %>
+    <% end %>
+    <% unless url.nil? %>
+      <%= hidden_field_tag :url, url %>
+    <% end %>
+    <% unless ref.nil? %>
+      <%= hidden_field_tag :ref, ref %>
+    <% end %>
+    <% if agreement.display_confirmation %>
+      <div class="field">
+        <%= label_tag :confirmation_checkbox, agreement.confirmation_text, :class => "fine_print label" %>
+        <%= check_box_tag :confirmation_checkbox, 1, false, :id => "fine_print_confirmation_checkbox_#{index}", :class => "fine_print checkbox" %><br/>
+      </div>
+    <% end %>
+    <div class="actions">
+      <%= submit_tag (agreement.display_confirmation ? 'OK' : agreement.confirmation_text), :id => "fine_print_submit_ok_#{index}", :class => "fine_print submit" %>
+      <%= submit_tag :Cancel, :name => 'cancel', :class => "fine_print submit" %>
+    </div>
+  <% end %>
+  <% if agreement.display_confirmation %>
+    <script>
+      fine_print_agreement_checkbox(<%= index %>);
+    </script>
+  <% end %>
+<% elsif !agreement.ready %>
+  This agreement is not yet ready to be used.<br/>
+<% else %>
+  Please <%= FinePrint.sign_in_path.nil? ? 'sign in' : link_to('sign in', FinePrint.sign_in_path) %> to accept this agreement.<br/>
+<% end %>
+

data/app/views/fine_print/agreements/_agreement.html.erb~

@@ -0,0 +1,77 @@
+<% # Clients of this partial must supply the following variable:
+   # agreement
+   # user
+   #
+   # Additionally, they can override the following variables:
+   index ||= 0
+   notice ||= nil
+   accept_path ||= nil
+   cancel_path ||= nil
+   url ||= nil
+   ref ||= nil
+   remote ||= false %>
+
+<% if notice %>
+  <p id="notice" class = "fine_print notice"><%= notice %></p>
+<% end %>
+
+<% if agreement.display_name %>
+  <h1 class="fine_print agreement name">
+    <%= agreement.name %>
+  </h1>
+<% end %>
+
+<% if agreement.display_version %>
+  <h3 class="fine_print agreement version">
+    Version: <%= agreement.version %>
+  </h3>
+<% end %>
+
+<% if agreement.display_updated %>
+  <h3 class="fine_print agreement updated">
+    Last updated: <%= agreement.updated_at %>
+  </h3>
+<% end %>
+
+<pre class="fine_print agreement content">
+  <%= agreement.content %>
+</pre>
+
+<% if agreement.can_be_accepted_by?(user) %>
+  <%= form_tag fine_print.user_agreements_path, :remote => remote do %>
+    <%= hidden_field_tag :agreement_id, agreement.id %>
+    <%= hidden_field_tag :index, index %>
+    <% unless accept_path.nil? %>
+      <%= hidden_field_tag :accept_path, accept_path %>
+    <% end %>
+    <% unless cancel_path.nil? %>
+      <%= hidden_field_tag :cancel_path, cancel_path %>
+    <% end %>
+    <% unless url.nil? %>
+      <%= hidden_field_tag :url, url %>
+    <% end %>
+    <% unless ref.nil? %>
+      <%= hidden_field_tag :ref, ref %>
+    <% end %>
+    <% if agreement.display_confirmation %>
+      <div class="field">
+        <%= label_tag :confirmation_checkbox, agreement.confirmation_text, :class => "fine_print label" %>
+        <%= check_box_tag :confirmation_checkbox, 1, false, :id => "fine_print_confirmation_checkbox_#{index}", :class => "fine_print checkbox" %><br/>
+      </div>
+    <% end %>
+    <div class="actions">
+      <%= submit_tag (agreement.display_confirmation ? 'OK' : agreement.confirmation_text), :id => "fine_print_submit_ok_#{index}", :class => "fine_print submit" %>
+      <%= submit_tag :Cancel, :name => 'cancel', :class => "fine_print submit" %>
+    </div>
+  <% end %>
+  <% if agreement.display_confirmation %>
+    <script>
+      fine_print_agreement_checkbox(<%= index %>);
+    </script>
+  <% end %>
+<% elsif !agreement.ready %>
+  This agreement is not yet ready to be used.<br/>
+<% else %>
+  Please <%= FinePrint.sign_in_path.nil? ? 'sign in' : link_to('sign in', FinePrint.sign_in_path) %> to accept this agreement.<br/>
+<% end %>
+

data/app/views/fine_print/agreements/_dialog.html.erb

@@ -0,0 +1,27 @@
+<% # Clients of this partial must supply the following variables:
+   # agreements
+   # user
+   # notice
+   #
+   # Additionally, they can override the following variables:
+   width ||= 640
+   height ||= 480 %>
+
+<%= stylesheet_link_tag 'fine_print/application' %>
+<%= javascript_include_tag 'fine_print/dialog' %>
+
+<% agreements.each_with_index do |agreement, index| %>
+  <div id="<%= "fine_print_dialog_#{index}" %>" title="<%= agreement.name %>" class="fine_print agreement dialog">
+    <%= render :partial => 'fine_print/agreements/agreement', :locals => {
+        :agreement => agreement,
+        :index => index,
+        :user => user,
+        :notice => notice,
+        :remote => true } %>
+  </div>
+
+  <script>
+    fine_print_init_dialog(<%= index %>, <%= width %>, <%= height %>);
+  </script>
+<% end %>
+

data/app/views/fine_print/agreements/_dialog.html.erb~

@@ -0,0 +1,27 @@
+<% # Clients of this partial must supply the following variables:
+   # agreements
+   # user
+   # notice
+   #
+   # Additionally, they can override the following variables:
+   width ||= 640
+   height ||= 480 %>
+
+<%= stylesheet_link_tag 'fine_print/application' %>
+<%= javascript_include_tag 'fine_print/dialog' %>
+
+<% agreements.each_with_index do |agreement, index| %>
+  <div id="<%= "fine_print_dialog_#{index}" %>" title="<%= agreement.name %>" class="fine_print agreement dialog">
+    <%= render :partial => 'fine_print/agreements/agreement', :locals => {
+        :agreement => agreement,
+        :index => index,
+        :user => user,
+        :notice => notice,
+        :remote => true } %>
+  </div>
+
+  <script>
+    fine_print_init_dialog(<%= index %>, width, height);
+  </script>
+<% end %>
+