emailvision4rails 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "rails", "3.2.8"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+gem "emailvision", "~> 2.1"
+gem "premailer", "~> 1.7"
+gem "hpricot", "~> 0.8"
+
+gem "pry", :group => :development
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Bastien Gysler (www.bastiengysler.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,198 @@
+Emailvision ruby on rails library
+=================================
+
+Emailvision4rails is a library used to manage messages and campaigns or more simply newsletters from your rails application.
+
+/!\ Not released yet /!\
+
+Install
+-------
+
+### Without bundler
+
+```shell
+$ gem install emailvision4rails
+```
+
+### With bundler
+
+Past this line to your Gemfile
+
+```ruby
+gem 'emailvision4rails'
+```
+
+Setup
+-----
+
+```shell
+$ rails generate emailvision4rails:setup
+```
+
+Generator
+---------
+
+Emailvision4rails is bundled with a newsletter generator.
+
+```shell
+$ rails generate newsletter standard daily weekly
+	create  app/newsletters/standard_newsletter.rb
+	create  app/views/standard_newsletter/daily.html.emv
+	create  app/views/standard_newsletter/daily.text.emv
+	create  app/views/standard_newsletter/weekly.html.emv
+	create  app/views/standard_newsletter/weekly.text.emv
+```
+
+Models
+------
+
+Models are ActiveModel compliant
+
+**Campaign**
+
+Attributes
+
+*   **name**
+*   **mailinglist_id**
+*   **message_id**
+*   **send_date**
+*   description
+*   emaildedupflg 
+*   format 
+*   delivery_speed 
+*   notification
+*   post_click_tracking
+*   strategy
+*   target
+*   url_end_campaign
+*   url_host
+*   analytics
+
+*Bold attributes must be present*
+
+Example
+
+```ruby
+campaign = Emailvision4rails::Campaign.new(
+	:name => 'Campaign',
+	:mailinglist_id => 123,
+	:message_id => 123,
+	:send_date => Time.now+30.minutes
+)
+
+if campaign.create
+	# Campaign created
+else
+	campaign.errors
+end
+```
+
+**Message**
+
+Attributes
+
+*   **name**
+*   **subject**
+*   **from**
+*   **from_email**
+*   **body**
+*   **reply_to**
+*   **reply_to_email**
+*   id
+*   create_date
+*   to 
+*   description
+*   encoding
+*   hotmail_unsub_url
+*   type
+*   hotmail_unsub_flg
+*   is_bounceback
+
+*Bold attributes must be present*
+
+```ruby
+message = Emailvision4rails::Message.new(
+	message_content,
+	:name => 'My message',
+	:subject => 'Hello',
+	:from => 'Bastien Gysler', 
+	:from_email => 'basgys@gmail.com',
+	:reply_to => 'Bastien Gysler',
+	:reply_to_email => 'basgys@gmail.com'
+)
+
+if message.create
+	# Message created
+else
+	message.errors
+end
+```
+
+Newsletter (Controller)
+-----------------------
+
+Newsletters work like mailers. These are stored in the *newsletters* directory (/app/newsletters)
+
+**Example**
+
+```shell
+$ rails generate newsletter standard
+```
+
+```ruby
+class StandardNewsletter < Emailvision4rails::AbstractNewsletter
+
+	def daily_fr(params = {})
+		newsletter(
+			:message => default_message_params,
+			:campaign => default_campaign_params.merge(:send_date => Time.now+1.day, :mailinglist_id => 123)
+		)
+	end
+
+	private
+
+	def default_message_params
+		{
+			:name => 'My message',
+			:subject => 'Hello',
+			:from => 'Bastien Gysler', 
+			:from_email => 'basgys@gmail.com',
+			:body => my_body,
+			:reply_to => 'Bastien Gysler',
+			:reply_to_email => 'basgys@gmail.com'
+		}
+	end
+
+	def default_campaign_params
+		{
+			:name => 'Campaign campaign'
+		}
+	end
+
+end
+```
+
+```ruby
+StandardNewsletter.daily_fr.publish
+```
+
+Views
+-----
+
+Views are stored in app/views and are suffixed by _newsletter.
+
+Two formats are available which are html and text and both must be present. Otherwise and ActionView::MissingTemplate error will be raised.
+
+Template engine that should be used is emv, but others work too.
+
+EMV template engine
+-------------------
+
+EMV is an engine built on top of ERB, but it also adds CSS inlining for HTML files.
+
+It means you can create your views just like others and EMV will do the dirty work to be "email ready".
+
+Author
+------
+
+Bastien Gysler :: [bastiengysler.com](http://www.bastiengysler.com/) :: @basgys

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Emailvision'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/emailvision4rails.rb

@@ -0,0 +1,28 @@
+require 'rails'
+require 'action_view'
+require 'premailer'
+require 'emailvision'
+
+module Emailvision4rails
+	# Base
+	autoload :EmvHandler, 'emailvision4rails/emv_handler'
+	autoload :Collector, 'emailvision4rails/collector'
+	autoload :Newsletter, 'emailvision4rails/newsletter'
+	autoload :Configuration, 'emailvision4rails/configuration'
+	autoload :Premailer, 'emailvision4rails/premailer'
+	autoload :Version, 'emailvision4rails/version'	
+
+	# Models
+	autoload :Base, 'emailvision4rails/models/base'
+	autoload :Message, 'emailvision4rails/models/message'
+	autoload :Campaign, 'emailvision4rails/models/campaign'
+
+	# Newsletters (Controller)
+	autoload :AbstractNewsletter, 'emailvision4rails/newsletters/abstract_newsletter'
+
+	ActionView::Template.register_template_handler :emv, EmvHandler	
+
+	if defined?(Rails)
+		require 'emailvision4rails/railtie'
+	end
+end

data/lib/emailvision4rails/configuration.rb

@@ -0,0 +1,9 @@
+module Emailvision4rails
+	class Configuration
+
+		class << self
+			attr_accessor :server_name, :endpoint, :login, :password, :key, :debug, :encoding
+		end		
+
+	end
+end

data/lib/emailvision4rails/emv_handler.rb

@@ -0,0 +1,18 @@
+require 'action_view/template'
+
+module Emailvision4rails
+	module EmvHandler
+		def self.erb_handler
+			@@erb_handler ||= ActionView::Template.registered_template_handler(:erb)
+		end
+
+		def self.call(template)
+			compiled_source = erb_handler.call(template)
+			if template.formats.include?(:html)
+				"Emailvision4rails::Premailer.new((begin;#{compiled_source};end)).to_inline_css"
+			else
+				compiled_source
+			end
+		end
+	end
+end

data/lib/emailvision4rails/models/base.rb

@@ -0,0 +1,57 @@
+require 'active_model/conversion'
+require 'active_model/attribute_methods'
+require 'active_model/naming'
+require 'active_model/translation'
+require 'active_model/validator'
+require 'active_model/validations'
+require 'active_model/callbacks'
+
+class Emailvision4rails::Base
+	include ActiveModel::Conversion
+	include ActiveModel::AttributeMethods
+	include ActiveModel::Validations
+
+	extend ActiveModel::Callbacks
+	extend ActiveModel::Naming
+
+	class_attribute :_attributes
+	self._attributes = []
+
+	attribute_method_suffix '?'
+
+	define_model_callbacks :create, :update
+
+	def self.attributes(*names)
+		attr_accessor *names
+		define_attribute_methods names
+
+		self._attributes += names
+	end
+
+	def attributes
+		self._attributes.inject({}) do |hash, attr|
+			hash[attr.to_s] = send(attr)
+			hash
+		end
+	end
+
+	def persisted?
+		false
+	end
+
+	def to_emv
+		attributes.reject {|k,v| v.nil?}
+	end
+
+	protected
+
+	def api
+		@api ||= Emailvision::Api.new :endpoint => "apiccmd"
+		@api.open_connection unless @api.connected?
+		@api
+	end
+
+	def attribute?(attribute)
+		send(attribute).present?
+	end
+end

data/lib/emailvision4rails/models/campaign.rb

@@ -0,0 +1,55 @@
+class Emailvision4rails::Campaign < Emailvision4rails::Base
+	
+	attributes(
+		:name,
+		:mailinglist_id,
+		:message_id, 
+		:send_date,
+		:description,
+		:emaildedupflg, 
+		:format, 
+		:delivery_speed, 
+		:notification,
+		:post_click_tracking,
+		:strategy,
+		:target,
+		:url_end_campaign,
+		:url_host,
+		:analytics  		    
+	)
+
+	validates_presence_of(
+		:name,
+		:mailinglist_id,
+		:message_id, 
+		:send_date
+	)
+
+	validate :send_date_must_be_in_the_future, :message => "must be more than 5 minutes in the future"
+
+	# Validate format of email address
+
+	def initialize(payload = {})
+		payload.each do |attr, val|
+			send("#{attr}=", val) if attributes.has_key?(attr.to_s)
+		end
+	end
+
+	def create
+		if valid?
+			run_callbacks :create do
+				api.post.campaign.create(:body => {:campaign => self.to_emv}).call
+			end
+			true
+		else
+			false
+		end
+	end
+
+	private
+
+	def send_date_must_be_in_the_future
+		# Adds 5 minutes to ensure futurness of send date between validation and publication
+		send_date.present? ? (send_date > Time.now+5.minutes) : false
+	end
+end

data/lib/emailvision4rails/models/message.rb

@@ -0,0 +1,75 @@
+class Emailvision4rails::Message < Emailvision4rails::Base
+
+	attributes(
+		:name,
+		:subject,
+    :from, 
+    :from_email,		      
+    :body,   		    
+	  :reply_to, 
+	  :reply_to_email,
+		:id,
+		:create_date, 
+		:to,  		    
+		:description, 
+		:encoding, 
+		:hotmail_unsub_url,
+		:type,
+		:hotmail_unsub_flg,
+		:is_bounceback
+	)
+
+	validates_presence_of(
+		:name,
+		:subject,
+		:from, 
+		:from_email,		      
+		:body,   		    
+		:reply_to, 
+		:reply_to_email
+	)  	
+
+	# Validate format of email address	
+
+	def initialize(body = "", payload = {})
+		self.body = body
+		payload.each do |attr, val|
+			send("#{attr}=", val) if attributes.has_key?(attr.to_s)
+		end
+	end
+
+	def create
+		if valid?
+		  run_callbacks :create do
+		    self.id = api.post.message.create(:body => {:message => self.to_emv}).call
+		  end
+			true
+		else
+			false
+		end
+	end	
+
+	def update
+		if valid? and persisted?
+			run_callbacks :update do
+				api.post.message.create(:body => self.to_emv).call
+			end			
+		else
+			false
+		end
+	end
+
+	# Maybe in a helper?
+	def mirror_url_id
+		@mirror_url_id ||= api.get.url.create_and_add_mirror_url(uri: [message_id, 'mirror_url']).call
+	end
+
+	def track_links
+		emv.get.message.track_all_links(id: message_id).call
+	end
+
+	def persisted?
+		message_id.present?
+	end
+
+end

data/lib/emailvision4rails/newsletter.rb

@@ -0,0 +1,43 @@
+module Emailvision4rails
+	class Newsletter
+
+		attr_accessor :parts, :payload
+
+		def initialize
+			@parts = {}
+		end
+
+		def publish
+			message = Message.new(content, payload[:message])			
+			campaign = Campaign.new(payload[:campaign])
+
+			# Message
+			message.create
+
+			# Campaign
+			campaign.message_id = message.id			
+			campaign.create
+
+			true
+		end
+
+		def content
+			parts.map do |format, content|
+				"[EMV #{format.upcase}PART]\n#{content}"
+			end.join("\n")
+		end
+
+		def to_html
+			parts[:html]
+		end
+
+		def to_text
+			parts[:text]
+		end		
+
+		def to_s
+			content
+		end
+
+	end
+end

data/lib/emailvision4rails/newsletters/abstract_newsletter.rb

@@ -0,0 +1,72 @@
+require 'abstract_controller'
+require 'action_view'
+require 'action_mailer/collector'
+
+module Emailvision4rails
+	class AbstractNewsletter < ::AbstractController::Base
+		abstract!
+
+		include AbstractController::Logger
+		include AbstractController::Rendering
+		include AbstractController::Layouts
+
+		append_view_path "#{Rails.root}/app/views"
+
+		private_class_method :new
+
+		class << self
+			def respond_to?(method, include_private = false)
+				super || action_methods.include?(method.to_s)
+			end
+
+			protected
+
+			def method_missing(method, *args)
+				return super unless respond_to?(method)
+				new(method, *args).message
+			end		
+		end
+
+		attr_internal :message
+
+	  def initialize(method_name=nil, *args)
+	    super()
+	    lookup_context.formats = [:text, :html] # Restrict rendering formats to html and text
+	    @_message = Newsletter.new
+	    process(method_name, *args) if method_name
+	  end
+
+		def process(method_name, *args)
+			lookup_context.skip_default_locale!
+			super(method_name, *args)
+		end
+
+		def newsletter(params = {})
+			message = @_message
+
+			lookup_context.locale = params.delete(:language) if params[:language]
+
+			responses = collect_responses(lookup_context.formats)
+
+			message.parts = responses
+			message.payload = params
+
+			message
+		end
+
+		private
+
+		def collect_responses(formats)
+			collector = ActionMailer::Collector.new(lookup_context) do 
+				render(action_name)
+			end			
+			responses = {}
+			formats.each do |f|
+				collector.send(f)
+				responses[f] = collector.responses.last[:body]
+			end
+			responses
+		end
+
+	end	
+end

data/lib/emailvision4rails/premailer.rb

@@ -0,0 +1,19 @@
+module Emailvision4rails
+  class Premailer < ::Premailer
+    def initialize(html)
+      ::Premailer.send(:include, Adapter.find(Adapter.use))
+
+      encoding = Configuration.encoding.upcase
+      options = {
+        :adapter => :hpricot,
+        :warn_level => Premailer::Warnings::SAFE,
+        :with_html_string => true,
+        :encoding => encoding,
+        :input_encoding => encoding,
+        :inputencoding => encoding
+      }
+
+      super(html, options)
+    end
+  end
+end

data/lib/emailvision4rails/railtie.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+module Emailvision4rails
+	class Railtie < Rails::Railtie
+	
+	  config.to_prepare do	  	
+	    file = "#{Rails.root}/config/emailvision.yml"
+	    
+	    if File.exist?(file)
+	      config = YAML.load_file(file)[Rails.env] || {}
+	      
+  	    Configuration.server_name  = config['server_name']
+  	    Configuration.endpoint     = config['endpoint']
+  	    Configuration.login        = config['login']
+  	    Configuration.password     = config['password']
+  	    Configuration.key          = config['key']
+  	    Configuration.debug        = config['debug']
+  	    Configuration.encoding     = Rails.configuration.encoding || 'utf-8'
+	    end	    
+	  end		
+	
+	end
+end

data/lib/emailvision4rails/version.rb

@@ -0,0 +1,3 @@
+module Emailvision4rails
+  Version = VERSION = '0.1.0'
+end

data/lib/generators/emailvision4rails/setup_generator.rb

@@ -0,0 +1,11 @@
+module Emailvision4rails
+	class Setup < Rails::Generators::Base
+
+		source_root File.expand_path('../templates', __FILE__)
+
+		def copy_config_template
+			copy_file "emailvision.yml", "config/emailvision.yml"
+		end
+
+	end
+end

data/lib/generators/emailvision4rails/templates/emailvision.yml

@@ -0,0 +1,15 @@
+development:
+    server_name:
+    login: 
+    password: 
+    key: 
+production:
+    server_name: 
+    login: 
+    password: 
+    key: 
+test:
+    server_name: 
+    login: 
+    password: 
+    key:

data/lib/generators/newsletter_generator.rb

@@ -0,0 +1,23 @@
+class NewsletterGenerator < Rails::Generators::NamedBase
+	argument :actions, :type => :array, :default => [], :banner => "action action"
+	check_class_collision :suffix => "Newsletter"
+	source_root File.expand_path("../templates", __FILE__)
+
+	def create_newsletter_file
+		template 'newsletter.rb', File.join('app/newsletters', class_path, "#{file_name}_newsletter.rb")
+	end
+
+	def create_view_files
+		actions.each do |action|
+			available_formats.each do |format|
+				template "action.#{format}.emv", File.join('app/views', class_path, "#{file_name}_newsletter", "#{action}.#{format}.emv")
+			end			
+		end
+	end	
+
+	protected
+
+	def available_formats
+		%w(html text)
+	end	
+end

data/lib/generators/templates/action.html.emv

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title><%%= @greeting %> from <%= class_name %></title>
+	</head>
+
+	<body>
+		<h1><%%= @greeting %></h1>
+		<p>I am <%= class_name %> in <b>HTML</b> format</p>
+	</body>
+</html>

data/lib/generators/templates/action.text.emv

@@ -0,0 +1,3 @@
+<%%= @greeting %>
+
+I am <%= class_name %> in text format

data/lib/generators/templates/newsletter.rb

@@ -0,0 +1,15 @@
+<% module_namespacing do -%>
+class <%= class_name %>Newsletter < Emailvision4rails::AbstractNewsletter
+<% actions.each do |action| -%>
+
+  def <%= action %>
+    @greeting = "Hi"
+
+		newsletter(
+			:message => {:name => "<%= action %>"},
+			:campaign => {:send_date => Time.now+10.minutes, :mailinglist_id => 123}
+		)	
+  end
+<% end -%>
+end
+<% end -%>

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: emailvision4rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bastien Gysler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: emailvision
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: premailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Manage Emailvision campaigns and messages from your rails application
+email: basgys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/emailvision4rails/configuration.rb
+- lib/emailvision4rails/emv_handler.rb
+- lib/emailvision4rails/models/base.rb
+- lib/emailvision4rails/models/campaign.rb
+- lib/emailvision4rails/models/message.rb
+- lib/emailvision4rails/newsletter.rb
+- lib/emailvision4rails/newsletters/abstract_newsletter.rb
+- lib/emailvision4rails/premailer.rb
+- lib/emailvision4rails/railtie.rb
+- lib/emailvision4rails/version.rb
+- lib/emailvision4rails.rb
+- lib/generators/emailvision4rails/setup_generator.rb
+- lib/generators/emailvision4rails/templates/emailvision.yml
+- lib/generators/newsletter_generator.rb
+- lib/generators/templates/action.html.emv
+- lib/generators/templates/action.text.emv
+- lib/generators/templates/newsletter.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.markdown
+homepage: https://github.com/basgys/emailvision4rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Emailvision library for Ruby on Rails
+test_files: []