ruby-push-notifications 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46af4db49981e818c075e9eb41dd4c2638851dd4
-  data.tar.gz: cfa87e1a6d3611d44abf9164cf8283b6f7117039
+  metadata.gz: 738a575f80f0cd2e1a1944232642c792f13e0bea
+  data.tar.gz: 8486e81fc3ab988335c233845ebee636b5d9ef89
 SHA512:
-  metadata.gz: 0237b54486f4c8186553fa31ed4d29bc1dc1ff20183371a759a3232b8c767a506ae3a22f561afb89f5e792ce5936fd7f35cc1ea2e6a2ac3f557fd9c16147f751
-  data.tar.gz: 591583bcb8d928476bd47272993739c5b597cf2d8002bb4ddc39f9557fb363fccd58ff9368c455b1a712dd0d8fcccca5c3f0bfdf3fdf4df09a9e686a1e1d38e0
+  metadata.gz: 43fbc9c2a9544ebd9f5cc7a8b8a6ccd9955177fafb6604ac08076830fb87c7bc98238601ea1579d10d438c77854f7f872903da8518276886b44634adc6a4f5a7
+  data.tar.gz: 24846b4b7d52519915de9bd02cd2d5bda4bf732fd109dc9a44b6cc32eb09dce256a548c3bee721eb4cedb115326c0080c16b0b42608664dbfd61e9b0c07f1761

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - "2.2.0"
   - "2.1.5"
   - "2.0.0"
-  - "1.9.3"
 env: CODECLIMATE_REPO_TOKEN=efdb12c380287a25b2b26362aa710a9b59020122cbe4edecf0d353bf50e0046a
 notifications:
   webhooks:

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# CHANGELOG™
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [unrealeased] - [unrealease date]
+
+## 1.0.0 - 2016-12-01
+- **Added**: Configurable timeouts for connecting external services.
+- **Removed**: Ruby 1.9.3 support.
+
+## 0.4.0 - 2016-02-23
+- **Added**: Option to provide a password for the PEM file for APNS connection
+
+## 0.3.0 - 2015-04-21
+- **Added**: Unified response interface through `Notifications Results Manager`
+
+## 0.2.0 - 2015-04-15
+- **Added**: Microsoft Push Notifications Service Support
+
+## 0.1.0 - 2015-03-31
+- First release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-push-notifications (0.4.0)
+    ruby-push-notifications (1.0.0)
       builder (~> 3.0)
 
 GEM
@@ -66,4 +66,4 @@ DEPENDENCIES
   webmock (~> 1.20)
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/README.md

@@ -61,3 +61,21 @@ Feel free to contribute!!
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Troubleshooting
+
+**If you see "255 Unknown Error" error code**
+
+This error code is assigned when the connection to push notification server wasn't successful
+<a href="https://github.com/calonso/ruby-push-notifications/blob/master/lib/ruby-push-notifications/apns/apns_pusher.rb#L56-L58">255 UNKnown Error code</a>
+
+Checking your connection configuration for example with APNS connection.
+When your pem file and token are development make sure you configure the pusher for sandbox mode
+``` RubyPushNotifications::APNS::APNSPusher.new('the certificate', true)) ```
+
+or when your pem file and token are production you should configure the pusher for production mode (Set the sandbox mode to false when creating your pusher)
+``` RubyPushNotifications::APNS::APNSPusher.new('the certificate', false)) ```
+
+## Changelog
+
+Refer to the [CHANGELOG.md](https://github.com/calonso/ruby-push-notifications/blob/master/CHANGELOG.md) file for detailed changes across versions.

data/examples/apns.rb

@@ -13,6 +13,9 @@ password = nil # optional password for .pem file
 notification = RubyPushNotifications::APNS::APNSNotification.new tokens, { aps: { alert: 'Hello APNS World!', sound: 'true', badge: 1 } }
 
 pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/path/to/your/apps/certificate.pem'), true, password) # enter the password if present
+# Connect timeout defaults to 30s
+# pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/path/to/your/apps/certificate.pem'), true, password, { connect_timeout: 20 })
+
 pusher.push [notification]
 p 'Notification sending results:'
 p "Success: #{notification.success}, Failed: #{notification.failed}"

data/examples/gcm.rb

@@ -12,6 +12,9 @@ registration_ids = [
 notification = RubyPushNotifications::GCM::GCMNotification.new registration_ids, { text: 'Hello GCM World!' }
 
 pusher = RubyPushNotifications::GCM::GCMPusher.new "Your app's GCM key"
+# Open and read timeouts default to 30s
+# pusher = RubyPushNotifications::GCM::GCMPusher.new "Your app's GCM key", { open_timeout: 10, read_timeout: 10 }
+
 pusher.push [notification]
 p 'Notification sending results:'
 p "Success: #{notification.success}, Failed: #{notification.failed}"

data/examples/mpns.rb

@@ -13,6 +13,8 @@ device_urls = [
 notification = RubyPushNotifications::MPNS::MPNSNotification.new device_urls, { title: 'Title', message: 'Hello MPNS World!', type: :toast }
 
 pusher = RubyPushNotifications::MPNS::MPNSPusher.new
+# Open and read timeouts default to 30s
+# pusher = RubyPushNotifications::MPNS::MPNSPusher.new optional_certificate, { open_timeout: 10, read_timeout: 10 }
 pusher.push [notification]
 p 'Notification sending results:'
 p "Success: #{notification.success}, Failed: #{notification.failed}"

data/lib/ruby-push-notifications/apns/apns_connection.rb

@@ -26,14 +26,17 @@ module RubyPushNotifications
       #
       # @param cert [String]. Contents of the PEM encoded certificate
       # @param sandbox [Boolean]. Whether to use the sandbox environment or not.
+      # @param pass [String] optional. Passphrase for the certificate.
+      # @param options [Hash] optional. Options for #open. Currently supports:
+      #   * connect_timeout [Integer]: how long the socket will wait for when opening the APNS socket. Defaults to 30.
       # @return [APNSConnection]. The recently stablished connection.
-      def self.open(cert, sandbox, pass = nil)
+      def self.open(cert, sandbox, pass = nil, options = {})
         ctx = OpenSSL::SSL::SSLContext.new
         ctx.key = OpenSSL::PKey::RSA.new cert, pass
         ctx.cert = OpenSSL::X509::Certificate.new cert
 
         h = host sandbox
-        socket = TCPSocket.new h, APNS_PORT
+        socket = Socket.tcp h, APNS_PORT, nil, nil, connect_timeout: options.fetch(:connect_timeout, 30)
         ssl = OpenSSL::SSL::SSLSocket.new socket, ctx
         ssl.connect
 

data/lib/ruby-push-notifications/apns/apns_pusher.rb

@@ -15,10 +15,13 @@ module RubyPushNotifications
 
       # @param certificate [String]. The PEM encoded APNS certificate.
       # @param sandbox [Boolean]. Whether the certificate is an APNS sandbox or not.
-      def initialize(certificate, sandbox, password = nil)
+      # @param options [Hash] optional. Options for APNSPusher. Currently supports:
+      #   * connect_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      def initialize(certificate, sandbox, password = nil, options = {})
         @certificate = certificate
         @pass = password
         @sandbox = sandbox
+        @options = options
       end
 
       # Pushes the notifications.
@@ -31,7 +34,7 @@ module RubyPushNotifications
       #
       # @param notifications [Array]. All the APNSNotifications to be sent.
       def push(notifications)
-        conn = APNSConnection.open @certificate, @sandbox, @pass
+        conn = APNSConnection.open @certificate, @sandbox, @pass, @options
 
         binaries = notifications.each_with_object([]) do |notif, binaries|
           notif.each_message(binaries.count) do |msg|
@@ -61,7 +64,7 @@ module RubyPushNotifications
               results.slice! err[2]..-1
               results << err[1]
               i = err[2]
-              conn = APNSConnection.open @certificate, @sandbox, @pass
+              conn = APNSConnection.open @certificate, @sandbox, @pass, @options
             end
           else
             results << NO_ERROR_STATUS_CODE

data/lib/ruby-push-notifications/gcm/gcm_connection.rb

@@ -27,8 +27,11 @@ module RubyPushNotifications
       # @param notification [String]. The text to POST
       # @param key [String]. The GCM sender id to use
       #    (https://developer.android.com/google/gcm/gcm.html#senderid)
+      # @param options [Hash] optional. Options for #post. Currently supports:
+      #   * open_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      #   * read_timeout [Integer]: Number of seconds to wait for one block to be read. Defaults to 30.
       # @return [GCMResponse]. The GCMResponse that encapsulates the received response
-      def self.post(notification, key)
+      def self.post(notification, key, options = {})
         headers = {
             CONTENT_TYPE_HEADER => JSON_CONTENT_TYPE,
             AUTHORIZATION_HEADER => "key=#{key}"
@@ -38,6 +41,8 @@ module RubyPushNotifications
         http = Net::HTTP.new url.host, url.port
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.open_timeout = options.fetch(:open_timeout, 30)
+        http.read_timeout = options.fetch(:read_timeout, 30)
 
         response = http.post url.path, notification, headers
 

data/lib/ruby-push-notifications/gcm/gcm_pusher.rb

@@ -11,8 +11,12 @@ module RubyPushNotifications
       #
       # @param key [String]. GCM sender id to use
       #   ((https://developer.android.com/google/gcm/gcm.html#senderid))
-      def initialize(key)
+      # @param options [Hash] optional. Options for GCMPusher. Currently supports:
+      #   * open_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      #   * read_timeout [Integer]: Number of seconds to wait for one block to be read. Defaults to 30.
+      def initialize(key, options = {})
         @key = key
+        @options = options
       end
 
       # Actually pushes the given notifications.
@@ -22,7 +26,7 @@ module RubyPushNotifications
       # @param notifications [Array]. Array of GCMNotification to send.
       def push(notifications)
         notifications.each do |notif|
-          notif.results = GCMConnection.post notif.as_gcm_json, @key
+          notif.results = GCMConnection.post notif.as_gcm_json, @key, @options
         end
       end
     end

data/lib/ruby-push-notifications/mpns/mpns_connection.rb

@@ -33,15 +33,20 @@ module RubyPushNotifications
       # submit the given notifications.
       #
       # @param n [MPNSNotification]. The notification object to POST
-      # @param optional cert [String]. Contents of the PEM encoded certificate
+      # @param cert [String] optional. Contents of the PEM encoded certificate.
+      # @param options [Hash] optional. Options for GCMPusher. Currently supports:
+      #   * open_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      #   * read_timeout [Integer]: Number of seconds to wait for one block to be read. Defaults to 30.
       # @return [Array]. The response of post
       # (http://msdn.microsoft.com/pt-br/library/windows/apps/ff941099)
-      def self.post(n, cert = nil)
+      def self.post(n, cert = nil, options = {})
         headers = build_headers(n.data[:type], n.data[:delay])
         body = n.as_mpns_xml
         responses = []
         n.each_device do |url|
           http = Net::HTTP.new url.host, url.port
+          http.open_timeout = options.fetch(:open_timeout, 30)
+          http.read_timeout = options.fetch(:read_timeout, 30)
           if cert && url.scheme == 'https'
             http.use_ssl = true
             http.verify_mode = OpenSSL::SSL::VERIFY_PEER

data/lib/ruby-push-notifications/mpns/mpns_pusher.rb

@@ -9,9 +9,13 @@ module RubyPushNotifications
       # Initializes the MPNSPusher
       #
       # @param certificate [String]. The PEM encoded MPNS certificate.
+      # @param options [Hash] optional. Options for GCMPusher. Currently supports:
+      #   * open_timeout [Integer]: Number of seconds to wait for the connection to open. Defaults to 30.
+      #   * read_timeout [Integer]: Number of seconds to wait for one block to be read. Defaults to 30.
       # (http://msdn.microsoft.com/pt-br/library/windows/apps/ff941099)
-      def initialize(certificate = nil)
+      def initialize(certificate = nil, options = {})
         @certificate = certificate
+        @options = options
       end
 
       # Actually pushes the given notifications.
@@ -21,7 +25,7 @@ module RubyPushNotifications
       # @param notifications [Array]. Array of MPNSNotification to send.
       def push(notifications)
         notifications.each do |notif|
-          notif.results = MPNSConnection.post notif, @certificate
+          notif.results = MPNSConnection.post notif, @certificate, @options
         end
       end
     end

data/lib/ruby-push-notifications/version.rb

@@ -1,3 +1,3 @@
 module RubyPushNotifications
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 end

data/ruby-push-notifications.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/calonso/ruby-push-notifications'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/ruby-push-notifications/apns/apns_connection_spec.rb

@@ -4,17 +4,17 @@ module RubyPushNotifications
     describe APNSConnection do
 
       let(:cert) { File.read 'spec/support/dummy.pem' }
-      let(:tcp_socket) { instance_double(TCPSocket).as_null_object }
+      let(:tcp_socket) { instance_double(Socket).as_null_object }
       let(:ssl_socket) { instance_double(OpenSSL::SSL::SSLSocket).as_null_object }
 
       describe '::open' do
         before do
-          allow(TCPSocket).to receive(:new).with('gateway.sandbox.push.apple.com', 2195).and_return tcp_socket
+          allow(Socket).to receive(:tcp).with('gateway.sandbox.push.apple.com', 2195, nil, nil, { connect_timeout: 30 }).and_return tcp_socket
           allow(OpenSSL::SSL::SSLSocket).to receive(:new).with(tcp_socket, an_instance_of(OpenSSL::SSL::SSLContext)).and_return ssl_socket
         end
 
         it 'creates the connection' do
-          expect(TCPSocket).to receive(:new).with('gateway.sandbox.push.apple.com', 2195).and_return tcp_socket
+          expect(Socket).to receive(:tcp).with('gateway.sandbox.push.apple.com', 2195, nil, nil, { connect_timeout: 30 }).and_return tcp_socket
           expect(OpenSSL::SSL::SSLSocket).to receive(:new).with(tcp_socket, an_instance_of(OpenSSL::SSL::SSLContext)).and_return ssl_socket
           APNSConnection.open cert, true
         end

data/spec/ruby-push-notifications/apns/apns_pusher_spec.rb

@@ -9,7 +9,7 @@ module RubyPushNotifications
       let(:data) { { a: 1 } }
 
       before do
-        allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil).and_return connection
+        allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil, {}).and_return connection
       end
 
       describe '#push' do
@@ -93,7 +93,7 @@ module RubyPushNotifications
               let(:connection2) { instance_double(APNSConnection).as_null_object }
 
               before do
-                allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil).and_return connection, connection2
+                allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil, {}).and_return connection, connection2
               end
 
               context 'failing first' do
@@ -197,10 +197,10 @@ module RubyPushNotifications
                 allow(connection).to receive(:read).with(6).and_return [8, PROCESSING_ERROR_STATUS_CODE, 0].pack('ccN')
                 allow(connection2).to receive(:read).with(6).and_return [8, MISSING_DEVICE_TOKEN_STATUS_CODE, 2].pack('ccN')
                 allow(connection3).to receive(:read).with(6).and_return [8, INVALID_TOPIC_SIZE_STATUS_CODE, 9].pack('ccN')
-                allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil).and_return connection, connection2, connection3, connection4
+                allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil, {}).and_return connection, connection2, connection3, connection4
               end
 
-              it 'repones the connection' do
+              it 'reopens the connection' do
                 (0..2).each do |i|
                   expect(connection).to receive(:write).with(apns_binary(data, tokens[i], i)).once
                 end
@@ -249,7 +249,7 @@ module RubyPushNotifications
                 allow(connection).to receive(:read).with(6).and_return [8, PROCESSING_ERROR_STATUS_CODE, 0].pack('ccN')
                 allow(connection2).to receive(:read).with(6).and_return [8, MISSING_DEVICE_TOKEN_STATUS_CODE, 2].pack('ccN')
                 allow(connection3).to receive(:read).with(6).and_return [8, INVALID_TOPIC_SIZE_STATUS_CODE, 9].pack('ccN')
-                allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil).and_return connection, connection2, connection3, connection4
+                allow(APNSConnection).to receive(:open).with(certificate, sandbox, nil, {}).and_return connection, connection2, connection3, connection4
               end
 
               it 'repones the connection' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-push-notifications
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Carlos Alonso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -106,6 +106,7 @@ files:
 - ".rspec"
 - ".ruby-style.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -165,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -195,4 +196,3 @@ test_files:
 - spec/support/dummy.pem
 - spec/support/factory_girl.rb
 - spec/support/results_shared_examples.rb
-has_rdoc: