pushr-core 1.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c269b18e78e10769483231241fb24d5244b28d8
+  data.tar.gz: fc7fcd4d877e6061ac263fd97530777158b053aa
+SHA512:
+  metadata.gz: bee51328463ac62dd6731e8e049e230c7a0ed582ee38bf9065ed8019989c8b43267067512806c596862e44ab547f61e76a78d6de470457866982ea61780e714a
+  data.tar.gz: 49e84cf9943ee2293a06fd4ecc84d12a9a00580b5a4a4a21329c097084f40c854ea1249b8b02efa8a4473c88a6e6a09a3934eeee5e5da00ee9e2c3a0051ac72f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,156 @@
+# Pushr
+
+[![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
+
+* 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
+
+Add to your `GemFile`
+
+    gem 'push-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'
+
+For __GCM__ (Android: Google Cloud Messaging):
+
+    gem 'push-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`):
+
+APNS ([see](https://github.com/tompesman/push-core#generating-certificates)):
+```ruby
+Pushr::ConfigurationApns.create(app: 'app_name', connections: 2, enabled: true,
+    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>')
+```
+
+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>')
+```
+
+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
+
+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.
+3. Select both the certificate and private key.
+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.
+
+    `openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem`
+
+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. 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(
+    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
+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' },
+    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
+
+## Heroku
+
+Push runs on Heroku with the following line in the `Procfile`.
+
+    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/pushr

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require
+
+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
+
+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)
+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
+  end
+end
+
+Pushr::Daemon.start(config)

data/lib/generators/templates/feedback_processor.rb

@@ -0,0 +1,33 @@
+module Pushr
+  class FeedbackProcessor
+    def initialize
+      # make sure you've set the RAILS_ENV variable
+      load 'config/environment.rb'
+    end
+
+    def process(feedback)
+      if feedback.instance_of? Pushr::FeedbackGcm
+        if feedback.follow_up == 'delete'
+          # TODO: delete gcm device
+          Pushr::Daemon.logger.info('[FeedbackProcessor] Pushr::FeedbackGcm delete')
+        elsif feedback.follow_up == 'update'
+          # TODO: update gcm device
+          # 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
+          Pushr::Daemon.logger.info('[FeedbackProcessor] Pushr::FeedbackApns delete')
+        end
+      else
+        Pushr::Daemon.logger.info('[FeedbackProcessor] Unknown feedback type')
+      end
+    end
+  end
+end

data/lib/pushr/configuration.rb

@@ -0,0 +1,49 @@
+module Pushr
+  class Configuration
+    include ActiveModel::Validations
+
+    validates :app, presence: true
+    validates :connections, presence: true
+    validates :connections, numericality: { greater_than: 0, only_integer: true }
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    def key
+      "#{app}:#{name}"
+    end
+
+    def save
+      if valid?
+        Pushr::Core.redis { |conn| conn.hset('pushr:configurations', key, to_json) }
+        return true
+      else
+        return false
+      end
+    end
+
+    def delete
+      Pushr::Core.redis { |conn| conn.hdel('pushr:configurations', key) }
+    end
+
+    def self.all
+      configurations = Pushr::Core.redis { |conn| conn.hgetall('pushr:configurations') }
+      configurations.each { |key, config| configurations[key] = instantiate(config, key) }
+      configurations.values
+    end
+
+    def self.find(key)
+      config = Pushr::Core.redis { |conn| conn.hget('pushr:configurations', key) }
+      instantiate(config, key)
+    end
+
+    def self.instantiate(config, id)
+      hsh = ::MultiJson.load(config).merge!(id: id)
+      klass = hsh['type'].split('::').reduce(Object) { |a, e| a.const_get e }
+      klass.new(hsh)
+    end
+  end
+end

data/lib/pushr/core.rb

@@ -0,0 +1,54 @@
+require 'active_model'
+require 'multi_json'
+require 'pushr/version'
+require 'pushr/configuration'
+require 'pushr/message'
+require 'pushr/feedback'
+require 'pushr/redis_connection'
+
+module Pushr
+  module Core
+    NAME = 'Pushr'
+    DEFAULTS = {}
+
+    attr_writer :options
+
+    def self.options
+      @options ||= DEFAULTS.dup
+    end
+
+    ##
+    # Configuration for Pushr, use like:
+    #
+    #   Pushr.configure do |config|
+    #     config.redis = { :namespace => 'myapp', :size => 1, :url => 'redis://myhost:8877/mydb' }
+    #   end
+    def self.configure
+      yield self
+    end
+
+    def self.redis(&block)
+      fail ArgumentError, 'requires a block' unless block
+      @redis ||= Pushr::RedisConnection.create
+      @redis.with(&block)
+    end
+
+    def self.redis=(hash)
+      if hash.is_a?(Hash)
+        @redis = RedisConnection.create(hash)
+        options[:namespace] ||= hash[:namespace]
+      elsif hash.is_a?(ConnectionPool)
+        @redis = hash
+      else
+        fail ArgumentError, 'redis= requires a Hash or ConnectionPool'
+      end
+    end
+
+    # instruments with a block
+    def self.instrument(name, payload = {}, &block)
+      ActiveSupport::Notifications.instrument(name, payload) do
+        yield
+      end
+    end
+  end
+end

data/lib/pushr/daemon.rb

@@ -0,0 +1,116 @@
+require 'thread'
+require 'logger'
+require 'multi_json'
+require 'pushr/redis_connection'
+require 'pushr/daemon/delivery_error'
+require 'pushr/daemon/delivery_handler'
+require 'pushr/daemon/feedback_handler'
+require 'pushr/daemon/logger'
+require 'pushr/daemon/app'
+
+module Pushr
+  module Daemon
+    class << self
+      attr_accessor :logger, :config, :feedback_handler
+    end
+
+    def self.start(config)
+      self.config = config
+      self.logger = Logger.new(foreground: config.foreground, error_notification: config.error_notification)
+      setup_signal_hooks
+
+      daemonize unless config.foreground
+      write_pid_file
+
+      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
+      Pushr::Core.configure do |config|
+        config.redis = { size: connections }
+      end
+    end
+
+    def self.load_stats_processor
+      if config.stats_processor
+        require "#{Dir.pwd}/#{config.stats_processor}"
+      end
+    rescue => e
+      logger.error("Failed to stats_processor: #{e.inspect}")
+    end
+
+    def self.setup_signal_hooks
+      @shutting_down = false
+
+      %w(SIGINT SIGTERM).each do |signal|
+        Signal.trap(signal) do
+          handle_shutdown_signal
+        end
+      end
+    end
+
+    def self.handle_shutdown_signal
+      exit 1 if @shutting_down
+      @shutting_down = true
+      shutdown
+    end
+
+    def self.shutdown
+      print "\nShutting down..."
+      feedback_handler.stop
+      App.stop
+
+      while Thread.list.count > 1
+        sleep 0.1
+        print '.'
+      end
+      print "\n"
+      delete_pid_file
+    end
+
+    def self.daemonize
+      exit if pid = fork
+      Process.setsid
+      exit if pid = fork
+
+      Dir.chdir '/'
+      File.umask 0000
+
+      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)
+    end
+  end
+end