maily_herald 0.0.1 → 0.8.0

data/lib/maily_herald/model_extensions.rb

@@ -0,0 +1,15 @@
+module MailyHerald
+  module ModelExtensions
+    def self.included(base)
+      unloadable
+      base.class_eval do
+        has_many    :maily_herald_subscriptions,       as: :entity, class_name: "MailyHerald::Subscription", dependent: :destroy
+        has_many    :maily_herald_logs,                as: :entity, class_name: "MailyHerald::Log"
+
+        after_destroy do
+          self.maily_herald_logs.scheduled.destroy_all
+        end
+      end
+    end
+  end
+end

data/lib/maily_herald/template_renderer.rb

@@ -0,0 +1,16 @@
+module MailyHerald
+  module TemplateRenderer
+    def self.included(base)
+      base.send :include, MailyHerald::TemplateRenderer::InstanceMethods
+    end
+
+    module InstanceMethods
+      protected 
+
+      def perform_template_rendering drop, template
+        template = Liquid::Template.parse(template)
+        template.render! drop
+      end
+    end
+  end
+end

data/lib/maily_herald/utils.rb

@@ -1,7 +1,80 @@
 module MailyHerald
-	module Utils
-		def random_hex(n)
-			SecureRandom.hex(n)
-		end
-	end
+  module Utils
+    def self.random_hex(n)
+      SecureRandom.hex(n)
+    end
+
+    class MarkupEvaluator
+      class DummyDrop < Liquid::Drop
+        def has_key?(name)
+          true
+        end
+
+        def invoke_drop name
+          true
+        end
+
+        alias :[] :invoke_drop
+      end
+
+      def self.test_conditions conditions
+        return true if !conditions || conditions.empty?
+
+        condition = self.create_liquid_condition conditions
+        template = Liquid::Template.parse(conditions)
+        raise StandardError unless template.errors.empty?
+
+        drop = DummyDrop.new
+        liquid_context = Liquid::Context.new([drop, template.assigns], template.instance_assigns, template.registers, true, {})
+        drop.context = liquid_context
+
+        condition.evaluate liquid_context
+      end
+
+
+      def initialize drop
+        @drop = drop
+      end
+
+      def evaluate_conditions conditions
+        return true if !conditions || conditions.empty?
+
+        condition = MarkupEvaluator.create_liquid_condition conditions
+        template = Liquid::Template.parse(conditions)
+
+        liquid_context = Liquid::Context.new([@drop, template.assigns], template.instance_assigns, template.registers, true, {})
+        @drop.context = liquid_context
+
+        condition.evaluate liquid_context
+      end
+
+      def evaluate_variable markup
+        template = Liquid::Template.parse(markup)
+
+        liquid_context = Liquid::Context.new([@drop, template.assigns], template.instance_assigns, template.registers, true, {})
+        @drop.context = liquid_context
+        liquid_context[markup]
+      end
+
+      private
+
+      def self.create_liquid_condition markup
+        expressions = markup.scan(Liquid::If::ExpressionsAndOperators).reverse
+        raise(Liquid::SyntaxError, Liquid::SyntaxHelp) unless expressions.shift =~ Liquid::If::Syntax
+
+        condition = Liquid::Condition.new($1, $2, $3)
+        while not expressions.empty?
+          operator = (expressions.shift).to_s.strip
+
+          raise(Liquid::SyntaxError, Liquid::SyntaxHelp) unless expressions.shift.to_s =~ Liquid::If::Syntax
+
+          new_condition = Liquid::Condition.new($1, $2, $3)
+          new_condition.send(operator.to_sym, condition)
+          condition = new_condition
+        end
+
+        condition
+      end
+    end
+  end
 end

data/lib/maily_herald/version.rb

@@ -1,3 +1,3 @@
 module MailyHerald
-  VERSION = "0.0.1"
+  VERSION = "0.8.0"
 end

data/maily_herald.gemspec

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 $:.push File.expand_path("../lib", __FILE__)
 
 # Maintain your gem's version:
@@ -10,20 +12,26 @@ Gem::Specification.new do |s|
   s.authors     = ["Łukasz Jachymczyk"]
   s.email       = ["lukasz@sology.eu"]
   s.homepage    = "https://github.com/Sology/maily_herald"
-  s.summary     = "Mailing framework for Ruby on Rails applications"
-  #s.description = ""
+  s.license     = "LGPL-3.0"
+  s.description = s.summary = "Email marketing solution for Ruby on Rails applications"
 
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.files       = `git ls-files`.split("\n")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files  = `git ls-files -- {spec,features}/**/`.split("\n")
 
-  s.add_dependency "rails", "~> 3.2.8"
-  s.add_dependency "liquid", "~> 2.6.0"
-  s.add_dependency "sidekiq", "~> 2.13.0"
-  # s.add_dependency "jquery-rails"
+  s.add_dependency "rails", "> 3.2"
+  s.add_dependency "liquid", "~> 2.6.1"
+  s.add_dependency "sidekiq", "~> 2.17.8"
 
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "shoulda-matchers", "~>1.0"#, "~> 3.0"
   s.add_development_dependency "factory_girl_rails"
   s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "timecop"
+  s.add_development_dependency "spring-commands-rspec"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "redcarpet" # for yard markdown formatting
 end

data/spec/controllers/maily_herald/tokens_controller_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe MailyHerald::TokensController do
+  before(:each) do
+    @user = FactoryGirl.create :user
+    @mailing = MailyHerald.one_time_mailing :test_mailing
+    @subscription = @mailing.subscription_for @user
+  end
+
+  describe "Unsubscribe action" do
+    before(:each) do
+      @mailing.token_action = :unsubscribe
+      @mailing.save
+    end
+
+    describe "when regular subscription" do
+      pending "should deactivate only one subscription" do
+        get :get, token: @subscription.token, use_route: :maily_herald
+        response.should redirect_to("/")
+        @subscription.reload
+
+        @subscription.active?.should_not be_true
+
+        @user.maily_herald_subscriptions.each do |s|
+          next unless s.target.subscription_group == @subscription.target.subscription_group
+          next if s == @subscription
+
+          s.active?.should be_true
+        end
+      end
+    end
+
+    describe "when aggregated subscription" do
+      before(:each) do
+        @mailing.subscription_group = :account
+        @mailing.save!
+      end
+
+      after(:each) do
+        @mailing.subscription_group = nil
+        @mailing.save!
+      end
+
+      pending "should deactivate subscription group" do
+        get :get, token: @subscription.token, use_route: :maily_herald
+        response.should redirect_to("/")
+        @subscription.reload
+
+        @subscription.active?.should_not be_true
+        @subscription.aggregate.should_not be_nil
+        @subscription.aggregate.active?.should_not be_true
+
+        @user.maily_herald_subscriptions.each do |s|
+          next unless s.target.subscription_group == @subscription.target.subscription_group
+
+          s.active?.should be_false
+        end
+      end
+    end
+  end
+
+  pending "Custom action" do
+    before(:each) do
+      @mailing.token_action = :custom
+      @mailing.should be_valid
+      @mailing.save
+      @mailing.token_custom_action.should_not be_nil
+    end
+
+    pending "should perform custom action" do
+      @subscription.reload
+      @subscription.target.token_action.should eq(:custom)
+      get :get, token: @subscription.token, use_route: :maily_herald
+      response.should redirect_to("/custom")
+      @subscription.reload
+      @user.reload
+
+      @user.name.should eq("changed")
+    end
+  end
+end

data/spec/dummy/Guardfile

@@ -0,0 +1,35 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch('config/environments/test.rb')
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+  watch('test/test_helper.rb') { :test_unit }
+  watch(%r{features/support/}) { :cucumber }
+end

data/spec/dummy/app/mailers/test_mailer.rb

@@ -0,0 +1,11 @@
+class TestMailer < MailyHerald::Mailer
+  default from: "no-reply@flossmarket.com"
+
+  def sample_mail user
+    mail to: user.email, subject: "Test"
+  end
+
+  def sample_mail_error user
+    mail to: user.email, subject: "Test"
+  end
+end

data/spec/dummy/app/models/product.rb

@@ -0,0 +1,2 @@
+class Product < ActiveRecord::Base
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  scope :active, lambda { where(active: true) }
+  scope :inactive, lambda { where(active: false) }
+end

data/spec/dummy/app/views/test_mailer/sample_mail.text.erb

@@ -0,0 +1 @@
+Hello

data/spec/dummy/bin/rails

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require 'bundler/setup'
+load Gem.bin_path('rake', 'rake')

data/spec/dummy/bin/rspec

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require 'bundler/setup'
+load Gem.bin_path('rspec-core', 'rspec')

data/spec/dummy/bin/spring

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# This file loads spring without using Bundler, in order to be fast
+# It gets overwritten when you run the `spring binstub` command
+
+unless defined?(Spring)
+  require "rubygems"
+  require "bundler"
+
+  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
+    ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV["GEM_HOME"] = ""
+    Gem.paths = ENV
+
+    gem "spring", match[1]
+    require "spring/binstub"
+  end
+end

data/spec/dummy/config/application.rb

@@ -8,7 +8,7 @@ require "active_resource/railtie"
 require "sprockets/railtie"
 # require "rails/test_unit/railtie"
 
-Bundler.require
+Bundler.require(*Rails.groups)
 require "maily_herald"
 
 module Dummy

data/spec/dummy/config/environments/development.rb

@@ -34,4 +34,5 @@ Dummy::Application.configure do
 
   # Expands the lines which load the assets
   config.assets.debug = true
+  config.serve_static_assets = true
 end

data/spec/dummy/config/environments/test.rb

@@ -28,6 +28,7 @@ Dummy::Application.configure do
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
+  ActionMailer::Base.default :from => "no-reply@foo.com>"
 
   # Raise exception on mass assignment protection for Active Record models
   config.active_record.mass_assignment_sanitizer = :strict

data/spec/dummy/config/initializers/maily_herald.rb

@@ -0,0 +1,103 @@
+MailyHerald.setup do |config|
+  config.token_redirect {|subscription| "/" }
+
+  config.context :all_users do |context|
+    context.scope {User.active}
+    context.destination {|user| user.email}
+    context.attributes do |user| 
+      attribute_group(:user) do
+        attribute(:name) {user.name}
+        attribute(:email) {user.email}
+        attribute(:created_at) {user.created_at}
+        attribute(:weekly_notifications) {user.weekly_notifications}
+        attribute_group(:properties) do
+          attribute(:prop1) { user.name[0] }
+          attribute(:prop2) { 2 }
+        end
+      end
+    end
+  end
+
+  config.list :generic_list do |list|
+    list.context_name = :all_users
+  end
+
+  config.list :locked_list, locked: true do |list|
+    list.context_name = :all_users
+  end
+
+  config.one_time_mailing :locked_mailing, locked: true do |mailing|
+    mailing.enable
+    mailing.title = "Test mailing"
+    mailing.subject = "Test mailing"
+    mailing.list = :generic_list
+    mailing.template = "User name: {{user.name}}."
+  end
+
+  config.one_time_mailing :test_mailing do |mailing|
+    mailing.enable
+    mailing.title = "Test mailing"
+    mailing.subject = "Test mailing"
+    mailing.list = :generic_list
+    mailing.template = "User name: {{user.name}}."
+  end
+
+  config.one_time_mailing :sample_mail do |mailing|
+    mailing.enable
+    mailing.title = "Sample mailing"
+    mailing.list = :generic_list
+    mailing.mailer_name = "TestMailer"
+  end
+
+  config.sequence :newsletters do |seq|
+    seq.enable
+    seq.title = "Newsletters"
+    seq.list = :generic_list
+    seq.start_at = "user.created_at"
+    seq.mailing :initial_mail do |mailing|
+      mailing.title = "Test mailing #1"
+      mailing.subject = "Test mailing #1"
+      mailing.template = "User name: {{user.name}}."
+      mailing.absolute_delay = 1.hour
+      mailing.enable
+    end
+    seq.mailing :second_mail do |mailing|
+      mailing.title = "Test mailing #2"
+      mailing.subject = "Test mailing #2"
+      mailing.template = "User name: {{user.name}}."
+      mailing.absolute_delay = 3.hours
+      mailing.enable
+    end
+    seq.mailing :third_mail do |mailing|
+      mailing.title = "Test mailing #3"
+      mailing.subject = "Test mailing #3"
+      mailing.template = "User name: {{user.name}}."
+      mailing.absolute_delay = 6.hours
+      mailing.enable
+    end
+  end
+
+  config.periodical_mailing :weekly_summary do |mailing|
+    mailing.enable
+    mailing.title = "Weekly summary"
+    mailing.subject = "Weekly summary"
+    mailing.start_at = "user.created_at"
+    mailing.list = :generic_list
+    mailing.title = "Test periodical mailing"
+    mailing.template = "User name: {{user.name}}."
+    mailing.period = 7.days
+    mailing.conditions = "user.weekly_notifications"
+  end
+
+  config.periodical_mailing :weekly_summary_sg do |mailing|
+    mailing.enable
+    mailing.title = "Weekly summary"
+    mailing.subject = "Weekly summary"
+    mailing.start_at = "user.created_at"
+    mailing.list = :generic_list
+    mailing.title = "Test periodical mailing"
+    mailing.template = "User name: {{user.name}}."
+    mailing.period = 7.days
+    mailing.conditions = "user.weekly_notifications"
+  end
+end