apn_sender 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d85dcde79eb0f21533547c631b827e73081d5167
-  data.tar.gz: a3bd028152b5f7ee6960b1516bf87b2fa7abdce8
+  metadata.gz: e9297870e306966d00d3d0acf01a3022dbbb1636
+  data.tar.gz: 25b8a81befe782fba5a0b7f0376ce9491f674a86
 SHA512:
-  metadata.gz: 96a448c4a6d1ed2fcc9807617eea4171e876ef45f7dd94b41925ca84c81f656404ef526ab590f7d30612571bd3ecab4f47621aabe44aeb66c5c3909b89794da5
-  data.tar.gz: 12b386591581bdcb234d0dd90de44f0836ad27705aedeeefcc6e0333d5225207fdabd0e085c0cf2675abfbbed1b725d716611ca859ea06c60a6ffe9cb1385a46
+  metadata.gz: 5048150d58ffba87b276ebe50d24bd1ab744f6eefa58ac94662cf22b5b773fde19fa66b840c1c982303693460d0d53283606aa9a0af7f99f04a6e4eb6802e634
+  data.tar.gz: ef4fc9e0ce014ac4bef75d1da4f858ae6317a86bed03aa09e8ca1f248e9b9cffef8f9a5ec2939024fb7db4ee89cfe87e91dcc0bb2c302a581cfcb8a38466f126

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Version 2.0
+## 2.0.1
+- Use bytesize to truncate alert when necessary
+- Better calculation on payload size. (botvinik)
+- Fix generating payload should use bytesize. (piotr-sokolowski)
+- Rescuing and repairing broken connections (Arseniy Ivanov)
+
 ## 2.0.0
 - adding connection_pool for handle apple sockets
 - removing resque hard dependency

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Kali Donovan
+Copyright (c) 2013 Arthur Nogueira Neves
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,32 +1,33 @@
 [![Code Climate](https://codeclimate.com/github/arthurnn/apn_sender.png)](https://codeclimate.com/github/arthurnn/apn_sender)
 [![Build Status](https://travis-ci.org/arthurnn/apn_sender.png)](https://travis-ci.org/arthurnn/apn_sender)
 
-## UPDATE May 3, 2013: current status
-
-This project was not supported for a while, but we are going to support it again.
-
------
-
 ## Synopsis
 
 Need to send background notifications to an iPhone application over a <em>persistent</em> connection in Ruby? Keep reading...
 
 ## The Story
 
-So you're building the server component of an iPhone application in Ruby.  And you want to send background notifications through the Apple Push Notification servers, which doesn't seem too bad at first.  But then you read in the [Apple Documentation](https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Introduction.html) that Apple's servers may treat non-persistent connections as a Denial of Service attack, and you realize that Rails has no easy way to maintain a persistent connection internally, and things start looking more complicated.
+So you're building the server component of an iPhone application in Ruby and you want to send background notifications through the Apple Push Notification servers. This doesn't seem too bad at first, but then you read in the [Apple Documentation](https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Introduction.html) that Apple's servers may treat non-persistent connections as a Denial of Service attack. Since Rails has no easy way to maintain a persistent connection internally, things start to look complicated.
 
-The apn_sender gem includes a background daemon which processes background messages from your application and sends them along to Apple <em>over a single, persistent socket</em>.  It also includes the ability to query the Feedback service, helper methods for enqueueing your jobs, and a sample monit config to make sure the background worker is around when you need it.
+This gem includes a background daemon which processes background messages from your application and sends them along to Apple <em>over a single, persistent socket</em>.  It also includes the ability to query the Feedback service, helper methods for enqueueing your jobs, and a sample monit config to make sure the background worker is around when you need it.
 
 ## Yet another ApplePushNotification interface?
 
 Yup.  There's some great code out there already, but we didn't like the idea of getting banned from the APN gateway for establishing a new connection each time we needed to send a batch of messages, and none of the libraries I found handled maintaining a persistent connection.
 
 ## Current Status
-This gem has been used in production, on 500px, sending millions of notifications.
+
+This gem has been used in production, on [500px](http://500px.com), sending hundreds of millions, if not, billions of notifications.
 
 ## Usage
 
-### 1. Queueing Messages From Your Application
+APN sender can use [Resque](http://github.com/defunkt/resque) or [Sidekiq](https://github.com/mperham/sidekiq) to send asynchronous messages, if none of them are installed it creates a new thread to send messages.
+
+### 1. Use a background processor or not.
+
+You can either use Resque or Sidekiq, I strongly advice using Sidekiq, as apn_sender uses a connection pool for the apple socks. To use apn_sender with one of them you dont have to do anything, just include the background processor gem into your gemfile and it will all work. 
+
+### 2. Queueing Messages From Your Application
 
 To queue a message for sending through Apple's Push Notification service from your Rails application:
 
@@ -34,44 +35,33 @@ To queue a message for sending through Apple's Push Notification service from yo
 APN.notify_async(token, opts_hash)
 ```
 
-where ```token``` is the unique identifier of the iPhone to receive the notification and ```opts_hash``` can have any of the following keys:
-
-Options:
+Where ```token``` is the unique identifier of the iPhone to receive the notification and ```opts_hash``` can have any of the following keys:
 
 * :alert  ## The alert to send
 * :badge  ## The badge number to send
 * :sound  ## The sound file to play on receipt, or true to play the default sound installed with your app
 
-
 If any other keys are present they'll be be passed along as custom data to your application.
 
-### 2. Sending Queued Messages
+### 3. Sending Queued Messages
 
 Put your ```apn_development.pem``` and ```apn_production.pem``` certificates from Apple in your ```RAILS_ROOT/config/certs``` directory.
 
-Once this is done, you can fire off a background worker with
+You also can configure some extra settings:
 
 ```
-$ rake apn:sender
-```
-
-For production, you're probably better off running a dedicated daemon and setting up monit to watch over it for you.  Luckily, that's pretty easy:
-
-```
- # To generate daemon
-./script/generate apn_sender
-
- # To run daemon. Pass --help to print all options
-./script/apn_sender start
+APN.root = 'RAILS_ROOT/config/certs' # root to certificates folder
+APN.certificate_name = 'apn_production.pem' # certificate filename
+APN.host = 'apple host (on development sandbox url is used by default)'
+APN.password = 'certificate_password'
+APN.pool_size = 1 # number of connections on the pool
+APN.pool_timeout = 5 # timeout in seconds for connection pool
 ```
 
-
-Also, there are two similar options: ```:cert_path``` and ```:full_cert_path```.  The former specifies the directory in which to find the .pem file (either apn_production.pem or apn_development.pem, depending on the environment). The latter specifies a .pem file explicitly, allowing customized certificate names if needed.
-
 Check ```logs/apn_sender.log``` for debugging output.  In addition to logging any major errors there, apn_sender hooks into the Resque::Worker logging to display any verbose or very_verbose worker output in apn_sender.log file as well.
 
 
-### 3. Checking Apple's Feedback Service
+### 4. Checking Apple's Feedback Service
 
 Since push notifications are a fire-and-forget sorta deal, where you get no indication if your message was received (or if the specified recipient even exists), Apple needed to come up with some other way to ensure their network isn't clogged with thousands of bogus messages (e.g. from developers sending messages to phones where their application <em>used</em> to be installed, but where the user has since removed it).  Hence, the Feedback Service.
 
@@ -134,27 +124,28 @@ There's also an included sample ```apn_sender.monitrc``` file in the ```contrib/
 
 ## Installation
 
-APN is built on top of [Resque](http://github.com/defunkt/resque) (an awesome [Redis](http://code.google.com/p/redis/)-based background runner similar to [delayed_job](http://github.com/collectiveidea/delayed_job)). Read through the [Resque README](http://github.com/defunkt/resque#readme) to get a feel for what's going on, follow the installation instructions there, and then run:
+Add this line to your application's Gemfile:
 
-```
-  $ gem install apn_sender
-```
-In your Rails app, add (2.3.x):
+    gem 'apn_sender', require: 'apn'
 
-```
-  config.gem 'apn_sender', :lib => 'apn'
-```
-or (3.x) to your Gemfile:
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apn_sender
 
-```
-  gem 'apn_sender', require: 'apn'
-```
 To add a few useful rake tasks for running workers, add the following line to your Rakefile:
 
 ```
   require 'apn/tasks'
 ```
 
-## Copyright
+## License
+
+APN Sender is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/arthurnn/apn_sender/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
-Copyright (c) 2013 Arthur Nogueira Neves. See LICENSE for details.

data/lib/apn.rb

@@ -34,8 +34,10 @@ module APN
     def backend
       @backend ||=
         if defined?(Sidekiq)
+          require 'apn/jobs/sidekiq_notification_job'
           APN::Backend::Sidekiq.new
         elsif defined?(Resque)
+          require 'apn/jobs/resque_notification_job'
           APN::Backend::Resque.new
         else
           APN::Backend::Simple.new
@@ -89,8 +91,5 @@ module APN::Jobs
   QUEUE_NAME = :apple_push_notifications
 end
 
-require 'apn/jobs/sidekiq_notification_job' if defined?(Sidekiq)
-require 'apn/jobs/resque_notification_job' if defined?(Resque)
 require "apn/railtie" if defined?(Rails)
-
 require 'apn/backend'

data/lib/apn/client.rb

@@ -13,6 +13,7 @@ module APN
     def push(message)
       socket.write(message.to_s)
       socket.flush
+
       if IO.select([socket], nil, nil, 1) && error = socket.read(6)
         error = error.unpack("ccN")
         APN.log(:error, "Error on message: #{error}")
@@ -21,6 +22,11 @@ module APN
 
       APN.log(:debug, "Message sent.")
       true
+    rescue OpenSSL::SSL::SSLError, Errno::EPIPE => e
+      APN.log(:error, "[##{self.object_id}] Exception occurred: #{e.inspect}, socket state: #{socket.inspect}")
+      reset_socket
+      APN.log(:debug, "[##{self.object_id}] Socket reestablished, socket state: #{socket.inspect}")
+      retry
     end
 
     def feedback
@@ -35,6 +41,7 @@ module APN
     end
 
     private
+
     # Open socket to Apple's servers
     def setup_socket
       ctx = setup_certificate
@@ -48,6 +55,12 @@ module APN
       end
     end
 
+    def reset_socket
+      @socket.close if @socket
+      @socket = nil
+      socket
+    end
+
     def setup_certificate
       ctx = OpenSSL::SSL::SSLContext.new
       ctx.cert = OpenSSL::X509::Certificate.new(@apn_cert)

data/lib/apn/connection.rb

@@ -1,7 +1,6 @@
 module APN
   module Connection
-    # APN::Connection::Base takes care of all the boring certificate loading, socket creating, and logging
-    # responsibilities so APN::Sender and APN::Feedback and focus on their respective specialties.
+
     def connection_pool
       @pool ||= ConnectionPool.new(size: (pool_size || 1), timeout: (pool_timeout || 5)) do
         APN::Client.new(host: host,

data/lib/apn/jobs/sidekiq_notification_job.rb

@@ -1,6 +1,6 @@
 module APN::Jobs
-  # This is the class that's actually enqueued via Resque when user calls +APN.notify+.
-  # It gets added to the +apple_server_notifications+ Resque queue, which should only be operated on by
+  # This is the class that's actually enqueued via Sidekiq when user calls +APN.notify+.
+  # It gets added to the +apple_server_notifications+ Sidekiq queue, which should only be operated on by
   # workers of the +APN::Sender+ class.
   class SidekiqNotificationJob
     include Sidekiq::Worker

data/lib/apn/notification.rb

@@ -19,9 +19,8 @@ module APN
   #
   class Notification
     # Available to help clients determine before they create the notification if their message will be too large.
-    # Each iPhone Notification payload must be 256 or fewer characters.  Encoding a null message has a 57
-    # character overhead, so there are 199 characters available for the alert string.
-    MAX_ALERT_LENGTH = 199
+    # Each iPhone Notification payload must be 256 or fewer characters (not including the token or other push data), see Apple specs at:
+    # https://developer.apple.com/library/mac/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW4
     DATA_MAX_BYTES = 256
 
     attr_accessor :options, :token
@@ -29,15 +28,17 @@ module APN
       @options = opts.is_a?(Hash) ? opts.symbolize_keys : {:alert => opts}
       @token = token
 
-      truncate_alert! if APN.truncate_alert
-
-      raise "The maximum size allowed for a notification payload is 256 bytes." if packaged_notification.size.to_i > 256
+      raise "The maximum size allowed for a notification payload is #{DATA_MAX_BYTES} bytes." if payload_size > DATA_MAX_BYTES
     end
 
     def to_s
       packaged_notification
     end
 
+    def payload_size
+      packaged_message.bytesize
+    end
+
     # Ensures at least one of <code>%w(alert badge sound)</code> is present
     def valid?
       return true if [:alert, :badge, :sound].any?{|key| options.keys.include?(key) }
@@ -48,7 +49,7 @@ module APN
     def packaged_notification
       pt = packaged_token
       pm = packaged_message
-      [0, 0, 32, pt, 0, pm.size, pm].pack("ccca*cca*")
+      [0, 0, 32, pt, 0, payload_size, pm].pack("ccca*cca*")
     end
 
     # Device token, compressed and hex-ified
@@ -60,29 +61,58 @@ module APN
     # Extracts :alert, :badge, and :sound keys into the 'aps' hash, merges any other hash data
     # into the root of the hash to encode and send to apple.
     def packaged_message
-      opts = @options.clone # Don't destroy our pristine copy
-      hsh = {'aps' => {}}
-      if alert = opts.delete(:alert)
-        alert = alert.to_s unless alert.is_a?(Hash)
-        hsh['aps']['alert'] = alert
-      end
-      hsh['aps']['badge'] = opts.delete(:badge).to_i if opts[:badge]
-      if sound = opts.delete(:sound)
-        hsh['aps']['sound'] = sound.is_a?(TrueClass) ? 'default' : sound.to_s
-      end
-      hsh.merge!(opts)
-      ActiveSupport::JSON::encode(hsh)
+      @packaged_message ||=
+        begin
+          opts = @options.dup
+          hsh = {'aps' => {}}
+          if alert = opts.delete(:alert)
+            alert = alert.to_s unless alert.is_a?(Hash)
+            hsh['aps']['alert'] = alert
+          end
+          hsh['aps']['badge'] = opts.delete(:badge).to_i if opts[:badge]
+          if sound = opts.delete(:sound)
+            hsh['aps']['sound'] = sound.is_a?(TrueClass) ? 'default' : sound.to_s
+          end
+          hsh.merge!(opts)
+          payload(hsh)
+        end
     end
 
-    def truncate_alert!
-      while packaged_notification.size.to_i > DATA_MAX_BYTES
-        if @options[:alert].is_a? Hash
-          last = @options[:alert]['loc-args'].pop
-          @options[:alert]['loc-args'] << last[0..-2]
-        else
-          @options[:alert] = @options[:alert][0..-2]
+    private
+
+      def payload(hash)
+        str = ActiveSupport::JSON::encode(hash)
+
+        if APN.truncate_alert && str.bytesize > DATA_MAX_BYTES
+          if hash['aps']['alert'].is_a?(Hash)
+            alert = hash['aps']['alert']['loc-args'][0]
+          else
+            alert = hash['aps']['alert']
+          end
+          max_bytesize = DATA_MAX_BYTES - (str.bytesize - alert.bytesize)
+
+          raise "Even truncating the alert wont be enought to have a #{DATA_MAX_BYTES} message" if max_bytesize <= 0
+          alert = truncate_alert(alert, max_bytesize)
+
+          if hash['aps']['alert'].is_a?(Hash)
+            hash['aps']['alert']['loc-args'][0] = alert
+          else
+            hash['aps']['alert'] = alert
+          end
+          str = ActiveSupport::JSON::encode(hash)
         end
+        str
       end
-    end
+
+      def truncate_alert(alert, max_size)
+        alert.each_char.each_with_object('') do |char, result|
+          if result.bytesize + char.bytesize > max_size
+            break result
+          else
+            result << char
+          end
+        end
+      end
+
   end
 end

data/lib/apn/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module APN
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apn_sender
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Kali Donovan
@@ -15,42 +15,42 @@ dependencies:
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Background worker to send Apple Push Notifications over a persistent
@@ -61,6 +61,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/apn.rb
 - lib/apn/backend.rb
 - lib/apn/client.rb
 - lib/apn/connection.rb
@@ -72,11 +77,6 @@ files:
 - lib/apn/sender_daemon.rb
 - lib/apn/tasks.rb
 - lib/apn/version.rb
-- lib/apn.rb
-- CHANGELOG.md
-- LICENSE
-- README.md
-- Rakefile
 homepage: http://github.com/arthurnn/apn_sender
 licenses:
 - MIT
@@ -87,17 +87,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Background worker to send Apple Push Notifications over a persistent TCP