pntfr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 881840f1cd5381a2e47d78f26b8abaa26cd2b02b
-  data.tar.gz: 9f8bb4c8aca929683314e84e203b8e6a9255b337
+  metadata.gz: 1f3b8477063d23af20f997756ac2525bd3b32780
+  data.tar.gz: 5f1680126704e0ebca33794342a03a96a471ab9c
 SHA512:
-  metadata.gz: 42006755a948b74d3f00b47c0db693d538278981d43ce1a383967cb95ab2d13efe61f016eb7b0dd6c38bc72c6bfefb602f0051e9d6aecefd619575f4399d827b
-  data.tar.gz: cd3fdf9794ec96cb0d38cec160eee42e26bab0cac6e71ff9925067982203de44524f8d65ef44d6113d6684883e0e3a52e5fabd30a29a96a681b91717928a4b55
+  metadata.gz: 4587cc3c9d9e1fc1707813312c914b10ae80bf849a9e56d3c2f2651fd31e8b2174fa404cfa9fa5b34cbc48b2cd28e2d003eda718f5aaf5c0914a42bd5eddee88
+  data.tar.gz: 5958abd16c317ca5eaf9b748b4fb8df87c4665208b4a9a9bd3b3422d0b88b2e3601820ca16020315e43e356616505cf4f8546d29efecf08966069d9bae7ce7c2

data/lib/pntfr/version.rb

@@ -1,3 +1,3 @@
 module Pntfr
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/pntfr/virtual_session/android.rb

@@ -1,14 +1,16 @@
 #
 # 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?
+        @gcm= ::GCM.new(@notification_key) unless Pntfr.test_env?
       end
 
       def msg content
@@ -16,17 +18,30 @@ module Pntfr
           :title        => content[:title],
           :description  => content[:description],
         }
+        @data[:sound]= parse_sound_file(content[:sound]) unless content[:sound].nil?
         self
       end
       def notify
         options = {data: @data}
         if Pntfr.test_env?
           Pntfr.add_delivery(@push_id, options)
+          VirtualSession::SuccessResponse.new
         else
-          @gcm.send_notification(@push_id, options)
+          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

@@ -11,5 +11,7 @@ module Pntfr
     end
   end
 end
-require File.dirname(__FILE__) + '/android'
-require File.dirname(__FILE__) + '/ios'
+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/base_response.rb

@@ -0,0 +1,31 @@
+module Pntfr
+  module VirtualSession
+    class BaseResponse
+      # communication with notification service was OK?
+      # implies no +failure?+
+      def success?
+        raise 'not implemented!'
+      end
+      # message has been sent?
+      def msg_sent?
+        raise 'not implemented!'
+      end
+      # communication with notification service failed?
+      # implies no +succcess?+
+      def failure?
+        raise 'not implemented!'
+      end
+      # Was there an error with the notification?
+      # implies +succcess?+ but no +msg_sent?+
+      def error?
+        raise 'not implemented!'
+      end
+      # which was the error?
+      def error
+      end
+      # which was the failure?
+      def failure
+      end
+    end
+  end
+end

data/lib/pntfr/virtual_session/gcm_response.rb

@@ -0,0 +1,44 @@
+#
+# Google Cloud Messaging json response wrapper.
+#
+require 'pntfr/virtual_session/base_response'
+require 'json'
+
+module Pntfr
+  module VirtualSession
+    class GcmResponse < BaseResponse
+      def initialize json
+        @status_code= json[:status_code]
+        @response= json[:response]
+        @body= json[:body]
+        if success?
+          @parsed_body= JSON.parse(@body)
+          @body_result= @parsed_body['results'].first
+        end
+      end
+      def success?
+        @status_code == 200
+      end
+      def bad_sender_account?
+        @status_code == 401
+      end
+      def failure?
+        @status_code == 400 or @status_code >= 500
+      end
+      def msg_sent?
+        success? && @parsed_body['success'] == 1
+      end
+      def error?
+        success? and !msg_sent? and @body_result.has_key?('error')
+      end
+      def error
+        if error?
+          @body_result['error']
+        end
+      end
+      def failure
+        "#{@body}->#{@response}"
+      end
+    end
+  end
+end

data/lib/pntfr/virtual_session/ios.rb

@@ -1,10 +1,12 @@
 #
 # VirtualSession implementation for iOS
 #
+require 'apns'
 module Pntfr
   module VirtualSession
     class Ios < Pntfr::VirtualSession::Base
       def msg content
+        configure_apns
         reset_msg
         @alert= content[:title]
         @alert+= "\n#{content[:description]}"
@@ -27,14 +29,22 @@ module Pntfr
         if Pntfr.test_env?
           Pntfr.add_delivery(@push_id, n)
         else
-          APNS.send_notification(@push_id, n)
+          ::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

data/lib/pntfr/virtual_session/success_response.rb

@@ -0,0 +1,31 @@
+#
+# Always success.
+# To be used on cases where no response to be parsed is received.
+#
+require 'pntfr/virtual_session/base_response'
+
+module Pntfr
+  module VirtualSession
+    class SuccessResponse < BaseResponse
+      # communication with notification service was OK?
+      # implies no +failure?+
+      def success?
+        true
+      end
+      # message has been sent?
+      def msg_sent?
+        true
+      end
+      # communication with notification service failed?
+      # implies no +succcess?+
+      def failure?
+        false
+      end
+      # Was there an error with the notification?
+      # implies +succcess?+ but no +msg_sent?+
+      def error?
+        false
+      end
+    end
+  end
+end

data/pntfr.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'apns', '~> 1.0', '>= 1.0.0'
   spec.add_runtime_dependency 'gcm', '~> 0.0', '>= 0.0.9'
+  spec.add_runtime_dependency 'json', '~> 1.8.1'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
 end

data/test/pntfr/push_notifier_test.rb

@@ -6,9 +6,6 @@ module Pntfr
       Pntfr.configure {}
     end
 
-    #
-    # COMMON
-    #
     def test_android_sessions_should_instantiate_android_virtual_sessions
       session= DeviceSession.new(Pntfr::Platforms::ANDROID)
       vsess= Pntfr::Notifier.to(session)
@@ -20,38 +17,5 @@ module Pntfr
       assert vsess.is_a?(Pntfr::VirtualSession::Ios)
     end
 
-    #
-    # ANDROID
-    #
-    def test_received_content_shoud_be_sent_to_gcm
-      push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
-      session= DeviceSession.new(Pntfr::Platforms::ANDROID, push_id)
-
-      Pntfr::Notifier.to(session).msg({:title => 'Some Title', :description => 'A description'}).notify
-
-      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]
-    end
-
-    #
-    # IOS
-    #
-    def test_received_content_shoud_be_ready_to_be_sent_to_apns
-      push_id= 'IOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSios'
-      session= DeviceSession.new(Pntfr::Platforms::IOS, push_id)
-
-      Pntfr::Notifier.to(session).msg({:title => 'thatitle', :description => 'thadescription', :sound => 'click.aiff', :badge => 33}).notify
-
-      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
-
   end
 end

data/test/pntfr/virtual_session/android_test.rb

@@ -0,0 +1,48 @@
+require 'pntfr/device_session'
+module Pntfr
+  module VirtualSession
+    class AndroidTest < Minitest::Test
+      def initialize method_name
+        super
+        Pntfr.configure {}
+      end
+
+      def test_received_content_shoud_be_sent_to_gcm
+        push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
+        session= DeviceSession.new(Pntfr::Platforms::ANDROID, push_id)
+
+        vsession= Pntfr::Notifier.to(session).msg({
+            :title => 'Some Title', :description => 'A description',
+            :sound => 'bell.caff'
+          })
+        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
+        push_id= 'ANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROIDANDROID'
+        session= DeviceSession.new(Pntfr::Platforms::ANDROID, push_id)
+
+        vsession= Pntfr::Notifier.to(session).msg({
+            :title => 'Some Title', :description => 'A description',
+            :sound => 'bell.caff'
+          })
+        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
+    end
+  end
+end

data/test/pntfr/virtual_session/ios_test.rb

@@ -0,0 +1,43 @@
+require 'pntfr/device_session'
+module Pntfr
+  module VirtualSession
+    class IosTest < Minitest::Test
+      def test_received_content_shoud_be_ready_to_be_sent_to_apns
+        push_id= 'IOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSiosIOSios'
+        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
+    end
+  end
+end

data/test/pntfr/virtual_session/response_test.rb

@@ -0,0 +1,49 @@
+module Pntfr
+  class ResponseTest < Minitest::Test
+    #
+    # Success response
+    #
+    def test_success_response_should_have_sent_msg_and_no_error
+      rs= VirtualSession::SuccessResponse.new
+      assert rs.success? and rs.msg_sent?
+      refute rs.error?
+      refute rs.failure?
+      assert_nil rs.error
+    end
+    #
+    # Android response
+    #
+    def test_gcm_200_responses_with_success_should_have_success_and_no_error
+      json= {:body=>"{\"multicast_id\":1020305051281243425,\"success\":1,\"failure\":0,\"canonical_ids\":0,\"results\":[{\"message_id\":\"0:1418221082312345%88882f99f9fd7ecd\"}]}", :headers=>{"content-type"=>["application/json; charset=UTF-8"], "date"=>["Wed, 10 Dec 2014 14:18:02 GMT"], "expires"=>["Wed, 10 Dec 2014 14:18:02 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=>200, :response=>"success", :canonical_ids=>[], :not_registered_ids=>[]}
+      rs= VirtualSession::GcmResponse.new(json)
+      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
+      json= {:body=>"{\"multicast_id\":6867269885611677069,\"success\":0,\"failure\":1,\"canonical_ids\":0,\"results\":[{\"error\":\"InvalidRegistration\"}]}", :headers=>{"content-type"=>["application/json; charset=UTF-8"], "date"=>["Tue, 09 Dec 2014 21:28:02 GMT"], "expires"=>["Tue, 09 Dec 2014 21:28:02 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=>200, :response=>"success", :canonical_ids=>[], :not_registered_ids=>[]}
+      rs= VirtualSession::GcmResponse.new(json)
+      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
+      json= {:body=>"{\"multicast_id\":5372261104801760966,\"success\":0,\"failure\":1,\"canonical_ids\":0,\"results\":[{\"error\":\"MismatchSenderId\"}]}", :headers=>{"content-type"=>["application/json; charset=UTF-8"], "date"=>["Tue, 09 Dec 2014 20:41:01 GMT"], "expires"=>["Tue, 09 Dec 2014 20:41:01 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=>200, :response=>"success", :canonical_ids=>[], :not_registered_ids=>[]}
+      rs= VirtualSession::GcmResponse.new(json)
+      assert rs.success?
+      refute rs.msg_sent?
+      assert rs.error?
+      refute rs.failure?
+      assert_equal 'MismatchSenderId', rs.error
+    end
+    def test_gcm_400_responses_should_have_failed_and_report_error
+      json= {: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."}
+      rs= VirtualSession::GcmResponse.new(json)
+      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."
+      assert_equal expected, rs.failure
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pntfr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apns
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,17 +111,18 @@ files:
 - 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
-- nbproject/private/private.properties
-- nbproject/private/rake-d.txt
-- nbproject/project.properties
-- nbproject/project.xml
+- lib/pntfr/virtual_session/success_response.rb
 - pntfr.gemspec
 - test/pntfr/device_session.rb
-- test/pntfr/ios_badge_test.rb
-- test/pntfr/ios_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/test_helper.rb
 homepage: http://www.coditramuntana.com
@@ -137,9 +152,11 @@ summary: Push notifier is a simple adapter for APNS and GCM gems, that way you c
   use same api to send push notifications to both devices.
 test_files:
 - test/pntfr/device_session.rb
-- test/pntfr/ios_badge_test.rb
-- test/pntfr/ios_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/test_helper.rb

data/nbproject/private/private.properties

@@ -1,2 +0,0 @@
-file.reference.pntfr-lib=/home/oliver/prog/coditramuntana/gems/pntfr/lib
-file.reference.pntfr-test=/home/oliver/prog/coditramuntana/gems/pntfr/test

data/nbproject/private/rake-d.txt

@@ -1,5 +0,0 @@
-build=Build pntfr-0.0.1.gem into the pkg directory.
-default=Run tests
-install=Build and install pntfr-0.0.1.gem into system gems.
-release=Create tag v0.0.1 and build and push pntfr-0.0.1.gem to Rubygems
-test=Run tests

data/nbproject/project.properties

@@ -1,7 +0,0 @@
-file.reference.pntfr-lib=lib
-file.reference.pntfr-test=test
-main.file=
-platform.active=Ruby_0
-source.encoding=UTF-8
-src.dir=${file.reference.pntfr-lib}
-test.src.dir=${file.reference.pntfr-test}

data/nbproject/project.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://www.netbeans.org/ns/project/1">
-    <type>org.netbeans.modules.ruby.rubyproject</type>
-    <configuration>
-        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
-            <name>Pntfr</name>
-            <source-roots>
-                <root id="src.dir"/>
-            </source-roots>
-            <test-roots>
-                <root id="test.src.dir"/>
-            </test-roots>
-        </data>
-    </configuration>
-</project>

data/test/pntfr/ios_test.rb

@@ -1,25 +0,0 @@
-module Pntfr
-  module VirtualSession
-    class IosTest < Minitest::Test
-      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)
-
-        vsession.msg(title: 't1', description: 'd1', sound: 's1').notify
-        vsession.msg(title: 't2', description: 'd2').notify
-
-        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
-    end
-  end
-end