suj-pusher 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 R&D SkillupJapan Corp.
+
+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,148 @@
+# Suj Pusher Server
+
+This is a simple but enterprise level pusher server that can push notifications to iOS and Android devices using the APN and GCM push services respectively.
+
+## Features
+
+- Support both APN and GCM push services with a simple unified API interface.
+- Keep persistent connections to APN following Apple recommendation.
+- Use redis pub/sub mechanism for real time push notifications. No polling.
+- No need to set APN certificates or GCM api keys in configuration files or pusher startup. These are sent in a per request basis. This allows support for multiple APN certs and GCM api keys in a single Pusher instance.
+- EventMachine based to handle in the order of thousands of push requests per second.
+
+## Installation
+
+Via gems simply install the suj-pusher gem on your system:
+
+```sh
+gem install suj-pusher
+```
+
+or download the source via git:
+
+```
+git clone https://github.com/sujrd/suj-pusher.git
+```
+
+after cloning the gem make sure to run bundle install to install the dependencies:
+
+```
+cd suj-pusher
+bundle install
+```
+
+## Usage
+
+To run the server simply run the pusher daemon:
+
+```
+pusher start|stop|restart|status  <options>
+```
+
+options:
+  - -r <REDIS>: The redis server used to receive push notification messages. The default is localhost:6379.
+
+Note that the daemon will run on your current folder and under the current user. Make sure you cd to a folder (e.g. /var/run/pusher) and that your current user has permissions to create folders/files inside that directory:
+
+```
+mkdir /var/run/pusher
+chown pusher_user:pusher_group /var/run/pusher
+cd /var/run/pusher
+/usr/bin/pusher start -r redis://192.168.x.x:6379/namespace
+```
+
+The pusher daemon creates a logs, tmp and certs directory in the current path. To check the state of the daemon you may check the logs. We store the APN certs inside the certs directory temporarily during the connection to APN and delete them when the connection is closed. Still make sure this folder is only readable/writeable by the user under which the pusher process is running.
+
+## Sending Notifications
+
+Once the pusher daemon is running and connected to your redis server you can push notifications by publishing messages to redis. The message format is a simple JSON string.
+
+
+### JSON string format
+
+Example JSON message:
+
+```json
+{
+  'apn_ids': ["xxxxx"],
+  'gcm_ids': ["xxxxx", "yyyyyy"],
+  'development': true,
+  'cert': "cert string",
+  'api_key': "secret key",
+  'data': {
+    'aps': {
+      'alert': "This is a message"
+    }
+  }
+}
+```
+
+- apn_ids: This is an array with the list of iOS client tokens to which the push notification is to be sent. These are the tokens you get from the iOS devices when they register for APN push notifications.
+- gcm_ids: This is an array with the list of Android client ids to which the push notification is to be sent. These IDs are obtained on the devices when they register for GCM push notifications. You may only have up to 1000 ids in this array.
+- development: This can be true or false and indicates if the push notification is to be sent using the APN sandbox gateway (yes) or the APN production gateway (no). This option only affects push notifications to iOS devices and is assumed yes if not provided.
+- cert: This is a string representation of the certificate used to send push notifications via the APN network. Simply read the cert.pem file as string and plug it in this field.
+- api_key: This is the secret api_key used to send push notifications via the GCM network. This is the key you get from the Google API console.
+- data: This is a custom hash that is sent as push notification to the devices. For GCM this hash may contain anything you want as long as its size do not exceed 4096. For APN this data hash MUST contain an *aps* hash that follows Apple push notification format.
+
+#### Apple *aps* hash
+
+When sending push notifications to iOS devices you must provide an aps hash inside the data hash that follows the format:
+
+"aps": {
+  "alert": {
+    "action-loc-key": "Open",
+    "body": "Hello, world!"
+  },
+  "badge": 2,
+  "sound": "default"
+}
+
+Read the [official documentation](http://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html#//apple_ref/doc/uid/TP40008194-CH100-SW1) for details on the *aps* hash format. Note that this hash must not exceed the 256 bytes or it will be rejected by the APN service.
+
+#### Sending one message to both APN and GCM
+
+Normally you would send messages to either Android or iOS indenpendently. But the pusher daemon can send the same message to devices on both networks as long as you follow the Apple restrictions. This is because Apple push messages are more limited than GCM.
+
+If your data hash is compatible with the APN standard as described above and you specify a APN cert, a GCM api_key, a list of apn_ids and a list of gcm_ids then the message will be delivered via push notification to all the devices in those lists. Apple will display the notifications using their own mechanisms and for Android you will receive the data hash in a Bundle object as usual. Is your responsibility to extract the data from that bundle and display/use it as you please.
+
+## Examples
+
+A simple example using ruby code to send a push notification to iOS devices.
+
+```ruby
+require 'multi_json'
+require 'redis'
+
+# Build a message hash
+msg = {
+  apn_ids: ["xxxxx"],
+  development: true,
+  cert: File.read(pemfile),
+  data: {
+    aps: {
+      alert: "This is a message"
+    }
+  }
+}
+
+# Format the hash as a JSON string. We use multi_json gem for this but you are free to use any JSON encoder you want.
+msg_json = MultiJson.dump(msg)
+
+# Obtain a redis instance
+redis = Redis.new({ host: "localhost", port: 6379})
+
+# Push the message to the *suj_pusher_queue* in the redis server.
+redis.publish "suj_pusher_queue", msg_json
+```
+
+You must push the messages to the *suj_pusher_queue* queue that is the one the Pusher daemon is listening to. Also make sure your message follows the format described on the previous sections.
+
+## Issues
+
+- We have no feedback mechanism. This is a fire and forget daemon that does not tell us if the message was sent or not.
+- This daemon has no security at all. Anyone that can push to your redis server can use this daemon to spam your users. Make sure your redis server is only accessible to you and the pusher daemon.
+
+## TODO
+
+- Implement a feedback mechanism that exposes a simple API to allow users check if some tokens, ids, certs, or api_keys are no longer valid so they can take proper action.
+- Find a way to register certificates and api_key only once so we do not need to send them for every request. Maybe add a cert/key registration api.

data/bin/pusher

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'suj/pusher'
+require 'fileutils'
+require 'daemon_spawn'
+
+
+BANNER = "Usage: pusher start|stop|restart|status [options]"
+WORKDIR = Dir.pwd
+
+class PusherDaemon < DaemonSpawn::Base
+  def start(args)
+    config = Suj::Pusher::Configuration.new
+    args.options do |opts|
+      opts.banner = BANNER
+      opts.on('-r REDIS', '--redis REDIS', String, 'Redis server to connect') { |redis| config.redis = redis }
+      opts.on('-v', '--version', 'Print this version of rapns.') { puts "rapns #{Suj::Pusher::VERSION}"; exit }
+      opts.on('-h', '--help', 'You\'re looking at it.') { puts opts; exit }
+      opts.parse!
+    end
+
+    config.certs_path = File.join(WORKDIR, "certs")
+    FileUtils.mkdir_p(config.certs_path)
+    FileUtils.mkdir_p(File.join(WORKDIR, "logs"))
+    FileUtils.mkdir_p(File.join(WORKDIR, "tmp/pids"))
+    Suj::Pusher.config.update(config)
+
+    @daemon = Suj::Pusher::Daemon.new
+    @daemon.start
+  end
+
+  def stop
+    @daemon.stop
+  end
+end
+
+PusherDaemon.spawn!(
+  sync_log: true,
+  working_dir: Dir.pwd
+)

data/lib/suj/pusher/apn_connection.rb

@@ -0,0 +1,84 @@
+require "eventmachine"
+
+require "base64"
+module Suj
+  module Pusher
+    class APNConnection < EM::Connection
+      include Suj::Pusher::Logger
+
+      ERRORS = {
+        0 => "No errors encountered",
+        1 => "Processing error",
+        2 => "Missing device token",
+        3 => "Missing topic",
+        4 => "Missing payload",
+        5 => "Invalid token size",
+        6 => "Invalid topic size",
+        7 => "Invalid payload size",
+        8 => "Invalid token",
+        255 => "Unknown error"
+      }
+
+      def initialize(pool, options = {})
+        super
+        @disconnected = true
+        @pool = pool
+        @options = options
+        @cert_key = Digest::SHA1.hexdigest(@options[:cert])
+        @cert_file = File.join(Suj::Pusher.config.certs_path, @cert_key)
+        File.open(@cert_file, "w") do |f|
+          f.write @options[:cert]
+        end
+        @ssl_options = {
+          private_key_file: @cert_file,
+          cert_chain_file: @cert_file,
+          verify_peer: false
+        }
+      end
+
+      def disconnected?
+        @disconnected
+      end
+
+      def deliver(data)
+        @notification = Suj::Pusher::ApnNotification.new(data)
+        if ! disconnected?
+          info "APN delivering data"
+          send_data(@notification.data)
+          @notification = nil
+        end
+      end
+
+      def post_init
+        info "APN Connection init "
+        start_tls(@ssl_options)
+      end
+
+      def receive_data(data)
+        cmd, status, id = data.unpack("ccN")
+        if status != 0
+          error "APN push error received: #{ERRORS[status]}"
+        else
+          info "APN push notification sent"
+        end
+      end
+
+      def connection_completed
+        info "APN Connection established..."
+        @disconnected = false
+        if ! @notification.nil?
+          info "APN delivering data"
+          send_data(@notification.data)
+          @notification = nil
+        end
+      end
+
+      def unbind
+        info "APN Connection closed..."
+        @disconnected = true
+        FileUtils.rm_f(@cert_file)
+        @pool.remove_connection(@cert)
+      end
+    end
+  end
+end

data/lib/suj/pusher/apn_notification.rb

@@ -0,0 +1,38 @@
+module Suj
+  module Pusher
+    class ApnNotification
+      include Suj::Pusher::Logger
+      MAX_SIZE = 256
+
+      class InvalidToken < StandardError; end
+      class PayloadTooLarge < StandardError; end
+
+      def initialize(options = {})
+        @token = options[:token]
+        @options = options
+        raise InvalidToken if @token.nil? || (@token.length != 64)
+        raise PayloadTooLarge if data.size > MAX_SIZE
+      end
+
+      def payload
+        @payload ||= MultiJson.dump(@options[:data] || {})
+      end
+
+      def data
+        @data ||= encode_data
+      end
+
+      private
+
+      def encode_data
+        identifier = 0
+        expiry = 0
+        size = [payload].pack("a*").size
+        data_array = [1, identifier, expiry, 32, @token, size, payload]
+        info("PAYLOAD: #{data_array}")
+        data_array.pack("cNNnH*na*")
+      end
+
+    end
+  end
+end

data/lib/suj/pusher/configuration.rb

@@ -0,0 +1,40 @@
+module Suj
+  module Pusher
+
+    def self.config
+      @config ||= Suj::Pusher::Configuration.new
+    end
+
+    def self.configure
+      yield config if block_given?
+    end
+
+    CONFIG_ATTRS = [
+      :certs_path,
+      :workdir,
+      :logger,
+      :redis
+    ]
+
+    class Configuration < Struct.new(*CONFIG_ATTRS)
+
+      def initialize
+        super
+        set_defaults
+      end
+
+      def update(other)
+        CONFIG_ATTRS.each do |attr|
+          other_value = other.send(attr)
+          send("#{attr}=", other_value) unless other_value.nil?
+        end
+      end
+
+      def set_defaults
+        self.redis = "redis://localhost:6379"
+        self.logger = ::Logger.new(STDOUT)
+      end
+
+    end
+  end
+end

data/lib/suj/pusher/connection_pool.rb

@@ -0,0 +1,46 @@
+require "base64"
+require File.join File.dirname(File.expand_path(__FILE__)), "apn_connection.rb"
+require File.join File.dirname(File.expand_path(__FILE__)), "gcm_connection.rb"
+
+module Suj
+  module Pusher
+    class ConnectionPool
+      include Suj::Pusher::Logger
+
+      APN_SANDBOX = "gateway.sandbox.push.apple.com"
+      APN_GATEWAY = "gateway.push.apple.com"
+      APN_PORT = 2195
+
+      def initialize(daemon)
+        @pool = {}
+        @daemon = daemon
+      end
+
+      def apn_connection(options = {})
+        cert = Digest::SHA1.hexdigest options[:cert]
+        info "APN connection #{cert}"
+        @pool[cert] ||= EM.connect(APN_GATEWAY, APN_PORT, APNConnection, self, options)
+      end
+
+      def apn_sandbox_connection(options = {})
+        cert = Digest::SHA1.hexdigest options[:cert]
+        info "APN connection #{cert}"
+        @pool[cert] ||= EM.connect(APN_SANDBOX, APN_PORT, APNConnection, self, options)
+      end
+
+      def gcm_connection(options = {})
+        # All GCM connections are unique, even if they are to the same app.
+        api_key = "#{options[:api_key]}#{rand * 100}"
+        info "GCM connection #{api_key}"
+        @pool[api_key] ||= Suj::Pusher::GCMConnection.new(self, api_key, options)
+      end
+
+      def remove_connection(key)
+        info "Removing connection #{key}"
+        @pool.delete(key)
+      end
+
+    end
+
+  end
+end

data/lib/suj/pusher/daemon.rb

@@ -0,0 +1,91 @@
+require 'thread'
+require 'socket'
+require 'pathname'
+require 'openssl'
+require 'em-hiredis'
+require "multi_json"
+require 'fileutils'
+
+module Suj
+  module Pusher
+    class Daemon
+      include Suj::Pusher::Logger
+
+      def start
+        info "Starting pusher daemon"
+        EM.run do
+          wait_msg do |msg|
+            begin
+              data = Hash.symbolize_keys(MultiJson.load(msg))
+              send_notification(data)
+            rescue MultiJson::LoadError
+              warn("Received invalid json data, discarding msg")
+            end
+          end
+        end
+      end
+
+      def stop
+        info "Stopping daemon process"
+        begin
+          EM.stop
+        rescue
+        end
+        info "Stopped daemon process"
+      end
+
+      private
+
+      def wait_msg
+        redis.pubsub.subscribe(Suj::Pusher::QUEUE) do |msg|
+          yield msg
+        end
+      end
+
+      def send_notification(msg)
+        if msg.has_key?(:cert)
+          if msg.has_key?(:development) && msg[:development]
+            send_apn_sandbox_notification(msg)
+          else
+            send_apn_notification(msg)
+          end
+        elsif msg.has_key?(:api_key)
+          send_gcm_notification(msg)
+        else
+          warn "Could not determine push notification service."
+        end
+      end
+
+      def send_apn_notification(msg)
+        info "Sending APN notification via connection #{Digest::SHA1.hexdigest(msg[:cert])}"
+        conn = pool.apn_connection(msg)
+        msg[:apn_ids].each do |apn_id|
+          conn.deliver(msg.merge({token: apn_id}))
+        end
+      end
+
+      def send_apn_sandbox_notification(msg)
+        info "Sending APN sandbox notification via connection #{Digest::SHA1.hexdigest(msg[:cert])}"
+        conn = pool.apn_sandbox_connection(msg)
+        msg[:apn_ids].each do |apn_id|
+          conn.deliver(msg.merge({token: apn_id}))
+        end
+      end
+
+      def send_gcm_notification(msg)
+        info "Sending GCM notification via connection #{msg[:api_key]}"
+        conn = pool.gcm_connection(msg)
+        conn.deliver(msg)
+      end
+
+      def redis
+        @redis || EM::Hiredis.connect(Suj::Pusher.config.redis)
+      end
+
+      def pool
+        @pool ||= Suj::Pusher::ConnectionPool.new(self)
+      end
+
+    end
+  end
+end

data/lib/suj/pusher/gcm_connection.rb

@@ -0,0 +1,49 @@
+require "em-http"
+
+module Suj
+  module Pusher
+    class GCMConnection
+      include Suj::Pusher::Logger
+
+      GATEWAY = "https://android.googleapis.com/gcm/send"
+
+      def initialize(pool, key, options = {})
+        @pool = pool
+        @options = options
+        @key = key
+        @headers =  {
+          'Content-Type' => 'application/json',
+          'Authorization' => "key=#{options[:api_key]}"
+        }
+      end
+
+      def deliver(msg)
+
+        return if msg[:gcm_ids].empty?
+
+        body = MultiJson.dump({
+          registration_ids: msg[:gcm_ids],
+          data: msg[:data] || {}
+        })
+
+
+        http = EventMachine::HttpRequest.new(GATEWAY).post( head: @headers, body: body )
+
+        http.errback do
+          error "GCM network error"
+          @pool.remove_connection(@key)
+        end
+        http.callback do
+          if http.response_header.status != 200
+            error "GCM push error #{http.response_header.status}"
+            error http.response
+          else
+            info "GCM push notification send"
+            info http.response
+          end
+          @pool.remove_connection(@key)
+        end
+      end
+    end
+  end
+end

data/lib/suj/pusher/logger.rb

@@ -0,0 +1,13 @@
+module Suj
+  module Pusher
+    module Logger
+
+      private
+
+      def info(msg); Suj::Pusher.config.logger.info(msg); end
+      def warn(msg); Suj::Pusher.config.logger.warn(msg); end
+      def error(msg); Suj::Pusher.config.logger.error(msg); end
+      def fatal(msg); Suj::Pusher.config.logger.fatal(msg); end
+    end
+  end
+end

data/lib/suj/pusher/monkey/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  #take keys of hash and transform those to a symbols
+  def self.symbolize_keys(value)
+    return value if not value.is_a?(Hash)
+    hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = Hash.symbolize_keys(v); memo}
+    return hash
+  end
+end

data/lib/suj/pusher/version.rb

@@ -0,0 +1,5 @@
+module Suj
+  module Pusher
+    VERSION = '0.0.1'
+  end
+end

data/lib/suj/pusher.rb

@@ -0,0 +1,19 @@
+require 'suj/pusher/monkey/hash'
+require 'suj/pusher/version'
+require 'suj/pusher/configuration'
+require 'suj/pusher/logger'
+require 'suj/pusher/connection_pool'
+require 'suj/pusher/apn_connection'
+require 'suj/pusher/gcm_connection'
+require 'suj/pusher/apn_notification'
+require 'suj/pusher/daemon'
+
+require 'logger'
+
+module Suj
+  module Pusher
+
+    QUEUE = "suj_pusher_queue"
+
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: suj-pusher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Horacio Sanson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &19868920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19868920
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: &19868320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19868320
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &19867580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19867580
+- !ruby/object:Gem::Dependency
+  name: daemon-spawn
+  requirement: &19866460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19866460
+description: Stand alone push notification server for APN and GCM.
+email:
+- rd@skillupjapan.co.jp
+executables:
+- pusher
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/suj/pusher.rb
+- lib/suj/pusher/apn_connection.rb
+- lib/suj/pusher/apn_notification.rb
+- lib/suj/pusher/configuration.rb
+- lib/suj/pusher/connection_pool.rb
+- lib/suj/pusher/daemon.rb
+- lib/suj/pusher/gcm_connection.rb
+- lib/suj/pusher/logger.rb
+- lib/suj/pusher/monkey/hash.rb
+- lib/suj/pusher/version.rb
+- bin/pusher
+homepage: https://github.com/sujrd/suj-pusher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Stand alone push notification server.
+test_files: []