apnd 0.1.4 → 0.1.5

data/README.markdown

@@ -83,12 +83,32 @@ push notifications to APND.
     APND::Notification.upstream_host = 'localhost'
     APND::Notification.upstream_port = 22195
 
-    notification = APND::Notification.create(
+    notification1 = APND::Notification.new(
       :alert  => 'Alert!',
       :token  => 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2',
+      :badge  => 1
+    )
+
+    notification2 = APND::Notification.new(
+      :alert  => 'Red Alert!',
+      :token  => 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2',
       :badge  => 99
     )
 
+    # Send multiple notifications at once to avoid overhead in
+    # opening/closing the upstream socket connection each time
+    APND::Notification.open_upstream_socket do |sock|
+      sock.puts notification1
+      sock.puts notification2
+    end
+
+    # Send a notification to the upstream socket immediately
+    notification3 = APND::Notification.create(
+      :alert  => 'Alert!',
+      :token  => 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2',
+      :badge  => 0
+    )
+
 
 ## Prerequisites
 
@@ -105,6 +125,9 @@ at [developer.apple.com](http://developer.apple.com/).
 
 Ruby must be compiled with OpenSSL support.
 
+Tests use [Shoulda](http://github.com/thoughtbot/shoulda), and optionally
+[TURN](https://github.com/TwP/turn).
+
 
 ## Installation
 

data/lib/apnd/daemon.rb

@@ -34,7 +34,7 @@ module APND
     #
     def run!
       EventMachine::run do
-        ohai "Starting APND Daemon on #{@bind}:#{@port}"
+        ohai "Starting APND Daemon v#{APND::Version} on #{@bind}:#{@port}"
         EventMachine::start_server(@bind, @port, APND::Daemon::Protocol) do |server|
           server.queue = @queue
         end

data/lib/apnd/errors.rb

@@ -9,5 +9,14 @@ module APND
         super("Payload is larger than 256 bytes: '#{message}'")
       end
     end
+
+    #
+    # Raised when parsing a Notification with an invalid header
+    #
+    class InvalidNotificationHeader < StandardError
+      def initialize(header)
+        super("Invalid Notification header: #{header.inspect}")
+      end
+    end
   end
 end

data/lib/apnd/notification.rb

@@ -81,6 +81,8 @@ module APND
     #
     def self.valid?(data)
       parse(data)
+    rescue
+      false
     end
 
     #
@@ -93,7 +95,7 @@ module APND
       header = buffer.slice!(0, 3).unpack('ccc')
 
       if header[0] != 0
-        raise RuntimeError, "Invalid Notification header: #{header.inspect}"
+        raise APND::Errors::InvalidNotificationHeader.new(header)
       end
 
       notification.token = buffer.slice!(0, 32).unpack('H*').first
@@ -117,8 +119,6 @@ module APND
       end
 
       notification
-    rescue
-      false
     end
 
     #
@@ -171,7 +171,7 @@ module APND
     def aps_json
       return @aps_json if @aps_json
       json = aps.to_json
-      raise APND::InvalidPayload.new(json) if json.size > 256
+      raise APND::Errors::InvalidPayload.new(json) if json.size > 256
       @aps_json = json
     end
 

data/lib/apnd/settings.rb

@@ -111,6 +111,18 @@ module APND
       @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
     #
@@ -118,11 +130,33 @@ module APND
       @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
   end
 end

data/lib/apnd/version.rb

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

data/test/apnd_test.rb

@@ -1,40 +1,69 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-context "APND" do
-  setup do
-    @bytes = %|\000\000 \376\025\242}]\363\303Gx\336\373\037O8\200&\\\305,\f\004v\202";\345\237\266\205\000\251\242\000;{"aps":{"sound":"default","alert":"Red Alert, Numba One!"}}|
-    @notification = APND::Notification.new({
-      :token => 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2',
-      :alert => 'Red Alert, Numba One!',
-      :sound => 'default'
-    })
-  end
+class APNDTest < Test::Unit::TestCase
+  @@bytes = %|\000\000 \376\025\242}]\363\303Gx\336\373\037O8\200&\\\305,\f\004v\202\";\345\237\266\205\000\251\242\000\\{\"location\":\"New York\",\"aps\":{\"badge\":10,\"sound\":\"default\",\"alert\":\"Red Alert, Numba One!\"}}|
 
-  test "Notification returns a valid hex_token" do
-    expected = %|\376\025\242}]\363\303Gx\336\373\037O8\200&\\\305,\f\004v\202";\345\237\266\205\000\251\242|
-    assert_equal @notification.hex_token, expected
-  end
+  context "APND Notification" do
+    setup do
+      @notification = APND::Notification.new({
+        :token  => 'fe15a27d5df3c34778defb1f4f3880265cc52c0c047682223be59fb68500a9a2',
+        :alert  => 'Red Alert, Numba One!',
+        :sound  => 'default',
+        :badge  => 10,
+        :custom => { 'location' => 'New York' }
+      })
+    end
 
-  test "Notification returns a valid byte string for Apple" do
-    assert_equal @notification.to_bytes, @bytes
-  end
+    context "instances" do
+      should "be initialized with a hash of options" do
+        [:token, :alert, :sound, :badge, :custom].each do |key|
+          assert_not_nil @notification.send(key)
+        end
+      end
+
+      should "return a valid hex_token" do
+        expected = %|\376\025\242}]\363\303Gx\336\373\037O8\200&\\\305,\f\004v\202";\345\237\266\205\000\251\242|
+        assert_equal @notification.hex_token, expected
+      end
 
-  test "Notification.parse returns a Notification when given a valid string" do
-    notification = APND::Notification.parse(@bytes)
+      should "return a valid byte string" do
+        assert_equal @notification.to_bytes, @@bytes
+      end
+    end
+
+    should "parse a valid packet" do
+      notification = APND::Notification.parse(@@bytes)
 
-    assert notification
+      assert notification
 
-    [:alert, :badge, :custom, :sound, :token, :hex_token, :to_bytes, :aps, :aps_json].each do |key|
-      assert_equal @notification.send(key), notification.send(key)
+      [:alert, :badge, :custom, :sound, :token, :hex_token, :to_bytes, :aps, :aps_json].each do |key|
+        assert_equal @notification.send(key), notification.send(key)
+      end
     end
 
-    assert ! APND::Notification.parse("I'm not a packet!")
+    should "raise InvalidNotificationHeader parsing a bad packet" do
+      assert_raise APND::Errors::InvalidNotificationHeader do
+        APND::Notification.parse("I'm not a packet!")
+      end
+    end
+
+    should "raise InvalidPayload if custom hash is too large" do
+      assert_raise APND::Errors::InvalidPayload do
+        notification = @notification.dup
+        notification.custom = {
+          'lorem' => "Hi! " * 200
+        }
+        APND::Notification.parse(notification.to_bytes)
+      end
+    end
   end
 
-  test "Notification multiple apns to be sent" do
-    notifications = [@bytes, @bytes, @bytes].join("\n")
-    notifications.each_line do |line|
-      assert APND::Notification.valid?(line)
+  context "APND Daemon" do
+    should "receive multiple Notifications in a single packet" do
+      notifications = [@@bytes, @@bytes, @@bytes].join("\n")
+      notifications.each_line do |line|
+        assert APND::Notification.valid?(line)
+      end
     end
   end
 

data/test/test_helper.rb

@@ -1,33 +1,10 @@
 require 'rubygems'
 require 'test/unit'
-
-dir = File.dirname(File.expand_path(__FILE__))
-$LOAD_PATH.unshift(File.join(dir, '..', 'lib'))
-$LOAD_PATH.unshift(dir)
-
-require 'apnd'
+require 'shoulda'
 
 begin
   require 'turn'
 rescue LoadError
 end
 
-##
-# test/spec/mini 3
-# http://gist.github.com/25455
-# chris@ozmm.org
-#
-def context(*args, &block)
-  return super unless (name = args.first) && block
-  require 'test/unit'
-  klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
-    def self.test(name, &block)
-      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
-    end
-    def self.xtest(*args) end
-    def self.setup(&block) define_method(:setup, &block) end
-    def self.teardown(&block) define_method(:teardown, &block) end
-  end
-  (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
-  klass.class_eval &block
-end
+require 'apnd'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Joshua Priddle
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 -05:00
+date: 2010-12-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,18 @@ dependencies:
         version: 1.1.0
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: "    APND (Apple Push Notification Daemon) is a ruby library to send Apple Push\n    Notifications to iPhones.\n"
 email: jpriddle@nevercraft.net
 executables: