ruby-push-notifications 0.0.1

data/.gitignore

@@ -0,0 +1,35 @@
+*.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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.2.0"
+  - "2.1.5"
+  - "2.0.0"
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-push-notifications.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    ruby-push-notifications (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.7)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  factory_girl (~> 4.0)
+  rake (~> 10.4)
+  rspec (~> 3.2)
+  ruby-push-notifications!
+  webmock (~> 1.20)

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,56 @@
+# 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)
+
+###iOS and Android 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)
+
+## 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)
+
+## 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

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 copy.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+tokens = [
+  '6400b2a275eacf035d22d285d0ffb58fde5b647e54c7da882703136ba4ecd7d6',
+  '16400b2a275eacf035d22d285d0ffb58fde5b647e54c7da882703136ba4ecd7d6',
+  '6400b2a275eacf035d22d285d0ffb58fde5b647e54c7da882703136ba4ecd7d6'
+]
+
+notification = RubyPushNotifications::APNS::APNSNotification.new tokens, { aps: { alert: 'Hello APNS World!', sound: 'true', badge: 1 } }
+
+pusher = RubyPushNotifications::APNS::APNSPusher.new(File.read('/Users/calonso/Desktop/apns.pem'), true)
+pusher.push [notification]
+p notification.results

data/examples/apns.rb

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

data/examples/gcm copy.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ruby-push-notifications'
+
+registration_ids = [
+  'APA91bFrtpS1bEo4BtTjE3V-GvRTX6KATZmh3ZGZ-wrQVY5UvsuQ4F-UmShwwjiG4uY0qtXG0RS4Tq2ir6t7gN6ziU7fpb1HtuiUKpdkY6WpE38mCxTa7cNeotIGgaKXOdNTEV10GU6Txp-Oxakqavuga6SrYNoVyA',
+  'APA91bFwufZkwhPhhLlQyIbM3MUksfxSvXXmXRP9L8LrJ8RMvUbRExERKHAzDR_pXZryKYICuqdS18fiytmks0WmKTZFd9_5AR8nK_m-5djqzM7AfBOyyv7Hy1uWCunJ2FcAbapGfaFYOTaW3MQGxjUIav_8Wj1R0OYANVMvZNGSDcu_j5wA80Y'
+]
+
+notification = RubyPushNotifications::GCM::GCMNotification.new registration_ids, { text: 'Hello GCM World!' }
+
+pusher = RubyPushNotifications::GCM::GCMPusher.new 'AIzaSyAEO2CE_ipX217WwWsbHvGr8fiVHDdKUIc'
+pusher.push [notification]
+p notification.results

data/examples/gcm.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env 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"
+pusher.push [notification]
+p notification.results

data/lib/ruby-push-notifications.rb

@@ -0,0 +1,8 @@
+require "ruby-push-notifications/version"
+
+module RubyPushNotifications
+  # Your code goes here...
+end
+
+require 'ruby-push-notifications/apns'
+require 'ruby-push-notifications/gcm'

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

@@ -0,0 +1,19 @@
+
+module RubyPushNotifications::APNS
+  NO_ERROR_STATUS_CODE = 0
+  PROCESSING_ERROR_STATUS_CODE = 1
+  MISSING_DEVICE_TOKEN_STATUS_CODE = 2
+  MISSING_TOPIC_STATUS_CODE = 3 # You're writing to the TCPSocket rather than the SSL one
+  MISSING_PAYLOAD_STATUS_CODE = 4
+  INVALID_TOKEN_SIZE_STATUS_CODE = 5
+  INVALID_TOPIC_SIZE_STATUS_CODE = 6
+  INVALID_PAYLOAD_SIZE_STATUS_CODE = 7
+  INVALID_TOKEN_STATUS_CODE = 8 # The token is for dev and the env is prod or viceversa, or simply wrong
+  SHUTDOWN_STATUS_CODE = 10
+  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'
+

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

@@ -0,0 +1,45 @@
+
+require 'socket'
+require 'openssl'
+require 'forwardable'
+
+module RubyPushNotifications
+  module APNS
+    class APNSConnection
+      extend Forwardable
+
+      APNS_SANDBOX_URL = 'gateway.sandbox.push.apple.com'
+      APNS_PRODUCTION_URL = 'gateway.push.apple.com'
+      APNS_PORT = 2195
+
+      def_delegators :@sslsock, :write, :flush, :to_io, :read
+
+      def self.open(cert, sandbox)
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.key = OpenSSL::PKey::RSA.new cert
+        ctx.cert = OpenSSL::X509::Certificate.new cert
+
+        h = host sandbox
+        socket = TCPSocket.new h, APNS_PORT
+        ssl = OpenSSL::SSL::SSLSocket.new socket, ctx
+        ssl.connect
+
+        new socket, ssl
+      end
+
+      def self.host(sandbox)
+        sandbox ? APNS_SANDBOX_URL : APNS_PRODUCTION_URL
+      end
+
+      def initialize(tcpsock, sslsock)
+        @tcpsock = tcpsock
+        @sslsock = sslsock
+      end
+
+      def close
+        @sslsock.close
+        @tcpsock.close
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+
+require 'json'
+
+module RubyPushNotifications
+  module APNS
+    class APNSNotification
+
+      WEEKS_4 = 2419200 # 4 weeks
+
+      attr_accessor :results
+
+      def initialize(tokens, data)
+        @tokens = tokens
+        @data = data
+      end
+
+      def each_message(starting_id)
+        @tokens.each_with_index do |token, i|
+          # Notification = 2(1), FrameLength(4), items(FrameLength)
+          # Item = ItemID(1), ItemLength(2), data(ItemLength)
+          # Items:
+          # Device Token => Id: 1, length: 32, data: binary device token
+          # Payload => Id: 2, length: ??, data: json formatted payload
+          # Notification ID => Id: 3, length: 4, data: notif id as int
+          # Expiration Date => Id: 4, length: 4, data: Unix timestamp as int
+          # Priority => Id: 5, length: 1, data: 10 as 1 byte int
+          bytes = device_token(token) + payload + notification_id(starting_id + i) + expiration_date + priority
+          yield [2, bytes.bytesize, bytes].pack 'cNa*'
+        end
+      end
+
+      def count
+        @tokens.count
+      end
+
+      private
+
+      def device_token(token)
+        [1, 32, token].pack 'cnH64'
+      end
+
+      def payload
+        @encoded_payload ||= -> {
+            json = JSON.dump(@data).force_encoding 'ascii-8bit'
+            [2, json.bytesize, json].pack 'cna*'
+          }.call
+      end
+
+      def notification_id(id)
+        [3, 4, id].pack 'cnN'
+      end
+
+      def expiration_date
+        [4, 4, (Time.now + WEEKS_4).to_i].pack 'cnN'
+      end
+
+      def priority
+        [5, 1, 10].pack 'cnc'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+
+module RubyPushNotifications
+  module APNS
+    class APNSPusher
+
+      def initialize(certificate, sandbox)
+        @certificate = certificate
+        @sandbox = sandbox
+      end
+
+      def push(notifications)
+        conn = APNSConnection.open @certificate, @sandbox
+
+        binaries = notifications.each_with_object([]) do |notif, binaries|
+          notif.each_message(binaries.count) do |msg|
+            binaries << msg
+          end
+        end
+
+        results = []
+        i = 0
+        while i < binaries.count
+          conn.write binaries[i]
+
+          if i == binaries.count-1
+            conn.flush
+            rs, = IO.select([conn], nil, nil, 2)
+          else
+            rs, = IO.select([conn], [conn])
+          end
+          if rs && rs.any?
+            err = rs[0].read(6).unpack 'ccN'
+            results.slice! err[2]..-1
+            results << err[1]
+            i = err[2]
+            conn = APNSConnection.open @certificate, @sandbox
+          else
+            results << NO_ERROR_STATUS_CODE
+          end
+          i += 1
+        end
+
+        conn.close
+
+        notifications.each do |notif|
+          notif.results = results.slice! 0, notif.count
+        end
+      end
+    end
+  end
+end