simply_notify 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bea5ac724667e4f1716048cd88349a515d35344
-  data.tar.gz: fce621386c319fa213ef08ca5573fd1ea2bdbb28
+  metadata.gz: 46c6e557ede2e4b6a9815f391f708f0a146f54c5
+  data.tar.gz: 97c24083c8b87635431a44415cbc4e27ce3f0faf
 SHA512:
-  metadata.gz: 01e96a4d7e65d5511e6cbe1d700230c5311f4ec155c84d4ddd50355076628b08c72874b356dffea6c68867438d34edc02c45b7bc0efa38e2437cd781e0c43dd4
-  data.tar.gz: 23bf64091c008b91c8804b69a7201dfceaff1713f3fd4ba66eba1c238f20ecbc3e6443bc1bfadeada26b821738aa6f9dcc218615b4ccf3893f7c94a81d02837c
+  metadata.gz: 2b180c9479e94d35d5e83bb9dbbbb01aa83c48cc02b0b68afaf0d553c81e3dbb9ebd5e0f29bf7c85d82e61f61b2d5cbac93073c690d19ecee219dcd6b81fe9b2
+  data.tar.gz: 6395e4da8ab81d55b563eb9be04d2473b64738803eb423051d3bd4e8cedffc72ce600d0586a707e88a29eb9be15c8f3636e2d602dcb1f52069e1ef3cc2ac3cfd

data/README.md

@@ -1,9 +1,6 @@
 # SimplyNotify
 
-simply_notify will send a user of the website an email notifying the user of a new notification that has been posted to their user account. It will also provide a link to the notifcation source (or homepage) and also track analytics such as when the user opens the notification email. 
-
-Check out ahoy_email for more information on email analytics --> https://github.com/ankane/ahoy_email
-
+simply_notify allows users to set preferences on how they want to receive notifications. Notifications are sent to users via email using actionmailer. Users can set their account preferences to receive notifications either in real time or a list of notifications every 24 hours. Ahoy_email is used for email tracking. For more information on gem dependncies of simply_notify, check out the additional information section. 
 
 # Installation
 
@@ -21,86 +18,200 @@ Or install it yourself as:
 
     $ gem install simply_notify
 
-
 # Usage
 
 ###Step 1
 
-Generate Notifier Mailer, Notifier Views, and ahoy_email Initializer.
-
-	rails generate notifier
+Generate mailer, views, and ahoy_email initializer.
 
+	$ rails generate notifier
 
 ###Step 2
 
 Generate ahoy_messages table.
     
-    rails generate ahoy_email:install
-    rake db:migrate
-
+    $ rails generate ahoy_email:install
+    $ rake db:migrate
 
 ###Step 3
 
-Setup controller where you want the notifications to be created.
+Generate notifications table.
+
+    $ rails g migration add_notificationFrequency_to_users notifificationFrequency:integer
+    $ rake db:migrate
+
+notificationFrequency values:
+nil or 0 = user does not receive notifications via email
+1 = user receives notifications in real time via email
+2 = user receives a list of notifications every 24 hours via email
+
+###Step 4
+
+Generate notifications model.
+    
+    $ rails g model Notification recipient_id:integer creator_id:integer action:string url:string
+    $ rake db:migrate
+
+###Step 5 
+
+Generate notifications controller.
 
-For example, if you want each user to be notified when an assignment is created, a link to the homepage included in the email, and the email subject to be 'New Assignment Posted' use a call such as this (added to app/controllers/assignments_controller.rb)
+    $ rake g controller notifications
 
-    # simply_notify: Most recent ID
-    most_recent_id = Assignment.maximum('id')
+###Step 6
 
-    # simply_notify: Notification source URL link 
-    url = "http://localhost:3000/assignments/postlist?id=#{most_recent_id}"
+Generate config/schedule.rb for cron jobs. 
+    
+    $ cd /apps/my-great-project
+    $ wheneverize .
+
+###Step 7
 
-    # simply_notify: Deliver email to each user
-    # use nil as parameter if you want url link to be the homepage
-    # use url as parameter if you want url link to be the source of the notification
+Add create/mailer to create method in appropriate controllers, such as this example in controllers/assignments_controller.rb.
+
+    if Assignment.where(:id) != nil
+      most_recent_id = Assignment.maximum(:id).next
+    else 
+      most_recent_id = 1
+    end 
+    url = "http://localhost:3000/posts?assignment_id=#{most_recent_id}"
     @users = User.all 
     @users.each do |u| 
-      Notifier.new_notification(u, url, 'New Assignment Posted').deliver_now
+      Notification.create(recipient: u, action: "New Assignment", url: url)
+      if (u.notificationFrequency == 1 || u.admin == true)
+        # use nil as parameter if you want link to be homepage, can also use url 
+        # change title of email by changing 'Notifications'
+        Notifier.new_notification(u, nil, 'Notifications').deliver_now
+      end 
     end
 
+###Step 8
 
-###Step 4
-
-Configure SMTP settings and set homepage as absolute url.
-
-For example, sending emails from a gmail account (added to appropriate environments, such as config/environments/development.rb):
+Configure SMTP settings for sending from gmail account and set homepage as absolute url (add to appropriate environments, such as config/environments/development.rb).
 
     # SMTP Config
-    # Set as your homepage
-    config.absolute_site_url = 'http://localhost:3000/'     
-    # Set as your from email 
-    config.action_mailer.default_options = {
-    from: "YOUR_FROM_EMAIL@gmail.com"  
-    }
-    # Set as the host
-    config.action_mailer.default_url_options = {:host => "localhost:3000"} 
+    config.absolute_site_url = 'http://localhost:3000/' #Set as your homepage  
+    config.action_mailer.default_options = { 
+    from: "YOUR_FROM_EMAIL@gmail.com" #Set as your from email 
+    }  
+    config.action_mailer.default_url_options = {:host => "localhost:3000"} #Set as the host
     config.action_mailer.delivery_method = :smtp
     config.action_mailer.perform_deliveries = true 
     config.action_mailer.smtp_settings = {
     address:              'smtp.gmail.com',
     port:                 587,
     domain:               'gmail.com',
-    # Set as your email
-    user_name:            'YOUR_USERNAME@gmail.com',
-    # Set as your password
-    password:             'YOUR_PASSWORD', 
+    user_name:            'YOUR_USERNAME@gmail.com', #Set as your email
+    password:             'YOUR_PASSWORD', #Set as your password
     authentication:       'plain',
     enable_starttls_auto: true  }
 
+###Step 9
+
+Edit configure_permitted_parameters method in controllers/application_controller.rb
+
+    def configure_permitted_parameters
+      devise_parameter_sanitizer.for(:sign_up) { |u| u.permit(:name, :email, :password, :password_confirmation, :optout, :nickname, :notificationFrequency) }
+      devise_parameter_sanitizer.for(:account_update) { |u| u.permit(:name, :email, :password, :password_confirmation, :optout, :nickname, :notificationFrequency, :current_password) }
+    end
+
+###Step 10 
+
+Add radio buttons to view/devise/registrations/edit.html.erb form.
+
+    <div class="field">
+      <h2>Notification Frequency</h2>
+      <p>Select from one of the options below:</p>
+      <%= f.radio_button :notificationFrequency, nil %>
+      <%= f.label("I do not want to receive notifications by email") %></br>
+      <%= f.radio_button :notificationFrequency, 1 %>
+      <%= f.label("I want to receive a single notification by email every time a new notifcation appears on my account") %></br>
+      <%= f.radio_button :notificationFrequency, 2 %>
+      <%= f.label("I want to receive a list of notifications for my account by email every 24 hours") %></br>
+    </div>
+
+Add radio buttons to view/devise/registrations/new.html.erb form.
 
-###IMPORTANT NOTE 
+    <div class="field">
+      <h2>Notification Frequency</h2>
+      <p>Select from one of the options below (this can be changed in your profile preferences at any time):</p>
+      <%= f.radio_button :notificationFrequency, nil %>
+      <%= f.label("I do not want to receive notifications by email") %></br>
+      <%= f.radio_button :notificationFrequency, 1 %>
+      <%= f.label("I want to receive a single notification by email every time a new notifcation appears on my account") %></br>
+      <%= f.radio_button :notificationFrequency, 2 %>
+      <%= f.label("I want to receive a list of notifications for my account by email every 24 hours") %></br>
+    </div>
 
-If you are using a localhost for development, such as localhost:3000, you will need to allow your system to be reachable from the outside in order to populate data into ahoy_messages table for opened_at. When the user opens their email, the image tag is fetched from your application server. The system must be reachable or it won't updated ahoy and values will appear as 'nil' in the table. 
+###Step 11
 
-A service such as pagekite will do the trick!
+Setup cron job frequency in config/schedule.rb.
 
+    every 1.day, :at => '8:00 pm' do
+      rake "cron:deliver_emails"
+    end
+
+Create file as lib/tasks/cron.rake and set rake schedule.
+
+    namespace :cron do
+      desc "Send notification emails every 24 hours"
+      task deliver_emails: :environment do
+        users = User.where(notificationFrequency: 2)
+        users.each do |u|
+          Notifier.new_notification(u, nil, 'Daily Notifications').deliver_now 
+        end
+      end
+    end
+
+###Step 12 
+
+Add associations to Notification model in model/notification.rb.
+
+    belongs_to :recipient, class_name: "User"
+    belongs_to :creator, class_name: "User"
+
+Add associations to User model in model/user.rb.
+
+    has_many :notifications
+
+Add associations to any other models in which notifications are generated in their respective controllers.
+
+    has_many :notifications
+
+###Step 13
+
+Add route to config/routes.rb.
+
+    resources :notifications
+
+###Step 14
+
+Add to notifications controller.
+
+    cclass NotificationsController < ApplicationController
+      before_action :authenticate_user!
+
+      def index
+        @notifications = Notification.where(recipient: current_user)
+      end
+    end
+
+# Additional Information
+
+Check out the ahoy_email gem for more information on email analytics --> https://github.com/ankane/ahoy_email
+
+Check out the whenever gem for more information on cron jobs --> https://github.com/javan/whenever
+
+Check out the devise gem for more information on user authentication --> https://github.com/plataformatec/devise
+
+###Important Note for Email Tracking
+
+If you are using a localhost for development, such as localhost:3000, you will need to allow your system to be reachable from the outside in order to populate data into the ahoy_messages table for opened_at tracking. When the user opens their email, the image tag is fetched from your application server. The system must be reachable or it won't updated ahoy. Values will appear as 'nil' in the table. A service such as pagekite will do the trick!
 
 # Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tylerlichten/simply_notify.
 
-
 # License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/notifier_generator.rb

@@ -11,28 +11,102 @@ class NotifierGenerator < Rails::Generators::Base
   def create_html_view_file
     create_file "app/views/notifier/new_notification.html.erb", 
     "<!DOCTYPE html>
-      <html>
-        <head>
-          <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+    <html>
+      <head>
+        <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
         </head>
         <body>
-          <h1>Hello</h1>
+          <h1>Hello!</h1>
           <p>
-            A new assignment has been posted!<br><br>
-            Please visit the course website: <%= @url %><br><br>
+            If your account has new notifications, they will be lised below.<br><br>
+            Please visit the course website at: <%= @url %><br>
+            Or you can follow the links provided by the notifications.<br><br>
             Thanks!<br>
-          </p>
-        </body>
-      </html>"
+
+        <% if @recipient.notificationFrequency == 2 && @recipient.admin == false %>
+          <h1>List of Notifications (past 24 hours):</h1>
+          <% i = 0 %>
+          <% @notifications.each do |x| %>
+            <% if x.recipient_id == @recipient.id && x.created_at >= 1.day.ago %>
+              <% i += 1 %>
+              <%= i %>.
+              <%= x.action %> -- 
+              <%= x.url %>
+              <br>
+            <% end %>
+          <% end %>
+        <% elsif @recipient.notificationFrequency == 1 && @recipient.admin == false %>
+          <h1>New Notification:</h1>
+          <% @notifications.reverse.each do |x| %>
+            <% if x.recipient_id == @recipient.id %>
+              <%= x.action %> --
+              <%= x.url %>
+              <% break %>
+            <% end %>
+          <% end %>
+        <% elsif @recipient.admin == true %> 
+          <h1>List of all Notifications (past 24 hours):</h1>
+          <% i = 0 %>
+          <% @notifications.each do |x| %>
+            <% if x.created_at >= 1.day.ago %>
+              <% i += 1 %>
+              <%= i %>. User ID  
+              <%= x.recipient_id %> --
+              <%= x.action %> -- 
+              <%= x.url %>
+              <br>
+            <% end %>
+          <% end %>
+        <% end %> 
+        </p>
+      </body>
+    </html>"
   end
 
   def create_text_view_file
     create_file "app/views/notifier/new_notification.text.erb", 
     "Hello, 
-      A new assignment has been posted! 
-      Please visit the course website: <%= @url %>.
+      If your account has new notifications, they will be lised below.
+      Please visit the course website at: <%= @url %>
+      Or you can follow the links provided by the notifications.
       
-      Thanks!"
+      Thanks!
+
+        <% if @recipient.notificationFrequency == 2 && @recipient.admin == false %>
+          List of Notifications (past 24 hours): 
+          <% i = 0 %>
+          <% @notifications.each do |x| %>
+            <% if x.recipient_id == @recipient.id && x.created_at >= 1.day.ago %>
+              <% i += 1 %>
+              <%= i %>.
+              <%= x.action %> -- 
+              <%= x.url %>
+              \r\n
+            <% end %>
+          <% end %>
+        <% elsif @recipient.notificationFrequency == 1 && @recipient.admin == false %>
+          New Notification:
+          <% @notifications.reverse.each do |x| %>
+            <% if x.recipient_id == @recipient.id %>
+              <%= x.action %> --
+              <%= x.url %>
+              <% break %>
+            <% end %>
+          <% end %>
+        <% elsif @recipient.admin == true %> 
+          List of all Notifications (past 24 hours):
+          <% i = 0 %>
+          <% @notifications.each do |x| %>
+            <% if x.created_at >= 1.day.ago %>
+              <% i += 1 %>
+              <%= i %>. User ID  
+              <%= x.recipient_id %> --
+              <%= x.action %> -- 
+              <%= x.url %>
+              \r\n
+            <% end %>
+          <% end %>
+        <% end %>"
   end
 
   def create_ahoy_email_initializer

data/lib/simply_notify/version.rb

@@ -1,3 +1,3 @@
 module SimplyNotify
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/simply_notify.rb

@@ -10,12 +10,16 @@ class Notifier < ActionMailer::Base
 
     if url.nil?
       @url = Rails.application.config.absolute_site_url
+      @notifications = Notification.all
+      @recipient = recipient
       mail(to: recipient.email, 
            subject: subject)
     else 
       @url = url
+      @notifications = Notification.all
+      @recipient = recipient
       mail(to: recipient.email, 
            subject: subject)
-    end 
+    end
   end
 end

data/simply_notify.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tyler Lichten"]
   spec.email         = ["tlich10@gmail.com"]
 
-  spec.summary       = %q{Delivers notification emails to users of the website}
-  spec.description   = %q{Delivers notification emails to users of the website}
+  spec.summary       = %q{Delivers notifications by email to website users}
+  spec.description   = %q{Delivers notifications by email to website users}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "ahoy_email"
   spec.add_runtime_dependency "ahoy_matey"
+  spec.add_runtime_dependency "whenever"
+  spec.add_runtime_dependency "devise"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simply_notify
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Tyler Lichten
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Delivers notification emails to users of the website
+description: Delivers notifications by email to website users
 email:
 - tlich10@gmail.com
 executables: []
@@ -165,5 +193,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Delivers notification emails to users of the website
+summary: Delivers notifications by email to website users
 test_files: []