courier 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format d

data/.watchr

@@ -0,0 +1,99 @@
+
+# https://github.com/rspec/rspec-rails/blob/master/specs.watchr
+
+# Other examples:
+# https://gist.github.com/298168
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+
+def all_spec_files
+  'spec/**/*_spec.rb'
+end
+
+def run_spec_matching(thing_to_match)
+  puts "Matching #{thing_to_match}"
+  matches = Dir[all_spec_files].grep(/#{thing_to_match}_spec/i)
+  if matches.empty?
+    puts "Sorry, thanks for playing, but there were no matches for #{thing_to_match}"
+  else
+    run matches.join(' ')
+  end
+end
+
+def run(files_to_run)
+  puts "Running #{files_to_run}"
+  system "bundle exec rspec -d #{files_to_run}"
+  no_int_for_you
+  notify
+  puts
+end
+
+def notify message=''
+  # message = message.split('---------------------------------------------------------------')[3].split('Time taken by tests')[0]
+  # image = message.include?('fails') ? "~/.watchr_images/failed.png" : "~/.watchr_images/passed.png"
+
+  # Grub images from autotest-growl
+  image = $?.success? ? "~/.watchr_images/passed.png" : "~/.watchr_images/failed.png"
+  message = $?.success? ? "success" : "failed"
+
+  options = "-i #{File.expand_path(image)} "
+  options += '-u critical -t 10000 ' unless $?.success?
+
+  notify_send = `which notify-send`.chomp
+  cmd = "#{notify_send} #{options} 'Watchr Test Results: #{message}'"
+  system cmd
+end
+
+def run_all_specs
+  run('spec/') #all_spec_files
+end
+
+
+# def run_suite
+#   system "clear"
+#   run_spec('spec/*/*_spec.rb spec/*/*/*_spec.rb')
+# end
+
+
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch('^app/(.*)\.(.*)') { |m| run_spec_matching(m[1]) }
+watch('^lib\/(.*)\.rb') { |m| run_spec_matching(m[1]) }
+watch('^spec\/(.*)_spec\.rb') { |m| run_spec_matching(m[1]) }
+watch('^spec\/factories/(.*)_factory\.rb') { |m| run_spec_matching(m[1]) }
+watch('^spec/spec_helper\.rb') { run_all_specs }
+watch('^spec/support/.*\.rb') { run_all_specs }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+
+def no_int_for_you
+  @sent_an_int = nil
+end
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @sent_an_int then
+    puts " A second INT? Ok, I get the message. Shutting down now."
+    exit
+  else
+    puts " Did you just send me an INT? Ugh. I'll quit for real if you do it again."
+    @sent_an_int = true
+    Kernel.sleep 1.5
+    run_all_specs
+  end
+end
+
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts " --- Running all tests ---\n\n"
+  run_suite
+end
+
+puts "Watching.."

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem 'activerecord', "~> 3.0"
+gem 'actionpack', "~> 3.0"
+gem 'state_machine', "~> 0.10.2"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem 'pg'
+  gem "ruby-debug"
+  gem "watchr"
+  gem "sqlite3"
+  gem "factory_girl"
+  gem "shoulda", ">= 0"
+  gem "rspec", "~> 2.5"
+  gem "rspec-rails"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Danil Pismenny
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,98 @@
+= Courier
+
+Давным давно, в одной далекой-предалекой галактике, был такой модем USR Courier,
+он хорошо держал карриер и был мечтой каждого фидошника. А сейчас чтобы получать
+много не нужных писем достаточно зарегистрироваться на еще одной социальной
+сети.
+
+Чтобы помочь социальной сети справиться с большим количеством видов подписок и
+оповещений, а пользователю настроить способы их доставки мы разработали плагин
+Courier. Courier On Rails.
+
+Courier - Система управления пользовательскими оповещениями и подписоками.
+
+== Установка
+
+Gemfile:
+
+   gem 'courier'
+
+Создание миграции и конфигцарции <tt>./config/initializers/courier.rb</tt>
+
+   rails g courier
+
+   rake db:migrate
+
+В <tt>config/initializers/courier.rb</tt> регистрируем используемые сервисы, шаблоны и их значения по умолчанию:
+
+    Courier.init do |d|
+      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
+
+В модели пользователя:
+
+  class User << ActiveRecord::Base
+    has_courier
+    ...
+
+== Использование
+
+Посылаем пользователю сообщение по шаблону <tt>:import_complete<tt> во все разрешенные сервисы
+
+    user.message :import_complete, {:some=>'arguments in hash'}
+
+Если сервис отправляет сообщение в реальном времени, то он его уже
+отправил, а если сообщения собираются для дальнейшей отправки, то
+осуществляется эта доставка так:
+
+    Courier.deliver_all!
+
+== Сервисы
+
+На данный момент реализованы сервисы:
+
+* Courier::Service::GritterNotice - отправка сообщений через gritter_notices[http://github.com/dapi/gritter_notices]
+* Courier::Service::ActionMailer  - TODO
+* Courier::Service::MailChimp     - TODO
+* Courier::Service::Facebook      - Использует Koala[https://github.com/arsduo/koala]
+
+== Свой сервис
+
+Все сервисы наследуютсяо от <tt>Courier::Service::Base</tt>. Последнее
+имя класс автоматически становится именем этого сервиса через
+<tt>demodulize.underscore</tt>. Всего нужно имплементировать 2 метода:
+
+* message(owner, template, args)
+* deliver!
+
+=== Сервис отложенной отправки
+
+Достаточно реализовать метод <tt>deliver!</tt>, так как +message+ удачно складывает все сообщения в базу. Например:
+
+    def deliver!
+      courier_messages.fresh.each do |message|
+        send_message_my_way message.owner, message.text
+      end
+    end
+
+=== Сервис отправки в реальном времени
+
+Достаточно реализоват метод +message+. Например:
+
+    def message(owner, template, args)
+      send_message_my_way owner, template.get_text(args)
+    end
+
+
+
+== Contributing to courier
+
+* Yes, please.
+
+== Copyright
+
+Copyright (c) 2011 Danil Pismenny.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "courier"
+  gem.homepage = "http://github.com/dapi/courier"
+  gem.license = "MIT"
+  gem.summary = "Система управления пользовательскими оповещениями и подписками"
+  gem.description = 'Система управления пользовательскими оповещениями и подписками'
+  gem.email = "danil@orionet.ru"
+  gem.authors = ["Danil Pismenny"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "courier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/courier.gemspec

@@ -0,0 +1,135 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{courier}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Danil Pismenny"]
+  s.date = %q{2011-04-02}
+  s.description = %q{Система управления пользовательскими оповещениями и подписками}
+  s.email = %q{danil@orionet.ru}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".watchr",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "courier.gemspec",
+    "lib/courier.rb",
+    "lib/courier/config.rb",
+    "lib/courier/engine.rb",
+    "lib/courier/message.rb",
+    "lib/courier/owner.rb",
+    "lib/courier/owner_setting.rb",
+    "lib/courier/service/active_mailer.rb",
+    "lib/courier/service/base.rb",
+    "lib/courier/service/facebook.rb",
+    "lib/courier/service/gritter_notice.rb",
+    "lib/courier/template/base.rb",
+    "lib/generators/courier_generator.rb",
+    "lib/generators/templates/courier.rb",
+    "lib/generators/templates/migration.rb",
+    "spec/courier/config_spec.rb",
+    "spec/courier/message_spec.rb",
+    "spec/courier/owner_setting_spec.rb",
+    "spec/courier/owner_spec.rb",
+    "spec/courier/service/base_spec.rb",
+    "spec/courier/service/facebook_spec.rb",
+    "spec/courier/service/gritter_notice_spec.rb",
+    "spec/courier/template/base_spec.rb",
+    "spec/courier_spec.rb",
+    "spec/examples/example1_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factories.rb",
+    "spec/support/gems_simulation.rb",
+    "spec/support/migration.rb",
+    "spec/support/mocks.rb",
+    "spec/support/user.rb"
+  ]
+  s.homepage = %q{http://github.com/dapi/courier}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Система управления пользовательскими оповещениями и подписками}
+  s.test_files = [
+    "spec/courier/config_spec.rb",
+    "spec/courier/message_spec.rb",
+    "spec/courier/owner_setting_spec.rb",
+    "spec/courier/owner_spec.rb",
+    "spec/courier/service/base_spec.rb",
+    "spec/courier/service/facebook_spec.rb",
+    "spec/courier/service/gritter_notice_spec.rb",
+    "spec/courier/template/base_spec.rb",
+    "spec/courier_spec.rb",
+    "spec/examples/example1_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factories.rb",
+    "spec/support/gems_simulation.rb",
+    "spec/support/migration.rb",
+    "spec/support/mocks.rb",
+    "spec/support/user.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<state_machine>, ["~> 0.10.2"])
+      s.add_development_dependency(%q<pg>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<watchr>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.0"])
+      s.add_dependency(%q<actionpack>, ["~> 3.0"])
+      s.add_dependency(%q<state_machine>, ["~> 0.10.2"])
+      s.add_dependency(%q<pg>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<watchr>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.0"])
+    s.add_dependency(%q<actionpack>, ["~> 3.0"])
+    s.add_dependency(%q<state_machine>, ["~> 0.10.2"])
+    s.add_dependency(%q<pg>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<watchr>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/courier.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+module Courier
+  require 'courier/owner_setting'
+  require 'courier/config'
+  module Service
+    require 'courier/service/base'
+    Dir["#{File.dirname(__FILE__)}/courier/service/**/*.rb"].each {|f| require f}
+  end
+  module Template
+    require 'courier/template/base'
+  end
+
+  class << self
+    cattr_accessor :config
+
+    def init
+      yield self.config = Courier::Config.new
+    end
+
+    def deliver_all!
+      config.services.each do |service|
+        service.deliver!
+      end
+    end
+
+    def template(name)
+      config.get_template(name)
+    end
+
+    def service(name)
+      config.get_service(name)
+    end
+  end
+end
+
+require 'courier/message'
+
+require 'courier/owner'
+ActiveRecord::Base.send(:extend, Courier::Owner )
+
+#require 'gritter_notices/view_helpers' ActionView::Base.send(:include, GritterNotices::ViewHelpers )
+# require 'gritter_notices/rspec_matcher'
+
+require 'courier/engine' if defined?(Rails)
+
+