notify_user 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a470e0d509c286f8776d2dfa71a3517282a11a1
-  data.tar.gz: d55423eee03a893bbb8f1dfc52481d3773faf3b1
+  metadata.gz: e2b5085ee8851c7794ce513ecd8a39306b99a617
+  data.tar.gz: 0899ee588ee35b8e57ca2775eee227e9b7bc7b90
 SHA512:
-  metadata.gz: 744a1fbaec414b5d906c450d7aa1698fd0190ed76e2632f257c27f3381ba4c6842b1af14a734757e3b3c8869d8450a81f45fc690e40e9923d9da4ee2a0119229
-  data.tar.gz: acca9ec95baa1668e47083abbb2d71a59c014341e6c6326a97236eedb44acfc283124ded02c230a33420b908e20a075fdcd19b9fba8957011f3e754f0678e69c
+  metadata.gz: 6eb6b9dacbf04d55add8f2410cbe666b28abe41c689a65b9f85862b62c6285577267fe3a21298ed41e376c66cc99fac0f58eb4e5e148be78200b4fcdc2eda1d5
+  data.tar.gz: 81644a729e2499c788d44b0d9497eac0c90bfad60a193980fa326277899e803d8212a75727cea5abbf624e413fdab247da1dfecb9d1dc4308b67434527174659

data/README.md

@@ -0,0 +1,99 @@
+notify_user
+===========
+
+
+Install:
+```
+gem 'notify_user'
+rails g notify_user:install
+```
+
+Getting started:
+```
+rails g notify_user:notification NewMyProperty
+```
+
+Edit views/notify_user/new_my_property/action_mailer/notification.html.erb, e.g.
+```
+<h3>We added <%= @notification.params[:listing_address] %> to your My Properties.</h3>
+```
+
+Then send:
+```
+NotifyUser.send_notification('new_my_property').to(user).with("listing_address" => "123 Main St").notify
+```
+
+To enable APNS add this line to your app/notification/notification_type.rb
+```
+channel :apns,
+	aggregate_per: false    
+```
+
+To run the tests:
+```
+BUNDLE_GEMFILE=gemfiles/rails40.gemfile bundle install
+BUNDLE_GEMFILE=gemfiles/rails40.gemfile bundle exec rspec spec
+```
+
+To run the tests like Travis:
+```
+gem install wwtd
+wwtd
+```
+
+##Web interface
+Display a list of notifications for a logged in user
+```
+visit /notify_user/notifications
+```
+Clicking on a notification gets marked as read and taken to the redirect_logic action (notifications_controller.rb)
+```
+def redirect_logic(notification)
+	class = notification.params[:type].capitalize.constantize
+	object = class.find(@notification.params[:id])
+	redirect_to property_url(object)
+end
+```
+Add line to environment.rb file to configure host url for mail notifications
+```
+config.action_mailer.default_url_options = { :host => "http://example.com" }
+```
+
+##Subscriptions
+Unsubscribing from a notification type, first add it to the notify_user.rb initilizer 
+```
+# Override the default notification type
+config.unsubscribable_notifications = ['NewPostNotification','NewSale']
+```
+Users can manage their subscription statuses through the web interface
+```
+visit notify_user/notifications/unsubscribe
+```
+Unsubscribe link helper - add this to your views/notify_user/layouts/action_mailer.html.erb
+```
+<% if is_unsubscribeable? @notification  %>
+	<p style="text-align: center;">
+		<%= unsubscribe_link(@notification, "Unsubscribe") %>
+	</p>
+<% end %>
+```
+
+##Upgrading to JSON params data type
+Run json_update generator which generates the migrations to change the params datatype to json as well as convert the current data to json
+```
+rails generate notify_user:json_update 
+rake db:migrate
+```
+
+##Changes
+Notification description and aggregates has changed syntax slighly from
+```
+@@description = "please override this type description" 
+@@aggregate_per = 10.minutes
+```
+to 
+```
+self.description = "please override this type description" 
+self.aggregate_per = 10.minutes
+```
+

data/app/controllers/notify_user/base_notifications_controller.rb

@@ -45,7 +45,7 @@ class NotifyUser::BaseNotificationsController < ApplicationController
   #get 
   def read
     @notification = NotifyUser::BaseNotification.for_target(@user).where('id = ?', params[:id]).first
-    @notification.mark_as_read
+    @notification.mark_as_read!
     redirect_logic(@notification)
   end
 
@@ -58,6 +58,7 @@ class NotifyUser::BaseNotificationsController < ApplicationController
       unsubscribe_from(params[:type])
       redirect_to notify_user_notifications_unsubscribe_path  
     end
+    @types = build_notification_types
     @unsubscribale_types = NotifyUser.unsubscribable_notifications
     @unsubscribale_channels = NotifyUser::BaseNotification.channels
   end

data/app/models/notify_user/base_notification.rb

@@ -1,9 +1,10 @@
-require 'state_machine'
+require 'aasm'
 require 'sidekiq'
 
 module NotifyUser
   class BaseNotification < ActiveRecord::Base
     include ActionView::Helpers::TextHelper
+    include AASM
 
     if ActiveRecord::VERSION::MAJOR < 4
       attr_accessible :params, :target, :type, :state
@@ -16,37 +17,36 @@ module NotifyUser
     validate :unsubscribed_validation
 
     # Params for creating the notification message.
-    # serialize :params, Hash
+    if ActiveRecord::VERSION::MAJOR < 4
+      serialize :params, JSON
+    end
 
     # The user to send the notification to
     belongs_to :target, polymorphic: true
 
     validates_presence_of :target_id, :target_type, :target, :type, :state
 
-    state_machine :state, initial: :pending do
+    aasm column: :state do
 
       # Created, not sent yet. Possibly waiting for aggregation.
-      state :pending do
-      end
+      state :pending, initial: true
 
       # Email/SMS/APNS has been sent.
-      state :sent do
-      end
+      state :sent
 
       # The user has seen this notification.
-      state :read do
-      end
+      state :read
 
       # Record that we have sent message(s) to the user about this notification.
       event :mark_as_sent do
-        transition :pending => :sent
+        transitions from: :pending, to: :sent
       end
 
       # Record that the user has seen this notification, usually on a page or in the app.
       # A notification can go straight from pending to read if it's seen in a view before
       # sent in an email.
       event :mark_as_read do
-        transition [:pending, :sent] => :read
+        transitions from: [:pending, :sent], to: :read
       end
     end
 
@@ -93,17 +93,19 @@ module NotifyUser
     # Send any Emails/SMS/APNS
     def notify
 
-      save
+      if save
 
-      #if aggregation is false bypass aggregation completely
-      self.channels.each do |channel_name, options|
-        if(options[:aggregate_per] == false)
-          self.class.delay.deliver_notification_channel(self.id, channel_name)    
-        else
-          if not aggregation_pending?
-            self.class.delay_for(options[:aggregate_per] || self.aggregate_per).notify_aggregated_channel(self.id, channel_name)
+        #if aggregation is false bypass aggregation completely
+        self.channels.each do |channel_name, options|
+          if(options[:aggregate_per] == false)
+            self.class.delay.deliver_notification_channel(self.id, channel_name)    
+          else
+            if not aggregation_pending?
+              self.class.delay_for(options[:aggregate_per] || self.aggregate_per).notify_aggregated_channel(self.id, channel_name)
+            end
           end
         end
+
       end
 
     end

data/lib/notify_user/version.rb

@@ -1,3 +1,3 @@
 module NotifyUser
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/spec/controllers/notify_user/notifications_controller_spec.rb

@@ -12,7 +12,7 @@ describe NotifyUser::NotificationsController do
 
   it "delegates authentication to Devise" do
     subject.should_receive(:authenticate_user!).and_return(true)
-    subject.should_receive(:current_user).any_number_of_times.and_return(user)
+    subject.stub(:current_user).and_return(user)
     get :index
   end
 
@@ -92,12 +92,6 @@ describe NotifyUser::NotificationsController do
       notification.save
     end
 
-    xit "endpoint for toggling subscriptions statuses" do
-      # NotifyUser::Unsubscribe.has_unsubscribed_from(user, 'NewPostNotification').should eq []
-      put :subscriptions, :types => ['NewPostNotification']
-      NotifyUser::Unsubscribe.has_unsubscribed_from(user, 'NewPostNotification').should_not eq []
-    end
-
     it "endpoint for updating notification subscription statuses" do
       NotifyUser::Unsubscribe.has_unsubscribed_from(user, 'NewPostNotification').should eq []
       put :subscriptions, :types => [{

data/spec/models/notify_user/unsubscribe_spec.rb

@@ -18,6 +18,11 @@ module NotifyUser
         notification.errors[:target].first.should eq " has unsubscribed from this type"
       end
 
+      it "doesn't queue an aggregation background worker if unsubscribed" do
+        notification.class.should_not_receive(:delay_for)
+        notification.notify
+      end
+
       it "doesnt create object if notification type isn't unsubscribable" do
         unsubscribe = NotifyUser::Unsubscribe.create({target: user, type: "UnsubscribableNotification"})
         NotifyUser::Unsubscribe.last.type.should_not eq "UnsubscribableNotification"

data/spec/support/database.yml

@@ -2,6 +2,7 @@ development:
   adapter: postgresql
   encoding: unicode
   database: notify_user_development
+  host: localhost
   pool: 5
   timeout: 5000
 
@@ -9,6 +10,7 @@ test:
   adapter: postgresql
   encoding: unicode
   database: notify_user_test
+  host: localhost
   pool: 5
   timeout: 5000
 
@@ -17,5 +19,6 @@ production:
   adapter: postgresql
   encoding: unicode
   database: notify_user_production
+  host: localhost
   pool: 5
   timeout: 5000

data/spec/support/rails_template.rb

@@ -1,6 +1,6 @@
 #removes the username and password fields from database.yml
-system("cat #{ENV['RAILS_ROOT']}/config/database.yml | grep -v 'username' > #{ENV['RAILS_ROOT']}/config/database2.yml ")
-system("cat #{ENV['RAILS_ROOT']}/config/database2.yml | grep -v 'password' > #{ENV['RAILS_ROOT']}/config/database.yml ")
+remove_file "#{ENV['RAILS_ROOT']}/config/database.yml"
+copy_file File.expand_path('../../support/database.yml'), "#{ENV['RAILS_ROOT']}/config/database.yml"
 
 rake "db:drop:all"
 rake "db:create:all"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notify_user
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Tom Spacek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: state_machine
+  name: aasm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -188,7 +188,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/assets/javascripts/notify_user/application.js
 - app/assets/javascripts/notify_user/notification.js

data/README.rdoc

@@ -1,3 +0,0 @@
-= NotifyUser
-
-This project rocks and uses MIT-LICENSE.