pntfr 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 829fb782afdbc0f329c888243e0c764e7a834ee3
-  data.tar.gz: 3ea3b3eebb5276bab7e97d9cb43aeb4809aea9d8
+  metadata.gz: 72f800de7abd264da783c00f614745d0707a1c67
+  data.tar.gz: 6a517da6bbb0289631ed30b446b446162a9afb55
 SHA512:
-  metadata.gz: 9c6647911bfde73e6e622670c9168e75aa07c36926b63b7b553e754862c7f173545656b7e273a97455e34aaa3047b7db3be022aa54df382c082bbf465edbc5a3
-  data.tar.gz: 62d5b85dab82325fef872b3d674ed1b670722af2775ca6162d3002ee39f1a03465976b68a788e5b7e3aa31dcbd145ca47560940b946f045e45355a6ee17fbb2c
+  metadata.gz: ef4c923993a150b1d72c02ff360675a86cd0b786836b12c558dd72e426d178fb0904640a7ec6a49b3c180643bc4f149f7e3997080073e47cc1587b7935ccdffc
+  data.tar.gz: 84b38c45c01d94fb1a70821da23f54eba0bcb4b2d4efb0fe8d59c953e5678540359be4ffc3359fdc6cc4042a81f5e33fd759189793ee8b3d1108b4d98d89597e

data/README.md

@@ -65,8 +65,33 @@ Pntfr::Notifier.to(session).msg({:title => 'Some Title', :description => 'A desc
 #send many notifications to a given device
 vsession= Pntfr::Notifier.to(session)
 vsession.msg({:title => 'Some Title', :description => 'A description'}).notify
-vsession.msg({:title => 'Some Other Title', :description => 'Another description', :sound => 'flipping-sound.aiff'}).notify
+vsession.msg({
+  :title => 'Some Other Title',
+  :description => 'Another description',
+  :sound => 'flipping-sound.aiff'})
+vsession.notify
+
+# send notifications with custom content (an extra optional parameter to #msg)
+vsession= Pntfr::Notifier.to(session)
+vsession.msg(
+  {:title => 'Some Title', :description => 'A description'},
+  {
+    :extra1 => 'extra one',
+    :extra_2 => 'extra 2',
+    :'last-extra' => {lastkey: 'last value'}
+  }
+)
+vsession.notify
+
+# Custom content will be found into :custom key for Android.
+# For iOS each custom key is transformed into an 'acme-' prefixed key.
 ```
+# Testing
+For testing one can check the messages to be sent to each given driver 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.
 
 # Resources
 - Depends on APNS gem: https://rubygems.org/gems/apns

data/lib/pntfr/version.rb

@@ -1,3 +1,6 @@
 module Pntfr
-  VERSION = '0.1.3'
+  # [FEATURE] Accept custom content.
+  # [DOC] Documentation for testing.
+  # [TEST] Facilitate Rails testing.
+  VERSION = '0.1.4'
 end

data/lib/pntfr/virtual_session/android.rb

@@ -13,12 +13,13 @@ module Pntfr
         @gcm= ::GCM.new(@notification_key) unless Pntfr.test_env?
       end
 
-      def msg content
+      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

data/lib/pntfr/virtual_session/ios.rb

@@ -5,14 +5,15 @@ require 'apns'
 module Pntfr
   module VirtualSession
     class Ios < Pntfr::VirtualSession::Base
-      def msg content
+      def msg content, custom=nil
         configure_apns
         reset_msg
         @alert= content[:title]
-        @alert+= "\n#{content[:description]}"
+        @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
 
@@ -25,6 +26,7 @@ module Pntfr
           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)
@@ -48,7 +50,13 @@ module Pntfr
       def reset_msg
         @alert= @sound= @badge= nil
       end
-
+      def add_custom_content custom
+        @custom= {}
+        custom.each_pair { |k, v|
+          key= "acme-#{k}".to_sym
+          @custom[key]= v
+        }
+      end
     end
   end
 end

data/pntfr.gemspec

@@ -9,8 +9,9 @@ Gem::Specification.new do |spec|
   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.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = "http://www.coditramuntana.com"
+  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"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/test/fxtr.rb

@@ -0,0 +1,27 @@
+# Fixtures
+#
+#
+
+module Fxtr
+  module Android
+    def self.simple_msg
+      {
+        :title => 'Some Title', :description => 'A description',
+        :sound => 'bell.caff'
+      }
+    end
+  end
+  module Common
+    # without description, only title
+    def self.simple_msg
+      {:title => 'Test Title'}
+    end
+    def self.custom_msg_content
+      {
+        :extra1 => 'extra one',
+        :extra_2 => 'extra 2',
+        :'last-extra' => {lastkey: 'last value'}
+      }
+    end
+  end
+end

data/test/pntfr/device_session.rb

@@ -3,4 +3,4 @@
 # 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)
+Pntfr::IosDeviceSession= Struct.new(:platform, :push_id, :num_notifs)

data/test/pntfr/virtual_session/android_test.rb

@@ -1,44 +1,61 @@
 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
-        push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
-        session= DeviceSession.new(Pntfr::Platforms::ANDROID, push_id)
+        session= DeviceSession.new(Pntfr::Platforms::ANDROID, @push_id)
 
-        vsession= Pntfr::Notifier.to(session).msg({
-            :title => 'Some Title', :description => 'A description',
-            :sound => 'bell.caff'
-          })
+        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}"
+        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
-        push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
-        session= DeviceSession.new(Pntfr::Platforms::ANDROID, push_id)
+        session= DeviceSession.new(Pntfr::Platforms::ANDROID, @push_id)
 
-        vsession= Pntfr::Notifier.to(session).msg({
-            :title => 'Some Title', :description => 'A description',
-            :sound => 'bell.caff'
-          })
+        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}"
+        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_test.rb

@@ -2,16 +2,18 @@ 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
-        push_id= 'IOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSios'
-        session= DeviceSession.new(Pntfr::Platforms::IOS, push_id)
+        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_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]
@@ -39,6 +41,23 @@ module Pntfr
         assert_equal 'default', notif[:sound]
         assert_equal 5, notif[:badge]
       end
+
+      def test_sending_custom_content_for_ios_should_be_added_as_acme_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]
+        assert_equal 'extra one', ios_notif[:'acme-extra1']
+        assert_equal 'extra 2', ios_notif[:'acme-extra_2']
+        assert_equal({lastkey: 'last value'}, ios_notif[:'acme-last-extra'])
+      end
     end
   end
 end

data/test/pntfr_configuration_test.rb

@@ -25,4 +25,4 @@ module Pntfr
     end
 
   end
-end
+end

data/test/test_helper.rb

@@ -7,7 +7,7 @@ require 'pntfr'
 # require all test files
 def add_to_path(d)
   Dir.entries(d).each do |f|
-    next if f == '.' or f == '..'
+    next if f == '.' || f == '..'
     file= File.join(d, f)
     if File.directory?(file)
       add_to_path(file)
@@ -17,4 +17,3 @@ def add_to_path(d)
   end
 end
 add_to_path(File.dirname(__FILE__))
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pntfr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apns
@@ -98,7 +98,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: One single API to send push notifications to Android and iOS devices.
 email:
 - oliver.hv@coditramuntana.com
 executables: []
@@ -123,6 +123,7 @@ files:
 - 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/platforms_test.rb
 - test/pntfr/push_notifier_test.rb
@@ -132,7 +133,7 @@ files:
 - test/pntfr/virtual_session/response_test.rb
 - test/pntfr_configuration_test.rb
 - test/test_helper.rb
-homepage: http://www.coditramuntana.com
+homepage: https://github.com/tramuntanal/pntfr
 licenses:
 - MIT
 metadata: {}
@@ -158,6 +159,7 @@ 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.
 test_files:
+- test/fxtr.rb
 - test/pntfr/device_session.rb
 - test/pntfr/platforms_test.rb
 - test/pntfr/push_notifier_test.rb