pushr-core 1.0.0.pre.1 → 1.0.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c269b18e78e10769483231241fb24d5244b28d8
-  data.tar.gz: fc7fcd4d877e6061ac263fd97530777158b053aa
+  metadata.gz: 8c4520c42719fbd129a5e29c3c37a66769c57e8f
+  data.tar.gz: 95c79b3d1e565ee7e8a9a35c75a65cc88c1ea7a7
 SHA512:
-  metadata.gz: bee51328463ac62dd6731e8e049e230c7a0ed582ee38bf9065ed8019989c8b43267067512806c596862e44ab547f61e76a78d6de470457866982ea61780e714a
-  data.tar.gz: 49e84cf9943ee2293a06fd4ecc84d12a9a00580b5a4a4a21329c097084f40c854ea1249b8b02efa8a4473c88a6e6a09a3934eeee5e5da00ee9e2c3a0051ac72f
+  metadata.gz: 632e2d3cd972ce3301f600a61b5cb905408e79eeff51f32793be97c31e47f8914135f27f32f174cb035a9ce750601a6b7e53861ad5e5597afb82f3e0124f7192
+  data.tar.gz: 17e5e36b3c6bd2c250843f10cf747fbdbfc3ebd03fa9a7db7e1bc665330655d47161c852cfefbda15f1f9f48a1f9f6b0addb00045331c866c768827778eff7c2

data/README.md

@@ -1,72 +1,64 @@
 # Pushr
 
+Please note: We're in the process of updating this gem. The current code is not yet stable. Please contact us if you
+want to test or contribute to this project.
+
 [![Build Status](https://travis-ci.org/9to5/pushr-core.svg?branch=master)](https://travis-ci.org/9to5/pushr-core)
 [![Code Climate](https://codeclimate.com/github/9to5/pushr-core.png)](https://codeclimate.com/github/9to5/pushr-core)
 [![Coverage Status](https://coveralls.io/repos/9to5/pushr-core/badge.png)](https://coveralls.io/r/9to5/pushr-core)
 
 ## Features
 
+* Lightening fast push notification delivery
+* Redis for queueing
 * 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))
+* Multi-Provider ([APNS](https://github.com/9to5/pushr-apns), [GCM](https://github.com/9to5/pushr-gcm))
 * Integrated feedback processing
-* Rake task to cleanup the database
-* Database for storage (no external dependencies)
+* Multi-process
 
 ## Installation
 
-Add to your `GemFile`
+Add to your `Gemfile`
 
-    gem 'push-core'
+    gem 'pushr-core'
 
 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 by Google, not this gem):
-
-    gem 'push-c2dm'
+    gem 'pushr-apns'
 
 For __GCM__ (Android: Google Cloud Messaging):
 
-    gem 'push-gcm'
+    gem 'pushr-gcm'
 
 And run `bundle install` to install the gems.
 
-To generate the migration and the configuration files run:
-
-    rails g push
-    bundle exec rake db:migrate
-
 ## Configuration
 
-The configuration is in the database and you add the configuration per push provider with the console (`rails c`):
+By default the gem tries to connect to a Redis instance at localhost. If you define the `PUSHR_URL` environment variable
+it will use that. The configuration is stored in Redis and you add the configuration per push provider with the console
+(`bundle console`):
 
-APNS ([see](https://github.com/tompesman/push-core#generating-certificates)):
+APNS ([see](https://github.com/9to5/pushr-core#generating-certificates)):
 ```ruby
 Pushr::ConfigurationApns.create(app: 'app_name', connections: 2, enabled: true,
-    certificate: File.read('certificate.pem'),
-    feedback_poll: 60,
-    sandbox: false)
+    certificate: File.read('certificate.pem'), feedback_poll: 60, sandbox: false)
 ```
 
-The `skip_check_for_error` parameter is optional and can be set to `true` or `false`. If set to `true` the APNS service will not check for errors when sending messages. This option should be used in a production environment and improves performance. In production the errors are reported and handled by the feedback service.
-
-C2DM ([see](https://developers.google.com/android/c2dm/)):
-```ruby
-Pushr::ConfigurationC2dm.create(app: 'app_name', connections: 2, enabled: true,
-    email: '<email address here>',
-    password: '<password here>')
-```
+The `skip_check_for_error` parameter is optional and can be set to `true` or `false`. If set to `true` the APNS service
+will not check for errors when sending messages. This option should be used in a production environment and improves
+performance. In production the errors are reported and handled by the feedback service. Please note that if you use
+sandbox devices in your production environment you should not `skip_check_for_error`.
 
 GCM ([see](http://developer.android.com/guide/google/gcm/gs.html)):
 ```ruby
-Pushr::ConfigurationGcm.create(app: 'app_name', connections: 2, enabled: true,
-    key: '<api key here>')
+Pushr::ConfigurationGcm.create(app: 'app_name', connections: 2, enabled: true, api: '<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. 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.
+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 for APNS
 
@@ -76,7 +68,8 @@ You can have each provider per app_name and you can have more than one app_name.
 4. Right click and select `Export 2 items...`.
 5. Save the file as `cert.p12`, make sure the File Format is `Personal Information Exchange (p12)`.
 6. If you decide to set a password for your exported certificate, please read the Configuration section below.
-7. Convert the certificate to a .pem, where `<environment>` should be `development` or `production`, depending on the certificate you exported.
+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`
 
@@ -86,21 +79,18 @@ You can have each provider per app_name and you can have more than one app_name.
 
 To start the daemon:
 
-    bundle exec push <environment> <options>
+    bundle exec pushr <options>
 
-Where `<environment>` is your Rails environment and `<options>` can be:
+Where `<options>` can be:
 
     -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
 Pushr::MessageApns.create(
@@ -112,45 +102,33 @@ Pushr::MessageApns.create(
     expiry: 1.day.to_i,
     attributes_for_device: {key: 'MSG'})
 ```
-C2DM:
-```ruby
-Pushr::MessageC2dm.create(
-    app: 'app_name',
-    device: '<C2DM registration_id here>',
-    payload: { message: 'Hello World' },
-    collapse_key: 'MSG')
-```
 
 GCM:
 ```ruby
 Pushr::MessageGcm.create(
     app: 'app_name',
-    device: '<GCM registration_id here>',
-    payload: { message: 'Hello World' },
+    registration_ids: ['<GCM registration_id here>', '<GCM registration_id here>'],
+    notification_key: 'notification_key_name',
+    delay_while_idle: true,
+    data: { message: 'Hello World' },
+    time_to_live: 24 * 60 * 60,
+    restricted_package_name: 'com.example.gcm',
+    dry_run: false,
     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.
-
-## Maintenance
-
-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
+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.
 
 ## Heroku
 
 Push runs on Heroku with the following line in the `Procfile`.
 
-    push: bundle exec push $RACK_ENV -f
+    pushr: bundle exec pushr -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/pushr

@@ -7,37 +7,52 @@ require 'optparse'
 require 'pushr/core'
 require 'pushr/daemon'
 
-config = Struct.new(:foreground, :pid_file, :error_notification, :feedback_processor, :stats_processor).new
-config.foreground = false
-config.error_notification = false
-config.feedback_processor = nil
-config.stats_processor = nil
-
+settings = Pushr::Daemon::Settings.new
 banner = 'Usage: pushr [options]'
 ARGV.options do |opts|
   opts.banner = banner
-  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('-b PATH', '--feedback-processor PATH', String, "Path to the feedback processor. Default: none. Example: 'lib/pushr/feedback_processor'") { |n| config.feedback_processor = n }
-  opts.on('-s PATH', '--stats-processor PATH', String, "Path to the stats processor. Default: none. Example: 'lib/pushr/stats_processor'") { |n| config.stats_processor = n }
-  opts.on('-v', '--version', 'Print this version of pushr.') { puts "pushr #{Pushr::VERSION}"; exit }
-  opts.on('-h', '--help', 'You\'re looking at it.') { puts opts; exit }
-  opts.parse!
-end
 
-if config.pid_file && !Pathname.new(config.pid_file).absolute?
-  config.pid_file = File.join(Dir.pwd.root, config.pid_file)
+  opts.on('-f', '--foreground', 'Run in the foreground. Log is not written.') do
+    settings.foreground = true
+  end
+
+  opts.on('-p PATH', '--pid-file PATH', String,
+          'Path to write PID file. Relative to current directory unless absolute.') do |path|
+            settings.pid_file = path
+          end
+
+  opts.on('-b PATH', '--feedback-processor PATH', String,
+          "Path to the feedback processor. Default: none. Example: 'lib/pushr/feedback_processor'") do |n|
+            settings.feedback_processor = n
+          end
+
+  opts.on('-s PATH', '--stats-processor PATH', String,
+          "Path to the stats processor. Default: none. Example: 'lib/pushr/stats_processor'") do |n|
+            settings.stats_processor = n
+          end
+
+  opts.on('-v', '--version', 'Print this version of pushr.') do
+    puts "pushr #{Pushr::VERSION}"
+    exit
+  end
+
+  opts.on('-h', '--help', 'You\'re looking at it.') do
+    puts opts
+    exit
+  end
+
+  opts.parse!
 end
 
 if ENV['AIRBRAKE_API_KEY']
   require 'airbrake'
-  config.error_notification = true
-  Airbrake.configure do |config|
-    config.api_key = ENV['AIRBRAKE_API_KEY']
-    config.host    = ENV['AIRBRAKE_HOST']
-    config.port    = ENV['AIRBRAKE_PORT'] ? ENV['AIRBRAKE_PORT'].to_i : 80
-    config.secure  = config.port == 443
+  settings.error_notification = true
+  Airbrake.configure do |airbrake|
+    airbrake.api_key = ENV['AIRBRAKE_API_KEY']
+    airbrake.host    = ENV['AIRBRAKE_HOST']
+    airbrake.port    = ENV['AIRBRAKE_PORT'] ? ENV['AIRBRAKE_PORT'].to_i : 80
+    airbrake.secure  = airbrake.port == 443
   end
 end
 
-Pushr::Daemon.start(config)
+Pushr::Daemon.start(settings)

data/lib/pushr/configuration.rb

@@ -5,10 +5,11 @@ module Pushr
     validates :app, presence: true
     validates :connections, presence: true
     validates :connections, numericality: { greater_than: 0, only_integer: true }
+    validates :enabled, inclusion: { in: [true, false] }
 
     def initialize(attributes = {})
       attributes.each do |name, value|
-        send("#{name}=", value)
+        send("#{name}=", value) if respond_to?("#{name}=")
       end
     end
 

data/lib/pushr/daemon.rb

@@ -2,11 +2,13 @@ require 'thread'
 require 'logger'
 require 'multi_json'
 require 'pushr/redis_connection'
+require 'pushr/daemon/settings'
 require 'pushr/daemon/delivery_error'
-require 'pushr/daemon/delivery_handler'
+require 'pushr/daemon/message_handler'
 require 'pushr/daemon/feedback_handler'
 require 'pushr/daemon/logger'
 require 'pushr/daemon/app'
+require 'pushr/daemon/pid_file'
 
 module Pushr
   module Daemon
@@ -20,24 +22,25 @@ module Pushr
       setup_signal_hooks
 
       daemonize unless config.foreground
-      write_pid_file
 
-      load_stats_processor
+      start_app
+
+      logger.info('[Daemon] Ready')
+
+      sleep 1 until @shutting_down
+    end
 
+    protected
+
+    def self.start_app
+      load_stats_processor
       App.load
       scale_redis_connections
       App.start
       self.feedback_handler = FeedbackHandler.new(config.feedback_processor)
       feedback_handler.start
-
-      logger.info('[Daemon] Ready')
-      while !@shutting_down
-        sleep 1
-      end
     end
 
-    protected
-
     def self.scale_redis_connections
       # feedback handler + app + app.totalconnections
       connections = 1 + 1 + App.total_connections
@@ -47,9 +50,7 @@ module Pushr
     end
 
     def self.load_stats_processor
-      if config.stats_processor
-        require "#{Dir.pwd}/#{config.stats_processor}"
-      end
+      require "#{Dir.pwd}/#{config.stats_processor}" if config.stats_processor
     rescue => e
       logger.error("Failed to stats_processor: #{e.inspect}")
     end
@@ -80,13 +81,13 @@ module Pushr
         print '.'
       end
       print "\n"
-      delete_pid_file
+      PidFile.delete(config.pid_file)
     end
 
     def self.daemonize
-      exit if pid = fork
+      exit if fork
       Process.setsid
-      exit if pid = fork
+      exit if fork
 
       Dir.chdir '/'
       File.umask 0000
@@ -94,23 +95,7 @@ module Pushr
       STDIN.reopen '/dev/null'
       STDOUT.reopen '/dev/null', 'a'
       STDERR.reopen STDOUT
-    end
-
-    def self.write_pid_file
-      unless config[:pid_file].blank?
-        begin
-          File.open(config[:pid_file], 'w') do |f|
-            f.puts $PROCESS_ID
-          end
-        rescue SystemCallError => e
-          logger.error("Failed to write PID to '#{config[:pid_file]}': #{e.inspect}")
-        end
-      end
-    end
-
-    def self.delete_pid_file
-      pid_file = config[:pid_file]
-      File.delete(pid_file) if !pid_file.blank? && File.exist?(pid_file)
+      PidFile.write(config.pid_file)
     end
   end
 end

data/lib/pushr/daemon/app.rb

@@ -42,7 +42,7 @@ module Pushr
           connection = @provider.connectiontype.new(@config, i + 1)
           connection.connect
 
-          handler = DeliveryHandler.new("pushr:#{@config.app}:#{@config.name}", connection, @config.app, i + 1)
+          handler = MessageHandler.new("pushr:#{@config.app}:#{@config.name}", connection, @config.app, i + 1)
           handler.start
           @handlers << handler
         end

data/lib/pushr/daemon/{delivery_handler.rb → message_handler.rb}

@@ -1,12 +1,12 @@
 module Pushr
   module Daemon
-    class DeliveryHandler
+    class MessageHandler
       attr_reader :name
 
       def initialize(queue_name, connection, name, i)
         @queue_name = queue_name
         @connection = connection
-        @name = "#{name}: DeliveryHandler #{i}"
+        @name = "#{name}: MessageHandler #{i}"
         Pushr::Daemon.logger.info "[#{@name}] listening to #{@queue_name}"
       end
 

data/lib/pushr/daemon/pid_file.rb

@@ -0,0 +1,21 @@
+module Pushr
+  module Daemon
+    class PidFile
+      def self.write(pid_file)
+        unless pid_file.nil?
+          begin
+            File.open(pid_file, 'w') do |f|
+              f.puts Process.pid
+            end
+          rescue SystemCallError => e
+            logger.error("Failed to write PID to '#{pid_file}': #{e.inspect}")
+          end
+        end
+      end
+
+      def self.delete(pid_file)
+        File.delete(pid_file) if !pid_file.blank? && File.exist?(pid_file)
+      end
+    end
+  end
+end

data/lib/pushr/daemon/settings.rb

@@ -0,0 +1,19 @@
+module Pushr
+  module Daemon
+    class Settings
+      attr_accessor :foreground, :pid_file, :error_notification, :feedback_processor, :stats_processor
+
+      def initialize
+        @foreground = false
+        @error_notification = false
+        @feedback_processor = nil
+        @stats_processor = nil
+        @pid_file = nil
+      end
+
+      def pid_file=(arg)
+        @pid_file = File.join(Dir.pwd, arg) if arg && !Pathname.new(arg).absolute?
+      end
+    end
+  end
+end

data/lib/pushr/feedback.rb

@@ -8,7 +8,7 @@ module Pushr
 
     def initialize(attributes = {})
       attributes.each do |name, value|
-        send("#{name}=", value)
+        send("#{name}=", value) if respond_to?("#{name}=")
       end
     end
 

data/lib/pushr/message.rb

@@ -6,7 +6,7 @@ module Pushr
 
     def initialize(attributes = {})
       attributes.each do |name, value|
-        send("#{name}=", value)
+        send("#{name}=", value) if respond_to?("#{name}=")
       end
     end
 

data/lib/pushr/version.rb

@@ -1,3 +1,3 @@
 module Pushr
-  VERSION = '1.0.0.pre.1'
+  VERSION = '1.0.0.pre.2'
 end

data/spec/lib/pushr/daemon/app_spec.rb

@@ -38,7 +38,7 @@ describe Pushr::Daemon::App do
 
   describe 'class' do
     it 'should start configuration' do
-      expect_any_instance_of(Pushr::Daemon::DeliveryHandler).to receive(:start)
+      expect_any_instance_of(Pushr::Daemon::MessageHandler).to receive(:start)
       config.save
       app = Pushr::Daemon::App.new(config)
       app.start

data/spec/lib/pushr/daemon/{delivery_handler_spec.rb → message_handler_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'pushr/daemon'
 
-describe Pushr::Daemon::DeliveryHandler do
+describe Pushr::Daemon::MessageHandler do
 
   before(:each) do
     Pushr::Core.configure do |config|
@@ -22,7 +22,7 @@ describe Pushr::Daemon::DeliveryHandler do
     it 'should start' do
       message.save
       connection.connect
-      handler = Pushr::Daemon::DeliveryHandler.new('pushr:app_name:dummy', connection, 'app', 1)
+      handler = Pushr::Daemon::MessageHandler.new('pushr:app_name:dummy', connection, 'app', 1)
       handler.stop
       thread = handler.start
       thread.join
@@ -39,7 +39,7 @@ describe Pushr::Daemon::DeliveryHandler do
       expect_any_instance_of(Pushr::Daemon::DummySupport::ConnectionDummy).to receive(:write).and_raise(error)
       message.save
       connection.connect
-      handler = Pushr::Daemon::DeliveryHandler.new('pushr:app_name:dummy', connection, 'app', 1)
+      handler = Pushr::Daemon::MessageHandler.new('pushr:app_name:dummy', connection, 'app', 1)
       handler.stop
       thread = handler.start
       thread.join

data/spec/spec_helper.rb

@@ -18,9 +18,8 @@ require 'mock_redis'
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
 RSpec.configure do |config|
-  config.raise_errors_for_deprecations!
   config.run_all_when_everything_filtered = true
-  # config.filter_run :focus
+  config.filter_run :focus
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushr-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.0.pre.2
 platform: ruby
 authors:
 - Tom Pesman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Pushr daemon for push notification services like APNS (iOS/Apple) and
-  GCM/C2DM (Android).
+  GCM (Android).
 email:
 - tom@tnux.net
 executables:
@@ -207,9 +207,11 @@ files:
 - lib/pushr/daemon.rb
 - lib/pushr/daemon/app.rb
 - lib/pushr/daemon/delivery_error.rb
-- lib/pushr/daemon/delivery_handler.rb
 - lib/pushr/daemon/feedback_handler.rb
 - lib/pushr/daemon/logger.rb
+- lib/pushr/daemon/message_handler.rb
+- lib/pushr/daemon/pid_file.rb
+- lib/pushr/daemon/settings.rb
 - lib/pushr/feedback.rb
 - lib/pushr/message.rb
 - lib/pushr/redis_connection.rb
@@ -219,9 +221,9 @@ files:
 - spec/lib/pushr/configuration_spec.rb
 - spec/lib/pushr/daemon/app_spec.rb
 - spec/lib/pushr/daemon/delivery_error_spec.rb
-- spec/lib/pushr/daemon/delivery_handler_spec.rb
 - spec/lib/pushr/daemon/feedback_handler_spec.rb
 - spec/lib/pushr/daemon/logger_spec.rb
+- spec/lib/pushr/daemon/message_handler_spec.rb
 - spec/lib/pushr/daemon_spec.rb
 - spec/lib/pushr/feedback_spec.rb
 - spec/lib/pushr/message_spec.rb
@@ -237,7 +239,8 @@ files:
 - spec/support/pushr_message_dummy.rb
 - bin/pushr
 homepage: https://github.com/9to5/pushr-core
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -247,7 +250,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -263,9 +266,9 @@ test_files:
 - spec/lib/pushr/configuration_spec.rb
 - spec/lib/pushr/daemon/app_spec.rb
 - spec/lib/pushr/daemon/delivery_error_spec.rb
-- spec/lib/pushr/daemon/delivery_handler_spec.rb
 - spec/lib/pushr/daemon/feedback_handler_spec.rb
 - spec/lib/pushr/daemon/logger_spec.rb
+- spec/lib/pushr/daemon/message_handler_spec.rb
 - spec/lib/pushr/daemon_spec.rb
 - spec/lib/pushr/feedback_spec.rb
 - spec/lib/pushr/message_spec.rb