rpush 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcd5a386e63d453ba0a442b2636d17c9f5d1163d
-  data.tar.gz: 6bcf897de27d5f489e237ec004883e0d31685741
+  metadata.gz: 8e562313c0e7b3ce34abf0013edf503f2f5dd4d2
+  data.tar.gz: 1b3e1799010d17074316c353e77f8bef16bf54a7
 SHA512:
-  metadata.gz: a35052dca2662df7e86819c6e74eb9ea31fd892da03701c771924dd2c9858bd7b5f36e330cb9e5093300df4809cf627617115e9548514af62a0a4bab1437367d
-  data.tar.gz: 1947d69afa9d7fd55688da01a0e5e25d62b4cde78b23c2b66a78b66a044c0fe05650851a2331108a2f2042a2a0133da96be22714484f7a965be15aea204c39dd
+  metadata.gz: bd1b05e4f6a848428b2d3f008e57806f062b9803605d2544b9ad45a26e4e2f90f56f1af095a56963d1e3f2b5edf835e07694b758bec2fca036171de3135543bc
+  data.tar.gz: 85f65b3f5278077a738dbbc10ae16f1eeae6ece50cfdde65c9333a053ea595551ce071aa9e68a52acdf9ce4710230bda6d9d866f97f69352fcc9e63ffdc23014

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 2.5.0 (July 19, 2015)
+  Features:
+  * Add 'rpush status' to inspect running Rpush internal status.
+  * ActiveRecord logging is no longer redirected to rpush.log when embedded (#138).
+  * Support for WNS (Windows RT) (#137).
+  * Indexes added to some Mongoid fields (#151).
+  * Added support for Oracle.
+
+  Bug fixes:
+  * Fix for handling APNs error when using `rpush push` or `Rpush.push`.
+  * Fix backwards compatibility issue with ActiveRecord (#144).
+
 ## 2.4.0 (Fed 18, 2015)
   Features:
   * Support for MongoDB (using Mongoid).

data/README.md

@@ -1,7 +1,5 @@
-[![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)
+[![Join the chat at https://gitter.im/rpush/rpush](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rpush/rpush?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 <img src="https://raw.github.com/rpush/rpush/master/logo.png" align="right" width="200px" />
 
@@ -21,9 +19,9 @@ Rpush aims to be the *de facto* gem for sending push notifications in Ruby. Its
 
 * Use [**ActiveRecord**](https://github.com/rpush/rpush/wiki/Using-ActiveRecord), [**Redis**](https://github.com/rpush/rpush/wiki/Using-Redis) or [**MongoDB**](https://github.com/rpush/rpush/wiki/Using-Mongodb) for storage.
 * Plugins for [**Bugsnag**](https://github.com/rpush/rpush-plugin-bugsnag),
-[**Sentry**](https://github.com/rpush/rpush-plugin-sentry), [**StatsD**](https://github.com/rpush/rpush-plugin-statsd).
+[**Sentry**](https://github.com/rpush/rpush-plugin-sentry), [**StatsD**](https://github.com/rpush/rpush-plugin-statsd) or [write your own](https://github.com/rpush/rpush/wiki/Writing-a-Plugin).
 * Seamless integration with your projects, including **Rails**.
-* Run as a [daemon](https://github.com/rpush/rpush#as-a-daemon-recommended), inside a [job queue](https://github.com/rpush/rpush/wiki/Push-API), on the [command-line](https://github.com/rpush/rpush#on-the-command-line) or [embedded](https://github.com/rpush/rpush/wiki/Embedding-API) in another process.
+* Run as a [daemon](https://github.com/rpush/rpush#as-a-daemon), inside a [job queue](https://github.com/rpush/rpush/wiki/Push-API), on the [command-line](https://github.com/rpush/rpush#on-the-command-line) or [embedded](https://github.com/rpush/rpush/wiki/Embedding-API) in another process.
 * Scales vertically (threading) and horizontally (multiple processes).
 * Designed for uptime - new apps are loaded automatically, signal `HUP` to update running apps.
 * Hooks for fine-grained instrumentation and error handling ([Reflection API](https://github.com/rpush/rpush/wiki/Reflection-API)).
@@ -87,7 +85,7 @@ app.save!
 ```ruby
 n = Rpush::Gcm::Notification.new
 n.app = Rpush::Gcm::App.find_by_name("android_app")
-n.registration_ids = ["token", "..."]
+n.registration_ids = ["..."]
 n.data = { message: "hi mom!" }
 n.save!
 ```
@@ -198,6 +196,7 @@ You should run `rpush init` after upgrading Rpush to check for configuration and
 * [Reflection API](https://github.com/rpush/rpush/wiki/Reflection-API)
 * [Push API](https://github.com/rpush/rpush/wiki/Push-API)
 * [Embedding API](https://github.com/rpush/rpush/wiki/Embedding-API)
+* [Writing a Plugin](https://github.com/rpush/rpush/wiki/Writing-a-Plugin)
 * [Implementing your own storage backend](https://github.com/rpush/rpush/wiki/Implementing-your-own-storage-backend)
 * [Upgrading from 2.x to 3.0](https://github.com/rpush/rpush/wiki/Upgrading-from-version-2.x-to-3.0)
 
@@ -223,4 +222,9 @@ Note that the database username is changed at runtime to be the currently logged
 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`.
+To switch between ActiveRecord and Redis, set the `CLIENT` environment variable to either `active_record`, `redis` or `mongoid`.
+
+
+[![Build Status](https://secure.travis-ci.org/rpush/rpush.svg?branch=master)](http://travis-ci.org/rpush/rpush)
+[![Test Coverage](https://codeclimate.com/github/rpush/rpush/badges/coverage.svg)](https://codeclimate.com/github/rpush/rpush)
+[![Code Climate](https://codeclimate.com/github/rpush/rpush/badges/gpa.svg)](https://codeclimate.com/github/rpush/rpush)

data/lib/generators/templates/rpush.rb

@@ -21,7 +21,7 @@ Rpush.configure do |config|
   # Path to log file. Relative to current directory unless absolute.
   config.log_file = 'log/rpush.log'
 
-  config.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::DEBUG
+  config.log_level = (defined?(Rails) && Rails.logger) ? Rails.logger.level : ::Logger::Severity::INFO
 
   # Define a custom logger.
   # config.logger = MyLogger.new
@@ -29,7 +29,7 @@ Rpush.configure do |config|
   # config.apns.feedback_receiver.enabled = true
   # config.apns.feedback_receiver.frequency = 60
 
- end
+end
 
 Rpush.reflect do |on|
 
@@ -123,6 +123,12 @@ Rpush.reflect do |on|
   # on.adm_failed_to_recipient do |notification, registration_id, reason|
   # end
 
+  # Called when Failed to deliver to WNS. Check the 'reason' string for further
+  # explanations.
+  # You should remove this uri from your records
+  # on.wns_invalid_channel do |notification, uri, reason|
+  # end
+
   # Called when an exception is raised.
   # on.error do |error|
   # end

data/lib/generators/templates/rpush_2_0_0_updates.rb

@@ -58,7 +58,7 @@ class Rpush200Updates < ActiveRecord::Migration
 
   def self.adapter_name
     env = (defined?(Rails) && Rails.env) ? Rails.env : 'development'
-    ActiveRecord::Base.configurations[env]['adapter']
+    Hash[ActiveRecord::Base.configurations[env].map { |k,v| [k.to_sym,v] }][:adapter]
   end
 
   def self.postgresql?

data/lib/rpush/cli.rb

@@ -30,28 +30,23 @@ module Rpush
     option 'pid-file', type: :string, aliases: '-p'
     def stop
       config_setup
-      ensure_pid_file_set
-
-      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
+      pid = rpush_process_pid
+      return unless pid
+
+      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
-
-        puts ANSI.green { '✔' }
-      else
-        STDERR.puts("* Rpush isn't running? #{Rpush.config.pid_file} does not exist.")
-        return
       end
+
+      puts ANSI.green { '✔' }
     end
 
     desc 'init', 'Initialize Rpush into the current directory'
@@ -96,6 +91,15 @@ module Rpush
       Rpush.push
     end
 
+    desc 'status', 'Show the internal status of the running Rpush instance.'
+    def status
+      require 'rpush/daemon'
+      rpc = Rpush::Daemon::Rpc::Client.new(rpush_process_pid)
+      status = rpc.status
+      rpc.close
+      puts humanize_json(status)
+    end
+
     desc 'version', 'Print Rpush version'
     def version
       puts Rpush::VERSION
@@ -146,13 +150,6 @@ module Rpush
       self.class.default_config_path
     end
 
-    def ensure_pid_file_set
-      return unless Rpush.config.pid_file.blank?
-
-      STDERR.puts(ANSI.red { 'ERROR: ' } + 'config.pid_file is not set.')
-      exit 1
-    end
-
     def check_ruby_version
       STDERR.puts(ANSI.yellow { 'WARNING: ' } + "You are using an old and unsupported version of Ruby.") if RUBY_VERSION <= '1.9.3' && RUBY_ENGINE == 'ruby'
     end
@@ -173,5 +170,42 @@ module Rpush
       new_options.freeze
       self.options = new_options
     end
+
+    def rpush_process_pid
+      if Rpush.config.pid_file.blank?
+        STDERR.puts(ANSI.red { 'ERROR: ' } + 'config.pid_file is not set.')
+        exit 1
+      end
+
+      unless File.exist?(Rpush.config.pid_file)
+        STDERR.puts("* Rpush isn't running? #{Rpush.config.pid_file} does not exist.")
+        exit 1
+      end
+
+      File.read(Rpush.config.pid_file).strip.to_i
+    end
+
+    def humanize_json(node, str = '', depth = 0) # rubocop:disable Metrics/PerceivedComplexity
+      if node.is_a?(Hash)
+        node = node.sort_by { |_, v| [Array, Hash].include?(v.class) ? 1 : 0 }
+        node.each do |k, v|
+          if [Array, Hash].include?(v.class)
+            str << "\n#{'  ' * depth}#{k}:\n"
+            humanize_json(v, str, depth + 1)
+          else
+            str << "#{'  ' * depth}#{k}: #{v}\n"
+          end
+        end
+      elsif node.is_a?(Array)
+        node.each do |v|
+          str << "\n" if v.is_a?(Hash)
+          humanize_json(v, str, depth)
+        end
+      else
+        str << "#{'  ' * depth}#{node}\n"
+      end
+
+      str
+    end
   end
 end

data/lib/rpush/client/active_model.rb

@@ -19,3 +19,6 @@ require 'rpush/client/active_model/gcm/notification'
 
 require 'rpush/client/active_model/wpns/app'
 require 'rpush/client/active_model/wpns/notification'
+
+require 'rpush/client/active_model/wns/app'
+require 'rpush/client/active_model/wns/notification'

data/lib/rpush/client/active_model/apns/notification.rb

@@ -64,7 +64,7 @@ module Rpush
             json
           end
 
-          def to_binary(options = {}) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+          def to_binary(options = {})
             frame_payload = payload
             frame_id = options[:for_validation] ? 0 : send(options.fetch(:id_attribute, :id))
             frame = ""

data/lib/rpush/client/active_model/wns/app.rb

@@ -0,0 +1,23 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wns
+        module App
+          def self.included(base)
+            base.instance_eval do
+              validates :client_id, :client_secret, presence: true
+            end
+          end
+
+          def access_token_expired?
+            access_token_expiration.nil? || access_token_expiration < Time.now
+          end
+
+          def service_name
+            'wns'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/wns/notification.rb

@@ -0,0 +1,28 @@
+module Rpush
+  module Client
+    module ActiveModel
+      module Wns
+        module Notification
+          module InstanceMethods
+            def alert=(value)
+              return unless value
+              data = self.data || {}
+              data['title'] = value
+              self.data = data
+            end
+          end
+
+          def self.included(base)
+            base.instance_eval do
+              include InstanceMethods
+
+              validates :uri, presence: true
+              validates :uri, format: { with: %r{https?://[\S]+} }
+              validates :data, presence: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_model/wpns/notification.rb

@@ -3,12 +3,7 @@ module Rpush
     module ActiveModel
       module Wpns
         module Notification
-          def self.included(base)
-            base.instance_eval do
-              validates :uri, presence: true
-              validates :uri, format: { with: %r{https?://[\S]+} }
-              validates :data, presence: true
-            end
+          module InstanceMethods
             def alert=(value)
               return unless value
               data = self.data || {}
@@ -16,6 +11,16 @@ module Rpush
               self.data = data
             end
           end
+
+          def self.included(base)
+            base.instance_eval do
+              include InstanceMethods
+
+              validates :uri, presence: true
+              validates :uri, format: { with: %r{https?://[\S]+} }
+              validates :data, presence: true
+            end
+          end
         end
       end
     end

data/lib/rpush/client/active_record.rb

@@ -15,5 +15,8 @@ require 'rpush/client/active_record/gcm/app'
 require 'rpush/client/active_record/wpns/notification'
 require 'rpush/client/active_record/wpns/app'
 
+require 'rpush/client/active_record/wns/notification'
+require 'rpush/client/active_record/wns/app'
+
 require 'rpush/client/active_record/adm/notification'
 require 'rpush/client/active_record/adm/app'

data/lib/rpush/client/active_record/wns/app.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Wns
+        class App < Rpush::Client::ActiveRecord::App
+          include Rpush::Client::ActiveModel::Wns::App
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/active_record/wns/notification.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module ActiveRecord
+      module Wns
+        class Notification < Rpush::Client::ActiveRecord::Notification
+          include Rpush::Client::ActiveModel::Wns::Notification
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/mongoid.rb

@@ -27,5 +27,8 @@ require 'rpush/client/mongoid/gcm/app'
 require 'rpush/client/mongoid/wpns/notification'
 require 'rpush/client/mongoid/wpns/app'
 
+require 'rpush/client/mongoid/wns/notification'
+require 'rpush/client/mongoid/wns/app'
+
 require 'rpush/client/mongoid/adm/notification'
 require 'rpush/client/mongoid/adm/app'

data/lib/rpush/client/mongoid/apns/feedback.rb

@@ -13,6 +13,9 @@ module Rpush
           validates :device_token, presence: true
           validates :failed_at, presence: true
 
+          index device_token: 1
+          index app_id: 1
+
           validates_with Rpush::Client::ActiveModel::Apns::DeviceTokenFormatValidator
         end
       end

data/lib/rpush/client/mongoid/notification.rb

@@ -3,6 +3,7 @@ module Rpush
     module Mongoid
       class Notification
         include ::Mongoid::Document
+        include ::Mongoid::Timestamps
         include ::Mongoid::Autoinc
         include Rpush::MultiJsonHelper
         include Rpush::Client::ActiveModel::Notification
@@ -36,6 +37,11 @@ module Rpush
         increments :integer_id, model_name: name
         index integer_id: 1
 
+        index delivered: 1, failed: 1, deliver_after: 1, processing: 1
+        index delivered: 1, failed: 1
+        index device_token: 1
+        index app_id: 1
+
         belongs_to :app
       end
     end

data/lib/rpush/client/mongoid/wns/app.rb

@@ -0,0 +1,14 @@
+module Rpush
+  module Client
+    module Mongoid
+      module Wns
+        class App < Rpush::Client::Mongoid::App
+          include Rpush::Client::ActiveModel::Wns::App
+
+          field :access_token, type: String
+          field :access_token_expiration, type: Time
+        end
+      end
+    end
+  end
+end

data/lib/rpush/client/mongoid/wns/notification.rb

@@ -0,0 +1,11 @@
+module Rpush
+  module Client
+    module Mongoid
+      module Wns
+        class Notification < Rpush::Client::Mongoid::Notification
+          include Rpush::Client::ActiveModel::Wns::Notification
+        end
+      end
+    end
+  end
+end