fine_print 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d381ead09489e5ca6b883c0ce22c68f7c9b9a623
-  data.tar.gz: 05d8ababdd00605954298ffdb15c0f89dfe9268b
+  metadata.gz: 5872d7ae6a8abfb926c3eb5c3203e086937ee70c
+  data.tar.gz: c685f59d91186586a78bd74eafaf16e2c02c2b65
 SHA512:
-  metadata.gz: 01d698b01cc332ba64c925ee1d1a1e9fd0502a398f95a9c654b5b00199e4f0e7eda1ea96623484779defda49541b341801e5d6d0c0dd9490adb0ba869b22512c
-  data.tar.gz: 4aeb8f6fb1b4971033c9ab4c21676d22ffdf60651a4423e63e85286bc3dc606faced415717dd6f4aa8dfe448532f2000b72a59fb09d089ffbd6da16e3b3829f3
+  metadata.gz: 96ee62c1e276077980ff95575e896ada2e679d9663a4bd84c55208434e86c37452b84ed1b83142b6051b07a217d520cc5ab336810c9e0dcbe1b93bdc20699e23
+  data.tar.gz: b4da61298157efa7fb336d8b88b8a4c2011b6373995b27e67d7cbff1bcaeaa5dfc6571095d7020d65ea95226d47ef0f4aa4be4b15609f685ef6d4c75728d87e9

data/README.md

@@ -60,11 +60,22 @@ Pay particular attention to `user_admin_proc`, as you will be unable to manage y
 
 ## Usage
 
-FinePrint adds 3 controller methods to all of your controllers:
+The FinePrint module contains several methods that help you find contracts and mark them as signed:
 
-`fine_print_get_signatures`, `fine_print_skip_signatures` and `fine_print_return`
+`get_contract(contract_object_or_id_or_name)`
+`sign_contract(user, contract_object_or_id_or_name)`
+`signed_contract?(user, contract_object_or_id_or_name)`
+`signed_any_contract_version?(user, contract_object_or_id_or_name)`
+`get_unsigned_contract_names(user, contract_names...)`
 
-Additionally, the FinePrint module contains several methods that help you find contracts and mark them as signed.
+Additionally, FinePrint adds 2 class methods to all of your controllers:
+
+`fine_print_get_signatures(contract_names..., options_hash)`
+`fine_print_skip_signatures(contract_names..., options_hash)`
+
+And 1 instance method, also to all of your controllers:
+
+`fine_print_return`
 
 To require that your users sign the most recent version of a contract, call
 `fine_print_get_signatures` in your controllers, just as you would a
@@ -114,10 +125,10 @@ the names of the unsigned contracts passed along in a `terms` array in the URL p
 
 Your job as the site developer is to present the terms to the user and ask them to sign them.
 This normally involves the user clicking an "I have read the above terms" checkbox which enables an "I Agree" button.
-When the "Agree" button is clicked (and you should verify that the checkbox is actually clicked in the params passed to the server), you need to send the information off to a controller 
-method that can call `FinePrint.sign_contract` which takes a user and a contract name, ID, or
-object. On success, this controller method can send the user back to where they were trying to
-go by calling the `fine_print_return` controller method (only works for GET requests).
+When the "Agree" button is clicked (and you should verify that the checkbox is actually clicked in the params passed to the server),
+you need to send the information off to a controller method that can call `FinePrint.sign_contract` which takes
+a user and a contract name, ID, or object. On success, this controller method can send the user back to where
+they were trying to go by calling the `fine_print_return` controller method (only works for GET requests).
 
 If there are multiple unsigned contracts, you are not required to get the user to sign
 them all in one page.  One strategy is to present only the first unsigned contract to them

data/lib/fine_print/controller_additions.rb

@@ -26,20 +26,20 @@ module FinePrint
         fine_print_options = options.slice(*FinePrint::SIGNATURE_OPTIONS)
 
         # Convert all names to string
-        names = args.collect{|n| n.to_s}
+        names = args.flatten.collect{|n| n.to_s}
 
         class_eval do
           before_filter(filter_options) do |controller|
-            names_to_check = names - fine_print_skipped_contract_names
+            contract_names = names - fine_print_skipped_contract_names
 
             # Bail if nothing to do
-            return true if names_to_check.blank?
+            return true if contract_names.blank?
 
             user = send FinePrint.current_user_method
             FinePrint.raise_unless_signed_in(user)
 
             unsigned_contract_names = 
-              FinePrint.get_unsigned_contract_names(names_to_check, user)
+              FinePrint.get_unsigned_contract_names(user, contract_names)
             return true if unsigned_contract_names.empty?
 
             # http://stackoverflow.com/a/2165727/1664216
@@ -54,7 +54,9 @@ module FinePrint
       # See the README
       def fine_print_skip_signatures(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        names = args.collect{|arg| arg.to_s}
+
+        # Convert all names to string
+        names = args.flatten.collect{|n| n.to_s}
 
         class_eval do
           prepend_before_filter(options) do |controller|

data/lib/fine_print/controller_additions.rb~

@@ -14,7 +14,7 @@ module FinePrint
 
     # See the README
     def fine_print_return
-      redirect_to root_path
+      redirect_to session.delete(:fine_print_return_to) || root_path
     end
 
     module ClassMethods
@@ -26,20 +26,20 @@ module FinePrint
         fine_print_options = options.slice(*FinePrint::SIGNATURE_OPTIONS)
 
         # Convert all names to string
-        names = args.collect{|n| n.to_s}
+        names = args.flatten.collect{|n| n.to_s}
 
         class_eval do
           before_filter(filter_options) do |controller|
-            names_to_check = names - fine_print_skipped_contract_names
+            contract_names = names - fine_print_skipped_contract_names
 
             # Bail if nothing to do
-            return true if names_to_check.blank?
+            return true if contract_names.blank?
 
             user = send FinePrint.current_user_method
             FinePrint.raise_unless_signed_in(user)
 
             unsigned_contract_names = 
-              FinePrint.get_unsigned_contract_names(names_to_check, user)
+              FinePrint.get_unsigned_contract_names(user, contract_names)
             return true if unsigned_contract_names.empty?
 
             # http://stackoverflow.com/a/2165727/1664216
@@ -54,7 +54,7 @@ module FinePrint
       # See the README
       def fine_print_skip_signatures(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        names = args.collect{|arg| arg.to_s}
+        names = args.flatten.collect{|n| n.to_s}
 
         class_eval do
           prepend_before_filter(options) do |controller|

data/lib/fine_print/version.rb

@@ -1,3 +1,3 @@
 module FinePrint
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/fine_print/version.rb~

@@ -0,0 +1,3 @@
+module FinePrint
+  VERSION = '1.0.0'
+end

data/lib/fine_print.rb

@@ -29,6 +29,7 @@ module FinePrint
 
   # Gets a contract given either the contract's object, ID or name
   # If given a name, it returns the latest published version of that contract
+  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
   #
   def self.get_contract(reference)
     ref = Integer(reference) rescue reference
@@ -42,30 +43,11 @@ module FinePrint
     end
   end
 
-  # Returns an array of names for the contracts whose latest published
-  # version the given user has not signed.
-  #   - names -- an array of contract names
+  # Records that the given user has signed the given contract
   #   - user -- the user in question
+  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
   #
-  def self.get_unsigned_contract_names(names, user)
-    raise_unless_signed_in(user)
-    return [] if names.blank?
-    names_array = names.is_a?(Array) ? names.collect{|name| name.to_s} : [names.to_s]
-
-    signed_contracts = Contract
-      .joins(:signatures)
-      .where({:name => names_array,
-              :fine_print_signatures => {:user_id => user.id,
-                              :user_type => user.class.name}}).latest
-    signed_contract_names = signed_contracts.collect{|c| c.name}
-
-    return names - signed_contract_names
-  end
-
-  # Records that the given user has signed the given contract; the contract
-  # can be a Contract object, a contract ID, or a contract name (string)
-  #
-  def self.sign_contract(contract, user)
+  def self.sign_contract(user, contract)
     raise_unless_signed_in(user)
     contract = get_contract(contract)
     raise IllegalState, 'Contract not found' if contract.nil?
@@ -76,10 +58,11 @@ module FinePrint
     end
   end
 
-  # Returns true iff the given user has signed the given contract; the contract
-  # can be a Contract object, a contract ID, or a contract name (string)
+  # Returns true iff the given user has signed the given contract
+  #   - user -- the user in question
+  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
   #
-  def self.signed_contract?(contract, user)
+  def self.signed_contract?(user, contract)
     raise_unless_signed_in(user)
     contract = get_contract(contract)
 
@@ -87,9 +70,10 @@ module FinePrint
                                :user_type => user.class.name).first.nil?
   end
 
-  # Returns true iff the given user has signed any version of the given contract.
+  # Returns true iff the given user has signed any version of the given contract
+  #   - user -- the user in question
   #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
-  def self.signed_any_contract_version?(contract, user)
+  def self.signed_any_contract_version?(user, contract)
     raise_unless_signed_in(user)
     contract = get_contract(contract)
     !Signature.joins(:contract)
@@ -98,6 +82,26 @@ module FinePrint
                      :user_id => user.id).first.nil?
   end
 
+  # Returns an array of names for the contracts whose latest published
+  # version the given user has not signed.
+  #   - user -- the user in question
+  #   - names -- contract names to check
+  #
+  def self.get_unsigned_contract_names(user, *names)
+    raise_unless_signed_in(user)
+    names = names.flatten.collect{|name| name.to_s}
+    return [] if names.blank?
+
+    signed_contracts = Contract
+      .joins(:signatures)
+      .where({:name => names,
+              :fine_print_signatures => {:user_id => user.id,
+                                         :user_type => user.class.name}}).latest
+    signed_contract_names = signed_contracts.collect{|c| c.name}
+
+    return names - signed_contract_names
+  end
+
   def self.is_signed_in?(user)
     user_signed_in_proc.call(user)
   end

data/lib/fine_print.rb~

@@ -29,6 +29,7 @@ module FinePrint
 
   # Gets a contract given either the contract's object, ID or name
   # If given a name, it returns the latest published version of that contract
+  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
   #
   def self.get_contract(reference)
     ref = Integer(reference) rescue reference
@@ -42,44 +43,26 @@ module FinePrint
     end
   end
 
-  # Returns an array of names for the contracts whose latest published
-  # version the given user has not signed.
-  #   - names -- an array of contract names
+  # Records that the given user has signed the given contract
   #   - user -- the user in question
+  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
   #
-  def self.get_unsigned_contract_names(names, user)
-    raise_unless_signed_in(user)
-    return [] if names.blank?
-    names_array = names.is_a?(Array) ? names.collect{|name| name.to_s} : [names.to_s]
-
-    signed_contracts = Contract
-      .joins(:signatures)
-      .where({:name => names_array,
-              :fine_print_signatures => {:user_id => user.id,
-                              :user_type => user.class.name}}).latest
-    signed_contract_names = signed_contracts.collect{|c| c.name}
-
-    return names - signed_contract_names
-  end
-
-  # Records that the given user has signed the given contract; the contract
-  # can be a Contract object, a contract ID, or a contract name (string)
-  #
-  def self.sign_contract(contract, user)
+  def self.sign_contract(user, contract)
     raise_unless_signed_in(user)
     contract = get_contract(contract)
     raise IllegalState, 'Contract not found' if contract.nil?
 
-    sig = Signature.create do |signature|
+    Signature.create do |signature|
       signature.user = user
       signature.contract = contract
     end
   end
 
-  # Returns true iff the given user has signed the given contract; the contract
-  # can be a Contract object, a contract ID, or a contract name (string)
+  # Returns true iff the given user has signed the given contract
+  #   - user -- the user in question
+  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
   #
-  def self.signed_contract?(contract, user)
+  def self.signed_contract?(user, contract)
     raise_unless_signed_in(user)
     contract = get_contract(contract)
 
@@ -87,9 +70,10 @@ module FinePrint
                                :user_type => user.class.name).first.nil?
   end
 
-  # Returns true iff the given user has signed any version of the given contract.
+  # Returns true iff the given user has signed any version of the given contract
+  #   - user -- the user in question
   #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
-  def self.signed_any_contract_version?(contract, user)
+  def self.signed_any_contract_version?(user, contract)
     raise_unless_signed_in(user)
     contract = get_contract(contract)
     !Signature.joins(:contract)

data/spec/dummy/log/development.log

@@ -1674,3 +1674,74 @@ Connecting to database specified by database.yml
    (4.2ms)  CREATE INDEX "index_fine_print_signatures_on_contract_id" ON "fine_print_signatures" ("contract_id")
    (4.6ms)  CREATE UNIQUE INDEX "index_fine_print_s_on_u_id_and_u_type_and_c_id" ON "fine_print_signatures" ("user_id", "user_type", "contract_id")
    (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+   (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (22.6ms)  DROP TABLE "dummy_users"
+   (5.2ms)  CREATE TABLE "dummy_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "is_admin" boolean DEFAULT 'f' NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.5ms)  DROP TABLE "fine_print_contracts"
+   (4.5ms)  CREATE TABLE "fine_print_contracts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL, "version" integer, "title" varchar(255) NOT NULL, "content" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.5ms)  CREATE UNIQUE INDEX "index_fine_print_contracts_on_name_and_version" ON "fine_print_contracts" ("name", "version")
+   (5.6ms)  DROP TABLE "fine_print_signatures"
+   (5.1ms)  CREATE TABLE "fine_print_signatures" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "contract_id" integer NOT NULL, "user_id" integer NOT NULL, "user_type" varchar(255) NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.0ms)  CREATE INDEX "index_fine_print_signatures_on_contract_id" ON "fine_print_signatures" ("contract_id")
+   (4.6ms)  CREATE UNIQUE INDEX "index_fine_print_s_on_u_id_and_u_type_and_c_id" ON "fine_print_signatures" ("user_id", "user_type", "contract_id")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (16.3ms)  DROP TABLE "dummy_users"
+   (5.9ms)  CREATE TABLE "dummy_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "is_admin" boolean DEFAULT 'f' NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.6ms)  DROP TABLE "fine_print_contracts"
+   (4.4ms)  CREATE TABLE "fine_print_contracts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL, "version" integer, "title" varchar(255) NOT NULL, "content" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.6ms)  CREATE UNIQUE INDEX "index_fine_print_contracts_on_name_and_version" ON "fine_print_contracts" ("name", "version")
+   (4.8ms)  DROP TABLE "fine_print_signatures"
+   (4.7ms)  CREATE TABLE "fine_print_signatures" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "contract_id" integer NOT NULL, "user_id" integer NOT NULL, "user_type" varchar(255) NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.5ms)  CREATE INDEX "index_fine_print_signatures_on_contract_id" ON "fine_print_signatures" ("contract_id")
+   (4.4ms)  CREATE UNIQUE INDEX "index_fine_print_s_on_u_id_and_u_type_and_c_id" ON "fine_print_signatures" ("user_id", "user_type", "contract_id")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (14.4ms)  DROP TABLE "dummy_users"
+   (5.8ms)  CREATE TABLE "dummy_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "is_admin" boolean DEFAULT 'f' NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.2ms)  DROP TABLE "fine_print_contracts"
+   (5.4ms)  CREATE TABLE "fine_print_contracts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL, "version" integer, "title" varchar(255) NOT NULL, "content" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.9ms)  CREATE UNIQUE INDEX "index_fine_print_contracts_on_name_and_version" ON "fine_print_contracts" ("name", "version")
+   (5.5ms)  DROP TABLE "fine_print_signatures"
+   (5.1ms)  CREATE TABLE "fine_print_signatures" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "contract_id" integer NOT NULL, "user_id" integer NOT NULL, "user_type" varchar(255) NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.4ms)  CREATE INDEX "index_fine_print_signatures_on_contract_id" ON "fine_print_signatures" ("contract_id")
+   (4.9ms)  CREATE UNIQUE INDEX "index_fine_print_s_on_u_id_and_u_type_and_c_id" ON "fine_print_signatures" ("user_id", "user_type", "contract_id")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  select sqlite_version(*)
+   (13.7ms)  DROP TABLE "dummy_users"
+   (5.2ms)  CREATE TABLE "dummy_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "is_admin" boolean DEFAULT 'f' NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.2ms)  DROP TABLE "fine_print_contracts"
+   (5.2ms)  CREATE TABLE "fine_print_contracts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL, "version" integer, "title" varchar(255) NOT NULL, "content" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.3ms)  CREATE UNIQUE INDEX "index_fine_print_contracts_on_name_and_version" ON "fine_print_contracts" ("name", "version")
+   (5.5ms)  DROP TABLE "fine_print_signatures"
+   (5.8ms)  CREATE TABLE "fine_print_signatures" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "contract_id" integer NOT NULL, "user_id" integer NOT NULL, "user_type" varchar(255) NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.3ms)  CREATE INDEX "index_fine_print_signatures_on_contract_id" ON "fine_print_signatures" ("contract_id")
+   (4.8ms)  CREATE UNIQUE INDEX "index_fine_print_s_on_u_id_and_u_type_and_c_id" ON "fine_print_signatures" ("user_id", "user_type", "contract_id")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+Connecting to database specified by database.yml
+   (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (11.9ms)  DROP TABLE "dummy_users"
+   (4.6ms)  CREATE TABLE "dummy_users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "is_admin" boolean DEFAULT 'f' NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (5.2ms)  DROP TABLE "fine_print_contracts"
+   (4.6ms)  CREATE TABLE "fine_print_contracts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL, "version" integer, "title" varchar(255) NOT NULL, "content" text NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.4ms)  CREATE UNIQUE INDEX "index_fine_print_contracts_on_name_and_version" ON "fine_print_contracts" ("name", "version")
+   (5.2ms)  DROP TABLE "fine_print_signatures"
+   (4.7ms)  CREATE TABLE "fine_print_signatures" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "contract_id" integer NOT NULL, "user_id" integer NOT NULL, "user_type" varchar(255) NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (4.4ms)  CREATE INDEX "index_fine_print_signatures_on_contract_id" ON "fine_print_signatures" ("contract_id")
+   (4.5ms)  CREATE UNIQUE INDEX "index_fine_print_s_on_u_id_and_u_type_and_c_id" ON "fine_print_signatures" ("user_id", "user_type", "contract_id")
+   (0.1ms)  SELECT version FROM "schema_migrations"