notifiable-rails 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b9758bcbfa68e1152383edd4993b474339b9c32
-  data.tar.gz: 3fce69e3fb495368fe940af16d66868eccfbe5b3
+  metadata.gz: 8bb9073ea05a2f8fc69c60f6f6cfbf0dfe7fe777
+  data.tar.gz: 0eb9ab880e47f9f1c5821fa5c71c1113e6fcbb79
 SHA512:
-  metadata.gz: 5f9677fca0b6053c6519a11092cb55cdd9a5b51f5964542a4909fb62d2404c3b458479723e20816809c30360844c19d7af665a45cac70f29407e8f21aefa9d95
-  data.tar.gz: 68b4ad53c80151e34483083756c273da2b9a01d46ab52d600e284ff89aedeb6f4899a260a92fada36a3079b74a6a10cc308d8cbe70aa2a5aede377b3f7689b24
+  metadata.gz: 63de150bca8c6845719a322493b3470b2381cb5cff93be4690dcbd92924475a6501e2e12745634cf0a8b423119f07192a18615c4f2e41924237edfa5c1c0f221
+  data.tar.gz: cb2f7131af80e79151cd0b3ff50357be1c9f4b903a4f7d4d441dc5e6fe6c0871e4d63fd7b89d0a6995829cc48a23f76a1f1e63b234a89d9517bb21ed3c0f4238

data/lib/generators/notifiable/install/install_generator.rb

@@ -21,6 +21,7 @@ module Notifiable
       end
 
       def copy_migrations
+        migration_template "create_notifiable_apps.rb", "db/migrate/create_notifiable_apps.rb"
         migration_template "create_notifiable_device_tokens.rb", "db/migrate/create_notifiable_device_tokens.rb"
         migration_template "create_notifiable_notifications.rb", "db/migrate/create_notifiable_notifications.rb"
         migration_template "create_notifiable_notification_device_tokens.rb", "db/migrate/create_notifiable_notification_device_tokens.rb"

data/lib/generators/notifiable/install/templates/create_notifiable_apps.rb

@@ -0,0 +1,10 @@
+class CreateNotifiableApps < ActiveRecord::Migration
+  def change
+    create_table :notifiable_apps do |t|
+      t.string :name
+      t.text :configuration
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/notifiable/install/templates/create_notifiable_device_tokens.rb

@@ -7,6 +7,7 @@ class CreateNotifiableDeviceTokens < ActiveRecord::Migration
       t.string :device_id
       t.boolean :is_valid, :default => true
       t.integer :user_id
+      t.references :app
 
       t.timestamps
     end

data/lib/generators/notifiable/install/templates/create_notifiable_notifications.rb

@@ -4,6 +4,11 @@ class CreateNotifiableNotifications < ActiveRecord::Migration
     create_table :notifiable_notifications do |t|
       t.text :message
       t.text :params
+      t.references :app
+      
+      #stats
+      t.integer :sent_count
+      t.integer :gateway_accepted_count
       
       # APNS - Optional
       #t.integer :badge

data/lib/notifiable.rb

@@ -1,4 +1,5 @@
 require 'notifiable/active_record'
+require 'notifiable/app'
 require 'notifiable/notifiable_concern'
 require 'notifiable/railtie' if defined?(Rails)
 require 'notifiable/engine'
@@ -13,7 +14,7 @@ module Notifiable
   mattr_accessor :api_controller_class
   
   mattr_accessor :api_device_token_params
-  @@api_device_token_params = [:device_id, :token, :provider]
+  @@api_device_token_params = [:device_id, :token, :provider, :app_id]
   
   mattr_accessor :user_class
   
@@ -27,8 +28,8 @@ module Notifiable
     yield self
   end
   
-  def self.batch(config = {})    
-    b = Batch.new(config)
+  def self.batch(app = Notifiable::App.first)    
+    b = Batch.new(app)
     yield(b)
     b.close
   end

data/lib/notifiable/app.rb

@@ -0,0 +1,8 @@
+module Notifiable
+  class App < ActiveRecord::Base
+    has_many :device_tokens, :class_name => 'Notifiable::DeviceToken', :dependent => :destroy
+    has_many :notifications, :class_name => 'Notifiable::App', :dependent => :destroy
+    
+    serialize :configuration
+  end
+end

data/lib/notifiable/batch.rb

@@ -1,10 +1,11 @@
 module Notifiable
   class Batch
-    attr_accessor :notifiers
     
-    def initialize(config = {})
+    def initialize(app)
+      raise "Must specify Notifiable::App" unless app
+      @app = app
       @notifiers = {}
-      @config = config
+      @notification_ids = []
     end
     
     def add_notifiable(notification, notifiable)
@@ -15,24 +16,39 @@ module Notifiable
     
     def add_device_token(notification, d)
       provider = d.provider.to_sym
-      
+
       unless @notifiers[provider]
         clazz = Notifiable.notifier_classes[provider]          
         raise "Notifier #{provider} not configured" unless clazz
         @notifiers[provider] = clazz.new
         @notifiers[provider].env = Rails.env
-        @config[provider].each_pair {|key, value| @notifiers[provider].send("#{key}=", value) if @notifiers[provider].methods.include?("#{key}=".to_sym) } if @config[provider]
+        
+        if @app.configuration && @app.configuration[provider]
+          @app.configuration[provider].each_pair {|key, value| @notifiers[provider].send("#{key}=", value) if @notifiers[provider].methods.include?("#{key}=".to_sym) } 
+        end
       end
       
       notifier = @notifiers[provider]
       if d.is_valid? && !notifier.nil? 
-  		  notifier.send_notification(notification, d) 
+  		  notifier.send_notification(notification, d)
+        @notification_ids << notification.id
       end
     end
     
     def close
       @notifiers.each_value {|n| n.close}
       @notifiers = nil
+      summarise
     end
+    
+    private
+    def summarise
+      notifications = Notification.where(:id => @notification_ids)
+      notifications.each do |n|
+        n.sent_count = n.notification_statuses.count
+        n.gateway_accepted_count = n.notification_statuses.where(:status => 0).count
+        n.save
+      end
+    end 
   end
 end

data/lib/notifiable/device_token.rb

@@ -1,11 +1,9 @@
 module Notifiable
-  
   class DeviceToken < ActiveRecord::Base
+    belongs_to :app, :class_name => "Notifiable::App"
     
+    validates_presence_of :token, :provider, :app
   	validates_uniqueness_of :token
-    validates_presence_of :token
-    validates_presence_of :provider
-
 
   	def user
   		user_id.blank? ? nil : Notifiable.user_class.find(user_id)

data/lib/notifiable/notification.rb

@@ -4,5 +4,8 @@ module Notifiable
     serialize :params
     
     has_many :notification_statuses, :class_name => 'Notifiable::NotificationStatus', :dependent => :destroy
+    belongs_to :app, :class_name => 'Notifiable::App'
+    
+    validates_presence_of :app
   end
 end

data/lib/notifiable/version.rb

@@ -1,3 +1,3 @@
 module Notifiable
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/spec/batch_spec.rb

@@ -2,32 +2,39 @@ require 'spec_helper'
 
 describe Notifiable::Batch do
   let(:user1) { FactoryGirl.create(:user) }
-  let(:notification) { Notifiable::Notification.new(:message => "Test message")}
+  let(:notification) { FactoryGirl.create(:notification, :app => app) }
+  let(:app) { FactoryGirl.create(:app, :configuration => {:configurable_mock => {:use_sandbox => true}}) }
   
   it "adds a notifiable object" do  
-    FactoryGirl.create(:mock_token, :provider => :configurable_mock, :user_id => user1.id)
+    FactoryGirl.create(:mock_token, :provider => :configurable_mock, :user_id => user1.id, :app => app)
           
-    b = Notifiable::Batch.new
+    b = Notifiable::Batch.new(app)
     b.add_notifiable(notification, user1)
+    b.close
 
-    Notifiable::NotificationStatus.count == 1
+    Notifiable::NotificationStatus.count.should == 1
+    saved_notification = Notifiable::Notification.first
+    saved_notification.sent_count.should == 1
+    saved_notification.gateway_accepted_count.should == 1
   end
   
   it "adds a device token" do  
-    FactoryGirl.create(:mock_token, :provider => :configurable_mock, :user_id => user1.id)
+    token = FactoryGirl.create(:mock_token, :provider => :configurable_mock, :user_id => user1.id, :app => app)
           
-    b = Notifiable::Batch.new
-    b.add_device_token(notification, user1.device_tokens.first)
+    b = Notifiable::Batch.new(app)
+    b.add_device_token(notification, token)
+    b.close
 
-    Notifiable::NotificationStatus.count == 1
+    Notifiable::NotificationStatus.count.should == 1
+    saved_notification = Notifiable::Notification.first
+    saved_notification.sent_count.should == 1
+    saved_notification.gateway_accepted_count.should == 1
   end
   
-  it "configures the provider" do  
-    FactoryGirl.create(:mock_token, :provider => :configurable_mock, :user_id => user1.id)
-      
-    config = {:configurable_mock => {:use_sandbox => true}}
+  it "configures the provider via an App" do  
+    FactoryGirl.create(:mock_token, :provider => :configurable_mock, :user_id => user1.id, :app => app)
     
-    b = Notifiable::Batch.new(config)
+    b = Notifiable::Batch.new(app)
     b.add_notifiable(notification, user1)
 
     b.notifiers[:configurable_mock].env.should eql Rails.env
@@ -36,11 +43,17 @@ describe Notifiable::Batch do
   
 end
 
+module Notifiable
+  class Batch
+    attr_accessor :notifiers
+  end
+end
+
 class ConfigurableMockNotifier < Notifiable::NotifierBase
   attr_accessor :use_sandbox
   
   def enqueue(notification, device_token)
-    processed(notification, device_token, 200)
+    processed(notification, device_token, 0)
   end
 end
 

data/spec/controllers/device_tokens_controller_spec.rb

@@ -5,6 +5,7 @@ describe Notifiable::DeviceTokensController do
   let(:user1) { FactoryGirl.create(:user) }
   let(:user2) { FactoryGirl.create(:user_with_mock_token) }
   let(:user2_device_token) { user2.device_tokens.first }
+  let(:app) { FactoryGirl.create(:app) }
   
   before(:each) do
     @request.env["HTTP_ACCEPT"] = "application/json"
@@ -12,29 +13,33 @@ describe Notifiable::DeviceTokensController do
   end
 
   it "creates a new device token for an existing user" do
-    post :create, :token => "ABC123", :user_email => user1.email, :provider => :apns
+    post :create, :token => "ABC123", :user_email => user1.email, :provider => :apns, :app_id => app.id
     
     expect(response).to be_success
     
     Notifiable::DeviceToken.count.should == 1
     user1.device_tokens.count.should == 1
-    user1.device_tokens.first.token.should.eql? "ABC123"
-    user1.device_tokens.first.provider.should.eql? :apns    
+    dt = user1.device_tokens.first
+    dt.token.should.eql? "ABC123"
+    dt.provider.should.eql? :apns 
+    dt.app.should.eql? app   
   end
   
   it "creates a new device token for an anonymous user" do
-    post :create, :token => "ABC123", :provider => :apns
+    post :create, :token => "ABC123", :provider => :apns, :app_id => app.id
     
     expect(response).to be_success
     
     Notifiable::DeviceToken.count.should == 1
-    Notifiable::DeviceToken.first.token.should.eql? "ABC123"
-    Notifiable::DeviceToken.first.provider.should.eql? :apns   
+    dt = Notifiable::DeviceToken.first
+    dt.token.should.eql? "ABC123"
+    dt.provider.should.eql? :apns   
+    dt.app.should.eql? app
     User.count.should == 0 
   end
   
   it "creates a new device token with a device_id" do
-    post :create, :token => "ABC123", :device_id => "DEF456", :user_email => user1.email, :provider => :mpns
+    post :create, :token => "ABC123", :device_id => "DEF456", :user_email => user1.email, :provider => :mpns, :app_id => app.id
     
     expect(response).to be_success
     
@@ -43,6 +48,7 @@ describe Notifiable::DeviceTokensController do
     dt = user1.device_tokens.first
     dt.token.should eql 'ABC123'
     dt.provider.should eql 'mpns'
+    dt.app.should.eql? app
     dt.device_id.should eql "DEF456"    
   end
   
@@ -58,6 +64,7 @@ describe Notifiable::DeviceTokensController do
     dt = user1.device_tokens.first
     dt.token.should eql 'ABC123'
     dt.provider.should eql 'mpns'
+    dt.app.should.eql? app
     dt.device_id.should eql "DEF456"    
   end
 
@@ -82,6 +89,13 @@ describe Notifiable::DeviceTokensController do
   	Notifiable::DeviceToken.where(:token => user2_device_token.token).count.should == 1
   end
   
+  it "doesn't create a token if no app is specified" do
+    post :create, :token => "ABC123", :device_id => "DEF456", :user_email => user1.email, :provider => :mpns
+    
+  	expect(response.status).to eq(422)
+  	Notifiable::DeviceToken.count.should == 0
+  end
+  
   it "returns not found if the token doesnt exist" do
   	delete :destroy, :token => "ZXY987", :user_email => user1.email
     

data/spec/notifiable_server_spec.rb

@@ -3,8 +3,10 @@ require 'spec_helper'
 describe Notifiable do
   let(:user1) { FactoryGirl.create(:user_with_mock_token) }
   let(:user2) { FactoryGirl.create(:user_with_mock_token) }
-  let(:notification1) { Notifiable::Notification.create(:message => "First test message")}
-  let(:notification2) { Notifiable::Notification.create(:message => "Second test message")}
+  let(:notification1) { FactoryGirl.create(:notification, :message => "First test message")}
+  let(:notification2) { FactoryGirl.create(:notification, :message => "Second test message")}
+  
+  before(:each) { FactoryGirl.create(:app) }
   
   it "sends two identical push notifications" do
     Notifiable.batch do |b|
@@ -46,7 +48,7 @@ describe Notifiable do
   
   it "raises an error if it can't find the notification provider" do
     user = FactoryGirl.create(:user)
-    Notifiable::DeviceToken.create :user_id => user.id, :token => "DEF567", :provider => :gcm
+    device_token = FactoryGirl.create(:mock_token, :provider => :sms, :user_id => user.id)
     
     expect { user.send_notification(notification1) }.to raise_error    
   end

data/spec/notifiable_spec.rb

@@ -4,8 +4,11 @@ describe Notifiable::Concern do
   let(:user1) { FactoryGirl.create(:user_with_mock_token) }
   let(:notification) { Notifiable::Notification.new(:message => "Test message")}
   
-  it "sends a single push notification" do    
-    
+  before(:each) { FactoryGirl.create(:app) }
+  
+  it "sends a single push notification" do 
+    FactoryGirl.create(:app)
+       
     user1.send_notification(notification)
     
     Notifiable::NotificationStatus.count.should == 1    

data/spec/notification_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 describe Notifiable::Notification do
   
   it "stores a message" do    
-    Notifiable::Notification.create(:message => "Test message")
+    FactoryGirl.create(:notification, :message => "Test message")
     
     Notifiable::Notification.first.message.should eql "Test message"
   end
   
   it "stores params" do    
-    Notifiable::Notification.create :params => {:custom_property => "A different message"}
+    FactoryGirl.create(:notification, :params => {:custom_property => "A different message"})
     
     Notifiable::Notification.first.params.should == {:custom_property => "A different message"}
   end
   
   it "destroys dependent NotificationStatuses" do
-    n = Notifiable::Notification.create :params => {:custom_property => "A different message"}
+    n = FactoryGirl.create(:notification, :params => {:custom_property => "A different message"})
     Notifiable::NotificationStatus.create :notification => n
     
     n.destroy

data/spec/support/factories.rb

@@ -2,11 +2,18 @@ FactoryGirl.define do
 
   factory :mock_token, :class => Notifiable::DeviceToken do
     provider :mock
-    token
+    sequence(:token) {|n| "ABCD#{n}" }
+    app
+  end
+  
+  factory :app, :class => Notifiable::App do
+  end
+  
+  factory :notification, :class => Notifiable::Notification do
+    app
   end
   
   sequence(:email) {|n| "person-#{n}@example.com" }
-  sequence(:token) {|n| "ABCD#{n}" }
   
   factory :user do
     email

data/spec/test_app/db/migrate/20131210115649_create_notifiable_apps.rb

@@ -0,0 +1,10 @@
+class CreateNotifiableApps < ActiveRecord::Migration
+  def change
+    create_table :notifiable_apps do |t|
+      t.string :name
+      t.text :configuration
+
+      t.timestamps
+    end
+  end
+end

data/spec/test_app/db/migrate/20131228225139_create_notifiable_device_tokens.rb

@@ -7,12 +7,13 @@ class CreateNotifiableDeviceTokens < ActiveRecord::Migration
       t.string :device_id
       t.boolean :is_valid, :default => true
       t.integer :user_id
+      t.references :app
 
       t.timestamps
     end
-    
+
     add_index :notifiable_device_tokens, :device_id, :unique => true  
-    add_index :notifiable_device_tokens, :token, :unique => true  
+    add_index :notifiable_device_tokens, :token, :unique => true      
     add_index :notifiable_device_tokens, :user_id
   end
 

data/spec/test_app/db/migrate/20131228225140_create_notifiable_notifications.rb

@@ -2,12 +2,22 @@ class CreateNotifiableNotifications < ActiveRecord::Migration
   
   def change
     create_table :notifiable_notifications do |t|
-      t.text :title
       t.text :message
       t.text :params
-      t.integer :badge
-      t.text :sound
-      t.datetime :expiry
+      t.references :app
+      
+      #stats
+      t.integer :sent_count
+      t.integer :gateway_accepted_count
+      
+      # APNS - Optional
+      #t.integer :badge
+      #t.text :sound
+      #t.datetime :expiry
+      
+      # MPNS - Optional
+      #t.text :title
+      
       t.timestamps
     end
   end