rpush 1.0.0 → 2.0.0.beta1

data/lib/rpush/daemon/store/active_record/reconnectable.rb

@@ -1,11 +1,12 @@
-class PGError < StandardError; end if !defined?(PGError)
-class Mysql; class Error < StandardError; end; end if !defined?(Mysql)
-module Mysql2; class Error < StandardError; end; end if !defined?(Mysql2)
-module ActiveRecord; end
-class ActiveRecord::JDBCError < StandardError; end if !defined?(::ActiveRecord::JDBCError)
+class PGError < StandardError; end unless defined?(PGError)
+class Mysql; class Error < StandardError; end; end unless defined?(Mysql)
+module Mysql2; class Error < StandardError; end; end unless defined?(Mysql2)
+module ActiveRecord
+  class JDBCError < StandardError; end unless defined?(::ActiveRecord::JDBCError)
+end
 
 # :nocov:
-if !defined?(::SQLite3::Exception)
+unless defined?(::SQLite3::Exception)
   module SQLite3
     class Exception < StandardError; end
   end
@@ -20,15 +21,14 @@ module Rpush
                             Mysql2::Error, ::ActiveRecord::JDBCError, SQLite3::Exception]
 
           def with_database_reconnect_and_retry
-            begin
-              ::ActiveRecord::Base.connection_pool.with_connection do
-                yield
-              end
-            rescue *ADAPTER_ERRORS => e
-              Rpush.logger.error(e)
-              database_connection_lost
-              retry
+            ::ActiveRecord::Base.connection_pool.with_connection do
+              yield
             end
+          rescue *ADAPTER_ERRORS => e
+            Rpush.logger.error(e)
+            sleep_to_avoid_thrashing
+            database_connection_lost
+            retry
           end
 
           def database_connection_lost
@@ -55,7 +55,7 @@ module Rpush
 
           def check_database_is_connected
             # Simply asking the adapter for the connection state is not sufficient.
-            Rpush::Notification.count
+            Rpush::Client::ActiveRecord::Notification.count
           end
 
           def sleep_to_avoid_thrashing

data/lib/rpush/daemon/store/interface.rb

@@ -0,0 +1,19 @@
+module Rpush
+  module Daemon
+    module Store
+      class Interface
+        PUBLIC_METHODS = [:deliverable_notifications, :mark_retryable,
+                          :mark_batch_retryable, :mark_delivered, :mark_batch_delivered,
+                          :mark_failed, :mark_batch_failed, :create_apns_feedback,
+                          :create_gcm_notification, :create_adm_notification, :update_app,
+                          :update_notification, :release_connection,
+                          :all_apps, :app, :mark_ids_failed, :mark_ids_retryable]
+
+        def self.check(klass)
+          missing = PUBLIC_METHODS - klass.instance_methods.map(&:to_sym)
+          fail "#{klass} must implement #{missing.join(', ')}." if missing.any?
+        end
+      end
+    end
+  end
+end

data/lib/rpush/daemon/store/redis.rb

@@ -0,0 +1,149 @@
+module Rpush
+  module Daemon
+    module Store
+      class Redis
+        DEFAULT_MARK_OPTIONS = { persist: true }
+
+        def app(app_id)
+          Rpush::Client::Redis::App.find(app_id)
+        end
+
+        def all_apps
+          Rpush::Client::Redis::App.all
+        end
+
+        def deliverable_notifications(limit)
+          retryable_ids = retryable_notification_ids
+          limit -= retryable_ids.size
+          pending_ids = limit > 0 ? pending_notification_ids(limit) : []
+          ids = retryable_ids + pending_ids
+          ids.map { |id| Rpush::Client::Redis::Notification.find(id) }
+        end
+
+        def mark_delivered(notification, time, opts = {})
+          opts = DEFAULT_MARK_OPTIONS.dup.merge(opts)
+          notification.delivered = true
+          notification.delivered_at = time
+          notification.save!(validate: false) if opts[:persist]
+        end
+
+        def mark_batch_delivered(notifications)
+          now = Time.now
+          notifications.each { |n| mark_delivered(n, now) }
+        end
+
+        def mark_failed(notification, code, description, time, opts = {})
+          opts = DEFAULT_MARK_OPTIONS.dup.merge(opts)
+          notification.delivered = false
+          notification.delivered_at = nil
+          notification.failed = true
+          notification.failed_at = time
+          notification.error_code = code
+          notification.error_description = description
+          notification.save!(validate: false) if opts[:persist]
+        end
+
+        def mark_batch_failed(notifications, code, description)
+          now = Time.now
+          notifications.each { |n| mark_failed(n, code, description, now) }
+        end
+
+        def mark_ids_failed(ids, code, description, time)
+          ids.each { |id| mark_failed(Rpush::Client::Redis::Apns::Notification.find(id), code, description, time) }
+        end
+
+        def mark_retryable(notification, deliver_after, opts = {})
+          opts = DEFAULT_MARK_OPTIONS.dup.merge(opts)
+          notification.delivered = false
+          notification.delivered_at = nil
+          notification.failed = false
+          notification.failed_at = nil
+          notification.retries += 1
+          notification.deliver_after = deliver_after
+
+          return unless opts[:persist]
+
+          notification.save!(validate: false)
+          namespace = Rpush::Client::Redis::Notification.absolute_retryable_namespace
+          Modis.with_connection do |redis|
+            redis.zadd(namespace, deliver_after.to_i, notification.id)
+          end
+        end
+
+        def mark_batch_retryable(notifications, deliver_after)
+          notifications.each { |n| mark_retryable(n, deliver_after) }
+        end
+
+        def mark_ids_retryable(ids, deliver_after)
+          ids.each { |id| mark_retryable(Rpush::Client::Redis::Apns::Notification.find(id), deliver_after) }
+        end
+
+        def create_apns_feedback(failed_at, device_token, app)
+          Rpush::Client::Redis::Apns::Feedback.create!(failed_at: failed_at, device_token: device_token, app: app)
+        end
+
+        def create_gcm_notification(attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists
+          notification = Rpush::Client::Redis::Gcm::Notification.new
+          create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app)
+        end
+
+        def create_adm_notification(attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists
+          notification = Rpush::Client::Redis::Adm::Notification.new
+          create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app)
+        end
+
+        def update_app(app)
+          app.save!
+        end
+
+        def update_notification(notification)
+          notification.save!
+        end
+
+        def release_connection
+        end
+
+        private
+
+        def create_gcm_like_notification(notification, attrs, data, registration_ids, deliver_after, app) # rubocop:disable ParameterLists
+          notification.assign_attributes(attrs)
+          notification.data = data
+          notification.registration_ids = registration_ids
+          notification.deliver_after = deliver_after
+          notification.app = app
+          notification.save!
+          notification
+        end
+
+        def retryable_notification_ids
+          retryable_ns = Rpush::Client::Redis::Notification.absolute_retryable_namespace
+
+          Modis.with_connection do |redis|
+            retryable_results = redis.multi do
+              now = Time.now.to_i
+              redis.zrangebyscore(retryable_ns, 0, now)
+              redis.zremrangebyscore(retryable_ns, 0, now)
+            end
+
+            retryable_results.first
+          end
+        end
+
+        def pending_notification_ids(limit)
+          pending_ns = Rpush::Client::Redis::Notification.absolute_pending_namespace
+
+          Modis.with_connection do |redis|
+            pending_results = redis.multi do
+              redis.zrange(pending_ns, 0, limit)
+              redis.zremrangebyrank(pending_ns, 0, limit)
+            end
+
+            pending_results.first
+          end
+        end
+      end
+    end
+  end
+end
+
+Rpush::Daemon::Store::Interface.check(Rpush::Daemon::Store::Redis)

data/lib/rpush/daemon/tcp_connection.rb

@@ -27,11 +27,9 @@ module Rpush
       end
 
       def close
-        begin
-          @ssl_socket.close if @ssl_socket
-          @tcp_socket.close if @tcp_socket
-        rescue IOError
-        end
+        @ssl_socket.close if @ssl_socket
+        @tcp_socket.close if @tcp_socket
+      rescue IOError # rubocop:disable HandleExceptions
       end
 
       def read(num_bytes)
@@ -50,11 +48,10 @@ module Rpush
         begin
           write_data(data)
         rescue Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError, IOError => e
-          retry_count += 1;
+          retry_count += 1
 
           if retry_count == 1
             log_error("Lost connection to #{@host}:#{@port} (#{e.class.name}), reconnecting...")
-            reflect(:apns_connection_lost, @app, e) # deprecated
             reflect(:tcp_connection_lost, @app, e)
           end
 
@@ -63,7 +60,7 @@ module Rpush
             sleep 1
             retry
           else
-            raise TcpConnectionError, "#{@app.name} tried #{retry_count-1} times to reconnect but failed (#{e.class.name})."
+            raise TcpConnectionError, "#{@app.name} tried #{retry_count - 1} times to reconnect but failed (#{e.class.name})."
           end
         end
       end
@@ -110,7 +107,6 @@ module Rpush
         ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, @ssl_context)
         ssl_socket.sync = true
         ssl_socket.connect
-        log_info("Connected to #{@host}:#{@port}")
         [tcp_socket, ssl_socket]
       end
 
@@ -118,10 +114,9 @@ module Rpush
         cert = @ssl_context.cert
         if certificate_expired?
           log_error(certificate_msg('expired'))
-          raise Rpush::Apns::CertificateExpiredError.new(@app, cert.not_after)
+          fail Rpush::CertificateExpiredError.new(@app, cert.not_after)
         elsif certificate_expires_soon?
           log_warn(certificate_msg('will expire'))
-          reflect(:apns_certificate_will_expire, @app, cert.not_after) # deprecated
           reflect(:ssl_certificate_will_expire, @app, cert.not_after)
         end
       end

data/lib/rpush/daemon/wpns/delivery.rb

@@ -1,10 +1,8 @@
 module Rpush
   module Daemon
     module Wpns
-
       # http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff941100%28v=vs.105%29.aspx
       class Delivery < Rpush::Daemon::Delivery
-
         FAILURE_MESSAGES = {
           400 => 'Bad XML or malformed notification URI.',
           401 => 'Unauthorized to send a notification to this app.'
@@ -18,12 +16,12 @@ module Rpush
         end
 
         def perform
-          begin
-            handle_response(do_post)
-          rescue Rpush::DeliveryError => error
-            mark_failed(error.code, error.description)
-            raise
-          end
+          handle_response(do_post)
+        rescue StandardError => error
+          mark_failed(error)
+          raise
+        ensure
+          @batch.notification_processed
         end
 
         private
@@ -34,25 +32,21 @@ module Rpush
           when 200
             ok(response)
           when 406
-            not_acceptable(response)
+            not_acceptable
           when 412
-            precondition_failed(response)
+            precondition_failed
           when 503
-            service_unavailable(response)
+            service_unavailable
           else
             handle_failure(code)
           end
         end
 
-        def handle_failure(code, msg=nil)
+        def handle_failure(code, msg = nil)
           unless msg
-            msg = if FAILURE_MESSAGES.key?(code)
-              FAILURE_MESSAGES[code]
-            else
-              Rpush::Daemon::HTTP_STATUS_CODES[code]
-            end
+            msg = FAILURE_MESSAGES.key?(code) ? FAILURE_MESSAGES[code] : Rpush::Daemon::HTTP_STATUS_CODES[code]
           end
-          raise Rpush::DeliveryError.new(code, @notification.id, msg)
+          fail Rpush::DeliveryError.new(code, @notification.id, msg)
         end
 
         def ok(response)
@@ -62,22 +56,22 @@ module Rpush
             mark_delivered
             log_info("#{@notification.id} sent successfully")
           when ["QueueFull"]
-            mark_retryable(@notification, Time.now + (60*10))
+            mark_retryable(@notification, Time.now + (60 * 10))
             log_warn("#{@notification.id} cannot be sent. The Queue is full.")
           when ["Suppressed"]
             handle_failure(200, "Notification was received but suppressed by the service.")
           end
         end
 
-        def not_acceptable(response)
+        def not_acceptable
           retry_notification("Per-day throttling limit reached.")
         end
 
-        def precondition_failed(response)
+        def precondition_failed
           retry_notification("Device unreachable.")
         end
 
-        def service_unavailable(response)
+        def service_unavailable
           mark_retryable_exponential(@notification)
           log_warn("Service Unavailable. " + retry_message)
         end
@@ -87,20 +81,17 @@ module Rpush
         end
 
         def retry_notification(reason)
-          deliver_after = Time.now + (60*60)
+          deliver_after = Time.now + (60 * 60)
           mark_retryable(@notification, deliver_after)
           log_warn("#{reason} " + retry_message)
         end
 
         def do_post
           body = notification_to_xml
-          header = {
-            "Content-Length" => body.length.to_s,
-            "Content-Type" => "text/xml",
-            "X-WindowsPhone-Target" => "toast",
-            "X-NotificationClass" => '2'
-          }
-          post = Net::HTTP::Post.new(URI.parse(@notification.uri).path, initheader=header)
+          post = Net::HTTP::Post.new(URI.parse(@notification.uri).path, "Content-Length" => body.length.to_s,
+                                                                        "Content-Type" => "text/xml",
+                                                                        "X-WindowsPhone-Target" => "toast",
+                                                                        "X-NotificationClass" => '2')
           post.body = body
           @http.request(URI.parse(@notification.uri), post)
         end

data/lib/rpush/deprecatable.rb

@@ -5,16 +5,17 @@ module Rpush
     end
 
     module ClassMethods
-      def deprecated(method_name, version, msg=nil)
+      def deprecated(method_name, version, msg = nil)
+        method_name_as_var = method_name.to_s.tr('=', '_setter_')
         instance_eval do
-          alias_method "#{method_name}_without_warning", method_name
+          alias_method "#{method_name_as_var}_without_warning", method_name
         end
         warning = "#{method_name} is deprecated and will be removed from Rpush #{version}."
         warning << " #{msg}" if msg
         class_eval(<<-RUBY, __FILE__, __LINE__)
           def #{method_name}(*args, &blk)
             Rpush::Deprecation.warn(#{warning.inspect})
-            #{method_name}_without_warning(*args, &blk)
+            #{method_name_as_var}_without_warning(*args, &blk)
           end
         RUBY
       end

data/lib/rpush/deprecation.rb

@@ -1,13 +1,11 @@
 module Rpush
   class Deprecation
     def self.muted
-      begin
-        orig_val = Thread.current[:rpush_mute_deprecations]
-        Thread.current[:rpush_mute_deprecations] = true
-        yield
-      ensure
-        Thread.current[:rpush_mute_deprecations] = orig_val
-      end
+      orig_val = Thread.current[:rpush_mute_deprecations]
+      Thread.current[:rpush_mute_deprecations] = true
+      yield
+    ensure
+      Thread.current[:rpush_mute_deprecations] = orig_val
     end
 
     def self.muted?
@@ -15,9 +13,8 @@ module Rpush
     end
 
     def self.warn(msg)
-      unless Rpush::Deprecation.muted?
-        STDERR.puts "DEPRECATION WARNING: #{msg}"
-      end
+      return if Rpush::Deprecation.muted?
+      STDERR.puts "DEPRECATION WARNING: #{msg}"
     end
   end
 end

data/lib/rpush/embed.rb

@@ -2,18 +2,23 @@ module Rpush
   def self.embed(options = {})
     Rpush.require_for_daemon
 
+    if @embed_thread
+      STDERR.puts 'Rpush.embed can only be run once inside this process.'
+    end
+
     config = Rpush::ConfigurationWithoutDefaults.new
     options.each { |k, v| config.send("#{k}=", v) }
     config.embedded = true
     Rpush.config.update(config)
-    Rpush::Daemon.start
-
     Kernel.at_exit { shutdown }
+    @embed_thread = Thread.new { Rpush::Daemon.start }
   end
 
   def self.shutdown
     return unless Rpush.config.embedded
     Rpush::Daemon.shutdown
+    @embed_thread.join if @embed_thread
+    @embed_thread = nil
   end
 
   def self.sync