apple_shove 1.0.2 → 1.1.0

data/README.md

@@ -37,6 +37,21 @@ Willing to give it a try? Onward...
 
 ## Usage
 
+### Quick Note on Certificate/Key Handling
+
+AppleShove expects certificates and keys to be bundled together in PKCS#12 PEM format. If you want to test the validity of your PKCS#12 file, you can do something similar to this:
+
+    apns_p12 = File.read('my_cert.p12')
+    begin
+        AppleShove.try_p12(apns_p12)
+    rescue Exception => e
+        puts "the PKCS#12 file is invalid: #{e.message}"
+    else
+        puts "it's valid!"
+    end
+
+If you send a notification with an invalid PKCS#12 file, the notification will fail downstream.
+
 ### Sending Notifications
 
 Sending a notification request looks like this:
@@ -81,6 +96,8 @@ We also have a feedback mechanism in place:
 
 ## Installation
 
+If you haven't already, install redis. It's normally available via brew, apt-get, and yum, but you can also build from [source](http://redis.io/download).
+
 Add this line to your application's Gemfile:
 
     gem 'apple_shove'

data/lib/apple_shove/apns/connection.rb

@@ -6,10 +6,12 @@ module AppleShove
       
       attr_reader :last_used
       
-      def initialize(opts = {})
-        @host         = opts[:host]
-        @port         = opts[:port]
-        @certificate  = opts[:certificate]
+      def initialize(host, port, p12_string)
+        @host       = host
+        @port       = port
+        @p12_string = p12_string
+
+        @p12        = nil
       end
 
       # lazy connect the socket
@@ -31,12 +33,13 @@ module AppleShove
       private
       
       def connect
-        @sock = TCPSocket.new(@host, @port)
-        @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
-
+        @p12          ||= OpenSSLHelper.pkcs12_from_pem(@p12_string)
         context         = ::OpenSSL::SSL::SSLContext.new
-        context.cert    = ::OpenSSL::X509::Certificate.new(@certificate)
-        context.key     = ::OpenSSL::PKey::RSA.new(@certificate) 
+        context.cert    = @p12.certificate
+        context.key     = @p12.key
+
+        @sock           = TCPSocket.new(@host, @port)
+        @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
         @ssl_sock       = ::OpenSSL::SSL::SSLSocket.new(@sock, context)
         @ssl_sock.sync  = true
         
@@ -49,4 +52,4 @@ module AppleShove
             
     end
   end
-end
+end

data/lib/apple_shove/apns/feedback_connection.rb

@@ -2,12 +2,10 @@ module AppleShove
   module APNS
     class FeedbackConnection < Connection
 
-      def initialize(opts = {})
+      def initialize(p12, sandbox)
         host = "feedback.#{opts[:sandbox] ? 'sandbox.' : ''}push.apple.com"
 
-        super certificate:  opts[:certificate],
-              host:         host,
-              port:         2196
+        super host, 2196, p12
       end
 
       def device_tokens

data/lib/apple_shove/apns/notify_connection.rb

@@ -8,20 +8,18 @@ module AppleShove
       attr_accessor :pending_notifications
       attr_reader :name
 
-      def initialize(opts = {})
-        @name = self.class.generate_name(opts[:certificate], opts[:sandbox])
+      def initialize(p12, sandbox)
+        @name = self.class.generate_name(p12, sandbox)
         @last_message           = nil
         @pending_notifications  = 0
 
-        host = "gateway.#{opts[:sandbox] ? 'sandbox.' : ''}push.apple.com"
+        host = "gateway.#{sandbox ? 'sandbox.' : ''}push.apple.com"
 
-        super certificate:  opts[:certificate],
-              host:         host,
-              port:         2195
+        super host, 2195, p12
       end
 
-      def self.generate_name(certificate, sandbox)
-        Digest::SHA1.hexdigest("#{certificate}#{sandbox}")
+      def self.generate_name(p12, sandbox)
+        Digest::SHA1.hexdigest("#{p12}#{sandbox}")
       end
 
       exclusive
@@ -35,34 +33,37 @@ module AppleShove
         message = notification.binary_message
 
         if @last_used && Time.now - @last_used > CONFIG[:reconnect_timer] * 60
-          Logger.info("#{@name}\trefreshing connection")
+          Logger.info("refreshing connection", self, notification)
           reconnect
         end
         
         begin
           socket.write message
         rescue Errno::EPIPE
-          Logger.warn("#{@name}\tbroken pipe. reconnecting.")
+          Logger.warn("broken pipe. reconnecting.", self, notification)
           reconnect
           # EPIPE raises on the second write to a closed pipe. We need to resend
           # the previous notification that didn't make it through.
           socket.write @last_message if @last_message 
           retry
         rescue Errno::ETIMEDOUT
-          Logger.warn("#{@name}\ttimeout. reconnecting.")
+          Logger.warn("timeout. reconnecting.", self, notification)
           reconnect
           retry
+        rescue Exception => e
+          Logger.error("error sending notification: #{e.message}", self, notification)
+        else
+          Logger.info("delivered notification", self, notification)
         end
-        
+
         @last_message = message
         @last_used    = Time.now
         @pending_notifications -= 1
-        Logger.info("#{@name}\tdelivered notification")
       end
 
       def shutdown
         while @pending_notifications > 0
-          Logger.info("#{@name}\twaiting to shut down. #{@pending_notifications} job(s) remaining.")
+          Logger.info("waiting to shut down. #{@pending_notifications} job(s) remaining.", self)
           sleep 1
         end
 
@@ -72,4 +73,4 @@ module AppleShove
 
     end
   end
-end
+end

data/lib/apple_shove/apple_shove.rb

@@ -1,7 +1,7 @@
 module AppleShove
 
-  def self.notify(certificate, device_token, payload, sandbox = false)
-    notification  = Notification.new  certificate:  certificate,
+  def self.notify(p12, device_token, payload, sandbox = false)
+    notification  = Notification.new  p12:          p12,
                                       device_token: device_token,
                                       payload:      payload,
                                       sandbox:      sandbox
@@ -12,9 +12,8 @@ module AppleShove
     true
   end
 
-  def self.feedback_tokens(certificate, sandbox = false)
-    conn = APNS::FeedbackConnection.new certificate:  certificate,
-                                        sandbox:      sandbox
+  def self.feedback_tokens(p12, sandbox = false)
+    conn = APNS::FeedbackConnection.new p12, sandbox
 
     conn.device_tokens
   end
@@ -30,4 +29,10 @@ module AppleShove
     "queue size:\t#{size}"
   end
 
+  # raises an exception if the p12 string is invalid
+  def self.try_p12(p12)
+    OpenSSLHelper.pkcs12_from_pem(p12)
+    true
+  end
+  
 end

data/lib/apple_shove/demultiplexer.rb

@@ -31,16 +31,15 @@ module AppleShove
     private
 
     def get_connection(notification)
-      key         = APNS::NotifyConnection.generate_name(notification.certificate, notification.sandbox)
+      key         = APNS::NotifyConnection.generate_name(notification.p12, notification.sandbox)
       connection  = @connections[key] 
 
       unless connection
         retire_oldest_connection if @connections.count >= @max_connections
 
-        connection        = APNS::NotifyConnection.new  certificate: notification.certificate,
-                                                        sandbox:     notification.sandbox
+        connection        = APNS::NotifyConnection.new notification.p12, notification.sandbox
         @connections[key] = connection
-        Logger.info "#{connection.name}\tcreated connection to APNS (#{@connections.count} total)"  
+        Logger.info "created connection to APNS (#{@connections.count} total)", connection  
       end
     
       connection
@@ -53,7 +52,7 @@ module AppleShove
         @connections.delete key
         conn.shutdown
         
-        Logger.info "#{conn_name}\tdestroyed connection to APNS (#{@connections.count} total)"
+        Logger.info "destroyed connection to APNS (#{@connections.count} total)", connection
       end
     end
     

data/lib/apple_shove/logger.rb

@@ -19,11 +19,35 @@ module AppleShove
       self
     end
         
-    def self.error(msg); instance.error(msg) end
-    def self.debug(msg); instance.debug(msg) end
-    def self.fatal(msg); instance.fatal(msg) end
-    def self.info(msg); instance.info(msg) end
-    def self.warn(msg); instance.warn(msg) end
-    
+    def self.error(msg, connection = nil, notification = nil)
+      log('error', msg, connection, notification) 
+    end
+
+    def self.debug(msg, connection = nil, notification = nil)
+      log('debug', msg, connection, notification) 
+    end
+
+    def self.fatal(msg, connection = nil, notification = nil)
+      log('fatal', msg, connection, notification) 
+    end
+
+    def self.info(msg, connection = nil, notification = nil)
+      log('info', msg, connection, notification) 
+    end
+
+    def self.warn(msg, connection = nil, notification = nil)
+      log('warn', msg, connection, notification) 
+    end
+
+    private
+
+    def self.log(severity, msg, connection, notification)
+      output = ''
+      output += "#{connection.name}\t" if connection && connection.respond_to?("name")
+      output += "#{notification.device_token}\t" if notification
+      output += msg
+      
+      instance.send(severity, output)
+    end
   end
 end

data/lib/apple_shove/notification.rb

@@ -1,7 +1,7 @@
 module AppleShove
   class Notification
 
-    attr_accessor :certificate, :sandbox, :device_token, :payload
+    attr_accessor :p12, :sandbox, :device_token, :payload
     
     def initialize(attributes = {})
         attributes.each { |k, v| self.send("#{k}=", v) }
@@ -31,4 +31,4 @@ module AppleShove
     end
                
   end
-end
+end

data/lib/apple_shove/openssl_helper.rb

@@ -0,0 +1,15 @@
+require 'openssl'
+
+module AppleShove
+  class OpenSSLHelper
+    
+    def self.pkcs12_from_pem(p12_pem)
+      key  = ::OpenSSL::PKey::RSA.new         p12_pem
+      cert = ::OpenSSL::X509::Certificate.new p12_pem
+      p12  = ::OpenSSL::PKCS12.create nil, nil, key, cert
+
+      p12
+    end
+
+  end
+end

data/lib/apple_shove/version.rb

@@ -1,3 +1,3 @@
 module AppleShove
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/spec/apple_shove_spec.rb

@@ -0,0 +1,10 @@
+require 'apple_shove'
+
+describe AppleShove do
+
+  it 'detects an invalid p12' do
+    p12 = 'this is an invalid p12'
+    expect { AppleShove.try_p12(p12) }.to raise_error
+  end
+
+end

data/spec/notification_helper.rb

@@ -1,12 +1,12 @@
 module NotificationHelper
 
   def generate_notification
-    certificate   = "DummyCertificate"
+    p12           = "DummyP12"
     sandbox       = false
     device_token  = hex(64)
     payload       = { mdm: "#{hex(8)}-#{hex(4)}-#{hex(4)}-#{hex(4)}-#{hex(12)}".downcase }
   
-    AppleShove::Notification.new  certificate:  certificate,
+    AppleShove::Notification.new  p12:          p12,
                                   sandbox:      sandbox,
                                   device_token: device_token,
                                   payload:      payload

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apple_shove
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,10 +130,12 @@ files:
 - lib/apple_shove/logger.rb
 - lib/apple_shove/notification.rb
 - lib/apple_shove/notification_queue.rb
+- lib/apple_shove/openssl_helper.rb
 - lib/apple_shove/tasks.rb
 - lib/apple_shove/version.rb
 - lib/tasks/apple_shove.rake
 - script/daemon
+- spec/apple_shove_spec.rb
 - spec/demultiplexer_spec.rb
 - spec/notification_helper.rb
 - spec/notification_queue_spec.rb
@@ -153,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3074046605150142324
+      hash: 2826984217209674541
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3074046605150142324
+      hash: 2826984217209674541
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -170,6 +172,7 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
+- spec/apple_shove_spec.rb
 - spec/demultiplexer_spec.rb
 - spec/notification_helper.rb
 - spec/notification_queue_spec.rb