newsletter 3.0.2 → 3.2.0

data/lib/deleteable.rb

@@ -2,6 +2,9 @@ module Deleteable
 
   def self.included(receiver)
     receiver.extend ClassMethods
+    receiver.class_eval do
+      default_scope where("deleted_at IS NULL")
+    end
   end
 
   def is_deleted?
@@ -17,15 +20,8 @@ module Deleteable
   end
 
   module ClassMethods
-    def find(*args)
-      if args[0] == (:exclusive_scope)
-        args.shift
-        super
-      else
-        with_scope(:find => {:conditions => ["#{table_name}.deleted_at is null"]}) do
-          super
-        end
-      end
+    def deleted
+      unscoped.where("deleted_at IS NOT NULL")
     end
   end
 
@@ -37,14 +33,16 @@ module DeleteableActions
   end
 
   def destroy
-    thing = controller_name.singularize.split('_').collect{|string| string.capitalize}.join.constantize.find(params[:id])
+    thing = self.class.name.gsub(/s?Controller$/,'').constantize.find(params[:id])
     thing.delete
-    redirect_to(eval("#{controller_name}_path(derailed_params)"))
+    redirect_to(action: :index)
   end
 
+  # :nocov: - not currently supported
   def undelete
-    thing = controller_name.singularize.split('_').collect{|string| string.capitalize}.join.constantize.find(:exclusive_scope,params[:id])
+    thing = self.class.name.gsub(/s?Controller$/,'').constantize.find(params[:id])
     thing.undelete
-    redirect_to(eval("#{controller_name}_path(derailed_params)"))
+    redirect_to(action: :index)
   end
-end
+  # :nocov:
+end

data/lib/newsletter/engine.rb

@@ -6,8 +6,36 @@ require 'nested_form'
 require 'carrierwave'
 require 'carrierwave/orm/activerecord'
 module Newsletter
-  mattr_accessor :table_prefix, :designs_path, :site_url,
-   :site_path, :layout, :archive_layout, :use_show_for_resources, :asset_path
+  # namespace for newsletter tables in database i.e. newsletter_
+  mattr_accessor :table_prefix
+  # path where design text files are saved
+  mattr_accessor :designs_path
+  # the fully qualified url of site i.e. http://www.example.com
+  mattr_accessor :site_url
+  # the path to the site '/' if its at the root or /blarg if the rails engine is at a subpath defaults to '/admin'
+  mattr_accessor :site_path
+  # the default layout for the administration of newsletters
+  mattr_accessor :layout
+  # layout for the newsletter archive
+  mattr_accessor :archive_layout
+  # path to the newsletter assets (will be used for asset uploads)
+  mattr_accessor :asset_path
+  # designs_require_authentication: whether you need to log in to manage designs(recommended)
+  mattr_accessor :designs_require_authentication
+  # design_authorized_roles: array of role names that can manage designs
+  mattr_accessor :design_authorized_roles
+  # newsletters_require_authentication: whether you need to log in to manage newsletters(everyone can currently see them.. devise your own abilities if you want to require login for these)
+  mattr_accessor :newsletters_require_authentication
+  # newsletter_authorized_roles: array of role names that can manage newsletters
+  mattr_accessor :newsletter_authorized_roles
+  # roles_method: the method which gives a list of role names for the 'current_user' of the app, if it answers with an array of names as strings with 'roles' or a string with 'role' this doesn't have to be set
+  mattr_accessor :roles_method
+
+  # the following 2 will probably be deprecated soon
+  # whether or not to redirect to the 'show' page of something after editing/creating or go to the 'index'
+  mattr_accessor :use_show_for_resources
+  # provides a view helper for whether to show a title in a layout/template
+  mattr_accessor :show_title
   class Engine < ::Rails::Engine
     isolate_namespace Newsletter
     initializer "Newsletter.config" do |app|
@@ -16,16 +44,86 @@ module Newsletter
         require 'newsletter/settings'
         ::Newsletter.initialize_with_config(::Newsletter::Settings.initialize!)
       end
-      config.generators do |g|
-        g.test_framework :rspec, :fixture => false
-        g.fixture_replacement :factory_girl, :dir => 'spec/factories'
-      end
     end
+    initializer "newsletter.factories", :after => "factory_girl.set_factory_paths" do
+      FactoryGirl.definition_file_paths << File.expand_path('../../../spec/test_app/spec/factories', __FILE__) if defined?(FactoryGirl)
+    end
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+  end
+
+  def self.authorized_for_roles?(user,roles=[])
+    user_roles = if ::Newsletter.roles_method.present?
+      user.send(::Newsletter.roles_method)
+    elsif user.respond_to?(:roles)
+      user.roles
+    elsif user.respond_to?(:role)
+      [user.role]
+    else
+      []
+    end
+    user_roles = [user_roles] unless user_roles.is_a?(Array)
+    roles.detect{|role| user_roles.map(&:to_sym).map(&:to_s).include?(role.to_s)}.present?
+  end
+
+  def self.authorized?(user, object=nil)
+    if object.eql?(::Newsletter::Design)
+      return true unless ::Newsletter.designs_require_authentication 
+      return false if user.blank?
+      return true unless ::Newsletter.design_authorized_roles.present? 
+      authorized_for_roles?(user, ::Newsletter.design_authorized_roles)
+    elsif object.eql?(::Newsletter::Newsletter)
+      return true unless ::Newsletter.newsletters_require_authentication 
+      return false if user.blank?
+      return true unless ::Newsletter.newsletter_authorized_roles.present? 
+      authorized_for_roles?(user, ::Newsletter.newsletter_authorized_roles)
+    else
+      false
+    end
+  end
+  
+  def self.abilities
+    <<-EOT
+      if ::Newsletter.authorized?(user, ::Newsletter::Design)
+        can :manage, [
+          ::Newsletter::Design,
+          ::Newsletter::Element,
+          ::Newsletter::Area,
+          ::Newsletter::Field
+        ]
+      end
+      if ::Newsletter.authorized?(user, ::Newsletter::Newsletter)
+        can :manage, [
+          ::Newsletter::Newsletter,
+          ::Newsletter::Piece,
+          ::Newsletter::FieldValue
+        ]
+        can :read, [
+          ::Newsletter::Design,
+          ::Newsletter::Element,
+          ::Newsletter::Area,
+          ::Newsletter::Field
+        ]
+      end
+      can :read, [
+        ::Newsletter::Newsletter,
+        ::Newsletter::Piece,
+        ::Newsletter::FieldValue
+      ]
+      can :archive, ::Newsletter::Newsletter
+    EOT
   end
+
+  # an easy way to get the root of the gem's directory structure
   PLUGIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__),'..','..'))
+  # an easy way to get the root of the gem's assets
   def self.assets_path
     File.join(PLUGIN_ROOT,'assets')
   end
+  # initializes the configuration options pulled from config/newsletter.yml and 
+  # overrides with config/newsletter.local.yml if it exists
   def self.initialize_with_config(conf)
     ::Newsletter.table_prefix ||= conf.table_prefix || 'newsletter_' rescue 'newsletter_'
     ::Newsletter.designs_path ||= conf.designs_path || "#{Rails.root}/designs" rescue "#{Rails.root}/designs"
@@ -37,8 +135,16 @@ module Newsletter
     ::Newsletter.archive_layout ||= conf.archive_layout || 'application' rescue 'application'    
     ::Newsletter.use_show_for_resources ||= conf.use_show_for_resources || false rescue false
     ::Newsletter.asset_path ||= conf.asset_path || 'newsletter_assets' rescue 'newsletter_assets'
+    ::Newsletter.show_title ||= conf.show_title || true rescue true
+    ::Newsletter.designs_require_authentication ||= conf.designs_require_authentication || false rescue false
+    ::Newsletter.newsletters_require_authentication ||= conf.newsletters_require_authentication || false rescue false
+    ::Newsletter.design_authorized_roles ||= conf.design_authorized_roles || [] rescue []
+    ::Newsletter.newsletter_authorized_roles ||= conf.newsletter_authorized_roles || [] rescue []
+    ::Newsletter.roles_method ||= conf.roles_method || '' rescue ''
   end
 end
+
+# initializes mail_manager tie ins
 Newsletter::Engine.config.to_prepare do
   Rails.logger.info "Newsletter: Checking for Mail Manager plugin support"
   begin

data/lib/newsletter/version.rb

@@ -1,3 +1,3 @@
 module Newsletter
-  VERSION = "3.0.2"
+  VERSION = "3.2.0"
 end

data/lib/tasks/newsletter.rake

@@ -3,45 +3,12 @@ ENV["Rails.env"] ||= "development"
 require "#{Rails.root}/config/environment"
 
 namespace :newsletter do 
-  desc "Create Newsletter LSI Auth Menus"
-  task :create_auth_menus do
-    Rails.logger.warn "Creating Newsletter LSI Auth Menus"
-    parent_menu = 'Newsletter'
-    AdminMenu.create_or_find(
-      :description=>'Newsletter',
-      :path=>'admin/newsletter/newsletters',
-      :admin_menu_id=>nil,
-      :menu_order=>1,
-      :is_visible=>1,
-      :auth_all=>1)
-    AdminMenu.create_or_find(
-      :description=>'Newsletters',
-      :path=>'admin/newsletter/newsletters',
-      :admin_menu_id=>AdminMenu.find_by_description('Newsletter').id,
-      :menu_order=>1,
-      :is_visible=>1,
-      :auth_all=>1)
-    AdminMenu.create_or_find(
-      :description=>'Newsletter General Auth',
-      :path=>'admin/newsletter',
-      :admin_menu_id=>nil,
-      :menu_order=>0,
-      :is_visible=>0,
-      :auth_all=>1)
-    AdminMenu.create!(
-      :description=>'Designs',
-      :path=>'admin/newsletter/designs',
-      :admin_menu_id=>AdminMenu.find_by_description('Newsletter').id,
-      :menu_order=>1,
-      :is_visible=>1,
-      :auth_all=>1)
-  end
-
   desc "Import Example Newsletter Design"
-  task :import_example_design do     
-    Rails.logger.warn "Importing Example Newsletter Design"
+  task :import_example_design, :design_name do |t,args|    
+    Rails.logger.warn "Importing Example Newsletter Design with name: #{args.design_name}"
     Newsletter::Design.import(
-      File.join(Newsletter::PLUGIN_ROOT,'designs','exports','example-export.yaml')
+      File.join(Newsletter::PLUGIN_ROOT,'designs','exports','example-export.yaml'), 
+      args.design_name
     )
   end
   desc "Add defaults to config/newsletter.yml"
@@ -53,12 +20,58 @@ namespace :newsletter do
       app_config = Hash.new
     end
     File.open('config/newsletter.yml','w') do |file|
+      file.write <<EOT
+# this file is used to configure the newsletter gem
+# it works like an older gem called AppConfig
+# all environments start with settings from the 'common' section
+# and are overridden by the section that matches the environment's name
+# also .. if you create a 'config/newsletter.local.yml' it will override
+# what is in 'config/newsletter.yml' such that you can keep a  version 
+# for local settings and not overwrite one that you include in your source control
+# also ... these files allow the use of erb syntax to set variables with ruby thus
+# allowing ENV variables and such to be used
+# here are the valid settings and what they are for:
+# site_url: used in various places to get the url of the site (such as in mailings templates)
+# site_path: used in various places to get the url of the site (such as in mailings templates)
+# layout: layout used for newsletter administration pages
+# archive_layout: layout used for public facing pages like the newsletter archive
+# designs_require_authentication: whether you need to log in to manage designs(recommended)
+# design_authorized_roles: array of role names that can manage designs
+# newsletters_require_authentication: whether you need to log in to manage newsletters(everyone can currently see them.. devise your own abilities if you want to require login for these)
+# newsletter_authorized_roles: array of role names that can manage newsletters
+# roles_method: the method which gives a list of role names for the 'current_user' of the app, if it answers with an array of names as strings with 'roles' or a string with 'role' this doesn't have to be set
+# designs_path: path from your rails root where design templates are saved
+# asset_path: where your newsletter assets are saved(images, pdfs, etc for newsletter instances-uploaded with carrier_wave)
+# table_prefix: prefix your newsletter tables to avoid collisions
+#
+#
+# The following 2 might be deprecated soon
+# show_title: can be used in templates/layouts to see whether you should show a title
+# use_show_for_resources: whether to have links to "show" actions - we don't use them really in this app..
+# and the 'show' actions aren't really currently supported
+EOT
       file.write YAML.dump({
         'common' => {
-          'newsletters_path' => '<%= "#{RAILS_ROOT}/newsletters" %>',
-          'asset_path' =>  'public/newsletter_assets',
-          'newsletter_path_prefix' =>  '/admin',
-          'newsletter_table_prefix' =>  args.table_prefix
+          'site_url' => 'http://example.com',
+          'layout' => 'newsletter/application',
+          'archive_layout' => 'layout',
+          'use_show_for_resources' => false,
+          'show_title' => true,
+          'designs_require_authentication' => false,
+          'design_authorized_roles' => [],
+          'newsletters_require_authentication' => false,
+          'newsletter_authorized_roles' => [],
+          'roles_method' => '',
+          'designs_path' => "<%= File.join(Rails.root,'designs') %>",
+          'asset_path' =>  'newsletter_assets',
+          'site_path' =>  '/admin',
+          'table_prefix' =>  args.table_prefix
+        },
+        'development' => {
+          'site_url' => 'http://example.dev',
+        },
+        'test' => {
+          'site_url' => 'http://example.lvh.me',
         }
       }.deep_merge(app_config))
     end

data/newsletter.gemspec

@@ -11,10 +11,12 @@ Gem::Specification.new do |gem|
   gem.email         = ["biz@lone-star.net"]
   gem.licenses      = ['MIT']
   gem.description   = %q{Newsletter templating and management system.}
-  gem.summary       = %q{Newsletter templating and management system.}
+  gem.summary       = %q{Newsletter templating and management system which allows a designer to create templates that are email-friendly and allows a user to create newsletters with little html/css knowhow.}
   gem.homepage      = "http://ireach.com"
 
   gem.add_dependency "rails", "~>3.2"
+  gem.add_dependency "jquery-rails", "~>3.1"
+  gem.add_dependency "jquery-ui-rails", "~>5.0"
   gem.add_dependency "mini_magick", "~>4.1"
   gem.add_dependency "will_paginate", "~>3.0"
   gem.add_dependency 'carrierwave', "~>0.10" 

data/spec/test_app/.rspec

@@ -1 +1,3 @@
 --color
+--require spec_helper
+--format documentation

data/spec/test_app/app/controllers/application_controller.rb

@@ -1,3 +1,8 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+  helper_method :current_user
+
+  def current_user
+    nil
+  end
 end

data/spec/test_app/app/models/ability.rb

@@ -0,0 +1,8 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    eval Newsletter.abilities
+  end
+end
+

data/spec/test_app/app/models/user.rb

@@ -0,0 +1,10 @@
+class User < ActiveRecord::Base
+  attr_accessible :email, :first_name, :last_name, :phone
+
+  validates :email, uniqueness: true, presence: true
+
+  def roles
+    return ['admin'] if last_name.include?('admin')
+    []
+  end
+end

data/spec/test_app/app/views/layouts/application.html.erb

@@ -3,12 +3,14 @@
 <head>
   <title>TestApp</title>
   <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "newsletter/application" %>
   <%= javascript_include_tag "application" %>
   <%= csrf_meta_tags %>
 </head>
 <body>
-
+<%= yield :page_navigation %>
 <%= yield %>
+<%= yield :page_navigation %>
 
 </body>
 </html>

data/spec/test_app/config/database.postgres.yml

@@ -0,0 +1,21 @@
+credentials: &credentials
+  encoding: utf8
+  adapter: postgresql
+  username: newsletter
+  password: newsletter_pass
+  host: localhost
+  reconnect: true
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *credentials 
+  database: mail_manager_development
+ 
+test:
+  <<: *credentials 
+  database: mail_manager_test
+ 
+production:
+  <<: *credentials 
+  database: mail_manager

data/spec/test_app/config/initializers/carrierwave.rb

@@ -0,0 +1,23 @@
+if Rails.env.test? || Rails.env.cucumber?
+  CarrierWave.configure do |config|
+    config.storage = :file
+    config.enable_processing = false
+  end
+
+  # make sure our uploader is auto-loaded
+  Newsletter::AssetUploader
+
+  # use different dirs when testing
+  CarrierWave::Uploader::Base.descendants.each do |klass|
+    next if klass.anonymous?
+    klass.class_eval do
+      def cache_dir
+        "#{Rails.root}/spec/support/uploads/tmp"
+      end
+
+      def store_dir
+        "#{Rails.root}/spec/support/uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      end
+    end
+  end
+end

data/spec/test_app/config/newsletter.yml

@@ -1,9 +1,12 @@
 --- 
 common:
-  site_url: http://newsletter.lvh.me:4447
+  site_url: http://newsletter.dev
   table_prefix: news_
-  designs_path: <%= "#{Rails.root}/designs" %>
+  designs_path: <%= "#{Rails.root}/" %>
   use_show_for_resources: false
   asset_path: newsletter_assets
   site_path: /
-  layout: application
+  layout: newsletter/application
+test:
+  site_url: http://newsletter.lvh.me:4447
+  designs_path: <%= "#{Rails.root}/tmp" %>