simply_notify 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96704c50346dbe9f09e32c86ed6224b84ccf3cc
-  data.tar.gz: 82694ee68402c70eb21035da7054e1f433bca45a
+  metadata.gz: 6f6ed495397695ae73384d15c941d23bca0b8f7d
+  data.tar.gz: 0e7fc593cedce54a1bb4f53144b2ef027c539c7d
 SHA512:
-  metadata.gz: 07a155e1b2d2b5f70dce82fafc96f95567ef2dd05ae77f9d9191c9f306f44440ded5fcd7512709480520da94dd020276b8bab8d7eeb1059646cdf5c0ac922402
-  data.tar.gz: 5487a0943adc9368736cb15e0f74b09ade72cb9e608d11ba8388dab5863143fa6d598e38f1bfe1728912acc0d5eaecd52b5a23395a8b4db8ac1ecaec059bfef4
+  metadata.gz: 6f64983596442469d3f6fcb9ce8c9909f0b23aeed5131483b4a6474418dc4af3b49a4f9accaacc779f4b9f6d9c7fb2120182938ee44d2fe8d6da7133aab2c7da
+  data.tar.gz: 1eb508d165913fcb13f3ab9f6ab08ef0c90e74cfaf4d30d0c1a1d59ae0c8f34ed897bca5cb18a4db3f321e8c77348e4bf6958de42469ba8966aabe3df0f70b10

data/README.md

@@ -1,9 +1,11 @@
 # SimplyNotify
 
-simply_notify will send a user of the Brandeis University course website an email notifying the user of a new notification that has been posted to their account. 
+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
 
-## Installation
+
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -20,16 +22,28 @@ Or install it yourself as:
     $ gem install simply_notify
 
 
-## Usage
+# Usage
+
+###Step 1
 
-Step 1: Generate mailer and views.
+Generate Notifier Mailer, Notifier Views, and ahoy_email Initializer.
 
 	rails generate notifier
 
 
-Step 2: Setup controller where you want then notifications to be created and URL link information. 
+###Step 2
+
+Generate ahoy_messages table.
+    
+    rails generate ahoy_email:install
+    rake db:migrate
+
+
+###Step 3
+
+Setup controller where you want the notifications to be created.
 
-For example, if you want each user to be notified when an assignment is created and a link to the homepage included in the email, use a call such as this (added to app/controllers/assignments_controller.rb)
+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)
 
     # simply_notify: Most recent ID
     most_recent_id = Assignment.maximum('id')
@@ -42,37 +56,52 @@ For example, if you want each user to be notified when an assignment is created
     # use url as parameter if you want url link to be the source of the notification
     @users = User.all 
     @users.each do |u| 
-      Notifier.new_notification(u.email, url).deliver_now
+      Notifier.new_notification(u, url, 'New Assignment Posted').deliver_now
     end
 
 
-Step 3: Configure SMTP settings and set homepage as absolute url.
+###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):
 
     # SMTP Config
-    config.absolute_site_url = 'http://localhost:3000/'  #set as your homepage
+    # 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 your from email
+    from: "YOUR_FROM_EMAIL@gmail.com"  
     }
+    # Set as the host
+    config.action_mailer.default_url_options = {:host => "localhost:3000"} 
     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',
-    user_name:            'YOUR_USERNAME@gmail.com',  #set as your email
-    password:             'YOUR_PASSWORD',  #set as your password
+    # Set as your email
+    user_name:            'YOUR_USERNAME@gmail.com',
+    # Set as your password
+    password:             'YOUR_PASSWORD', 
     authentication:       'plain',
     enable_starttls_auto: true  }
 
 
-## Contributing
+###IMPORTANT NOTE 
+
+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. 
+
+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
+# 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

@@ -2,7 +2,7 @@ require "rails/generators"
 require "thor"
 
 class NotifierGenerator < Rails::Generators::Base
-  desc "This generator creates the Mailer and Views"
+  desc "This generator creates the Notifier Mailer, Notifier Views, and ahoy_email initializer"
 
   def create_mailer_file
   	create_file "app/mailers/notifier.rb", "require 'simply_notify'"
@@ -34,4 +34,30 @@ class NotifierGenerator < Rails::Generators::Base
       
       Thanks!"
   end
+
+  def create_ahoy_email_initializer
+    create_file "config/initializers/ahoy_email.rb",
+    "class EmailSubscriber
+
+      def open(event)
+        # :message and :controller keys
+        ahoy = event[:controller].ahoy
+        ahoy.track "Email opened", message_id: event[:message].id
+      end
+
+      def click(event)
+        # same keys as above, plus :url
+        ahoy = event[:controller].ahoy
+        ahoy.track "Email clicked", message_id: event[:message].id, url: event[:url]
+      end
+    end
+
+    AhoyEmail.subscribers << EmailSubscriber.new"
+  end
+
+  def insert_association_user_model
+    insert_into_file "app/models/user.rb",
+      "has_many :messages, class_name: \"Ahoy::Message\"",
+      after: "has_many :groups, through: :memberships"
+  end 
 end

data/lib/simply_notify/version.rb

@@ -1,3 +1,3 @@
 module SimplyNotify
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end

data/lib/simply_notify.rb

@@ -1,17 +1,21 @@
 require "simply_notify/version"
 require "action_mailer"
+require "ahoy_email"
 
 class Notifier < ActionMailer::Base
+  track utm_campaign: "boom"
 
-  def new_notification(recipient, url)
-  	if url.nil?
+  def new_notification(recipient, url, subject)
+    track user: recipient
+
+    if url.nil?
       @url = Rails.application.config.absolute_site_url
-  	  mail(to: recipient, 
-           subject: 'New Notification')
-  	else 
-  	  @url = url
-      mail(to: recipient, 
-           subject: 'New Notification')
+      mail(to: recipient.email, 
+           subject: subject)
+    else 
+      @url = url
+      mail(to: recipient.email, 
+           subject: subject)
     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 email notifications to users of a website}
-  spec.description   = %q{Delivers email notifications to users of a website}
+  spec.summary       = %q{Delivers notification emails to users of the website}
+  spec.description   = %q{Delivers notification emails to users of the website}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "actionmailer"
   spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "ahoy_email"
+  spec.add_runtime_dependency "ahoy_matey"
 
   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.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Lichten
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ahoy_email
+  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: ahoy_matey
+  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
@@ -94,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Delivers email notifications to users of a website
+description: Delivers notification emails to users of the website
 email:
 - tlich10@gmail.com
 executables: []
@@ -137,5 +165,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Delivers email notifications to users of a website
+summary: Delivers notification emails to users of the website
 test_files: []