Push0r 0.4.4 → 0.5.0

data/lib/push0r/Queue.rb

@@ -1,76 +1,76 @@
 module Push0r
-	
-	# A Queue is used to register services to be used to transmit PushMessages. Single PushMessages are then put into the queue and a call to the {#flush} method transmits all enqueued messages using the registered services.  In a sense, Queue is the class that ties all the other Push0r components together.
-	# @example
-	#   queue = Push0r::Queue.new
-	#
-	#   gcm_service = Push0r::GcmService.new("__gcm_api_token__")
-	#   queue.register_service(gcm_service)
-	#
-	#   apns_service = Push0r::ApnsService.new(File.read("aps.pem"), true)
-	#   queue.register_service(apns_service)
-	#
-	#   gcm_message = Push0r::GcmPushMessage.new("__registration_id__")
-	#   gcm_message.attach({"data" => {"d" => "1"}})
-	#
-	#   apns_message = Push0r::ApnsPushMessage.new("__device_token__")
-	#   apns_message.attach({"data" => {"v" => "1"}}
-	#
-	#   queue.add(gcm_message)
-	#   queue.add(apns_message)
-	#
-	#   queue.flush
-	class Queue
-		def initialize
-			@services = []
-			@queued_messages = {}
-		end
-	
-		# Registers a Service with the Queue
-		# @note Every service can only be registered once with the same queue
-		# @param service [Service] the service to be registered with the queue
-		# @return [void]
-		# @see Service
-		def register_service(service)
-			unless @services.include?(service)
-				@services << service
-			end
-		end
-	
-		# Adds a PushMessage to the queue
-		# @param message [PushMessage] the message to be added to the queue
-		# @return [Boolean] true if message was added to the queue (that is: if any of the registered services can handle the message), otherwise false
-		# @see PushMessage
-		def add(message)
-			@services.each do |service|
-				if service.can_send?(message)
-					if @queued_messages[service].nil?
-						@queued_messages[service] = []
-					end
-					@queued_messages[service] << message
-					return true
-				end
-			end
-			return false
-		end
-	
-		# Flushes the queue by transmitting the enqueued messages using the registered services
-		# @return [FlushResult] the result of the operation
-		def flush
-			failed_messages = []
-			new_token_messages = []
-			
-			@queued_messages.each do |service, messages|
-				service.init_push
-				messages.each do |message|
-					service.send(message)
-				end
-				(failed, new_token) = service.end_push
-				failed_messages += failed
-				new_token_messages += new_token
-			end
-			@queued_messages = {}
-			return FlushResult.new(failed_messages, new_token_messages)
-		end
-	end
+
+  # A Queue is used to register services to be used to transmit PushMessages. Single PushMessages are then put into the queue and a call to the {#flush} method transmits all enqueued messages using the registered services.  In a sense, Queue is the class that ties all the other Push0r components together.
+  # @example
+  #   queue = Push0r::Queue.new
+  #
+  #   gcm_service = Push0r::GcmService.new("__gcm_api_token__")
+  #   queue.register_service(gcm_service)
+  #
+  #   apns_service = Push0r::ApnsService.new(File.read("aps.pem"), true)
+  #   queue.register_service(apns_service)
+  #
+  #   gcm_message = Push0r::GcmPushMessage.new("__registration_id__")
+  #   gcm_message.attach({"data" => {"d" => "1"}})
+  #
+  #   apns_message = Push0r::ApnsPushMessage.new("__device_token__")
+  #   apns_message.attach({"data" => {"v" => "1"}}
+  #
+  #   queue.add(gcm_message)
+  #   queue.add(apns_message)
+  #
+  #   queue.flush
+  class Queue
+    def initialize
+      @services = []
+      @queued_messages = {}
+    end
+
+    # Registers a Service with the Queue
+    # @note Every service can only be registered once with the same queue
+    # @param service [Service] the service to be registered with the queue
+    # @return [void]
+    # @see Service
+    def register_service(service)
+      unless @services.include?(service)
+        @services << service
+      end
+    end
+
+    # Adds a PushMessage to the queue
+    # @param message [PushMessage] the message to be added to the queue
+    # @return [Boolean] true if message was added to the queue (that is: if any of the registered services can handle the message), otherwise false
+    # @see PushMessage
+    def add(message)
+      @services.each do |service|
+        if service.can_send?(message)
+          if @queued_messages[service].nil?
+            @queued_messages[service] = []
+          end
+          @queued_messages[service] << message
+          return true
+        end
+      end
+      return false
+    end
+
+    # Flushes the queue by transmitting the enqueued messages using the registered services
+    # @return [FlushResult] the result of the operation
+    def flush
+      failed_messages = []
+      new_token_messages = []
+
+      @queued_messages.each do |service, messages|
+        service.init_push
+        messages.each do |message|
+          service.send(message)
+        end
+        (failed, new_token) = service.end_push
+        failed_messages += failed
+        new_token_messages += new_token
+      end
+      @queued_messages = {}
+      return FlushResult.new(failed_messages, new_token_messages)
+    end
+  end
 end

data/lib/push0r/Service.rb

@@ -1,51 +1,51 @@
 module Push0r
-	module ErrorCodes
-		NO_ERROR = -1
-	end
+  module ErrorCodes
+    NO_ERROR = -1
+  end
 
-	# Service is the base class for all implemented push services. A Service encapsulates everything that is necessary to take a batch of push notifications and transmit it to the receivers.
-	# @abstract
-	class Service
+  # Service is the base class for all implemented push services. A Service encapsulates everything that is necessary to take a batch of push notifications and transmit it to the receivers.
+  # @abstract
+  class Service
 
-		# Called on the service every time a PushMessage is added to a Queue in order to determine whether it can send the given message.
-		# @param message [PushMessage] the message
-		# @return [Boolean] true if this service can send the given message, otherwise false
-		# @abstract
-		# @see PushMessage
-		# @see Queue
-		def can_send?(message)
-			return false
-		end
+    # Called on the service every time a PushMessage is added to a Queue in order to determine whether it can send the given message.
+    # @param message [PushMessage] the message
+    # @return [Boolean] true if this service can send the given message, otherwise false
+    # @abstract
+    # @see PushMessage
+    # @see Queue
+    def can_send?(message)
+      return false
+    end
 
-		# Sends a single push message. This is called during the flushing of a Queue for every enqueued PushMessage. The service may create its own internal queue in order to efficiently batch the messages.
-		# @param message [PushMessage] the message to be sent
-		# @return [void]
-		# @abstract
-		# @see PushMessage
-		# @see Queue
-		def send(message)
-			## empty
-		end
+    # Sends a single push message. This is called during the flushing of a Queue for every enqueued PushMessage. The service may create its own internal queue in order to efficiently batch the messages.
+    # @param message [PushMessage] the message to be sent
+    # @return [void]
+    # @abstract
+    # @see PushMessage
+    # @see Queue
+    def send(message)
+      ## empty
+    end
 
-		# Called on the service during the flushing of a Queue before the first PushMessage is sent.
-		# @return [void]
-		# @abstract
-		# @see PushMessage
-		# @see Queue
-		def init_push
-			## empty
-		end
+    # Called on the service during the flushing of a Queue before the first PushMessage is sent.
+    # @return [void]
+    # @abstract
+    # @see PushMessage
+    # @see Queue
+    def init_push
+      ## empty
+    end
 
-		# Called on the service during the flushing of a Queue after the last PushMessage has been sent. If the service manages its own internal queue, this is the place to actually transmit all messages.
-		# @return [Array(Array<String>, Array<String>)] Failed new RegId Messages
-		# @abstract
-		# @see PushMessage
-		# @see Queue
-		def end_push
-			## empty
-			return [[], []]
-		end
-	end
+    # Called on the service during the flushing of a Queue after the last PushMessage has been sent. If the service manages its own internal queue, this is the place to actually transmit all messages.
+    # @return [Array(Array<String>, Array<String>)] Failed new RegId Messages
+    # @abstract
+    # @see PushMessage
+    # @see Queue
+    def end_push
+      ## empty
+      return [[], []]
+    end
+  end
 end
 
 require_relative 'APNS/ApnsService'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Push0r
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Kai Straßmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,3 +64,4 @@ signing_key:
 specification_version: 4
 summary: Push0r gem
 test_files: []
+has_rdoc: