Send 1 message to many devices + Allow overriding general configuration credentials + Internal refactoring.

Author: tramuntanal

Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    pntfr (0.2.0)
+      apns (~> 1.0, >= 1.0.0)
+      gcm (~> 0.0, >= 0.0.9)
+      json (~> 1.8, >= 1.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    apns (1.0.0)
+    gcm (0.1.0)
+      httparty
+      json
+    httparty (0.13.4)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.2)
+    minitest (5.7.0)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  minitest (~> 5.7.0)
+  pntfr!
+  rake

lib/pntfr/notification.rb

@@ -0,0 +1,42 @@
+# Encapsulates the content of a notification in a neutral maneer.
+# For each platform it can return the notification in the corresponding format
+# using #to_platform like methods (i.e. #to_ios)
+#
+
+module Pntfr
+  class Notification
+    FILE_EXTENSION_REGEXP= /(\.[^\.]+)\z/
+
+    def initialize content, custom=nil
+      @content= content
+      @custom= custom
+    end
+
+    def to_ios
+      alert= @content[:title]
+      alert+= "\n#{@content[:description]}" if @content.key?(:description)
+      sound= @content[:sound]
+      badge= @content[:badge]
+      badge= @content[:badge].to_i if badge
+      n= {:alert => alert, :sound => 'default'}
+      n[:sound]= sound if sound
+      n[:badge]= badge if badge
+      n.merge!({other: {custom: @custom}}) if @custom
+      n
+    end
+
+    def to_android
+      data= {
+        :title        => @content[:title],
+        :description  => @content[:description],
+      }
+      data[:sound]= remove_extension(@content[:sound]) unless @content[:sound].nil?
+      data[:custom]= @custom if @custom
+      data
+    end
+    def remove_extension filename
+      filename.gsub(FILE_EXTENSION_REGEXP, '')
+    end
+
+  end
+end

lib/pntfr/notifier.rb

@@ -1,15 +1,94 @@
-require File.dirname(__FILE__) + '/virtual_session/base'
+require File.dirname(__FILE__) + '/session/base'
+require File.dirname(__FILE__) + '/notification'
 
 module Pntfr
 
   class Notifier
-    def self.to session
-      if Platforms.android? session.platform
-        Pntfr::VirtualSession::Android.new(session)
-      elsif Platforms.ios? session.platform
-        Pntfr::VirtualSession::Ios.new(session)
+    def self.to devices, credentials=nil
+      notif= Notifier.new(credentials)
+      notif.update_devices(devices)
+      notif
+    end
+
+    attr_reader :andr_responses
+    attr_reader :ios_responses
+
+    #
+    # +credentials+ is a hash with 2 keys :andr and :ios, each one with its
+    # given credentials:
+    # - :andr => a string with the notification_key
+    # - :ios  => a hash of the form {
+    #    host: 'test-host',
+    #    pem: 'test-pem',
+    #    port: 'test-port',
+    #    pass: 'test-password',
+    #  }
+    #
+    def initialize credentials=nil
+      validate_credentials(credentials)
+      @credentials= credentials || {}
+
+      @andr_responses=[]
+      @ios_responses= []
+    end
+
+    def update_devices(devices)
+      devices= [devices] unless devices.kind_of?(Array)
+
+      # the list of ANDROID push_id to send the notification to
+      @andr_ids= []
+      @ios_devices= []
+      devices.each do |device|
+        if Platforms.android? device.platform
+          @andr_ids << device.push_id
+        elsif Platforms.ios? device.platform
+          @ios_devices << device
+        end
+      end
+      self
+    end
+
+    def msg content, custom=nil
+      @msg= Notification.new(content, custom)
+      self
+    end
+
+    def notify
+      if any_android_device?
+        @andr_responses << andr_session.notify(@andr_ids, @msg.to_android)
+      end
+      if any_ios_device?
+        @ios_responses << ios_session.notify(@ios_devices, @msg.to_ios)
+      end
+    end
+
+    def any_android_device?
+      @andr_ids.any?
+    end
+
+    def any_ios_device?
+      @ios_devices.any?
+    end
+
+    #--------------------------------------------
+    private
+    #--------------------------------------------
+    def andr_session
+      @andr_session||= Pntfr::Session::Android.new(@credentials[:andr])
+    end
+    def ios_session
+      @ios_session||= Pntfr::Session::Ios.new(@credentials[:ios])
+    end
+    def validate_credentials(credentials)
+      return if credentials.nil?
+      if !credentials.is_a?(Hash)
+        raise ArgumentError.new('Credentials should be a Hash with either :andr or :ios keys!')
+      end
+      if !(credentials.has_key?(:andr) or credentials.has_key?(:ios))
+        raise ArgumentError.new('Either :andr or :ios service credentials should have been provided!')
       end
     end
+
   end
 
 end

lib/pntfr/session/android.rb

@@ -0,0 +1,38 @@
+#
+# Session implementation for Android
+#
+require 'gcm'
+module Pntfr
+  module Session
+    class Android < Pntfr::Session::Base
+
+      attr_reader :gcm
+
+      def initialize notification_key=nil
+        if notification_key.nil?
+          notification_key= Pntfr.config.gcm[:notification_key]
+        end
+        @gcm= ::GCM.new(notification_key)
+      end
+
+      def notify(push_ids, data)
+        options = {data: data}
+        if Pntfr.test_env?
+          push_ids.each { |push_id| Pntfr.add_delivery(push_id, options) }
+          Session::SuccessResponse.new
+        else
+          rs= @gcm.send_notification(push_ids, options)
+          parse_response rs
+        end
+      end
+
+      #---------------------------------------------------------
+      private
+      #---------------------------------------------------------
+      def parse_response rs
+        Session::GcmResponse.new(rs)
+      end
+
+    end
+  end
+end

lib/pntfr/session/base.rb

@@ -0,0 +1,19 @@
+module Pntfr
+  module Session
+    class Base
+      def initialize devices
+        @devices= devices
+      end
+      def msg content
+        raise 'not implemented!'
+      end
+      def notify(push_ids, data)
+        raise 'not implemented!'
+      end
+    end
+  end
+end
+require 'pntfr/session/success_response'
+require 'pntfr/session/android'
+require 'pntfr/session/gcm_response'
+require 'pntfr/session/ios'

…b/pntfr/virtual_session/base_response.rb lib/pntfr/session/base_response.rblib/pntfr/virtual_session/base_response.rb renamed to lib/pntfr/session/base_response.rb lib/pntfr/virtual_session/base_response.rb renamed to lib/pntfr/session/base_response.rb

@@ -1,5 +1,5 @@
 module Pntfr
-  module VirtualSession
+  module Session
     class BaseResponse
       # communication with notification service was OK?
       # implies no +failure?+

lib/pntfr/virtual_session/gcm_response.rb lib/pntfr/session/gcm_response.rblib/pntfr/virtual_session/gcm_response.rb renamed to lib/pntfr/session/gcm_response.rb

@@ -1,11 +1,11 @@
 #
 # Google Cloud Messaging json response wrapper.
 #
-require 'pntfr/virtual_session/base_response'
+require 'pntfr/session/base_response'
 require 'json'
 
 module Pntfr
-  module VirtualSession
+  module Session
     class GcmResponse < BaseResponse
       def initialize json
         @raw= json

lib/pntfr/session/ios.rb

@@ -0,0 +1,58 @@
+#
+# Session implementation for iOS
+#
+require 'apns'
+module Pntfr
+  module Session
+    class Ios < Pntfr::Session::Base
+
+      attr_reader :apns
+
+      def initialize apns_config=nil
+        if apns_config.nil?
+          configure_apns(Pntfr.config.apns)
+        else
+          configure_apns(apns_config)
+        end
+      end
+
+      def notify devices, notification
+        apns_notifications= []
+        devices.each do |device|
+          if device_controls_badge(device)
+            if !notification[:badge].nil?
+              device.num_notifs= notification[:badge]
+            else
+              device.num_notifs+= 1
+              notification[:badge]= device.num_notifs
+            end
+          end
+          if Pntfr.test_env?
+            Pntfr.add_delivery(device.push_id, notification)
+          else
+            apns_notif= APNS::Notification.new(device.push_id, notification)
+            apns_notifications << apns_notif
+          end
+        end
+        ::APNS.send_notifications(apns_notifications) if apns_notifications.any?
+        SuccessResponse.new
+      end
+
+      #-------------------------------------------------
+      private
+      #-------------------------------------------------
+
+      def device_controls_badge(device)
+        device.methods.include?(:num_notifs)
+      end
+
+      def configure_apns config
+        APNS.host = config[:host]
+        APNS.pem  = config[:pem]
+        APNS.port = config[:port]
+        APNS.pass = config[:pass]
+        @apns= APNS
+      end
+    end
+  end
+end

…ntfr/virtual_session/success_response.rb lib/pntfr/session/success_response.rblib/pntfr/virtual_session/success_response.rb renamed to lib/pntfr/session/success_response.rb lib/pntfr/virtual_session/success_response.rb renamed to lib/pntfr/session/success_response.rb

@@ -2,10 +2,10 @@
 # Always success.
 # To be used on cases where no response to be parsed is received.
 #
-require 'pntfr/virtual_session/base_response'
+require 'pntfr/session/base_response'
 
 module Pntfr
-  module VirtualSession
+  module Session
     class SuccessResponse < BaseResponse
       # communication with notification service was OK?
       # implies no +failure?+

lib/pntfr/version.rb

@@ -1,9 +1,12 @@
 module Pntfr
-  # For IOS do not prefix custom fields with 'acme-' in the notification,
-  # instead group them all into a :custom key, like in Android.
   #
-  # As this change doesn't break the gems API but changes device's management of
-  # received notifications, lets change only the minor version. This will also
-  # reflect the adding of the custom keys feature.
-  VERSION = '0.2.0'
+  # - Performance improvement: Allow sending one message to many devices in one
+  # single call (on both platforms).
+  # - Allow overriding general configuration credentials when instantiating each
+  # Notifier (on both platforms).
+  # - Internal refactoring.
+  #
+  # As this change don't break the gem's API (it extends it), lets change only
+  # minor version.
+  VERSION = '0.3.0'
 end