alchemy_crm 2.0.0

data/lib/alchemy_crm/i18n_helpers.rb

@@ -0,0 +1,35 @@
+module AlchemyCrm
+	module I18nHelpers
+
+		def self.included(controller)
+			controller.send(:helper_method, [:i18n_t, :translate_model_attribute, :alchemy_crm_t])
+		end
+
+		# This is a proxy to the ::I18n.t method with an alchem_crm scope.
+		# 
+		# We can't use +t+ in views, because Alchemy overrides it and scopes everything into the +alchemy+ namespace.
+		# 
+		# === NOTE:
+		# 
+		# The keys are scoped into +alchemy_crm+ namespace.
+		# Even if you pass a scope this is scoped under +alchemy_crm+.
+		# 
+		def alchemy_crm_t(key, options={})
+			scope = options[:scope].blank? ? 'alchemy_crm' : "alchemy_crm.#{options.delete(:scope)}"
+			::I18n.t(key, {:scope => scope, :default => key.to_s.humanize}.merge(options))
+		end
+
+		# This is a proxy to the ::I18n.t method without any scope.
+		# 
+		# We can't use +t+ in views, because Alchemy overrides it and scopes everything into the +alchemy+ namespace.
+		# 
+		def i18n_t(key, options={})
+			::I18n.t(key, options.merge(:default => key.to_s.humanize))
+		end
+
+		def translate_model_attribute(model, key)
+			"alchemy_crm/#{model.to_s.underscore}".classify.constantize.human_attribute_name(key)
+		end
+
+	end
+end

data/lib/alchemy_crm/newsletter_layout.rb

@@ -0,0 +1,40 @@
+module AlchemyCrm
+	class NewsletterLayout
+
+		def self.get_layouts_for_select()
+			all
+			@@newsletter_layouts.map do |l|
+				[display_name_for(l["name"]), l["name"]]
+			end
+		end
+
+		def self.all
+			@@newsletter_layouts ||= Alchemy::PageLayout.get_all_by_attributes(:newsletter => true)
+		end
+
+		def self.get(name)
+			all
+			@@newsletter_layouts.detect { |l| l['name'] == name.to_s }
+		end
+
+		def self.display_name_for(name)
+			Alchemy::I18n.t(name, :scope => :page_layout_names, :default => name.to_s.camelcase)
+		end
+
+	end
+end
+
+Alchemy::PageLayout.class_eval do
+
+	def self.selectable_layouts(language_id, layoutpage = false)
+		class_variable_get('@@definitions').select do |layout|
+			used = layout["unique"] && has_a_page_this_layout?(layout["name"], language_id)
+			if layoutpage
+				layout["layoutpage"] == true && !used && layout["newsletter"] != true
+			else
+				layout["layoutpage"] != true && !used && layout["newsletter"] != true
+			end
+		end
+	end
+
+end

data/lib/alchemy_crm/seeder.rb

@@ -0,0 +1,30 @@
+module AlchemyCrm
+	class Seeder
+
+		def self.seed!
+			puts "Seeding database for Alchemy Mailing Module"
+			root = Alchemy::Page.root
+			lang = Alchemy::Language.get_default
+			if root.nil? || lang.nil?
+				puts "== Aborting! Not all dependencies found. Did you ran the Alchemy seeder?"
+			else
+				mailing_root = Alchemy::Page.find_or_create_by_name(
+					:name => "Alchemy CRM Rootpage",
+					:page_layout => 'alchemy_crm_rootpage',
+					:do_not_autogenerate => true,
+					:do_not_sweep => true,
+					:language => lang,
+					:parent_id => root.id
+				)
+				if mailing_root.new_record?
+					mailing_root.save!
+					mailing_root.move_to_child_of root
+					puts "== Success! Mailing root page created"
+				else
+					puts "== Skipping! Already created mailing root page."
+				end
+			end
+		end
+
+	end
+end

data/lib/alchemy_crm/version.rb

@@ -0,0 +1,3 @@
+module AlchemyCrm
+	VERSION = "2.0.0"
+end

data/lib/generators/alchemy_crm/scaffold/files/_standard.html.erb

@@ -0,0 +1 @@
+<%= render_elements %>

data/lib/generators/alchemy_crm/scaffold/files/_standard.text.erb

@@ -0,0 +1 @@
+<%= render_elements(:render_format => 'text') %>

data/lib/generators/alchemy_crm/scaffold/files/elements.yml

@@ -0,0 +1,51 @@
+# These elements are added by the Alchemy CRM module.
+
+- name: newsletter_signup_form
+  unique: true
+  contents:
+  - name: choose_newsletter_text
+    type: EssenceRichtext
+  - name: signed_up_text
+    type: EssenceRichtext
+    validate: [presence]
+  - name: verified_text
+    type: EssenceRichtext
+    validate: [presence]
+
+- name: newsletter_signup_mail
+  unique: true
+  contents:
+  - name: mail_from
+    type: EssenceText
+    validate: [presence]
+  - name: subject
+    type: EssenceText
+    validate: [presence]
+    take_me_for_preview: true
+  - name: text
+    type: EssenceRichtext
+    validate: [presence]
+
+- name: newsletter_signout_form
+  unique: true
+  contents:
+  - name: signed_out_text
+    type: EssenceRichtext
+    validate: [presence]
+  - name: disabled_text
+    type: EssenceRichtext
+    validate: [presence]
+
+- name: newsletter_signout_mail
+  unique: true
+  contents:
+  - name: mail_from
+    type: EssenceText
+    validate: [presence]
+  - name: subject
+    type: EssenceText
+    validate: [presence]
+    take_me_for_preview: true
+  - name: text
+    type: EssenceRichtext
+    validate: [presence]

data/lib/generators/alchemy_crm/scaffold/files/newsletter_layouts.yml

@@ -0,0 +1,3 @@
+# Newsletter page layouts
+- name: standard
+  elements: []

data/lib/generators/alchemy_crm/scaffold/files/newsletters.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+		<title>Newsletter</title>
+		<style type="text/css" media="screen">
+			/* Put styles styles here */
+		</style>
+	</head>
+	<body alink="#000" vlink="#000" link="#000" bgcolor="#fff">
+		<%# This image is used for tracking %>
+		<%- unless @preview_mode -%>
+		<img src="<%= recipient_reads_url(:id => @recipient.id || 1, :host => @server) %>" style="width: 0; height: 0; display: none" width="0" height="0"/>
+		<%- end -%>
+		<%# end tracking image %>
+		
+		<%= render_newsletter_layout %>
+		
+		<%= alchemy_preview_mode_code %>
+	</body>
+</html>

data/lib/generators/alchemy_crm/scaffold/files/newsletters.text.erb

@@ -0,0 +1,4 @@
+Newsletter
+==========
+
+<%= render_newsletter_layout(:render_format => 'text') %>

data/lib/generators/alchemy_crm/scaffold/files/page_layouts.yml

@@ -0,0 +1,19 @@
+# These page layouts are added by the Alchemy CRM module.
+
+- name: newsletter_signup
+  unique: true
+  cache: false
+  elements: [newsletter_signup_form]
+  autogenerate: [newsletter_signup_form]
+
+- name: newsletter_signout
+  unique: true
+  cache: false
+  elements: [newsletter_signout_form]
+  autogenerate: [newsletter_signout_form]
+
+- name: newsletter_mails
+  unique: true
+  layoutpage: true
+  elements: [newsletter_signup_mail, newsletter_signout_mail]
+  autogenerate: [newsletter_signup_mail, newsletter_signout_mail]

data/lib/generators/alchemy_crm/scaffold/scaffold_generator.rb

@@ -0,0 +1,26 @@
+require 'rails'
+
+module AlchemyCrm
+  module Generators
+    class ScaffoldGenerator < ::Rails::Generators::Base
+      desc "This generator generates the Alchemy CRM scaffold."
+      source_root File.expand_path('files', File.dirname(__FILE__))
+      
+      def create_newsletter_scaffold
+
+        empty_directory "#{Rails.root}/app/views/alchemy/newsletter_layouts"
+
+        copy_file "_standard.html.erb", "#{Rails.root}/app/views/alchemy/newsletter_layouts/_standard.html.erb"
+        copy_file "_standard.text.erb", "#{Rails.root}/app/views/alchemy/newsletter_layouts/_standard.text.erb"
+        copy_file "newsletters.html.erb", "#{Rails.root}/app/views/layouts/alchemy/newsletters.html.erb"
+        copy_file "newsletters.text.erb", "#{Rails.root}/app/views/layouts/alchemy/newsletters.text.erb"
+        copy_file "newsletter_layouts.yml", "#{Rails.root}/config/alchemy/newsletter_layouts.yml"
+
+        append_file "#{Rails.root}/config/alchemy/elements.yml", YAML.load_file(File.expand_path('files/elements.yml', File.dirname(__FILE__))).to_yaml.gsub(/^-{3}\s{2}/, "\n# These elements are added by the Alchemy CRM module.\n\n")
+        append_file "#{Rails.root}/config/alchemy/page_layouts.yml", YAML.load_file(File.expand_path('files/page_layouts.yml', File.dirname(__FILE__))).to_yaml.gsub(/^^-{3}\s{2}/, "\n# These page layouts are added by the Alchemy CRM module.\n\n")
+
+      end
+      
+    end
+  end
+end

data/lib/tasks/alchemy_crm.rake

@@ -0,0 +1,28 @@
+namespace 'alchemy_crm' do
+
+	desc "Migrates the database, inserts essential data into the database and copies all assets."
+	task :prepare do
+		Rake::Task['alchemy_crm:install:migrations'].invoke
+		Rake::Task['alchemy_crm:seeder:copy'].invoke
+	end
+
+	namespace 'seeder' do
+		desc "Copy a line of code into the seeds.rb file"
+		task :copy do
+			File.open("./db/seeds.rb", "a") do |f|
+				f.puts "\n# Seeding Alchemy CRM data"
+				f.puts "AlchemyCrm::Seeder.seed!\n"
+			end
+		end
+	end
+
+	namespace 'elements' do
+		desc "Copy all crm elements into app"
+		task :copy do
+			Dir.glob(File.expand_path('../../app/views/alchemy/elements/*', File.dirname(__FILE__))).each do |file|
+				FileUtils.cp(file, Rails.root.join('app/views/alchemy/elements/'))
+			end
+		end
+	end
+
+end

data/lib/tasks/routes.rake

@@ -0,0 +1,29 @@
+desc 'Print out all defined routes in match order, with names. Target specific controller with CONTROLLER=x.'
+task :routes => :environment do
+	Rails.application.reload_routes!
+	all_routes = AlchemyCrm::Engine.routes.routes
+	
+	if ENV['CONTROLLER']
+		all_routes = all_routes.select{ |route| route.defaults[:controller] == ENV['CONTROLLER'] }
+	end
+
+	routes = all_routes.collect do |route|
+	
+		reqs = route.requirements.dup
+		reqs[:to] = route.app unless route.app.class.name.to_s =~ /^ActionDispatch::Routing/
+		reqs = reqs.empty? ? "" : reqs.inspect
+	
+		{:name => route.name.to_s, :verb => route.verb.to_s, :path => route.path, :reqs => reqs}
+	end
+	
+	 # Skip the route if it's internal info route
+	routes.reject! { |r| r[:path] =~ %r{/rails/info/properties|^/assets} }
+	
+	name_width = routes.map{ |r| r[:name].length }.max
+	verb_width = routes.map{ |r| r[:verb].length }.max
+	path_width = routes.map{ |r| r[:path].length }.max
+	
+	routes.each do |r|
+		puts "#{r[:name].rjust(name_width)} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs]}"
+	end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'lib/alchemy_crm')

data/recipes/alchemy-mailings-capistrano-tasks.rb

@@ -0,0 +1,12 @@
+namespace 'alchemy_crm' do
+	
+	namespace :assets do
+  
+	  desc "Copies all assets from Alchemy-Mailings plugin folder to public folder"
+	  task :copy do
+	    run "cd #{current_path} && RAILS_ENV=production #{rake} alchemy_crm:assets:copy:all"
+	  end
+  
+	end
+	
+end

data/spec/alchemy_mailings_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe AlchemyCrm do
+  it "should be valid" do
+    AlchemyCrm.should be_a(Module)
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module AlchemyCrm
+	describe 'Configuration' do
+		describe 'file' do
+			context 'is present in host application' do
+				before(:each) do
+					@config_file = Rails.root.join('config', 'alchemy_crm.config.yml')
+					File.open(@config_file, 'w') do |file|
+						file.puts({'mail_from' => 'jon@doe.com'}.to_yaml)
+					end
+				end
+				it "should load the app config" do
+					Config.show.should == {'mail_from' => 'jon@doe.com'}
+				end
+				after(:each) do
+					FileUtils.rm_f @config_file
+				end
+			end
+			context 'is not present in application' do
+				it 'should load the default config' do
+					default_config = File.join(File.dirname(__FILE__), '..', 'config/alchemy_crm.config.yml')
+					Config.show.should == YAML.load_file(default_config)
+				end
+			end
+		end
+	end
+end

data/spec/controllers/alchemy_crm/contacts_controller_spec.rb

@@ -0,0 +1,210 @@
+require 'spec_helper'
+
+module AlchemyCrm
+	describe ContactsController do
+
+		before(:all) do
+			Alchemy::PageLayout.add([
+				{"name" => 'newsletter_signup', "elements" => ['newsletter_signup_form'], "autogenerate" => ["newsletter_signup_form"]},
+				{"name" => 'newsletter_signout', "elements" => ['newsletter_signout_form'], "autogenerate" => ["newsletter_signout_form"]},
+				{"name" => 'newsletter_mails', "elements" => ['newsletter_signup_mail', 'newsletter_signout_mail'], "autogenerate" => ["newsletter_signup_mail", "newsletter_signout_mail"]}
+			])
+			@language_root = Alchemy::Page.create!(:name => 'Language Root', :page_layout => 'standard', :parent_id => Alchemy::Page.root.id, :language => Alchemy::Language.get_default)
+			@signup_page = Alchemy::Page.create!(:name => 'Newsletter Signup', :page_layout => 'newsletter_signup', :parent_id => @language_root.id, :language => @language_root.language, :public => true)
+			@signout_page = Alchemy::Page.create!(:name => 'Newsletter Signout', :page_layout => 'newsletter_signout', :parent_id => @language_root.id, :language => @language_root.language, :public => true)
+			@mail_page = Alchemy::Page.create!(:name => 'Newsletter Mails', :page_layout => 'newsletter_mails', :parent_id => @language_root.id, :language => @language_root.language)
+			@contact_params = {:email => 'jon@doe.com', :firstname => 'Jon', :lastname => 'Doe', :salutation => 'mr'}
+			@newsletter = Newsletter.create!(:name => 'Newsletter', :layout => 'standard')
+		end
+
+		describe '#signup' do
+
+			before(:each) do
+				post :signup, {:contact => @contact_params, :use_route => :alchemy_crm}
+			end
+
+			it "should create the contact from params." do
+				Contact.find_by_email('jon@doe.com').should_not be_nil
+			end
+
+			it "should deliver the signup mail." do
+				ActionMailer::Base.deliveries.collect(&:subject).should include("Signup mail")
+			end
+
+		end
+
+		describe '#verify' do
+
+			before(:all) do
+				@contact = Contact.create!({:email => 'jon@doe.com', :firstname => 'Jon', :lastname => 'Doe', :salutation => 'mr'})
+			end
+
+			context "receiving hash from existing contact" do
+
+				render_views
+
+				before(:each) do
+					@element = @signup_page.elements.find_by_name(:newsletter_signup_form)
+					@element.content_by_name('verified_text').essence.update_attribute(:body, 'you are now verified')
+					post :verify, {:token => @contact.email_sha1, :use_route => :alchemy_crm}
+				end
+
+				it "should verify the contact." do
+					@contact.reload
+					@contact.verified.should be(true)
+				end
+
+				it "should display custom 'verified' text." do
+					verified_text = Regexp.new(Regexp.escape(@element.ingredient('verified_text')))
+					response.body.should match(verified_text)
+				end
+
+			end
+
+			context "receiving hash from existing contact and newsletter ids" do
+
+				before(:each) do
+					@subscription = Subscription.create!(:contact => @contact, :newsletter => @newsletter)
+					@newsletter_ids = @contact.subscriptions.collect(&:newsletter_id)
+					post :verify, {:token => @contact.email_sha1, :newsletter_ids => @newsletter_ids, :use_route => :alchemy_crm}
+				end
+
+				it "should verify all subscriptions from contact." do
+					@contact.subscriptions.where(:verified => true).collect(&:newsletter_id).should == @newsletter_ids
+				end
+
+			end
+
+			context "receiving hash from not existing contact" do
+
+				it "should raise routing error." do
+					lambda {
+						post :verify, {:token => 'f4k3h4ckh4sh', :use_route => :alchemy_crm}
+					}.should raise_error(ActionController::RoutingError)
+				end
+
+			end
+
+			context "not receiving any newsletter_ids" do
+
+				before(:each) do
+					@subscription = Subscription.create!(:contact => @contact, :newsletter => @newsletter)
+					post :verify, {:token => @contact.email_sha1, :use_route => :alchemy_crm}
+				end
+
+				it "should verify all subscriptions from contact." do
+					@contact.subscriptions.where(:verified => true).count.should == @contact.subscriptions.count
+				end
+
+			end
+
+			after(:all) do
+				@contact.destroy
+			end
+
+		end
+
+		describe '#signout' do
+
+			context "receiving an unknown email" do
+
+				it "should display error notice." do
+					post :signout, {:email => 'not@know.com', :use_route => :alchemy_crm}
+					flash[:notice].should match(/contact could not be found/)
+				end
+
+			end
+
+			context "receiving an email for verified contact" do
+
+				before(:each) do
+					@contact = Contact.create!({:email => 'jon@doe.com', :firstname => 'Jon', :lastname => 'Doe', :salutation => 'mr', :verified => true}, :as => :admin)
+				end
+
+				it "should deliver signout mail." do
+					post :signout, {:email => 'jon@doe.com', :use_route => :alchemy_crm}
+					ActionMailer::Base.deliveries.collect(&:subject).should include("Signout mail")
+				end
+
+			end
+
+			context "receiving an email for known, but not verified contact" do
+
+				before(:each) do
+					@contact = Contact.create!({:email => 'jon@doe.com', :firstname => 'Jon', :lastname => 'Doe', :salutation => 'mr'})
+				end
+
+				it "should display error notice." do
+					post :signout, {:email => @contact.email, :use_route => :alchemy_crm}
+					flash[:notice].should match(/contact could not be found/)
+				end
+
+			end
+
+		end
+
+		describe '#disable' do
+
+			before(:all) do
+				@contact = Contact.create!({:email => 'jon@doe.com', :firstname => 'Jon', :lastname => 'Doe', :salutation => 'mr', :verified => true}, :as => :admin)
+			end
+
+			context "receiving hash from existing contact" do
+
+				render_views
+
+				before(:each) do
+					@element = @signout_page.elements.find_by_name(:newsletter_signout_form)
+					@element.content_by_name('disabled_text').essence.update_attribute(:body, 'you are now disabled')
+					post :disable, {:token => @contact.email_sha1, :use_route => :alchemy_crm}
+				end
+
+				it "should disable the contact." do
+					@contact.reload
+					@contact.disabled.should be(true)
+					@contact.verified.should be(false)
+				end
+
+				it "should display custom 'disabled' text." do
+					disabled_text = Regexp.new(Regexp.escape(@element.ingredient('disabled_text')))
+					response.body.should match(disabled_text)
+				end
+
+			end
+
+			context "receiving hash from existing contact" do
+
+				before(:each) do
+					@subscription = Subscription.create!(:contact => @contact, :newsletter => @newsletter)
+					post :disable, {:token => @contact.email_sha1, :use_route => :alchemy_crm}
+				end
+
+				it "should delete all subscriptions from contact." do
+					@contact.subscriptions.should be_empty
+				end
+
+			end
+
+			context "receiving hash from not existing contact" do
+
+				it "should raise routing error." do
+					lambda {
+						post :disable, {:token => 'f4k3h4ckh4sh', :use_route => :alchemy_crm}
+					}.should raise_error(ActionController::RoutingError)
+				end
+
+			end
+
+			after(:all) do
+				@contact.destroy
+			end
+
+		end
+
+		after(:all) do
+			@language_root.destroy
+			Contact.destroy_all
+		end
+
+	end
+end