mwotton-apnd 0.1.8

data/lib/apnd/feedback.rb

@@ -0,0 +1,65 @@
+module APND
+  #
+  # APND::Feedback receives feedback from Apple when notifications are
+  # being rejected for a specific token. This is usually due to the user
+  # uninstalling your application.
+  #
+  class Feedback
+
+    class << self
+      #
+      # The host to receive feedback from, usually apple
+      #
+      attr_accessor :upstream_host
+
+      #
+      # The port to connect to upstream_host on
+      #
+      attr_accessor :upstream_port
+    end
+
+    #
+    # Set upstream host/port to default values
+    #
+    self.upstream_host = APND.settings.feedback.host
+    self.upstream_port = APND.settings.feedback.port.to_i
+
+    #
+    # Connect to Apple's Feedback Service and return an array of device
+    # tokens that should no longer receive push notifications
+    #
+    def self.find_stale_devices(&block)
+      feedback = self.new
+      devices  = feedback.receive
+      devices.each { |device| yield *device } if block_given?
+      devices
+    end
+
+    #
+    # Create a connection to Apple's Feedback Service
+    #
+    def initialize
+      @apple = APND::Daemon::AppleConnection.new({
+        :cert      => APND.settings.apple.cert,
+        :cert_pass => APND.settings.apple.cert_pass,
+        :host      => self.class.upstream_host,
+        :port      => self.class.upstream_port.to_i
+      })
+    end
+
+    #
+    # Receive feedback from Apple and return an array of device tokens
+    #
+    def receive
+      tokens = []
+      @apple.open do |sock|
+        while line = sock.gets
+          payload = line.strip.unpack('N1n1H140')
+          tokens << [payload[2].strip, Time.at(payload[0])]
+        end
+      end
+      tokens
+    end
+
+  end
+end

data/lib/apnd/notification.rb

@@ -0,0 +1,189 @@
+require 'socket'
+
+module APND
+  #
+  # APND::Notification is the base class for creating new push notifications.
+  #
+  class Notification
+
+    class << self
+      #
+      # The host notifications will be written to, usually one
+      # running APND
+      #
+      attr_accessor :upstream_host
+
+      #
+      # The port to connect to upstream_host on
+      #
+      attr_accessor :upstream_port
+    end
+
+    #
+    # Set upstream host/port to default values
+    #
+    self.upstream_host = APND.settings.notification.host
+    self.upstream_port = APND.settings.notification.port.to_i
+
+    #
+    # The device token from Apple
+    #
+    attr_accessor :token
+
+    #
+    # The alert to send
+    #
+    attr_accessor :alert
+
+    #
+    # The badge number to set
+    #
+    attr_accessor :badge
+
+    #
+    # The sound to play
+    #
+    attr_accessor :sound
+
+    #
+    # Custom data to send
+    #
+    attr_accessor :custom
+
+    #
+    # Creates a new socket to upstream_host:upstream_port
+    #
+    def self.upstream_socket
+      @socket = TCPSocket.new(upstream_host, upstream_port)
+    end
+
+    #
+    # Opens a new socket upstream, yields it, and closes it
+    #
+    def self.open_upstream_socket(&block)
+      socket = upstream_socket
+      yield socket
+      socket.close
+    end
+
+    #
+    # Create a new APN
+    #
+    def self.create(params = {}, push = true)
+      notification = Notification.new(params)
+      notification.push! if push
+      notification
+    end
+
+    #
+    # Try to create a new Notification from raw data
+    # Used by Daemon::Protocol to validate incoming data
+    #
+    def self.valid?(data)
+      parse(data)
+    rescue => e
+      puts e.inspect
+      puts e.backtrace
+      false
+    end
+
+    #
+    # Parse raw data into a new Notification
+    #
+    def self.parse(data)
+      buffer = data.dup
+      notification = Notification.new
+
+      header = buffer.slice!(0, 3).unpack('ccc')
+
+      if header[0] != 0
+        raise APND::Errors::InvalidNotificationHeader.new(header)
+      end
+
+      notification.token = buffer.slice!(0, 32).unpack('H*').first
+
+      json_length = buffer.slice!(0, 2).unpack('CC')
+
+      json = buffer.slice!(0, json_length.last)
+
+      payload = JSON.parse(json)
+
+      %w[alert sound badge].each do |key|
+        if payload['aps'] && payload['aps'][key]
+          notification.send("#{key}=", payload['aps'][key])
+        end
+      end
+
+      payload.delete('aps')
+
+      unless payload.empty?
+        notification.custom = payload
+      end
+
+      notification
+    end
+
+    #
+    # Create a new Notification object from a hash
+    #
+    def initialize(params = {})
+      @token  = params[:token]
+      @alert  = params[:alert]
+      @badge  = params[:badge]
+      @sound  = params[:sound]
+      @custom = params[:custom]
+    end
+
+    #
+    # Token in hex format
+    #
+    def hex_token
+      [self.token.delete(' ')].pack('H*')
+    end
+
+    #
+    # aps hash sent to Apple
+    #
+    def aps
+      aps = {}
+      aps['alert'] = self.alert      if self.alert
+      aps['badge'] = self.badge.to_i if self.badge
+      aps['sound'] = self.sound      if self.sound
+
+      output = { 'aps' => aps }
+
+      if self.custom
+        self.custom.each do |key, value|
+          output[key.to_s] = value
+        end
+      end
+      output
+    end
+
+    #
+    # Pushes notification to upstream host:port (default is localhost:22195)
+    #
+    def push!
+      self.class.open_upstream_socket { |sock| sock.write(to_bytes) }
+    end
+
+    #
+    # Returns the Notification's aps hash as json
+    #
+    def aps_json
+      return @aps_json if @aps_json
+      json = aps.to_json
+      raise APND::Errors::InvalidPayload.new(json) if json.size > 256
+      @aps_json = json
+    end
+
+    #
+    # Format the notification as a string for submission
+    # to Apple
+    #
+    def to_bytes
+      @bytes ||= "\0\0 %s\0%s%s" % [hex_token, aps_json.length.chr, aps_json]
+    end
+
+  end
+end

data/lib/apnd/settings.rb

@@ -0,0 +1,205 @@
+module APND
+  #
+  # Settings for APND
+  #
+  class Settings
+
+    #
+    # Settings for APND::Daemon::AppleConnection
+    #
+    class AppleConnection
+
+      #
+      # Host used to connect to Apple
+      #
+      #   Development: gateway.sandbox.push.apple.com
+      #   Production: gateway.push.apple.com
+      #
+      attr_accessor :host
+
+      #
+      # Port used to connect to Apple
+      #
+      attr_accessor :port
+
+      #
+      # Path to APN cert for your application
+      #
+      attr_accessor :cert
+
+      #
+      # Password for APN cert, optional
+      #
+      attr_accessor :cert_pass
+
+      def initialize
+        @host = 'gateway.sandbox.push.apple.com'
+        @port = 2195
+      end
+    end
+
+    #
+    # Settings for APND::Daemon
+    #
+    class Daemon
+
+      #
+      # IP to bind APND::Daemon to
+      #
+      #   Default: '0.0.0.0'
+      #
+      attr_accessor :bind
+
+      #
+      # Port APND::Daemon will run on
+      #
+      #   Default: 22195
+      #
+      attr_accessor :port
+
+      #
+      # Path to APND::Daemon log
+      #
+      #   Default: /var/log/apnd.log
+      #
+      attr_accessor :log_file
+
+      #
+      # Interval (in seconds) the queue will be processed
+      #
+      #   Default: 30
+      #
+      attr_accessor :timer
+
+      def initialize
+        @timer    = 30
+        @bind     = '0.0.0.0'
+        @port     = 22195
+        @log_file = '/var/log/apnd.log'
+      end
+    end
+
+    #
+    # Settings for APND::Notification
+    #
+    class Notification
+
+      #
+      # Host to send notification to, usually the one running APND::Daemon
+      #
+      #   Default: localhost
+      #
+      attr_accessor :host
+
+      #
+      # Port to send notifications to
+      #
+      #   Default: 22195
+      #
+      attr_accessor :port
+
+      def initialize
+        @host = 'localhost'
+        @port = 22195
+      end
+    end
+
+    #
+    # Settings for APND::Feedback
+    #
+    class Feedback
+
+      #
+      # Host used to connect to Apple
+      #
+      #   Development: feedback.sandbox.push.apple.com
+      #   Production: feedback.push.apple.com
+      #
+      attr_accessor :host
+
+      #
+      # Port used to connect to Apple
+      #
+      #   Default: 2196
+      #
+      attr_accessor :port
+
+      def initialize
+        @host = 'feedback.sandbox.push.apple.com'
+        @port = 2196
+      end
+    end
+
+    #
+    # Returns the AppleConnection settings
+    #
+    def apple
+      @apple ||= APND::Settings::AppleConnection.new
+    end
+
+    #
+    # Mass assign AppleConnection settings
+    #
+    def apple=(options = {})
+      if options.respond_to?(:keys)
+        apple.cert      = options[:cert]      if options[:cert]
+        apple.cert_pass = options[:cert_pass] if options[:cert_pass]
+        apple.host      = options[:host]      if options[:host]
+        apple.port      = options[:port]      if options[:port]
+      end
+    end
+
+    #
+    # Returns the Daemon settings
+    #
+    def daemon
+      @daemon ||= APND::Settings::Daemon.new
+    end
+
+    #
+    # Mass assign Daemon settings
+    #
+    def daemon=(options = {})
+      if options.respond_to?(:keys)
+        daemon.bind     = options[:bind]     if options[:bind]
+        daemon.port     = options[:port]     if options[:port]
+        daemon.log_file = options[:log_file] if options[:log_file]
+        daemon.timer    = options[:timer]    if options[:timer]
+      end
+    end
+
+    #
+    # Returns the Notification settings
+    #
+    def notification
+      @notification ||= APND::Settings::Notification.new
+    end
+
+    #
+    # Mass assign Notification settings
+    #
+    def notification=(options = {})
+      if options.respond_to?(:keys)
+        notification.port = options[:port] if options[:port]
+        notification.host = options[:host] if options[:host]
+      end
+    end
+
+    #
+    # Returns the Feedback settings
+    #
+    def feedback
+      @feedback ||= APND::Settings::Feedback.new
+    end
+
+    #
+    # Mass assign Feedback settings
+    #
+    def feedback=(options = {})
+      if options.respond_to?(:keys)
+        feedback.port = options[:port] if options[:port]
+        feedback.host = options[:host] if options[:host]
+      end
+    end
+  end
+end