new_data_notifier 0.0.3 → 0.1.2

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0.0"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+group :development do
+  gem "sqlite3-ruby", :require => "sqlite3"
+  gem "bundler"
+  gem "jeweler"
+  gem "rcov"
+  gem "reek"
+end
+
+group :test do
+  gem "timecop"
+  gem "factory_girl", :require => "factory_girl", :git => "git://github.com/thoughtbot/factory_girl.git"
+  gem "shoulda", :require => "shoulda"
+  gem "test_benchmarker"
+  gem "rack-test", :require => "rack/test"
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+GIT
+  remote: git://github.com/thoughtbot/factory_girl.git
+  revision: 4f5f5df39a1b565160ad7138a1f7d7a7c836664d
+  specs:
+    factory_girl (2.0.0.beta2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    shoulda (2.11.3)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    test_benchmarker (1.2.1)
+    thor (0.14.6)
+    timecop (0.3.5)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  factory_girl!
+  jeweler
+  rack-test
+  rails (>= 3.0.0)
+  rcov
+  reek
+  shoulda
+  sqlite3-ruby
+  test_benchmarker
+  timecop

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.mkd

@@ -0,0 +1,26 @@
+New Data Notifier
+===============
+
+If there is some new users signed up on your site or some new articles been added by some other user, If you hope been notified, please execute "gem install new_data_notifier"
+
+Install
+=======
+
+1. Execute "rails generate new_data_notifier:config"
+
+2. Change the config in new_data_notifier.rb which placed in initializers dir, below is a sample:
+
+    NewDataNotifier.default_recipients = ["hlxwell@gmail.com"]
+
+    NewDataNotifier.be_monitored_models = ["Job", "Partner"]
+
+    NewDataNotifier.sender_address = ["new_data@gmail.com"]
+
+3. Add cron task.
+
+    */20 * * * * sh -c "cd /home/michael.he/app/current && rake send_latest_data RAILS_ENV=production"
+
+
+Copyright
+=========
+Copyright (c) 2010 Michael He, released under the MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+# jeweler
+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 = "new_data_notifier"
+  gem.homepage = "http://github.com/hlxwell/new_data_notifier"
+  gem.license = "MIT"
+  gem.summary = %Q{If there is some new users signed up on your site or some new articles been added by some other user, If you hope been notified, please execute "gem install new_data_notifier}
+  gem.description = %Q{If there is some new users signed up on your site or some new articles been added by some other user, If you hope been notified, please execute "gem install new_data_notifier}
+  gem.email = "hlxwell@gmail.com"
+  gem.authors = ["michael he"]
+  # 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
+
+# Rcov
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# Reek tasks
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+# test tasks
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task :default => :test

data/VERSION

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

data/app/mailers/new_data_notifier/notifier.rb

@@ -0,0 +1,97 @@
+module NewDataNotifier
+  class NoFileFound < StandardError; end
+
+  class Notifier < ActionMailer::Base
+    # methods for setting configs
+    class << self
+      def default_recipients=(recipients)
+        @@recipients = recipients
+      end
+
+      def default_recipients
+        @@recipients ||= []
+      end
+
+      def be_monitored_models=(models)
+        @@models = models
+      end
+
+      def be_monitored_models
+        @@models ||= []
+      end
+
+      def sender_address=(address)
+        @@sender_address = address
+      end
+
+      def sender_address
+        @@sender_address ||= %("New Data Notifier" <newdata.notifier@example.com>)
+      end
+
+      def default_options
+        {
+          :sender_address => sender_address,
+          :recipients => default_recipients,
+          :subject => "[New Data Notification]"
+        }
+      end
+
+      # used to deliver all notification mails
+      def send_all_notification
+        # send mail
+        unless get_latest_added_data.select { |key, value| value.count > 0 }.blank?
+          NewDataNotifier::Notifier.notify(data_hash).deliver
+        end
+      end
+
+      def get_latest_added_data
+        # find data
+        data_hash = {}
+        NewDataNotifier::Notifier.be_monitored_models.each do |model|
+          data_hash[model.downcase.to_sym] = model.constantize.where("created_at >= ?", get_last_sent_at).order("created_at DESC")
+        end
+        data_hash.delete_if { |key, value| value.count == 0 }
+        data_hash
+      end
+
+      def get_last_sent_at
+        time_mark_file_path = File.join(Rails.root, 'tmp', 'last_notification_send_at')
+        # read last sent time, if blank, set current time.
+        begin
+          last_sent_at = Time.parse( File.read(time_mark_file_path) )
+          raise "tmp/last_notification_send_at not found" if last_sent_at.blank?
+        rescue
+          last_sent_at = Time.now
+        ensure
+          # have to ensure each time after finish send mail should change the last_notification_send_at
+          File.open(time_mark_file_path, "w") do |f|
+            f.write(Time.now)
+          end
+        end
+        last_sent_at
+      end
+
+    end
+
+    # notification event.
+    def notify(data_hash)
+      @data_hash = data_hash
+      options = self.class.default_options
+      mail(:to => options[:recipients], :from => options[:sender_address], :subject => options[:subject])
+    end
+
+    protected
+
+    helper_method :object_name
+    def object_name(obj)
+      if obj.respond_to?(:title) and obj.try(:title).present?
+        obj.title
+      elsif obj.respond_to?(:name) and obj.try(:name).present?
+        obj.name
+      else
+        "#{obj.class}##{obj.id}"
+      end
+    end
+  end
+
+end

data/app/views/new_data_notifier/notifier/notification.text.erb

@@ -0,0 +1,8 @@
+<% @data_hash.each do |key, value| %>
+
+============ New <%= key %>(s) (<%= value.size %>) ================
+  <% value.each do |obj| %>
+    <%=  object_name(obj) %> --- created at: <%= obj.created_at.to_s(:db) %>
+  <% end %>
+
+<% end %>

data/lib/new_data_notifier/engine.rb

@@ -0,0 +1,11 @@
+module NewDataNotifier
+  class Engine < Rails::Engine
+    rake_tasks do
+      load 'new_data_notifier/tasks/notifier.rake'
+    end
+
+    generators do
+      require 'new_data_notifier/generators/create_config.rb'
+    end
+  end
+end

data/lib/new_data_notifier/generators/create_config.rb

@@ -0,0 +1,10 @@
+module NewDataNotifier
+  class CreateConfig < Rails::Generators::Base
+    desc "Add a config file."
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_config_file
+      template "new_data_notifier.rb", "config/initializers/new_data_notifier.rb"
+    end
+  end
+end

data/lib/new_data_notifier/generators/templates/new_data_notifier.rb

@@ -0,0 +1,3 @@
+NewDataNotifier::Notifier.default_recipients = ["you_email@example.com"]
+NewDataNotifier::Notifier.be_monitored_models = ["User"]
+NewDataNotifier::Notifier.sender_address = ["you_email@example.com"]

data/lib/new_data_notifier/tasks/notifier.rake

@@ -0,0 +1,6 @@
+namespace :new_data_notifier do
+  desc "send latest data"
+  task :send_latest_data => :environment do
+    NewDataNotifier::Notifier.send_all_notification
+  end
+end

data/lib/new_data_notifier.rb

@@ -1,68 +1 @@
-# NewDataNotifier
-require 'action_mailer'
-require 'railtie'
-
-##
-# Mail template
-#
-class NewDataNotifier < ActionMailer::Base
-  self.mailer_name = 'new_dat_notifier'
-  self.append_view_path "#{File.dirname(__FILE__)}/../app/views"
-
-  class << self
-    def default_recipients=(recipients)
-      @@recipients = recipients
-    end
-
-    def default_recipients
-      @@recipients ||= []
-    end
-
-    def be_monitored_models=(models)
-      @@models = models
-    end
-
-    def be_monitored_models
-      @@models ||= []
-    end
-
-    def sender_address=(address)
-      @@sender_address = address
-    end
-
-    def sender_address
-      @@sender_address ||= %("New Data Notifier" <newdata.notifier@example.com>)
-    end
-
-    def default_options
-      {
-        :sender_address => sender_address,
-        :recipients => default_recipients,
-        :subject => "[New Data Notification]"
-      }
-    end
-  end
-
-  # notification event.
-  def notification(data_hash)
-    @data_hash = data_hash
-    options = self.class.default_options
-    mail(:to => options[:recipients], :from => options[:sender_address], :subject => options[:subject]) do |format|
-      format.text { render "new_data_notifier/notification" }
-    end
-  end
-
-  protected
-
-  helper_method :object_name
-  def object_name(obj)
-    if obj.respond_to?(:title) and obj.try(:title).present?
-      obj.title
-    elsif obj.respond_to?(:name) and obj.try(:name).present?
-      obj.name
-    else
-      "#{obj.class}##{obj.id}"
-    end
-  end
-
-end
+require 'new_data_notifier/engine'

data/new_data_notifier.gemspec

@@ -0,0 +1,130 @@
+# 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{new_data_notifier}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["michael he"]
+  s.date = %q{2011-03-17}
+  s.description = %q{If there is some new users signed up on your site or some new articles been added by some other user, If you hope been notified, please execute "gem install new_data_notifier}
+  s.email = %q{hlxwell@gmail.com}
+  s.extra_rdoc_files = [
+    "README.mkd"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.mkd",
+    "Rakefile",
+    "VERSION",
+    "app/.DS_Store",
+    "app/mailers/new_data_notifier/notifier.rb",
+    "app/views/new_data_notifier/notifier/notification.text.erb",
+    "lib/.DS_Store",
+    "lib/new_data_notifier.rb",
+    "lib/new_data_notifier/engine.rb",
+    "lib/new_data_notifier/generators/create_config.rb",
+    "lib/new_data_notifier/generators/templates/new_data_notifier.rb",
+    "lib/new_data_notifier/tasks/notifier.rake",
+    "new_data_notifier.gemspec",
+    "test/dummy/Rakefile",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/models/user.rb",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/database.yml",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/new_data_notifier.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/db/migrate/20110317034437_create_users.rb",
+    "test/dummy/db/schema.rb",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/public/javascripts/application.js",
+    "test/dummy/public/javascripts/controls.js",
+    "test/dummy/public/javascripts/dragdrop.js",
+    "test/dummy/public/javascripts/effects.js",
+    "test/dummy/public/javascripts/prototype.js",
+    "test/dummy/public/javascripts/rails.js",
+    "test/dummy/public/stylesheets/.gitkeep",
+    "test/dummy/script/rails",
+    "test/integration/new_data_notifier_test.rb",
+    "test/support/integration_case.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/hlxwell/new_data_notifier}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.1}
+  s.summary = %q{If there is some new users signed up on your site or some new articles been added by some other user, If you hope been notified, please execute "gem install new_data_notifier}
+  s.test_files = [
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/models/user.rb",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/new_data_notifier.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/routes.rb",
+    "test/dummy/db/migrate/20110317034437_create_users.rb",
+    "test/dummy/db/schema.rb",
+    "test/integration/new_data_notifier_test.rb",
+    "test/support/integration_case.rb",
+    "test/test_helper.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<rails>, [">= 3.0.0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<reek>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<reek>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<reek>, [">= 0"])
+  end
+end
+

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

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

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "new_data_notifier"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    config.time_zone = 'Beijing'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end