notifiable-rails 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab6756bd2340817f2d17d834d70f8e93c1ed4099
-  data.tar.gz: 45df3fe71bb3477e904ec77b97dfebbd3df82263
+  metadata.gz: 68d901d11477d8f90ee9b4180d0c49ad37c38859
+  data.tar.gz: d734d5b725c04781ec6de1e07ef6b28e5280ff60
 SHA512:
-  metadata.gz: 315d467276e714839d3f7d82cd19698e3ca1ed7e3b91da2d86a05476bb706ef37c56b8d728f7649de9cce92ec6c6d97f169cf6472627355fca84ff6ea86330ba
-  data.tar.gz: 5904e1345423e81be5e682ee117e51122ca6263452421d2b66efcb0e4207f4d4b5e473aa2efd009d01e1fa642e171ddad4045296049c51e59f918b0f147a0911
+  metadata.gz: 32251a7be76a5cad5a4277b80a7b2781e0a36cc16a5464c28d031f05de745744a16eb013a25bffeb11b07a8828f9965e5b9938261cb762cdd48e19639ff88b9c
+  data.tar.gz: dfc5f8e28c4c4f64408947584bb6c033e1a8bd087e6294b3753a1ccf4218a542b0a6e9342ed948477632a0c4e5dc83a71f46aaf5761bfafae562c38438ed44ad

data/app/controllers/notifiable/{notifications_controller.rb → notification_statuses_controller.rb}

@@ -1,29 +1,25 @@
-
 module Notifiable
-  
-  class NotificationsController < Notifiable.api_controller_class
-    
+  class NotificationStatusesController < Notifiable.api_controller_class
     before_filter :find_notification_status!, :check_authorisation!
-    
+  
     def opened      
-      if @notification_status.opened! && @notification_status.notification.increment!(:opened_count)
+      if @notification_status.opened!
         head :status => :ok
       else
         render :json => { :errors => @notification_status.errors.full_messages }, :status => :unprocessable_entity
       end
-      
-    end
     
+    end
+  
     private
     def find_notification_status!
-      return head :status => :not_acceptable unless params[:notification_id] && params[:device_token_id]
-            
-      @notification_status = NotificationStatus.find_by!("notification_id = ? AND device_token_id = ?", params[:notification_id], params[:device_token_id])
+      return head :status => :not_acceptable unless params[:localized_notification_id] && params[:device_token_id]
+          
+      @notification_status = NotificationStatus.find_by_localized_notification_id_and_device_token_id!(params[:localized_notification_id], params[:device_token_id])
     end
-    
+  
     def check_authorisation!
       head :status => :unauthorized unless current_notifiable_user == @notification_status.device_token.user
     end
   end
-  
 end

data/config/routes.rb

@@ -1,5 +1,5 @@
   
 Notifiable::Engine.routes.draw do
 	resources :device_tokens, :only => [:create, :update, :destroy]
-	put 'notifications/opened', :to => "notifications#opened"
+	put 'notification_statuses/opened', :to => "notification_statuses#opened"
 end

data/db/migrate/20131210115649_create_notifiable_device_tokens.rb

@@ -4,6 +4,7 @@ class CreateNotifiableDeviceTokens < ActiveRecord::Migration
     create_table :notifiable_device_tokens do |t|
       t.string :token
     	t.string :provider
+      t.string :locale
       t.boolean :is_valid, :default => true
       t.integer :user_id
       t.references :app

data/db/migrate/20131210115650_create_notifiable_notifications.rb

@@ -2,8 +2,6 @@ class CreateNotifiableNotifications < ActiveRecord::Migration
   
   def change
     create_table :notifiable_notifications do |t|
-      t.text :message
-      t.text :params
       t.references :app
       
       #stats
@@ -11,14 +9,6 @@ class CreateNotifiableNotifications < ActiveRecord::Migration
       t.integer :gateway_accepted_count, :default => 0
       t.integer :opened_count, :default => 0
       
-      # APNS - Optional
-      #t.integer :badge
-      #t.text :sound
-      #t.datetime :expiry
-      
-      # MPNS - Optional
-      #t.text :title
-      
       t.timestamps
     end
   end

data/db/migrate/20131210115651_create_notifiable_localized_notifications.rb

@@ -0,0 +1,22 @@
+class CreateNotifiableLocalizedNotifications < ActiveRecord::Migration
+  
+  def change
+    create_table :notifiable_localized_notifications do |t|
+      t.text :message
+      t.text :params
+      t.string :locale
+      t.references :notification
+      
+      # APNS - Optional
+      #t.integer :badge
+      #t.text :sound
+      #t.datetime :expiry
+      
+      # MPNS - Optional
+      #t.text :title
+      
+      t.timestamps
+    end
+  end
+
+end

data/db/migrate/{20131210115651_create_notifiable_statuses.rb → 20131210115652_create_notifiable_statuses.rb}

@@ -2,7 +2,7 @@ class CreateNotifiableStatuses < ActiveRecord::Migration
   
   def change
     create_table :notifiable_statuses do |t|
-      t.references :notification
+      t.references :localized_notification
       t.references :device_token
       t.integer :status
       t.datetime :created_at

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

@@ -5,7 +5,7 @@ Notifiable.configure do |config|
   
   # Set the params permitted for creation of device tokens
   # Defaults to [:token, :provider, :app_id]
-  #config.api_device_token_params = [:token, :provider, :app_id]
+  #config.api_device_token_params = [:token, :provider, :app_id, :locale]
   
   # The class representing the holder of the device
 	config.user_class = User

data/lib/notifiable/device_token.rb

@@ -1,6 +1,7 @@
 module Notifiable
   class DeviceToken < ActiveRecord::Base
     belongs_to :app, :class_name => "Notifiable::App"
+    has_many :notification_statuses, :class_name => "Notifiable::NotificationStatus"
     
     validates_presence_of :token, :provider, :app
 

data/lib/notifiable/localized_notification.rb

@@ -0,0 +1,14 @@
+module Notifiable
+  class LocalizedNotification < ActiveRecord::Base
+    belongs_to :notification, :class_name => "Notifiable::Notification"
+    #validates :notification, presence: true
+    
+    serialize :params
+    
+    has_many :notification_statuses, :class_name => 'Notifiable::NotificationStatus', :dependent => :destroy
+    
+    def send_params
+      @send_params ||= (self.params ? self.params : {}).merge({:localized_notification_id => self.id})
+    end
+  end
+end

data/lib/notifiable/notification.rb

@@ -3,16 +3,25 @@ module Notifiable
     
     serialize :params
     
-    has_many :notification_statuses, :class_name => 'Notifiable::NotificationStatus', :dependent => :destroy
-    belongs_to :app, :class_name => 'Notifiable::App'
+    has_many :localized_notifications, :class_name => 'Notifiable::LocalizedNotification', :dependent => :destroy
+    accepts_nested_attributes_for :localized_notifications
     
-    validates_presence_of :app
+    belongs_to :app, :class_name => 'Notifiable::App'    
+    validates :app, presence: true
+    
+    def notification_statuses
+      Notifiable::NotificationStatus.joins(:localized_notification).where('notifiable_localized_notifications.notification_id' => self.id)
+    end
     
     def batch  
       yield(self)
       close
     end
     
+    def localized_notification(locale)
+      self.localized_notifications.find_by(:locale => locale)
+    end
+    
     def add_notifiable(notifiable)
       notifiable.device_tokens.each do |d|
         self.add_device_token(d)

data/lib/notifiable/notification_status.rb

@@ -1,12 +1,17 @@
 module Notifiable
   class NotificationStatus < ActiveRecord::Base
-    belongs_to :notification, :class_name => 'Notifiable::Notification'
+    
+    belongs_to :localized_notification, :class_name => 'Notifiable::LocalizedNotification'
+    validates :localized_notification, presence: true
+    
     belongs_to :device_token, :class_name => 'Notifiable::DeviceToken'
+    validates :device_token, presence: true
     
     self.table_name = 'notifiable_statuses'
     
     def opened!
       update_attribute(:status, -1)
+       self.localized_notification.notification.increment!(:opened_count)
     end
     
     def opened?

data/lib/notifiable/notifier_base.rb

@@ -9,7 +9,7 @@ module Notifiable
     end
     
 		def send_notification(device_token)
-      enqueue(device_token)
+      enqueue(device_token, self.localized_notification(device_token))
     end
     
     def close
@@ -21,9 +21,13 @@ module Notifiable
       def flush
       
       end
+      
+      def localized_notification(device_token)
+        self.notification.localized_notification(device_token.locale)
+      end
     
       def processed(device_token, status)
-        receipts << {notification_id: self.notification.id, device_token_id: device_token.id, status: status, created_at: DateTime.now}
+        receipts << {localized_notification_id: self.localized_notification(device_token).id, device_token_id: device_token.id, status: status, created_at: DateTime.now}
       
         if receipts.count > Notifiable.notification_status_batch_size
           save_receipts

data/lib/notifiable/version.rb

@@ -1,3 +1,3 @@
 module Notifiable
-  VERSION = "0.20.0"
+  VERSION = "0.21.0"
 end

data/lib/notifiable.rb

@@ -4,6 +4,7 @@ require 'notifiable/notifiable_concern'
 require 'notifiable/railtie' if defined?(Rails)
 require 'notifiable/engine'
 require 'notifiable/notification'
+require 'notifiable/localized_notification'
 require 'notifiable/notification_status'
 require 'notifiable/device_token'
 require 'notifiable/notifier_base'
@@ -13,7 +14,10 @@ module Notifiable
   mattr_accessor :api_controller_class
   
   mattr_accessor :api_device_token_params
-  @@api_device_token_params = [:token, :provider, :app_id]
+  @@api_device_token_params = [:token, :provider, :app_id, :locale]
+
+  mattr_accessor :locales
+  @@locales = [:en]
   
   mattr_accessor :user_class
   

data/spec/controllers/device_tokens_controller_spec.rb

@@ -76,7 +76,7 @@ describe Notifiable::DeviceTokensController do
   
   context "old" do
     let(:user1) { FactoryGirl.create(:user) }
-    let(:user2) { FactoryGirl.create(:user_with_mock_token) }
+    let(:user2) { FactoryGirl.create(:user_with_en_token) }
     let(:user2_device_token) { user2.device_tokens.first }
     let(:app) { FactoryGirl.create(:app) }
     let(:invalid_device_token) { FactoryGirl.create(:invalid_mock_token) }

data/spec/controllers/{notifications_controller_spec.rb → notification_statuses_controller_spec.rb}

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Notifiable::NotificationsController do
+describe Notifiable::NotificationStatusesController do
   
-  let(:user1_device_token) { user1.device_tokens.first }
-  let(:user2) { FactoryGirl.create(:user) }
-  let(:anonymous_device_token) { FactoryGirl.create(:mock_token) }
+  #let(:user1_device_token) { user1.device_tokens.first }
+  #let(:user2) { create(:user) }
+  #let(:anonymous_device_token) { create(:mock_token) }
   
   before(:each) do
     @request.env["HTTP_ACCEPT"] = "application/json"
@@ -19,10 +19,10 @@ describe Notifiable::NotificationsController do
         let(:notifiable_app) { create(:app) }
         let(:user) { create(:user) }
         let(:token) { create(:mock_token, :app => notifiable_app, :user_id => user.id) }
-        subject(:n) { create(:notification, :app => notifiable_app)}
-        let!(:status) { create(:notification_status, :notification => n, :device_token => token) }
+        let(:localized_notification) { create(:localized_notification, :locale => :en) }
+        subject!(:status) { create(:notification_status, :localized_notification => localized_notification, :device_token => token) }
       
-        before(:each) { put :opened, {:notification_id => n.id, :device_token_id => token.id, :user_email => user.email} }
+        before(:each) { put :opened, {:localized_notification_id => localized_notification.id, :device_token_id => token.id, :user_email => user.email} }
       
         it { expect(Notifiable::NotificationStatus.count).to eq 1 }
         it { expect(Notifiable::NotificationStatus.first.opened?).to eq true }
@@ -34,10 +34,10 @@ describe Notifiable::NotificationsController do
         let(:user1) { create(:user) }
         let(:user2) { create(:user) }
         let(:token) { create(:mock_token, :app => notifiable_app, :user_id => user1.id) }
-        subject(:n) { create(:notification, :app => notifiable_app)}
-        let!(:status) { create(:notification_status, :notification => n, :device_token => token) }
-      
-        before(:each) { put :opened, {:notification_id => n.id, :device_token_id => token.id, :user_email => user2.email} }
+        let(:localized_notification) { create(:localized_notification, :locale => :en) }
+        subject!(:status) { create(:notification_status, :localized_notification => localized_notification, :device_token => token) }
+              
+        before(:each) { put :opened, {:localized_notification_id => localized_notification.id, :device_token_id => token.id, :user_email => user2.email} }
 
         it { expect(response.status).to eq 401 }      
         it { expect(Notifiable::NotificationStatus.count).to eq 1 }
@@ -49,10 +49,10 @@ describe Notifiable::NotificationsController do
     describe "anonymously" do
       let(:notifiable_app) { create(:app) }
       let(:token) { create(:mock_token, :app => notifiable_app) }
-      subject(:n) { create(:notification, :app => notifiable_app)}
-      let!(:status) { create(:notification_status, :notification => n, :device_token => token) }
+      let(:localized_notification) { create(:localized_notification, :locale => :en) }
+      let!(:status) { create(:notification_status, :localized_notification => localized_notification, :device_token => token) }
       
-      before(:each) { put :opened, {:notification_id => n.id, :device_token_id => token.id} }
+      before(:each) { put :opened, {:localized_notification_id => localized_notification.id, :device_token_id => token.id} }
       
       it { expect(Notifiable::NotificationStatus.count).to eq 1 }
       it { expect(Notifiable::NotificationStatus.first.opened?).to eq true }

data/spec/model/device_token_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Notifiable::DeviceToken do
+  
+  describe "#locale" do
+    subject(:token) { create(:mock_token, :locale => 'en') }
+    
+    it { expect(token.locale).to eq 'en' }
+  end
+  
+  describe "#notification_statuses" do
+    subject(:token) { create(:mock_token, :notification_statuses => create_list(:notification_status, 2)) }
+    
+    it { expect(token.notification_statuses.count).to eq 2 }
+  end
+end

data/spec/model/localized_notification_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Notifiable::LocalizedNotification do
+
+  describe "#locale" do
+    subject!(:l) { create(:localized_notification, :locale => 'en') }
+    
+    it { expect(Notifiable::LocalizedNotification.first.locale).to eq 'en' }
+  end
+  
+  describe "#message" do
+    subject!(:l) { create(:localized_notification, :message => "Test message") }
+    
+    it { expect(Notifiable::LocalizedNotification.first.message).to eq "Test message" }
+  end
+  
+  describe "#params" do
+    subject!(:l) { create(:localized_notification, :params => {:custom_property => "A different message"}) }
+    
+    it { expect(Notifiable::LocalizedNotification.first.params).to eq({:custom_property => "A different message"}) }
+  end
+  
+  describe "#notification" do
+    let(:n) {create(:notification)}
+    subject!(:l) { create(:localized_notification, :notification => n) }
+    
+    it { expect(Notifiable::LocalizedNotification.first.notification).to eq n }
+  end
+  
+  describe "#destroy" do
+    subject(:l) { create(:localized_notification) }
+    let!(:s) { create(:notification_status, :localized_notification => l) }
+    
+    before(:each) { l.destroy }
+    
+    it { expect(Notifiable::NotificationStatus.count).to eq 0 }
+  end
+end

data/spec/model/notifiable_spec.rb

@@ -5,8 +5,8 @@ describe Notifiable::Concern do
   describe "#send_notification" do
     
     context "single" do
-      let(:user1) { create(:user_with_mock_token) }
-      let(:notification1) { create(:notification, :message => "First test message")} 
+      let(:user1) { create(:user_with_en_token) }
+      let(:notification1) { create(:notification_with_en_localization) } 
       
       before(:each) { user1.send_notification(notification1) }
       
@@ -15,7 +15,7 @@ describe Notifiable::Concern do
     
     context "invalid device" do
       let(:user1) { FactoryGirl.create(:user_with_invalid_mock_token) }
-      let(:notification1) { create(:notification, :message => "First test message")} 
+      let(:notification1) { create(:notification_with_en_localization) } 
     
       before(:each) { user1.send_notification(notification1) }
       

data/spec/model/notification_spec.rb

@@ -1,27 +1,18 @@
 require 'spec_helper'
 
 describe Notifiable::Notification do
-  
-  let(:user1) { FactoryGirl.create(:user_with_mock_token) }
-  let(:user2) { FactoryGirl.create(:user_with_mock_token) }
-  let(:notification1) { FactoryGirl.create(:notification, :message => "First test message")}
-  let(:notification2) { FactoryGirl.create(:notification, :message => "Second test message")}
-  
-  describe "#message" do
-    subject!(:n) { create(:notification, :message => "Test message") }
-    
-    it { expect(Notifiable::Notification.first.message).to eq "Test message" }
-  end
-  
-  describe "#params" do
-    subject!(:n) { create(:notification, :params => {:custom_property => "A different message"}) }
-    
-    it { expect(Notifiable::Notification.first.params).to eq({:custom_property => "A different message"}) }
+
+  describe "#localized_notifications" do
+    subject(:n) { create(:notification) }
+    let!(:localizations) { create_list(:localized_notification, 2, :notification => n)}
+
+    it { expect(Notifiable::Notification.count).to eq 1 }    
+    it { expect(Notifiable::Notification.first.localized_notifications.count).to eq 2 }
   end
   
   describe "#destroy" do
-    subject(:n) { create(:notification) }
-    let!(:s) { create(:notification_status, :notification => n) }
+    subject(:n) { create(:localized_notification) }
+    let!(:s) { create(:notification_status, :localized_notification => n) }
     
     before(:each) { n.destroy }
     
@@ -30,11 +21,11 @@ describe Notifiable::Notification do
   
   describe "#add_notifiable" do
     context "for a single user" do
-      subject(:notification) { create(:notification) }
-      let(:u) { create(:user_with_mock_token) }
+      subject(:notification) { create(:notification_with_en_localization) }
+      let(:u) { create(:user_with_en_token) }
     
       before(:each) do
-        notification1.batch do |n|
+        notification.batch do |n|
           n.add_notifiable(u)
         end      
       end
@@ -48,12 +39,12 @@ describe Notifiable::Notification do
     end
     
     context "for two users" do
-      subject(:notification) { create(:notification) }
-      let(:u1) { create(:user_with_mock_token) }
-      let(:u2) { create(:user_with_mock_token) }
+      subject(:notification) { create(:notification_with_en_localization) }
+      let(:u1) { create(:user_with_en_token) }
+      let(:u2) { create(:user_with_en_token) }
     
       before(:each) do
-        notification1.batch do |n|
+        notification.batch do |n|
           n.add_notifiable(u1)
           n.add_notifiable(u2)
         end      
@@ -73,10 +64,10 @@ describe Notifiable::Notification do
   
   describe "#add_device_token" do
     context "single token" do
-      subject(:n) { create(:notification) }
-      let(:dt) { create(:mock_token) }
+      subject(:notification) { create(:notification_with_en_localization) }
+      let(:dt) { create(:device_token, :locale => :en) }
     
-      before(:each) { notification1.batch {|n| n.add_device_token(dt) } }
+      before(:each) { notification.batch {|n| n.add_device_token(dt) } }
     
       it { expect(Notifiable::Notification.first.sent_count).to eq 1 }
       it { expect(Notifiable::Notification.first.gateway_accepted_count).to eq 1 }
@@ -87,11 +78,11 @@ describe Notifiable::Notification do
     end
     
     context "undefined provider" do
-      subject(:n) { create(:notification) }
+      subject(:notification) { create(:notification) }
       let(:dt) { create(:mock_token, :provider => :sms) }
       
       before(:each) do
-        notification1.batch do |n|      
+        notification.batch do |n|      
           begin    
             n.add_device_token(unconfigured_device_token)
           rescue

data/spec/spec_helper.rb

@@ -45,6 +45,10 @@ RSpec.configure do |config|
   # Infer the spec type from the containing folder
   config.infer_spec_type_from_file_location!
   
+  config.before(:suite) do
+    #FactoryGirl.lint
+  end
+  
   config.before(:each) {
     DatabaseCleaner.start
     Notifiable.delivery_method = :send

data/spec/support/factories.rb

@@ -1,8 +1,10 @@
 FactoryGirl.define do
 
-  factory :mock_token, :class => Notifiable::DeviceToken do
+  sequence(:token) {|n| "ABCD#{n}" }
+
+  factory :device_token, aliases: [:mock_token], :class => Notifiable::DeviceToken do
     provider :mock
-    sequence(:token) {|n| "ABCD#{n}" }
+    token
     app
     
     factory :invalid_mock_token do
@@ -15,13 +17,22 @@ FactoryGirl.define do
   
   factory :notification, :class => Notifiable::Notification do
     app
+    
+    factory :notification_with_en_localization do
+      after(:create) do |notification, evaluator|
+        FactoryGirl.create(:localized_notification, :locale => :en, :notification => notification)
+      end
+    end
   end
   
+  factory :localized_notification, :class => Notifiable::LocalizedNotification do
+    notification
+  end
   
   factory :notification_status, :class => Notifiable::NotificationStatus do
-    notification
+    localized_notification
     status 0
-    association :device_token, factory: :mock_token
+    device_token
   end
   
   sequence(:email) {|n| "person-#{n}@example.com" }
@@ -29,9 +40,9 @@ FactoryGirl.define do
   factory :user do
     email
     
-    factory :user_with_mock_token do
+    factory :user_with_en_token do
       after(:create) do |user, evaluator|
-        FactoryGirl.create(:mock_token, :user_id => user.id)
+        FactoryGirl.create(:device_token, :user_id => user.id, :locale => :en)
       end
     end
   

data/spec/test_app/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20131210115652) do
+ActiveRecord::Schema.define(version: 20131210115660) do
 
   create_table "notifiable_apps", force: true do |t|
     t.string   "name"
@@ -23,6 +23,7 @@ ActiveRecord::Schema.define(version: 20131210115652) do
   create_table "notifiable_device_tokens", force: true do |t|
     t.string   "token"
     t.string   "provider"
+    t.string   "locale"
     t.boolean  "is_valid",   default: true
     t.integer  "user_id"
     t.integer  "app_id"
@@ -33,9 +34,16 @@ ActiveRecord::Schema.define(version: 20131210115652) do
   add_index "notifiable_device_tokens", ["token"], name: "index_notifiable_device_tokens_on_token", unique: true
   add_index "notifiable_device_tokens", ["user_id"], name: "index_notifiable_device_tokens_on_user_id"
 
-  create_table "notifiable_notifications", force: true do |t|
+  create_table "notifiable_localized_notifications", force: true do |t|
     t.text     "message"
     t.text     "params"
+    t.string   "locale"
+    t.integer  "notification_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "notifiable_notifications", force: true do |t|
     t.integer  "app_id"
     t.integer  "sent_count",             default: 0
     t.integer  "gateway_accepted_count", default: 0
@@ -45,7 +53,7 @@ ActiveRecord::Schema.define(version: 20131210115652) do
   end
 
   create_table "notifiable_statuses", force: true do |t|
-    t.integer  "notification_id"
+    t.integer  "localized_notification_id"
     t.integer  "device_token_id"
     t.integer  "status"
     t.datetime "created_at"