fcm-ruby-push-notifications 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5043c1d56180cceaae2e9e0c47270dcdb18dc889
+  data.tar.gz: 8e83ac1db715886036aab694901fe3e0ed220249
+SHA512:
+  metadata.gz: 51cdd15cb84d289715c4794333c11b0217ee2fe59b94b3f47e6c6ebba85ba55aa06e0351c840ef70078b099af1a53e407d3edb5f68646e1282eb48630ec0b02c
+  data.tar.gz: 24fb35a54e114c538f36449047956cbb7e2aca35c516d1558e66b33a5de8595a5663943757c9cf76f11674e75d434737a7bcabd8d8b532706c5951e43b8fe700

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store
+
+examples/*.bak

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+matrix:
+  include:
+  - rvm: "2.1.10"
+    gemfile: gemfiles/Gemfile-legacy
+  - rvm: "2.0.0"
+    gemfile: gemfiles/Gemfile-legacy
+env: CODECLIMATE_REPO_TOKEN=efdb12c380287a25b2b26362aa710a9b59020122cbe4edecf0d353bf50e0046a
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/b740ebfeb7e0dba10293
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# 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.2.0 - 2017-09-20
+- **Added**: Add support Windows Push Notification Services (WNS)
+
+## 1.1.0 - 2017-03-14
+- **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.
+- **Removed**: Version file
+
+## 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

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-push-notifications.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Carlos Alonso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,82 @@
+# Ruby Push Notifications
+
+[![Build Status](https://travis-ci.org/calonso/ruby-push-notifications.svg)](https://travis-ci.org/calonso/ruby-push-notifications) [![Dependency Status](https://gemnasium.com/calonso/ruby-push-notifications.svg)](https://gemnasium.com/calonso/ruby-push-notifications) [![Code Climate](https://codeclimate.com/github/calonso/ruby-push-notifications/badges/gpa.svg)](https://codeclimate.com/github/calonso/ruby-push-notifications) [![Test Coverage](https://codeclimate.com/github/calonso/ruby-push-notifications/badges/coverage.svg)](https://codeclimate.com/github/calonso/ruby-push-notifications) [![Gem Version](https://badge.fury.io/rb/ruby-push-notifications.svg)](http://badge.fury.io/rb/ruby-push-notifications) [![Join the chat at https://gitter.im/calonso/ruby-push-notifications](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/calonso/ruby-push-notifications?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+### iOS, Android and Windows Phone Push Notifications made easy!
+
+## Features
+
+* iOS and Android support
+* Complete error and retry management
+* Easy and intuitive API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-push-notifications'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-push-notifications
+
+## Usage
+
+**Ruby Push Notifications** gem usage is really easy.
+
+1. After installing, require the gem
+2. Create one or more notifications
+3. Create the corresponding `pusher`
+4. Push!!
+5. Get feedback
+
+For completely detailed examples:
+
+1. [Apple iOS example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/apns.rb)
+2. [Google Android example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/gcm.rb)
+3. [Windows Phone(MPNS) example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/mpns.rb)
+4. [Windows Phone(WNS) example](https://github.com/calonso/ruby-push-notifications/tree/master/examples/wns.rb)
+
+## Pending tasks
+
+Feel free to contribute!!
+
+* Validate iOS notifications format and max size
+* Validate iOS tokens format
+* Validate GCM registration ids format
+* Validate GCM notifications format and max size
+* Split GCM notifications in parts if more than 1000 destinations are given (currently raising exception)
+* Integrate with APNS Feedback service
+* Validate MPNS notifications format
+* Validate MPNS data
+* Add other platforms (Amazon Fire...)
+
+## Contributing
+
+1. Fork it ( https://github.com/calonso/ruby-push-notifications/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end
+

data/examples/apns.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env bundle exec ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+tokens = [
+  'First token here',
+  'Second token here'
+]
+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 })
+
+# 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}"
+p 'Details:'
+p notification.individual_results

data/examples/gcm.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env bundle exec ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+registration_ids = [
+  'First registration id here',
+  'Second registration id here'
+]
+
+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 }
+
+# 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}"
+p 'Details:'
+p notification.individual_results

data/examples/mpns.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env bundle exec ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+device_urls = [
+  'First device url here',
+  'Second device url here'
+]
+
+# Notification with toast type
+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}"
+p 'Details:'
+p notification.individual_results

data/examples/wns.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+sid = "ms-app://...."
+secret = "..."
+
+wns_access = RubyPushNotifications::WNS::WNSAccess.new(sid, secret).get_token
+access_token = wns_access.response.access_token
+
+device_urls = ["https://hk2.notify.windows.com/?token=AwYAAACEIPGNfZtVWJMvU%2fJ67TTdLQNdFl2345SbaCP7dmkvUmy6Cv9Y7hM4UT5uA%2b3obnZlIIhQcse9Hs6RPW0MPFVjf3MugnfD8qjIHMtRKIsKENIFveN1xQ6S38m90%2fgaBsE%3d"]
+
+notification = RubyPushNotifications::WNS::WNSNotification.new(device_urls, { type: :toast, title: 'This is a special title', message: 'this is a special message'})
+# notification = RubyPushNotifications::WNS::WNSNotification.new(device_urls, { type: :tile, image: 'https://res-5.cloudinary.com/prepathon/image/fetch/w_21,h_21,c_fill,g_face/http://assets-cdn.github.com/images/icons/emoji/unicode/1f604.png?v6', message: 'this is a special message'})
+# notification = RubyPushNotifications::WNS::WNSNotification.new(device_urls, { type: :badge, value: 'activity'})
+
+pusher = RubyPushNotifications::WNS::WNSPusher.new(access_token)
+
+pusher.push([notification])
+p 'Notification sending results:'
+p "Success: #{notification.success}, Failed: #{notification.failed}"
+p 'Details:'
+p notification.individual_results

data/gemfiles/Gemfile-legacy

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem "activesupport", "~> 4.2", group: :test
+
+# Specify your gem's dependencies in ruby-push-notifications.gemspec
+gemspec path: ".."
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/lib/ruby-push-notifications.rb

@@ -0,0 +1,7 @@
+require 'forwardable'
+require 'ruby-push-notifications/notification_results_manager'
+require 'ruby-push-notifications/apns'
+require 'ruby-push-notifications/gcm'
+require 'ruby-push-notifications/fcm'
+require 'ruby-push-notifications/mpns'
+require 'ruby-push-notifications/wns'

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

@@ -0,0 +1,44 @@
+#
+# @author Carlos Alonso
+#
+module RubyPushNotifications::APNS
+
+  # No Status Error Code. Represents a successfully sent notification
+  NO_ERROR_STATUS_CODE = 0
+
+  # An error occurred while processing the notification
+  PROCESSING_ERROR_STATUS_CODE = 1
+
+  # The notification contains no device token
+  MISSING_DEVICE_TOKEN_STATUS_CODE = 2
+
+  # The notification is being sent through the plain TCPSocket,
+  # rather than the SSL one
+  MISSING_TOPIC_STATUS_CODE = 3
+
+  # The notification contains no payload
+  MISSING_PAYLOAD_STATUS_CODE = 4
+
+  # The given token sice is invalid (!= 32)
+  INVALID_TOKEN_SIZE_STATUS_CODE = 5
+
+  # The given topic size is invalid
+  INVALID_TOPIC_SIZE_STATUS_CODE = 6
+
+  # Payload size is invalid (256 bytes if iOS < 8, 2Kb otherwise)
+  INVALID_PAYLOAD_SIZE_STATUS_CODE = 7
+
+  # The token is for dev and the env is prod or viceversa, or simply wrong
+  INVALID_TOKEN_STATUS_CODE = 8
+
+  # Connection closed at Apple's end
+  SHUTDOWN_STATUS_CODE = 10
+
+  # Unknown error
+  UNKNOWN_ERROR_STATUS_CODE = 255
+end
+
+require 'ruby-push-notifications/apns/apns_connection'
+require 'ruby-push-notifications/apns/apns_notification'
+require 'ruby-push-notifications/apns/apns_pusher'
+require 'ruby-push-notifications/apns/apns_results'

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

@@ -0,0 +1,70 @@
+require 'socket'
+require 'openssl'
+
+module RubyPushNotifications
+  module APNS
+    # This class encapsulates a connection with APNS.
+    #
+    # @author Carlos Alonso
+    class APNSConnection
+      extend Forwardable
+
+      # @private URL of the APNS Sandbox environment
+      APNS_SANDBOX_URL = 'gateway.sandbox.push.apple.com'
+
+      # @private URL of APNS production environment
+      APNS_PRODUCTION_URL = 'gateway.push.apple.com'
+
+      # @private Port to connect to
+      APNS_PORT = 2195
+
+      def_delegators :@sslsock, :write, :flush, :to_io, :read
+
+      # Opens a connection with APNS
+      #
+      # @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:
+      #   * 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 = {})
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.key = OpenSSL::PKey::RSA.new cert, pass
+        ctx.cert = OpenSSL::X509::Certificate.new cert
+
+        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
+
+        new socket, ssl
+      end
+
+      # Returns the URL to connect to.
+      #
+      # @param sandbox [Boolean]. Whether it is the sandbox or the production
+      #  environment we're looking for.
+      # @return [String]. The URL for the APNS service.
+      def self.host(sandbox)
+        sandbox ? APNS_SANDBOX_URL : APNS_PRODUCTION_URL
+      end
+
+      # Initializes the APNSConnection
+      #
+      # @param tcpsock [TCPSocket]. The used TCP Socket.
+      # @param sslsock [SSLSocket]. The connected SSL Socket.
+      def initialize(tcpsock, sslsock)
+        @tcpsock = tcpsock
+        @sslsock = sslsock
+      end
+
+      # Closes the APNSConnection
+      def close
+        @sslsock.close
+        @tcpsock.close
+      end
+    end
+  end
+end