maily_herald 0.0.1 → 0.8.0

data/bin/maily_herald

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'maily_herald'
+require 'maily_herald/cli'
+
+begin
+  cli = MailyHerald::CLI.instance
+  cli.parse
+  cli.paperboy
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/config/database.yml

@@ -0,0 +1,5 @@
+test: 
+  adapter: sqlite3 
+  database: db/test.sqlite3 
+  pool: 5 
+  timeout: 5000 

data/config/locales/en.yml

@@ -1,13 +1,8 @@
 en:
   activerecord:
-    attributes:
-      mailing: 
-        name: Name
-        context: Context
-        sequence: Sequence
-        conditions: Conditions
-        title: Title
-        sender: Sender
-        delay: Delay
-        token: Token
-        template: Template
+    errors:
+      models:
+        maily_herald/subscription:
+          attributes:
+            entity:
+              wrong_type: is different type than defined in context

data/config/routes.rb

@@ -1,2 +1,12 @@
 MailyHerald::Engine.routes.draw do
+  get ":token", to: "tokens#get", as: :token
+end
+
+MailyHerald::Engine.routes.url_helpers.class.module_eval do
+  def unsubscribe_url(subscription, *args)
+    options = args.extract_options! || {}
+    options = options.reverse_merge(controller: "/maily_herald/tokens", action: "get", token: subscription.token)
+
+    MailyHerald::Engine.routes.url_helpers.url_for(options)
+  end
 end

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = "./spec/dummy"

data/db/migrate/20150205120443_create_maily_herald_tables.rb

@@ -0,0 +1,53 @@
+class CreateMailyHeraldTables < ActiveRecord::Migration
+  def change
+    create_table :maily_herald_dispatches do |t|
+      t.string            :type,                                        null: false
+      t.integer           :sequence_id
+      t.integer           :list_id,                                     null: false
+      t.text              :conditions
+      t.text              :start_at
+      t.string            :mailer_name
+      t.string            :name,                                        null: false
+      t.string            :title
+      t.string            :subject
+      t.string            :from
+      t.string            :state,             default: "disabled"
+      t.text              :template
+      t.integer           :absolute_delay
+      t.integer           :period
+      t.boolean           :override_subscription
+
+      t.timestamps
+    end
+		add_index :maily_herald_dispatches, :name, unique: true
+
+    create_table :maily_herald_subscriptions do |t|
+      t.integer           :entity_id,                                   null: false
+      t.integer           :list_id,                                     null: false
+      t.string            :entity_type,                                 null: false
+      t.string            :token,                                       null: false
+      t.text              :settings
+      t.text              :data
+      t.boolean           :active,             default: false,       null: false
+      t.datetime          :delivered_at
+
+      t.timestamps
+    end
+
+    create_table :maily_herald_logs do |t|
+      t.integer           :entity_id,                                   null: false
+      t.string            :entity_type,                                 null: false
+      t.string            :entity_email
+      t.integer           :mailing_id
+      t.string            :status,                                      null: false
+      t.text              :data
+      t.datetime          :processing_at
+    end
+
+    create_table :maily_herald_lists do |t|
+      t.string            :name,                                        null: false
+      t.string            :title
+      t.string            :context_name
+    end
+  end
+end

data/db/migrate_legacy/20130711124555_create_maily_herald_tables.rb

@@ -0,0 +1,67 @@
+class CreateMailyHeraldTables < ActiveRecord::Migration
+  def change
+    create_table :maily_herald_dispatches do |t|
+      t.string            :type,                                        null: false
+      t.integer           :sequence_id
+      t.string            :context_name
+      t.text              :conditions
+      t.string            :trigger
+      t.string            :mailer_name
+      t.string            :name,                                        null: false
+      t.string            :title
+      t.string            :subject
+      t.string            :from
+      t.text              :template
+      t.integer           :absolute_delay
+      t.datetime          :start
+      t.text              :start_var
+      t.integer           :period
+      t.boolean           :enabled,           default: false
+      t.boolean           :autosubscribe
+      t.boolean           :override_subscription
+      t.integer           :subscription_group_id
+      t.string            :token_action
+
+      t.timestamps
+    end
+		add_index :maily_herald_dispatches, :name, unique: true
+    add_index :maily_herald_dispatches, :context_name
+    add_index :maily_herald_dispatches, :trigger
+
+    create_table :maily_herald_subscriptions do |t|
+      t.string            :type,                                        null: false
+      t.integer           :entity_id,                                   null: false
+      t.string            :entity_type,                                 null: false
+      t.integer           :dispatch_id
+      t.string            :token,                                       null: false
+      t.text              :settings
+      t.text              :data
+      t.boolean           :active,             default: false,       null: false
+      t.datetime          :delivered_at
+
+      t.timestamps
+    end
+		#add_index :maily_herald_subscriptions, [:type, :entity_id, :entity_type, :dispatch_id], unique: true, name: "index_maliy_herald_subscriptions_unique"
+
+    create_table :maily_herald_logs do |t|
+      t.integer           :entity_id,                                   null: false
+      t.string            :entity_type,                                 null: false
+      t.integer           :mailing_id
+      t.string            :status,             default: "delivered", null: false
+      t.text              :data
+      t.datetime          :processed_at
+    end
+
+    create_table :maily_herald_subscription_groups do |t|
+      t.string            :name,                                        null: false
+      t.string            :title,                                       null: false
+    end
+
+    create_table :maily_herald_aggregated_subscriptions do |t|
+      t.integer           :entity_id,                                   null: false
+      t.string            :entity_type,                                 null: false
+      t.integer           :group_id,                                    null: false
+      t.boolean           :active,             default: false,       null: false
+    end
+  end
+end

data/db/migrate_legacy/20140612101023_create_lists.rb

@@ -0,0 +1,33 @@
+class CreateLists < ActiveRecord::Migration
+  def up
+    create_table :maily_herald_lists do |t|
+      t.string            :name,                                        null: false
+      t.string            :title
+      t.string            :context_name
+    end
+
+    remove_column :maily_herald_dispatches, :token_action
+    remove_column :maily_herald_dispatches, :subscription_group_id
+    remove_column :maily_herald_dispatches, :autosubscribe
+    remove_column :maily_herald_dispatches, :start
+    remove_column :maily_herald_dispatches, :start_var
+    remove_column :maily_herald_dispatches, :trigger
+    remove_column :maily_herald_dispatches, :enabled
+    remove_column :maily_herald_dispatches, :context_name
+    add_column :maily_herald_dispatches, :start_at, :text
+    add_column :maily_herald_dispatches, :list_id, :integer
+    add_column :maily_herald_dispatches, :state, :string, default: :disabled
+
+    remove_column :maily_herald_subscriptions, :dispatch_id
+    remove_column :maily_herald_subscriptions, :type
+    add_column :maily_herald_subscriptions, :list_id, :integer
+    #add_column :maily_herald_subscriptions, :next_delivery_at, :datetime
+
+    drop_table :maily_herald_subscription_groups
+    drop_table :maily_herald_aggregated_subscriptions
+
+    rename_column :maily_herald_logs, :processed_at, :processing_at
+    change_column :maily_herald_logs, :status, :string, default: nil
+    add_column :maily_herald_logs, :entity_email, :string
+  end
+end

data/lib/generators/maily_herald/install_generator.rb

@@ -9,9 +9,9 @@ module MailyHerald
         template "maily_herald.rb", "config/initializers/maily_herald.rb"
       end
 
-			def copy_locale
-				copy_file "../../../config/locales/en.yml", "config/locales/maily_handler.en.yml"
-			end
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/maily_herald.en.yml"
+      end
 
       def show_readme
         readme "README" if behavior == :invoke

data/lib/generators/templates/README

@@ -0,0 +1,2 @@
+Welcome to MailyHerald!
+Don't forget to create your contexts in initializer (config/initializers/maily_herald.rb).

data/lib/generators/templates/maily_herald.rb

@@ -1,2 +1,3 @@
 MailyHerald.setup do |config|
+  # Put your contexts and mailing definitions here
 end

data/lib/maily_herald.rb

@@ -1,29 +1,351 @@
-require "maily_herald/engine"
+require 'maily_herald/version'
+
+require 'liquid'
+require 'sidekiq'
+require 'redis'
+
+if defined?(::Rails::Engine)
+  require "maily_herald/engine"
+end
 
 module MailyHerald
-  autoload :Utils,          	'maily_herald/utils'
-  autoload :Context,          'maily_herald/context'
-  autoload :Worker,          	'maily_herald/worker'
+  class Async
+    include Sidekiq::Worker
 
-  def self.setup
-    yield self
+    def perform args = {}
+      if args["logger"]
+        logger_opts = {level: args["logger"]["level"], progname: "bkg"}
+        logger_opts[:target] = args["logger"]["target"]
+        MailyHerald::Logging.initialize(logger_opts)
+      end
+
+      if args["mailing"] && args["entity"]
+        MailyHerald::Manager.deliver args["mailing"], args["entity"]
+      elsif 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
+    end
   end
 
-	def self.context name, &block
-		name = name.to_s
-
-		if block_given?
-			@@contexts ||= {}
-			@@contexts[name] ||= MailyHerald::Context.new
-			yield @@contexts[name]
-		else
-			@@contexts[name]
-		end
-	end
-
-	def self.contexts
-		@@contexts
-	end
-end
+  class ScheduleUpdater
+    include Sidekiq::Worker
 
-require 'liquid'
+    def perform id
+      dispatch = MailyHerald::Dispatch.find(id)
+      dispatch.update_schedules if dispatch.respond_to?(:update_schedules)
+    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'
+
+  @@token_redirect = nil
+
+  class << self
+    # Returns config options read from config file.
+    def options
+      @options ||= read_options
+    end
+
+    # Assign config options.
+    def options=(opts)
+      @options = opts
+    end
+
+    # Get list of locked dispatches.
+    def locked_dispatches
+      @@locked_dispatches ||= []
+    end
+
+    # Lock a dispatch.
+    #
+    # @param name [Symbol] Dispatch identifier name.
+    def lock_dispatch name
+      name = name.to_s
+      self.locked_dispatches << name unless @@locked_dispatches.include?(name)
+    end
+
+    # Check if dispatch is locked.
+    #
+    # @param name [Symbol] Dispatch identifier name.
+    def dispatch_locked? name
+      self.locked_dispatches.include?(name.to_s)
+    end
+
+    # Get list of locked lists.
+    def locked_lists
+      @@locked_lists ||= []
+    end
+
+    # Lock a list.
+    #
+    # @param name [Symbol] List identifier name.
+    def lock_list name
+      name = name.to_s
+      self.locked_lists << name unless @@locked_lists.include?(name)
+    end
+
+    # Check if List is locked.
+    #
+    # @param name [Symbol] List identifier name.
+    def list_locked? name
+      self.locked_lists.include?(name.to_s)
+    end
+
+    # Obtains Redis connection.
+    def redis
+      @redis ||= begin
+                   client = Redis.new(
+                     url: options[:redis_url] || 'redis://localhost:6379/0',
+                     driver: options[:redis_driver] || "ruby"
+                   )
+
+                   if options[:redis_namespace]
+                     require 'redis/namespace'
+                     Redis::Namespace.new(options[:redis_namespace], redis: client)
+                   else
+                     client
+                   end
+                 end
+    end
+
+    # Gets the Maily logger.
+    def logger
+      unless MailyHerald::Logging.initialized?
+        opts = {
+          level: options[:verbose] ? Logger::DEBUG : Logger::INFO,
+        }
+        opts[:target] = options[:logfile] if options[:logfile]
+
+        MailyHerald::Logging.initialize(opts)
+      end
+      MailyHerald::Logging.logger
+    end
+
+    # Performs Maily setup.
+    #
+    # To be used in initializer file.
+    def setup
+      @@contexts ||= {}
+
+      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 self
+    end
+
+    # Fetches or defines a {Context}.
+    #
+    # If no block provided, Context with given +name+ is returned.
+    #
+    # If block provided, Context with given +name+ is created and then block
+    # is evaluated within that Context.
+    #
+    # @param name [Symbol] Identifier name of the Context.
+    def context name, &block
+      name = name.to_s
+
+      if block_given?
+        @@contexts ||= {}
+        @@contexts[name] ||= MailyHerald::Context.new(name)
+        yield @@contexts[name]
+      else
+        @@contexts[name]
+      end
+    end
+
+    # Returns a dispatch with given identifier name.
+    #
+    # Dispatch is basically any object extending {MailyHerald::Dispatch}.
+    #
+    # @param name [Symbol] Dispatch identifier name.
+    def dispatch name
+      MailyHerald::Dispatch.find_by_name(name)
+    end
+
+    # Fetches or defines an {OneTimeMailing}.
+    #
+    # If no block provided, {OneTimeMailing} with given +name+ is returned.
+    #
+    # If block provided, {OneTimeMailing} 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 one_time_mailing name, options = {}
+      mailing = MailyHerald::OneTimeMailing.where(name: name).first 
+      lock = options.delete(:locked)
+
+      if block_given? && !self.dispatch_locked?(name) && (!mailing || lock)
+        mailing ||= MailyHerald::OneTimeMailing.new(name: name)
+        yield(mailing)
+        mailing.save! 
+
+        MailyHerald.lock_dispatch(name) if lock
+      end
+
+      mailing
+    end
+
+    # Fetches or defines an {PeriodicalMailing}.
+    #
+    # If no block provided, {PeriodicalMailing} with given +name+ is returned.
+    #
+    # If block provided, {PeriodicalMailing} 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 periodical_mailing name, options = {}
+      mailing = MailyHerald::PeriodicalMailing.where(name: name).first 
+      lock = options.delete(:locked)
+
+      if block_given? && !self.dispatch_locked?(name) && (!mailing || lock)
+        mailing ||= MailyHerald::PeriodicalMailing.new(name: name)
+        yield(mailing)
+        mailing.save!
+
+        self.lock_dispatch(name) if lock
+      end
+
+      mailing
+    end
+
+    # Fetches or defines an {Sequence}.
+    #
+    # If no block provided, {Sequence} with given +name+ is returned.
+    #
+    # If block provided, {Sequence} with given +name+ is created or edited 
+    # and block is evaluated within that mailing.
+    # Additionally, within provided block, using {Sequence#mailing} method, 
+    # {SequenceMailing sequence mailings} can be defined.
+    #
+    # @option options [true, false] :locked (false) Determines whether Mailing is locked.
+    # @see Dispatch#locked?
+    # @see Sequence#mailing
+    def sequence name, options = {}
+      sequence = MailyHerald::Sequence.where(name: name).first 
+      lock = options.delete(:locked)
+
+      if block_given? && !self.dispatch_locked?(name) && (!sequence || lock)
+        sequence ||= MailyHerald::Sequence.new(name: name)
+        yield(sequence)
+        sequence.save!
+
+        self.lock_dispatch(name) if lock
+      end
+
+      sequence
+    end
+
+    # Fetches or defines a {List}.
+    #
+    # If no block provided, {List} with given +name+ is returned.
+    #
+    # If block provided, {List} with given +name+ is created or edited 
+    # and block is evaluated within that list.
+    #
+    # @option options [true, false] :locked (false) Determines whether {List} is locked.
+    # @see List#locked?
+    def list name, options = {}
+      list = MailyHerald::List.where(name: name).first 
+      lock = options.delete(:locked)
+
+      if block_given? && !self.list_locked?(name) && (!list || lock)
+        list ||= MailyHerald::List.new(name: name)
+        yield(list)
+        list.save!
+
+        self.lock_list(name) if lock
+      end
+
+      list
+    end
+
+    # Subscribe +entity+ to {List lists} identified by +list_names+.
+    #
+    # @see List#subscribe!
+    def subscribe entity, *list_names
+      list_names.each do |ln| 
+        list = MailyHerald.list(ln)
+        next unless list
+
+        list.subscribe! entity
+      end
+    end
+
+    # Unsubscribe +entity+ from {List lists} identified by +list_names+.
+    #
+    # @see List#unsubscribe!
+    def unsubscribe entity, *list_names
+      list_names.each do |ln| 
+        list = MailyHerald.list(ln)
+        next unless list
+
+        list.unsubscribe! entity
+      end
+    end
+
+    # Return all defined {Context Contexts}.
+    def contexts
+      @@contexts ||= {}
+    end
+
+    def token_redirect &block
+      if block_given?
+        @@token_redirect = block
+      else
+        @@token_redirect
+      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)
+
+      Async.perform_async sequence: seq_name, logger: MailyHerald::Logging.safe_options
+    end
+
+    def run_mailing mailing_name
+      mailing_name = mailing_name.name if mailing_name.is_a?(Mailing)
+
+      Async.perform_async mailing: mailing_name, logger: MailyHerald::Logging.safe_options
+    end
+
+    def run_all
+      Async.perform_async(logger: MailyHerald::Logging.safe_options)
+    end
+
+    def find_subscription_for mailer_name, mailing_name, entity
+      mailing = MailyHerald::Mailing.where(mailer_name: mailer_name, name: mailing_name).first
+      mailing.subscription_for entity
+    end
+
+    # Read options from config file
+    def read_options cfile = "config/maily_herald.yml"
+      opts = {}
+      if File.exist?(cfile)
+        opts = YAML.load(ERB.new(IO.read(cfile)).result)
+      end
+      opts
+    end
+  end
+end