spree_mail 0.40.0.2 → 0.40.0.3

data/README.md

@@ -14,7 +14,7 @@ To create a spree mail demo app, run the following:
     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 
+    echo "gem 'spree_mail', '0.40.0.3'" >> Gemfile 
     rm public/index.html 
     bundle install 
     rake spree:install spree_mail:install db:migrate db:seed
@@ -22,7 +22,7 @@ To create a spree mail demo app, run the following:
 
 Or all at once:
 
-    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 new spree_mail_example; cd spree_mail_example; echo "gem 'spree', '0.40.2'" >> Gemfile; echo "gem 'spree_mail', '0.40.0.3'" >> Gemfile; rm public/index.html; bundle install; rake spree:install spree_mail:install db:migrate db:seed
 
 `rake db:sample` if you want to...
 
@@ -48,6 +48,8 @@ To Do
 * Add user help to email form
 * Add email tracking functionality
 * Add a selection of products to emails
+* Add an 'assets' upload admin and an easy way to link images or files to an email
+* Maybe add a wysiwyg editor for email composition
 
 
 License

data/app/controllers/subscribers_controller.rb

@@ -16,19 +16,19 @@ class SubscribersController < Spree::BaseController
   def create
     @subscriber = Subscriber.new(params[:subscriber])
     if @subscriber.valid? && @subscriber.save
-      flash[:notice] = "Thanks for signing up for our newsletter!"
+      flash[:notice] = I18n.t( :subscribe_thanks)
       redirect_to new_subscriber_path
     else
-      flash[:error] = "Sorry, we could not sign you up."
+      flash[:error] = I18n.t( :subscribe_failed)
       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."
+      flash[:notice] = I18n.t(:unsubscribe_success_public)
     else
-      flash[:error]  = "We're sorry, you could not be unsubscribed at this time."
+      flash[:error]  = I18n.t(:unsubscribe_failed_public)
     end
     redirect_to new_subscriber_path
   end
@@ -39,4 +39,4 @@ class SubscribersController < Spree::BaseController
       @subscriber = Subscriber.find_by_token(params[:id])
     end
   
-end
+end

data/app/model/email.rb

@@ -74,4 +74,4 @@ TXT
     
   end
 
-end
+end

data/app/model/subscriber.rb

@@ -6,7 +6,7 @@ class Subscriber < ActiveRecord::Base
   scope :unsubscribed, where("unsubscribed_at IS NOT NULL").order(:name)
   
   validates :name,  :presence => true
-  validates :email, :format => Devise.email_regexp, :uniqueness => true
+  validates :email, :email => true, :uniqueness => true
   
   before_create :set_token
   
@@ -36,4 +36,4 @@ class Subscriber < ActiveRecord::Base
       write_attribute :token, Digest::SHA1.hexdigest(Time.now.to_s)
     end
   
-end
+end

data/app/validators/email_validator.rb

@@ -0,0 +1,20 @@
+class EmailValidator < ActiveModel::EachValidator
+  def validate_each(record,attribute,value)
+    begin
+      m = Mail::Address.new(value)
+      # We must check that value contains a domain and that value is an email address
+      r = m.domain && m.address == value
+      t = m.__send__(:tree)
+      # We need to dig into treetop
+      # A valid domain must have dot_atom_text elements size > 1
+      # user@localhost is excluded
+      # treetop must respond to domain
+      # We exclude valid email values like <user@localhost.com>
+      # Hence we use m.__send__(tree).domain
+      r &&= (t.domain.dot_atom_text.elements.size > 1)
+    rescue Exception => e   
+      r = false
+    end
+    record.errors[attribute] << (options[:message] || I18n.t(:invalid_email, :scope => [:activerecord, :errors, :messages])) unless r
+  end
+end

data/app/views/admin/emails/_form.html.erb

@@ -44,9 +44,9 @@
   
   <div class="selection left">
 
-    <h3>Select Subscribers:</h3>
-    <%= link_to "select all", "#select-all" %> / 
-    <%= link_to "deselect all", "#deselect-all" %>
+    <h3><%= t("select_subscribers") %>:</h3>
+    <%= link_to t("select_all"), "#select-all" %> / 
+    <%= link_to t("deselect_all"), "#deselect-all" %>
     <ul class="select">
       <% @subscribers.each do |subscriber| %>
         <li class="checkbox">
@@ -60,7 +60,7 @@
   
   <div class="right">
     
-    <h3>Message Details:</h3>
+    <h3><%= t("message_details")%></h3>
     <%= f.field_container :subject do %>
       <%= f.label :subject, t("subject") %><br />
       <%= f.text_field :subject, :class => "title" %>
@@ -75,4 +75,4 @@
     
   </div>
   
-<% end %>
+<% end %>

data/app/views/admin/emails/show.html.erb

@@ -2,13 +2,13 @@
 
 <h1><%= t("show_email") %></h1>
 
-<h5>To: (<%= @email.recipients.length %>)</h5>
+<h5><%= t("to") %>: (<%= @email.recipients.length %>)</h5>
 <p><%= @email.recipient_list %></p>
 
-<h5>Subject:</h5>
+<h5><%= t("subject") %>:</h5>
 <p><%= @email.subject %></p>
 
-<h5>Body:</h5>
+<h5><%= t("body") %>:</h5>
 <%= simple_format @email.body %>
 
 <hr/>

data/app/views/admin/subscribers/_options.html.erb

@@ -1,5 +1,5 @@
 <% if subscriber.active? %>
-  <%= link_to "unsubscribe", unsubscribe_admin_subscriber_path(subscriber) %>
+  <%= link_to t("unsubscribe"), unsubscribe_admin_subscriber_path(subscriber) %>
 <% else %>
-  <%= link_to "resubscribe", resubscribe_admin_subscriber_path(subscriber) %>
-<% end %>
+  <%= link_to t("resubscribe"), resubscribe_admin_subscriber_path(subscriber) %>
+<% end %>

data/app/views/hooks/_footer_left.html.erb

@@ -1 +1 @@
-<%= link_to "sign up for our newsletter", new_subscriber_path %>
+<%= link_to t("sign_up_for_our_newsletter"), new_subscriber_path %>

data/app/views/hooks/_subscriber_static_content.html.erb

@@ -1,3 +1,3 @@
 <h1><%= t('newsletter_sign_up') %></h1>
 
-<p>Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin vel ante a orci tempus eleifend ut et magna. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus luctus urna sed urna ultricies ac tempor dui sagittis. In condimentum facilisis porta. Sed nec diam eu diam mattis viverra. Nulla fringilla, orci ac euismod semper, magna diam porttitor mauris, quis sollicitudin sapien justo in libero. Vestibulum mollis mauris enim. Morbi euismod magna ac lorem rutrum elementum. Donec viverra auctor lobortis. Pellentesque eu est.</p>
+<p><%= t("newsletter_text_signup") %></p>

data/app/views/layouts/email.html.erb

@@ -10,7 +10,6 @@
 	
 </head>
 
-
 <body style="min-width: 500px; margin: 0; padding: 15px; background-color: #ddd; background-image: url(<%= @base_url %>/images/mailer/background.jpg); background-repeat: repeat; font-family: Courier, serif; font-size: 14px; line-height: 19px; color: #575757; -webkit-text-size-adjust: 135%;">
 
   <table cellpadding="5" cellspacing="0" border="0" align="center" width="600" bgcolor="#fff" style="background-color: #fff; border: 1px solid #e0e0e0;">
@@ -23,8 +22,8 @@
           <tr>
             <td><%= link_to image_tag(@base_url + Spree::Config[:logo], :alt => Spree::Config[:site_name], :style => "border: 0"), root_url %></td>
             <td align="right">
-              <p><%= @email.created_at.strftime("%B %d, %Y").downcase.capitalize.gsub(/\s0/, " ") %></p>
-              <p><b>Subject:</b> <%= @email_subject %></p>
+              <p><%= l @email.created_at, :format => "%B %d, %Y" %></p>
+              <p><b><%= t("subject") %>:</b> <%= @email_subject %></p>
             </td>
           </tr>
           <tr>
@@ -36,9 +35,9 @@
         <table cellpadding="15" cellspacing="0" border="0" align="center" width="100%" style="border-top: 1px solid #e0e0e0;">
           <tr>
             <td>
-              <p style="font-size: 12px;">This is a message from the <%= Spree::Config[:site_name] %> if you believe you have recieved this in error please let us know.</p>
-              <p style="font-size: 12px;">Contact: <b><%= mail_to @email.from, @email.from, :style => "color: #5b8fb1;" %></b></p>
-              <p style="font-size: 12px;">If you would like to Unsubscribe <%= link_to "click here", subscriber_url(@subscriber.token), :style => "color: #5b8fb1;" %></p>
+              <p style="font-size: 12px;"><%= t :received_in_error, :site_name => Spree::Config[:site_name] %></p>
+              <p style="font-size: 12px;"><%= t("contact") %>: <b><%= mail_to @email.from, @email.from, :style => "color: #5b8fb1;" %></b></p>
+              <p style="font-size: 12px;"><%= t("unsubscribe_text", :site_name => Spree::Config[:site_name]) %> <%= link_to t("click_here"), subscriber_url(@subscriber.token), :style => "color: #5b8fb1;" %></p>
               <h4 style="padding: 10px 0; margin: 0; border-top: 1px solid #e0e0e0;">
                 <%= link_to Spree::Config[:site_name], root_url, :style => "color: #5b8fb1;" %>
               </h4>  
@@ -60,10 +59,10 @@
       <td align="right">
         <p style="font-size: 12px">
           <% if @link_to_browser %>
-            <%= link_to "click here", @link_to_browser, :style => "color: #5b8fb1;" %>
-            to view this email in your browser
+            <%= link_to t("click_here"), @link_to_browser, :style => "color: #5b8fb1;" %>
+            <%= t("view_in_browser") %>
           <% else %>
-            visit us online at      
+	        <%= t("visit_online") %>      
             <%= link_to Spree::Config[:site_url], root_url, :style => "color: #5b8fb1;" %>
           <% end %>
         </p>
@@ -72,7 +71,10 @@
     <tr>
       <td colspan="2" align="center">
         <br/>
-        <p style="font-size: 11px; color: #999;">This message was sent to <%= mail_to @subscriber.email, @subscriber.email, :style => "color: #5b8fb1;" %> from <%= mail_to @email.from, @email.from, :style => "color: #5b8fb1;" %> on <%= @email.created_at.strftime('%b %d, %Y at %I:%M:%S %p').gsub(/\s0/, ' ') %>.</p>
+        <p style="font-size: 11px; color: #999;"><%= t(:message_sent_to_from_on,
+                                                       :to => @subscriber.email,
+                                                       :from => @email.from,
+                                                       :on => l(@email.created_at, :format => "%b %d, %Y at %I:%M:%S %p")) %>.</p>
       </td>
     </tr>
   </table>

data/app/views/subscribers/show.html.erb

@@ -1,6 +1,6 @@
-<h1>Unsubscribe from our Mailing List</h1>
+<h1><%= t("unsubscribe_title") %></h1>
 
-<p>Please enter your email address below:</p>
+<p><%= t("unsubscribe_mail") %>:</p>
 
 <% token = Digest::SHA1.hexdigest(Time.now.to_s) %>
 <%= form_for @subscriber, :url => unsubscribe_subscriber_path(@subscriber.token) do |form| %>
@@ -10,7 +10,7 @@
     <%= form.hidden_field :token, :value => token %>
   </p>
   <p>
-    <%= form.submit "Unsubscribe" %> or
-    <%= link_to "Cancel", root_path %>
+    <%= form.submit t("unsubscribe") %> or
+    <%= link_to t("cancel"), root_path %>
   </p>
-<% end %>
+<% end %>

data/config/locales/en.yml

@@ -10,10 +10,15 @@ en:
   view_unsubscribed: View Unsubscribed
   view_all_subscribers: View All Subscribers
   
+  resubscribe: Resubscribe
   resubscribe_success: "Successfully Resubscribed"
   resubscribe_failed: "Resubscribe Failed"
   unsubscribe_success: "Successfully Unsubscribed"
+  unsubscribe_success_public: "You were successfully unsubscribed from the mailing list."
   unsubscribe_failed: "Unsubscribed failed"
+  unsubscribe_failed_public: "We're sorry, you could not be unsubscribed at this time."
+  subscribe_thanks: "Thanks for signing up for our newsletter!"
+  subscribe_failed: "Sorry, we could not sign you up."
   
   listing_emails: Listing Emails
   show_email: Show Email
@@ -24,10 +29,38 @@ en:
   
   to: To
   send: Send
+  body: Body
   subject: Subject
   message_body: Message Body
   
   delivery_success: Your email was successfully sent!
   delivery_failed: Sorry, your email could not be sent.
   
-  
+  contact: "Contact"
+  
+  received_in_error: 'This is a message from the %{site_name} if you believe you have received this in error please let us know.'
+  unsubscribe_text: "If you would like to Unsubscribe"
+  click_here: "Click here"
+  view_in_browser: "to view this email in your browser"
+  visit_online: "visit us online at"
+  message_sent_to_from_on: "This message was sent to %{to} from %{from} on %{on}."
+  
+  
+  unsubscribe_title: "Unsubscribe from our Mailing List"
+  unsubscribe_mail: "Please enter your email address below"
+  unsubscribe: "Unsubscribe"
+  
+  select_subscribers: "Select subscribers"
+  select_all: "Select All"
+  deselect_all: "Deselect All"
+  message_details: "Message Details"
+
+  sign_up_for_our_newsletter: "Sign up for our newsletter"
+
+  newsletter_text_signup: "Lorem Ipsum dolor sit amet..."
+
+
+  activerecord:
+    errors:
+      messages:
+        invalid_email: "appears to be invalid"

data/lib/spree_mail/custom_hooks.rb

@@ -1,17 +1,5 @@
 module SpreeMail
   class CustomHooks < Spree::ThemeSupport::HookListener
-    # custom hooks go here
-    
-    #replace :admin_product_form_right, 'admin/hooks/product_form_right'
-    #
-    #replace :cart_item_price, 'hooks/cart_item_price'
-    #replace :cart_item_total, 'hooks/cart_item_total'
-    #
-    #insert_before :inside_cart_form, 'hooks/wholesale_customer_id'
-    #  
-    #insert_after :admin_orders_index_headers, 'admin/hooks/admin_orders_index_headers'
-    #insert_after :admin_orders_index_rows,    'admin/hooks/admin_orders_index_rows'
-    #insert_after :admin_orders_index_search,  'admin/hooks/admin_orders_index_search'
     
     insert_after :footer_left,  'hooks/footer_left'
     insert_after :admin_tabs,   'admin/hooks/subscribers_tab'

data/lib/spree_mail/version.rb

@@ -1,3 +1,3 @@
 module SpreeMail
-  VERSION = "0.40.0.2"
+  VERSION = "0.40.0.3"
 end

data/lib/spree_mail.rb

@@ -1,5 +1,5 @@
+require 'mail'
 require 'mustache'
-require 'spree_mail/version'
 require 'spree_mail/custom_hooks'
 
 module SpreeMail
@@ -9,16 +9,8 @@ module SpreeMail
     config.autoload_paths += %W(#{config.root}/lib)
 
     initializer "static assets" do |app|
-      app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{config.root}/public"
+      app.middleware.insert_before ::Rack::Lock, ::ActionDispatch::Static, "#{config.root}/public"
     end
 
-    #def self.activate
-    #  #Dir["../app/**/*.rb"].each do |c|
-    #  #  puts c
-    #  #  #Rails.env.production? ? require(c) : load(c)
-    #  #end
-    #end
-
-    #config.to_prepare &method(:activate).to_proc
   end
 end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 40
   - 0
-  - 2
-  version: 0.40.0.2
+  - 3
+  version: 0.40.0.3
 platform: ruby
 authors: 
 - Spencer Steffen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-27 00:00:00 -08:00
+date: 2011-01-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,9 +28,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 40
-        - 2
-        version: 0.40.2
+        - 30
+        - 1
+        version: 0.30.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,9 +43,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 40
-        - 2
-        version: 0.40.2
+        - 30
+        - 1
+        version: 0.30.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,20 @@ dependencies:
         version: 0.12.0
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :runtime
+  version_requirements: *id004
 description: Spree Mail extends Spree by adding a mailing list subscriber model, sign up forms and an admin to send messages.
 email: 
 - spencer@citrusme.com
@@ -87,6 +101,7 @@ files:
 - app/mailers/email_mailer.rb
 - app/model/email.rb
 - app/model/subscriber.rb
+- app/validators/email_validator.rb
 - app/views/admin/emails/_form.html.erb
 - app/views/admin/emails/edit.html.erb
 - app/views/admin/emails/index.html.erb