radiant-reader-extension 0.9.2

data/app/models/message_function.rb

@@ -0,0 +1,37 @@
+class MessageFunction
+  attr_accessor :name, :description
+  
+  def initialize(name, description='')
+    @name = name
+    @description = description
+  end
+  
+  def symbol
+    @name.to_s.downcase.intern
+  end
+  
+  def to_s
+    @name
+  end
+  
+  def self.[](value)
+    return if value.blank?
+    @@functions.find { |function| function.symbol == value.to_s.downcase.intern }
+  end
+    
+  def self.add(name, description='')
+    @@functions.push(MessageFunction.new(name, description)) unless MessageFunction[name]
+  end
+
+  def self.find_all
+    @@functions.dup
+  end
+  
+  @@functions = [
+    MessageFunction.new('welcome', 'Welcome'),
+    MessageFunction.new('invitation', 'Invitation' ),
+    MessageFunction.new('password_reset', 'Password instructions'),
+    MessageFunction.new('activation', 'Activation instructions')
+  ]
+
+end

data/app/models/message_reader.rb

@@ -0,0 +1,13 @@
+class MessageReader < ActiveRecord::Base
+  belongs_to :message
+  belongs_to :reader
+  
+  named_scope :undelivered, {
+    :conditions => "sent_at IS NULL OR sent_at > NOW()"
+  }
+
+  named_scope :delivered, {
+    :conditions => "sent_at IS NOT NULL and sent_at <= NOW()"
+  }
+
+end

data/app/models/reader.rb

@@ -0,0 +1,146 @@
+require 'authlogic'
+require 'digest/sha1'
+require 'gravtastic'
+
+class Reader < ActiveRecord::Base
+  @@user_columns = [:name, :email, :login, :created_at, :password, :notes]
+  cattr_accessor :user_columns
+  cattr_accessor :current
+  default_scope :order => 'name ASC'
+
+  is_site_scoped if respond_to? :is_site_scoped
+
+  is_gravtastic :with => :email, :rating => 'PG', :size => 48
+  acts_as_authentic do |config|
+    config.validations_scope = :site_id if defined? Site
+    config.transition_from_restful_authentication = true
+    config.validate_email_field = false
+    config.validate_login_field = false
+  end
+
+  belongs_to :user
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+
+  has_many :message_readers
+  has_many :messages, :through => :message_readers
+
+  attr_accessor :current_password   # used for authentication on update
+
+  before_save :set_login
+  before_update :update_user
+
+  validates_presence_of :name, :email, :message => 'is required'
+  validates_uniqueness_of :login, :message => "is already in use here"
+  validate :email_must_not_be_in_use
+
+  include RFC822
+  validates_format_of :email, :with => RFC822_valid, :message => 'appears not to be an email address'
+  validates_length_of :name, :maximum => 100, :allow_nil => true
+
+  named_scope :any
+  named_scope :active, :conditions => "activated_at IS NOT NULL"
+  named_scope :inactive, :conditions => "activated_at IS NULL"
+
+  def forename
+    read_attribute(:forename) || name.split(/\s/).first
+  end
+
+  def activate!
+    self.activated_at = Time.now.utc
+    self.save!
+    self.send_welcome_message
+  end
+
+  def activated?
+    !inactive?
+  end
+
+  def inactive?
+    self.activated_at.nil?
+  end
+
+  def disable_perishable_token_maintenance?
+    inactive? && !new_record?
+  end
+
+  [:activation, :invitation, :welcome, :password_reset].each do |function|
+    define_method("send_#{function}_message".intern) {
+      send_functional_message(function)
+    }
+  end
+
+  def send_functional_message(function)
+    reset_perishable_token!
+    message = Message.functional(function)
+    raise StandardError, "No #{function} message could be found" unless message
+    message.deliver_to(self)
+  end
+
+  def generate_email_field_name
+    generate_password(32)
+  end
+
+  def generate_password(length=12)
+    chars = ("a".."z").to_a + ("A".."Z").to_a + ("1".."9").to_a
+    Array.new(length, '').collect{chars[rand(chars.size)]}.join
+  end
+
+  def is_user?
+    self.user ? true : false
+  end
+
+  def is_admin?
+    self.user && self.user.admin? ? true : false
+  end
+
+  def self.find_or_create_for_user(user)
+    if user.respond_to?(:site) && site = Page.current_site
+      reader = self.find_or_create_by_site_id_and_user_id(site.id, user.id)
+    else
+      reader = self.find_or_create_by_user_id(user.id)
+    end
+    if reader.new_record?
+      user_columns.each { |att| reader.send("#{att.to_s}=", user.send(att)) }
+      reader.crypted_password = user.password
+      reader.password_salt = user.salt
+      reader.activated_at = reader.created_at
+      reader.save(false)
+    end
+    reader
+  end
+
+  protected
+
+    def set_login
+      self.login = self.email if self.login.blank?
+    end
+
+  private
+
+    def email_must_not_be_in_use
+      reader = Reader.find_by_email(self.email)   # the finds will be site-scoped if appropriate
+      user = User.find_by_email(self.email)
+      if user && user != self.user
+        errors.add(:email, "belongs to an author here")
+      elsif reader && reader != self
+        errors.add(:email, "is already registered here")
+      else
+        return true
+      end
+      return false
+    end
+
+    def validate_length_of_password?
+      new_record? or not password.to_s.empty?
+    end
+
+    def update_user
+      if self.user
+        user_columns.each { |att| self.user.send("#{att.to_s}=", send(att)) if send("#{att.to_s}_changed?") }
+        self.user.password_confirmation = password_confirmation if password_changed?
+        self.user.save! if self.user.changed?
+      end
+    end
+
+end

data/app/models/reader_notifier.rb

@@ -0,0 +1,34 @@
+class ReaderNotifier < ActionMailer::Base
+
+  # this sets a default that will be overridden by the layout association of each message as it is sent out
+  radiant_layout "email"
+  
+  def message(reader, message, sender=nil)
+    site = reader.site if reader.respond_to?(:site)
+    prefix = site ? site.abbreviation : Radiant::Config['site.mail_prefix']
+    host = site ? site.base_domain : Radiant::Config['site.url'] || 'www.example.com'
+    default_url_options[:host] = host
+    sender ||= message.created_by
+
+    message_layout(message.layout) if message.layout
+    content_type("text/html")
+    subject (prefix || '') + message.subject
+    recipients(reader.email)
+    from message.created_by.email
+    subject message.subject
+    sent_on(Time.now)
+
+    body({
+      :host => host,
+      :title => message.subject,
+      :message => message.filtered_body,
+      :sender => sender,
+      :reader => reader,
+      :site => site || {
+        :name => Radiant::Config['site.name'],
+        :url => Radiant::Config['site.url']
+      }
+    })
+  end
+
+end

data/app/models/reader_session.rb

@@ -0,0 +1,3 @@
+class ReaderSession < Authlogic::Session::Base
+
+end

data/app/views/admin/messages/_form.html.haml

@@ -0,0 +1,29 @@
+= render_region :form_top
+
+.form-area
+  - render_region :form do |formpart|
+    - formpart.edit_subject do
+      %p.title
+        = form.label :subject, "Message Subject"
+        = form.text_field :subject, :class => 'textbox', :maxlength => 255
+        - if @message.new_record?
+          = form.hidden_field :function_id
+
+    - formpart.edit_body do
+      %div.body
+        %p
+          %span.filter
+            = form.label :filter_id, "Filter:"
+            = form.select :filter_id, TextFilter.descendants.map { |tf| tf.filter_name }.sort, :id => 'message_filter', :include_blank => true
+          = form.label :body, "Message Body"
+          = form.text_area :body, :class => 'textarea', :style => 'width: 100%'
+
+- render_region :form_bottom do |form_bottom|
+  - form_bottom.edit_timestamp do
+    = updated_stamp @message  
+  - form_bottom.edit_buttons do
+    %p.buttons
+      = save_model_button(@message)
+      = save_model_and_continue_editing_button(@message)
+      or
+      = link_to "cancel", admin_messages_url

data/app/views/admin/messages/_help.html.haml

@@ -0,0 +1,41 @@
+%p
+  You can use tags, snippets and assets in your messages just as you would in a page. 
+  There are also a few simple mailmerge tags that you can use to place information about the recipient (or yourself) in each message as it is sent out. 
+  Most are self-explanatory:
+%ul.help
+  %li
+    %code <r:sender:name />
+    is the name configured in 
+    %em
+      reader.mail_from_name:
+    currently 
+    %strong
+      = "'#{Radiant::Config['reader.mail_from_name']}'."
+  %li
+    %code <r:sender:email />
+    is the address configured in 
+    %em
+      reader.mail_from_address:
+    currently 
+    %strong
+    = "'#{Radiant::Config['reader.mail_from_address']}'."
+  %li
+    %code <r:recipient:name /> 
+  %li
+    %code <r:recipient:email />
+  %li
+    %code <r:recipient:login />
+  %li
+    %code <r:recipient:password /> 
+    only works in welcome messages: after first login we forget the unencrypted password
+  %li
+    %code <r:recipient:url />
+    is the address of the page about this person
+  %li
+    %code <r:recipient:edit_url /> 
+    is the address of the preferences form
+  %li
+    %code <r:recipient:activation_url />
+    is the address that will activate a newly-created account
+  %li
+    %code <r:recipient:description />

data/app/views/admin/messages/_message_description.html.haml

@@ -0,0 +1,3 @@
+- if @message.function
+  = @message.function
+message

data/app/views/admin/messages/edit.html.haml

@@ -0,0 +1,16 @@
+- include_stylesheet('admin/reader')
+
+= render_region :top 
+- render_region :main do |main|
+
+  - main.edit_header do
+    %h1 
+      Edit
+      = render :partial => 'message_description'
+
+  - main.edit_form do
+    - form_for :message, @message, :url => admin_message_url(@message), :html => {:id => 'message_form', :method => 'put'} do |f|
+      = render :partial => 'form', :object => f
+
+  - main.edit_footer do
+    = render :partial => 'help'

data/app/views/admin/messages/new.html.haml

@@ -0,0 +1,16 @@
+- include_stylesheet('admin/reader')
+
+= render_region :top 
+- render_region :main do |main|
+
+  - main.edit_header do
+    %h1
+      Create 
+      = render :partial => 'message_description'
+
+  - main.edit_form do
+    - form_for :message, @message, :url => admin_messages_url, :html => {:id => 'message_form', :method => 'post'} do |f|
+      = render :partial => 'form', :object => f
+
+  - main.edit_footer do
+    = render :partial => 'help'

data/app/views/admin/reader_settings/_setting.html.haml

@@ -0,0 +1,24 @@
+- if setting || key
+  - setting ||= Radiant::Config.find_by_key(key)
+  - if setting
+    - label ||= setting.key
+    - notes ||= nil
+    - domkey = setting.key.gsub('?', '_')
+    - containerid = "set_#{domkey}"
+
+    - if setting.key.ends_with?("?")
+      %p.ruled
+        %span{:id => containerid, :class => "checkbox #{setting.value.to_s}"}
+          = checkbox_for_setting(setting, label)
+
+    - else 
+      %p.ruled
+        %label= label
+        %span.inplace{:id => containerid}
+          = editable_setting(setting)
+    
+  - else
+    %p.haserror
+      %strong
+        = key
+      is not defined.

data/app/views/admin/reader_settings/edit.html.haml

@@ -0,0 +1,10 @@
+- domkey = @setting.key.gsub('?', '_')
+- domid = "set_#{domkey}"
+
+- remote_form_for @setting, :url => admin_reader_setting_path(@setting), :update => domid, :loading => "$('#{domid}').addClassName('waiting');", :loaded => "$('#{domid}').removeClassName('waiting');", :html => { :method => :put } do |f|
+  - if @setting.key =~ /\.layout$/
+    = f.select :value, Layout.all.collect {|l| [ l.name, l.name ] }
+  - else
+    = f.text_field :value
+  = f.submit 'save'
+  = link_to_remote 'cancel', {:url => admin_reader_setting_url(@setting.id), :method => 'get', :update => domid, :loading => "$('#{domid}').addClassName('waiting');", :loaded => "$('#{domid}').removeClassName('waiting');"}, {:class => 'cancel'}

data/app/views/admin/reader_settings/index.html.haml

@@ -0,0 +1,35 @@
+- body_classes << "reversed"
+- include_stylesheet('admin/reader')
+
+#reader_settings.box
+  %h3 Reader administration
+  
+  - render_region :settings do |settings|
+    - settings.registration do
+      = render :partial => 'setting', :locals => {:key => 'reader.allow_registration?', :label => 'Allow visitors to register'}
+      = render :partial => 'setting', :locals => {:key => 'reader.require_confirmation?', :label => 'Require email confirmation'}
+      = render :partial => 'setting', :locals => {:key => 'reader.layout', :label => "Admin layout", :notes => "The radiant layout used to present reader-administration pages"}
+
+    - settings.site do
+      = render :partial => 'setting', :locals => {:key => 'site.title', :label => "Site title", :notes => "This is the name by which forms and emails refer to your site"}
+      = render :partial => 'setting', :locals => {:key => 'site.url', :label => "Site url", :notes => "This is the address we use to build links in emails"}
+
+    - settings.sender do
+      = render :partial => 'setting', :locals => {:key => 'reader.mail_from_name', :label => "Email sender", :notes => "This is the name that automatic emails seem to come from"}
+      = render :partial => 'setting', :locals => {:key => 'reader.mail_from_address', :label => "Email address", :notes => "This is the address that automatic emails seem to come from"}
+
+#message_settings.box
+  %h3 Administrative messages
+  
+  - render_region :messages do |messages|
+    - messages.administration do
+      - MessageFunction.find_all.each do |func|
+        - message = Message.for_function(func).shift
+        %p.ruled
+          %label= func.description
+          - if message
+            = link_to message.subject, edit_admin_message_url(message)
+          - else
+            = link_to image('plus') + " create message", new_admin_message_url(:function => func), :class => 'create'
+
+

data/app/views/admin/reader_settings/show.html.haml

@@ -0,0 +1 @@
+= editable_setting(@setting)

data/app/views/admin/readers/_avatar.html.haml

@@ -0,0 +1,3 @@
+#avatar
+  = image_tag(gravatar_url(@reader.email, :size=>"96px"), :class=>"avatar", :width=>96, :height=>96, :alt=>"")
+  %p.caption Avatar provided by Gravatar.com

data/app/views/admin/readers/_form.html.haml

@@ -0,0 +1,50 @@
+- form_for [:admin, @reader] do |f|
+  = hidden_field "reader", "lock_version"
+  
+  = render :partial => 'avatar' unless @reader.new_record?
+  
+  = render_region :form_top, :locals => {:f => f}
+  
+  - render_region :form, :locals => {:f => f} do |form|
+    - form.edit_name do
+      %p
+        = f.label :name, t('name') 
+        = f.text_field :name, :class => "textbox activate", :size => 32, :maxlength => 100 
+    
+    - form.edit_email do
+      %p
+        = f.label :email, t('email_address') , :class => "optional"
+        = f.text_field "email", :class => 'textbox', :size => 32, :maxlength => 255
+
+    - form.edit_username do
+      %p
+        = f.label :login, t('username') , :class => "optional"
+        = f.text_field "login", :class => 'textbox', :size => 32, :maxlength => 255
+    
+    - form.edit_readername do
+      %p
+        = f.label :login, t('readername') 
+        = f.text_field "login", :class => "textbox", :size => 32, :maxlength => 40 
+    
+    - form.edit_password do
+      = render "password_fields", :f => f
+    
+    - form.edit_description do
+      %p
+        = f.label :description, "Self-description", :class => "optional"
+        ~ f.text_area "description", :size => "53x8", :class => "textarea"
+
+    - form.edit_notes do
+      %p
+        = f.label :notes, t('notes'), :class => "optional"
+        ~ f.text_area "notes", :size => "53x4", :class => "textarea"
+  
+  - render_region :form_bottom, :locals => {:f => f} do |form_bottom|
+    - form_bottom.edit_buttons do
+      %p.buttons
+        = save_model_button(@reader)
+        = save_model_and_continue_editing_button(@reader)
+        = t('or')   
+        = link_to t('cancel'), admin_readers_path
+    - form_bottom.edit_timestamp do
+      = updated_stamp @reader