courier 0.1.2

data/lib/courier/config.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+class Courier::Config
+  attr_accessor :services_hash, :templates_hash, :services_order
+
+  def initialize
+    self.services_order=[]
+    self.services_hash={}
+    self.templates_hash={}
+  end
+
+  def services *services
+    return services_order if services.empty?
+    raise 'Список сервисов уже определен' unless services_order.empty?
+
+    self.services_order = services.map { |s|
+      service = class_of_service(s).new
+      services_hash[service.name] = service
+    }
+  end
+
+  def get_service name
+    name=name.to_sym
+    services_hash[name] or raise "No such service '#{name}'"
+  end
+
+  def template name, *sets
+    raise "Values (#{sets.count}) and services counts (#{services_order.count}) not much" unless services_order.count==sets.count
+    template = Courier::Template::Base.new(:name=>name)
+    raise "Such template is already defined #{name}" if templates_hash.has_key? template.name
+    sets.each_with_index do |val, index|
+      service = services_order[index] or "Too many values (#{index}), no such services"
+      template.set(service, val)
+    end
+
+    templates_hash[template.name] = template
+  end
+
+  def get_template key
+    templates_hash[key.to_sym] or raise "No such template '#{key}'"
+  end
+
+  def class_of_service(name)
+    if name.is_a? Symbol
+      "Courier::Service::#{name.to_s.classify}".constantize
+    else
+      name
+    end
+  end
+end

data/lib/courier/engine.rb

@@ -0,0 +1,4 @@
+module Courier
+  class Engine < Rails::Engine
+  end
+end

data/lib/courier/message.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+
+# Моделька в помощь тем сервисам, что хотят иметь сохраненные сообщения для последующей доставки
+
+class Courier::Message < ActiveRecord::Base
+  set_table_name 'courier_messages'
+
+  belongs_to :owner, :polymorphic=>true
+  belongs_to :service #, :polymorphic=>true
+  belongs_to :template #, :polymorphic=>true
+
+  serialize :options, Hash
+
+  scope :fresh, where(:state=>:fresh)
+
+  validates_presence_of :owner, :service, :template
+
+  state_machine :state, :initial => :fresh do
+    state :fresh
+    state :delivered
+    event :set_delivered do
+      transition :fresh => :delivered
+    end
+  end
+end

data/lib/courier/owner.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+
+# # Courier::Sender (extenstion для AR-модели пользователя-отправителя)
+
+# Подключается через `acts_as_sender` дает модели метод `message(key, options)`. Пример вызова:
+
+# @@@
+# user.notify :comments_in_my_plan, :comments=>@comments, :level=>:success
+# user.notify_failure :cant_import_plans, :provider=>:facebook
+# @@@
+
+
+module Courier::Owner
+  def has_courier
+    has_one :courier, :as => :owner, :dependent => :destroy, :class_name=>'Courier::OwnerSetting'
+    include InstanceMethods
+
+    after_create do
+      create_courier
+    end
+  end
+
+  module InstanceMethods
+    def message(template_key, args={})
+      template = Courier.template(template_key)
+      Courier.config.services_order.each do |service|
+        service.message(self, template, args) if courier.enabled?(template, service, args)
+      end
+    end
+  end
+end

data/lib/courier/owner_setting.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+# Индивидуальные настройки для каждого пользователя. Матрица пересечения сервис-шаблон для каждого владельца.
+
+
+class Courier::OwnerSetting < ActiveRecord::Base
+  set_table_name 'courier_owner_setting'
+
+  belongs_to :owner, :polymorphic=>true
+
+  serialize :settings, Hash
+
+  before_validation do
+    self.settings||={}
+  end
+
+  validates_presence_of :owner
+  validates_uniqueness_of :owner_id, :scope=>:owner_type
+
+  def settings_of_template(template)
+    template = Courier.template(template) if template.is_a? Symbol
+    settings[template.name]||={}
+  end
+
+  def set(template, service, val=nil)
+    service = Courier.service(service) if service.is_a? Symbol
+    raise 'Cant use value as argument when block given' if block_given? and val
+    settings_of_template(template)[service.name] = block_given? ? yield : val
+  end
+
+  def get(template, service)
+    service = Courier.service(service) if service.is_a? Symbol
+    template = Courier.template(template) if template.is_a? Symbol
+    val = settings_of_template(template)[service.name]
+    val || template.get(service)
+  end
+
+  def enabled?(template, service, args={})
+    get(template, service)==:on
+  end
+
+  def disabled?(template, service, args={})
+    get(template, service)==:off
+  end
+end

data/lib/courier/service/active_mailer.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+class Courier::Service::ActiveMailer < Courier::Service::Base
+end

data/lib/courier/service/base.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+# Модель класса осуществляющего способ доставки.
+
+# * name - уникальное название (littlesms, actionmailer)
+# * type (класс)
+
+# ## Например:
+
+# * Courier::Service::SMS::LittleSMS
+# * Courier::Service::Email::ActionMailer
+# * Courier::Service::Email::MailChimp
+# * Courier::Service::Twitter::Grackle
+# * Courier::Service::Flash::GritterNotice
+
+# доставщики подключаются через команду
+# Courier.register_service(SMS::LittleSMS, Email::ActionMailer,.. )
+
+require 'ostruct'
+
+class Courier::Service::Base
+  class << self
+    def inherited(subclass)
+      subclass.instance_variable_set('@config', OpenStruct.new)
+      super
+    end
+
+    def configure
+      yield @config
+    end
+
+    def config
+      @config
+    end
+  end
+
+  def check_args owner, template, args
+    args[:owner]  ||=owner
+    args[:text]   ||=template.get_text(args)
+    args[:service]||=self
+  end
+
+  def message(owner, template, args)
+    check_args owner, template, args
+    courier_messages.create! :owner=>owner, :template=>template, :options=>args
+  end
+
+  def name
+    self.class.name.demodulize.underscore.to_sym
+  end
+
+  def deliver!
+    raise 'inherit my class and implement me'
+  end
+end

data/lib/courier/service/facebook.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+class Courier::Service::Facebook < Courier::Service::Base
+  def initialize
+    raise "No Koala defined. Add gem 'koala' to your Gemfile. " unless defined? Koala
+    super
+  end
+
+  def check_args owner, template, args
+    args[:to]|='me'
+    args[:attachment]||={}
+    super
+  end
+
+  def deliver!
+    cache={}
+    courier_messages.fresh.each do |message|
+      message.owner.respond_to?(:facebook_token) or
+        raise "method facebook_token is not defined in your owner's model #{owner.class}"
+      token = message.owner.facebook_token or raise "owner's facebook_token is empty"
+      graph = cache[token] ||= Koala::Facebook::GraphAPI.new(token)
+      graph.put_wall_post(message.options[:text], message.options[:attachment], message.options[:to]) and
+        message.set_delivered
+    end
+  end
+end

data/lib/courier/service/gritter_notice.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+class Courier::Service::GritterNotice < Courier::Service::Base
+  def initialize
+    raise "No GritterNotices. Add gem 'gritter_notices' to Gemfile." unless defined? GritterNotices
+    super
+  end
+
+  def message(owner, template, options)
+    options[:scope]=[:courier,:messages,:gritter_notice] unless options[:scope]
+    options[:text]=I18n::translate(name, options )
+    owner.gritter_notice template.name, options
+  end
+
+  def deliver!
+    # Nothng to do, it's realtime delivered
+  end
+end

data/lib/courier/template/base.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+class Courier::Template::Base
+
+  attr_accessor :name, :defaults
+
+  def initialize(args)
+    self.name = args[:name].to_sym or raise 'no template name defined'
+    self.defaults={}
+  end
+
+  def get_text(args)
+    args[:scope]=[:courier,:messages,args[:service].name] unless args[:scope]
+    args[:cascade]=true unless args.has_key? :cascade
+    I18n::translate(name, args )
+  end
+
+  def get(service)
+    service = Courier.service(service) if service.is_a?(Symbol)
+    name = service.name.to_sym
+    raise "Not defined default value for #{service} in template #{self}" unless defaults.has_key? name
+    defaults[name]
+  end
+
+  def set(service, val)
+    service = Courier.service(service) if service.is_a?(Symbol)
+    defaults[service.name.to_sym] = check_val(val)
+  end
+
+  def key
+    name
+  end
+
+  private
+
+  def check_val(val)
+    raise "Value must be :on or :off" unless val==:on or val==:off
+    val
+  end
+
+
+end

data/lib/generators/courier_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CourierGenerator < Rails::Generators::Base
+  desc "This generator creates an initializer file at config/initializers/courier.rb and migration file."
+
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_courier_tables.rb'
+  end
+
+  def create_initializer_file
+    copy_file "courier.rb", "config/initializers/courier.rb"
+    # create_file "config/initializers/courier.rb", "# Add initialization content here"
+  end
+end

data/lib/generators/templates/courier.rb

@@ -0,0 +1,7 @@
+Courier.init do |d|
+  raise 'Make your own settings'
+  # d.services                       :active_mailer, :gritter_notice, :facebook
+  # d.template :import_complete,     :off,           :on,              :off
+  # d.template :avatar_loaded,       :on,            :off,             :on
+  # d.template :weekly_subscription, :on,            :on,              :on
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+class CreateCourierTables < ActiveRecord::Migration
+  def self.up
+    create_table :courier_owner_setting, :force => true do |t|
+      t.integer  :owner_id,                           :null => false
+      t.string   :owner_type,                         :null => false
+      t.text     :settings,                           :null => false
+      t.timestamps
+    end
+
+    add_index :courier_owner_setting, [:owner_id, :owner_type], :unique=>true
+
+    # create_table :courier_templates, :force => true do |t|
+    #   t.string   :key,                         :null => false, :unique=>true
+    #   t.text     :settings,                    :null => false
+    #   t.timestamps
+    # end
+
+    create_table :courier_messages, :force => true do |t|
+      t.integer   :owner_id,                           :null => false
+      t.string    :owner_type,                         :null => false
+      t.integer   :template_id,                        :null => false
+      t.integer   :service_id,                         :null => false
+      t.string    :state,                              :null => false
+      t.text      :options,                            :null => false
+      t.timestamp :delivered_at
+      t.timestamps
+    end
+
+    add_index :courier_messages, [:service_id, :state]
+  end
+
+  def self.down
+    # drop_table :gritter_notices
+  end
+end

data/spec/courier/config_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Courier::Config do
+  before do
+    subject.services :active_mailer, :facebook
+  end
+
+  describe '#services' do
+    it 'initialize services by name and preserve order' do
+      subject.services.first.should be_kind_of(Courier::Service::ActiveMailer)
+      subject.services.last.should be_kind_of(Courier::Service::Facebook)
+    end
+
+    it 'return ordered list of services when called with not args' do
+      services=[1,2,3]
+      subject.should_receive(:services_order) { services }
+      subject.services.should == services
+    end
+  end
+
+  describe '#get_service'
+
+  describe '#template' do
+    it 'sets default values for template' do
+      subject.template :import_complete, :on, :off
+      subject.get_template(:import_complete).should be_kind_of(Courier::Template::Base)
+    end
+
+    it 'raise errors when services counts not much' do
+      expect { subject.template :import_complete, :on, :off, :off }.to raise_error
+    end
+
+    it 'raise errors when value unknown' do
+      expect { subject.template :import_complete, :on, :bad_value }.to raise_error
+    end
+  end
+end

data/spec/courier/message_spec.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Courier::Message do
+
+  it { should belong_to(:owner) }
+  it { should belong_to(:template) }
+  it { should belong_to(:service) }
+
+  it { should validate_presence_of(:owner) }
+  it { should validate_presence_of(:service) }
+  it { should validate_presence_of(:template) }
+
+  describe do
+    before do
+      pending
+    end
+  end
+end