homing 0.1.0

data/app/controllers/emails_controller.rb

@@ -0,0 +1,6 @@
+class EmailsController < ApplicationController
+  def unsubscribe
+    @email = Email.find_by_unsubscribe_token(params[:unsubscribe_token])
+    @email.unsubscribe! if @email && @email.active?
+  end
+end

data/app/mailers/campaign_mailer.rb

@@ -0,0 +1,26 @@
+class CampaignMailer < ActionMailer::Base
+  default :from => Homing::Engine.config.default_email
+  
+  def notification(recipient, campaign)
+    recipient.prepare!
+    recipient_email = recipient.email
+    @edition = campaign.name
+    if recipient_email.name.present?
+      to = "#{recipient_email.name} <#{recipient_email.address}>"
+      @text_message = campaign.text_message.gsub(/RECIPIENT_NAME/,recipient_email.name)
+      @html_message = campaign.html_message.gsub(/RECIPIENT_NAME/,recipient_email.name)
+    else
+      to = recipient_email.address
+      @text_message = campaign.text_message.gsub(/RECIPIENT_NAME/,campaign.default_name)
+      @html_message = campaign.html_message.gsub(/RECIPIENT_NAME/,campaign.default_name)
+    end  
+    subject, @text_message, @html_message = [campaign.subject, @text_message, @html_message].map {|text| 
+      text.gsub(/BUSINESS_NAME/,recipient_email.business)}.map {|text| 
+      text.gsub(/BUSINESS_URL/,recipient_email.business_url)}.map {|text|
+      text.gsub(/ASSET_HOST/,Homing::Engine.config.asset_host)}
+    @html_message = @html_message.html_safe
+    @unsubscribe_token = recipient_email.unsubscribe_token
+        
+    recipient.sending! if mail(:to => to, :subject => subject)
+  end
+end

data/app/models/campaign.rb

@@ -0,0 +1,17 @@
+class Campaign < ActiveRecord::Base
+  has_many :recipients
+  attr_accessor :recipients_list
+  after_create :save_recipients
+  validates_presence_of :name, :subject
+  
+  def save_recipients
+    recipients_list.split("\n").each do |row|
+      columns = row.split("|")
+      email = Email.find_by_address(columns[1]) || Email.create!(:name => columns[0], 
+        :address => columns[1], :business => columns[2], 
+        :owner_id => columns[3], :owner_type => columns[4],
+        :business_url => columns[5])
+      self.recipients.create(:email => email) unless email.unsubscribed?
+    end
+  end
+end

data/app/models/email.rb

@@ -0,0 +1,30 @@
+require 'hasher'
+
+class Email < ActiveRecord::Base
+  include Hasher  
+  include ActiveRecord::Transitions
+
+  validates_presence_of :address
+  validates_uniqueness_of :address
+  validates_presence_of :unsubscribe_token
+  validates_uniqueness_of :unsubscribe_token
+  before_validation :set_unsubscribe_token
+  belongs_to :owner, :polymorphic => true
+    
+  state_machine do
+    state :active
+    state :unsubscribed
+
+    event :unsubscribe do
+      transitions :to => :unsubscribed, :from => :active, :on_transition => :mark_unsubscribed_at
+    end
+  end
+
+  protected
+    def set_unsubscribe_token
+      self.unsubscribe_token = generate_hash(self.address)
+    end
+    def mark_unsubscribed_at(unsubscribed_at = Time.now)
+      self.unsubscribed_at = unsubscribed_at
+    end
+end

data/app/models/recipient.rb

@@ -0,0 +1,28 @@
+class Recipient < ActiveRecord::Base
+  include ActiveRecord::Transitions
+    
+  belongs_to :email
+  validates_uniqueness_of :email_id, :scope => :campaign_id
+  belongs_to :campaign
+
+  state_machine do
+    state :pending
+    state :ready
+    state :sent
+  
+    event :prepare do
+      transitions :to => :ready, :from => :pending
+    end
+    event :sending do
+      transitions :to => :sent, :from => :ready
+    end
+  end
+  
+  state_machine.states.collect(&:name).each do |name|
+    scope name, where(:state => name)
+  end
+  
+  def state_enum
+    Recipient.state_machine.states.collect(&:name).map {|name| name.to_s}
+  end
+end

data/app/views/emails/unsubscribe.html.haml

@@ -0,0 +1 @@
+= @email.present? ? "Your email #{@email.address} was unsubscribed." : "No such email found."

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do |map|
+  match '/emails/unsubscribe/:unsubscribe_token' => 'emails#unsubscribe', :as => :unsubscribe
+end

data/lib/generators/homing/homing_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class HomingGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    current_migration_number(dirname) + 1
+  end
+
+  def create_migration_file
+    migration_template "create_campaigns.rb", "db/migrate/create_campaigns.rb"
+    migration_template "create_emails.rb", "db/migrate/create_emails.rb"
+    migration_template "create_recipients.rb", "db/migrate/create_recipients.rb"
+  end
+end

data/lib/generators/homing/templates/create_campaigns.rb

@@ -0,0 +1,18 @@
+class CreateCampaigns < ActiveRecord::Migration
+  def self.up
+    create_table :campaigns do |t|
+      t.string :name
+      t.string :default_name
+      t.string :subject
+      t.text :text_message
+      t.text :html_message
+      t.boolean :complete
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :campaigns
+  end
+end

data/lib/generators/homing/templates/create_emails.rb

@@ -0,0 +1,21 @@
+class CreateEmails < ActiveRecord::Migration
+  def self.up
+    create_table :emails do |t|
+      t.string :name
+      t.string :address
+      t.string :business
+      t.integer :owner_id
+      t.string :owner_type
+      t.string :business_url
+      t.string :state
+      t.string :unsubscribe_token
+      t.datetime :unsubscribed_at
+    end
+    
+    add_index :emails, :address
+  end
+
+  def self.down
+    drop_table :emails
+  end
+end

data/lib/generators/homing/templates/create_recipients.rb

@@ -0,0 +1,15 @@
+class CreateRecipients < ActiveRecord::Migration
+  def self.up
+    create_table :recipients do |t|
+      t.string :state
+      t.references :email
+      t.references :campaign
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :recipients
+  end
+end

data/lib/hasher.rb

@@ -0,0 +1,29 @@
+module Hasher
+  require 'digest/sha1'
+  SECRET = "myhasheriscoolerthanyourhasher"
+ 
+  def generate_hash(string)
+    encrypt string
+  end
+ 
+  protected
+  def encrypt(string)
+    Digest::SHA1.hexdigest(salt + string)
+  end
+ 
+  def salt
+    Digest::SHA1.hexdigest(SECRET + time_stamp + random)
+  end
+ 
+  def time_stamp(time = Time.now)
+    time.strftime("%d%Y%l%M").to_s
+  end
+ 
+  def random(size = 10)
+    (0...size).map { character_set[ rand(character_set.size) ] }.join
+  end
+ 
+  def character_set
+    [('0'..'9'),('A'..'Z')].map { |range| range.to_a }.flatten
+  end
+end

data/lib/homing/engine.rb

@@ -0,0 +1,14 @@
+require "homing"
+require "rails"
+require "transitions"
+require "active_record/transitions"
+
+module Homing
+  class Engine < Rails::Engine
+    config.default_email = "mail@example.com"
+    config.asset_host = "http://example.com"
+    rake_tasks do
+      load "homing/railties/tasks.rake"
+    end
+  end
+end

data/lib/homing/railties/tasks.rake

@@ -0,0 +1,51 @@
+namespace :homing do
+  desc "Campaign notifier"
+  task :notify, [:campaign_id, :limit] => :environment do |t, args|
+    campaign_id = args[:campaign_id]
+    limit = (args[:limit] || 200).to_i
+    campaign = Campaign.find(campaign_id) rescue nil
+    if campaign.present? && campaign.complete.blank?
+      recipients = campaign.recipients.pending.limit(limit)
+      puts "Sending email to: #{recipients.count} addresses"
+      recipients.each_with_index do |recipient, index|
+        begin
+          puts "#{index}. #{recipient.email.address}"
+          CampaignMailer.notification(recipient, campaign).deliver unless recipient.email.unsubscribed?
+        rescue Exception => e
+          puts "ERROR: #{recipient.email.address}"
+          puts e
+        end
+      end
+      campaign.update_attribute(:complete, true) if campaign.recipients.pending.count.zero? && campaign.recipients.ready.count.zero?
+    else
+      puts campaign.present? ? "Campaign complete!" : "Campaign not found!"
+    end
+  end
+  
+  desc "Campaign summary"
+  task :summary, [:campaign_id] => :environment do |t, args|
+    campaign_id = args[:campaign_id]
+    campaign = Campaign.find(campaign_id) rescue nil
+    if campaign.present?
+      puts "Total emails: #{campaign.recipients.count}"
+      puts "Emails sent: #{campaign.recipients.sent.count}"
+      puts "Emails ready: #{campaign.recipients.ready.count}"
+      puts "Emails pending: #{campaign.recipients.pending.count}"
+      puts "Campaign complete!" if campaign.complete
+    else
+      puts "Campaign not found!"
+    end
+  end
+  
+  desc "Campaign reset"
+  task :reset, [:campaign_id] => :environment do |t, args|
+    campaign_id = args[:campaign_id]
+    campaign = Campaign.find(campaign_id) rescue nil
+    if campaign.present?
+      campaign.update_attribute(:complete, false)
+      campaign.recipients.update_all("state = 'pending'")
+    else
+      puts "Campaign not found!"
+    end
+  end
+end

data/lib/homing.rb

@@ -0,0 +1,3 @@
+module Homing
+  require 'homing/engine' if defined?(Rails)
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: homing
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Codrea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: transitions
+  version_requirements: *id001
+  prerelease: false
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/emails_controller.rb
+- app/mailers/campaign_mailer.rb
+- app/models/campaign.rb
+- app/models/email.rb
+- app/models/recipient.rb
+- app/views/emails/unsubscribe.html.haml
+- config/routes.rb
+- lib/generators/homing/homing_generator.rb
+- lib/generators/homing/templates/create_campaigns.rb
+- lib/generators/homing/templates/create_emails.rb
+- lib/generators/homing/templates/create_recipients.rb
+- lib/hasher.rb
+- lib/homing.rb
+- lib/homing/engine.rb
+- lib/homing/railties/tasks.rake
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+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.5.2
+signing_key: 
+specification_version: 3
+summary: Homing
+test_files: []
+