maily_herald 0.8.0 → 0.9.1

data/app/models/maily_herald/subscription.rb

@@ -25,8 +25,23 @@ module MailyHerald
 
     after_save :update_schedules, if: Proc.new{|s| s.active_changed?}
 
+    def self.get_from(entity)
+      if entity.has_attribute?(:maily_subscription_id) && entity.maily_subscription_id
+        subscription = MailyHerald::Subscription.new
+
+        entity.attributes.each do |k, v|
+          if match = k.match(/^maily_subscription_(\w+)$/)
+            subscription.send("#{match[1]}=", v)
+          end
+        end
+
+        subscription.readonly!
+        subscription
+      end
+    end
+
     def active?
-      !new_record? && read_attribute(:active)
+      read_attribute(:id) && read_attribute(:active)
     end
 
     def deactivate!
@@ -42,7 +57,7 @@ module MailyHerald
     end
 
     def token_url
-      MailyHerald::Engine.routes.url_helpers.ubsubscribe_url(self)
+      MailyHerald::Engine.routes.url_helpers.maily_unsubscribe_url(self)
     end
 
     def to_liquid
@@ -52,6 +67,12 @@ module MailyHerald
     end
 
     def update_schedules
+      AdHocMailing.where(list_id: self.list).each do |m|
+        m.set_schedule_for self.entity
+      end
+      OneTimeMailing.where(list_id: self.list).each do |m|
+        m.set_schedule_for self.entity
+      end
       PeriodicalMailing.where(list_id: self.list).each do |m|
         m.set_schedule_for self.entity
       end

data/config/routes.rb

@@ -3,9 +3,9 @@ MailyHerald::Engine.routes.draw do
 end
 
 MailyHerald::Engine.routes.url_helpers.class.module_eval do
-  def unsubscribe_url(subscription, *args)
+  def maily_unsubscribe_url(subscription, *args)
     options = args.extract_options! || {}
-    options = options.reverse_merge(controller: "/maily_herald/tokens", action: "get", token: subscription.token)
+    options = options.reverse_merge({controller: "/maily_herald/tokens", action: "get", token: subscription.token}.merge(Rails.application.routes.default_url_options))
 
     MailyHerald::Engine.routes.url_helpers.url_for(options)
   end

data/lib/maily_herald.rb

@@ -19,14 +19,10 @@ module MailyHerald
         MailyHerald::Logging.initialize(logger_opts)
       end
 
-      if args["mailing"] && args["entity"]
-        MailyHerald::Manager.deliver args["mailing"], args["entity"]
-      elsif args["mailing"]
+      if args["mailing"]
         MailyHerald::Manager.run_mailing args["mailing"]
       elsif args["sequence"]
         MailyHerald::Manager.run_sequence args["sequence"]
-      elsif args["simulate"]
-        MailyHerald::Manager.simulate args["simulate"]
       else
         MailyHerald::Manager.run_all
       end
@@ -38,17 +34,30 @@ module MailyHerald
 
     def perform id
       dispatch = MailyHerald::Dispatch.find(id)
-      dispatch.update_schedules if dispatch.respond_to?(:update_schedules)
+      dispatch.set_schedules if dispatch.respond_to?(:set_schedules)
+    end
+  end
+
+  class Initializer
+    def initialize klass
+      @klass = klass
+    end
+
+    def method_missing m, *args, &block
+      if %w{list ad_hoc_mailing one_time_mailing periodical_mailing sequence_mailing sequence}.include?(m.to_s)
+        options = args.extract_options!
+        @klass.send m, *args, options.merge(locked: true), &block
+      else
+        @klass.send m, *args, &block
+      end
     end
   end
 
   autoload :Utils,              'maily_herald/utils'
-  autoload :ConditionEvaluator, 'maily_herald/condition_evaluator'
   autoload :TemplateRenderer,   'maily_herald/template_renderer'
   autoload :ModelExtensions,    'maily_herald/model_extensions'
   autoload :Context,            'maily_herald/context'
   autoload :Manager,            'maily_herald/manager'
-	autoload :Config,							'maily_herald/config'
 	autoload :Autonaming,					'maily_herald/autonaming'
 	autoload :Logging,					  'maily_herald/logging'
 
@@ -105,6 +114,14 @@ module MailyHerald
       self.locked_lists.include?(name.to_s)
     end
 
+    def start_at_procs
+      @@start_at_procs ||= {}
+    end
+
+    def conditions_procs
+      @@conditions_procs ||= {}
+    end
+
     # Obtains Redis connection.
     def redis
       @redis ||= begin
@@ -139,11 +156,14 @@ module MailyHerald
     #
     # To be used in initializer file.
     def setup
-      @@contexts ||= {}
+      logger.warn("Maily migrations seems to be pending. Skipping setup...") && return unless schema_loaded?
 
-      logger.warn("Maily migrations seems to be pending. Skipping setup...") && return if ([MailyHerald::Dispatch, MailyHerald::List, MailyHerald::Log, MailyHerald::Subscription].collect(&:table_exists?).select{|v| !v}.length > 0)
+      yield Initializer.new(self)
+    end
 
-      yield self
+    # Checks if Maily tables are present.
+    def schema_loaded?
+      !([MailyHerald::Dispatch, MailyHerald::List, MailyHerald::Log, MailyHerald::Subscription].collect(&:table_exists?).select{|v| !v}.length > 0)
     end
 
     # Fetches or defines a {Context}.
@@ -156,6 +176,7 @@ module MailyHerald
     # @param name [Symbol] Identifier name of the Context.
     def context name, &block
       name = name.to_s
+      @@contexts ||= {}
 
       if block_given?
         @@contexts ||= {}
@@ -175,6 +196,30 @@ module MailyHerald
       MailyHerald::Dispatch.find_by_name(name)
     end
 
+    # Fetches or defines an {AdHocMailing}.
+    #
+    # If no block provided, {AdHocMailing} with given +name+ is returned.
+    #
+    # If block provided, {AdHocMailing} with given +name+ is created or edited 
+    # and block is evaluated within that mailing.
+    #
+    # @option options [true, false] :locked (false) Determines whether Mailing is locked.
+    # @see Dispatch#locked?
+    def ad_hoc_mailing name, options = {}
+      mailing = MailyHerald::AdHocMailing.where(name: name).first 
+      lock = options.delete(:locked)
+
+      if block_given? && !self.dispatch_locked?(name) && (!mailing || lock)
+        mailing ||= MailyHerald::AdHocMailing.new(name: name)
+        yield(mailing)
+        mailing.save! 
+
+        MailyHerald.lock_dispatch(name) if lock
+      end
+
+      mailing
+    end
+
     # Fetches or defines an {OneTimeMailing}.
     #
     # If no block provided, {OneTimeMailing} with given +name+ is returned.
@@ -311,13 +356,6 @@ module MailyHerald
       end
     end
 
-    def deliver mailing_name, entity_id
-      mailing_name = mailing_name.name if mailing_name.is_a?(Mailing)
-      entity_id = entity_id.id if !entity_id.is_a?(Fixnum)
-
-      Async.perform_async mailing: mailing_name, entity: entity_id, logger: MailyHerald::Logging.safe_options
-    end
-
     def run_sequence seq_name
       seq_name = seq_name.name if seq_name.is_a?(Sequence)
 
@@ -342,6 +380,7 @@ module MailyHerald
     # Read options from config file
     def read_options cfile = "config/maily_herald.yml"
       opts = {}
+      cfile = Pathname.new(cfile).relative? && defined?(Rails) ? Rails.root + cfile : cfile
       if File.exist?(cfile)
         opts = YAML.load(ERB.new(IO.read(cfile)).result)
       end

data/lib/maily_herald/autonaming.rb

@@ -1,4 +1,12 @@
 module MailyHerald
+
+  # Provides some common patters for models that have both :name and :title attributes.
+  # It adds some format constraints to :name and title attributes and makes sure
+  # that they are always both set properly.
+  #
+  # If only :name is provided, it will be used also as a:title.
+  # If only :title is provided, :name will be automatically generated out of it.
+  #
   module Autonaming
     def self.included(base)
       base.extend ClassMethods

data/lib/maily_herald/context.rb

@@ -103,9 +103,9 @@ module MailyHerald
     # Defines or returns Entity scope - collection of Entities.
     #
     # If block passed, it is saved as scope proc. Block has to return 
-    # +ActiveRecord::Relation+ containing Entity objects that will belong to scope.
+    # +ActiveRecord::Relation+ containing entity objects that will belong to scope.
     #
-    # If no block given, scope proc is called and Entity collection returned.
+    # If no block given, scope proc is called and entity collection returned.
     def scope &block
       if block_given?
         @scope = block
@@ -210,6 +210,8 @@ module MailyHerald
     # Obtains {Context} attributes in a form of (nested) +Hash+ which 
     # values are procs each returning single Entity attribute value.
     def attributes_list
+      return {} unless @attributes
+
       attributes = @attributes.dup
       attributes.setup 
       attributes.for_drop
@@ -217,6 +219,8 @@ module MailyHerald
 
     # Returns Liquid drop created from Context attributes.
     def drop_for entity, subscription
+      return {} unless @attributes
+
       attributes = @attributes.dup
       attributes.setup entity, subscription
       Drop.new(attributes.for_drop)

data/lib/maily_herald/logging.rb

@@ -50,6 +50,8 @@ module MailyHerald
       @options ||= OPTIONS.dup
       @options.merge!(opts) if opts
 
+      @options[:target] = Rails.root + @options[:target] if @options[:target].is_a?(String) && Pathname.new(@options[:target]).relative? && defined?(Rails)
+
       @logger = Logger.new(@options[:target])
       @logger.level = @options[:level]
       @logger.formatter = Formatter.new

data/lib/maily_herald/manager.rb

@@ -1,49 +1,33 @@
 module MailyHerald
   class Manager
-    def self.handle_trigger type, entity
-      mailings = Mailing.where(trigger: type)
-      mailings.each do |mailing|
-        mailing.deliver_to entity
-      end
-    end
-
-    def self.deliver mailing, entity
-      mailing = Mailing.find_by_name(mailing) if !mailing.is_a?(Mailing)
-      entity = mailing.context.scope.find(entity) if entity.is_a?(Fixnum)
+    # Run scheduled sequence mailing deliveries.
+    #
+    # @param sequence [Sequence, String, Symbol] {Sequence} object or name
+    def self.run_sequence sequence
+      seqence = Sequence.find_by_name(seqence) unless seqence.is_a?(Sequence)
 
-      mailing.deliver_to entity if mailing
-    end
-
-    def self.run_sequence seq
-      seq = Sequence.find_by_name(seq) if !seq.is_a?(Sequence)
-
-      seq.run if seq
+      sequence.run if sequence
     end
 
+    # Run scheduled periodical mailing deliveres.
+    #
+    # @param mailing [PeriodicalMailing, OneTimeMailing, String, Symbol] 
+    #           {AdHocMailing}, {OneTimeMailing} or {PeriodicalMailing} object or name
     def self.run_mailing mailing
-      mailing = Mailing.find_by_name(mailing) if !mailing.is_a?(Mailing)
+      mailing = Mailing.find_by_name(mailing) unless mailing.is_a?(Mailing)
 
       mailing.run if mailing
     end
 
+    # Run all scheduled mailing deliveres.
     def self.run_all
+      AdHocMailing.all.each {|m| m.run}
+      OneTimeMailing.all.each {|m| m.run}
       PeriodicalMailing.all.each {|m| m.run}
       Sequence.all.each {|m| m.run}
     end
 
-    def self.simulate period
-      File.open("/tmp/maily_herlald_timetravel.lock", "w") {}
-      time = Time.now
-      end_time = time + period
-      while time < end_time 
-        Timecop.freeze(time)
-        run_all
-        time = time + 1.day
-      end
-      Timecop.return
-      File.delete("/tmp/maily_herlald_timetravel.lock")
-    end
-
+    # Check if Maily sidekiq job is running.
     def self.job_enqueued?
       Sidekiq::Queue.new.detect{|j| j.klass == "MailyHerald::Async" } || 
         Sidekiq::Workers.new.detect{|w, msg| msg["payload"]["class"] == "MailyHerald::Async" } ||

data/lib/maily_herald/utils.rb

@@ -5,32 +5,61 @@ module MailyHerald
     end
 
     class MarkupEvaluator
-      class DummyDrop < Liquid::Drop
-        def has_key?(name)
-          true
-        end
+      VariableSignature = /\A[\w\.\[\]]+(\s*|\s*.+)?\Z/
 
-        def invoke_drop name
-          true
-        end
+      module Filters
+        module Date
+          def minus input, no, unit
+            input - no.to_i.send(unit)
+          end
 
-        alias :[] :invoke_drop
+          def plus input, no, unit
+            input + no.to_i.send(unit)
+          end
+        end
       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
+        drop = Class.new(Liquid::Drop) do
+          def has_key?(name); true; end
+          def invoke_drop(name); true; end
+          alias :[] :invoke_drop
+        end.new
+
+        evaluator = Utils::MarkupEvaluator.new(drop)
+        evaluator.evaluate_conditions(conditions)
+        true
+      rescue
+        return false
       end
 
+      def self.test_start_at markup
+        return true if !markup || markup.empty?
+
+        drop = Class.new(Liquid::Drop) do
+          def has_key?(name); true; end
+          def invoke_drop(name)
+            t = Time.now
+            t.define_singleton_method(:[]) do |v|
+              Time.now
+            end
+            t.define_singleton_method(:has_key?) do |v|
+              true
+            end
+            t
+          end
+          alias :[] :invoke_drop
+        end.new
+
+        evaluator = Utils::MarkupEvaluator.new(drop)
+        val = evaluator.evaluate_start_at(markup)
+
+        return val.is_a?(Time) || val.is_a?(DateTime)
+      rescue
+        return false
+      end
 
       def initialize drop
         @drop = drop
@@ -41,19 +70,31 @@ module MailyHerald
 
         condition = MarkupEvaluator.create_liquid_condition conditions
         template = Liquid::Template.parse(conditions)
+        raise StandardError unless template.errors.empty?
 
         liquid_context = Liquid::Context.new([@drop, template.assigns], template.instance_assigns, template.registers, true, {})
-        @drop.context = liquid_context
+        @drop.context = liquid_context if @drop.is_a?(Liquid::Drop)
 
-        condition.evaluate liquid_context
+        val = condition.evaluate liquid_context
+        raise(ArgumentError, "Conditions do not evaluate to boolean (got `#{val}`)") unless [true, false].include?(val)
+        val
       end
 
-      def evaluate_variable markup
-        template = Liquid::Template.parse(markup)
+      def evaluate_start_at markup
+        begin
+          Time.parse(markup)
+        rescue
+          raise(ArgumentError, "Start at is not a proper variable: `#{markup}`") unless VariableSignature =~ markup
 
-        liquid_context = Liquid::Context.new([@drop, template.assigns], template.instance_assigns, template.registers, true, {})
-        @drop.context = liquid_context
-        liquid_context[markup]
+          liquid_context = Liquid::Context.new([@drop], {}, {}, true, {})
+          liquid_context.add_filters([Filters::Date])
+
+          @drop.context = liquid_context if @drop.is_a?(Liquid::Drop)
+          #liquid_context[markup]
+
+          variable = Liquid::Variable.new markup
+          variable.render(liquid_context)
+        end
       end
 
       private

data/lib/maily_herald/version.rb

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

data/maily_herald.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.email       = ["lukasz@sology.eu"]
   s.homepage    = "https://github.com/Sology/maily_herald"
   s.license     = "LGPL-3.0"
-  s.description = s.summary = "Email marketing solution for Ruby on Rails applications"
+  s.description = s.summary = "Email processing solution for Ruby on Rails applications"
 
   s.files       = `git ls-files`.split("\n")
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }