pntfr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f221094bc8a33889ee989b9c5e0b3efa6bb6ff8b
-  data.tar.gz: c6a9e243937f0edd3156f7aa08286cf1d94df001
+  metadata.gz: c5cf720813ce033ef80813fd133fc74ef8db6b2b
+  data.tar.gz: 38e3393d5950af33c10bd82e01e5eec01cc01345
 SHA512:
-  metadata.gz: 9967a87ce75e3d54a592fcd3b5ffc6fd1e6abbc673793b8c71a0ead675e692629f2d121dcdfad90e3a92fd4992d8383646cdaa37afa0af38dc9b3185f76328c8
-  data.tar.gz: d65996ca9d17152d5f41cb6cf6be1a96be4a2afce06ccb27e49b9f12fbdcde55a02bc8c1472d37798a844e6617811f56142759218ee8da7b6f544b41a0bec30b
+  metadata.gz: c73fce1055940fec086f8a242deae2ab71ec09d950e269c1bfbc6ae6203b14d36dc5a8476b803d6660ca8f11053f1b914f01d305d17537dccd95b803e9c596f7
+  data.tar.gz: 43d6a4e89c141f6025418a24351bfd967b09f54656b1981cefde5f1c4e3be4545d4e11e2b230194f8ba139a8fbf79201e52a7da98e3869a479adad51bde20958

data/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

data/README.md

@@ -1,13 +1,18 @@
 # Pntfr
-Push Notifier is a simple adapter for APNS (Apple Push Notification Service) and GCM (Google Cloud Messaging) gems, that way you can use same API to send push notifications to both devices.
+Push Notifier is a simple adapter for APNS (Apple Push Notification Service) and GCM (Google Cloud Messaging) gems, that way you can use one message format and one library to send push notifications to both devices.
 
 # Usage
 ## Installation
 Add it to your Gemfile:
 
-gem 'pntfr', '~>0.1.1'
+gem 'pntfr', '~>0.3.0'
 
 ## Configuration
+Pntfr can be configured in two ways.
+- Setting a global configuration
+- Setting notification service's configuration on each call.
+
+### Global configuration
 To configure the Apple Push Notification Service just set the Hash of keys to be used:
 ```ruby
 Pntfr.configure do |config|
@@ -39,41 +44,55 @@ end
 ```
 
 ## Sending messages
-Pntfr suposes you have session objects with the `platform` and `push_id` attributes.
+Pntfr suposes you have device objects, or other kind of model, with `platform` and `push_id` attributes.
 Also, and optionally, a `num_notifs` integer attribute will be automagically managed to 
 monitor Apple's badge in notifications.
 
-The neutral model for the content of the messages is composed by a title and a description,
-this maps directly to Android notification's `data` content wile is concatenated with a newline
-for Apns notificaitons.
+In order to avoid having to create a different message for each platform Pntfr
+expects a "neutral format" for the messages. The neutral format of the messages
+is a map composed by `title` and `description` keys.
+This keys are added directly to Android notification's `data` content, on the
+other side, for Apns notifications, are concatenated with a newline
 
 Sending a notification is quite simple.
-- First, create a virtual session to manage each recipient's connection. This virtual
-session is platform specific and will take care of the message structure for the
-given platform and of connecting through the correct driver.
+- First, create a notifier to manage each recipient's connection. This notifier
+manages platform specific sessions and will take care of the message structure
+for each platform and of connecting through the correct driver.
 - Second, set the message to be sent
 - Third, notify.
-Your're done.
+You're done.
 
-Given you have a DeviceSession model in your application. Then to send notifications to a device do:
+Given you have a Device model in your application. Then to send notifications to a device do:
 ```ruby
-# get device session
-session= DeviceSession.new(platform: Pntfr::Platforms::IOS, push_id: '...')
+# SEND ONE NOTIFICATION TO A SINGLE DEVICE
+# get the device to be notified
+device= Device.new(platform: Pntfr::Platforms::IOS, push_id: '...')
 # send notification to the given device
-Pntfr::Notifier.to(session).msg({:title => 'Some Title', :description => 'A description'}).notify
+Pntfr::Notifier.to(device).msg({:title => 'Some Title', :description => 'A description'}).notify
 
-#send many notifications to a given device
-vsession= Pntfr::Notifier.to(session)
-vsession.msg({:title => 'Some Title', :description => 'A description'}).notify
-vsession.msg({
+# SEND ONE NOTIFICATION TO MANY DEVICES
+# using ActiveRecord for example
+notifier= Pntfr::Notifier.new
+notifier.notify({
   :title => 'Some Other Title',
   :description => 'Another description',
   :sound => 'flipping-sound.aiff'})
-vsession.notify
+Device.find_in_batches do |devices|
+  notifier.update_devices(devices)
+  notifier.notify
+end
+
+# SEND MANY NOTIFICATIONS TO A GIVEN DEVICE
+notifier= Pntfr::Notifier.to(device)
+notifier.msg({:title => 'Title1', :description => 'Description 1'}).notify
+notifier.msg({:title => 'Title2', :description => 'Description 2'}).notify
+notifier.msg({:title => 'Title3', :description => 'Description 3'}).notify
+...
 
-# send notifications with custom content (an extra optional parameter to #msg)
-vsession= Pntfr::Notifier.to(session)
-vsession.msg(
+# NOTIFICATIONS WITH CUSTOM CONTENT
+# send notifications with custom content (extra and optional parameter to #msg)
+notifier= Pntfr::Notifier.to(device)
+notifier.msg(
   {:title => 'Short Title'},
   {
     :extra1 => 'extra one',
@@ -81,17 +100,36 @@ vsession.msg(
     :'last-extra' => {lastkey: 'last value'}
   }
 )
-vsession.notify
+notifier.notify
 
-# Custom content will be found into :custom key for each platform.
+
+# Supose you have this configuration for 
+# SETTING ANPS AND GCN CREDENTIALS ON EACH NOTIFICATION
+# using different configuration on each call
+credentials= {ios: {
+        host: 'test-host',
+        pem: 'test-pem',
+        port: 'test-port',
+        pass: 'test-password',
+      },
+andr: 'notification key'
+}
+notifier= Pntfr::Notifier.new( credentials )
+# this Notifier instance overrides the global credentials configuration (if any)
+notifier.update_devices(device).msg({:title => 'Title', :description => 'Description'}).notify
+# of course the device's push_id and credentials should belong to the same application.
 ```
 # Testing
-For testing one can check the messages to be sent to each given driver the same way
+For testing, one can check the messages sent to each device the same way
 that Rails ActiveMailer works: messages are stacked into `Pntfr.deliveries[push_id]`,
 where for each key (push_id is the identifier of the device) one will get an ordered array 
 with all messages sent to the device while testing. Of course, while testing,
 notifications are not sent, only stored in the stack.
 
+# Further development (roadmap)
+- Update cannonical push id when required for gcm.
+- Retrieve feedback on sent messages for apns.
+
 # Resources
 - Depends on APNS gem: https://rubygems.org/gems/apns
 - Depends on GCM gem: https://rubygems.org/gems/gcm
@@ -99,6 +137,6 @@ notifications are not sent, only stored in the stack.
 
 # Authors
 
-- Oliver HV <https://github.com/tramuntanal>
+- Oliver Valls <https://github.com/tramuntanal>
 
 Contributions are always welcome and greatly appreciated!

data/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

data/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

data/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

data/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'

data/lib/pntfr/{virtual_session → 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?+

data/lib/pntfr/{virtual_session → 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

data/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

data/lib/pntfr/{virtual_session → 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?+

data/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

data/pntfr.gemspec

@@ -8,9 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Pntfr::VERSION
   spec.authors       = ['oliver']
   spec.email         = ['oliver.hv@coditramuntana.com']
-  spec.summary       = %q{Push notifier is a simple adapter for APNS and GCM gems, that way you can use same api to send push notifications to both devices.}
+  spec.summary       = %q{Push Notifier is a simple adapter for APNS (Apple Push Notification Service) and GCM (Google Cloud Messaging) gems, that way you can use one message format and one library to send push notifications to both devices.}
   spec.description   = %q{One single API to send push notifications to Android and iOS devices.}
-  #  spec.homepage      = "http://www.coditramuntana.com"
   spec.homepage      = 'https://github.com/tramuntanal/pntfr'
   spec.license       = "MIT"
 

data/test/pntfr/android_test.rb

@@ -0,0 +1,76 @@
+require 'pntfr/device'
+require 'fxtr'
+
+module Pntfr
+  class AndroidTest < Minitest::Test
+
+    def setup
+      @push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
+    end
+    def test_received_content_shoud_be_sent_to_gcm
+      device= Device.new(Pntfr::Platforms::ANDROID, @push_id)
+
+      notifier= Pntfr::Notifier.to(device).msg(Fxtr::Android.simple_msg)
+      notifier.notify
+      check_andr_msg_sent(notifier)
+
+      notifs= Pntfr.deliveries[@push_id]
+      refute_nil notifs, "A notification should have been delivered for #{@push_id}"
+      notif= notifs.last
+      assert_equal 'Some Title', notif[:data][:title]
+      assert_equal 'A description', notif[:data][:description]
+      assert_equal 'bell', notif[:data][:sound]
+    end
+    def test_sound_attribute_shoud_be_sent_to_gcm
+      device= Device.new(Pntfr::Platforms::ANDROID, @push_id)
+
+      notifier= Pntfr::Notifier.to(device).msg(Fxtr::Android.simple_msg)
+      notifier.notify
+      check_andr_msg_sent(notifier)
+
+      notifs= Pntfr.deliveries[@push_id]
+      refute_nil notifs, "A notification should have been delivered for #{@push_id}"
+      notif= notifs.last
+      assert_equal 'Some Title', notif[:data][:title]
+      assert_equal 'A description', notif[:data][:description]
+      assert_equal 'bell', notif[:data][:sound]
+    end
+
+    def test_sending_custom_content_for_android_should_be_added_as_more_keys
+      device= Device.new(Pntfr::Platforms::ANDROID, @push_id)
+
+      notifier= Pntfr::Notifier.to(device)
+      notifier.msg(Fxtr::Common.simple_msg, Fxtr::Common.custom_msg_content)
+      notifier.notify
+      check_andr_msg_sent(notifier)
+
+      notifs= Pntfr.deliveries[@push_id]
+      refute_nil notifs, "A notification should have been delivered for #{@push_id}"
+      notif= notifs.last
+      data= notif[:data]
+      assert_equal 'Test Title', data[:title]
+      assert_equal 'extra one', data[:custom][:extra1]
+      assert_equal 'extra 2', data[:custom][:extra_2]
+      assert_equal({lastkey: 'last value'}, data[:custom][:'last-extra'])
+
+    end
+
+    def test_when_overriding_android_credentials_should_use_new_ones
+      notification_key= 'OVERRIDEN-TEST-KEY'
+      andr_session= Pntfr::Session::Android.new(notification_key)
+      assert_equal 'OVERRIDEN-TEST-KEY', andr_session.gcm.api_key
+    end
+
+    #-------------------------------------------------------
+    private
+    #-------------------------------------------------------
+    def check_andr_msg_sent(notifier)
+      assert notifier.ios_responses.empty?
+      andr_rs= notifier.andr_responses
+      assert_equal 1, andr_rs.size
+      rs= andr_rs.first
+      assert rs.success? and rs.msg_sent?
+    end
+
+  end
+end

data/test/pntfr/device.rb

@@ -0,0 +1,6 @@
+# Pntfr's expected models to be used for testing purposes
+
+# minimal expected device
+Pntfr::Device= Struct.new(:platform, :push_id)
+# device with num_notifs which will be autoincremented on each sent msg
+Pntfr::IosDevice= Struct.new(:platform, :push_id, :num_notifs)

data/test/pntfr/ios_badge_test.rb

@@ -0,0 +1,16 @@
+require 'pntfr/device'
+
+module Pntfr
+  class IosBadgeTest < Minitest::Test
+    def test_sending_a_notification_increments_notifier_notifications_num
+      device= Pntfr::IosDevice.new(Pntfr::Platforms::IOS, '1id2id3id4id5id', 0)
+
+      Pntfr::Notifier.to(device).msg({:title => 't', :description => 'd'}).notify
+
+      notifs= Pntfr.deliveries['1id2id3id4id5id']
+      notif= notifs.last
+      assert_equal 1, notif[:badge]
+      assert_equal 1, device.num_notifs
+    end
+  end
+end

data/test/pntfr/ios_test.rb

@@ -0,0 +1,90 @@
+require 'pntfr/device'
+module Pntfr
+  class IosTest < Minitest::Test
+    def setup
+      @push_id= 'IOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSios'
+    end
+
+    def test_received_content_shoud_be_ready_to_be_sent_to_apns
+      device= Device.new(Pntfr::Platforms::IOS, @push_id)
+
+      notifier= Pntfr::Notifier.to(device)
+      notifier.msg({:title => 'thatitle', :description => 'thadescription', :sound => 'click.aiff', :badge => 33})
+      notifier.notify
+      check_ios_msg_sent(notifier)
+
+      ios_notifs= Pntfr.deliveries[@push_id]
+      refute_nil ios_notifs, "A notification should have been delivered for #{@push_id}"
+      ios_notif= ios_notifs.last
+      assert_equal "thatitle\nthadescription", ios_notif[:alert]
+      assert_equal 'click.aiff', ios_notif[:sound]
+      assert_equal 33, ios_notif[:badge]
+    end
+
+    def test_ios_information_from_previous_msg_should_be_reset_when_sending_a_new_msg
+      device= IosDevice.new(Pntfr::Platforms::IOS, name, 3)
+      notifier= Pntfr::Notifier.to(device)
+
+      notifier.msg(title: 't1', description: 'd1', sound: 's1').notify
+      check_ios_msg_sent(notifier)
+      notifier.msg(title: 't2', description: 'd2').notify
+      check_ios_msg_sent(notifier, 2)
+
+      notifs= Pntfr.deliveries[device.push_id]
+      assert_equal 5, device.num_notifs
+      assert_equal 2, notifs.size
+      notif= notifs.first
+      assert_equal "t1\nd1", notif[:alert]
+      assert_equal 's1', notif[:sound]
+      assert_equal 4, notif[:badge]
+      notif= notifs.last
+      assert_equal "t2\nd2", notif[:alert]
+      assert_equal 'default', notif[:sound]
+      assert_equal 5, notif[:badge]
+    end
+
+    def test_sending_custom_content_for_ios_should_be_added_as_custom_keys
+      device= Device.new(Pntfr::Platforms::IOS, @push_id)
+
+      notifier= Pntfr::Notifier.to(device)
+      notifier.msg(Fxtr::Common.simple_msg, Fxtr::Common.custom_msg_content)
+      notifier.notify
+      check_ios_msg_sent(notifier)
+
+      ios_notifs= Pntfr.deliveries[@push_id]
+      refute_nil ios_notifs, "A notification should have been delivered for #{@push_id}"
+      ios_notif= ios_notifs.last
+      assert_equal 'Test Title', ios_notif[:alert]
+      custom= ios_notif[:other][:custom]
+      assert_equal 'extra one', custom[:'extra1']
+      assert_equal 'extra 2', custom[:'extra_2']
+      assert_equal({lastkey: 'last value'}, custom[:'last-extra'])
+    end
+
+    def test_when_overriding_ios_credentials_should_use_new_ones
+      apns_config= {
+        host: 'test-host',
+        pem: 'test-pem',
+        port: 'test-port',
+        pass: 'test-password',
+      }
+      ios_session= Pntfr::Session::Ios.new(apns_config)
+      apns= ios_session.apns
+      assert_equal 'test-host', apns.host
+      assert_equal 'test-pem', apns.pem
+      assert_equal 'test-port', apns.port
+      assert_equal 'test-password', apns.pass
+    end
+
+    #-----------------------------------------------------------
+    private
+    #-----------------------------------------------------------
+    def check_ios_msg_sent(notifier, num_responses=1)
+      assert notifier.andr_responses.empty?
+      ios_rs= notifier.ios_responses
+      assert_equal num_responses, ios_rs.size
+      rs= ios_rs.first
+      assert rs.success? and rs.msg_sent?
+    end
+  end
+end

data/test/pntfr/notifier_test.rb

@@ -0,0 +1,73 @@
+require 'pntfr/device'
+module Pntfr
+  class NotifierTest < Minitest::Test
+
+    def setup
+      @andr_dev= Device.new(Pntfr::Platforms::ANDROID, 'ANDR_ID')
+      @ios_dev= Device.new(Pntfr::Platforms::IOS, 'IOS_ID')
+    end
+    def test_android_device_should_instantiate_notifier
+      notifier= Pntfr::Notifier.to(@andr_dev)
+      refute_nil notifier
+      assert notifier.any_android_device?
+    end
+    def test_ios_device_should_instantiate_notifier
+      notifier= Pntfr::Notifier.to(@ios_dev)
+      refute_nil notifier
+      assert notifier.any_ios_device?
+    end
+
+    def test_creating_notifier_with_many_devices_should_create_a_notifier
+      devices= [@andr_dev, @ios_dev]
+      notifier= Pntfr::Notifier.to(devices)
+      refute_nil notifier
+      assert notifier.any_android_device?
+      assert notifier.any_ios_device?
+    end
+
+    def test_when_updating_only_andr_devices_older_devices_from_ios_platforms_should_be_reseted
+      notifier= Pntfr::Notifier.to([@andr_dev, @ios_dev])
+      assert notifier.any_android_device?
+      assert notifier.any_ios_device?
+
+      notifier.update_devices(@andr_dev)
+      assert notifier.any_android_device?
+      refute notifier.any_ios_device?
+    end
+
+    def test_when_updating_only_ios_devices_older_devices_from_andr_platforms_should_be_reseted
+      notifier= Pntfr::Notifier.to([@andr_dev, @ios_dev])
+      assert notifier.any_android_device?
+      assert notifier.any_ios_device?
+
+      notifier.update_devices(@ios_dev)
+      refute notifier.any_android_device?
+      assert notifier.any_ios_device?
+    end
+
+    def test_setting_string_credentials_should_raise_argument_error
+      begin
+        Pntfr::Notifier.to(@andr_dev, 'ios=andr')
+        raise 'Should have raised an ArgumentError'
+      rescue ArgumentError
+      end
+    end
+
+    def test_setting_empty_hash_credentials_should_raise_argument_error
+      begin
+        Pntfr::Notifier.to(@andr_dev, {})
+        raise 'Should have raised an ArgumentError'
+      rescue ArgumentError
+      end
+    end
+
+    def test_setting_wrong_credentials_should_raise_argument_error
+      begin
+        Pntfr::Notifier.to(@ios_dev, {key1: 'asdf', wrongK: {}, android: [], iphone: ''})
+        raise 'Should have raised an ArgumentError'
+      rescue ArgumentError
+      end
+    end
+
+  end
+end

data/test/pntfr/{virtual_session → session}/response_test.rb

@@ -4,7 +4,7 @@ module Pntfr
     # Success response
     #
     def test_success_response_should_have_sent_msg_and_no_error
-      rs= VirtualSession::SuccessResponse.new
+      rs= Session::SuccessResponse.new
       assert rs.success? and rs.msg_sent?
       refute rs.error?
       refute rs.failure?
@@ -19,20 +19,20 @@ module Pntfr
     GCM_400_RESPONSE= {:body=>"\"registration_ids\" field is not a JSON array\n", :headers=>{"content-type"=>["text/plain; charset=UTF-8"], "date"=>["Tue, 09 Dec 2014 21:27:30 GMT"], "expires"=>["Tue, 09 Dec 2014 21:27:30 GMT"], "cache-control"=>["private, max-age=0"], "x-content-type-options"=>["nosniff"], "x-frame-options"=>["SAMEORIGIN"], "x-xss-protection"=>["1; mode=block"], "server"=>["GSE"], "alternate-protocol"=>["443:quic,p=0.02"], "connection"=>["close"]}, :status_code=>400, :response=>"Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields."}
 
     def test_gcm_200_responses_with_success_should_have_success_and_no_error
-      rs= VirtualSession::GcmResponse.new(GCM_200_WITH_SUCCESS)
+      rs= Session::GcmResponse.new(GCM_200_WITH_SUCCESS)
       assert rs.success?
       refute rs.error?
       assert_nil rs.error
     end
     def test_gcm_200_responses_with_invalid_registration_should_have_failed_and_report_error
-      rs= VirtualSession::GcmResponse.new(GCM_200_WITH_INVALID_REGISTRATION)
+      rs= Session::GcmResponse.new(GCM_200_WITH_INVALID_REGISTRATION)
       refute rs.failure?
       refute rs.msg_sent?
       assert rs.success? and rs.error?
       assert_equal 'InvalidRegistration', rs.error
     end
     def test_gcm_200_responses_with_mismatch_sender_id_should_have_failed_and_report_error
-      rs= VirtualSession::GcmResponse.new(GCM_200_WITH_MISMATCH_SENDER_ID)
+      rs= Session::GcmResponse.new(GCM_200_WITH_MISMATCH_SENDER_ID)
       assert rs.success?
       refute rs.msg_sent?
       assert rs.error?
@@ -40,7 +40,7 @@ module Pntfr
       assert_equal 'MismatchSenderId', rs.error
     end
     def test_gcm_400_responses_should_have_failed_and_report_error
-      rs= VirtualSession::GcmResponse.new(GCM_400_RESPONSE)
+      rs= Session::GcmResponse.new(GCM_400_RESPONSE)
       refute rs.success? and rs.error?
       assert rs.failure?
       expected= "\"registration_ids\" field is not a JSON array\n->Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields."
@@ -51,7 +51,7 @@ module Pntfr
         GCM_200_WITH_INVALID_REGISTRATION,
         GCM_200_WITH_MISMATCH_SENDER_ID,
         GCM_400_RESPONSE].each do |json|
-        assert_equal json.to_s, VirtualSession::GcmResponse.new(json).to_s
+        assert_equal json.to_s, Session::GcmResponse.new(json).to_s
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pntfr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apns
@@ -107,31 +107,33 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/pntfr.rb
+- lib/pntfr/notification.rb
 - lib/pntfr/notifier.rb
 - lib/pntfr/platforms.rb
+- lib/pntfr/session/android.rb
+- lib/pntfr/session/base.rb
+- lib/pntfr/session/base_response.rb
+- lib/pntfr/session/gcm_response.rb
+- lib/pntfr/session/ios.rb
+- lib/pntfr/session/success_response.rb
 - lib/pntfr/test_ext.rb
 - lib/pntfr/version.rb
-- lib/pntfr/virtual_session/android.rb
-- lib/pntfr/virtual_session/base.rb
-- lib/pntfr/virtual_session/base_response.rb
-- lib/pntfr/virtual_session/gcm_response.rb
-- lib/pntfr/virtual_session/ios.rb
-- lib/pntfr/virtual_session/success_response.rb
 - pntfr.gemspec
 - test/fxtr.rb
-- test/pntfr/device_session.rb
+- test/pntfr/android_test.rb
+- test/pntfr/device.rb
+- test/pntfr/ios_badge_test.rb
+- test/pntfr/ios_test.rb
+- test/pntfr/notifier_test.rb
 - test/pntfr/platforms_test.rb
-- test/pntfr/push_notifier_test.rb
-- test/pntfr/virtual_session/android_test.rb
-- test/pntfr/virtual_session/ios_badge_test.rb
-- test/pntfr/virtual_session/ios_test.rb
-- test/pntfr/virtual_session/response_test.rb
-- test/pntfr_configuration_test.rb
+- test/pntfr/session/response_test.rb
+- test/pntfr_global_configuration_test.rb
 - test/test_helper.rb
 homepage: https://github.com/tramuntanal/pntfr
 licenses:
@@ -153,19 +155,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Push notifier is a simple adapter for APNS and GCM gems, that way you can
-  use same api to send push notifications to both devices.
+summary: Push Notifier is a simple adapter for APNS (Apple Push Notification Service)
+  and GCM (Google Cloud Messaging) gems, that way you can use one message format and
+  one library to send push notifications to both devices.
 test_files:
 - test/fxtr.rb
-- test/pntfr/device_session.rb
+- test/pntfr/android_test.rb
+- test/pntfr/device.rb
+- test/pntfr/ios_badge_test.rb
+- test/pntfr/ios_test.rb
+- test/pntfr/notifier_test.rb
 - test/pntfr/platforms_test.rb
-- test/pntfr/push_notifier_test.rb
-- test/pntfr/virtual_session/android_test.rb
-- test/pntfr/virtual_session/ios_badge_test.rb
-- test/pntfr/virtual_session/ios_test.rb
-- test/pntfr/virtual_session/response_test.rb
-- test/pntfr_configuration_test.rb
+- test/pntfr/session/response_test.rb
+- test/pntfr_global_configuration_test.rb
 - test/test_helper.rb

data/lib/pntfr/virtual_session/android.rb

@@ -1,48 +0,0 @@
-#
-# VirtualSession implementation for Android
-#
-require 'gcm'
-module Pntfr
-  module VirtualSession
-    class Android < Pntfr::VirtualSession::Base
-      FILE_EXTENSION_REGEXP= /(\.[^\.]+)\z/
-
-      def initialize session
-        super
-        @notification_key= Pntfr.config.gcm[:notification_key]
-        @gcm= ::GCM.new(@notification_key) unless Pntfr.test_env?
-      end
-
-      def msg content, custom=nil
-        @data= {
-          :title        => content[:title],
-          :description  => content[:description],
-        }
-        @data[:sound]= parse_sound_file(content[:sound]) unless content[:sound].nil?
-        @data[:custom]= custom if custom
-        self
-      end
-      def notify
-        options = {data: @data}
-        if Pntfr.test_env?
-          Pntfr.add_delivery(@push_id, options)
-          VirtualSession::SuccessResponse.new
-        else
-          rs= @gcm.send_notification([@push_id], options)
-          parse_response rs
-        end
-      end
-
-      #---------------------------------------------------------
-      private
-      #---------------------------------------------------------
-      def parse_response rs
-        VirtualSession::GcmResponse.new(rs)
-      end
-
-      def parse_sound_file filename
-        filename.gsub(FILE_EXTENSION_REGEXP, '')
-      end
-    end
-  end
-end

data/lib/pntfr/virtual_session/base.rb

@@ -1,17 +0,0 @@
-module Pntfr
-  module VirtualSession
-    class Base
-      def initialize session
-        @session= session
-        @push_id= @session.push_id
-      end
-      def msg content
-        raise 'not implemented!'
-      end
-    end
-  end
-end
-require 'pntfr/virtual_session/success_response'
-require 'pntfr/virtual_session/android'
-require 'pntfr/virtual_session/gcm_response'
-require 'pntfr/virtual_session/ios'

data/lib/pntfr/virtual_session/ios.rb

@@ -1,58 +0,0 @@
-#
-# VirtualSession implementation for iOS
-#
-require 'apns'
-module Pntfr
-  module VirtualSession
-    class Ios < Pntfr::VirtualSession::Base
-      def msg content, custom=nil
-        configure_apns
-        reset_msg
-        @alert= content[:title]
-        @alert+= "\n#{content[:description]}" if content.key?(:description)
-        @sound= content[:sound]
-        badge= content[:badge]
-        @badge= content[:badge].to_i if badge
-        add_custom_content(custom) if custom
-        self
-      end
-
-      def notify
-        n= {:alert => @alert, :sound => 'default'}
-        if @badge
-          n[:badge]= @badge
-        elsif @session.methods.include?(:num_notifs)
-          @session.num_notifs+= 1
-          n[:badge]= @session.num_notifs
-        end
-        n[:sound]= @sound if @sound
-        n.merge!(@custom) if @custom
-
-        if Pntfr.test_env?
-          Pntfr.add_delivery(@push_id, n)
-        else
-          ::APNS.send_notification(@push_id, n)
-        end
-        SuccessResponse.new
-      end
-
-      #-------------------------------------------------
-      private
-      #-------------------------------------------------
-
-      def configure_apns
-        config= Pntfr.config.apns
-        APNS.host = config[:host]
-        APNS.pem  = config[:pem]
-        APNS.port = config[:port]
-        APNS.pass = config[:pass]
-      end
-      def reset_msg
-        @alert= @sound= @badge= nil
-      end
-      def add_custom_content custom
-        @custom= {other: {custom: custom}}
-      end
-    end
-  end
-end

data/test/pntfr/device_session.rb

@@ -1,6 +0,0 @@
-# Pntfr's expected models to be used for testing purposes
-
-# minimal expected session
-Pntfr::DeviceSession= Struct.new(:platform, :push_id)
-# session with num_notifs which will be autoincremented on each sent msg
-Pntfr::IosDeviceSession= Struct.new(:platform, :push_id, :num_notifs)

data/test/pntfr/push_notifier_test.rb

@@ -1,17 +0,0 @@
-require 'pntfr/device_session'
-module Pntfr
-  class NotifierTest < Minitest::Test
-
-    def test_android_sessions_should_instantiate_android_virtual_sessions
-      session= DeviceSession.new(Pntfr::Platforms::ANDROID)
-      vsess= Pntfr::Notifier.to(session)
-      assert vsess.is_a?(Pntfr::VirtualSession::Android)
-    end
-    def test_ios_sessions_should_instantiate_ios_virtual_sessions
-      session= DeviceSession.new(Pntfr::Platforms::IOS)
-      vsess= Pntfr::Notifier.to(session)
-      assert vsess.is_a?(Pntfr::VirtualSession::Ios)
-    end
-
-  end
-end

data/test/pntfr/virtual_session/android_test.rb

@@ -1,61 +0,0 @@
-require 'pntfr/device_session'
-require 'fxtr'
-
-module Pntfr
-  module VirtualSession
-    class AndroidTest < Minitest::Test
-
-      def setup
-        @push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
-      end
-      def test_received_content_shoud_be_sent_to_gcm
-        session= DeviceSession.new(Pntfr::Platforms::ANDROID, @push_id)
-
-        vsession= Pntfr::Notifier.to(session).msg(Fxtr::Android.simple_msg)
-        rs= vsession.notify
-        assert rs.success? and rs.msg_sent?
-
-        notifs= Pntfr.deliveries[@push_id]
-        refute_nil notifs, "A notification should have been delivered for #{@push_id}"
-        notif= notifs.last
-        assert_equal 'Some Title', notif[:data][:title]
-        assert_equal 'A description', notif[:data][:description]
-        assert_equal 'bell', notif[:data][:sound]
-      end
-      def test_sound_attribute_shoud_be_sent_to_gcm
-        session= DeviceSession.new(Pntfr::Platforms::ANDROID, @push_id)
-
-        vsession= Pntfr::Notifier.to(session).msg(Fxtr::Android.simple_msg)
-        rs= vsession.notify
-        assert rs.success? and rs.msg_sent?
-
-        notifs= Pntfr.deliveries[@push_id]
-        refute_nil notifs, "A notification should have been delivered for #{@push_id}"
-        notif= notifs.last
-        assert_equal 'Some Title', notif[:data][:title]
-        assert_equal 'A description', notif[:data][:description]
-        assert_equal 'bell', notif[:data][:sound]
-      end
-
-      def test_sending_custom_content_for_android_should_be_added_as_more_keys
-        session= DeviceSession.new(Pntfr::Platforms::ANDROID, @push_id)
-
-        vsession= Pntfr::Notifier.to(session)
-        vsession.msg(Fxtr::Common.simple_msg, Fxtr::Common.custom_msg_content)
-        rs= vsession.notify
-        assert rs.success? and rs.msg_sent?
-
-        notifs= Pntfr.deliveries[@push_id]
-        refute_nil notifs, "A notification should have been delivered for #{@push_id}"
-        notif= notifs.last
-        data= notif[:data]
-        assert_equal 'Test Title', data[:title]
-        assert_equal 'extra one', data[:custom][:extra1]
-        assert_equal 'extra 2', data[:custom][:extra_2]
-        assert_equal({lastkey: 'last value'}, data[:custom][:'last-extra'])
-
-      end
-
-    end
-  end
-end

data/test/pntfr/virtual_session/ios_badge_test.rb

@@ -1,18 +0,0 @@
-require 'pntfr/device_session'
-
-module Pntfr
-  module VirtualSession
-    class IosBadgeTest < Minitest::Test
-      def test_sending_a_notification_increments_session_notifications_num
-        session= Pntfr::IosDeviceSession.new(Pntfr::Platforms::IOS, '1id2id3id4id5id', 0)
-
-        Pntfr::Notifier.to(session).msg({:title => 't', :description => 'd'}).notify
-
-        notifs= Pntfr.deliveries['1id2id3id4id5id']
-        notif= notifs.last
-        assert_equal 1, notif[:badge]
-        assert_equal 1, session.num_notifs
-      end
-    end
-  end
-end

data/test/pntfr/virtual_session/ios_test.rb

@@ -1,64 +0,0 @@
-require 'pntfr/device_session'
-module Pntfr
-  module VirtualSession
-    class IosTest < Minitest::Test
-      def setup
-        @push_id= 'IOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSios'
-      end
-
-      def test_received_content_shoud_be_ready_to_be_sent_to_apns
-        session= DeviceSession.new(Pntfr::Platforms::IOS, @push_id)
-
-        rs= Pntfr::Notifier.to(session).msg({:title => 'thatitle', :description => 'thadescription', :sound => 'click.aiff', :badge => 33}).notify
-        assert rs.success? and rs.msg_sent?
-
-        ios_notifs= Pntfr.deliveries[@push_id]
-        refute_nil ios_notifs, "A notification should have been delivered for #{@push_id}"
-        ios_notif= ios_notifs.last
-        assert_equal "thatitle\nthadescription", ios_notif[:alert]
-        assert_equal 'click.aiff', ios_notif[:sound]
-        assert_equal 33, ios_notif[:badge]
-      end
-
-      def test_ios_information_from_previous_msg_should_be_reset_when_sending_a_new_msg
-        session= IosDeviceSession.new(Pntfr::Platforms::IOS, name, 3)
-        vsession= Pntfr::Notifier.to(session)
-
-        rs= vsession.msg(title: 't1', description: 'd1', sound: 's1').notify
-        assert rs.success? and rs.msg_sent?
-        rs= vsession.msg(title: 't2', description: 'd2').notify
-        assert rs.success? and rs.msg_sent?
-
-        notifs= Pntfr.deliveries[session.push_id]
-        assert_equal 5, session.num_notifs
-        assert_equal 2, notifs.size
-        notif= notifs.first
-        assert_equal "t1\nd1", notif[:alert]
-        assert_equal 's1', notif[:sound]
-        assert_equal 4, notif[:badge]
-        notif= notifs.last
-        assert_equal "t2\nd2", notif[:alert]
-        assert_equal 'default', notif[:sound]
-        assert_equal 5, notif[:badge]
-      end
-
-      def test_sending_custom_content_for_ios_should_be_added_as_custom_keys
-        session= DeviceSession.new(Pntfr::Platforms::IOS, @push_id)
-
-        vsession= Pntfr::Notifier.to(session)
-        vsession.msg(Fxtr::Common.simple_msg, Fxtr::Common.custom_msg_content)
-        rs= vsession.notify
-        assert rs.success? and rs.msg_sent?
-
-        ios_notifs= Pntfr.deliveries[@push_id]
-        refute_nil ios_notifs, "A notification should have been delivered for #{@push_id}"
-        ios_notif= ios_notifs.last
-        assert_equal 'Test Title', ios_notif[:alert]
-        custom= ios_notif[:other][:custom]
-        assert_equal 'extra one', custom[:'extra1']
-        assert_equal 'extra 2', custom[:'extra_2']
-        assert_equal({lastkey: 'last value'}, custom[:'last-extra'])
-      end
-    end
-  end
-end