ruby-push-notifications 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a56beebcc92083bc2f71294a56bc9ee3bc76eaa
-  data.tar.gz: 0d26991e228d5e85b6e326aeeaab62b3f718b32d
+  metadata.gz: 233dc6f0f402cb52394547c792773699f75c920a
+  data.tar.gz: 375783019646d00e93261ef0b032fa59547a4ab6
 SHA512:
-  metadata.gz: 97d469ba85e823407ee4d196b480ebb1a33437fdeaca7bac666d8006555e93c4440f493312bc6f0fbcf3133fcdc0f39e8b64ea94d8f7b4a5a2bf0a4f5b3ea592
-  data.tar.gz: 071ee1997208978781c887538c5699cce6546d59acb52bdd8981ecfc33aa09c456ac595512cfa554d59abdce3619396a03472923d851503b5e2a5fc4ecc69e96
+  metadata.gz: f5bbf5568795d0026087b4e84a6856cf1de77738c1cac3daae2f136f9e16f221734b1becf2304d5ea24104cece5820926407b152a5b1a02290595dd4c4b163fe
+  data.tar.gz: 2f5a20d5a059bbf43c9116d3eb8af2cd4d5b5f00435cc6c674de1bf215746f7926742f6a92b30ac8863ed1a8769c0597e13e882de464cb1947d66f526ab410a0

data/CHANGELOG.md

@@ -3,6 +3,8 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unrealeased] - [unrealease date]
+- **Added**: Option (`url`) to set custom GCM endpoint (Android)
+- **Added**: Option (`host`) to set custom APNS environment (iOS)
 
 ## 1.0.1 - 2017-01-12
 - **Fixed**: Loading issue when `'forwardable'` wasn't previously required.

data/examples/apns.rb

@@ -16,6 +16,10 @@ pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/path/to/your/ap
 # Connect timeout defaults to 30s
 # pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/path/to/your/apps/certificate.pem'), true, password, { connect_timeout: 20 })
 
+# Manually set APNS environment (e.g. useful for load testing)
+# When option `host` is given it always uses this environment, `sandbox` param is ignored.
+# pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/path/to/your/apps/certificate.pem'), true, password, { host: "gateway.push.example.com" })
+
 pusher.push [notification]
 p 'Notification sending results:'
 p "Success: #{notification.success}, Failed: #{notification.failed}"

data/examples/gcm.rb

@@ -15,6 +15,9 @@ 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 }
 
+# Manually set GCM URL (e.g. useful for load testing)
+# pusher = RubyPushNotifications::GCM::GCMPusher.new "Your app's GCM key", { url: "https://example.com/gcm/send" }
+
 pusher.push [notification]
 p 'Notification sending results:'
 p "Success: #{notification.success}, Failed: #{notification.failed}"

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

@@ -26,6 +26,7 @@ module RubyPushNotifications
       # @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:
+      #   * host [String]: Hostname of the APNS environment. Defaults to the official APNS hostname.
       #   * 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, options = {})
@@ -33,7 +34,7 @@ module RubyPushNotifications
         ctx.key = OpenSSL::PKey::RSA.new cert, pass
         ctx.cert = OpenSSL::X509::Certificate.new cert
 
-        h = host sandbox
+        h = options.fetch(:host, host(sandbox))
         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

@@ -16,6 +16,7 @@ module RubyPushNotifications
       # @param certificate [String]. The PEM encoded APNS certificate.
       # @param sandbox [Boolean]. Whether the certificate is an APNS sandbox or not.
       # @param options [Hash] optional. Options for APNSPusher. Currently supports:
+      #   * host [String]: Hostname of the APNS environment. Defaults to the official APNS hostname.
       #   * 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

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

@@ -28,6 +28,7 @@ module RubyPushNotifications
       # @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:
+      #   * url [String]: URL of the GCM endpoint. Defaults to the official GCM URL.
       #   * 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
@@ -37,9 +38,9 @@ module RubyPushNotifications
             AUTHORIZATION_HEADER => "key=#{key}"
         }
 
-        url = URI.parse GCM_URL
+        url = URI.parse options.fetch(:url, GCM_URL)
         http = Net::HTTP.new url.host, url.port
-        http.use_ssl = true
+        http.use_ssl = url.scheme == 'https'
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         http.open_timeout = options.fetch(:open_timeout, 30)
         http.read_timeout = options.fetch(:read_timeout, 30)

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

@@ -12,6 +12,7 @@ module RubyPushNotifications
       # @param key [String]. GCM sender id to use
       #   ((https://developer.android.com/google/gcm/gcm.html#senderid))
       # @param options [Hash] optional. Options for GCMPusher. Currently supports:
+      #   * url [String]: URL of the GCM endpoint. Defaults to the official GCM URL.
       #   * 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 = {})

data/ruby-push-notifications.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "ruby-push-notifications"
-  spec.version       = "1.0.1"
+  spec.version       = "1.1.0"
   spec.authors       = ['Carlos Alonso']
   spec.email         = ['info@mrcalonso.com']
   spec.summary       = %q{iOS, Android and Windows Phone Push Notifications made easy!}

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

@@ -28,6 +28,13 @@ module RubyPushNotifications
           expect(OpenSSL::PKey::RSA).to receive(:new).with(cert, 'password')
           expect(APNSConnection.open(cert, true, 'password')).to be_a APNSConnection
         end
+
+        context 'when :host option is present' do
+          it 'opens a connection with a custom APNS' do
+            expect(Socket).to receive(:tcp).with('gateway.push.example.com', 2195, nil, nil, { connect_timeout: 30 }).and_return tcp_socket
+            APNSConnection.open cert, true, 'password', { host: "gateway.push.example.com" }
+          end
+        end
       end
 
       describe '#close' do

data/spec/ruby-push-notifications/gcm/gcm_connection_spec.rb

@@ -23,6 +23,20 @@ module RubyPushNotifications
                 once
         end
 
+        context 'when :url option is present' do
+          it 'posts data to a custom GCM endpoint' do
+            stub_request(:post, 'https://example.com/gcm/send').
+              to_return status: [200, 'OK'], body: response
+
+            GCMConnection.post body, key, url: 'https://example.com/gcm/send'
+
+            expect(WebMock).
+              to have_requested(:post, 'https://example.com/gcm/send').
+                with(body: body, headers: { 'Content-Type' => 'application/json', 'Authorization' => "key=#{key}" }).
+                  once
+          end
+        end
+
         it 'returns the response encapsulated in a GCMResponse object' do
           expect(GCMConnection.post body, key).to eq GCMResponse.new(200, response)
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-push-notifications
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Carlos Alonso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder