module FinePrint

config() click to toggle source

# File lib/fine_print.rb, line 9
def self.config
  @config ||= Configuration.new
end

configure() { |config| ... } click to toggle source

# File lib/fine_print.rb, line 13
def self.configure
  yield config
end

get_contract(reference) click to toggle source

Gets a contract, given either the contract object, ID or name If given a name, returns the latest published version of that contract

- contract - can be a Contract object, its ID, or its name

# File lib/fine_print.rb, line 20
def self.get_contract(reference)
  return reference if reference.is_a? Contract
  num = Integer(reference) rescue nil
  return Contract.find(num) if num
  contract = Contract.where(name: reference.to_s).published.first
  return contract if contract
  raise ActiveRecord::RecordNotFound, "Couldn't find Contract with 'name'=#{reference.to_s}"
end

latest_published_contracts(conditions = {}) click to toggle source

Returns all the latest published contracts that match the given conditions.

# File lib/fine_print.rb, line 80
def self.latest_published_contracts(conditions = {})
  Contract.published.latest.where(conditions)
end

sign_contract(user, contract, is_implicit = SIGNATURE_IS_EXPLICIT, max_attempts = 3) click to toggle source

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 (String/Symbol)
- is_implicit - if true, the signature is implicit/assumed/indirectly-acquired
                if false, the signature was obtained directly from the user

# File lib/fine_print.rb, line 34
def self.sign_contract(user, contract, is_implicit = SIGNATURE_IS_EXPLICIT, max_attempts = 3)
  attempts = 0

  begin
    Signature.transaction(requires_new: true) do
      contract = get_contract(contract)

      Signature.create do |signature|
        signature.user = user
        signature.contract = contract
        signature.is_implicit = is_implicit
      end
    end
  rescue ActiveRecord::RecordNotUnique => exception
    attempts += 1
    raise exception if attempts >= max_attempts

    # Simply retry as in https://apidock.com/rails/v4.0.2/ActiveRecord/Relation/find_or_create_by
    # If it already exists, the validations should catch it this time
    retry
  end
end

signed_any_version_of_contract?(user, contract) click to toggle source

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 (String/Symbol)

# File lib/fine_print.rb, line 71
def self.signed_any_version_of_contract?(user, contract)
  return false if user.nil?

  contract = get_contract(contract)

  contract.same_name.signed_by(user).exists?
end

signed_contract?(user, contract) click to toggle source

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 (String/Symbol)

# File lib/fine_print.rb, line 60
def self.signed_contract?(user, contract)
  return false if user.nil?

  contract = get_contract(contract)

  contract.signed_by?(user)
end

signed_contracts_for(user, conditions = {}) click to toggle source

Returns all contracts matching the given conditions whose latest published version the user has signed.

- user - the user in question
- conditions - filters the list of contracts to check

If no conditions are provided, all latest contracts are checked.

# File lib/fine_print.rb, line 89
def self.signed_contracts_for(user, conditions = {})
  return [] if user.nil?

  latest_published_contracts(conditions).signed_by(user)
end

unsigned_contracts_for(user, conditions = {}) click to toggle source

Returns all contracts matching the given conditions whose latest published version the user has not signed.

- user - the user in question
- conditions - filters the list of contracts to check

If no conditions are provided, all latest contracts are checked.

# File lib/fine_print.rb, line 100
def self.unsigned_contracts_for(user, conditions = {})
  contracts = latest_published_contracts(conditions)
  signed_contracts = signed_contracts_for(user, conditions)
  contracts - signed_contracts
end

Constants

Public Class Methods