alchemy_crm 2.0.0

data/app/controllers/alchemy_crm/mailings_controller.rb

@@ -0,0 +1,20 @@
+module AlchemyCrm
+	class MailingsController < AlchemyCrm::BaseController
+
+		def show
+			@mailing = Mailing.find_by_sha1(params[:m])
+			if @mailing.nil? && !params[:id].blank?
+				@mailing = Mailing.find(params[:id])
+			end
+			@page = @mailing.page
+			if params[:r].present?
+				@recipient = @mailing.recipients.find_by_sha1(params[:r])
+				@contact = @recipient.contact || Contact.new_from_recipient(@recipient)
+			else
+				@contact = Contact.fake
+				@recipient = Recipient.new_from_contact(@contact)
+			end
+		end
+
+	end
+end

data/app/controllers/alchemy_crm/recipients_controller.rb

@@ -0,0 +1,35 @@
+module AlchemyCrm
+	class RecipientsController < AlchemyCrm::BaseController
+
+		def reads
+			recipient = Recipient.find_by_sha1(params[:h])
+			if recipient && !recipient.read?
+				recipient.reads!
+			end
+			render :nothing => true
+		end
+
+		def reacts
+			recipient = Recipient.find_by_sha1(params[:h])
+			if recipient
+				recipient.reacts!({
+					:page_id => params[:page_id],
+					:element_id => params[:element_id],
+					:url => params[:r]
+				})
+			end
+			if params[:r].present?
+				redirect_to params[:r]
+			else
+				page = Alchemy::Page.includes(:elements).find(params[:page_id])
+				element = page.elements.find_by_id(params[:element_id])
+				redirect_to alchemy.show_page_url(
+					:urlname => page.urlname,
+					:lang => multi_language? ? page.language_code : nil,
+					:anchor => element ? element.dom_id : nil
+				)
+			end
+		end
+
+	end
+end

data/app/controllers/alchemy_crm/subscriptions_controller.rb

@@ -0,0 +1,57 @@
+# Caution: Not yet implemmented!
+module AlchemyCrm
+	class SubscriptionsController < AlchemyCrm::BaseController
+
+		before_filter :load_contact, :except => :deliver_subscriptions_overview
+
+		def index
+			@page = Alchemy::Page.find_by_page_layout('newsletter_views')
+			@root_page = @page.get_language_root
+			render :template => 'alchemy/pages/show', :layout => layout_for_page
+		end
+
+		def new
+
+		end
+
+		def create
+			
+		end
+
+		def edit
+
+		end
+
+		def update
+			
+		end
+
+		def destroy
+			@subscription = @contact.subscriptions.find(params[:subscription_id])
+			@subscription.destroy
+			flash[:notice] = t(:subscription_destroyed)
+			@page = Alchemy::Page.find_by_page_layout('newsletter_views')
+			@root_page = @page.get_language_root
+			render :template => 'alchemy/pages/show', :layout => layout_for_page
+		end
+
+		def overview
+			@contact = Contact.find_by_email(params[:email])
+			if @contact
+				SubscriptionsMailer.overview_mail.deliver(@contact, @element)
+				flash[:notice] = t(:send_subscriptions_overview_via_email)
+				redirect_to :index
+			else
+				flash[:error] = t(:no_subscriber_found)
+				render :index
+			end
+		end
+		
+	private
+
+		def load_contact
+			@contact = Contact.find_by_email_sha1(params[:token])
+		end
+
+	end
+end

data/app/helpers/alchemy/pages_helper_extension.rb

@@ -0,0 +1,18 @@
+Alchemy::PagesHelper.module_eval do
+
+	def render_page_layout(options={})
+		default_options = {
+			:render_format => "html"
+		}
+		options = default_options.merge(options)
+		if @page.layout_description['newsletter']
+			render :partial => "alchemy/newsletter_layouts/#{@page.page_layout.downcase}.#{options[:render_format]}.erb"
+		else
+			render :partial => "alchemy/page_layouts/#{@page.page_layout.downcase}.#{options[:render_format]}.erb"
+		end
+	rescue ActionView::MissingTemplate
+		warning("PageLayout: '#{@page.page_layout}' not found. Rendering standard page_layout.")
+		render :partial => "alchemy/page_layouts/standard"
+	end
+
+end

data/app/helpers/alchemy_crm/admin/base_helper.rb

@@ -0,0 +1,12 @@
+module AlchemyCrm
+	module Admin
+		module BaseHelper
+
+			# Renders a <small> html tag with the contact count for current tag in it.
+			def contact_count_from_tag(tag)
+				content_tag('small', "(#{Contact.tagged_with(tag).count})")
+			end
+
+		end
+	end
+end

data/app/helpers/alchemy_crm/mailings_helper.rb

@@ -0,0 +1,190 @@
+module AlchemyCrm
+	module MailingsHelper
+
+		include Alchemy::PagesHelper
+
+		# Renders the newsletter layout for +@mailing.page+
+		# 
+		# The +@mailing.page.page_layout+ must have a +newsletter_layout+ prefix.
+		# The partial itself is named without the +newsletter_layout+ prefix.
+		# The partial resists in +/app/views/newsletter_layouts/+
+		# 
+		# === Example:
+		# 
+		# Given a mailing page with a +standard+ layout has partials named +_standard.html.erb+ and +_standard.text.erb+
+		# But the page page_layout attribute is +newsletter_layout_standard+
+		# 
+		def render_newsletter_layout(options={})
+			options = {:format => 'html'}.update(options)
+			render "alchemy/newsletter_layouts/#{@page.page_layout.downcase.gsub(Regexp.new(Mailing::MAILING_PAGE_LAYOUT_PREFIX), '')}.#{options[:format]}.erb"
+		end
+
+		# Renders the tracking image that records the receivement of the mailing inside the mail client.
+		def render_tracking_image
+			return "" if @preview_mode || @recipient.nil?
+			image_tag(
+				alchemy_crm.recipient_reads_url(:h => @recipient.sha1, :host => current_host),
+				:style => "width: 0; height: 0; display: none",
+				:width => 0,
+				:height => 0,
+				:alt => ''
+			)
+		end
+
+		# Renders a link to the unsubscribe page.
+		# 
+		# Please notice that you have to create a page with a +newsletter_signout+ page layout and this page has to be public.
+		# 
+		# The text inside the link is translated.
+		# 
+		# === Example translation:
+		# 
+		#   de:
+		#     alchemy_crm:
+		#       unsubscribe: 'abmelden'
+		# 
+		# === Options:
+		# 
+		#   html_options [Hash] # Passed to the link. Useful for styling the link with inline css.
+		# 
+		# You can pass an optional block thats gets passed to +link_to+
+		# 
+		def link_to_unsubscribe_page(html_options={})
+			text = ::I18n.t(:unsubscribe, :scope => :alchemy_crm)
+			if block_given?
+				link_to(url_for_unsubscribe_page, html_options) do
+					yield
+				end
+			else
+				link_to(text, url_for_unsubscribe_page, html_options)
+			end
+		end
+
+		# Returns the url for the unsubscribe page.
+		# Used by +link_to_unsubscribe_page+ helper and inside of plain text views of mailings.
+		def url_for_unsubscribe_page
+			unsubscribe_page = Alchemy::Page.find_by_page_layout('newsletter_signout')
+			if unsubscribe_page.nil?
+				raise('Newsletter Signout Page Could Not Be Found. Please create one!')
+			else
+				alchemy.show_page_url(
+					:urlname => unsubscribe_page.urlname,
+					:lang => multi_language? ? unsubscribe_page.language_code : nil,
+					:email => @contact ? @contact.email : nil,
+					:host => current_host
+				)
+			end
+		end
+
+		# Renders a notice to open the mailing inside a browser, if it does not displays correctly.
+		# 
+		# The notice and the link inside are translated via I18n.
+		# 
+		# === Example translation:
+		# 
+		#   de:
+		#     alchemy_crm:
+		#       here: 'hier'
+		#       read_in_browser_notice: "Falls der Newsletter nicht richtig dargestellt wird, klicken Sie bitte %{link}."
+		# 
+		# === Options:
+		# 
+		#   html_options [Hash] # Passed to the link. Useful for styling the link with inline css.
+		# 
+		def read_in_browser_notice(html_options = {})
+			return "" if @recipient.nil?
+			::I18n.t(
+				:read_in_browser_notice,
+				:link => link_to(
+					::I18n.t(:here, :scope => :alchemy_crm),
+					alchemy_crm.show_mailing_url(
+						:m => @mailing.sha1,
+						:r => @recipient.sha1,
+						:host => current_host
+					),
+					html_options,
+					:host => current_host
+				),
+				:scope => :alchemy_crm
+			).html_safe
+		end
+
+		# Use this helper to render an image from your server.
+		# 
+		# The notice and the link inside are translated via I18n.
+		# 
+		# === Example:
+		# 
+		#   <%= image_from_server_tag('logo.png', :alt => 'Logo', :width => 230, :height => 116, :style => 'outline:none; text-decoration:none; -ms-interpolation-mode: bicubic;') %>
+		#   => <img src="http://example.com/assets/logo.png"
+		#  
+		# === Options:
+		# 
+		#   html_options [Hash] # Passed to the image_tag helper.
+		# 
+		def image_from_server_tag(image, html_options={})
+			image_tag([current_server, Rails.application.config.assets.prefix, image].join('/'), html_options)
+		end
+
+		# Renders a link that tracks the reaction of a recipient.
+		# 
+		# After getting tracked the controller redirects to the url passed in.
+		# 
+		# It has the same arguments that the Rails +link_to+ helper has.
+		# 
+		# === Example:
+		# 
+		#   <%= tracked_link_tag('read more', :r => 'http://example.com/my-article', :style => 'color: black') %>
+		#   => <a href="http://example.com/recipient/s3cr3tSh41/reacts?r=http%3A%2F%2Fexample.com%2Fmy-article" style="color: black">
+		# 
+		# *NOTE:* You can even pass a block like you could for +link_to+ helper from Rails.
+		# 
+		def tracked_link_tag(*args)
+			if block_given?
+				link_to(tracked_url_for(args.first), args.last) do
+					yield
+				end
+			else
+				link_to(args.first, tracked_url_for(args[1]), args.last)
+			end
+		end
+
+		# Returns the url for tracking a link that's clicked inside a mailing.
+		# Used by +tracked_link_tag+ helper and plain text mailing views.
+		def tracked_url_for(redirect_url)
+			alchemy_crm.recipient_reacts_url(:h => @recipient.sha1, :r => redirect_url, :host => current_host)
+		end
+
+		def current_host
+			(defined?(request)).nil? || request.nil? ? @options[:host] : request.host
+		end
+
+		def current_server
+			if (defined?(request)).nil? || request.nil?
+				protocol = @options.nil? || @options[:protocol].blank? ? 'http://' : @options[:protocol]
+			else
+				protocol = request.protocol
+			end
+			if (defined?(request)).nil? || request.nil?
+				if @options
+					port = @options[:port] && @options[:port] != 80 ? @options[:port] : nil
+				else
+					port = nil
+				end
+			else
+				port = request.port != 80 ? request.port : nil
+			end
+			[protocol, current_host, port ? ":#{port}" : nil].join
+		end
+
+		def current_language
+			return @language if @language
+			if @options && @options[:language_id]
+				@language = Alchemy::Language.find(@options[:language_id])
+			else
+				@language = Alchemy::Language.get_default
+			end
+		end
+
+	end
+end

data/app/mailers/alchemy_crm/bounce_receiver.rb

@@ -0,0 +1,13 @@
+module AlchemyCrm
+	class BounceReceiver < ActionMailer::Base
+
+		def receive(email)
+			return unless email.content_type == "multipart/report"
+			bounce = BouncedDelivery.from_email(email)
+			recipient = Recipient.find_by_message_id(bounce.original_message_id)
+			recipient.bounced = (bounce.status == "Failure")
+			recipient.save!
+		end
+
+	end
+end

data/app/mailers/alchemy_crm/contacts_mailer.rb

@@ -0,0 +1,26 @@
+module AlchemyCrm
+	class ContactsMailer < ActionMailer::Base
+
+		def signup_mail(contact, page)
+			@contact = contact
+			@newsletter_ids = @contact.subscriptions.collect(&:newsletter_id)
+			@element = page.elements.where(:name => 'newsletter_signup_mail').first
+			mail(
+				:from => @element.ingredient('mail_from'),
+				:to => contact.email,
+				:subject => @element.ingredient('subject')
+			)
+		end
+
+		def signout_mail(contact, page)
+			@element = page.elements.where(:name => 'newsletter_signout_mail').first
+			@contact = contact
+			mail(
+				:from => @element.ingredient("mail_from"),
+				:to => contact.email,
+				:subject => @element.ingredient('subject')
+			)
+		end
+
+	end
+end

data/app/mailers/alchemy_crm/mailings_mailer.rb

@@ -0,0 +1,48 @@
+module AlchemyCrm
+	class MailingsMailer < ActionMailer::Base
+
+		default :from => AlchemyCrm::Config.get(:mail_from)
+
+		helper "AlchemyCrm::Mailings"
+		helper_method :logged_in?, :configuration
+
+		# Renders the email sent to the mailing recipient
+		# It takes the layout from +layouts/alchemy_crm/mailings.erb+ and renders a html and a text part from it.
+		def build(mailing, recipient, options = {})
+			@options = options
+			::I18n.locale = @options[:locale]
+			@mailing = mailing
+			@page = @mailing.page
+			@recipient = recipient
+			@contact = @recipient.contact || Contact.new_from_recipient(@recipient)
+
+			mail(:to => @recipient.mail_to, :subject => mailing.subject) do |format|
+				format.html { render("layouts/alchemy_crm/mailings.html") }
+				format.text { render("layouts/alchemy_crm/mailings.text") }
+			end
+		end
+
+		# Faking that we are not logged in
+		def logged_in?
+			false
+		end
+
+		# Proxy to Alchemy config for view helpers
+		def configuration(name)
+			Alchemy::Config.get(name)
+		end
+
+		# Simple session object that contains the language id for view helpers.
+		def session
+			{
+				:language_id => @options[:language_id]
+			}
+		end
+
+		# Setting default url options for rails url_for helpers.
+		def default_url_options
+			{:host => @options[:host], :port => @options[:port]}
+		end
+
+	end
+end

data/app/mailers/alchemy_crm/subscriptions_mailer.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+module AlchemyCrm
+	class SubscriptionsMailer < ActionMailer::Base
+
+		def overview_mail(contact, element)
+			@contact = contact
+			@subscriptions = contact.subscriptions
+			@element = element
+			mail(
+				:from => element.ingredient("mail_from"),
+				:to => contact.email,
+				:subject => element.ingredient("mail_subject")
+			)
+		end
+
+	end
+end