spree_mail 0.40.0.1

data/README.md

@@ -0,0 +1,19 @@
+Spree Mail
+----------
+
+Spree Mail extends Spree by adding a mailing list subscriber model, sign up forms and an admin to send messages.
+
+
+
+Demo
+----
+
+rails new spree_mail_example; cd spree_mail_example; echo "gem 'spree', '0.40.2'" >> Gemfile; echo "gem 'spree_mail', '0.40.0.1'" >> Gemfile; rm public/index.html; bundle install; rake spree:install spree_mail:install db:migrate db:seed; rails s
+
+
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,94 @@
+require 'bundler'
+#require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+#Rake::TestTask.new do |t|
+#  t.libs << "lib"
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = true
+#end
+
+
+task :test do
+
+  root = ENV["RAILS_ROOT"] || File.expand_path('../spec/test_app', __FILE__)
+  env = File.join(root, 'config', 'environment.rb')
+  puts "(Rails Root: #{root})"
+
+  require env
+  require File.expand_path('../test/test_helper', __FILE__)
+  Dir["test/**/*.rb"].reject{|file| file.match(/test_helper/) != nil }.each do |file|
+    puts "Loading #{file}"
+    load file
+  end
+  
+end
+
+
+
+
+desc "Default Task"
+task :default => [ :test ]
+
+
+
+
+
+
+
+
+# TODO: pull in the spree/core/Rakefile bits that set up for testing
+desc "Regenerates a Rails 3 app for testing"
+task :test_app do
+# TODO - this path requires a certain directory structure -- need
+# to think about how to refactor
+  
+  
+  files = `gem contents spree`.split("\n").select{|file| file.match("test_app_generator")}
+  if files.length == 1
+    require files.first
+    class SpreeMailTestAppGenerator < Spree::Generators::TestAppGenerator
+      def tweak_gemfile
+        append_file "Gemfile" ,
+          <<-gems
+gem 'activemerchant'
+gem 'spree_core', '>=0.40.2'
+gem 'spree_auth', '>=0.40.2'
+gem 'spree_mail', :path => "#{File.dirname(__FILE__)}"  
+          gems
+      end
+  
+      def install_spree_gems
+      
+        puts "-----------------------------------------"
+        puts "Installing gems..."
+        `bundle install --gemfile=spec/test_app/Gemfile`
+        puts "-----------------------------------------"
+      
+        inside "test_app" do
+          run 'rake spree_core:install'
+          run 'rake spree_auth:install'
+          run 'rake spree_mail:install'
+        end
+      end
+    
+      def migrate_db
+        run_migrations
+      end
+    end
+    
+    SpreeMailTestAppGenerator.start
+    
+    puts "spec/test_app created. "
+           
+  else
+    puts "Failed: Could not find lib/generators/spree/test_app_generator.rb"
+  end
+end
+
+namespace :test_app do
+  desc 'Rebuild test database'
+  task :rebuild_db do
+    system("cd spec/test_app && rake db:drop db:migrate RAILS_ENV=test")
+  end
+end

data/app/controllers/admin/emails_controller.rb

@@ -0,0 +1,61 @@
+class Admin::EmailsController < Admin::BaseController
+  
+  resource_controller
+  
+  before_filter :check_json_authenticity, :only => :index
+  before_filter :get_subscribers, :only => [:new, :create, :edit, :update]
+  
+  index.response do |wants|
+    wants.html { render :action => :index }
+    wants.json { render :json => json_data }
+  end
+  destroy.success.wants.js { render_js_for_destroy }
+
+
+  def deliver
+    @email = Email.find(params[:id])
+    sent, count = @email.deliver!
+    if sent
+      flash[:notice] = t('delivery_success', count)
+    else
+      flash[:error] = t('delivery_failed', count)
+    end
+    redirect_to admin_email_path(@email)
+  end 
+
+
+
+  private
+
+  ## Allow different formats of json data to suit different ajax calls
+  #def json_data
+  #  json_format = params[:json_format] or 'default'
+  #  case json_format
+  #  when 'basic'
+  #    collection.map {|u| {'id' => u.id, 'name' => u.email}}.to_json
+  #  else
+  #    collection.to_json(:include =>
+  #      {:bill_address => {:include => [:state, :country]},
+  #      :ship_address => {:include => [:state, :country]}})
+  #  end
+  #end
+
+  def get_subscribers
+   @subscribers = Subscriber.active
+  end
+  
+  def collection
+    return @collection if @collection.present?
+    unless request.xhr?
+      @search = Email.searchlogic(params[:search])
+
+      #set order by to default or form result
+      @search.order ||= "ascend_by_name"
+
+      @collection = @search.do_search.paginate(:per_page => Spree::Config[:admin_products_per_page], :page => params[:page])
+
+    else
+      @collection = Email.where("wholesalers.name like :search", {:search => "#{params[:q].strip}%"}).limit(params[:limit] || 100)
+    end
+  end  
+end

data/app/controllers/admin/subscribers_controller.rb

@@ -0,0 +1,78 @@
+class Admin::SubscribersController < Admin::BaseController
+  
+  resource_controller
+  
+  before_filter :check_json_authenticity, :only => :index
+  
+  #index.response do |wants|
+  #  wants.html { render :action => :index }
+  #  wants.json { render :json => json_data }
+  #end
+
+  destroy.success.wants.js { render_js_for_destroy }
+
+  create.response do |wants|
+    wants.html { redirect_to admin_subscribers_path }
+  end
+  
+  update.response do |wants|
+    wants.html { redirect_to admin_subscribers_path }
+  end
+
+  def resubscribe
+    @subscriber = object
+    if @subscriber.resubscribe!
+      flash[:notice] = t("resubscribe_success")
+    else
+      flash[:error] = t("resubscribe_failed")
+    end
+    redirect_to request.referer
+  end
+    
+  def unsubscribe
+    @subscriber = object
+    if @subscriber.unsubscribe!
+      flash[:notice] = t("unsubscribe_success")
+    else
+      flash[:error] = t("unsubscribe_failed")
+    end
+    redirect_to request.referer
+  end
+
+  def unsubscribed
+    @search = Subscriber.searchlogic(params[:search])
+    
+    #set order by to default or form result
+    @search.order ||= "ascend_by_name"
+
+    @subscribers = @collection = @search.do_search.unsubscribed.paginate(:per_page => Spree::Config[:admin_products_per_page], :page => params[:page])
+    render :template => 'admin/subscribers/index'
+  end
+
+
+  private
+
+  # Allow different formats of json data to suit different ajax calls
+  #def json_data
+  #  json_format = params[:json_format] or 'default'
+  #  case json_format
+  #  when 'basic'
+  #    collection.map {|u| {'id' => u.id, 'name' => u.email}}.to_json
+  #  else
+  #    collection.to_json(:include =>
+  #      {:bill_address => {:include => [:state, :country]},
+  #      :ship_address => {:include => [:state, :country]}})
+  #  end
+  #end
+
+  def collection
+    return @collection if @collection.present?
+    @search = Subscriber.searchlogic(params[:search])
+    
+    #set order by to default or form result
+    @search.order ||= "ascend_by_name"
+
+    @collection = @search.do_search.active.paginate(:per_page => Spree::Config[:admin_products_per_page], :page => params[:page])
+    
+  end  
+end

data/app/controllers/emails_controller.rb

@@ -0,0 +1,19 @@
+class EmailsController < Spree::BaseController
+      
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  
+  def show
+    @subscriber = Subscriber.find_by_token(params[:token])
+    @email = Email.find_by_token(params[:id])
+    
+    return redirect_to new_subscriber_path unless @email.recipients.include?(@subscriber.email)
+    
+    @email_subject = @email.render(:subject, @subscriber)
+    @text          = @email.render(:body,    @subscriber)
+    @base_url      = "http://#{Spree::Config[:site_url]}"
+    
+    render :layout => 'email', :text => simple_format(@text)    
+  end
+  
+end

data/app/controllers/subscribers_controller.rb

@@ -0,0 +1,42 @@
+class SubscribersController < Spree::BaseController
+
+  before_filter :get_subscriber, :only => [:show, :unsubscribe]
+  
+  def index
+    redirect_to new_subscriber_path
+  end
+  
+  def new
+    @subscriber = Subscriber.new
+  end
+  
+  def show
+  end
+  
+  def create
+    @subscriber = Subscriber.new(params[:subscriber])
+    if @subscriber.valid? && @subscriber.save
+      flash[:notice] = "Thanks for signing up for our newsletter!"
+      redirect_to new_subscriber_path
+    else
+      flash[:error] = "Sorry, we could not sign you up."
+      render :action => 'new'
+    end
+  end
+  
+  def unsubscribe
+    if @subscriber.email == params[:subscriber][:email] && @subscriber.unsubscribe!
+      flash[:notice] = "You were successfully unsubscribed from the mailing list."
+    else
+      flash[:error]  = "We're sorry, you could not be unsubscribed at this time."
+    end
+    redirect_to new_subscriber_path
+  end
+  
+  private
+  
+    def get_subscriber
+      @subscriber = Subscriber.find_by_token(params[:id])
+    end
+  
+end

data/app/mailers/email_mailer.rb

@@ -0,0 +1,24 @@
+class EmailMailer < ActionMailer::Base
+    
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  
+  default_url_options[:host] = "10.0.1.10:3000"
+    
+  def with_layout(email, subscriber)
+    @email           = email
+    @subscriber      = subscriber
+    @email_subject   = @email.render(:subject, @subscriber)
+    @text            = @email.render(:body,    @subscriber)
+    @base_url        = "http://10.0.1.10:3000" ##{Spree::Config[:site_url]}
+    @link_to_browser = read_email_url(@subscriber.token, @email.token)
+    
+    unless @email.nil? || @email_subject.empty? || @text.empty?
+      mail(:to => @subscriber.email, :from => @email.from, :subject => @email_subject) do |format|
+        format.text { render :text   => @text }
+        format.html { render :layout => 'email', :text => simple_format(@text) }
+      end
+    end
+  end
+    
+end

data/app/model/email.rb

@@ -0,0 +1,77 @@
+class Email < ActiveRecord::Base
+  
+  validates :to,      :presence => true
+  validates :subject, :presence => true
+  validates :body,    :presence => true
+  
+  before_create :set_token
+  
+  def to=(value)
+    value = {} unless value.is_a? Hash
+    value.delete("0")
+    return false if value.empty?    
+    write_attribute :to, value.inspect
+  end
+  
+  def from
+    MailMethod.current.preferred_mails_from rescue "no-reply@spree-mail-example.com"
+  end
+  
+  def recipients
+    hash = eval(read_attribute(:to)) rescue {}  
+    hash.values  
+  end
+  
+  def recipient_list
+    recipients.join(", ")
+  end
+
+  def deliver!
+    count = 0
+    recipients.each do |email|
+      subscriber = Subscriber.find_by_email(email) rescue nil
+      if subscriber
+        mail = EmailMailer.with_layout(self, subscriber)
+        count += 1 if mail && mail.deliver!
+      end
+    end   
+    return 0 < count, count
+  end
+  
+  
+  
+  def render(attribute, subscriber)
+    Mustache.render(self.send(attribute), subscriber.attributes)
+  end
+  
+  private
+ 
+    def set_token
+      write_attribute :token, Digest::SHA1.hexdigest(Time.now.to_s)
+    end
+  
+    
+  class << self
+    
+    def new(parameters={})
+      parameters ||= {}
+      super(parameters.reverse_merge!(:body => template))
+    end
+  
+    def template
+      txt=<<TXT
+Hello {{name}},
+  
+
+  
+Regards,
+
+#{Spree::Config[:site_name]}
+    
+TXT
+    end
+    
+    
+  end
+
+end

data/app/model/subscriber.rb

@@ -0,0 +1,39 @@
+class Subscriber < ActiveRecord::Base
+
+  attr_protected :token
+  
+  scope :active, where("unsubscribed_at IS NULL").order(:name)
+  scope :unsubscribed, where("unsubscribed_at IS NOT NULL").order(:name)
+  
+  validates :name,  :presence => true
+  validates :email, :format => Devise.email_regexp, :uniqueness => true
+  
+  before_create :set_token
+  
+  def active?
+    unsubscribed_at.to_s.empty?
+  end
+  
+  def resubscribe!
+    return true if active?
+    self.unsubscribed_at = nil
+    save
+  end
+  
+  def unsubscribe!
+    return true unless active?
+    self.unsubscribed_at = Time.now
+    save
+  end
+  
+  def email=(value)
+    write_attribute :email, value.strip.downcase
+  end
+    
+  private
+  
+    def set_token
+      write_attribute :token, Digest::SHA1.hexdigest(Time.now.to_s)
+    end
+  
+end