RubyGems - notify_on - Versions diffs - 1.0.1 - Mend

notify_on 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (135) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +29 -0
data/Rakefile +37 -0
data/app/assets/config/notify_on_manifest.js +2 -0
data/app/assets/javascripts/notify_on/application.js +13 -0
data/app/assets/stylesheets/notify_on/application.css +15 -0
data/app/controllers/notify_on/application_controller.rb +5 -0
data/app/helpers/notify_on/application_helper.rb +4 -0
data/app/helpers/notify_on/mailer_helper.rb +9 -0
data/app/jobs/notify_on/application_job.rb +4 -0
data/app/mailers/notify_on/application_mailer.rb +6 -0
data/app/mailers/notify_on/notification_mailer.rb +26 -0
data/app/models/concerns/notify_on/email_support.rb +97 -0
data/app/models/concerns/notify_on/pusher_support.rb +66 -0
data/app/models/concerns/notify_on/string_interpolation.rb +39 -0
data/app/models/notify_on/application_record.rb +5 -0
data/app/models/notify_on/notification.rb +86 -0
data/app/views/layouts/notify_on/application.html.erb +17 -0
data/app/views/notifications/notify.html.erb +9 -0
data/config/database.travis.yml +4 -0
data/config/routes.rb +2 -0
data/lib/generators/notify_on/install_generator.rb +29 -0
data/lib/generators/templates/notifications.yml +19 -0
data/lib/generators/templates/notify_on.rb +64 -0
data/lib/notify_on.rb +29 -0
data/lib/notify_on/bulk_config.rb +36 -0
data/lib/notify_on/configuration.rb +22 -0
data/lib/notify_on/creator.rb +85 -0
data/lib/notify_on/engine.rb +19 -0
data/lib/notify_on/notify_on.rb +36 -0
data/lib/notify_on/receives_notifications.rb +11 -0
data/lib/notify_on/utilities.rb +13 -0
data/lib/notify_on/version.rb +3 -0
data/lib/tasks/notify_on_tasks.rake +4 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/config/manifest.js +5 -0
data/spec/dummy/app/assets/javascripts/application.js +7 -0
data/spec/dummy/app/assets/javascripts/cable.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.scss +28 -0
data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
data/spec/dummy/app/controllers/application_controller.rb +7 -0
data/spec/dummy/app/controllers/messages_controller.rb +31 -0
data/spec/dummy/app/helpers/application_helper.rb +8 -0
data/spec/dummy/app/jobs/application_job.rb +2 -0
data/spec/dummy/app/mailers/application_mailer.rb +4 -0
data/spec/dummy/app/mailers/notification_mailer.rb +15 -0
data/spec/dummy/app/models/application_record.rb +3 -0
data/spec/dummy/app/models/comment.rb +10 -0
data/spec/dummy/app/models/message.rb +45 -0
data/spec/dummy/app/models/post.rb +11 -0
data/spec/dummy/app/models/user.rb +21 -0
data/spec/dummy/app/views/application/_header.html.erb +44 -0
data/spec/dummy/app/views/application/home.html.erb +1 -0
data/spec/dummy/app/views/layouts/application.html.erb +19 -0
data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
data/spec/dummy/app/views/messages/_message.html.erb +6 -0
data/spec/dummy/app/views/messages/index.html.erb +33 -0
data/spec/dummy/app/views/messages/new.html.erb +5 -0
data/spec/dummy/app/views/messages/show.html.erb +7 -0
data/spec/dummy/app/views/notifications/new_message.html.erb +9 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +34 -0
data/spec/dummy/bin/update +29 -0
data/spec/dummy/config.ru +5 -0
data/spec/dummy/config/application.rb +35 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/cable.yml +9 -0
data/spec/dummy/config/database.yml +12 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +58 -0
data/spec/dummy/config/environments/production.rb +86 -0
data/spec/dummy/config/environments/test.rb +42 -0
data/spec/dummy/config/initializers/application_controller_renderer.rb +6 -0
data/spec/dummy/config/initializers/assets.rb +11 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
data/spec/dummy/config/initializers/devise.rb +274 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/new_framework_defaults.rb +24 -0
data/spec/dummy/config/initializers/notify_on.rb +64 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/simple_form.rb +165 -0
data/spec/dummy/config/initializers/simple_form_bootstrap.rb +149 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/devise.en.yml +62 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/locales/simple_form.en.yml +31 -0
data/spec/dummy/config/notifications.yml +20 -0
data/spec/dummy/config/puma.rb +47 -0
data/spec/dummy/config/routes.rb +14 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/config/spring.rb +6 -0
data/spec/dummy/db/migrate/20160801112429_devise_create_users.rb +42 -0
data/spec/dummy/db/migrate/20160801130804_create_messages.rb +11 -0
data/spec/dummy/db/migrate/20160823102904_create_notify_on_notifications.rb +20 -0
data/spec/dummy/db/migrate/20161021100707_create_comments.rb +11 -0
data/spec/dummy/db/migrate/20161021100842_create_posts.rb +11 -0
data/spec/dummy/db/schema.rb +77 -0
data/spec/dummy/db/seeds.rb +4 -0
data/spec/dummy/lib/templates/erb/scaffold/_form.html.erb +13 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
data/spec/dummy/public/apple-touch-icon.png +0 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/spec/controllers/messages_controller_spec.rb +5 -0
data/spec/dummy/spec/factories/comments.rb +7 -0
data/spec/dummy/spec/factories/messages.rb +7 -0
data/spec/dummy/spec/factories/posts.rb +6 -0
data/spec/dummy/spec/factories/users.rb +6 -0
data/spec/dummy/spec/features/send_message_spec.rb +25 -0
data/spec/dummy/spec/mailers/notify_on/notification_mailer_spec.rb +30 -0
data/spec/dummy/spec/mailers/previews/notification_mailer_preview.rb +4 -0
data/spec/dummy/spec/models/comment_spec.rb +22 -0
data/spec/dummy/spec/models/message_spec.rb +60 -0
data/spec/dummy/spec/models/post_spec.rb +23 -0
data/spec/dummy/spec/models/user_spec.rb +21 -0
data/spec/factories/notify_on_notifications.rb +10 -0
data/spec/lib/notify_on/configuration_spec.rb +53 -0
data/spec/mailers/notify_on/notification_mailer_spec.rb +6 -0
data/spec/mailers/previews/notify_on/notification_mailer_preview.rb +6 -0
data/spec/models/notify_on/notification_spec.rb +335 -0
data/spec/rails_helper.rb +95 -0
data/spec/spec_helper.rb +103 -0
data/spec/support/feature_helpers.rb +19 -0
data/spec/support/general_helpers.rb +19 -0
metadata +543 -0

data/app/views/layouts/notify_on/application.html.erb ADDED

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Notify on</title>
+  <%= stylesheet_link_tag    "notify_on/application", media: "all" %>
+  <%= javascript_include_tag "notify_on/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<p class="notice"><%= notice %></p>
+<p class="alert"><%= alert %></p>
+<%= yield %>
+</body>
+</html>

data/app/views/notifications/notify.html.erb ADDED

@@ -0,0 +1,9 @@
+<p>Hey there, <%= @recipient.to_s %>!</p>
+<p>You have a new notification:</p>
+<blockquote>
+  <%= simple_format @notification.description %>
+</blockquote>
+<p>Cheers!</p>

data/config/database.travis.yml ADDED

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  database: travis_ci_test
+  username: postgres

data/config/routes.rb ADDED

	@@ -0,0 +1,2 @@
1	+ NotifyOn::Engine.routes.draw do
2	+ end

data/lib/generators/notify_on/install_generator.rb ADDED

@@ -0,0 +1,29 @@
+module NotifyOn
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+    def generate_migration
+      attrs  = "recipient_id:integer recipient_type:string sender_id:integer "
+      attrs += "sender_type:string unread:boolean trigger_id:integer "
+      attrs += "trigger_type:string description_raw:text "
+      attrs += "description_cached:text link_raw:string link_cached:string "
+      attrs += "options:text"
+      generate "migration create_notify_on_notifications #{attrs}"
+      gsub_file Dir.glob('db/migrate/*.rb').last, /t\.boolean\ \:unread/,
+                't.boolean :unread, :default => true'
+      gsub_file Dir.glob('db/migrate/*.rb').last, /t\.text\ \:options/,
+                "t.text :options\n      t.timestamps"
+    end
+    def copy_initializer
+      template "notify_on.rb", "config/initializers/notify_on.rb"
+    end
+    def copy_bulk_config
+      template "notifications.yml", "config/notifications.yml"
+    end
+  end
+end

data/lib/generators/templates/notifications.yml ADDED

@@ -0,0 +1,19 @@
+# This is the file that lets you configure notifications in bulk, instead of
+# using individual "notify_on" calls within your models.
+#
+# Do so by first specifying the underscored class name, and give each
+# notification a name. For example:
+#
+# message:
+#   message_sent:
+#     when: :save
+#     if: :active?
+#     unless: :from_unless?
+#     to: :user
+#     from: :author
+#     message: '{author.first_name} has sent you a message.'
+#     link: chat_path(:chat)
+#     email:
+#       template: new_message
+#       unless:  :pusher_recipient_active?
+#

data/lib/generators/templates/notify_on.rb ADDED

@@ -0,0 +1,64 @@
+# Use this file to set your application's configuration for NotifyOn.
+NotifyOn.configure do |config|
+  # ---------------------------------------- Email
+  # Email messages are a common way to let a user know they have a new
+  # notification. In some cases, you want that notification to come from another
+  # user. Other times, your system may handle it. Defining a default email
+  # address means that if you don't specify "to" when calling "notify_on", the
+  # default email address will be used.
+  #
+  # config.default_email = 'No Reply <noreply@yourdomain.com>'
+  #
+  # Note: You can use NotifyOn's string interpolation here. It will first
+  # attempt methods on the trigger, and then fallback to the notification.
+  # Therefore, you have access to the "sender" object, and could choose to
+  # default to the sender's email address, like so:
+  #
+  # config.default_email = '{sender.name} <{sender.email}>'
+  #
+  # You can also override the notification mailer class if you need to add
+  # custom functionality not supported in NotifyOn's NotificationMailer class.
+  #
+  # config.mailer_class = 'NotifyOn::NotificationMailer'
+  #
+  # NotifyOn's email notification service provides the option to use Active Job
+  # to send email messages in the background instead of during the request. If
+  # you enable Active Job, NotifyOn will use your application settings for
+  # Active Job. Learn more at
+  # http://guides.rubyonrails.org/active_job_basics.html
+  #
+  # config.deliver_mail = :now # or :later
+  # ---------------------------------------- Pusher
+  # Pusher enables you to send notifications in real-time. Learn more about
+  # Pusher at https://pusher.com. If you are going to use Pusher, you need to
+  # include the following values:
+  #
+  # config.pusher_app_id = 'my_app_id'
+  # config.pusher_key = 'my_key'
+  # config.pusher_secret = 'my_secret'
+  #
+  # Note: You may want to use environment-dependent values, not tracked by git,
+  # so your secrets are not exposed. You may choose to use Rails' secrets for
+  # this. For example:
+  #
+  # config.pusher_app_id = Rails.application.secrets.pusher_app_id
+  # config.pusher_key = Rails.application.secrets.pusher_key
+  # config.pusher_secret = Rails.application.secrets.pusher_secret
+  #
+  # While you can configure your Pusher event in each "notify_on" call, you can
+  # also set your default configuration so you don't have to restate it for
+  # every notification.
+  #
+  # config.default_pusher_channel = 'presence_{:env}_notification_{:recipient_id}'
+  # config.default_pusher_event = 'new_notification'
+  #
+  # You can use Pusher by default (which requires the channel and event be set
+  # above). Uncomment the following setting to do so.
+  #
+  # config.use_pusher_by_default = true
+end

data/lib/notify_on.rb ADDED

@@ -0,0 +1,29 @@
+require 'notify_on/engine'
+require 'notify_on/configuration'
+require 'notify_on/utilities'
+require 'notify_on/receives_notifications'
+require 'notify_on/creator'
+require 'notify_on/notify_on'
+require 'notify_on/bulk_config'
+require 'em-http-request'
+require 'hashie'
+require 'pusher'
+module NotifyOn
+  class << self
+    attr_writer :configuration
+  end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  def self.reset
+    @configuration = Configuration.new
+  end
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/notify_on/bulk_config.rb ADDED

@@ -0,0 +1,36 @@
+require 'yaml'
+module NotifyOn
+  class BulkConfig
+    def initialize(options = {})
+    end
+    def self.load
+      new.load
+    end
+    def load
+      return unless File.exists?(config_file) && config
+      config.each do |model_name, notification_name|
+        notification_name.each do |name, notify_on_config|
+          model_name.classify.constantize.class_eval do
+            notify_on (notify_on_config['action'] || notify_on_config['when']),
+                      notify_on_config.deep_symbolize_keys
+          end
+        end
+      end
+    end
+    private
+      def config_file
+        Rails.root.join('config', 'notifications.yml').to_s
+      end
+      def config
+        YAML.load_file(config_file)
+      end
+  end
+end

data/lib/notify_on/configuration.rb ADDED

@@ -0,0 +1,22 @@
+module NotifyOn
+  class Configuration
+    attr_accessor \
+      :default_email,
+      :default_pusher_channel,
+      :default_pusher_event,
+      :deliver_mail,
+      :mailer_class,
+      :pusher_app_id,
+      :pusher_key,
+      :pusher_secret,
+      :use_pusher_by_default
+    def initialize
+      @deliver_mail = :now
+      @mailer_class = 'NotifyOn::NotificationMailer'
+      @use_pusher_by_default = false
+    end
+  end
+end

data/lib/notify_on/creator.rb ADDED

@@ -0,0 +1,85 @@
+module NotifyOn
+  module Creator
+    private
+      def create_notify_on_notifications(options)
+        # skip_notifications disables all notifications for an instance.
+        return if skip_notifications == true
+        # Collect notifications so we can return the set if we are creating more
+        # than one (when "to" is an array or collection).
+        notifications = []
+        # "to" must be a method or attribute, and here we resolve it.
+        to = options[:to].to_s == 'self' ? self : send(options[:to].to_s)
+        # We don't need a sender all the time, but we figure out who it is now
+        # so we can more easily work with the object.
+        sender = options[:from].blank? ? nil : send(options[:from].to_s)
+        # Ensure "to" is an array so we can iterate over it, even if that's only
+        # happening once.
+        (to.respond_to?(:each) ? to : [to]).each do |recipient|
+          # If we have an update strategy, then we first need to look for an
+          # exiting notification.
+          notification = find_from_update_strategy(recipient, sender, options)
+          # Create a new notification if we didn't have an update strategy or
+          # couldn't find one. Much of the advanced work happens within the
+          # model, which is why we store "options" in the record.
+          notification = NotifyOn::Notification.new(
+            :recipient => recipient,
+            :sender => sender,
+            :description_raw => options[:message],
+            :options => options
+          ) if notification.nil?
+          # Update the shared attributes regardless of whether the notification
+          # is being created or updated.
+          notification.assign_attributes(
+            :unread => true,
+            :trigger => self,
+            :link_raw => options[:link]
+          )
+          # Make sure we can save the notification.
+          notification.save!
+          # Attempt to send the notification via Pusher. There are catches in
+          # place to prevent it from being pushed if disabled.
+          # -- NotifyOn::PusherSupport
+          notification.push!
+          # Send the notification via email, if requested.
+          # -- NotifyOn::EmailSupport
+          notification.send_email! if options[:email].present?
+          # Add notification to the collection for response.
+          notifications << notification
+        end
+        # Return the collection of notifications that we created.
+        notifications
+      end
+      def find_from_update_strategy(to, from, options)
+        # Exit if we don't have a strategy, and currently we only support the
+        # :sender strategy.
+        return nil unless options[:update] && options[:update][:strategy] &&
+                          options[:update][:strategy] == :sender &&
+                          from.present?
+        if (scope = options[:update][:scope]).present?
+          to.notifications.from_with_type(from, self.class.name).recent
+            .includes(:trigger => [scope])
+            .select{ |n| n.trigger.send(scope) == self.send(scope)}[0]
+        else
+          to.notifications.from_with_type(from, self.class.name).recent
+            .limit(1)[0]
+        end
+      end
+  end
+end

data/lib/notify_on/engine.rb ADDED

@@ -0,0 +1,19 @@
+module NotifyOn
+  class Engine < ::Rails::Engine
+    isolate_namespace NotifyOn
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+    config.after_initialize do
+      Rails.application.eager_load!
+      NotifyOn::BulkConfig.load
+    end
+  end
+end

data/lib/notify_on/notify_on.rb ADDED

@@ -0,0 +1,36 @@
+class << ActiveRecord::Base
+  def notify_on(action, options = {})
+    include NotifyOn::Creator
+    ([self] + self.descendants).each do |klass|
+      klass.class_eval do
+        has_many :notifications, -> { preloaded },
+                 :class_name => NotifyOn::Notification, :as => :trigger,
+                 :dependent => :destroy
+      end
+    end
+    attr_accessor :skip_notifications
+    method_to_s = NotifyOn::Utilities.callback_method_name(action, options)
+    method_sym = method_to_s.to_sym
+    send("after_#{(action.to_s == 'create') ? 'create' : 'update'}", method_sym)
+    define_method(method_to_s) do
+      # The action trigger needs to be create, save, or a true condition.
+      return unless %w(create update).include?(action.to_s) || send(action.to_sym)
+      # An optional if condition must be missing or true.
+      return unless options[:if].blank? || send(options[:if])
+      # An optional unless condition must be missing or false.
+      return unless options[:unless].blank? || !send(options[:unless])
+      # Create the notification if we get past all our checks.
+      create_notify_on_notifications(options)
+    end
+    private method_to_s.to_sym
+  end
+end

data/lib/notify_on/receives_notifications.rb ADDED

@@ -0,0 +1,11 @@
+class << ActiveRecord::Base
+  def receives_notifications
+      has_many :notifications, -> { preloaded },
+               :class_name => NotifyOn::Notification, :as => :recipient,
+               :dependent => :destroy
+  end
+end

data/lib/notify_on/utilities.rb ADDED

@@ -0,0 +1,13 @@
+module NotifyOn
+  class Utilities
+    def self.callback_method_name(action, options)
+      opts = options.merge(:action => action)
+      opts.each { |k, v| opts[k] = v.to_s.gsub(/\?/, '') }
+      "notify_#{opts[:to]}_on_#{opts[:action]}" +
+      ("_if_#{opts[:if]}" if opts[:if].present?).to_s +
+      ("_unless_#{opts[:unless]}" if opts[:unless].present?).to_s
+    end
+  end
+end

data/lib/notify_on/version.rb ADDED

@@ -0,0 +1,3 @@
+module NotifyOn
+  VERSION = '1.0.1'
+end

data/lib/tasks/notify_on_tasks.rake ADDED

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :notify_on do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile ADDED

@@ -0,0 +1,6 @@
+# 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_relative 'config/application'
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js ADDED

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link notify_on_manifest.js

data/spec/dummy/app/assets/javascripts/application.js ADDED

@@ -0,0 +1,7 @@
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap-sprockets
+$(document).ready(function(){
+  $('.dropdown-toggle').dropdown();
+});