push-apns 0.0.1.pre

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= PushApns
+
+This project rocks and uses MIT-LICENSE.

data/lib/push-apns.rb

@@ -0,0 +1,11 @@
+require 'socket'
+require 'pathname'
+require 'push-apns/version'
+require 'push/apns/binary_notification_validator'
+require 'push/message_apns'
+require 'push/feedback_apns'
+require 'push/daemon/apns'
+require 'push/daemon/interruptible_sleep'
+require 'push/daemon/apns_support/certificate'
+require 'push/daemon/apns_support/connection_apns'
+require 'push/daemon/apns_support/feedback_receiver'

data/lib/push-apns/version.rb

@@ -0,0 +1,3 @@
+module PushApns
+  VERSION = "0.0.1.pre"
+end

data/lib/push/apns/binary_notification_validator.rb

@@ -0,0 +1,12 @@
+module Push
+  module Apns
+    class BinaryNotificationValidator < ActiveModel::Validator
+
+      def validate(record)
+        if record.payload_size > 256
+          record.errors[:base] << "APN notification cannot be larger than 256 bytes. Try condensing your alert and device attributes."
+        end
+      end
+    end
+  end
+end

data/lib/push/daemon/apns.rb

@@ -0,0 +1,41 @@
+module Push
+  module Daemon
+    class Apns
+      attr_accessor :configuration, :certificate
+
+      def initialize(options)
+        self.configuration = options
+
+        self.certificate = ApnsSupport::Certificate.new(configuration[:certificate])
+        certificate.load
+
+        start_feedback
+      end
+
+      def pushconnections
+        self.configuration[:connections]
+      end
+
+      def totalconnections
+        # + feedback
+        pushconnections + 1
+      end
+
+      def connectiontype
+        ApnsSupport::ConnectionApns
+      end
+
+      def start_feedback
+        ApnsSupport::FeedbackReceiver.start(self)
+      end
+
+      def stop_feedback
+        ApnsSupport::FeedbackReceiver.stop
+      end
+
+      def stop
+        stop_feedback
+      end
+    end
+  end
+end

data/lib/push/daemon/apns_support/certificate.rb

@@ -0,0 +1,37 @@
+module Push
+  class CertificateError < StandardError; end
+
+  module Daemon
+    module ApnsSupport
+      class Certificate
+        attr_accessor :certificate
+
+        def initialize(certificate_path)
+          @certificate_path = path(certificate_path)
+        end
+
+        def path(path)
+          if Pathname.new(path).absolute?
+            path
+          else
+            File.join(Rails.root, "config", "push", path)
+          end
+        end
+
+        def load
+          @certificate = read_certificate
+        end
+
+        protected
+
+        def read_certificate
+          if !File.exists?(@certificate_path)
+            raise CertificateError, "#{@certificate_path} does not exist. The certificate location can be configured in config/push/<<environment>>.rb"
+          else
+            File.read(@certificate_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/push/daemon/apns_support/connection_apns.rb

@@ -0,0 +1,96 @@
+module Push
+  module Daemon
+    module ApnsSupport
+      class ConnectionApns
+        attr_reader :name, :provider
+
+        def initialize(provider, i=nil)
+          @provider = provider
+          if i
+            # Apns push connection
+            @name = "ConnectionApns #{i}"
+            @host = "gateway.#{provider.configuration[:sandbox] ? 'sandbox.' : ''}push.apple.com"
+            @port = 2195
+          else
+            @name = "FeedbackReceiver"
+            @host = "feedback.#{provider.configuration[:sandbox] ? 'sandbox.' : ''}push.apple.com"
+            @port = 2196
+          end
+        end
+
+        def connect
+          @ssl_context = setup_ssl_context
+          @tcp_socket, @ssl_socket = connect_socket
+        end
+
+        def close
+          begin
+            @ssl_socket.close if @ssl_socket
+            @tcp_socket.close if @tcp_socket
+          rescue IOError
+          end
+        end
+
+        def read(num_bytes)
+          @ssl_socket.read(num_bytes)
+        end
+
+        def select(timeout)
+          IO.select([@ssl_socket], nil, nil, timeout)
+        end
+
+        def write(data)
+          retry_count = 0
+
+          begin
+            write_data(data)
+          rescue Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError => e
+            retry_count += 1;
+
+            if retry_count == 1
+              Push::Daemon.logger.error("[#{@name}] Lost connection to #{@host}:#{@port} (#{e.class.name}), reconnecting...")
+            end
+
+            if retry_count <= 3
+              reconnect
+              sleep 1
+              retry
+            else
+              raise ConnectionError, "#{@name} tried #{retry_count-1} times to reconnect but failed (#{e.class.name})."
+            end
+          end
+        end
+
+        def reconnect
+          close
+          @tcp_socket, @ssl_socket = connect_socket
+        end
+
+        protected
+
+        def write_data(data)
+          @ssl_socket.write(data)
+          @ssl_socket.flush
+        end
+
+        def setup_ssl_context
+          ssl_context = OpenSSL::SSL::SSLContext.new
+          ssl_context.key = OpenSSL::PKey::RSA.new(provider.certificate.certificate, provider.configuration[:certificate_password])
+          ssl_context.cert = OpenSSL::X509::Certificate.new(provider.certificate.certificate)
+          ssl_context
+        end
+
+        def connect_socket
+          tcp_socket = TCPSocket.new(@host, @port)
+          tcp_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
+          tcp_socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+          ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, @ssl_context)
+          ssl_socket.sync = true
+          ssl_socket.connect
+          Push::Daemon.logger.info("[#{@name}] Connected to #{@host}:#{@port}")
+          [tcp_socket, ssl_socket]
+        end
+      end
+    end
+  end
+end

data/lib/push/daemon/apns_support/feedback_receiver.rb

@@ -0,0 +1,58 @@
+module Push
+  module Daemon
+    module ApnsSupport
+      class FeedbackReceiver
+        extend Push::Daemon::InterruptibleSleep
+        attr_accessor :provider
+        FEEDBACK_TUPLE_BYTES = 38
+
+        def self.start(provider)
+          @provider = provider
+          @thread = Thread.new do
+            loop do
+              break if @stop
+              check_for_feedback
+              interruptible_sleep @provider.configuration[:feedback_poll]
+            end
+          end
+        end
+
+        def self.stop
+          @stop = true
+          interrupt_sleep
+          @thread.join if @thread
+        end
+
+        def self.check_for_feedback
+          connection = nil
+          begin
+            connection = ApnsSupport::ConnectionApns.new(@provider)
+            connection.connect
+
+            while tuple = connection.read(FEEDBACK_TUPLE_BYTES)
+              timestamp, device = parse_tuple(tuple)
+              create_feedback(timestamp, device)
+            end
+          rescue StandardError => e
+            Push::Daemon.logger.error(e)
+          ensure
+            connection.close if connection
+          end
+        end
+
+        protected
+
+        def self.parse_tuple(tuple)
+          failed_at, _, device = tuple.unpack("N1n1H*")
+          [Time.at(failed_at).utc, device]
+        end
+
+        def self.create_feedback(failed_at, device)
+          formatted_failed_at = failed_at.strftime("%Y-%m-%d %H:%M:%S UTC")
+          Push::Daemon.logger.info("[FeedbackReceiver] Delivery failed at #{formatted_failed_at} for #{device}")
+          Push::FeedbackApns.create!(:failed_at => failed_at, :device => device)
+        end
+      end
+    end
+  end
+end

data/lib/push/feedback_apns.rb

@@ -0,0 +1,5 @@
+module Push
+  class FeedbackApns < Push::Feedback
+    validates :device, :format => { :with => /\A[a-z0-9]{64}\z/ }
+  end
+end

data/lib/push/message_apns.rb

@@ -0,0 +1,101 @@
+module Push
+  class MessageApns < Push::Message
+    SELECT_TIMEOUT = 0.5
+    ERROR_TUPLE_BYTES = 6
+    APN_ERRORS = {
+      1 => "Processing error",
+      2 => "Missing device token",
+      3 => "Missing topic",
+      4 => "Missing payload",
+      5 => "Missing token size",
+      6 => "Missing topic size",
+      7 => "Missing payload size",
+      8 => "Invalid token",
+      255 => "None (unknown error)"
+    }
+
+    store :properties, accessors: [:alert, :badge, :sound, :expiry, :attributes_for_device]
+
+    validates :badge, :numericality => true, :allow_nil => true
+    validates :expiry, :numericality => true, :presence => true
+    validates :device, :format => { :with => /\A[a-z0-9]{64}\z/ }
+    validates_with Push::Apns::BinaryNotificationValidator
+
+    # def attributes_for_device=(attrs)
+    #   raise ArgumentError, "attributes_for_device must be a Hash" if !attrs.is_a?(Hash)
+    #   write_attribute(:attributes_for_device, MultiJson.encode(attrs))
+    # end
+    #
+    # def attributes_for_device
+    #   MultiJson.decode(read_attribute(:attributes_for_device)) if read_attribute(:attributes_for_device)
+    # end
+
+    def alert=(alert)
+      if alert.is_a?(Hash)
+        #write_attribute(:alert, MultiJson.encode(alert))
+        properties[:alert] = MultiJson.encode(alert)
+      else
+        #write_attribute(:alert, alert)
+        properties[:alert] = alert
+      end
+    end
+
+    def alert
+      string_or_json = read_attribute(:alert)
+      MultiJson.decode(string_or_json) rescue string_or_json
+    end
+
+    # This method conforms to the enhanced binary format.
+    # http://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingWIthAPS/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW4
+    def to_message(options = {})
+      id_for_pack = options[:for_validation] ? 0 : id
+      [1, id_for_pack, expiry, 0, 32, device, 0, payload_size, payload].pack("cNNccH*cca*")
+    end
+
+    def use_connection
+      Push::Daemon::ApnsSupport::ConnectionApns
+    end
+
+    def payload
+      MultiJson.encode(as_json)
+    end
+
+    def payload_size
+      payload.bytesize
+    end
+
+    private
+
+    def as_json
+      json = ActiveSupport::OrderedHash.new
+      json['aps'] = ActiveSupport::OrderedHash.new
+      json['aps']['alert'] = alert if alert
+      json['aps']['badge'] = badge if badge
+      json['aps']['sound'] = sound if sound
+      attributes_for_device.each { |k, v| json[k.to_s] = v.to_s } if attributes_for_device
+      json
+    end
+
+    def check_for_error(connection)
+      if connection.select(SELECT_TIMEOUT)
+        error = nil
+
+        if tuple = connection.read(ERROR_TUPLE_BYTES)
+          cmd, code, notification_id = tuple.unpack("ccN")
+
+          description = APN_ERRORS[code.to_i] || "Unknown error. Possible push bug?"
+          error = Push::DeliveryError.new(code, notification_id, description, "APNS")
+        else
+          error = Push::DisconnectionError.new
+        end
+
+        begin
+          Push::Daemon.logger.error("[#{connection.name}] Error received, reconnecting...")
+          connection.reconnect
+        ensure
+          raise error if error
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: push-apns
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Tom Pesman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70268841150140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70268841150140
+- !ruby/object:Gem::Dependency
+  name: push-core
+  requirement: &70268841149600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.1.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: *70268841149600
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70268841149200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70268841149200
+description: Plugin with APNS specific push information.
+email:
+- tom@tnux.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/push-apns.rb
+- lib/push-apns/version.rb
+- lib/push/apns/binary_notification_validator.rb
+- lib/push/daemon/apns.rb
+- lib/push/daemon/apns_support/certificate.rb
+- lib/push/daemon/apns_support/connection_apns.rb
+- lib/push/daemon/apns_support/feedback_receiver.rb
+- lib/push/feedback_apns.rb
+- lib/push/message_apns.rb
+- README.md
+- MIT-LICENSE
+homepage: https://github.com/tompesman/push-apns
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: APNS (iOS) part of the modular push daemon.
+test_files: []