apn_sender 2.0.1 → 2.0.2

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Version 2.0
+## 2.0.2
+- Add default file so we dont need to require 'apn' anymore
+- Change backend switch:
+  Use simple backend per default, also allow changes.
+  Now you can change the backend using:
+        APN.backend = :sidekiq
+
 ## 2.0.1
 - Use bytesize to truncate alert when necessary
 - Better calculation on payload size. (botvinik)

data/README.md

@@ -1,5 +1,5 @@
-[![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)
+[![Code Climate](http://img.shields.io/codeclimate/github/arthurnn/apn_sender.svg)](https://codeclimate.com/github/arthurnn/apn_sender)
+[![Build Status](https://travis-ci.org/arthurnn/apn_sender.svg?branch=master)](https://travis-ci.org/arthurnn/apn_sender)
 
 ## Synopsis
 
@@ -56,9 +56,11 @@ 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
+APN.logger = Logger.new(File.join(Rails.root, 'log', 'apn_sender.log'))
 ```
 
 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.
+On latest versions apn_sender will use Rails.logger as the default logger.
 
 
 ### 4. Checking Apple's Feedback Service
@@ -147,5 +149,3 @@ To add a few useful rake tasks for running workers, add the following line to yo
 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")
-

data/lib/apn.rb

@@ -22,26 +22,26 @@ module APN
       msg = APN::Notification.new(token, opts)
       raise "Invalid notification options (did you provide :alert, :badge, or :sound?): #{opts.inspect}" unless msg.valid?
 
+      APN.log(:debug, "Sending to token '#{token}' message '#{opts.to_s}'")
       APN.with_connection do |client|
         client.push(msg)
       end
     end
 
     def backend=(backend)
-      @backend = backend
+      @backend =
+        case backend
+        when Symbol
+          APN::Backend.const_get(backend.to_s.camelize).new
+        when nil
+          APN::Backend::Simple.new
+        else
+          backend
+        end
     end
 
     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
-        end
+      @backend ||= APN::Backend::Simple.new
     end
 
     def logger=(logger)

data/lib/apn/backend.rb

@@ -1,22 +1,9 @@
 module APN
   module Backend
-
-    class Sidekiq
-
-      def notify(token, opts)
-        ::Sidekiq::Client.enqueue(APN::Jobs::SidekiqNotificationJob, token, opts)
-      end
-    end
-
-    class Resque
-
-      def notify(token, opts)
-        ::Resque.enqueue(APN::Jobs::ResqueNotificationJob, token, opts)
-      end
-    end
+    autoload :Sidekiq,     'apn/backend/sidekiq'
+    autoload :Resque,      'apn/backend/resque'
 
     class Simple
-
       def notify(token, opts)
         Thread.new do
           APN.notify_sync(token, opts)
@@ -25,7 +12,6 @@ module APN
     end
 
     class Null
-
       def notify(token, opts)
         APN.log("Null Backend sending message to #{token}")
       end

data/lib/apn/backend/resque.rb

@@ -0,0 +1,17 @@
+begin
+  require 'resque'
+  require 'apn/jobs/resque_notification_job'
+rescue LoadError => e
+  $stderr.puts "You don't have resque installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+module APN
+  module Backend
+    class Resque
+      def notify(token, opts)
+        ::Resque.enqueue(APN::Jobs::ResqueNotificationJob, token, opts)
+      end
+    end
+  end
+end

data/lib/apn/backend/sidekiq.rb

@@ -0,0 +1,17 @@
+begin
+  require 'sidekiq'
+  require 'apn/jobs/sidekiq_notification_job'
+rescue LoadError => e
+  $stderr.puts "You don't have sidekiq installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+module APN
+  module Backend
+    class Sidekiq
+      def notify(token, opts)
+        ::Sidekiq::Client.enqueue(APN::Jobs::SidekiqNotificationJob, token, opts)
+      end
+    end
+  end
+end

data/lib/apn/client.rb

@@ -22,7 +22,7 @@ module APN
 
       APN.log(:debug, "Message sent.")
       true
-    rescue OpenSSL::SSL::SSLError, Errno::EPIPE => e
+    rescue OpenSSL::SSL::SSLError, Errno::EPIPE, Errno::ETIMEDOUT => 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}")

data/lib/apn/feedback.rb

@@ -46,7 +46,7 @@ module APN
 
     # Prettify to return meaningful status information when printed. Can't add these directly to connection/base, because Resque depends on decoding to_s
     def to_s
-      "#{@socket ? 'Connected' : 'Connection not currently established'} to #{host} on #{port}"
+      "#{@client ? 'Connected' : 'Connection not currently established'} to #{host} on #{port}"
     end
 
     protected

data/lib/apn/notification.rb

@@ -73,6 +73,9 @@ module APN
           if sound = opts.delete(:sound)
             hsh['aps']['sound'] = sound.is_a?(TrueClass) ? 'default' : sound.to_s
           end
+          if content_available = opts.delete(:content_available)
+            hsh['aps']['content-available'] = 1 if [1,true].include? content_available
+          end
           hsh.merge!(opts)
           payload(hsh)
         end

data/lib/apn/railtie.rb

@@ -7,10 +7,7 @@ module APN
         APN.certificate_name =  "apn_development.pem"
         APN.host =  "gateway.sandbox.push.apple.com"
       end
-
-      logger = Logger.new(File.join(Rails.root, 'log', 'apn_sender.log'))
-      APN.logger = logger
-
+      APN.logger = Rails.logger
     end
   end
 end

data/lib/apn/tasks.rb

@@ -13,6 +13,7 @@ namespace :apn do
       return
     end
 
+    APN.backend = :resque
     APN.password = ENV['CERT_PASS']
     APN.full_certificate_path =  ENV['FULL_CERT_PATH']
     APN.logger = Rails.logger

data/lib/apn/version.rb

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

data/lib/apn_sender.rb

@@ -0,0 +1 @@
+require 'apn'

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: apn_sender
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Kali Donovan
@@ -13,46 +14,40 @@ date: 2011-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &1 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *1
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
+  version_requirements: *2
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &3 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *3
 description: Background worker to send Apple Push Notifications over a persistent
   TCP socket. Includes Resque tweaks to allow persistent sockets between jobs, helper
   methods for enqueueing APN notifications, and a background daemon to send them.
@@ -61,11 +56,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- LICENSE
-- README.md
-- Rakefile
-- lib/apn.rb
+- lib/apn/backend/resque.rb
+- lib/apn/backend/sidekiq.rb
 - lib/apn/backend.rb
 - lib/apn/client.rb
 - lib/apn/connection.rb
@@ -77,29 +69,36 @@ files:
 - lib/apn/sender_daemon.rb
 - lib/apn/tasks.rb
 - lib/apn/version.rb
+- lib/apn.rb
+- lib/apn_sender.rb
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
 homepage: http://github.com/arthurnn/apn_sender
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Background worker to send Apple Push Notifications over a persistent TCP
   socket.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: e9297870e306966d00d3d0acf01a3022dbbb1636
-  data.tar.gz: 25b8a81befe782fba5a0b7f0376ce9491f674a86
-SHA512:
-  metadata.gz: 5048150d58ffba87b276ebe50d24bd1ab744f6eefa58ac94662cf22b5b773fde19fa66b840c1c982303693460d0d53283606aa9a0af7f99f04a6e4eb6802e634
-  data.tar.gz: ef4fc9e0ce014ac4bef75d1da4f858ae6317a86bed03aa09e8ca1f248e9b9cffef8f9a5ec2939024fb7db4ee89cfe87e91dcc0bb2c302a581cfcb8a38466f126