spree_email_to_friend 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+spec/test_app

data/README.markdown

@@ -0,0 +1,3 @@
+= Email To Friend
+
+Description goes here

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc "Default Task"
+task :default => [ :spec ]
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+desc "Regenerates a rails 3 app for testing"
+task :test_app do
+  SPREE_PATH = ENV['SPREE_PATH']
+  raise "SPREE_PATH should be specified" unless SPREE_PATH
+  require File.join(SPREE_PATH, 'lib/generators/spree/test_app_generator')
+  class AuthTestAppGenerator < Spree::Generators::TestAppGenerator
+    def tweak_gemfile
+      append_file 'Gemfile' do
+<<-gems
+gem 'spree_core', :path => '#{File.join(SPREE_PATH, 'core')}'
+gem 'spree_auth', :path => '#{File.join(SPREE_PATH, 'auth')}'
+gem 'spree_email_to_friend', :path => '#{File.dirname(__FILE__)}'
+gems
+      end
+    end
+
+    def install_gems
+      system("cd spec/test_app && rake spree_core:install")
+      system("cd spec/test_app && rake spree_auth:install")
+    end
+
+    def migrate_db
+      run_migrations
+    end
+  end
+  AuthTestAppGenerator.start
+end
+
+namespace :test_app do
+  desc 'Rebuild test and cucumber databases'
+  task :rebuild_dbs do
+    system("cd spec/test_app && rake db:drop db:migrate RAILS_ENV=test && rake db:drop db:migrate RAILS_ENV=cucumber")
+  end
+end

data/app/controllers/admin/captcha_settings_controller.rb

@@ -0,0 +1,11 @@
+class Admin::CaptchaSettingsController < Admin::BaseController
+  def update
+    Spree::Captcha::Config.set(params[:preferences])
+
+    respond_to do |format|
+      format.html {
+        redirect_to admin_captcha_settings_path
+      }
+    end
+  end
+end

data/app/controllers/email_sender_controller.rb

@@ -0,0 +1,53 @@
+class EmailSenderController < Spree::BaseController
+  before_filter :find_object
+
+  def send_mail
+    if request.get?
+      @mail_to_friend = MailToFriend.new(:sender_email => current_user.try(:email))
+    else
+      mail_to_friend
+    end
+  end
+
+  private
+
+  def mail_to_friend
+    @mail_to_friend = MailToFriend.new(params[:mail_to_friend])
+    respond_to do |format|
+      format.html do
+        captcha_passed = !Spree::Captcha::Config[:use_captcha] || verify_recaptcha(:private_key => Spree::Captcha::Config[:private_key])
+        if @mail_to_friend.valid? && captcha_passed
+          flash[:notice] = I18n.t('email_to_friend.mail_sent_to', :email => @mail_to_friend.recipient_email).html_safe
+          flash[:notice] << ActionController::Base.helpers.link_to(I18n.t('email_to_friend.send_to_other'), email_to_friend_path(@object.class.name.downcase, @object)).html_safe
+
+          send_message(@object, @mail_to_friend)
+
+          method_name = "after_delivering_#{@object.class.name.downcase}_mail"
+          send(method_name) if respond_to?(method_name, true)
+
+          redirect_to @object
+        else
+          render :action => :send_mail
+        end
+      end
+    end
+  end
+
+  #extract send message to make easier to override
+  def send_message(object, mail_to_friend)
+    ToFriendMailer.deliver_mail_to_friend(object,@mail_to_friend)
+  end
+
+  def find_object
+    class_name = params[:type].titleize.constantize
+    return false if params[:id].blank?
+    @object = class_name.find_by_id(params[:id])
+    if class_name.respond_to?('find_by_permalink')
+      @object ||= class_name.find_by_permalink(params[:id])
+    end
+    if class_name.respond_to?('get_by_param')
+      @object ||= class_name.get_by_param(params[:id])
+    end
+  end
+
+end

data/app/mailers/to_friend_mailer.rb

@@ -0,0 +1,21 @@
+class ToFriendMailer < ActionMailer::Base
+  default_url_options[:host] = Spree::Config[:site_url]
+  default :from => Spree::Config[:mails_from]
+
+  def mail_to_friend(object, mail)
+    @object = object
+    @mail = mail
+    opts = {}
+
+    if mail.hide_recipients && Spree::Config[:hidden_recipients_to_address]
+      opts[:to] = Spree::Config[:hidden_recipients_to_address]
+      opts[:bcc] = mail.recipient_email
+    else
+      opts[:to] = mail.recipient_email
+    end
+    opts[:subject] =  mail.subject
+    opts[:reply_to] = mail.sender_email
+
+    mail(opts)
+  end
+end

data/app/models/captcha_configuration.rb

@@ -0,0 +1,9 @@
+class CaptchaConfiguration < Configuration
+  THEMES = ['red', 'white', 'blackglass', 'clean', 'custom']
+
+  # this keys works for localhost
+  preference :private_key, :string, :default => '6LfIsgEAAAAAAGfB6Z0lEUtdL3GVuBkRa9cYlMZz'
+  preference :public_key, :string, :default => '6LfIsgEAAAAAALpT20eiC3RslZQmmCbiNS-AUvSe'
+  preference :theme, :string, :default => 'red'
+  preference :use_captcha, :boolean, :default => true
+end

data/app/models/mail_to_friend.rb

@@ -0,0 +1,46 @@
+class MailToFriend
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+  attr_accessor :subject, :sender_name, :sender_email, :recipient_name, :recipient_email, :message, :recipients, :invalid_recipients, :hide_recipients
+
+  EMAILREGEX = /^[-a-z0-9_+\.]+\@([-a-z0-9]+\.)+[a-z0-9]{2,8}$/i
+
+  validates :subject, :presence => true
+  validates :sender_name, :presence => true
+  validates :recipient_name, :presence => true, :unless => :is_multi
+  validates :sender_email, :format => { :with => EMAILREGEX }
+  validates :recipients, :length => {:minimum => 1, :message => "must contain at least one valid email address"}
+  validates :invalid_recipients, :length => {:maximum => 0, :message => "must be removed"}
+
+  def initialize(opts = {})
+    @subject      = opts[:subject]      || I18n.t('email_to_friend.you_would_like_this')
+    @sender_email = opts[:sender_email] || ' '
+    @sender_name  = opts[:sender_name]  || @sender_email.split('@', 2)[0].titleize
+
+    @recipients = []
+    @invalid_recipients = []
+
+    @recipient_email = (opts[:recipient_email] || '').gsub(';', ',').gsub(/\s/ , '')
+    @recipient_email.split(',').each do |address|
+      if address =~ EMAILREGEX
+         @recipients << address
+      else
+        @invalid_recipients << address
+      end
+    end
+
+    @recipient_name = opts[:recipient_name]
+    @recipient_name ||= @recipients[0].split('@', 2)[0].titleize unless @recipients.empty?
+
+    @hide_recipients = opts[:hide_recipients] || false
+    @message = opts[:message]
+  end
+
+  def persisted?
+    false
+  end
+
+  def is_multi
+    (@recipients.size + @invalid_recipients.size) > 1
+  end
+end

data/app/views/admin/captcha_settings/edit.html.erb

@@ -0,0 +1,22 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("captcha.captcha_settings") %></h1>
+
+<% form_tag(admin_captcha_settings_path, :method => :put) do -%>
+  <p>
+    <label><%= t("captcha.public_key") %>:</label>
+    <%= text_field_tag('preferences[public_key]', Spree::Captcha::Config[:public_key], :size => 40) %>
+  </p>
+  <p>
+    <label><%= t('captcha.private_key') %>:</label>
+    <%= text_field_tag('preferences[private_key]', Spree::Captcha::Config[:private_key], :size => 40)%>
+  </p>
+  <p>
+    <label><%= t('captcha.theme') %>:</label>
+    <%= select_tag('preferences[theme]', options_for_select(CaptchaConfiguration::THEMES, Spree::Captcha::Config[:theme])) %>
+  </p>
+  <p class="form-buttons">
+    <%= button t('update') %>
+    <%= t("or") %> <%= link_to t("cancel"), admin_captcha_settings_url %>
+  </p>
+<% end -%>

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

@@ -0,0 +1,22 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("captcha.captcha_settings") %></h1>
+
+<table>
+  <tr>
+    <th scope="row"><%= t("captcha.public_key") %>:</th>
+    <td><%= Spree::Captcha::Config[:public_key] %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("captcha.private_key") %>:</th>
+    <td><%=  Spree::Captcha::Config[:private_key] %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("captcha.theme") %>:</th>
+    <td><%=  Spree::Captcha::Config[:theme] %></td>
+  </tr>
+</table>
+
+<p>
+  <%= link_to_with_icon('edit', t("edit"), edit_admin_captcha_settings_path) %>
+</p>

data/app/views/email_sender/send_mail.html.erb

@@ -0,0 +1,33 @@
+<h1><%= t('email_to_friend.tell_about', :product => @object.name) %></h1>
+
+<%= form_for(@mail_to_friend, :url => "") do |f| -%>
+  <%= render "shared/error_messages", :target => @mail_to_friend %>
+  <%= hook :send_mail_fields, {:f => f} do %>
+  <p>
+    <%= f.label(:sender_name, t('email_to_friend.sender_name')) %><br/>
+    <%= f.text_field(:sender_name) %>
+  </p>
+  <p>
+    <%= f.label(:sender_email, t('email_to_friend.sender_email')) %><br/>
+    <%= f.text_field(:sender_email) %>
+  </p>
+  <p>
+    <%= f.label(:recipient_name, t('email_to_friend.recipient_name')) %><br/>
+    <%= f.text_field(:recipient_name) %>
+  </p>
+  <p>
+    <%= f.label(:recipient_email, t('email_to_friend.recipient_email')) %><br/>
+    <%= f.text_field(:recipient_email) %>
+  </p>
+  <p>
+    <%= f.label(:message, t('email_to_friend.message')) %><br/>
+    <%= f.text_area(:message) %>
+  </p>
+  <% end %>
+  <% if Spree::Captcha::Config[:use_captcha] %>
+    <%= recaptcha_tags :public_key => Spree::Captcha::Config[:public_key], :display => {:theme => Spree::Captcha::Config[:theme]} %>
+  <% end %>
+  <p>
+    <%= f.submit(t('email_to_friend.send_message')) %>
+  </p>
+<% end -%>

data/app/views/products/_mail_to_friend.html.erb

@@ -0,0 +1,16 @@
+<%= mail.recipient_name %>,
+
+I think you would like this item:
+
+  * <%= product.name %>
+
+<% unless mail.message.blank? -%>
+<%= mail.message %>
+<% end -%>
+
+<%= mail.sender_name %>
+
+Click the link below to view the <%= product.name %> page.
+<%= product_url(product) %>
+
+For more online shopping, visit <%= products_url %>

data/app/views/to_friend_mailer/mail_to_friend.erb

@@ -0,0 +1,3 @@
+<% object_sym = @object.class.name.downcase %>
+<%= render :partial => "#{object_sym.pluralize}/mail_to_friend", 
+           :locals => {object_sym.to_sym => @object, :mail => @mail} %>

data/config/locales/en.yml

@@ -0,0 +1,22 @@
+---
+en:
+  email_to_friend:
+    send_to_friend: "Email a friend"
+    tell_about: "Tell a friend about: %{product}"
+    sender_name: "Your name"
+    sender_email: "Your email address"
+    recipient_name: "Your friend's name"
+    recipient_email: "Your friend's email address"
+    recipient_emails: "Email addresses (comma separated)"
+    message: "Message"
+    send_message: "Tell your friend!"
+    mail_sent_to: "Mail sent to %{email} "
+    send_to_other: "Send to other friend"
+    you_would_like_this: "I think you would like this item"
+
+  captcha:
+    captcha_settings: "Captcha Settings"
+    public_key: "Public key"
+    private_key: "Private key"
+    manage_keys: "Manage your (re)captcha keys"
+    theme: "Theme"

data/config/locales/es.yml

@@ -0,0 +1,20 @@
+---
+es:
+  email_to_friend:
+    send_to_friend: "Enviar a un amigo"
+    tell_about: "Enviar {{product}} a un amigo"
+    sender_name: "Tu nombre"
+    sender_email: "Tu dirección de correo"
+    recipient_name: "Nombre de tu amigo"
+    recipient_email: "Dirección de correo de tu amigo"
+    message: "Mensaje"
+    send_message: "¡Enviar a un amigo!"
+    mail_sent_to: "Mensaje enviado a {{email}} "
+    send_to_other: "Enviar a otro amigo"
+    you_would_like_this: "Creo que este artículo te gustará"
+  captcha:
+    captcha_settings: "Configuracion de Captcha"
+    public_key: "Llave pública"
+    private_key: "Llave privada"
+    manage_keys: "Administrar tus llaves de recaptcha."
+    theme: "Tema"

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+
+  match "/email_to_friend/:type/:id" => 'email_sender#send_mail', :as => :email_to_friend
+
+  namespace :admin do
+    resource :captcha_settings
+  end
+
+end

data/lib/spree/captcha/config.rb

@@ -0,0 +1,10 @@
+module Spree::Captcha
+  class Config < Spree::Config
+    class << self
+      def instance
+        return nil unless ActiveRecord::Base.connection.tables.include?('configurations')
+        CaptchaConfiguration.find_or_create_by_name("Captcha configuration")
+      end
+    end
+  end
+end

data/lib/spree_email_to_friend.rb

@@ -0,0 +1,18 @@
+require 'spree_core'
+require 'spree_email_to_friend_hooks'
+require 'recaptcha/rails'
+
+module SpreeEmailToFriend
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env == "production" ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_email_to_friend_hooks.rb

@@ -0,0 +1,11 @@
+class SpreeEmailToFriendHooks < Spree::ThemeSupport::HookListener
+  insert_after :admin_configurations_menu do
+    "<%= configurations_menu_item(I18n.t('captcha.captcha_settings'), admin_captcha_settings_path, I18n.t('captcha.manage_keys')) %>"
+  end
+
+  insert_after :product_description do
+    %(<p class="email_to_friend">
+        <%= link_to(t('email_to_friend.send_to_friend'), email_to_friend_url('product', @product)) %>
+    </p>)
+  end
+end

data/spec/controllers/email_sender_controller_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe EmailSenderController do
+
+  #Delete this example and add some real ones
+  it "should use EmailSenderController" do
+    controller.should be_an_instance_of(EmailSenderController)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../test_app/config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end
+

data/spree_email_to_friend.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_email_to_friend'
+  s.version     = '1.0.0'
+  s.summary     = 'Spree extension to send product recommendations to friends'
+  s.homepage    = 'https://github.com/calas/spree-email-to-friend'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author        = 'Jorge Calás Lozano, Roman Smirnov'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.has_rdoc = true
+
+  s.add_dependency('spree_core', '>= 0.30.1')
+  s.add_dependency('spree_auth', '>= 0.30.1')
+  s.add_dependency('recaptcha', '>= 0.3.1')
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: spree_email_to_friend
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- "Jorge Cal\xC3\xA1s Lozano, Roman Smirnov"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 101
+        segments: 
+        - 0
+        - 30
+        - 1
+        version: 0.30.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: spree_auth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 101
+        segments: 
+        - 0
+        - 30
+        - 1
+        version: 0.30.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: recaptcha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- app/controllers/admin/captcha_settings_controller.rb
+- app/controllers/email_sender_controller.rb
+- app/mailers/to_friend_mailer.rb
+- app/models/captcha_configuration.rb
+- app/models/mail_to_friend.rb
+- app/views/admin/captcha_settings/edit.html.erb
+- app/views/admin/captcha_settings/show.html.erb
+- app/views/email_sender/send_mail.html.erb
+- app/views/products/_mail_to_friend.html.erb
+- app/views/to_friend_mailer/mail_to_friend.erb
+- config/locales/en.yml
+- config/locales/es.yml
+- config/routes.rb
+- lib/spree/captcha/config.rb
+- lib/spree_email_to_friend.rb
+- lib/spree_email_to_friend_hooks.rb
+- spec/controllers/email_sender_controller_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spree_email_to_friend.gemspec
+has_rdoc: true
+homepage: https://github.com/calas/spree-email-to-friend
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Spree extension to send product recommendations to friends
+test_files: 
+- spec/controllers/email_sender_controller_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb