fine_print 0.1.1 → 1.0.0

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

@@ -0,0 +1,100 @@
+module FinePrint
+  class Contract < ActiveRecord::Base
+    has_many :signatures, :inverse_of => :contract
+
+    has_many :same_name, :class_name => 'Contract', :primary_key => :name, :foreign_key => :name
+
+    before_validation :downcase_name
+    before_update :no_signatures
+    before_destroy :no_signatures
+
+    validates_presence_of :name, :title, :content
+    validates_format_of :name, :with => /\A\w+\z/
+    validates_uniqueness_of :version, :scope => :name, :case_sensitive => false
+
+    default_scope order(:name, 'version DESC')
+
+    scope :published, where(arel_table[:version].not_eq(nil))
+    scope :latest, published
+      .joins(:same_name)
+      .group(:id)
+      .having(:version => arel_table.alias(:same_names_fine_print_contracts)[:version]
+                          .maximum.tap{|mvq| mvq.alias = nil})
+
+    def is_published?
+      !version.nil?
+    end
+
+    def is_latest?
+      is_published? && version == same_name.maximum(:version)
+    end
+
+    def sign(user)
+      FinePrint.sign_contract(self, user)
+    end
+
+    def signed_by?(user)
+      FinePrint.signed_contract?(self, user)
+    end
+
+    def publish
+      no_signatures
+      errors.add(:base, 'Contract is already published') if is_published?
+      return false unless errors.empty?
+
+      self.version = (same_name.published.first.try(:version) || 0) + 1
+      save
+    end
+
+    def unpublish
+      no_signatures
+      errors.add(:base, 'Contract is not the latest published version') unless is_latest?
+      return false unless errors.empty?
+
+      self.version = nil
+      save
+    end
+
+    def draft_copy
+      Contract.where(:name => name, :version => nil).first || dup.tap{|contract| contract.version = nil}
+    end
+
+    ##################
+    # Access Control #
+    ##################
+
+    def can_be_updated?
+      signatures.empty?
+    end
+
+    def can_be_published?
+      signatures.empty? && !is_published?
+    end
+
+    def can_be_unpublished?
+      signatures.empty? && is_latest?
+    end
+
+    def can_be_new_versioned?
+      is_published?
+    end
+
+    alias_method :can_be_destroyed?, :can_be_updated?
+
+    ##############
+    # Validation #
+    ##############
+
+    def no_signatures
+      return if signatures.empty?
+      errors.add(:base, 'Contract cannot be modified because users have signed it')
+      false
+    end
+
+    protected
+
+    def downcase_name
+      self.name = name.downcase
+    end
+  end
+end

data/app/models/fine_print/signature.rb

@@ -0,0 +1,25 @@
+module FinePrint
+  class Signature < ActiveRecord::Base
+    belongs_to :contract, :inverse_of => :signatures
+    belongs_to :user, :polymorphic => true
+
+    before_create :contract_published
+
+    validates_presence_of :contract, :user_type, :user_id
+    validates_uniqueness_of :contract_id, :scope => [:user_type, :user_id]
+
+    default_scope order(:contract_id, :user_type, :user_id)
+
+    protected
+
+    ##############
+    # Validation #
+    ##############
+
+    def contract_published
+      return if contract.is_published?
+      errors.add(:contract, 'needs to be published before it can be signed')
+      false
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module FinePrint
+  class Signature < ActiveRecord::Base
+    belongs_to :contract, :inverse_of => :signatures
+    belongs_to :user, :polymorphic => true
+
+    before_save :contract_published
+
+    validates_presence_of :contract, :user_type, :user_id
+    validates_uniqueness_of :contract_id, :scope => [:user_type, :user_id]
+
+    default_scope order(:contract_id, :user_type, :user_id)
+
+    protected
+
+    ##############
+    # Validation #
+    ##############
+
+    def contract_published
+      return if contract.is_published?
+      errors.add(:contract, 'needs to be published before it can be signed')
+      false
+    end
+  end
+end

data/app/views/fine_print/contracts/_form.html.erb

@@ -0,0 +1,35 @@
+<%= form_for(@contract, :html => {:class => 'fine_print'}) do |f| %>
+  <% if @contract.errors.any? %>
+    <div id='error_explanation' class='fine_print errors'>
+      <h2 class='fine_print heading'><%= pluralize(@contract.errors.count, 'error') %> prohibited this contract from being saved:</h2>
+
+      <ul>
+      <% @contract.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class='field'>
+    <%= f.label :name, :class => 'fine_print' %>
+    <%= f.text_field :name, :size => 40, :class => 'fine_print text_field' %>
+    <div class='fine_print field_help'>
+      used internally by your code, only letters, numbers, underscores; changing this will start a new contract with new version counts
+    </div>
+  </div>
+  <div class='field'>
+    <%= f.label :title, :class => 'fine_print' %>
+    <%= f.text_field :title, :size => 40, :class => 'fine_print text_field' %>
+    <div class='fine_print field_help'>
+      e.g., 'Terms of Use'
+    </div>
+  </div>
+  <div class='field'>
+    <%= f.label :content, :class => 'fine_print' %>
+    <%= f.text_area :content, :cols => 56, :class => 'fine_print text_area' %>
+  </div>
+  <div class='actions'>
+    <%= f.submit nil, :class => 'fine_print submit' %>
+  </div>
+<% end %>

data/app/views/fine_print/contracts/_form.html.erb~

@@ -0,0 +1,35 @@
+<%= form_for(@contract, :html => {class: 'fine_print'}) do |f| %>
+  <% if @contract.errors.any? %>
+    <div id='error_explanation' class='fine_print errors'>
+      <h2 class='fine_print heading'><%= pluralize(@contract.errors.count, 'error') %> prohibited this contract from being saved:</h2>
+
+      <ul>
+      <% @contract.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class='field'>
+    <%= f.label :name, :class => 'fine_print' %>
+    <%= f.text_field :name, :size => 40, :class => 'fine_print text_field' %>
+    <div class='fine_print field_help'>
+      used internally by your code, only letters, numbers, underscores; changing this will start a new contract with new version counts
+    </div>
+  </div>
+  <div class='field'>
+    <%= f.label :title, :class => 'fine_print' %>
+    <%= f.text_field :title, :size => 40, :class => 'fine_print text_field' %>
+    <div class='fine_print field_help'>
+      e.g., 'Terms of Use'
+    </div>
+  </div>
+  <div class='field'>
+    <%= f.label :content, :class => 'fine_print' %>
+    <%= f.text_area :content, :cols => 56, :class => 'fine_print text_area' %>
+  </div>
+  <div class='actions'>
+    <%= f.submit nil, :class => 'fine_print submit' %>
+  </div>
+<% end %>

data/app/views/fine_print/contracts/edit.html.erb

@@ -0,0 +1,10 @@
+<h1 class='fine_print heading'>Editing Contract</h1>
+
+<div class='fine_print edit_contract'>
+  <%= render 'form' %>
+
+  <div class='fine_print links'>
+    <%= link_to 'Show', @contract, :class => 'fine_print link' %> |
+    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
+  </div>
+</div>

data/app/views/fine_print/contracts/index.html.erb

@@ -0,0 +1,43 @@
+<h1 class='fine_print heading'>FinePrint Contracts</h1>
+
+<div class='fine_print contract_index'>
+
+  <% @contracts.group_by(&:name).each do |name, contracts| %>
+
+    <%# Sort contracts by version number; unpublished contracts go at end by creation date %>
+    <% contracts = contracts.sort_by {|cc| cc.version || cc.created_at.to_i} %>
+
+    <ul class='fine_print'>
+      <li><%= name %></li>
+      
+        <ul class='fine_print'>
+          <% contracts.each do |contract| %>
+            <li><%= link_to contract.title, contract %> 
+              (<%= contract.version.nil? ? 'draft' : "v.#{contract.version.to_s}" %>)
+              <% if contract.can_be_updated? %>
+                [<%= link_to 'Edit', edit_contract_path(contract), :class => 'fine_print link' %>]
+              <% else %>
+                [<%= link_to 'New version', new_version_contract_path(contract), :class => 'fine_print link' %>]
+              <% end %>
+              <% if contract.can_be_published? %>
+                [<%= link_to 'Publish', publish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %>]
+              <% elsif contract.can_be_unpublished? %>
+                [<%= link_to 'Unpublish', unpublish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>]
+              <% end %>
+              <% if contract.can_be_destroyed? %>
+                [<%= link_to 'Delete', contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :class => 'fine_print link' %>]
+              <% end %>
+            </li>
+          <% end %>
+        </ul>
+      
+    </ul>
+
+  <% end %>
+
+  <div class='fine_print links'>
+    <%= link_to 'New Contract', new_contract_path, :class => 'fine_print link' %> |
+    <%= link_to 'Overview', root_path, :class => 'fine_print link' %>
+  </div>
+
+</div>

data/app/views/fine_print/contracts/index.html.erb~

@@ -0,0 +1,43 @@
+<h1 class='fine_print heading'>FinePrint Contracts</h1>
+
+<div class='fine_print contract_index'>
+
+  <% @contracts.group_by(&:name).each do |name, contracts| %>
+
+    <%# Sort contracts by version number; unpublished contracts go at end by creation date %>
+    <% contracts = contracts.sort_by {|cc| cc.version || cc.created_at.to_i} %>
+
+    <ul class='fine_print'>
+      <li><%= name %></li>
+      
+        <ul class='fine_print'>
+          <% contracts.each do |contract| %>
+            <li><%= link_to contract.title, contract %> 
+              (<%= contract.version.nil? ? 'draft' : "v.#{contract.version.to_s}" %>)
+              <% if contract.can_be_updated? %>
+                [<%= link_to 'Edit', edit_contract_path(contract), :class => 'fine_print link' %>]
+              <% else %>
+                [<%= link_to 'New version', new_version_contract_path(contract), :class => 'fine_print link' %>]
+              <% end %>
+              <% if contract.can_be_published? %>
+                [<%= link_to 'Publish', publish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %>]
+              <% elsif contract.can_be_unpublished? %>
+                [<%= link_to 'Unpublish', unpublish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>]
+              <% end %>
+              <% if contract.can_be_destroyed? %>
+                [<%= link_to 'Delete', contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :class => 'fine_print link' %>]
+              <% end %>
+            </li>
+          <% end %>
+        </ul>
+      
+    </ul>
+
+  <% end %>
+
+  <div class='fine_print links'>
+    <%= link_to 'New Contract', new_contract_path, :class => 'fine_print link' %> |
+    <%= link_to 'Overview', root_path, :class => 'fine_print link' %>
+  </div>
+
+</div>

data/app/views/fine_print/contracts/new.html.erb

@@ -0,0 +1,9 @@
+<h1 class='fine_print heading'>New Contract</h1>
+
+<div class='fine_print new_contract'>
+  <%= render 'form' %>
+
+  <div class='fine_print links'>
+    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
+  </div>
+</div>

data/app/views/fine_print/contracts/new_version.html.erb

@@ -0,0 +1,9 @@
+<h1 class='fine_print heading'>New Version of <%= @contract.name %></h1>
+
+<div class='fine_print new_contract_version'>
+  <%= render 'form' %>
+
+  <div class='fine_print links'>
+    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
+  </div>
+</div>

data/app/views/fine_print/contracts/show.html.erb

@@ -0,0 +1,33 @@
+<h1 class='fine_print heading'>Contract Details</h1>
+
+<div class='fine_print show_contract'>
+  <table class='fine_print left_heading'>
+    <tr>
+      <th>Name</th>
+      <td><%= @contract.name %></td>
+    </tr>
+    <tr>
+      <th>Title</th>
+      <td><%= @contract.title %></td>
+    </tr>
+    <tr>
+      <th>Version</th>
+      <td><%= @contract.version.nil? ? 'Draft' : @contract.version %></td>
+    </tr>
+    <tr>
+      <th>Updated at</th>
+      <td><%= @contract.updated_at %></td>
+    </tr>
+    <tr>
+      <th>Content</th>
+      <td><%= @contract.content.html_safe %></td>
+    </tr>
+  </table>
+
+  <div class='fine_print links'>
+    <% if @contract.can_be_updated? %>
+      <%= link_to 'Edit', edit_contract_path(@contract), :class => 'fine_print link' %> |
+    <% end %>
+    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
+  </div>
+</div>

data/app/views/fine_print/contracts/show.html.erb~

@@ -0,0 +1,35 @@
+<h1 class='fine_print heading'>Contract Details</h1>
+
+<div class='fine_print show_contract'>
+
+  <table class='fine_print left_heading'>
+    <tr>
+      <th>Name</th>
+      <td><%= @contract.name %></td>
+    </tr>
+    <tr>
+      <th>Title</th>
+      <td><%= @contract.title %></td>
+    </tr>
+    <tr>
+      <th>Version</th>
+      <td><%= @contract.version.nil? ? 'Draft' : @contract.version %></td>
+    </tr>
+    <tr>
+      <th>Updated at</th>
+      <td><%= @contract.updated_at %></td>
+    </tr>
+    <tr>
+      <th>Content</th>
+      <td><%= @contract.content.html_safe %></td>
+    </tr>
+  </table>
+
+  <div class='fine_print links'>
+    <% if @contract.can_be_updated? %>
+      <%= link_to 'Edit', edit_contract_path(@contract), :class => 'fine_print link' %> |
+    <% end %>
+    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
+  </div>
+
+</div>

data/app/views/fine_print/home/index.html.erb

@@ -1,7 +1,16 @@
-<h1 class="fine_print heading">FinePrint</h1>
-
-<ul>
-  <li><%= link_to 'Manage agreements', agreements_path, :class => "fine_print link" %></li>
-  <li><%= link_to 'View accepted agreements', user_agreements_path, :class => "fine_print link" %></li>
-</ul>
+<h1 class='fine_print heading'>FinePrint</h1>
 
+<div class='fine_print root'>
+  <ul class='fine_print'>
+    <li>
+      <%= link_to 'Manage contracts',
+                  contracts_path,
+                  :class => 'fine_print link' %>
+    </li>
+    <li>
+      <%= link_to 'View signatures',
+                  signatures_path,
+                  :class => 'fine_print link' %>
+    </li>
+  </ul>
+</div>

data/app/views/fine_print/home/index.html.erb~

@@ -1,7 +1,15 @@
-<h1 class="fine_print heading">FinePrint</h1>
+<h1 class='fine_print heading'>FinePrint</h1>
 
-<ul>
-  <li><%= link_to 'Manage agreements', agreements_path, :class => "fine_print link" %></li>
-  <li><%= link_to 'Accepted agreements', user_agreements_path, :class => "fine_print link" %></li>
+<ul class='fine_print'>
+  <li>
+    <%= link_to 'Manage contracts', 
+                contracts_path, 
+                :class => 'fine_print link' %>
+  </li>
+  <li>
+    <%= link_to 'View signatures', 
+                signatures_path, 
+                :class => 'fine_print link' %>
+  </li>
 </ul>
 

data/app/views/fine_print/signatures/index.html.erb

@@ -0,0 +1,36 @@
+<h1 class='fine_print heading'>Contract Signatures</h1>
+
+<div class='fine_print signature_index'>
+
+  <table class='fine_print top_heading index'>
+    <tr class='fine_print heading-row'>
+      <th>User ID</th>
+      <th>Contract name</th>
+      <th>Contract version</th>
+      <th>Date accepted</th>
+      <th></th>
+    </tr>
+
+  <% @signatures.each do |signature| %>
+    <tr class='fine_print data-row <%= cycle('even', 'odd') %>'>
+      <td><%= signature.user.id %></td>
+      <td><%= signature.contract.name %></td>
+      <td><%= signature.contract.version %></td>
+      <td><%= signature.created_at %></td>
+      <td><%= link_to 'Terminate', 
+                      signature, 
+                      :method => :delete, 
+                      :data => { 
+                        :confirm => 'User will be asked to accept the contract again. Are you sure?' 
+                      }, 
+                      :class => 'fine_print link' %>
+      </td>
+    </tr>
+  <% end %>
+  </table>
+
+  <div class='fine_print links'>
+    <%= link_to 'Overview', root_path, :class => 'fine_print link' %>
+  </div>
+  
+</div>

data/app/views/fine_print/signatures/index.html.erb~

@@ -0,0 +1,32 @@
+<h1 class='fine_print heading'>Contract Signatures</h1>
+
+<table class='fine_print index'>
+  <tr class='fine_print heading-row'>
+    <th>User ID</th>
+    <th>Contract name</th>
+    <th>Contract version</th>
+    <th>Date accepted</th>
+    <th></th>
+  </tr>
+
+<% @signatures.each do |signature| %>
+  <tr class='fine_print data-row <%= cycle('even', 'odd') %>'>
+    <td><%= signature.user.id %></td>
+    <td><%= signature.contract.name %></td>
+    <td><%= signature.contract.version %></td>
+    <td><%= signature.created_at %></td>
+    <td><%= link_to 'Terminate', 
+                    signature, 
+                    method: :delete, 
+                    data: { 
+                      confirm: 'User will be asked to accept the contract again. Are you sure?' 
+                    }, 
+                    :class => 'fine_print link' %>
+    </td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'Overview', root_path, :class => 'fine_print link' %>

data/app/views/layouts/fine_print/application.html.erb

@@ -8,6 +8,12 @@
 </head>
 <body>
 
+<% if flash[:alert] %>
+  <div class="alert"><%= flash[:alert] %></div>
+<% elsif flash[:notice] %>
+  <div class="notice"><%= flash[:notice] %></div>
+<% end %>
+
 <%= yield %>
 
 </body>

data/app/views/layouts/fine_print/application.html.erb~

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>FinePrint</title>
+  <%= stylesheet_link_tag    "fine_print/application", :media => "all" %>
+  <%= javascript_include_tag "fine_print/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<% if flash[:notice] %>
+  <div class="notice"><%= flash[:notice] %></div>
+<% elsif flash[:notice] %>
+  <div class="notice"><%= flash[:notice] %></div>
+<% end %>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/fine_print.rb

@@ -1,53 +1,36 @@
 # Change the settings below to suit your needs
 # All settings are initially set to their default values
 FinePrint.configure do |config|
+  # Engine Configuration
 
-  # Engine Options (initializer only)
+  # Name of the ApplicationController helper method that returns the current user.
+  # Default: 'current_user'
+  config.current_user_method = 'current_user'
 
-  # Name of the ApplicationController helper method that returns the current user
-  # Default: "current_user"
-  config.current_user_method = "current_user"
-
-  # Proc called with user as argument that should return true if and only if the user is an admin
-  # Admins can create and edit agreements and terminate accepted agreements
+  # Proc called with user as argument that should return true if and only if the user is an admin.
+  # Admins can create and edit agreements and terminate accepted agreements.
   # Default: lambda { |user| false } (no admins)
   config.user_admin_proc = lambda { |user| false }
 
-  # Path to redirect users to when an error occurs (e.g. permission denied on admin pages)
-  # Default: "/"
-  config.redirect_path = "/"
-
-  # Path to link users to if they need to sign in
-  # Set to nil to disable the link
-  # Default: "/"
-  config.sign_in_path = "/"
-
-
-
-  # Agreement Options (initializer or inline)
-
-  # Message to be displayed to the user explaining that they need to accept an agreement
-  # Set to nil to disable
-  # Default: "You must accept the following agreement to proceed."
-  config.agreement_notice = "You must accept the following agreement to proceed."
-
-  # Path to redirect users to when an agreement is accepted and referer information is unavailable
-  # Default: "/"
-  config.accept_path = "/"
-
-  # Path to redirect users to when an agreement is not accepted and referer information is unavailable
-  # Default: "/"
-  config.cancel_path = "/"
-
-  # Whether to use referer information to redirect users after (not) accepting an agreement
-  # Default: true
-  config.use_referers = true
-
-  # If set to true, modal jQuery UI dialogs will be used instead of redirecting the user to the agreement page
-  # Note: users with javascript disabled will not even see the agreement and will be able to proceed without accepting it
-  #       if users are not supposed to ever see or interact with a certain page without accepting the agreement,
-  #       disable this option for that particular controller action
-  # Default: false
-  config.use_modal_dialogs = false
-  
+  # Proc that returns true if and only if the provided user is logged in.
+  # In many systems, a non-logged-in user is represented by nil.
+  # However, some systems use something like an AnonymousUser class to represent this state.
+  # This proc is mostly used to help the developer realize that they should only be asking
+  # signed in users to sign contracts; without this, developers would get a cryptic SQL error.
+  # Default: lambda { |user| !user.nil? }
+  config.user_signed_in_proc = lambda { |user| !user.nil? }
+
+  # Path to redirect users to when an error occurs (e.g. permission denied on admin pages).
+  # Default: '/'
+  config.redirect_path = '/'
+
+  # Signature (fine_print_get_signatures) Configuration
+
+  # Path to redirect users to when they need to agree to contract(s).
+  # A list of contract names that must be agreed to will be available in the 'contracts' parameter.
+  # Your code doesn't have to deal with all of them at once, e.g. you can get
+  # the user to agree to the first one and then they'll just eventually be
+  # redirected back to this page with the remaining contract names.
+  # Default: '/'
+  config.pose_contracts_path = '/'
 end