radiant-reader-extension 0.9.2 → 1.0.0

data/README.md

@@ -10,21 +10,18 @@ The purpose of this extension is to provide a common core that supports other vi
 
 ## Latest
 
+* **currently requires the `preconfiguration` branch of radiant**
+* public interface internationalized
 * New configuration interface
-
-* Provisionally updated for 0.9, but still being tweaked and tested: not definitely stable yet
-
-* I'm about to start cleaning out the messaging interface. Some of its extra clutter will be moved into a newsletter extension so that here we can concentrate on making administrative messages easy to edit.
+* Messaging much simplified: now intended to be purely administrative.
 
 ## Status
 
-Compatible with radiant 0.9 but currently undergoing some renovation.
-
-Tests are thorough. A lot of our work relies on this extension.
+Compatible with radiant 0.9.2, which isn't out yet. You can use the preconfiguration branch of radiant edge to try this out. Expect changes.
 
 ## Requirements
 
-Radiant 0.8.1 (we need the new config machinery) or 0.9. [share_layouts](http://github.com/spanner/radiant-share-layouts-extension) (currently you need our version, which works with ActionMailer too). If you're on 0.8.1 you will probably want the  [submenu](https://github.com/spanner/radiant-submenu-extension/tree) extension too.
+Radiant 0.9.2. The [layouts](http://github.com/squaretalent/radiant-layouts-extension) and [mailer_layouts](http://github.com/spanner/radiant-mailer_layouts-extension) extensions.
 
 You also need three gems (in addition to those that radiant requires): authlogic, gravtastic and sanitize. They're declared in the extension so you should be able just to run
 
@@ -38,15 +35,22 @@ in your environment.rb before you can migrate anything. Authlogic has to load be
 
 ## Installation
 
+As a gem:
+
+	gem install 'radiant_reader_extension'
+	
+or for more control:
+
 	git submodule add git://github.com/spanner/radiant-reader-extension.git vendor/extensions/reader
+
+and then:
+
 	rake radiant:extensions:reader:migrate
 	rake radiant:extensions:reader:update
 
-The update task will install a /stylesheets/admin/reader.css that you can leave alone and a /stylesheets/reader.css that you should call from your reader layout (see below) and will want to improve upon. There is also a very thin /javascripts/reader.js: all it does is fade notifications. The forum extension has a lot more javascripts for you to deplore.
-
 ## Configuration
 
-If you want to allow public registration, set `reader.allow_registration?` to true in your configuration. If it is false, then reader accounts can only be created by the administrator.
+If you want to allow public registration, set `reader.allow_registration?` to true. If it is false, then reader accounts can only be created by the administrator.
 
 Under multi_site Reader adds a `reader_layout` column to the site table and a layout-chooser to the site-edit view. In a single-site installation you will also need these configuration entries:
 

data/VERSION

@@ -1 +1 @@
-0.9.2
+1.0.0

data/app/controllers/admin/messages_controller.rb

@@ -1,20 +1,59 @@
 class Admin::MessagesController < Admin::ResourceController
+  skip_before_filter :load_model
+  before_filter :load_model, :except => :index    # we want the filter to run before :show too
   before_filter :set_function, :only => :new
-  
-  def index
-    redirect_to admin_reader_settings_url
+
+  # here :show is the preview/send page
+  def show
+    
   end
   
+  # mock email view called into an iframe in the :show view
+  # the view calls @message.preview, which returns the message body
+  def preview
+    render :layout => false
+  end
+
+  def deliver
+    case params['delivery']
+    when "all"
+      @readers = @message.possible_readers
+    when "inactive"
+      @readers = @message.inactive_readers
+    when "unsent"
+      @readers = @message.undelivered_readers
+    else
+      redirect_to admin_message_url(@message)
+      return
+    end
+    failures = @message.deliver(@readers) || []
+    if failures.any?
+      if failures.length == @readers.length
+        flash[:error] = "all_deliveries_failed"
+      else
+        addresses = failures.map(&:email).to_sentence
+        flash[:notice] = "some_deliveries_failed"
+      end
+    else
+      flash[:notice] = "message_delivered"
+    end
+    redirect_to admin_message_url(@message)
+  end
+
 protected
 
   def continue_url(options)
-    admin_reader_settings_url
+    if action_name == "destroy"
+      redirect_to :back
+    else
+      options[:redirect_to] || (params[:continue] ? {:action => 'edit', :id => model.id} : admin_message_url(model))
+    end
   end
 
   def set_function
     if params[:function]
-      @message.function_id = params[:function]
+      model.function_id = params[:function]
     end
   end
-
+  
 end

data/app/controllers/admin/reader_configuration_controller.rb

@@ -0,0 +1,3 @@
+class Admin::ReaderConfigurationController < Admin::ConfigurationController
+
+end

data/app/controllers/password_resets_controller.rb

@@ -15,24 +15,22 @@ class PasswordResetsController < ApplicationController
     if @reader
       if @reader.activated?
         @reader.send_password_reset_message
-        flash[:notice] = "Password reset instructions have been emailed to you."
+        flash[:notice] = "reset_message_sent"
         render
       else
         @reader.send_activation_message
-        flash[:notice] = "Account activation instructions have been emailed to you."
+        flash[:notice] = "activation_message_sent"
         redirect_to new_reader_activation_url
       end
     else  
-      @error = flash[:error] = "Sorry. That email address is not known here."  
+      @error = flash[:error] = "email_unknown"
       render :action => :new  
     end  
   end
 
   def edit  
-    if @reader
-      flash[:notice] = "Thank you. Please enter and confirm a new password."
-    else
-      flash[:error] = "Sorry: can't find you."
+    unless @reader
+      flash[:error] = 'reset_not_found'
     end
     render
   end  
@@ -43,14 +41,14 @@ class PasswordResetsController < ApplicationController
       @reader.password_confirmation = params[:reader][:password_confirmation]
       if @reader.save 
         self.current_reader = @reader
-        flash[:notice] = "Thank you. Your password has been updated and you are now logged in."
+        flash[:notice] = 'password_updated_notice'
         redirect_to url_for(@reader)
       else
-        flash[:error] = "Passwords don't match! Please try again."
+        flash[:error] = 'password_mismatch'
         render :action => :edit 
       end  
     else
-      flash[:error] = "Sorry: can't find you."
+      flash[:error] = 'reset_not_found'
       render :action => :edit     # without @reader, this will take us back to the enter-your-code form
     end
   end  

data/app/controllers/reader_action_controller.rb

@@ -25,7 +25,7 @@ class ReaderActionController < ApplicationController
 
   def permission_denied
     session[:return_to] ||= request.referer
-    @title = flash[:error] || "Sorry: permission denied"
+    @title = flash[:error] || t('permission_denied')
     render
   end
 
@@ -75,7 +75,7 @@ protected
   def require_no_reader
     if set_reader
       store_location
-      flash[:notice] = "Please log out first"
+      flash[:notice] = 'please_log_out'
       redirect_back_or_to url_for(current_reader)
       return false
     end

data/app/controllers/reader_activations_controller.rb

@@ -7,7 +7,7 @@ class ReaderActivationsController < ReaderActionController
   
   radiant_layout { |controller| Radiant::Config['reader.layout'] }
 
-  # this is just fake REST: we're actually working on the reader, not an activation object, but in a usefully restricted way:
+  # this is just fake REST: we're actually working on the reader, not an activation object.
   # .show sends out an activation message if we can identify the current reader
   # .update activates the reader, if the token is correct
 
@@ -19,7 +19,7 @@ class ReaderActivationsController < ReaderActionController
     if current_reader
       @reader = current_reader
       @reader.send_activation_message
-      flash[:notice] = "Account activation instructions have been emailed to you."
+      flash[:notice] = "activation_message_sent"
     end
     render :action => 'show'
   end
@@ -28,12 +28,11 @@ class ReaderActivationsController < ReaderActionController
     if @reader
       @reader.activate!
       self.current_reader = @reader
-      flash[:notice] = "Thank you! Your account has been activated."
+      flash[:notice] = "thanks_activated"
       redirect_back_or_to default_activated_url
-      
     else
-      @error = "Sorry: something was wrong in that link. Please check your email message."
-      flash[:error] = "Activation failed."
+      @error = "please_check_message"
+      flash[:error] = "activation_failed."
       render :action => 'show'
     end
   end
@@ -47,7 +46,7 @@ protected
 
   def check_reader_inactive
     if @reader && @reader.activated?
-      flash[:notice] = "Hello #{@reader.name}! Your account is already active."
+      flash[:notice] = t('hello').titlecase + " #{@reader.name}! " + t('already_active')
       redirect_back_or_to default_activated_url
       false
     end

data/app/controllers/reader_sessions_controller.rb

@@ -16,7 +16,7 @@ class ReaderSessionsController < ReaderActionController
       end
       respond_to do |format|
         format.html {
-          flash[:notice] = "Hello #{@reader_session.reader.name}. Welcome back."
+          flash[:notice] = t('hello').titlecase + " #{@reader_session.reader.name}. " + t('welcome_back')
           redirect_back_or_to default_loggedin_url
         }
         format.js { 
@@ -27,7 +27,7 @@ class ReaderSessionsController < ReaderActionController
     else
       respond_to do |format|
         format.html { 
-          flash[:error] = "Sorry: that combination of login and password is not known here."
+          flash[:error] = 'login_unknown'
           render :action => :new 
         }
         format.js { render :action => :new, :layout => false }
@@ -43,7 +43,7 @@ class ReaderSessionsController < ReaderActionController
       session['user_id'] = nil
       current_user = nil
     end
-    flash[:notice] = "You are logged out. Bye!"
+    flash[:notice] = 'logout_message'
     redirect_back_or_to reader_login_url
   end
   

data/app/controllers/readers_controller.rb

@@ -29,7 +29,6 @@ class ReadersController < ReaderActionController
         render :partial => 'readers/controls'
       }
     end
-    
   end
 
   def new
@@ -50,14 +49,14 @@ class ReadersController < ReaderActionController
     @reader.clear_password = params[:reader][:password]
 
     unless @reader.email.blank?
-      flash[:error] = "Please don't fill in the spam trap field."
+      flash[:error] = 'please_avoid_spam_trap'
       @reader.email = ''
-      @reader.errors.add(:trap, "must be empty")
+      @reader.errors.add(:trap, "must_be_empty")
       render :action => 'new' and return
     end
 
     unless @email_field = session[:email_field]
-      flash[:error] = "Please use the registration form."
+      flash[:error] = 'please_use_form'
       redirect_to new_reader_url and return
     end
 
@@ -76,7 +75,7 @@ class ReadersController < ReaderActionController
     @reader.attributes = params[:reader]
     @reader.clear_password = params[:reader][:password] if params[:reader][:password]
     if @reader.save
-      flash[:notice] = "Your account has been updated"
+      flash[:notice] = 'account_updated'
       redirect_to url_for(@reader)
     else
       render :action => 'edit'
@@ -90,7 +89,7 @@ protected
   end
 
   def restrict_to_self
-    flash[:error] = "Sorry. You are not allowed to edit other people's accounts." if params[:id] && params[:id] != current_reader.id
+    flash[:error] = "cannot_edit_others" if params[:id] && params[:id] != current_reader.id
     @reader = current_reader
   end
   
@@ -101,19 +100,19 @@ protected
     @reader.attributes = params[:reader]
     @reader.valid?
     
-    flash[:error] = 'Sorry. Wrong password.'
-    @reader.errors.add(:current_password, "was not correct")
+    flash[:error] = 'password_incorrect'
+    @reader.errors.add(:current_password, "not_correct")
     render :action => 'edit' and return false
   end
   
   def no_removing
-    flash[:error] = "You can't delete readers here. Please log in to the admin interface."
+    flash[:error] = 'cannot_delete_readers'
     redirect_to admin_readers_url
   end
   
   def check_registration_allowed
     unless Radiant::Config['reader.allow_registration?']
-      flash[:error] = "Sorry. This site does not allow public registration."
+      flash[:error] = "registration_disallowed"
       redirect_to reader_login_url
       false
     end

data/app/models/message.rb

@@ -19,8 +19,8 @@ class Message < ActiveRecord::Base
 
   default_scope :order => 'updated_at DESC, created_at DESC'
   named_scope :for_function, lambda { |f| {:conditions => ["function_id = ?", f.to_s]} }
-  named_scope :administrative, { :conditions => "function_id IS NOT NULL" }
-  named_scope :ordinary, { :conditions => "function_id IS NULL" }
+  named_scope :administrative, { :conditions => "function_id IS NOT NULL AND NOT function_id = ''" }
+  named_scope :ordinary, { :conditions => "function_id = '' OR function_id IS NULL" }
   named_scope :published, { :conditions => "status_id >= 100" }
 
   def filtered_body

data/app/models/message_function.rb

@@ -14,6 +14,10 @@ class MessageFunction
     @name
   end
   
+  def humanize
+    to_s.gsub('_', ' ')
+  end
+  
   def self.[](value)
     return if value.blank?
     @@functions.find { |function| function.symbol == value.to_s.downcase.intern }

data/app/models/reader_notifier.rb

@@ -1,20 +1,22 @@
 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"
+  radiant_layout lambda { Radiant::Config['email.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'
+    prefix = site ? site.abbreviation : Radiant::Config['email.prefix']
+    host = site ? site.base_domain : Radiant::Config['site.domain'] || 'www.example.com'
     default_url_options[:host] = host
-    sender ||= message.created_by
+    sender = Radiant::Config['email.name'] || "sender_not_configured"
+    sender_address = Radiant::Config['email.address'] || "admin@#{host}"
 
     message_layout(message.layout) if message.layout
     content_type("text/html")
     subject (prefix || '') + message.subject
     recipients(reader.email)
-    from message.created_by.email
+    from ["#{sender} <#{sender_address}>"]
+    reply_to = [sender_address]
     subject message.subject
     sent_on(Time.now)
 
@@ -23,10 +25,11 @@ class ReaderNotifier < ActionMailer::Base
       :title => message.subject,
       :message => message.filtered_body,
       :sender => sender,
+      :reply_to => sender_address,
       :reader => reader,
       :site => site || {
-        :name => Radiant::Config['site.name'],
-        :url => Radiant::Config['site.url']
+        :name => Radiant::Config['site.title'],
+        :url => Radiant::Config['site.domain']
       }
     })
   end

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

@@ -18,6 +18,8 @@
           = form.label :body, "Message Body"
           = form.text_area :body, :class => 'textarea', :style => 'width: 100%'
 
+      = render_region :body_bottom, :locals => {:form => form}
+
 - render_region :form_bottom do |form_bottom|
   - form_bottom.edit_timestamp do
     = updated_stamp @message  
@@ -26,4 +28,4 @@
       = save_model_button(@message)
       = save_model_and_continue_editing_button(@message)
       or
-      = link_to "cancel", admin_messages_url
+      = link_to "cancel", admin_reader_configuration_url

data/app/views/admin/messages/_list_function.haml

@@ -0,0 +1,3 @@
+- if message.has_function?
+  %span.function
+    = message.function.description

data/app/views/admin/messages/index.haml

@@ -0,0 +1,42 @@
+- include_stylesheet('admin/reader')
+= render_region :top 
+
+#messages_table.outset      
+  %table#messages.index{:cellspacing=>"0", :border=>"0", :cellpadding=>"0"}
+    %thead
+      %tr
+        - render_region :thead do |thead|
+          - thead.subject_header do
+            %th.message Subject
+          - thead.sent_header do
+            %th.message_sent Delivery status
+          - thead.modify_header do
+            %th.modify Modify
+    %tbody
+      - @messages.each do |message|
+        %tr
+          - render_region :tbody do |tbody|
+            - tbody.subject_cell do
+              %td.name
+                = link_to message.subject, admin_message_url(message), :class => message.has_function? ? "functional" : "normal"
+                = render :partial => '/admin/messages/list_function', :locals => {:message => message}
+
+            - tbody.sent_cell do
+              %td.message_sent
+                %p
+                  - if message.sent_at
+                    = t('last_sent')
+                    = l(message.sent_at, :format => :short)
+                  - else
+                    = t('never_sent')
+            - tbody.modify_cell do
+              %td.actions
+                = link_to( image('delta') + ' ' + t('edit_message'), edit_admin_message_url(message), :class => "action" )
+                = link_to( image('minus') + ' ' + t('delete_message'), admin_message_url(message), {:method => :delete, :class => "action", :confirm => t('really_delete_message', :title => message.subject)})
+
+  - render_region :bottom do |bottom|
+    - bottom.buttons do
+      #actions
+        = pagination_for @messages
+        %ul
+          %li= link_to image('plus') + " " + "new message", new_admin_message_url