ghazel-em-apn 0.0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d304846e4e9cb3d8b7da79ef8a0e721dfb3a3ba0
+  data.tar.gz: bb079ada2ab1b5a9a1234a0ea698ba889c2bedfb
+SHA512:
+  metadata.gz: cbdc74902f15c6f187fb0cb2a2ce9aba4954f4a20d42df0950636a45fc52a0b58c918a2d2a98dff32467f84c0aec41cba171f67617cb89fe02b8d5d9e116c238
+  data.tar.gz: 8670311ae9a6c723bdb82471c6b1651fcd89f439b9a2dbe1a1f915f0c3715be6295496748d8cdb6642b1e5044fa37faee2d19011fa3e74c49f44faa80dc18d5c

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+certs/*.pem
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-apn.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT-License)
+
+Copyright (c) 2011 GroupMe
+
+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,85 @@
+# EM-APN - EventMachine'd Apple Push Notifications #
+
+We want:
+
+ * Streamlined for a persistent connection use-case
+ * Support for the enhanced protocol, with receipts
+
+## Usage ##
+
+In a nutshell:
+
+    require "em-apn"
+
+    # Inside a reactor...
+    notification = EM::APN::Notification.new(token, :alert => alert)
+    client = EM::APN::Client.connect
+    client.deliver(notification)
+
+Using this interface, the easiest way to configure the connection is by setting
+some environment variables so that EM::APN can find your SSL certificates:
+
+    ENV["APN_KEY"]  = "/path/to/key.pem"
+    ENV["APN_CERT"] = "/path/to/cert.pem"
+
+Also, by default, the library connects to Apple's sandbox push server. If you
+want to connect to the production server, simply set the `APN_ENV`
+environment variable to `production`:
+
+    ENV["APN_ENV"] = "production"
+
+The gateway and SSL certs can also be set directly when instantiating the object:
+
+    client = EM::APN::Client.connect(
+      :gateway => "some.host",
+      :key     => "/path/to/key.pem",
+      :cert    => "/path/to/cert.pem"
+    )
+
+The client manages an underlying `EM::Connection`, and it will automatically
+reconnect to the gateway when the connection is closed. Callbacks can be set
+on the client to handle error responses from the gateway, connection open & close
+events:
+
+    client = EM::APN::Client.connect
+    client.on_error do |response|
+      # See EM::APN::ErrorResponse
+    end
+
+    client.on_close do
+      # Do something.
+    end
+
+    client.on_open do
+      # Do something
+    end
+
+In our experience, we've found that Apple immediately closes the connection
+whenever an error is detected, so the error and close callbacks are nearly
+always called one-to-one. These methods exist as a convenience, and the
+callbacks can also be set directly to anything that responds to `#call`:
+
+    client.error_callback = Proc.new { |response| ... }
+    client.close_callback = Proc.new { ... }
+    client.open_callback  = Proc.new { ... }
+
+### Max Payload Size ###
+
+Apple enforces a limit of __256 bytes__ for the __entire payload__.
+
+If you attempt to deliver a notification that exceeds that limit, the library
+will raise an `EM::APN::Notification::PayloadTooLarge` exception.
+
+To prevent that from happening, you can call `#truncate_alert!` on the
+notification.
+
+    notification = EM::APN::Notification.new(...)
+    notification.truncate_alert!
+    client.deliver(notification)
+
+## Inspiration ##
+
+Much thanks to:
+
+ * https://github.com/kdonovan/apn_sender
+ * http://blog.technopathllc.com/2010/12/apples-push-notification-with-ruby.html

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+desc "Run specs"
+task :spec do
+  spec_files = Dir["spec/**/*_spec.rb"]
+  ruby("-S bundle exec rspec #{spec_files.join(" ")}")
+end
+
+task :default => :spec

data/em-apn.gemspec

@@ -0,0 +1,24 @@
+# -*- mode: ruby; encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-apn/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ghazel-em-apn"
+  s.version     = EventMachine::APN::VERSION
+  s.authors     = ["Dave Yeu"]
+  s.email       = ["daveyeu@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{EventMachine-driven Apple Push Notifications}
+
+  s.rubyforge_project = "em-apn"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "eventmachine", ">= 1.0.0.beta.3"
+  s.add_dependency "multi_json",   ">= 1.8.2"
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
+end

data/lib/em-apn/client.rb

@@ -0,0 +1,78 @@
+# encoding: UTF-8
+
+module EventMachine
+  module APN
+    class Client
+      SANDBOX_GATEWAY    = "gateway.sandbox.push.apple.com"
+      PRODUCTION_GATEWAY = "gateway.push.apple.com"
+      PORT               = 2195
+      SANDBOX_FEEDBACK_GATEWAY    = "feedback.sandbox.push.apple.com"
+      PRODUCTION_FEEDBACK_GATEWAY = "feedback.push.apple.com"
+      FEEDBACK_PORT      = 2196
+
+
+      attr_reader :gateway, :port, :key, :cert, :connection, :error_callback, :close_callback, :open_callback
+      attr_reader :feedback_connection, :feedback_gateway, :feedback_port, :feedback_callback
+
+      # A convenience method for creating and connecting.
+      def self.connect(options = {})
+        new(options).tap do |client|
+          client.connect
+          client.connect_feedback
+        end
+      end
+
+      def initialize(options = {})
+        @key  = options[:key]  || ENV["APN_KEY"]
+        @cert = options[:cert] || ENV["APN_CERT"]
+        @port = options[:port] || PORT
+
+        @gateway = options[:gateway] || ENV["APN_GATEWAY"]
+        @gateway ||= (ENV["APN_ENV"] == "production") ? PRODUCTION_GATEWAY : SANDBOX_GATEWAY
+
+
+        @feedback_gateway = options[:feedback_gateway] || ENV["APN_FEEDBACK_GATEWAY"]
+        @feedback_gateway ||= (ENV["APN_ENV"] == "production") ? PRODUCTION_FEEDBACK_GATEWAY : SANDBOX_FEEDBACK_GATEWAY
+        @feedback_port = options[:feedback_port] || FEEDBACK_PORT
+
+        @connection = nil
+        @feedback_connection = nil
+      end
+
+      def connect
+        @connection = EM.connect(gateway, port, Connection, self)
+      end
+
+      def connect_feedback
+        @feedback_connection = EM.connect(feedback_gateway, feedback_port, FeedbackConnection, self)
+      end
+
+      def deliver(notification)
+        notification.validate!
+        connect if connection.nil? || connection.disconnected?
+        log(notification)
+        connection.send_data(notification.data)
+      end
+
+      def on_error(&block)
+        @error_callback = block
+      end
+
+      def on_close(&block)
+        @close_callback = block
+      end
+
+      def on_open(&block)
+        @open_callback = block
+      end
+
+      def on_feedback(&block)
+        @feedback_callback = block
+      end
+
+      def log(notification)
+        EM::APN.logger.info("TOKEN=#{notification.token} PAYLOAD=#{notification.payload.inspect}")
+      end
+    end
+  end
+end

data/lib/em-apn/connection.rb

@@ -0,0 +1,47 @@
+module EventMachine
+  module APN
+    class Connection < EM::Connection
+      attr_reader :client
+
+      def initialize(*args)
+        super
+        @client = args.last
+        @disconnected = false
+      end
+
+      def disconnected?
+        @disconnected
+      end
+
+      def post_init
+        start_tls(
+          :private_key_file => client.key,
+          :cert_chain_file  => client.cert,
+          :verify_peer      => false
+        )
+      end
+
+      def connection_completed
+        EM::APN.logger.info("Connection completed")
+        client.open_callback.call if client.open_callback
+      end
+
+      def receive_data(data)
+        data_array = data.unpack("ccN")
+        error_response = ErrorResponse.new(*data_array)
+        EM::APN.logger.warn(error_response.to_s)
+
+        if client.error_callback
+          client.error_callback.call(error_response)
+        end
+      end
+
+      def unbind
+        @disconnected = true
+
+        EM::APN.logger.info("Connection closed")
+        client.close_callback.call if client.close_callback
+      end
+    end
+  end
+end

data/lib/em-apn/error_response.rb

@@ -0,0 +1,34 @@
+module EventMachine
+  module APN
+    class ErrorResponse
+      DESCRIPTION = {
+        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 => "None (unknown)"
+      }
+
+      attr_reader :command, :status_code, :identifier
+
+      def initialize(command, status_code, identifier)
+        @command     = command
+        @status_code = status_code
+        @identifier  = identifier
+      end
+
+      def to_s
+        "CODE=#{@status_code} ID=#{@identifier} DESC=#{description}"
+      end
+
+      def description
+        DESCRIPTION[@status_code] || "Missing description"
+      end
+    end
+  end
+end

data/lib/em-apn/failed_delivery_attempt.rb

@@ -0,0 +1,18 @@
+module EventMachine
+  module APN
+    class FailedDeliveryAttempt
+      LENGTH = 38
+
+      attr_accessor :timestamp, :device_token
+
+      def initialize(binary_tuple)
+        # N   =>  4 byte timestamp
+        # n   =>  2 byte token_length
+        # H64 => 32 byte device_token
+        seconds, _, @device_token = binary_tuple.unpack('NnH64')
+        raise ArgumentError('invalid format') unless seconds && @device_token
+        @timestamp = Time.at(seconds)
+      end
+    end
+  end
+end

data/lib/em-apn/feedback_connection.rb

@@ -0,0 +1,43 @@
+module EventMachine
+  module APN
+    class FeedbackConnection < EM::Connection
+      attr_reader :client
+
+      def initialize(*args)
+        super
+        @client = args.last
+        @disconnected = false
+      end
+
+      def disconnected?
+        @disconnected
+      end
+
+      def post_init
+        start_tls(
+          :private_key_file => client.key,
+          :cert_chain_file  => client.cert,
+          :verify_peer      => false
+        )
+      end
+
+      def connection_completed
+        EM::APN.logger.info("Feedback connection completed")
+      end
+
+      def receive_data(data)
+        attempt = FailedDeliveryAttempt.new(data)
+        EM::APN.logger.warn(attempt.to_s)
+
+        if client.feedback_callback
+          client.feedback_callback.call(attempt)
+        end
+      end
+
+      def unbind
+        @disconnected = true
+        EM::APN.logger.info("Feedback connection closed")
+      end
+    end
+  end
+end

data/lib/em-apn/log_message.rb

@@ -0,0 +1,13 @@
+module EventMachine
+  module APN
+    class LogMessage
+      def initialize(response)
+        @response = response
+      end
+
+      def log
+        EM::APN.logger.info(@response.to_s)
+      end
+    end
+  end
+end

data/lib/em-apn/notification.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+
+module EventMachine
+  module APN
+    class Notification
+      DATA_MAX_BYTES = 256
+      ALERT_KEY = "alert"
+
+      class PayloadTooLarge < StandardError; end
+
+      attr_reader :token, :identifier
+      attr_accessor :expiry
+
+      def initialize(token, aps = {}, custom = {}, options = {})
+        raise "Bad push token: #{token}" if token.nil? || (token.length != 64)
+
+        @token  = token
+        @aps    = aps.stringify_keys!
+        @custom = custom
+        @expiry = options[:expiry]
+
+        self.identifier = options[:identifier] if options[:identifier]
+      end
+
+      def payload
+        MultiJson.encode(@custom.merge(:aps => @aps))
+      end
+
+      # Documentation about this format is here:
+      # http://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingWIthAPS/CommunicatingWIthAPS.html
+      def data
+        identifier = @identifier || 0
+        expiry     = @expiry || 0
+        size = [payload].pack("a*").size
+        data_array = [1, identifier, expiry, 32, token, size, payload]
+        data_array.pack("cNNnH*na*")
+      end
+
+      def validate!
+        if data.size > DATA_MAX_BYTES
+          error = "max is #{DATA_MAX_BYTES} bytes, but got #{data.size}: #{payload.inspect}"
+          raise PayloadTooLarge.new(error)
+        else
+          true
+        end
+      end
+
+      def identifier=(new_identifier)
+        @identifier = new_identifier.to_i
+      end
+
+      def truncate_alert!
+        return unless @aps.has_key?(ALERT_KEY)
+
+        while data.size > DATA_MAX_BYTES && @aps[ALERT_KEY].size > 0
+          @aps[ALERT_KEY].chop!
+        end
+      end
+
+    end
+  end
+end

data/lib/em-apn/response.rb

@@ -0,0 +1,13 @@
+module EventMachine
+  module APN
+    class Response
+      def initialize(notification)
+        @notification = notification
+      end
+
+      def to_s
+        "TOKEN=#{@notification.token}"
+      end
+    end
+  end
+end

data/lib/em-apn/server.rb

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+# Mock Apple push server... because we love to test
+module EventMachine
+  module APN
+    module Server
+      def post_init
+        EM::APN.logger.info("Received a new connection")
+        @data  = ""
+
+        start_tls(
+          :cert_chain_file  => ENV["APN_CERT"],
+          :private_key_file => ENV["APN_KEY"],
+          :verify_peer      => false
+        )
+      end
+
+      def ssl_handshake_completed
+        EM::APN.logger.info("SSL handshake completed")
+      end
+
+      def receive_data(data)
+        @data << data
+
+        # Try to extract the payload header
+        headers = @data.unpack("cNNnH64n")
+        return if headers.last.nil?
+
+        # Try to grab the payload
+        payload_size = headers.last
+        payload = @data[45, payload_size]
+        return if payload.length != payload_size
+
+        @data = @data[45 + payload_size, -1] || ""
+
+        process(headers, payload)
+      end
+
+      def process(headers, payload)
+        message = "APN RECV #{headers[4]} #{payload}"
+        EM::APN.logger.info(message)
+
+        args = MultiJson.decode(payload)
+
+        # If the alert is 'DISCONNECT', then we fake a bad payload by replying
+        # with an error and disconnecting.
+        if args["aps"]["alert"] == "DISCONNECT"
+          EM::APN.logger.info("Disconnecting")
+          send_data([8, 1, 0].pack("ccN"))
+          close_connection_after_writing
+        end
+      end
+
+      def unbind
+        EM::APN.logger.info("Connection closed")
+      end
+    end
+  end
+end

data/lib/em-apn/test_helper.rb

@@ -0,0 +1,37 @@
+# Test helper for EM::APN
+#
+# To use this, start by simply requiring this file after EM::APN has already
+# been loaded
+#
+#     require "em-apn"
+#     require "em-apn/test_helper"
+#
+# This will nullify actual deliveries and instead, push them onto an accessible
+# list:
+#
+#     expect {
+#       client.deliver('notification)
+#     }.to change { EM::APN.deliveries.size }.by(1)
+#
+#     notification = EM::APN.deliveries.first
+#     notification.should be_an_instance_of(EM::APN::Notification)
+#     notification.payload.should == ...
+#
+module EventMachine
+  module APN
+    def self.deliveries
+      @deliveries ||= []
+    end
+
+    Client.class_eval do
+      def connect
+        # No-op
+      end
+
+      def deliver(notification)
+        log(notification)
+        EM::APN.deliveries << notification
+      end
+    end
+  end
+end

data/lib/em-apn/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module APN
+    VERSION = "0.0.3.1"
+  end
+end

data/lib/em-apn.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require "eventmachine"
+require "multi_json"
+require "logger"
+require "extensions/hash"
+require "em-apn/client"
+require "em-apn/feedback_connection"
+require 'em-apn/failed_delivery_attempt'
+require "em-apn/connection"
+require "em-apn/notification"
+require "em-apn/log_message"
+require "em-apn/response"
+require "em-apn/error_response"
+
+module EventMachine
+  module APN
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(new_logger)
+      @logger = new_logger
+    end
+  end
+end

data/lib/extensions/hash.rb

@@ -0,0 +1,13 @@
+class Hash
+  unless Hash.instance_methods.include?(:stringify_keys!)
+    def stringify_keys!
+      keys.each do |key|
+        unless key.kind_of?(String)
+          self[key.to_s] = delete(key)
+        end
+      end
+
+      self
+    end
+  end
+end

data/script/push

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+#
+# Send a single push notification
+#
+#   $ script/push <TOKEN> "<ALERT>"
+#
+
+require "rubygems"
+require "bundler/setup"
+require "em-apn"
+
+ENV["APN_KEY"]  ||= File.join(File.dirname(__FILE__),  "..", "certs", "key.pem")
+ENV["APN_CERT"] ||= File.join(File.dirname(__FILE__), "..", "certs", "cert.pem")
+
+token, alert = ARGV
+
+if token.nil? || alert.nil?
+  puts "Usage: script/push <TOKEN> \"<ALERT>\""
+  exit 1
+end
+
+EM.run do
+  client = EM::APN::Client.connect
+  client.deliver(EM::APN::Notification.new(token, :alert => alert))
+
+  # Hopefully give ourselves enough time to receive a response on failure.
+  # Wish there was a better way to do this. Or at least a more timely way.
+  EM.add_timer(1) { EM.stop_event_loop }
+end

data/script/server

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#
+# Run a mock Apple push server
+
+require "rubygems"
+require "bundler/setup"
+require "em-apn"
+require "em-apn/server"
+
+ENV["APN_KEY"]  = File.join(File.dirname(__FILE__), "..", "certs", "key.pem")
+ENV["APN_CERT"] = File.join(File.dirname(__FILE__), "..", "certs", "cert.pem")
+
+EM::APN.logger.info("Starting push server")
+
+EM.run do
+  EM.start_server("127.0.0.1", 2195, EM::APN::Server)
+end