apnd 0.1.0 → 0.1.1

data/README.markdown

@@ -1,7 +1,7 @@
 # APND
 
 APND (Apple Push Notification Daemon) is a ruby library to send Apple Push
-Notifications (APNs) to iPhones.
+Notifications to iPhones.
 
 Apple recommends application developers create one connection to their
 upstream push notification server, rather than creating one per notification.

data/Rakefile

@@ -11,3 +11,19 @@ desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -r ./lib/apnd.rb -I ./lib"
 end
+
+require 'sdoc_helpers'
+desc "Push a new version to Gemcutter"
+task :publish do
+  require 'apnd/version'
+
+  ver = APND::Version
+
+  sh "gem build apnd.gemspec"
+  sh "gem push apnd-#{ver}.gem"
+  sh "git tag -a -m 'APND v#{ver}' v#{ver}"
+  sh "git push origin v#{ver}"
+  sh "git push origin master"
+  sh "git clean -fd"
+  exec "rake pages"
+end

data/lib/apnd.rb

@@ -8,14 +8,14 @@ module APND
   autoload :Notification, 'apnd/notification'
 
   #
-  # APND Settings
+  # Returns APND::Settings
   #
   def self.settings
     @@settings ||= Settings.new
   end
 
   #
-  # Yields APND Settings
+  # Yields APND::Settings
   #
   def self.configure
     yield settings
@@ -23,6 +23,7 @@ module APND
 
 end
 
-def ohai(message)
+
+def ohai(message) #:nodoc:
   puts "[%s] %s" % [Time.now.strftime("%Y-%m-%d %H:%M:%S"), message]
 end

data/lib/apnd/daemon.rb

@@ -40,21 +40,30 @@ module APND
         end
 
         EventMachine::PeriodicTimer.new(@timer) do
-          count = @queue.size
-          if count > 0
-            ohai "Queue has #{count} item#{count == 1 ? '' : 's'}"
-            count.times do
-              @queue.pop do |notification|
-                begin
-                  ohai "Sending notification"
-                  @apple.write(notification.to_bytes)
-                rescue Errno::EPIPE, OpenSSL::SSL::SSLError
-                  ohai "Error, notification has been added back to the queue"
-                  @queue.push(notification)
-                rescue RuntimeError => error
-                  ohai "Error: #{error}"
-                end
-              end
+          process_notifications!
+        end
+      end
+    end
+
+  private
+
+    #
+    # Sends each notification in the queue upstream to Apple
+    #
+    def process_notifications!
+      count = @queue.size
+      if count > 0
+        ohai "Queue has #{count} item#{count == 1 ? '' : 's'}"
+        count.times do
+          @queue.pop do |notification|
+            begin
+              ohai "Sending notification"
+              @apple.write(notification.to_bytes)
+            rescue Errno::EPIPE, OpenSSL::SSL::SSLError
+              ohai "Error, notification has been added back to the queue"
+              @queue.push(notification)
+            rescue RuntimeError => error
+              ohai "Error: #{error}"
             end
           end
         end

data/lib/apnd/daemon/protocol.rb

@@ -3,13 +3,23 @@ module APND
   # Daemon::Protocol handles incoming APNs
   #
   class Daemon::Protocol < ::EventMachine::Connection
+
+    #
+    # Queue should be the EventMachine queue, see APND::Daemon
+    #
     attr_accessor :queue
 
+    #
+    # Called when a client connection is opened
+    #
     def post_init
       @address = Socket.unpack_sockaddr_in(self.get_peername)
       ohai "#{@address.last}:#{@address.first} opened connection"
     end
 
+    #
+    # Called when a client connection is closed
+    #
     def unbind
       ohai "#{@address.last}:#{@address.first} closed connection"
     end

data/lib/apnd/errors.rb

@@ -1,5 +1,5 @@
 module APND
-  module Errors
+  module Errors #:nodoc: all
 
     #
     # Raised if APN payload is larger than 256 bytes

data/lib/apnd/notification.rb

@@ -7,14 +7,64 @@ module APND
   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
 
-    attr_accessor :token, :alert, :badge, :sound, :custom
+    #
+    # 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
@@ -112,9 +162,7 @@ module APND
     # Pushes notification to upstream host:port (default is localhost:22195)
     #
     def push!
-      socket = TCPSocket.new(self.class.upstream_host, self.class.upstream_port)
-      socket.write(to_bytes)
-      socket.close
+      self.class.open_upstream_socket { |sock| sock.write(to_bytes) }
     end
 
     #

data/lib/apnd/version.rb

@@ -1,8 +1,8 @@
 module APND
-  class Version
+  class Version #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     def self.to_s
       [MAJOR, MINOR, TINY].join('.')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joshua Priddle
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-29 00:00:00 -04:00
+date: 2010-10-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,11 +22,13 @@ dependencies:
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 12
+        - 10
+        version: 0.12.10
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -34,11 +36,13 @@ dependencies:
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -46,14 +50,16 @@ dependencies:
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
+        - 1
         - 0
-        version: "0"
+        version: 1.1.0
   type: :runtime
   version_requirements: *id003
-description: "    APND (Apple Push Notification Daemon) is a ruby library to send Apple Push\n    Notifications (APNs) to iPhones.\n"
+description: "    APND (Apple Push Notification Daemon) is a ruby library to send Apple Push\n    Notifications to iPhones.\n"
 email: jpriddle@nevercraft.net
 executables: 
 - apnd