pushr-core 1.0.0.pre.4 → 1.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4013d245094a4659d51610f6448da91813c933e
-  data.tar.gz: dad963d156b9b3d0fda568a7fdbc2426d8ef8230
+  metadata.gz: b5aa180695a8bae681de138ad10bacf7533aba86
+  data.tar.gz: 7d57cdb043ea68c5fd70203411be5929566fb07c
 SHA512:
-  metadata.gz: 03bb413cee574cbe9c314fd52352e91ba0265d345afff11b2db1d811800eaede790823367d6c9ab96d33658b178172ba45637424429a34994b18c10947b4f60c
-  data.tar.gz: 568ff09d71fd0546c0c6508f29d0c5cf2579f80159cb763e75772338132530d36dd353969c3ef87c0c784c1f9f73beaf07f3845e7f7a634cc114a39e340d1912
+  metadata.gz: 3fce9432e6d7577f98eef127f4cbc038e09d6986dc7226c5f8c47a8dd90baaf5364478dd31eed989c88b2deebdaf2dca7cc57bcebd7bbf85753616cf76b9c64e
+  data.tar.gz: 5da4bbfb52aea12f3a68d55ad285dff059fdeaa289677e7ffea7e03fe48249369b390a1d3f65c7d1aa56a327ebf3fad62e23b35fb2aba8cd1d646b2c05e90f95

data/README.md

@@ -11,10 +11,11 @@ want to test or contribute to this project.
 
 * Lightening fast push notification delivery
 * Redis for queueing
+* Redis or YAML for configuration
 * Multi-App
 * Multi-Provider ([APNS](https://github.com/9to5/pushr-apns), [GCM](https://github.com/9to5/pushr-gcm))
-* Integrated feedback processing
 * Multi-process
+* Integrated feedback processing
 
 ## Installation
 
@@ -36,14 +37,24 @@ And run `bundle install` to install the gems.
 
 ## Configuration
 
+### Via Redis or YAML File
+
+The configuration of Pushr can either be stored in Redis or in a YAML file. **The default is Redis.**
+
+If you want to use a YAML file, you need to specify it via the `-c` option of the `pushr` daemon.
+Note that this will also override any existing Redis configuration.
+APNS certificates can be loaded from file. If a relative file name is given, it's assumed to be relative to the same path as the YAML config file.
+
+### Redis
+
 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/9to5/pushr-core#generating-certificates)):
 ```ruby
-Pushr::ConfigurationApns.create(app: 'app_name', connections: 2, enabled: true,
-    certificate: File.read('certificate.pem'), sandbox: false, skip_check_for_error: false)
+Pushr::ConfigurationApns.new(app: 'app_name', connections: 2, enabled: true,
+    certificate: File.read('certificate.pem'), sandbox: false, skip_check_for_error: false).save
 ```
 
 The `skip_check_for_error` parameter can be set to `true` or `false`. If set to `true` the APNS service
@@ -53,21 +64,39 @@ sandbox devices in your production environment you should not set `skip_check_fo
 
 APNS Feedback:
 ```ruby
-Pushr::ConfigurationApnsFeedback.create(app: 'app_name', connections: 1, enabled: true,
-    feedback_poll: 60)
+Pushr::ConfigurationApnsFeedback.new(app: 'app_name', connections: 1, enabled: true,
+    feedback_poll: 60).save
 ```
 
 Use this configuration to let a thread check for feedback on all APNS Configurations. It checks every `feedback_poll` in seconds.
+There should be only one instance of this configuration type.
 
 GCM ([see](http://developer.android.com/guide/google/gcm/gs.html)):
 ```ruby
-Pushr::ConfigurationGcm.create(app: 'app_name', connections: 2, enabled: true, api: '<api key here>')
+Pushr::ConfigurationGcm.new(app: 'app_name', connections: 2, enabled: true, api: '<api key here>').save
 ```
 
 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.
 
+### YAML File
+
+If a YAML file is used for configuration, it needs to follow the structure of the example below, and may contain only the
+desired sections. The certificates will be read from files. For security reasons, you might not want to check-in the certificate
+files into your source code repository.
+
+If no absolute path is given of the PEM files, the location is assumed to be relative to the location of the YAML file. An example
+of a YAML configuration file can be found under `./lib/generators/templates/pushr.yml`.
+
+If you are using `Pushr` with Rails, add this to your `config/initializers/pushr.rb` file:
+
+```ruby
+Pushr::Core.configure do |config|
+  config.configuration_file = File.join(Rails.root , 'config/pushr/config.yaml')
+end
+```
+
 ### Generating Certificates for APNS
 
 1. Open up Keychain Access and select the `Certificates` category in the sidebar.
@@ -92,28 +121,53 @@ To start the daemon:
 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.
-    -b, --feedback-processor PATH    Path to the feedback processor. Default: lib/push/feedback_processor.
-    -v, --version                    Print this version of push.
+    -c, --configuration FILE         Read the configuration from this YAML file
+    -o, --redis-host HOST            Hostname of redis instance
+    -r, --redis-port PORT            Port of redis instance
+    -n, --redis-namespace NAMESPACE  Namespace on redis connection
+    -p, --pid-file PATH              Path to write PID file. Relative to current directory unless absolute.
+    -b, --feedback-processor PATH    Path to the feedback processor. Default: none. Example: 'lib/pushr/feedback_processor'
+    -s, --stats-processor PATH       Path to the stats processor. Default: none. Example: 'lib/pushr/stats_processor'
+    -v, --version                    Print this version of pushr.
     -h, --help                       You're looking at it.
 
 ## Sending notifications
 
 APNS:
 ```ruby
-Pushr::MessageApns.create(
+Pushr::MessageApns.new(
     app: 'app_name',
     device: '<APNS device_token here>',
     alert: 'Hello World',
     sound: '1.aiff',
     badge: 1,
+    expiry: 1.day.from_now.to_i,
+    attributes_for_device: {key: 'MSG'},
+    priority: 10,
+    content_available: 1).save
+```
+
+
+Silent Push Notification via APNS:
+
+```ruby
+Push::MessageApns.create(
+    app: 'app_name',
+    device: '<APNS device_token here>',
+    alert: nil,
+    sound: nil,
+    badge: 1,
+    content_available: 1,   # see footnote
     expiry: 1.day.to_i,
-    attributes_for_device: {key: 'MSG'})
+    attributes_for_device: nil)
 ```
 
+Use `content_available: 1` if the iOS device should start your app upon receiving the silent push notification.
+
+
 GCM:
 ```ruby
-Pushr::MessageGcm.create(
+Pushr::MessageGcm.new(
     app: 'app_name',
     registration_ids: ['<GCM registration_id here>', '<GCM registration_id here>'],
     notification_key: 'notification_key_name',
@@ -122,15 +176,36 @@ Pushr::MessageGcm.create(
     time_to_live: 24 * 60 * 60,
     restricted_package_name: 'com.example.gcm',
     dry_run: false,
-    collapse_key: 'MSG')
+    collapse_key: 'MSG').save
 ```
 
 ## 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
+installer installs the `lib/pushr/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.
 
+## Tracking your own Message IDs
+
+If you have your own message-IDs for notifications in your system and want to track them throughout the message delivery, so they
+show up in all the logs you can add this during message creation:
+```ruby
+  external_id: your_external_id_here
+```
+
+You can also set the prefix under which your message ID will show up in the logs:
+```ruby
+Pushr::Core.configure do |config|
+  config.external_id_tag = 'MyID' # will pre-fix the above message ID with this string
+end
+```
+
+This can be useful if you want to automatically ingest your log files for analytics.
+
+Furthermore you can hand your message-ID to the mobile device, so it can either log it, or the mobile device can return a call to
+an API endpoint to record the time the message was actually received. This way you can measure end-to-end delivery times. This
+works best for silent push notifications in APNS.
+
 ## Heroku
 
 Push runs on Heroku with the following line in the `Procfile`.

data/bin/pushr

@@ -9,6 +9,7 @@ require 'pushr/daemon'
 
 settings = Pushr::Daemon::Settings.new
 banner = 'Usage: pushr [options]'
+connection = {}
 ARGV.options do |opts|
   opts.banner = banner
 
@@ -16,6 +17,22 @@ ARGV.options do |opts|
     settings.foreground = true
   end
 
+  opts.on('-c FILE', '--configuration FILE', 'Read the configuration from this YAML file') do |file|
+    Pushr::Core.configuration_file = file
+  end
+
+  opts.on('-o HOST', '--redis-host HOST', String, 'Hostname of redis instance') do |host|
+    connection[:host] = host
+  end
+
+  opts.on('-r PORT', '--redis-port PORT', String, 'Port of redis instance') do |port|
+    connection[:port] = port
+  end
+
+  opts.on('-n NAMESPACE', '--redis-namespace NAMESPACE', String, 'Namespace on redis connection') do |namespace|
+    connection[:namespace] = namespace
+  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
@@ -44,6 +61,13 @@ ARGV.options do |opts|
   opts.parse!
 end
 
+Pushr::Core.configure do |config|
+  x = { }
+  x[:namespace] = connection[:namespace] if connection[:namespace]
+  x[:url] = "redis://#{connection[:host]}:#{connection[:port] || 6379}/0" if connection[:host]
+  config.redis = x
+end
+
 if ENV['AIRBRAKE_API_KEY']
   require 'airbrake'
   settings.error_notification = true

data/lib/generators/templates/feedback_processor.rb

@@ -15,11 +15,6 @@ module Pushr
           # device = feedback.update_to
           Pushr::Daemon.logger.info('[FeedbackProcessor] Pushr::FeedbackGcm update')
         end
-      elsif feedback.instance_of? Pushr::FeedbackC2dm
-        if feedback.follow_up == 'delete'
-          # TODO: delete c2dm device
-          Pushr::Daemon.logger.info('[FeedbackProcessor] Pushr::FeedbackC2dm delete')
-        end
       elsif feedback.instance_of? Pushr::FeedbackApns
         if feedback.follow_up == 'delete'
           # TODO: delete apns device

data/lib/generators/templates/pushr.yml

@@ -0,0 +1,53 @@
+# Configurations for all Pushr Gems
+---
+
+# GCM (Android Messaging):
+- type: Pushr::ConfigurationGcm
+  app: gcm-development
+  enabled: true
+  connections: 1
+  api: your-api-key-here
+
+# APNS (Apple Messaging):
+- type: Pushr::ConfigurationApns
+  app: ios-development
+  enabled: true
+  connections: 1
+  skip_check_for_error: false
+  sandbox: true
+  certificate: filename.pem
+
+- type: Pushr::ConfigurationApns
+  app: ios-development
+  enabled: true
+  connections: 1
+  sandbox: true
+  certificate: pushr/ios-development.pem
+
+- type: Pushr::ConfigurationApns
+  app: ios-production
+  enabled: true
+  connections: 1
+  sandbox: false
+  certificate: pushr/ios-production.pem
+
+- type: Pushr::ConfigurationApns
+  app: ios-beta
+  enabled: true
+  connections: 1
+  sandbox: true
+  certificate: pushr/ios-beta.pem
+
+- type: Pushr::ConfigurationApns
+  app: ios-enterprise
+  enabled: true
+  connections: 1
+  sandbox: false
+  certificate: pushr/ios-enterprise.pem
+
+# APNS Feedback (Feedback Service for all APNS Connections):
+- type: Pushr::ConfigurationApnsFeedback
+  app: apns-feedback
+  enabled: true
+  connections: 1
+  feedback_poll: 300 # seconds

data/lib/pushr/configuration.rb

@@ -2,6 +2,7 @@ module Pushr
   class Configuration
     include ActiveModel::Validations
 
+    attr_accessor :id, :type, :app, :enabled, :connections
     validates :app, presence: true
     validates :connections, presence: true
     validates :connections, numericality: { greater_than: 0, only_integer: true }
@@ -30,19 +31,40 @@ module Pushr
       Pushr::Core.redis { |conn| conn.hdel('pushr:configurations', key) }
     end
 
+    def to_json
+      MultiJson.dump(to_hash)
+    end
+
     def self.all
-      configurations = Pushr::Core.redis { |conn| conn.hgetall('pushr:configurations') }
-      configurations.each { |key, config| configurations[key] = instantiate(config, key) }
-      configurations.values
+      if Pushr::Core.configuration_file # only set if file exists
+        read_from_yaml_file
+      else
+        read_from_redis
+      end
     end
 
     def self.find(key)
       config = Pushr::Core.redis { |conn| conn.hget('pushr:configurations', key) }
-      instantiate(config, key)
+      instantiate_json(config, key)
+    end
+
+    def self.read_from_yaml_file
+      filename = Pushr::Core.configuration_file
+      configs = File.open(filename) { |fd| YAML.load(fd) }
+      configs.map { |hsh| instantiate(hsh) }
+    end
+
+    def self.read_from_redis
+      configurations = Pushr::Core.redis { |conn| conn.hgetall('pushr:configurations') }
+      configurations.each { |key, config| configurations[key] = instantiate_json(config, key) }
+      configurations.values
+    end
+
+    def self.instantiate_json(config, id)
+      instantiate(::MultiJson.load(config).merge!(id: id))
     end
 
-    def self.instantiate(config, id)
-      hsh = ::MultiJson.load(config).merge!(id: id)
+    def self.instantiate(hsh)
       klass = hsh['type'].split('::').reduce(Object) { |a, e| a.const_get e }
       klass.new(hsh)
     end

data/lib/pushr/core.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 require 'active_model'
 require 'multi_json'
 require 'pushr/version'
@@ -9,7 +10,7 @@ require 'pushr/redis_connection'
 module Pushr
   module Core
     NAME = 'Pushr'
-    DEFAULTS = {}
+    DEFAULTS = { external_id_tag: 'external_id' }
 
     attr_writer :options
 
@@ -20,8 +21,8 @@ module Pushr
     ##
     # Configuration for Pushr, use like:
     #
-    #   Pushr.configure do |config|
-    #     config.redis = { :namespace => 'myapp', :size => 1, :url => 'redis://myhost:8877/mydb' }
+    #   Pushr::Core.configure do |config|
+    #     config.redis = { namespace: 'myapp', url: 'redis://myhost:8877/mydb' }
     #   end
     def self.configure
       yield self
@@ -35,8 +36,8 @@ module Pushr
 
     def self.redis=(hash)
       if hash.is_a?(Hash)
-        @redis = RedisConnection.create(hash)
-        options[:namespace] ||= hash[:namespace]
+        options.merge!(hash)
+        @redis = RedisConnection.create(options)
       elsif hash.is_a?(ConnectionPool)
         @redis = hash
       else
@@ -44,8 +45,31 @@ module Pushr
       end
     end
 
+    def self.external_id_tag=(value)
+      options[:external_id_tag] = value
+    end
+
+    def self.external_id_tag
+      options[:external_id_tag]
+    end
+
+    def self.configuration_file
+      options[:configuration_file]
+    end
+
+    def self.configuration_file=(filename)
+      if filename
+        filename = File.join(Dir.pwd, filename) unless Pathname.new(filename).absolute?
+        if File.file?(filename)
+          options[:configuration_file] = filename
+        else
+          fail ArgumentError, "can not find config file: #{filename}"
+        end
+      end
+    end
+
     # instruments with a block
-    def self.instrument(name, payload = {}, &block)
+    def self.instrument(name, payload = {})
       ActiveSupport::Notifications.instrument(name, payload) do
         yield
       end

data/lib/pushr/daemon/app.rb

@@ -7,7 +7,7 @@ module Pushr
         attr_reader :apps
 
         def load
-          @apps = Configuration.all.keep_if { |c| c.enabled == true }.map { |c| App.new(c) }
+          @apps = Pushr::Configuration.all.keep_if { |c| c.enabled == true }.map { |c| App.new(c) }
         end
 
         def total_connections

data/lib/pushr/daemon/delivery_error.rb

@@ -12,7 +12,7 @@ module Pushr
       end
 
       def message
-        "Unable to deliver message #{@message.inspect}, received #{@source} error #{@code} (#{@description})"
+        "Unable to deliver message #{@message.to_json}, received #{@source} error #{@code} (#{@description})"
       end
     end
   end

data/lib/pushr/feedback.rb

@@ -1,6 +1,8 @@
 module Pushr
   class Feedback
     include ActiveModel::Validations
+
+    attr_accessor :type, :app
     validates :app, presence: true
     validates :device, presence: true
     validates :follow_up, presence: true
@@ -21,6 +23,10 @@ module Pushr
       end
     end
 
+    def to_json
+      MultiJson.dump(to_hash)
+    end
+
     def self.next(timeout = 3)
       Pushr::Core.redis do |conn|
         feedback = conn.blpop('pushr:feedback', timeout: timeout)

data/lib/pushr/message.rb

@@ -2,6 +2,7 @@ module Pushr
   class Message
     include ActiveModel::Validations
 
+    attr_accessor :type, :app, :external_id
     validates :app, presence: true
 
     def initialize(attributes = {})
@@ -19,9 +20,8 @@ module Pushr
       end
     end
 
-    def save!
-      save || fail(RecordNotSaved)
-      # fail 'x' unless save
+    def to_json
+      MultiJson.dump(to_hash)
     end
 
     def self.next(queue_name, timeout = 3)

data/lib/pushr/redis_connection.rb

@@ -8,7 +8,6 @@ module Pushr
       url = options[:url] || determine_redis_provider || 'redis://localhost:6379/0'
       driver = options[:driver] || 'ruby'
       # need a connection for Fetcher and Retry
-      # size = options[:size] || (Pushr.server? ? (Pushr.options[:concurrency] + 2) : 5)
       size = options[:size] || 5
       namespace = options[:namespace] || Pushr::Core.options[:namespace]
 

data/lib/pushr/version.rb

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

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

@@ -13,8 +13,10 @@ describe Pushr::Daemon::App do
     allow(logger).to receive(:error)
     allow(logger).to receive(:warn)
     Pushr::Daemon.logger = logger
+    Pushr::Daemon.config = settings
   end
 
+  let(:settings) { Pushr::Daemon::Settings.new }
   let(:config) { Pushr::ConfigurationDummy.new(app: 'app_name', connections: 1, enabled: true) }
   describe 'self' do
     before(:each) do

data/spec/support/pushr_configuration_dummy.rb

@@ -1,22 +1,13 @@
 module Pushr
   class ConfigurationDummy < Pushr::Configuration
-    attr_accessor :id, :type, :app, :enabled, :connections, :test_attr
+    attr_accessor :test_attr
 
     def name
       :dummy
     end
 
-    def to_json(args = nil)
-      hsh = {
-        id: [@app, name].join(':'),
-        type: self.class.to_s,
-        app: app,
-        enabled: enabled,
-        connections: connections,
-        test_attr: test_attr
-      }
-
-      ::MultiJson.dump(hsh)
+    def to_hash(_ = nil)
+      { id: [@app, name].join(':'), type: self.class.to_s, app: app, enabled: enabled, connections: connections, test_attr: test_attr }
     end
   end
 end

data/spec/support/pushr_dummy.rb

@@ -13,7 +13,7 @@ module Pushr
           connection = DummySupport::ConnectionDummy.new(configuration, i + 1)
           connection.connect
 
-          handler = MessageHandler.new("pushr:#{configuration.app}:#{configuration.name}", connection, configuration.app, i + 1)
+          handler = MessageHandler.new("pushr:#{configuration.key}", connection, configuration.app, i + 1)
           handler.start
           @handlers << handler
         end

data/spec/support/pushr_feedback_dummy.rb

@@ -1,11 +1,11 @@
 module Pushr
   class FeedbackDummy < Pushr::Feedback
-    attr_accessor :type, :app, :device, :follow_up, :failed_at
+    attr_accessor :device, :follow_up, :failed_at
     validates :device, format: { with: /\A[a-z0-9]{64}\z/ }
     validates :follow_up, inclusion: { in: %w(delete), message: '%{value} is not a valid follow-up' }
 
-    def to_json(args = nil)
-      MultiJson.dump(type: 'Pushr::FeedbackDummy', app: app, device: device, follow_up: follow_up, failed_at: failed_at)
+    def to_hash(_ = nil)
+      { type: 'Pushr::FeedbackDummy', app: app, device: device, follow_up: follow_up, failed_at: failed_at }
     end
   end
 end

data/spec/support/pushr_invalid_configuration_dummy.rb

@@ -4,5 +4,9 @@ module Pushr
     def name
       :invalid_dummy
     end
+
+    def to_hash
+      { type: self.class.to_s, app: app, enabled: enabled, connections: connections, test_attr: test_attr }
+    end
   end
 end

data/spec/support/pushr_message_dummy.rb

@@ -1,13 +1,13 @@
 module Pushr
   class MessageDummy < Pushr::Message
     POSTFIX = 'dummy'
-    attr_accessor :postfix, :type, :app
+    attr_accessor :device_id
 
     def to_message
     end
 
-    def to_json(args = nil)
-      MultiJson.dump(type: self.class.to_s, app: app)
+    def to_hash(_ = nil)
+      { type: self.class.to_s, app: app, device_id: device_id }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushr-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.4
+  version: 1.0.0.rc.1
 platform: ruby
 authors:
 - Tom Pesman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/generators/templates/feedback_processor.rb
+- lib/generators/templates/pushr.yml
 - lib/pushr/configuration.rb
 - lib/pushr/core.rb
 - lib/pushr/daemon.rb