fine_print 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Rice University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# FinePrint
+
+FinePrint is a Rails gem that makes managing web site agreements (terms, privacy policy, etc) simple and easy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'fine_print'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself:
+
+```sh
+$ gem install fine_print
+```
+
+Then execute the following command to copy the necessary migration and the initializer to your application:
+
+```sh
+$ rake fine_print:install
+```
+
+And then migrate your database:
+
+```sh
+$ rake db:migrate
+```
+
+Also add FinePrint to your application's routes:
+
+```rb
+mount FinePrint::Engine => "/fine_print"
+```
+
+And provide a link on your site for administrators to access the fine_print engine to manage agreements.
+
+```erb
+<%= link_to 'FinePrint', fine_print_path %>
+```
+
+Finally, make sure your `application.js` requires jquery and jquery_ujs (it usually does by default):
+
+```js
+//= require jquery
+//= require jquery_ujs
+```
+
+**Note:** FinePrint will **automatically** add the fine_print/dialog.js file to your asset precompilation list.
+
+## Configuration
+
+After installation, the initializer for FinePrint will be located under `config/initializers/fine_print.rb`.
+Make sure to configure it to suit your needs.
+Pay particular attention to `user_admin_proc`, as you will be unable to manage your agreements unless you set up this proc to return true for your admins.
+
+If you want to use FinePrint's modal dialogs, then make sure `application.js` also requires jquery-ui:
+
+```js
+//= require jquery-ui
+```
+
+## Usage
+
+FinePrint adds a new method to all controllers that behaves like a before_filter.
+It can be accessed by calling `fine_print_agreement` from any controller.
+This method takes an agreement name and an options hash.
+Accepted options are (see initializer for more explanation):
+
+- `only` and `except` just like a before_filter
+
+- `agreement_notice` notice to be shown to the user above the agreement
+
+- `accept_path` path to redirect users to when an agreement is accepted and no referer information is available
+- `cancel_path` path to redirect users to when an agreement is not accepted and no referer information is available
+- `use_referers` false if you want users to always be redirected to the above paths
+
+- `use_modal_dialogs` true if you want to use FinePrint's modal dialogs
+
+Example:
+
+```rb
+fine_print_agreement 'terms of use', :except => :index, :use_modal_dialogs => true
+```
+
+This gem also adds the `fine_print_dialog` helper method, which needs to be called (usually from your layout) if you want to use FinePrint's modal dialogs.
+This method only takes an options hash. Accepted options are:
+
+- `width`
+- `height`
+
+Example:
+
+```erb
+<%= fine_print_dialog, :width => 800, :height => 600 %>
+```
+
+## Managing Agreements
+
+Here are some important notes about managing your agreements with FinePrint:
+
+- Agreements are referred to on your controller by the name you specified
+- Creating another agreement with the same name will make it a new version of a previous agreement
+- Agreements need to be marked as `ready` to be able to be accepted by users
+- The latest version of each agreement that is marked as `ready` will always be used
+- Agreements cannot be modified after at least one user has accepted them, but you can always create new versions
+- When a new version is present, users will be asked to accept it the next time they visit a controller action that calls `fine_print_agreement`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create specs for your feature
+4. Ensure that all specs pass
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new pull request

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test => 'app:db:test:prepare') do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test
+

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

@@ -0,0 +1,19 @@
+function fine_print_agreement_checkbox(index) {
+  var checkbox = $("#fine_print_confirmation_checkbox_" + index);
+  if (!checkbox) {
+    return;
+  }
+  checkbox.change(function() {
+    $("#fine_print_submit_ok_" + index).attr("disabled", !this.checked);
+    try {
+      if (this.checked) {
+        $("#fine_print_submit_ok_" + index).button("enable");
+      }
+      else {
+        $("#fine_print_submit_ok_" + index).button("disable");
+      }
+    }
+    catch(e) {}
+  });
+  $("#fine_print_submit_ok_" + index).attr("disabled", !checkbox.checked);
+}

data/app/assets/javascripts/fine_print/agreements.js~

@@ -0,0 +1,19 @@
+function fine_print_agreement_checkbox(index) {
+  var checkbox = $("#fine_print_confirmation_checkbox_" + index);
+  if (!checkbox) {
+    return;
+  }
+  checkbox.change(function() {
+    $("#fine_print_submit_ok_" + index).attr("disabled", !this.checked);
+    try {
+      if (this.checked) {
+        $("#fine_print_submit_ok_" + index).button("enable");
+      }
+      else {
+        $("#fine_print_submit_ok_" + index).button("disable");
+      }
+    }
+    catch (e) {}
+  });
+  $("#fine_print_submit_ok_" + index).attr("disabled", !checkbox.checked);
+}

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

@@ -0,0 +1,4 @@
+//= require jquery
+//= require jquery_ujs
+//= require fine_print/agreements
+//= require fine_print/user_agreements

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

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+//= require jquery-ui
+//= require fine_print/agreements
+//= require fine_print/user_agreements

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

@@ -0,0 +1,2 @@
+//= require fine_print/agreements
+//= require fine_print/user_agreements

data/app/assets/javascripts/fine_print/dialog.js~

@@ -0,0 +1,2 @@
+//= require agreements
+//= require user_agreements

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

@@ -0,0 +1,20 @@
+function fine_print_init_dialog(index, width, height) {
+  $("#fine_print_dialog_" + index).dialog({
+    autoOpen: false,
+    draggable: false,
+    modal: true,
+    resizable: false,
+    width: width,
+    height: height
+  }).on("dialogbeforeclose", function(event, ui) {
+    window.history.back();
+    return false;
+  });
+}
+
+$(function () {
+  try {
+    $("#fine_print_dialog_0").dialog("open");
+  }
+  catch(e) {}
+});

data/app/assets/javascripts/fine_print/user_agreements.js~

@@ -0,0 +1,20 @@
+function fine_print_init_dialog(index, width, height) {
+  $("#fine_print_dialog_" + index).dialog({
+    autoOpen: false,
+    draggable: false,
+    modal: true,
+    resizable: false,
+    width: 640,
+    height: 480
+  }).on("dialogbeforeclose", function(event, ui) {
+    window.history.back();
+    return false;
+  });
+}
+
+$(function () {
+  try {
+    $("#fine_print_dialog_0").dialog("open");
+  }
+  catch(e) {}
+});

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

@@ -0,0 +1,11 @@
+pre.fine_print.agreement.content {
+  background-color: white;
+}
+
+div.fine_print.agreement.dialog {
+  display: none;
+}
+
+input.fine_print.checkbox {
+  float: left;
+}

data/app/assets/stylesheets/fine_print/agreements.css~

@@ -0,0 +1,11 @@
+pre.fine_print.agreement.content {
+  background-color: white;
+}
+
+pre.fine_print.agreement.dialog {
+  display: none;
+}
+
+input.fine_print.checkbox {
+  float: left;
+}

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

@@ -0,0 +1,5 @@
+/*
+ *= require_self
+ *= require_tree .
+ */
+

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

@@ -0,0 +1,60 @@
+/*
+ *= require_self
+ *= require_tree .
+ */
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

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

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/assets/stylesheets/fine_print/user_agreements.css~

@@ -0,0 +1,3 @@
+input.fine_print .check_box {
+  float: left;
+}

data/app/assets/stylesheets/scaffold.css~

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/fine_print/agreements_controller.rb

@@ -0,0 +1,114 @@
+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)
+      @cancel_path = session.delete(:fine_print_cancel_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