radiant-reader-extension 1.3.13 → 2.0.0.rc4

data/README.md

@@ -10,9 +10,9 @@ The purpose of this extension is to provide a common core that supports other vi
 
 ## Latest
 
-This version requires edge radiant, or radiant 0.9.2 when it becomes available. We are using a lot of the new configuration and sheets code.
+This version requires edge radiant, or radiant 1 when it becomes available. We are using a lot of the new configuration and sheets code.
 
-Right now we are **not compatible with multi_site or the sites extension**: that's mostly because neither is radiant edge: it will all be sorted out in time for the release of 0.9.2, which isn't far away.
+Right now we are **not compatible with multi_site or the sites extension**: that's mostly because neither is radiant edge: it will all be sorted out in time for the release of v1, which isn't far away.
 
 * public interface internationalized;
 * Uses the new configuration interface;

data/Rakefile

@@ -1,22 +1,3 @@
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "radiant-reader-extension"
-    gem.summary = %Q{User-services extension for Radiant CMS}
-    gem.description = %Q{Centralises reader/member/user registration and management tasks for the benefit of other extensions}
-    gem.email = "will@spanner.org"
-    gem.homepage = "http://github.com/spanner/radiant-reader-extension"
-    gem.authors = ["spanner"]
-    gem.add_dependency "radiant", ">= 0.9.0"
-    gem.add_dependency 'radiant-layouts-extension'
-    gem.add_dependency 'radiant-mailer_layouts-extension'
-    gem.add_dependency 'authlogic'
-    gem.add_dependency 'sanitize'
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. This is only required if you plan to package reader as a gem."
-end
-
 # In rails 1.2, plugins aren't available in the path until they're loaded.
 # Check to see if the rspec plugin is installed first and require
 # it if it is.  If not, use the gem version.

data/app/controllers/admin/group_invitations_controller.rb

@@ -0,0 +1,78 @@
+class Admin::GroupInvitationsController < ApplicationController
+  require 'csv'
+  
+  before_filter :find_group, :only => [:new, :create]
+
+  def new
+
+  end
+
+  def create
+    if params[:invite_reader] || params[:import_reader]
+      notice = []
+      if invites = params[:invite_reader]
+        invite_counter = 0
+        invites.each do |i|
+          if reader = Reader.find_by_id(i)
+            reader.groups << @group unless reader.is_in?(@group)
+            @group.send_welcome_to(reader)
+            invite_counter += 1
+          end
+        end
+        notice << "#{invite_counter} existing"
+      end
+      if imports = params[:import_reader]
+        import_counter = 0
+        imports.each do |i|
+          r = params["reader_#{i}".to_sym]
+          reader = Reader.new(r)
+          reader.create_password!
+          if reader.save!
+            reader.groups << @group
+            reader.send_group_invitation_message(@group)
+            import_counter += 1
+          end
+          notice << "#{import_counter} new"
+        end
+      end
+      flash[:notice] = notice.join(' and ') + " readers invited into the #{@group.name} group"
+      redirect_to admin_group_url(@group)
+    else 
+      if params[:readerlist] && @readers = readers_from_csv(params[:readerlist])
+        render :action => 'preview'
+      else
+        render :action => 'new'
+      end
+    end
+  end
+
+private
+
+  def find_group
+    @group = Group.find(params[:group_id])
+  end
+
+  def readers_from_csv(readerdata)
+    readers = []
+    CSV::StringReader.parse(readerdata).each do |line|
+      csv = line.collect {|value| value ? value.gsub(/^ */, '').chomp : ''}
+      input = {}
+      input[:honorific] = csv.shift if Radiant::Config['reader.use_honorifics?']
+      [:name, :email, :login, :phone].each {|field| input[field] = csv.shift}
+      r = Reader.find_by_email(input[:email]) || Reader.new(input)
+      r.create_password!    #only for validation purposes: not saved not passed through
+      r.login = generate_login(input[:name]) if r.login.blank?
+      r.valid?    # so that errors can be shown on the confirmation form
+      readers << r
+    end
+    readers
+  end
+
+  def generate_login(name)
+    names = name.split
+    initials = names.map {|n| n.slice(0,1)}
+    initials.pop
+    initials.push(names.last).join('_').downcase
+  end
+
+end

data/app/controllers/admin/groups_controller.rb

@@ -0,0 +1,8 @@
+class Admin::GroupsController < Admin::ResourceController
+  skip_before_filter :load_model
+  before_filter :load_model, :except => :index    # we want the filter to run before :show too
+  
+  def show
+    
+  end
+end

data/app/controllers/admin/memberships_controller.rb

@@ -0,0 +1,42 @@
+class Admin::MembershipsController < ApplicationController
+    
+  before_filter :find_group
+  
+  def index
+    redirect_to admin_group_url(@group)
+  end
+  
+  def create
+    @reader = Reader.find(params[:reader_id])
+    raise ActiveRecord::RecordNotFound unless @reader
+    @membership = Membership.find_or_create_by_reader_id_and_group_id(@reader.id, @group.id)
+    respond_to do |format|
+      format.html { 
+        flash[:notice] = "#{@reader.name} added to group #{@group.name}"
+        redirect_to admin_group_url(@group) 
+      }
+      format.js { render :partial => 'reader' }
+    end
+  end
+  
+  def destroy
+    @membership = @group.memberships.find(params[:id])
+    @reader = @membership.reader
+    @membership.delete if @membership
+    respond_to do |format|
+      format.html { 
+        flash[:notice] = "#{@reader.name} removed from group #{@group.name}" if @membership
+        redirect_to admin_group_url(@group) 
+      }
+      format.js { render :partial => 'reader' }
+    end
+  end
+  
+protected
+
+  def find_group
+    @group = Group.find(params[:group_id])
+    raise ActiveRecord::RecordNotFound unless @group
+  end
+    
+end

data/app/controllers/admin/messages_controller.rb

@@ -3,6 +3,7 @@ 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
+  before_filter :get_group, :only => :new
 
   # here :show is the preview/send page
   def show
@@ -30,13 +31,13 @@ class Admin::MessagesController < Admin::ResourceController
     failures = @message.deliver(@readers) || []
     if failures.any?
       if failures.length == @readers.length
-        flash[:error] = t("all_deliveries_failed")
+        flash[:error] = t("reader_extension.all_deliveries_failed")
       else
         addresses = failures.map(&:email).to_sentence
-        flash[:notice] = t("some_deliveries_failed")
+        flash[:notice] = t("reader_extension.some_deliveries_failed")
       end
     else
-      flash[:notice] = t("message_delivered")
+      flash[:notice] = t("reader_extension.message_delivered")
     end
     redirect_to admin_message_url(@message)
   end
@@ -57,4 +58,8 @@ protected
     end
   end
   
+  def get_group
+    model.group = Group.find(params[:group_id]) if params[:group_id]
+  end
+
 end

data/app/controllers/admin/permissions_controller.rb

@@ -0,0 +1,42 @@
+class Admin::PermissionsController < ApplicationController
+    
+  before_filter :find_group
+  
+  def index
+    redirect_to admin_group_url(@group)
+  end
+  
+  def create
+    @page = Page.find(params[:page_id])
+    raise ActiveRecord::RecordNotFound unless @page
+    @permission = Permission.find_or_create_by_page_id_and_group_id(@page.id, @group.id)
+    respond_to do |format|
+      format.html { 
+        flash[:notice] = "#{@page.name} bound to group #{@group.name}"
+        redirect_to admin_group_url(@group) 
+      }
+      format.js { render :partial => 'page' }
+    end
+  end
+  
+  def destroy
+    @permission = @group.permissions.find(params[:id])
+    @page = @permission.page
+    @permission.delete if @permission
+    respond_to do |format|
+      format.html { 
+        flash[:notice] = "#{@page.name} released from group #{@group.name}"
+        redirect_to admin_group_url(@group)
+      }
+      format.js { render :partial => 'page' }
+    end
+  end
+  
+protected
+
+  def find_group
+    @group = Group.find(params[:group_id])
+    raise ActiveRecord::RecordNotFound unless @group
+  end
+  
+end

data/app/controllers/admin/reader_configuration_controller.rb

@@ -1,4 +1,3 @@
 class Admin::ReaderConfigurationController < Admin::ConfigurationController
   helper :reader
-
 end

data/app/controllers/admin/readers_controller.rb

@@ -12,7 +12,7 @@ class Admin::ReadersController < Admin::ResourceController
     model.update_attributes!(params[:reader])
     model.clear_password = params[:reader][:password] if params[:reader] && params[:reader][:password]      # condition is so that radiant tests pass
     model.send_invitation_message
-    flash[:notice] = t('reader_saved')
+    flash[:notice] = t('reader_extension.reader_saved')
     response_for :create
   end
 

data/app/controllers/password_resets_controller.rb

@@ -23,14 +23,14 @@ class PasswordResetsController < ReaderActionController
         redirect_to new_reader_activation_url
       end
     else  
-      @error = flash[:error] = t("email_unknown")
+      @error = flash[:error] = t("reader_extension.email_unknown")
       render :action => :new  
     end  
   end
 
   def edit  
     unless @reader
-      flash[:error] = t('reset_not_found')
+      flash[:error] = t('reader_extension.reset_not_found')
     end
     render
   end  
@@ -41,14 +41,14 @@ class PasswordResetsController < ReaderActionController
       @reader.password_confirmation = params[:reader][:password_confirmation]
       if @reader.save 
         self.current_reader = @reader
-        flash[:notice] = t('password_updated_notice')
+        flash[:notice] = t('reader_extension.password_updated_notice')
         redirect_to url_for(@reader)
       else
-        flash[:error] = t('password_mismatch')
+        flash[:error] = t('reader_extension.password_mismatch')
         render :action => :edit 
       end  
     else
-      flash[:error] = t('reset_not_found')
+      flash[:error] = t('reader_extension.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

@@ -3,9 +3,6 @@ class ReaderActionController < ApplicationController
 
   helper :reader
   helper_method :current_site, :current_site=, :logged_in?, :logged_in_user?, :logged_in_admin?
-
-  attr_accessor :css, :js
-  helper_method :reader_css_paths, :reader_js_paths, :add_reader_js, :add_reader_css
   
   no_login_required
   before_filter :set_site_title
@@ -15,31 +12,6 @@ class ReaderActionController < ApplicationController
   
   radiant_layout { |controller| Radiant::Config['reader.layout'] }
 
-  # allow reader-based extensions to contribute to the public interface
-  # these methods can be called from any view
-
-  def add_reader_css(path)
-    @css ||= []
-    @css << path
-  end
-
-  def add_reader_js(path)
-    @js ||= []
-    @js << path
-  end
-
-  # these methods are called from :reader_css and :reader_js page parts defined in view/readers/_standard_parts
-
-  def reader_css_paths
-    @css ||= []
-    @css.uniq
-  end
-  
-  def reader_js_paths
-    @js ||= []
-    @js.uniq
-  end
-  
   # authorisation helpers
 
   def logged_in?
@@ -56,9 +28,17 @@ class ReaderActionController < ApplicationController
 
   def permission_denied
     session[:return_to] ||= request.referer
-    @title = flash[:error] || t('permission_denied')
+    @title = flash[:error] || t('reader_extension.permission_denied')
     render
   end
+  
+  def default_welcome_url(reader)
+    if page = reader.find_homepage
+      page.url
+    else
+      reader_url(reader)  #TODO make this interesting
+    end
+  end
 
 protected
   
@@ -81,8 +61,8 @@ protected
       store_location
       respond_to do |format|
         format.html {
-          flash[:explanation] = t('reader_required')
-          flash[:notice] = t('please_log_in')
+          flash[:explanation] = t('reader_extension.reader_required')
+          flash[:notice] = t('reader_extension.please_log_in')
           redirect_to reader_login_url 
         }
         format.js { 
@@ -98,7 +78,7 @@ protected
     unless current_reader && current_reader.activated?
       respond_to do |format|
         format.html { 
-          flash[:explanation] = t('activation_required')
+          flash[:explanation] = t('reader_extension.activation_required')
           redirect_to reader_activation_url 
         }
         format.js { 
@@ -113,7 +93,7 @@ protected
   def require_no_reader
     if set_reader
       store_location
-      flash[:notice] = t('please_log_out')
+      flash[:notice] = t('reader_extension.please_log_out')
       redirect_back_or_to url_for(current_reader)
       return false
     end

data/app/controllers/reader_activations_controller.rb

@@ -21,7 +21,7 @@ class ReaderActivationsController < ReaderActionController
     if current_reader
       @reader = current_reader
       @reader.send_activation_message
-      flash[:notice] = t("activation_message_sent")
+      flash[:notice] = t("reader_extension.activation_message_sent")
     end
     expires_now
     render :action => 'show'
@@ -32,7 +32,7 @@ class ReaderActivationsController < ReaderActionController
       @reader.activate!
       self.current_reader = @reader
     else
-      @error = t("please_check_message")
+      @error = t("reader_extension.please_check_message")
     end
     expires_now
     render :action => 'show'
@@ -47,14 +47,10 @@ protected
 
   def check_reader_inactive
     if @reader && @reader.activated?
-      flash[:notice] = t('hello').titlecase + " #{@reader.name}! " + t('already_active')
-      redirect_back_or_to default_activated_url
+      flash[:notice] = t('reader_extension.hello').titlecase + " #{@reader.name}! " + t('reader_extension.already_active')
+      redirect_back_or_to default_welcome_url(@reader)
       false
     end
   end
 
-  def default_activated_url
-    reader_url(@reader)
-  end
-
 end

data/app/controllers/reader_sessions_controller.rb

@@ -25,10 +25,10 @@ class ReaderSessionsController < ReaderActionController
   def new
     if current_reader
       if current_reader.activated?
-        cookies[:error] = t('already_logged_in')
+        cookies[:error] = t('reader_extension.already_logged_in')
         redirect_to reader_url(current_reader)
       else
-        cookies[:error] = t('account_requires_activation')
+        cookies[:error] = t('reader_extension.account_requires_activation')
         redirect_to reader_activation_url
       end
     else
@@ -39,29 +39,24 @@ class ReaderSessionsController < ReaderActionController
   
   def create
     @reader_session = ReaderSession.new(params[:reader_session])
-    if @reader_session.save
-      if @reader_session.reader.activated? && @reader_session.reader.clear_password        
-        @reader_session.reader.clear_password = ""                          # we forget the cleartext version on the first successful login
-        @reader_session.reader.save(false)
-      end
-      respond_to do |format|
+    @reader_session.save do |success|
+      if success
+        if @reader_session.reader.activated? && @reader_session.reader.clear_password        
+          @reader_session.reader.clear_password = ""                          # we forget the cleartext version on the first successful login
+          @reader_session.reader.save(false)
+        end
         format.html {
-          flash[:notice] = t('hello').titlecase + " #{@reader_session.reader.name}. " + t('welcome_back')
-          redirect_back_or_to default_loggedin_url
+          flash[:notice] = t('reader_extension.hello').titlecase + " #{@reader_session.reader.name}. " + t('reader_extension.welcome_back')
+          redirect_back_or_to default_welcome_url(@reader_session.reader)
         }
         format.js { 
           redirect_back_with_format(:js)
         }
-      end
-      
-    else
-      respond_to do |format|
-        format.html { 
-          render :action => :new 
-        }
-        format.js { 
-          render :action => :new, :layout => false 
-        }
+      else
+        respond_to do |format|
+          format.html { render :action => :new }
+          format.js { render :action => :new, :layout => false }
+        end
       end
     end
   end
@@ -76,11 +71,5 @@ class ReaderSessionsController < ReaderActionController
     end
     redirect_to reader_login_url
   end
-  
-protected
-
-  def default_loggedin_url
-    reader_url(@reader_session.reader)
-  end
 
 end

data/app/controllers/readers_controller.rb

@@ -7,9 +7,10 @@ class ReadersController < ReaderActionController
   before_filter :initialize_partials
   before_filter :i_am_me, :only => [:show, :edit]
   before_filter :require_reader, :except => [:new, :create, :activate]
+  before_filter :default_to_self, :only => [:show]
   before_filter :restrict_to_self, :only => [:edit, :update, :resend_activation]
   before_filter :no_removing, :only => [:remove, :destroy]
-  before_filter :require_password, :only => [:update]
+  before_filter :ensure_groups_subscribable, :only => [:update, :create]
 
   def index
     @readers = Reader.active.paginate(pagination_parameters.merge(:per_page => 60))
@@ -21,7 +22,7 @@ class ReadersController < ReaderActionController
 
   def new
     if current_reader
-      flash[:error] = t('already_logged_in')
+      flash[:error] = t('reader_extension.already_logged_in')
       redirect_to url_for(current_reader) and return
     end
     @reader = Reader.new
@@ -38,9 +39,9 @@ class ReadersController < ReaderActionController
     @reader.clear_password = params[:reader][:password]
 
     unless @reader.email.blank?
-      flash[:error] = t('please_avoid_spam_trap')
+      flash[:error] = t('reader_extension.please_avoid_spam_trap')
       @reader.email = ''
-      @reader.errors.add(:trap, t("must_be_empty"))
+      @reader.errors.add(:trap, t("reader_extension.must_be_empty"))
       render :action => 'new' and return
     end
 
@@ -56,6 +57,7 @@ class ReadersController < ReaderActionController
       self.current_reader = @reader
       redirect_to reader_activation_url
     else
+      @reader.email_field = session[:email_field]
       render :action => 'new'
     end
   end
@@ -64,7 +66,7 @@ class ReadersController < ReaderActionController
     @reader.attributes = params[:reader]
     @reader.clear_password = params[:reader][:password] if params[:reader][:password]
     if @reader.save
-      flash[:notice] = t('account_updated')
+      flash[:notice] = t('reader_extension.account_updated')
       redirect_to url_for(@reader)
     else
       render :action => 'edit'
@@ -77,8 +79,12 @@ protected
     params[:id] = current_reader.id if current_reader && params[:id] == 'me'
   end
 
+  def default_to_self
+    params[:id] ||= current_reader.id
+  end
+  
   def restrict_to_self
-    flash[:error] = t("cannot_edit_others") if params[:id] && params[:id] != current_reader.id
+    flash[:error] = t("reader_extension.cannot_edit_others") if params[:id] && params[:id] != current_reader.id
     @reader = current_reader
   end
   
@@ -89,19 +95,19 @@ protected
     @reader.attributes = params[:reader]
     @reader.valid?
     
-    flash[:error] = t('password_incorrect')
+    flash[:error] = t('reader_extension.password_incorrect')
     @reader.errors.add(:current_password, "not_correct")
     render :action => 'edit' and return false
   end
   
   def no_removing
-    flash[:error] = t('cannot_delete_readers')
+    flash[:error] = t('reader_extension.cannot_delete_readers')
     redirect_to admin_readers_url
   end
   
   def check_registration_allowed
     unless Radiant::Config['reader.allow_registration?']
-      flash[:error] = t("registration_disallowed")
+      flash[:error] = t("reader_extension.registration_disallowed")
       redirect_to reader_login_url
       false
     end
@@ -129,4 +135,15 @@ private
     @index_partials = index_partials
   end
 
+  def ensure_groups_subscribable
+    if params[:reader] && params[:reader][:group_ids]
+      params[:reader][:group_ids].each do |g|
+        raise ActiveRecord::RecordNotFound unless Group.find(g).public?
+      end
+    end
+    true
+  rescue ActiveRecord::RecordNotFound
+    false
+  end
+
 end