rpush 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46ba458f1bce103da495d96eb5c823d75a8dbb65
-  data.tar.gz: 39fd41cb301888ba9e93f6b01a76b3688ed2cf08
+  metadata.gz: bcc9513fb56f7be786d23e453cce23438c9ea9aa
+  data.tar.gz: cf5b79d6e9306478a509680494924b2e99335683
 SHA512:
-  metadata.gz: e6818f8d0a1adc9990e1d7f28b2a4b4299ab1d38a9f43be7b23eb281a74d2743d72ab4bbc75dc7cf51c610afee9160f77ef2a929d344570d64f6da58053e6979
-  data.tar.gz: 1eb53814eefda8f89a74f97dc85d7f8d54ff679041eb81ce1793c18be91655f7aae2e5518fceeaf61ad3ffbb127664a0b9e5446db2c307c67ff75e22ec8921ef
+  metadata.gz: a88119dfb66901691ec8d508f63f448b43d6387e7299b8c503c27ad04b3051056d9b51f2b593021163da1c1a072bd4ddc6cc006caceaa877947c2874095a7c8b
+  data.tar.gz: 8f636b57c346bfe27d16955876a47fa0c9def6a9c64bffd192c46474033bb5ef4885d8edea067d0e2c7ae10a64a87061f6e066e051001a1ed4db9cd43ac823fd

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.1.0 (Oct 4, 2014)
+  * Bump APNs max payload size to 2048 for iOS 8.
+  * Add 'category' for iOS 8.
+  * Add url_args for Safari Push Notification Support (#77).
+  * Improved command-line interface.
+  * Rails integration is now optional.
+  * Added log_level config option.
+  * log_dir is now deprecated and has no effect, use log_file instead.
+
 ## 2.0.1 (Sept 13, 2014)
   * Add ssl_certificate_revoked reflection (#68).
   * Fix for Postgis support in 2.0.0 migration (#70).

data/README.md

@@ -1,7 +1,7 @@
-[![Build Status](https://secure.travis-ci.org/rpush/rpush.png?branch=master)](http://travis-ci.org/rpush/rpush)
-[![Code Climate](https://codeclimate.com/github/rpush/rpush.png)](https://codeclimate.com/github/rpush/rpush)
-[![Code Coverage](https://codeclimate.com/github/rpush/rpush/coverage.png)](https://codeclimate.com/github/rpush/rpush)
-[![Gem Version](https://badge.fury.io/rb/rpush.png)](http://badge.fury.io/rb/rpush)
+[![Build Status](https://secure.travis-ci.org/rpush/rpush.svg?branch=master)](http://travis-ci.org/rpush/rpush)
+[![Code Climate](https://codeclimate.com/github/rpush/rpush/badges/gpa.svg)](https://codeclimate.com/github/rpush/rpush)
+[![Test Coverage](https://codeclimate.com/github/rpush/rpush/badges/coverage.svg)](https://codeclimate.com/github/rpush/rpush)
+[![Gem Version](https://badge.fury.io/rb/rpush.svg)](http://badge.fury.io/rb/rpush)
 
 <img src="https://raw.github.com/rpush/rpush/master/logo.png" align="right" width="200px" />
 
@@ -9,16 +9,16 @@
 
 * Supported services:
   * [**Apple Push Notification Service**](#apple-push-notification-service)
+    * Including Safari Push Notifications.
   * [**Google Cloud Messaging**](#google-cloud-messaging)
   * [**Amazon Device Messaging**](#amazon-device-messaging)
   * [**Windows Phone Push Notification Service**](#windows-phone-notification-service)
 
 * Supported storage backends:
-  * **ActiveRecord**
-  * **Redis**
-  * More coming!
+  * [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord)
+  * [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis)
 
-* Seamless Rails integration (3 & 4) .
+* Optional Rails integration (version 3 & 4).
 * Scales vertically (threading) and horizontally (multiple processes).
 * Designed for uptime - new apps are loaded automatically, signal `HUP` to update running apps.
 * Run as a daemon or inside an [existing process](https://github.com/rpush/rpush/wiki/Embedding-API).
@@ -35,11 +35,11 @@ Add it to your Gemfile:
 gem 'rpush'
 ```
 
-Generate the migrations, rpush.rb and migrate:
+Initialize Rpush into your project. Rails will be detected automatically.
 
 ```
-rails g rpush
-rake db:migrate
+cd /path/to/project
+rpush init
 ```
 
 ### Create an App & Notification
@@ -67,6 +67,8 @@ n.data = { foo: :bar }
 n.save!
 ```
 
+The `url_args` attribute is available for Safari Push Notifications.
+
 You should also implement the [ssl_certificate_will_expire](https://github.com/rpush/rpush/wiki/Reflection-API) reflection to monitor when your certificate is due to expire.
 
 #### Google Cloud Messaging
@@ -134,13 +136,17 @@ It is recommended to run Rpush as a separate process in most cases, though embed
 
 #### As a daemon (recommended):
 
-    cd /path/to/rails/app
-    rpush <Rails environment> [options]
+```
+cd /path/to/project
+rpush start
+```
+
+See `rpush help` for all available commands and options.
 
 #### Embedded inside an existing process
 
 ```ruby
-# Call this during startup of your application, for example, by adding it to the end of config/initializers/rpush.rb
+# Call this during startup of your application, for example, by adding it to the end of config/rpush.rb
 Rpush.embed
 ```
 
@@ -157,11 +163,11 @@ See [Push API](https://github.com/rpush/rpush/wiki/Push-API) for more details.
 
 ### Configuration
 
-See [Configuration](https://github.com/rpush/rpush/wiki/Configuration) for a list of options, or run `rpush --help`.
+See [Configuration](https://github.com/rpush/rpush/wiki/Configuration) for a list of options.
 
 ### Updating Rpush
 
-If you're using ActiveRecord, you should run `rails g rpush` after upgrading Rpush to check for any new migrations.
+You should run `rails init` after upgrading Rpush to check for configuration and migration changes.
 
 ### Wiki
 
@@ -191,8 +197,6 @@ If you're using ActiveRecord, you should run `rails g rpush` after upgrading Rpu
 
 ### Contributing
 
-Fork as usual and go crazy!
-
 When running specs, please note that the ActiveRecord adapter can be changed by setting the `ADAPTER` environment variable. For example: `ADAPTER=postgresql rake`.
 
 Available adapters for testing are `mysql`, `mysql2` and `postgresql`.
@@ -200,3 +204,5 @@ Available adapters for testing are `mysql`, `mysql2` and `postgresql`.
 Note that the database username is changed at runtime to be the currently logged in user's name. So if you're testing
 with mysql and you're using a user named 'bob', you will need to grant a mysql user 'bob' access to the 'rpush_test'
 mysql database.
+
+To switch between ActiveRecord and Redis, set the `CLIENT` environment variable to either `:active_record` or `:redis`.

data/bin/rpush

@@ -1,45 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
 require 'rpush'
-
-environment = ARGV[0]
-
-config = Rpush::ConfigurationWithoutDefaults.new
-
-options = ARGV.options do |opts|
-  opts.banner = 'Usage: rpush <Rails environment> [options]'
-  opts.on('-f', '--foreground', 'Run in the foreground.') { config.foreground = true }
-  opts.on('-P N', '--db-poll N', Integer, "Frequency in seconds to check for new notifications.") { |n| config.push_poll = n }
-  opts.on('-F N', '--feedback-poll N', Integer, "Frequency in seconds to check for feedback.") { |n| config.feedback_poll = n }
-  opts.on('-e', '--no-error-checks', 'Disable APNs error checking after notification delivery.') { config.check_for_errors = false } # deprecated
-  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 N', '--batch-size N', Integer, 'Storage backend notification batch size.') { |n| config.batch_size = n }
-  opts.on('-B', '--[no-]batch-storage-updates', 'Perform storage updates in batches.') { |v| config.batch_storage_updates = v } # deprecated
-  opts.on('-v', '--version', 'Print the version.') do
-    puts "rpush #{Rpush::VERSION}"
-    exit
-  end
-  opts.on('-h', '--help', 'You\'re looking at it.') do
-    hidden_switches = %w(-e --no-error-checks)
-    puts opts.to_s.split("\n").delete_if do |line|
-      hidden_switches.any? { |s| line =~ /#{s}/ }
-    end.join("\n")
-    exit
-  end
-end
-
-if environment.nil? || environment =~ /^-/
-  puts options.to_s
-  exit 1
-end
-
-options.parse!
-
-ENV['RAILS_ENV'] = environment
-load 'config/environment.rb'
-load 'config/initializers/rpush.rb' if File.exist?('config/initializers/rpush.rb')
-
-Rpush.config.update(config)
-Rpush.require_for_daemon
-Rpush::Daemon.start
+Rpush::CLI.start(ARGV)

data/lib/generators/rpush_config_generator.rb

@@ -0,0 +1,7 @@
+class RpushConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_config
+    copy_file 'rpush.rb', $RPUSH_CONFIG_PATH
+  end
+end

data/lib/generators/{rpush_generator.rb → rpush_migration_generator.rb}

@@ -1,4 +1,4 @@
-class RpushGenerator < Rails::Generators::Base
+class RpushMigrationGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
   source_root File.expand_path('../templates', __FILE__)
 
@@ -25,22 +25,17 @@ class RpushGenerator < Rails::Generators::Base
     end
 
     add_rpush_migration('rpush_2_0_0_updates')
-  end
-
-   def copy_config
-    copy_file 'rpush.rb', 'config/initializers/rpush.rb'
+    add_rpush_migration('rpush_2_1_0_updates')
   end
 
   protected
 
-  def add_rpush_migration(template)
-    if !has_migration?(template)
-      migration_template "#{template}.rb", "db/migrate/#{template}.rb"
-    end
-  end
-
   def has_migration?(template)
     migration_dir = File.expand_path('db/migrate')
     self.class.migration_exists?(migration_dir, template)
+   end
+
+  def add_rpush_migration(template)
+      migration_template "#{template}.rb", "db/migrate/#{template}.rb"
   end
 end

data/lib/generators/templates/rpush.rb

@@ -1,30 +1,30 @@
- # Rpush configuration. Options set here are overridden by command-line options.
-
- Rpush.configure do |config|
+Rpush.configure do |config|
 
   # Supported clients are :active_record and :redis.
-  # config.client = :active_record
+  config.client = :active_record
 
   # Options passed to Redis.new
   # config.redis_options = {}
 
-  # Run in the foreground?
-  # config.foreground = false
-
   # Frequency in seconds to check for new notifications.
-  # config.push_poll = 2
+  config.push_poll = 2
 
   # Frequency in seconds to check for feedback
-  # config.feedback_poll = 60
+  config.feedback_poll = 60
 
   # The maximum number of notifications to load from the store every `push_poll` seconds.
   # If some notifications are still enqueued internally, Rpush will load the batch_size less
   # the number enqueued. An exception to this is if the service is able to receive multiple
   # notification payloads over the connection with a single write, such as APNs.
-  # config.batch_size = 100
+  config.batch_size = 100
+
+  # Path to write PID file. Relative to current directory unless absolute.
+  config.pid_file = 'tmp/rpush.pid'
+
+  # Path to log file. Relative to current directory unless absolute.
+  config.log_file = 'log/rpush.log'
 
-  # Path to write PID file. Relative to Rails root unless absolute.
-  # config.pid_file = '/path/to/rpush.pid'
+  config.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::INFO
 
   # Define a custom logger.
   # config.logger = MyLogger.new

data/lib/generators/templates/rpush_2_0_0_updates.rb

@@ -33,7 +33,8 @@ class Rpush200Updates < ActiveRecord::Migration
   end
 
   def self.adapter_name
-    ActiveRecord::Base.configurations[Rails.env]['adapter']
+    env = (defined?(Rails) && Rails.env) ? Rails.env : 'development'
+    ActiveRecord::Base.configurations[env]['adapter']
   end
 
   def self.postgresql?

data/lib/generators/templates/rpush_2_1_0_updates.rb

@@ -0,0 +1,11 @@
+class Rpush210Updates < ActiveRecord::Migration
+  def self.up
+    add_column :rpush_notifications, :url_args, :text, null: true
+    add_column :rpush_notifications, :category, :string, null: true
+  end
+
+  def self.down
+    remove_column :rpush_notifications, :url_args
+    remove_column :rpush_notifications, :category
+  end
+end

data/lib/rpush.rb

@@ -1,14 +1,19 @@
+require 'logger'
 require 'multi_json'
 require 'active_support/all'
 
 module Rpush
   def self.attr_accessible_available?
     require 'rails'
+  rescue LoadError
+    false
+  else
     ::Rails::VERSION::STRING < '4' || defined?(::ActiveRecord::MassAssignmentSecurity)
   end
 end
 
 require 'rpush/version'
+require 'rpush/cli'
 require 'rpush/deprecation'
 require 'rpush/deprecatable'
 require 'rpush/logger'
@@ -24,14 +29,17 @@ module Rpush
     defined? JRUBY_VERSION
   end
 
-  def self.require_for_daemon
-    require 'rpush/daemon'
-  end
-
   def self.logger
     @logger ||= Logger.new
   end
 
+  def self.root
+    require 'rails'
+    Rails.root || Dir.pwd
+  rescue LoadError
+    Dir.pwd
+  end
+
   class << self
     attr_writer :logger
   end

data/lib/rpush/apns_feedback.rb

@@ -1,6 +1,6 @@
 module Rpush
   def self.apns_feedback
-    Rpush.require_for_daemon
+    require 'rpush/daemon'
     Rpush::Daemon.initialize_store
 
     Rpush::Apns::App.all.each do |app|

data/lib/rpush/cli.rb

@@ -0,0 +1,133 @@
+# encoding: UTF-8
+
+require 'thor'
+require 'term/ansicolor'
+
+module Rpush
+  class CLI < Thor
+    include Term::ANSIColor
+
+    def self.detect_rails?
+      ['bin/rails', 'script/rails'].any? { |path| File.exist?(path) }
+    end
+
+    def self.default_config_path
+      detect_rails? ? 'config/initializers/rpush.rb' : 'config/rpush.rb'
+    end
+
+    class_option :config, type: :string, aliases: '-c', default: default_config_path
+    class_option :rails_env, type: :string, aliases: '-e', default: 'development'
+
+    option :foreground, type: :boolean, aliases: '-f', default: false
+    option 'pid-file', type: :string, aliases: '-p'
+    desc 'start', 'Start Rpush'
+    def start
+      check_ruby_version
+
+      if detect_rails? && options[:rails_env]
+        STDOUT.write "* Booting Rails '#{options[:rails_env]}' environment... "
+        STDOUT.flush
+        ENV['RAILS_ENV'] = options[:rails_env]
+        load 'config/environment.rb'
+        puts green('✔')
+      end
+
+      load_config
+      require 'rpush/daemon'
+      Rpush::Daemon.start
+    end
+
+    desc 'stop', 'Stop Rpush'
+    option 'pid-file', type: :string, aliases: '-p'
+    def stop
+      check_ruby_version
+      load_config
+      ensure_pid_file
+
+      if File.exist?(Rpush.config.pid_file)
+        pid = File.read(Rpush.config.pid_file).strip.to_i
+        STDOUT.write "* Stopping Rpush (pid #{pid})... "
+        STDOUT.flush
+        Process.kill('TERM', pid)
+
+        loop do
+          begin
+            Process.getpgid(pid)
+            sleep 0.05
+          rescue Errno::ESRCH
+            break
+          end
+        end
+
+        puts green('✔')
+      else
+        STDERR.puts("* Rpush isn't running? #{Rpush.config.pid_file} does not exist.")
+        return
+      end
+    end
+
+    desc 'init', 'Initialize Rpush into the current directory.'
+    option 'active-record', type: :boolean, desc: 'Install ActiveRecord migrations.'
+    def init
+      check_ruby_version
+      require 'rails/generators'
+
+      puts "* #{green('Installing config...')}"
+      $RPUSH_CONFIG_PATH = default_config_path # rubocop:disable Style/GlobalVars
+      Rails::Generators.invoke('rpush_config')
+
+      install_migrations = options['active-record']
+
+      unless options.key?('active-record')
+        has_answer = false
+        until has_answer
+          STDOUT.write "\n* #{green('Install ActiveRecord migrations?')} [y/n]: "
+          STDOUT.flush
+          answer = STDIN.gets.chomp.downcase
+          has_answer = %w(y n).include?(answer)
+        end
+
+        install_migrations = answer == 'y'
+      end
+
+      Rails::Generators.invoke('rpush_migration') if install_migrations
+
+      puts "\n* #{green('Next steps:')}"
+      puts "  - Run 'db:migrate'." if install_migrations
+      puts "  - Review and update your configuration in #{default_config_path}."
+      puts "  - Create your first app, see https://github.com/rpush/rpush for examples."
+      puts "  - Run 'rpush help' for commands and options."
+    end
+
+    private
+
+    def detect_rails?
+      self.class.detect_rails?
+    end
+
+    def default_config_path
+      self.class.default_config_path
+    end
+
+    def ensure_pid_file
+      return  if Rpush.config.pid_file.blank?
+
+      STDERR.puts(red('ERROR: ') + 'config.pid_file is not set.')
+      exit 1
+    end
+
+    def load_config
+      if !File.exist?(options[:config])
+        STDERR.puts(red('ERROR: ') + "#{options[:config]} does not exist. Please run 'rpush init' to generate it or specify the --config option.")
+        exit 1
+      else
+        load options[:config]
+        Rpush.config.update(options)
+      end
+    end
+
+    def check_ruby_version
+      STDERR.puts(yellow('WARNING: ') + "You are using an old and unsupported version of Ruby.") if RUBY_VERSION <= '1.9.3'
+    end
+  end
+end