Push0r 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 743b3cb996a180ba70171eeab749a395c78c6d03
-  data.tar.gz: a1319283af3cd495de24590dcc7967e09b585248
+  metadata.gz: 6fff2260692ade292cbbc87b6f9df4fc214dabda
+  data.tar.gz: 88dc9988dafff0da09a52b3e58bf4fd69bf36235
 SHA512:
-  metadata.gz: 24f684c5e324447760f1c0d6ee19bc75342c5bf7bbe6d19eef0829113ec72b2964765ca08bab76c1c87794b6c0520f75c2a3979a2b7931b37c18d6b37ee3cdc2
-  data.tar.gz: 7d9fc5ae2fc378ddef6c6f7e04b5984440e3ab20624968c03bf89d10418595b17071895731edda9e4d9dc7c1a74996e77d3fc368f5e425cddd0c2299c14d4366
+  metadata.gz: 00aba3ca41d749b4c937f94cb44f1c871fba600eadc37a99a99974a2118e0fa944acf331c436029d46f918af6744266be80b9fb2509a1e51e8e6a30871ae9001
+  data.tar.gz: 7025b1127c3e619495803289416290cd28f67518260ef8bdd0b3c769720edd83ec6db52f46753954636f733f5056c63b17bff7cf2c360498181a28a243640843

data/lib/push0r/APNS/ApnsPushMessage.rb

@@ -1,40 +1,44 @@
 module Push0r
-	# ApnsPushMessage is a {PushMessage} implementation that encapsulates a single push notification to be sent to a single user.
-	class ApnsPushMessage < PushMessage		
-		
-		# Returns a new ApnsPushMessage instance that encapsulates a single push notification to be sent to a single user.
-		# @param receiver_token [String] the apns push token (aka device token) to push the notification to
-		# @param identifier [Fixnum] a unique identifier to identify this push message during error handling. If nil, a random identifier is automatically generated.
-		# @param time_to_live [Fixnum] The time to live in seconds for this push messages. If nil, the time to live is set to zero seconds.
-		def initialize(receiver_token, identifier = nil, time_to_live = nil)
-			if identifier.nil? ## make sure the message has an identifier (required for apns error handling)
-				identifier = Random.rand(2**32)
-			end
-			super(receiver_token, identifier, time_to_live)
-		end
-		
-		# Convenience method to attach common data (that is an alert, a sound or a badge value) to this message's payload.
-		# @param alert_text [String] the alert text to be displayed
-		# @param sound [String] the sound to be played
-		# @param badge [Fixnum] the badge value to be displayed
+  # ApnsPushMessage is a {PushMessage} implementation that encapsulates a single push notification to be sent to a single user.
+  class ApnsPushMessage < PushMessage
+    attr_reader :environment
+
+    # Returns a new ApnsPushMessage instance that encapsulates a single push notification to be sent to a single user.
+    # @param receiver_token [String] the apns push token (aka device token) to push the notification to
+    # @param environment [Fixnum] the environment to use when sending this push message. Defaults to ApnsEnvironment::PRODUCTION.
+    # @param identifier [Fixnum] a unique identifier to identify this push message during error handling. If nil, a random identifier is automatically generated.
+    # @param time_to_live [Fixnum] The time to live in seconds for this push messages. If nil, the time to live is set to zero seconds.
+    def initialize(receiver_token, environment = ApnsEnvironment::PRODUCTION, identifier = nil, time_to_live = nil)
+      if identifier.nil? ## make sure the message has an identifier (required for apns error handling)
+        identifier = Random.rand(2**32)
+      end
+      super(receiver_token, identifier, time_to_live)
+      @environment = environment
+    end
+
+    # Convenience method to attach common data (that is an alert, a sound or a badge value) to this message's payload.
+    # @param alert_text [String] the alert text to be displayed
+    # @param sound [String] the sound to be played
+    # @param badge [Fixnum] the badge value to be displayed
     # @param category [String] the category this message belongs to (see UIUserNotificationCategory in apple's documentation)
-		def simple(alert_text = nil, sound = nil, badge = nil, category = nil)
-			new_payload = {aps: {}}
-			if alert_text
-				new_payload[:aps][:alert] = alert_text
-			end
-			if sound
-				new_payload[:aps][:sound] = sound
-			end
-			if badge
-				new_payload[:aps][:badge] = badge
-			end
+    def simple(alert_text = nil, sound = nil, badge = nil, category = nil)
+      new_payload = {aps: {}}
+      if alert_text
+        new_payload[:aps][:alert] = alert_text
+      end
+      if sound
+        new_payload[:aps][:sound] = sound
+      end
+      if badge
+        new_payload[:aps][:badge] = badge
+      end
       if category
         new_payload[:aps][:category] = category
       end
-			@payload.merge!(new_payload)
-			
-			return self
-		end
-	end
+
+      @payload.merge!(new_payload)
+
+      return self
+    end
+  end
 end

data/lib/push0r/APNS/ApnsService.rb

@@ -1,231 +1,234 @@
 module Push0r
 
-	# A module that contains Apple Push Notification Service error codes
-	module ApnsErrorCodes
-		PROCESSING_ERROR 		= 1
-		MISSING_DEVICE_TOKEN 	= 2
-		MISSING_TOPIC 			= 3
-		MISSING_PAYLOAD 		= 4
-		INVALID_TOKEN_SIZE 		= 5
-		INVALID_TOPIC_SIZE 		= 6
-		INVALID_PAYLOAD_SIZE 	= 7
-		INVALID_TOKEN 			= 8
-		SHUTDOWN 				= 10
-		NONE 					= 255
-	end
-
-	# ApnsService is a {Service} implementation to push notifications to iOS and OSX users using the Apple Push Notification Service.
-	# @example
-	#   queue = Push0r::Queue.new
-	#
-	#   apns_service = Push0r::ApnsService.new(File.read("aps.pem"), true)
-	#   queue.register_service(apns_service)
-	class ApnsService < Service
-
-		# Returns a new ApnsService instance
-		# @param certificate_data [String] the Apple push certificate in PEM format
-		# @param sandbox_environment [Boolean] true if the sandbox push server should be used, otherwise false
-		def initialize(certificate_data, sandbox_environment = false)
-			@certificate_data = certificate_data
-			@sandbox_environment = sandbox_environment
-			@ssl = nil
-			@sock = nil
-			@messages = []
-		end
-
-		# @see Service#can_send?
-		def can_send?(message)
-			return message.is_a?(ApnsPushMessage)
-		end
-
-		# @see Service#send
-		def send(message)
-			@messages << message
-		end
-
-		# @see Service#init_push
-		def init_push
-			# not used for apns
-		end
-
-		# @see Service#end_push
-		def end_push
-			failed_messages = []
-			result = false
-			begin
-				begin
-					setup_ssl(true)
-				rescue SocketError => e
-					puts "Error: #{e}"
-					break
-				end
-				(result, error_message, error_code) = transmit_messages
-				if result == false
-					failed_messages << FailedMessage.new(error_code, [error_message.receiver_token], error_message)
-					reset_message(error_message.identifier)
-					if @messages.empty? then result = true end
-				end
-			end while result != true
-
-			close_ssl
-
-			@messages = [] ## reset
-			return [failed_messages, []]
-		end
-
-		# Calls the APNS feedback service and returns an array of expired push tokens
-		# @return [Array<String>] an array of expired push tokens
-		def get_feedback
-			tokens = []
-
-			begin
-				setup_ssl(true)
-			rescue SocketError => e
-				puts "Error: #{e}"
-				return tokens
-			end
-
-			if IO.select([@ssl], nil, nil, 1)
-				while line = @ssl.read(38)
-					f = line.unpack('N1n1H64')
-					time = Time.at(f[0])
-					token = f[2].scan(/.{8}/).join(" ")
-					tokens << token
-				end
-			end
-
-			close_ssl
-
-			return tokens
-		end
-
-		private
-		def setup_ssl(for_feedback = false)
-			close_ssl
-			ctx = OpenSSL::SSL::SSLContext.new
-
-			ctx.key = OpenSSL::PKey::RSA.new(@certificate_data, '')
-			ctx.cert = OpenSSL::X509::Certificate.new(@certificate_data)
-
-			unless for_feedback
-				@sock = TCPSocket.new(@sandbox_environment ? "gateway.sandbox.push.apple.com" : "gateway.push.apple.com", 2195)
-			else
-				@sock = TCPSocket.new(@sandbox_environment ? "feedback.sandbox.push.apple.com" : "feedback.push.apple.com", 2195)
-			end
-			@ssl = OpenSSL::SSL::SSLSocket.new(@sock, ctx)
-			@ssl.connect
-		end
-
-		def close_ssl
-			if !@ssl.nil? && !@ssl.closed?
-				begin
-					@ssl.close
-				rescue IOError
-				end
-			end
-			@ssl = nil
-			
-			if !@sock.nil? && !@sock.closed?
-				begin
-					@sock.close
-				rescue IOError
-				end
-			end
-			@sock = nil
-		end
-
-		def reset_message(error_identifier)
-			index = @messages.find_index {|o| o.identifier == error_identifier}
-
-			if index.nil? ## this should never happen actually
-				@messages = []
-			elsif index < @messages.length - 1 # reset @messages to contain all messages after the one that has failed
-				@messages = @messages[index+1, @messages.length]
-			else ## the very last message failed, so there's nothing left to be sent
-				@messages = []
-			end
-		end
-
-		def create_push_frame(message)
-			receiver_token = message.receiver_token
-			payload = message.payload
-			identifier = message.identifier
-			time_to_live = (message.time_to_live.nil? || message.time_to_live.to_i < 0) ? 0 : message.time_to_live.to_i
-
-			if receiver_token.nil? then raise(ArgumentError, "receiver_token is nil!") end
-			if payload.nil? then raise(ArgumentError, "payload is nil!") end
-
-			receiver_token = receiver_token.gsub(/\s+/, "")
-			if receiver_token.length != 64 then raise(ArgumentError, "invalid receiver_token length!") end
-
-			devicetoken = [receiver_token].pack('H*')
-			devicetoken_length = [32].pack("n")
-			devicetoken_item = "\1#{devicetoken_length}#{devicetoken}"
-
-			identifier = [identifier.to_i].pack("N")
-			identifier_length = [4].pack("n")
-			identifier_item = "\3#{identifier_length}#{identifier}"
-
-			expiration_date = [(time_to_live > 0 ? Time.now.to_i + time_to_live : 0)].pack("N")
-			expiration_date_length = [4].pack("n")
-			expiration_item = "\4#{expiration_date_length}#{expiration_date}"
-
-			priority = "\xA" ## default: high priority
-			if payload[:aps] && payload[:aps]["content-available"] && payload[:aps]["content-available"].to_i != 0 && (payload[:aps][:alert].nil? && payload[:aps][:sound].nil? && payload[:aps][:badge].nil?)
-				priority = "\5" ## lower priority for content-available pushes without alert/sound/badge
-			end
-
-			priority_length = [1].pack("n")
-			priority_item = "\5#{priority_length}#{priority}"
-
-			payload = payload.to_json.force_encoding("BINARY")
-			payload_length = [payload.bytesize].pack("n")
-			payload_item = "\2#{payload_length}#{payload}"
-
-			frame_length = [devicetoken_item.bytesize + payload_item.bytesize + identifier_item.bytesize + expiration_item.bytesize + priority_item.bytesize].pack("N")
-			frame = "\2#{frame_length}#{devicetoken_item}#{payload_item}#{identifier_item}#{expiration_item}#{priority_item}"
-
-			return frame
-		end
-
-		def transmit_messages
-			if @messages.empty? || @ssl.nil?
-				return [true, nil, nil]
-			end
-
-			pushdata = ""
-			@messages.each do |message|
-				pushdata << create_push_frame(message)
-			end
-
-			@ssl.write(pushdata)
-
-			if IO.select([@ssl], nil, nil, 1)
-				begin
-					read_buffer = @ssl.read(6)
-				rescue Exception
-					return [true, nil, nil]
-				end
-				if !read_buffer.nil?
-					#cmd = read_buffer[0].unpack("C").first
-					error_code = read_buffer[1].unpack("C").first
-					identifier = read_buffer[2,4].unpack("N").first
-					puts "ERROR: APNS returned error code #{error_code} #{identifier}"
-					return [false, message_for_identifier(identifier), error_code]
-				else
-					return [true, nil, nil]
-				end
-			end
-			return [true, nil, nil]
-		end
-
-		def message_for_identifier(identifier)
-			index = @messages.find_index {|o| o.identifier == identifier}
-			if index.nil?
-				return nil
-			else
-				return @messages[index]
-			end
-		end
-	end
+  # A module that contains Apple Push Notification Service error codes
+  module ApnsErrorCodes
+    PROCESSING_ERROR = 1
+    MISSING_DEVICE_TOKEN = 2
+    MISSING_TOPIC = 3
+    MISSING_PAYLOAD = 4
+    INVALID_TOKEN_SIZE = 5
+    INVALID_TOPIC_SIZE = 6
+    INVALID_PAYLOAD_SIZE = 7
+    INVALID_TOKEN = 8
+    SHUTDOWN = 10
+    NONE = 255
+  end
+  
+  module ApnsEnvironment
+    PRODUCTION = 0
+    SANDBOX = 1
+  end
+  
+  # ApnsService is a {Service} implementation to push notifications to iOS and OSX users using the Apple Push Notification Service.
+  # @example
+  #   queue = Push0r::Queue.new
+  #
+  #   apns_service = Push0r::ApnsService.new(File.read("aps.pem"), Push0r::ApnsEnvironment::SANDBOX)
+  #   queue.register_service(apns_service)
+  class ApnsService < Service
+
+    # Returns a new ApnsService instance
+    # @param certificate_data [String] the Apple push certificate in PEM format
+    # @param environment [Fixnum] the environment to use when sending messages. Either ApnsEnvironment::PRODUCTION or ApnsEnvironment::SANDBOX. Defaults to ApnsEnvironment::PRODUCTION.
+    def initialize(certificate_data, environment = ApnsEnvironment::PRODUCTION)
+      @certificate_data = certificate_data
+      @environment = environment
+      @ssl = nil
+      @sock = nil
+      @messages = []
+    end
+
+    # @see Service#can_send?
+    def can_send?(message)
+      return message.is_a?(ApnsPushMessage) && message.environment == @environment
+    end
+
+    # @see Service#send
+    def send(message)
+      @messages << message
+    end
+
+    # @see Service#init_push
+    def init_push
+      # not used for apns
+    end
+
+    # @see Service#end_push
+    def end_push
+      failed_messages = []
+      result = false
+      begin
+        begin
+          setup_ssl(true)
+        rescue SocketError => e
+          puts "Error: #{e}"
+          break
+        end
+        (result, error_message, error_code) = transmit_messages
+        unless result
+          failed_messages << FailedMessage.new(error_code, [error_message.receiver_token], error_message)
+          reset_message(error_message.identifier)
+          result = true if @messages.empty?
+        end
+      end until result
+
+      close_ssl
+
+      @messages = [] ## reset
+      return [failed_messages, []]
+    end
+
+    # Calls the APNS feedback service and returns an array of expired push tokens
+    # @return [Array<String>] an array of expired push tokens
+    def get_feedback
+      tokens = []
+
+      begin
+        setup_ssl(true)
+      rescue SocketError => e
+        puts "Error: #{e}"
+        return tokens
+      end
+
+      if IO.select([@ssl], nil, nil, 1)
+        while (line = @ssl.read(38))
+          f = line.unpack('N1n1H64')
+          time = Time.at(f[0])
+          token = f[2].scan(/.{8}/).join(' ')
+          tokens << token
+        end
+      end
+
+      close_ssl
+
+      return tokens
+    end
+
+    private
+    def setup_ssl(for_feedback = false)
+      close_ssl
+      ctx = OpenSSL::SSL::SSLContext.new
+
+      ctx.key = OpenSSL::PKey::RSA.new(@certificate_data, '')
+      ctx.cert = OpenSSL::X509::Certificate.new(@certificate_data)
+
+      @sock = nil
+      unless for_feedback
+        @sock = TCPSocket.new(@environment == ApnsEnvironment::SANDBOX ? 'gateway.sandbox.push.apple.com' : 'gateway.push.apple.com', 2195)
+      else
+        @sock = TCPSocket.new(@environment == ApnsEnvironment::SANDBOX ? 'feedback.sandbox.push.apple.com' : 'feedback.push.apple.com', 2195)
+      end
+      @ssl = OpenSSL::SSL::SSLSocket.new(@sock, ctx)
+      @ssl.connect
+    end
+
+    def close_ssl
+      if !@ssl.nil? && !@ssl.closed?
+        begin
+          @ssl.close
+        rescue IOError
+        end
+      end
+      @ssl = nil
+
+      if !@sock.nil? && !@sock.closed?
+        begin
+          @sock.close
+        rescue IOError
+        end
+      end
+      @sock = nil
+    end
+
+    def reset_message(error_identifier)
+      index = @messages.find_index { |o| o.identifier == error_identifier }
+
+      if index.nil? ## this should never happen actually
+        @messages = []
+      elsif index < @messages.length - 1 # reset @messages to contain all messages after the one that has failed
+        @messages = @messages[index+1, @messages.length]
+      else ## the very last message failed, so there's nothing left to be sent
+        @messages = []
+      end
+    end
+
+    def create_push_frame(message)
+      receiver_token = message.receiver_token
+      payload = message.payload
+      identifier = message.identifier
+      time_to_live = (message.time_to_live.nil? || message.time_to_live.to_i < 0) ? 0 : message.time_to_live.to_i
+
+      raise(ArgumentError, 'receiver_token is nil!') if receiver_token.nil?
+
+      raise(ArgumentError, 'payload is nil!') if payload.nil?
+
+      receiver_token = receiver_token.gsub(/\s+/, '')
+      raise(ArgumentError, 'invalid receiver_token length!') if receiver_token.length != 64
+
+      devicetoken = [receiver_token].pack('H*')
+      devicetoken_length = [32].pack('n')
+      devicetoken_item = "\1#{devicetoken_length}#{devicetoken}"
+
+      identifier = [identifier.to_i].pack('N')
+      identifier_length = [4].pack('n')
+      identifier_item = "\3#{identifier_length}#{identifier}"
+
+      expiration_date = [(time_to_live > 0 ? Time.now.to_i + time_to_live : 0)].pack('N')
+      expiration_date_length = [4].pack('n')
+      expiration_item = "\4#{expiration_date_length}#{expiration_date}"
+
+      priority = "\xA" ## default: high priority
+      if payload[:aps] && payload[:aps]['content-available'] && payload[:aps]['content-available'].to_i != 0 && (payload[:aps][:alert].nil? && payload[:aps][:sound].nil? && payload[:aps][:badge].nil?)
+        priority = "\5" ## lower priority for content-available pushes without alert/sound/badge
+      end
+
+      priority_length = [1].pack('n')
+      priority_item = "\5#{priority_length}#{priority}"
+
+      payload = payload.to_json.force_encoding('BINARY')
+      payload_length = [payload.bytesize].pack('n')
+      payload_item = "\2#{payload_length}#{payload}"
+
+      frame_length = [devicetoken_item.bytesize + payload_item.bytesize + identifier_item.bytesize + expiration_item.bytesize + priority_item.bytesize].pack('N')
+      frame = "\2#{frame_length}#{devicetoken_item}#{payload_item}#{identifier_item}#{expiration_item}#{priority_item}"
+
+      return frame
+    end
+
+    def transmit_messages
+      if @messages.empty? || @ssl.nil?
+        return [true, nil, nil]
+      end
+
+      pushdata = ''
+      @messages.each do |message|
+        pushdata << create_push_frame(message)
+      end
+
+      @ssl.write(pushdata)
+
+      if IO.select([@ssl], nil, nil, 1)
+        begin
+          read_buffer = @ssl.read(6)
+        rescue Exception
+          return [true, nil, nil]
+        end
+        if !read_buffer.nil?
+          #cmd = read_buffer[0].unpack("C").first
+          error_code = read_buffer[1].unpack('C').first
+          identifier = read_buffer[2, 4].unpack('N').first
+          puts "ERROR: APNS returned error code #{error_code} #{identifier}"
+          return [false, message_for_identifier(identifier), error_code]
+        else
+          return [true, nil, nil]
+        end
+      end
+      return [true, nil, nil]
+    end
+
+    def message_for_identifier(identifier)
+      index = @messages.find_index { |o| o.identifier == identifier }
+      index.nil? ? nil : @messages[index]
+    end
+  end
 end