push-core 0.0.1.pre4 → 1.0.0

data/README.md

@@ -1,6 +1,12 @@
 # Push
 
-Please note this gem not yet used in production. If you want to help, please contact me.
+## Features
+
+* Multi-App
+* Multi-Provider ([APNS](https://github.com/tompesman/push-apns), [GCM](https://github.com/tompesman/push-gcm), [C2DM](https://github.com/tompesman/push-c2dm))
+* Integrated feedback processing
+* Rake task to cleanup the database
+* Database for storage (no external dependencies)
 
 ## Installation
 
@@ -13,8 +19,8 @@ and add the push provider to you Gemfile:
 For __APNS__ (iOS: Apple Push Notification Services):
 
     gem push-apns
-    
-For __C2DM__ (Android: Cloud to Device Messaging, deprecated):
+
+For __C2DM__ (Android: Cloud to Device Messaging, deprecated by Google, not this gem):
 
     gem push-c2dm
 
@@ -33,25 +39,30 @@ To generate the migration and the configuration files run:
 
 The configuration is in the database and you add the configuration per push provider with the console (`rails c`):
 
-APNS:
+APNS ([see](https://github.com/tompesman/push-core#generating-certificates)):
 ```ruby
-Push::ConfigurationApns.create(:app => 'app_name', :connections => 2, :certificate => File.read("certificate.pem"), :feedback_poll => 60, :enabled => true).save
+Push::ConfigurationApns.create(app: 'app_name', connections: 2, enabled: true,
+    certificate: File.read('certificate.pem'),
+    feedback_poll: 60,
+    sandbox: false)
 ```
 
-C2DM
+C2DM ([see](https://developers.google.com/android/c2dm/)):
 ```ruby
-Push::ConfigurationC2dm.create(:app => 'app_name', :connections => 2, :email => "<email address here>", :password => "<password here>", :enabled => true).save
+Push::ConfigurationC2dm.create(app: 'app_name', connections: 2, enabled: true,
+    email: '<email address here>',
+    password: '<password here>')
 ```
 
-GCM
+GCM ([see](http://developer.android.com/guide/google/gcm/gs.html)):
 ```ruby
-Push::ConfigurationGcm.create(:app => 'app_name', :connections => 2, :key => '<api key here>').save
+Push::ConfigurationGcm.create(app: 'app_name', connections: 2, enabled: true,
+    key: '<api key here>')
 ```
 
-You can have each provider per app_name and you can have more than one app_name. Use the instructions below to generate the certificate for the APNS provider.
+You can have each provider per app_name and you can have more than one app_name. Use the instructions below to generate the certificate for the APNS provider. If you only want to prepare the database with the configurations, you can set the `enabled` switch to `false`. Only enabled configurations will be used by the daemon.
 
-
-### Generating Certificates
+### Generating Certificates for APNS
 
 1. Open up Keychain Access and select the `Certificates` category in the sidebar.
 2. Expand the disclosure arrow next to the iOS Push Services certificate you want to export.
@@ -62,60 +73,78 @@ You can have each provider per app_name and you can have more than one app_name.
 7. Convert the certificate to a .pem, where `<environment>` should be `development` or `production`, depending on the certificate you exported.
 
     `openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem`
-      
-8. Move the .pem file into your Rails application under `config/push`.
 
+8. Move the .pem file somewhere where you can use the `File.read` to load the file in the database.
 
 ## Daemon
 
 To start the daemon:
 
     bundle exec push <environment> <options>
-    
+
 Where `<environment>` is your Rails environment and `<options>` can be:
 
-		-f, --foreground                 Run in the foreground.
-		-p, --pid-file PATH              Path to write PID file. Relative to Rails root unless absolute.
-		-P, --push-poll N                Frequency in seconds to check for new notifications. Default: 2.
-		-n, --airbrake-notify            Enables error notifications via Airbrake.
-		-F, --feedback-poll N            Frequency in seconds to check for feedback for the feedback processor. Default: 60. Use 0 to disable.
-		-b, --feedback-processor PATH    Path to the feedback processor. Default: lib/push/feedback_processor.
-		-v, --version                    Print this version of push.
-		-h, --help                       You're looking at it.
+    -f, --foreground                 Run in the foreground. Log is not written.
+    -p, --pid-file PATH              Path to write PID file. Relative to Rails root unless absolute.
+    -P, --push-poll N                Frequency in seconds to check for new notifications. Default: 2.
+    -n, --error-notification         Enables error notifications via Airbrake or Bugsnag.
+    -F, --feedback-poll N            Frequency in seconds to check for feedback for the feedback processor. Default: 60. Use 0 to disable.
+    -b, --feedback-processor PATH    Path to the feedback processor. Default: lib/push/feedback_processor.
+    -v, --version                    Print this version of push.
+    -h, --help                       You're looking at it.
 
 
 ## Sending notifications
 APNS:
 ```ruby
-Push::MessageApns.new(:app => 'app_name', device: '<APNS device_token here>', alert: 'Hello World', expiry: 1.day.to_i, attributes_for_device: {key: 'MSG'}).save
+Push::MessageApns.create(
+    app: 'app_name',
+    device: '<APNS device_token here>',
+    alert: 'Hello World',
+    sound: '1.aiff',
+    badge: 1,
+    expiry: 1.day.to_i,
+    attributes_for_device: {key: 'MSG'})
 ```
 C2DM:
 ```ruby
-Push::MessageC2dm.new(:app => 'app_name', device: '<C2DM registration_id here>', payload: { message: 'Hello World' }, collapse_key: 'MSG').save
+Push::MessageC2dm.create(
+    app: 'app_name',
+    device: '<C2DM registration_id here>',
+    payload: { message: 'Hello World' },
+    collapse_key: 'MSG')
 ```
 
 GCM:
 ```ruby
-Push::MessageGcm.new(:app => 'app_name', device: '<GCM registration_id here>', payload: { message: 'Hello World' }, collapse_key: 'MSG').save
+Push::MessageGcm.create(
+    app: 'app_name',
+    device: '<GCM registration_id here>',
+    payload: { message: 'Hello World' },
+    collapse_key: 'MSG')
 ```
 
 ## Feedback processing
 
 The push providers return feedback in various ways and these are captured and stored in the `push_feedback` table. The installer installs the `lib/push/feedback_processor.rb` file which is by default called every 60 seconds. In this file you can process the feedback which is different for every application.
 
-## Rake Task
+## Maintenance
 
-The push-core also comes with a rake task to delete all the messages and feedback of the last 7 days or by the DAYS parameter.
+The push-core comes with a rake task to delete all the messages and feedback of the last 7 days or by the DAYS parameter.
 
-		bundle exec rake push:clean DAYS=2
+    bundle exec rake push:clean DAYS=2
 
-## Prerequisites
+## Heroku
+
+Push runs on Heroku with the following line in the `Procfile`.
 
-* Rails 3.2 +
-* Ruby 1.9
+    push: bundle exec push $RACK_ENV -f
+
+## Prerequisites
 
+* Rails 3.2.x
+* Ruby 1.9.x
 
 ## Thanks
 
 This project started as a fork of Ian Leitch [RAPNS](https://github.com/ileitch/rapns) project. The differences between this project and RAPNS is the support for C2DM and the modularity of the push providers.
-    

data/bin/push

@@ -5,20 +5,20 @@ require 'push'
 
 environment = ARGV[0]
 
-config = Struct.new(:foreground, :pid_file, :push_poll, :airbrake_notify, :feedback_poll, :feedback_processor).new
+config = Struct.new(:foreground, :pid_file, :push_poll, :error_notification, :feedback_poll, :feedback_processor).new
 config.foreground = false
 config.push_poll = 2
-config.airbrake_notify = false
+config.error_notification = false
 config.feedback_poll = 60
 config.feedback_processor = 'lib/push/feedback_processor'
 
 banner = 'Usage: push <Rails environment> [options]'
 ARGV.options do |opts|
   opts.banner = banner
-  opts.on('-f', '--foreground', 'Run in the foreground.') { config.foreground = true }
+  opts.on('-f', '--foreground', 'Run in the foreground. Log is not written.') { config.foreground = true }
   opts.on('-p PATH', '--pid-file PATH', String, 'Path to write PID file. Relative to Rails root unless absolute.') { |path| config.pid_file = path }
   opts.on('-P N', '--push-poll N', Integer, "Frequency in seconds to check for new notifications. Default: #{config.push_poll}.") { |n| config.push_poll = n }
-  opts.on('-n', '--airbrake-notify', 'Enables error notifications via Airbrake.') { config.check_for_errors = true }
+  opts.on('-n', '--error-notification', 'Enables error notifications via Airbrake or Bugsnag.') { config.error_notification = true }
   opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback for the feedback processor. Default: #{config.feedback_poll}. Use 0 to disable.") { |n| config.feedback_poll = n }
   opts.on('-b PATH', '--feedback-processor PATH', String, "Path to the feedback processor. Default: #{config.feedback_processor}.") { |n| config.feedback_processor = n }
   opts.on('-v', '--version', 'Print this version of push.') { puts "push #{Push::VERSION}"; exit }
@@ -40,4 +40,4 @@ if config.pid_file && !Pathname.new(config.pid_file).absolute?
   config.pid_file = File.join(Rails.root, config.pid_file)
 end
 
-Push::Daemon.start(environment, config)
+Push::Daemon.start(config)

data/lib/push/daemon.rb

@@ -19,9 +19,9 @@ module Push
       attr_accessor :logger, :config
     end
 
-    def self.start(environment, config)
+    def self.start(config)
       self.config = config
-      self.logger = Logger.new(:foreground => config.foreground, :airbrake_notify => config.airbrake_notify)
+      self.logger = Logger.new(:foreground => config.foreground, :error_notification => config.error_notification)
       setup_signal_hooks
       daemonize unless config.foreground
       write_pid_file

data/lib/push/daemon/database_reconnectable.rb

@@ -1,15 +1,17 @@
-class PGError < StandardError; end if !defined?(PGError)
-module Mysql2; class Error < StandardError; end; end if !defined?(Mysql2)
-
 module Push
   module Daemon
     module DatabaseReconnectable
-      ADAPTER_ERRORS = [ActiveRecord::StatementInvalid, PGError, Mysql2::Error]
+      def adaptor_errors
+        errors = [ActiveRecord::StatementInvalid]
+        errors << PGError if defined?(PGError)
+        errors << Mysql2::Error if defined?(Mysql2)
+        errors
+      end
 
       def with_database_reconnect_and_retry(name)
         begin
           yield
-        rescue *ADAPTER_ERRORS => e
+        rescue *adaptor_errors => e
           Push::Daemon.logger.error(e)
           database_connection_lost(name)
           retry
@@ -25,8 +27,8 @@ module Push
             reconnect_database
             check_database_is_connected
             break
-          rescue *ADAPTER_ERRORS => e
-            Push::Daemon.logger.error(e, :airbrake_notify => false)
+          rescue *adaptor_errors => e
+            Push::Daemon.logger.error(e, :error_notification => false)
             sleep_to_avoid_thrashing
           end
         end

data/lib/push/daemon/feeder.rb

@@ -28,8 +28,8 @@ module Push
       def self.enqueue_notifications
         begin
           with_database_reconnect_and_retry(name) do
+            ready_apps = Push::Daemon::App.ready
             Push::Message.ready_for_delivery.find_each do |notification|
-              ready_apps = Push::Daemon::App.ready
               Push::Daemon::App.deliver(notification) if ready_apps.include?(notification.app)
             end
           end

data/lib/push/daemon/logger.rb

@@ -3,10 +3,7 @@ module Push
     class Logger
       def initialize(options)
         @options = options
-        log_file = File.open(File.join(Rails.root, 'log', 'push.log'), 'w')
-        log_file.sync = true
-        @logger = ActiveSupport::BufferedLogger.new(log_file, Rails.logger.level)
-        @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
+        open_log unless @options[:foreground]
       end
 
       def info(msg)
@@ -14,7 +11,7 @@ module Push
       end
 
       def error(msg, options = {})
-        airbrake_notify(msg) if notify_via_airbrake?(msg, options)
+        error_notification(msg, options)
         log(:error, msg, 'ERROR')
       end
 
@@ -26,28 +23,41 @@ module Push
 
       def log(where, msg, prefix = nil)
         if msg.is_a?(Exception)
-          msg = "#{msg.class.name}, #{msg.message}: #{msg.backtrace.join("\n")}"
+          msg = "#{msg.class.name}, #{msg.message}: #{msg.backtrace.join("\n") if msg.backtrace}"
         end
 
         formatted_msg = "[#{Time.now.to_s(:db)}] "
         formatted_msg << "[#{prefix}] " if prefix
         formatted_msg << msg
-        puts formatted_msg if @options[:foreground]
-        @logger.send(where, formatted_msg)
+
+        if @options[:foreground]
+          puts formatted_msg
+        else
+          @logger.send(where, formatted_msg)
+        end
+      end
+
+      def open_log
+        log_file = File.open(File.join(Rails.root, 'log', 'push.log'), 'w')
+        log_file.sync = true
+        @logger = ActiveSupport::BufferedLogger.new(log_file, Rails.logger.level)
+        @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
       end
 
-      def airbrake_notify(e)
-        return unless @options[:airbrake_notify] == true
+      def error_notification(e, options)
+        return unless do_error_notification?(e, options)
 
         if defined?(Airbrake)
           Airbrake.notify_or_ignore(e)
         elsif defined?(HoptoadNotifier)
           HoptoadNotifier.notify_or_ignore(e)
+        elsif defined?(Bugsnag)
+          Bugsnag.notify(e)
         end
       end
 
-      def notify_via_airbrake?(msg, options)
-        msg.is_a?(Exception) && options[:airbrake_notify] != false
+      def do_error_notification?(msg, options)
+        @options[:error_notification] and options[:error_notification] != false and msg.is_a?(Exception)
       end
     end
   end

data/lib/push/version.rb

@@ -1,3 +1,3 @@
 module Push
-  VERSION = "0.0.1.pre4"
+  VERSION = "1.0.0"
 end

data/lib/tasks/push_tasks.rake

@@ -2,7 +2,7 @@
 namespace :push do
   desc "Delete all push messages and feedback older than 7 days or DAYS=x if defined (where x is an integer)"
   task :clean => :environment do
-    days = ENV["DAYS"].to_i || 7
+    days = ENV["DAYS"] ? ENV["DAYS"].to_i : 7
     puts "Removing #{days} days of push messages and feedback"
     feedback = Push::Feedback.where("created_at < ?", days.days.ago).delete_all
     messages = Push::Message.where("created_at < ?", days.days.ago).delete_all

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: push-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre4
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Tom Pesman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-21 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70213224802660 !ruby/object:Gem::Requirement
+  requirement: &70261995219020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70213224802660
+  version_requirements: *70261995219020
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70213224801920 !ruby/object:Gem::Requirement
+  requirement: &70261995218260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70213224801920
+  version_requirements: *70261995218260
 description: Push daemon for push notification services like APNS (iOS/Apple) and
   GCM/C2DM (Android).
 email:
@@ -85,12 +85,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Core of the push daemon.