fine_print 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ae19efef1a93bef86de360020973d0c72e58e74
-  data.tar.gz: fd9d302b91cebd30ad20e4aaac6530c0d9d29e95
+  metadata.gz: 229ff9376133bf2ec88be816ca6c0616cc3870c5
+  data.tar.gz: ba35f289d9cbf3f3405fa02eba2b87d6ec1f552d
 SHA512:
-  metadata.gz: eb8a60a9956d17a72e7b8b59725d6ca269a7103ddd1219ad9318b68662b34ec4384ee3529294aae6d1706835e4ade31e5f53a97dfe6fd30434d2bdff95ad4661
-  data.tar.gz: 212e0c1badbd251eba90272f370ef6e77d96755ade8e067ef3c2cd780c618f2b53b064e5ea0b354e0ceb3d0eb6666bef6bbb0557dddd1a2bbd583c56fa2977dd
+  metadata.gz: 9a56e58821c884748ccd333fe9c9f87e7d16d393da9646069c39b02f1f81afbc883b74a4ab3ad3e919b4913f68feccd189089549ac00a0e7c998f1f9f18b4886
+  data.tar.gz: cd1acacfbf520bc35018053891830c15017a71517f0cbd7cac4cdceb251f7261173e4a1af59accb9779190bc4382c21aab63d0787e77fa6e0b08dc4065d24e8f

data/README.md

@@ -1,6 +1,10 @@
 # FinePrint
 
-FinePrint is a Rails gem (engine) that makes managing web site agreements (terms, privacy policy, etc) simple and easy.
+[![Gem Version](https://badge.fury.io/rb/fine_print.svg)](http://badge.fury.io/rb/fine_print)
+[![Build Status](https://travis-ci.org/lml/fine_print.svg?branch=master)](https://travis-ci.org/lml/fine_print)
+[![Code Climate](https://codeclimate.com/github/lml/fine_print/badges/gpa.svg)](https://codeclimate.com/github/lml/fine_print)
+
+FinePrint is a Rails engine in gem form that makes managing web site agreements (terms of use, privacy policy, etc) simple and easy.
 
 As the meaning of 'agreement' can be somewhat ambiguous (meaning either the thing someone agrees to or the record of the agreement between that thing and the user), we call a set of terms a 'contract' and a user's agreement to that contract a 'signature'.
 
@@ -64,13 +68,16 @@ You can choose to check if users signed contracts either as a before_filter or i
 
 ### Option 1 - As a before_filter
 
-If you choose to have FinePrint work like a before_filter, you can user the following 2 class methods, which are automatically added to all of your controllers:
+If you choose to have FinePrint work like a before_filter, you can user the following 3 class methods, which are automatically added to all of your controllers:
 
 ```rb
 fine_print_get_signatures(contract_names..., options_hash)
+fine_print_require_signatures(contract_names..., options_hash)
 fine_print_skip_signatures(contract_names..., options_hash)
 ```
 
+They work as follows:
+- `fine_print_get_signatures` will redirect the user
 To require that your users sign the most recent version of a contract, call
 `fine_print_get_signatures` in your controller classes. It works just like a `before_filter` (in fact, it will add a `before_filter` for you).
 

data/Rakefile

@@ -20,4 +20,3 @@ desc 'Run all specs in spec directory (excluding plugin specs)'
 RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
 task :default => :spec
-

data/app/assets/javascripts/fine_print/application.js

@@ -7,4 +7,3 @@
 //= require jquery
 //= require jquery_ujs
 //= require_tree .
-

data/app/assets/stylesheets/fine_print/application.css

@@ -2,4 +2,3 @@
  *= require_self
  *= require_tree .
  */
-

data/app/controllers/fine_print/application_controller.rb

@@ -1,12 +1,17 @@
 module FinePrint
   class ApplicationController < ActionController::Base
-    before_filter :verify_admin
+    respond_to :html
+
+    before_filter :get_user, :can_manage
 
     protected
 
-    def verify_admin
-      user = FinePrint.current_user_proc.call(self)
-      FinePrint.raise_unless_admin(user)
+    def get_user
+      @user = instance_exec &FinePrint.current_user_proc
+    end
+
+    def can_manage
+      with_interceptor { instance_exec @user, &FinePrint.can_manage_proc }
     end
   end
 end

data/app/controllers/fine_print/contracts_controller.rb

@@ -1,22 +1,17 @@
 module FinePrint
   class ContractsController < FinePrint::ApplicationController
     include FinePrint::ApplicationHelper
+
     before_filter :get_contract, :except => [:index, :new, :create]
 
     def index
-      @contracts = Contract.all
-    end
-  
-    def show
+      @contracts = Contract.includes(:signatures).all.to_a.group_by(&:name)
     end
 
     def new
       @contract = Contract.new
     end
-  
-    def edit
-    end
-  
+
     def create
       @contract = Contract.new
       @contract.name = params[:contract][:name]
@@ -26,10 +21,19 @@ module FinePrint
       if @contract.save
         redirect_to @contract, :notice => 'Contract was successfully created.'
       else
-        render :action => 'new'
+        render :action => 'new', :alert => merge_errors_for(@contract)
       end
     end
-  
+
+    def show
+    end
+
+    def edit
+      @contract.no_signatures
+      redirect_to contracts_path, :alert => merge_errors_for(@contract) \
+        unless @contract.errors.empty?
+    end
+
     def update
       @contract.name = params[:contract][:name]
       @contract.title = params[:contract][:title]
@@ -38,7 +42,7 @@ module FinePrint
       if @contract.save
         redirect_to @contract, :notice => 'Contract was successfully updated.'
       else
-        render :action => 'edit'
+        render :action => 'edit', :alert => merge_errors_for(@contract)
       end
     end
 
@@ -67,7 +71,7 @@ module FinePrint
     end
 
     def new_version
-      @contract = @contract.draft_copy
+      @contract = @contract.new_version
     end
 
     protected

data/app/controllers/fine_print/home_controller.rb

@@ -1,4 +1,9 @@
 module FinePrint
   class HomeController < FinePrint::ApplicationController
+
+    def index
+      redirect_to contracts_path
+    end
+
   end
 end

data/app/controllers/fine_print/signatures_controller.rb

@@ -1,14 +1,56 @@
 module FinePrint
   class SignaturesController < FinePrint::ApplicationController
+    include FinePrint::ApplicationHelper
+
+    acts_as_interceptor :override_url_options => true
+
+    skip_before_filter :can_manage, :only => [:new, :create]
+    before_filter :can_sign, :only => [:new, :create]
+    before_filter :get_contract, :only => [:index, :new, :create]
+
     def index
-      @signatures = Signature.all
+      @signatures = @contract.signatures
+    end
+
+    def new
+      @signature = Signature.new
+    end
+
+    def create
+      @signature = Signature.new
+
+      unless params[:signature_accept]
+        @signature.errors.add(:contract, 'must be accepted to proceed')
+        render :action => 'new'
+        return
+      end
+
+      @signature.user = @user
+      @signature.contract = @contract
+  
+      if @signature.save
+        redirect_back
+      else
+        render :action => 'new', :alert => merge_errors_for(@signature)
+      end
     end
   
     def destroy
       @signature = Signature.find(params[:id])
 
       @signature.destroy
-      redirect_to signatures_path
+      redirect_to contract_signatures_path(@signature.contract),
+                  :notice => 'Signature was successfully deleted.'
+    end
+
+    protected
+
+    def can_sign
+      with_interceptor { instance_exec @user, &FinePrint.can_sign_proc }
+    end
+
+    def get_contract
+      @contract = Contract.find(params[:contract_id])
     end
   end
 end

data/app/models/fine_print/contract.rb

@@ -1,45 +1,35 @@
 module FinePrint
   class Contract < ActiveRecord::Base
-    has_many :signatures, :inverse_of => :contract
+    has_many :signatures, :dependent => :destroy, :inverse_of => :contract
 
-    has_many :same_name, :class_name => 'Contract', :primary_key => :name, :foreign_key => :name
+    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
+    validates :name, :presence => true, :format => /\A[\w-]+\z/
+    validates :title, :presence => true
+    validates :content, :presence => true
+    validates :version, :uniqueness => {:scope => :name, :case_sensitive => false},
+                        :allow_nil => true
 
-    default_scope { order(:name, 'version DESC') }
+    default_scope lambda { order{[name.asc, version.desc]} }
 
-    scope :published, lambda { where(arel_table[:version].not_eq(nil)) }
-    scope :latest, lambda {
-      published.joins(:same_name)
-               .group('fine_print_contracts.id')
-               .having(:version =>
-                       arel_table.alias(:same_names_fine_print_contracts)[:version].maximum.tap{|mvq| mvq.alias = nil})
-    }
+    scope :published, lambda { where{version != nil} }
+    scope :latest, lambda { joins(:same_name).group{id}
+                              .having{version == max(same_name.version)} }
 
     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)
+      is_published? && self == same_name.published.first
     end
 
     def publish
-      no_signatures
       errors.add(:base, 'Contract is already published') if is_published?
       return false unless errors.empty?
 
@@ -48,7 +38,6 @@ module FinePrint
     end
 
     def unpublish
-      no_signatures
       errors.add(:base, 'Contract is not the latest published version') unless is_latest?
       return false unless errors.empty?
 
@@ -56,28 +45,11 @@ module FinePrint
       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?
+    def new_version
+      Contract.where(:name => name, :version => nil).first || \
+        dup.tap{|contract| contract.version = nil}
     end
 
-    def can_be_unpublished?
-      signatures.empty? && is_latest?
-    end
-
-    alias_method :can_be_destroyed?, :can_be_updated?
-
     ##############
     # Validation #
     ##############
@@ -91,7 +63,7 @@ module FinePrint
     protected
 
     def downcase_name
-      self.name = name.downcase
+      self.name = name.try(:downcase)
     end
   end
 end

data/app/models/fine_print/signature.rb

@@ -3,10 +3,11 @@ module FinePrint
     belongs_to :contract, :inverse_of => :signatures
     belongs_to :user, :polymorphic => true
 
-    before_create :contract_published
+    validate :contract_published, :on => :create
 
-    validates_presence_of :contract, :user_type, :user_id
-    validates_uniqueness_of :contract_id, :scope => [:user_type, :user_id]
+    validates :contract, :presence => true,
+                         :uniqueness => {:scope => [:user_type, :user_id]}
+    validates :user, :presence => true
 
     default_scope { order(:contract_id, :user_type, :user_id) }
 

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

@@ -0,0 +1,11 @@
+<%# Clients of this partial must provide the following variable:
+    contract %>
+
+<h2 class='fine_print heading'><%= contract.title %> <%= @contract.version ? \
+  "(v.#{@contract.version})" : 'Draft' %></h2>
+
+<h4 class='fine_print heading'>Last updated: <%= contract.updated_at %></h4>
+
+<div class='fine_print contract'>
+  <pre><%= @contract.content.html_safe %></pre>
+</div>

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

@@ -7,4 +7,4 @@
     <%= link_to 'Show', @contract, :class => 'fine_print link' %> |
     <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
   </div>
-</div>
+</div>

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

@@ -2,10 +2,10 @@
 
 <div class='fine_print contract_index'>
 
-  <% @contracts.group_by(&:name).each do |name, contracts| %>
+  <% @contracts.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} %>
+    <% #contracts = contracts.sort_by {|cc| cc.version || cc.created_at.to_i} %>
 
     <ul class='fine_print'>
       <li><%= name %></li>
@@ -14,18 +14,17 @@
           <% contracts.each do |contract| %>
             <li><%= link_to contract.title, contract %> 
               (<%= contract.version.nil? ? 'draft' : "v.#{contract.version.to_s}" %>)
-              <% if contract.can_be_updated? %>
+              <% if contract.signatures.empty? %>
                 [<%= 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? %>
+                <% if contract.is_published? %>
+                  [<%= link_to 'Unpublish', unpublish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>]
+                <% else %>
+                  [<%= link_to 'Publish', publish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %>]
+                <% end %>
                 [<%= link_to 'Delete', contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :class => 'fine_print link' %>]
+              <% else %>
+                [<%= link_to 'New version', new_version_contract_path(contract), :method => :post %>]
+                [<%= link_to 'Signatures', contract_signatures_path(contract) %>]
               <% end %>
             </li>
           <% end %>
@@ -36,8 +35,7 @@
   <% 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' %>
+    <%= link_to 'New Contract', new_contract_path, :class => 'fine_print link' %>
   </div>
 
 </div>

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

@@ -6,4 +6,4 @@
   <div class='fine_print links'>
     <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
   </div>
-</div>
+</div>

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

@@ -1,33 +1,22 @@
 <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>
+<h4 class='fine_print heading'>Name: <%= @contract.name %></h4>
 
-  <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>
+<%= render :partial => 'show', :locals => {:contract => @contract} %>
+
+<div class='fine_print links'>
+  <% if @contract.signatures.empty? %>
+    <%= link_to 'Edit', edit_contract_path(@contract), :class => 'fine_print link' %> |
+      <% if @contract.is_published? %>
+        <%= link_to 'Unpublish', unpublish_contract_path(@contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>
+      <% else %>
+        <%= link_to 'Publish', publish_contract_path(@contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %> |
+      <% end %>
+      <%= link_to 'Delete', @contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :class => 'fine_print link' %>
+  <% else %>
+    <%= link_to 'New version', new_version_contract_path(@contract), :method => :post %> |
+    <%= link_to 'Signatures', contract_signatures_path(@contract),
+                              :class => 'fine_print link' %>
+  <% end %>
+  | <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
 </div>

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

@@ -0,0 +1,21 @@
+<%= form_for([@contract, @signature], :html => {:class => 'fine_print'}) do |f| %>
+  <% if @signature.errors.any? %>
+    <div id='error_explanation' class='fine_print errors'>
+      <h4 class='fine_print heading'>Error:</h4>
+
+      <ul>
+        <% @signature.errors.full_messages.each do |msg| %>
+          <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class='field'>
+    <%= f.label :accept, 'I have read and accept the terms above.', :class => 'fine_print' %>
+    <%= check_box_tag :signature_accept, :class => 'fine_print check_box' %>
+  </div>
+  <div class='actions'>
+    <%= f.submit 'I agree', :class => 'fine_print submit' %>
+  </div>
+<% end %>

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

@@ -1,12 +1,10 @@
-<h1 class='fine_print heading'>Contract Signatures</h1>
+<h1 class='fine_print heading'>Signatures for <%= link_to "#{@contract.title} (v.#{@contract.version})", @contract %></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>
@@ -14,8 +12,6 @@
   <% @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, 
@@ -30,7 +26,7 @@
   </table>
 
   <div class='fine_print links'>
-    <%= link_to 'Overview', root_path, :class => 'fine_print link' %>
+    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
   </div>
   
-</div>
+</div>

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

@@ -0,0 +1,13 @@
+<div class='fine_print contract'>
+  <%= render :partial => 'fine_print/contracts/show',
+             :locals => {:contract => @contract} %>
+</div>
+
+<div class='fine_print new_signature'>
+  <%= render 'form' %>
+
+  <div class='fine_print links'>
+    <%= without_interceptor { link_to 'I do not agree',
+          main_app.root_url, :class => 'fine_print link' } %>
+  </div>
+</div>

data/config/initializers/fine_print.rb

@@ -1,41 +1,44 @@
 # Change the settings below to suit your needs
 # All options are initially set to their default values
 FinePrint.configure do |config|
+
   # Engine Configuration
 
-  # Proc called with a controller as argument.
+  # Proc called with a controller as self.
   # Returns the current user.
-  # Default: lambda { |controller| controller.current_user }
-  config.current_user_proc = lambda { |controller| controller.current_user }
-
-  # Proc called with a user as argument.
-  # Returns true iif 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 }
-
-  # Proc called with a user as argument
-  # Returns true iif the argument the user is allowed to sign a contract.
-  # 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.
-  # If this proc returns false, FinePrint will not ask for signatures and will not redirect the user, so it's up to the developer to make sure that unsigned users can't access pages that should require a signed contract to use.
-  # Default: lambda { |user| !!user }
-  config.user_can_sign_proc = lambda { |user| !!user }
-
-
-
-  # Contract Configuration
-
-  # What to call the contract names param, passed when the user is redirected
-  # This is visible to the user in the Url
-  # Default: 'contracts'
-  config.contract_param_name = 'contracts'
+  # Default: lambda { current_user }
+  config.current_user_proc = lambda { current_user }
+
+  # Proc called with a user as argument and a controller as self.
+  # This proc is called when a user tries to access FinePrint's controllers.
+  # Should raise and exception, render or redirect unless the user can manage contracts.
+  # Contract managers can create and edit agreements and terminate accepted agreements.
+  # The default does not allow anyone to manage contracts.
+  # Note: Proc must account for nil users, if current_user_proc returns nil.
+  # Default: lambda { |user| false || raise(ActionController::RoutingError, 'Not Found') }
+  config.can_manage_proc = lambda { |user| false || \
+                                      raise(ActionController::RoutingError, 'Not Found') }
+
+  # Proc called with a user as argument and a controller as self.
+  # This proc is called to check that the given user is allowed to sign contracts.
+  # Should raise and exception, render or redirect unless the user can sign contracts.
+  # You might want to redirect users to a login page if they are not signed in.
+  # The default renders 401 Unauthorized for nil users.
+  # Default: lambda { |user| !user.nil? || head(:unauthorized) }
+  config.can_sign_proc = lambda { |user| !user.nil? || head(:unauthorized) }
+
+  # Controller Configuration
+
+  # Proc called with a user and an array of contract ids as arguments and a controller as self.
+  # This proc is called when a user tries to access a resource protected by FinePrint,
+  # but has not signed all the required contracts.
+  # Should raise and exception, render or redirect the user.
+  # The `contract_ids` variable contains the contract ids that need to be signed.
+  # The default redirects users to FinePrint's contract signing views.
+  # The `fine_print_return` method can be used to return from a redirect made here.
+  # Default: lambda { |user, contract_ids| with_interceptor { redirect_to(
+  #   fine_print.new_contract_signature_path(:contract_id => contract_ids.first)) } }
+  config.must_sign_proc = lambda { |user, contract_ids| redirect_to(
+    fine_print.new_contract_signature_path(:contract_id => contract_ids.first)) }
 
-  # 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 `contract_param_name` 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.contract_redirect_path = '/'
 end

data/config/routes.rb

@@ -1,13 +1,13 @@
 FinePrint::Engine.routes.draw do
+  root :to => 'home#index'
+
   resources :contracts do
+    resources :signatures, :only => [:index, :new, :create, :destroy], :shallow => true
+
     member do
-      get :new_version
+      post :new_version
       put :publish
       put :unpublish
     end
   end
-
-  resources :signatures, :only => [:index, :destroy]
-
-  root :to => 'home#index'
 end