lowdown 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab366da937c62aeebaaa7070b47f3f3a108e1460
-  data.tar.gz: 568554722d19bf9899cfdfda1fa96de1698365ce
+  metadata.gz: 658a05f8102498326e20e21fff2c403ff597bbf7
+  data.tar.gz: 2274644492c37bdfe02681faccf3128b6297b0d3
 SHA512:
-  metadata.gz: 90a597f2d9faae4afe0a4640b3618303b8740de0132fbfd5d9b291526ef3a240b0bbbe35208279197811a021305cb0edff7408c4d96e356a14a7a3a686b4db01
-  data.tar.gz: 81fe7bf93ff1c4fa94090720c32293155a08b59fe2b6e6e0b5ca9dce7feac5d322d0f6c260a9ba68a8476443656710882dd33610b824a21601131cc9db96abba
+  metadata.gz: 610fe096be572adaaf73453bb1a12fcbd6b4b64da59a0110fbe876f4a4d18e10174cc9ecc2fd50912577a0b98cf6c94cf241b605acbbf11e100ed89183bcaf8a
+  data.tar.gz: 53b1305c9bccf953d3cfe174cd785f77a3000b3cc37e7a1c7a3c7bffd3b64d6c5e8318bf925c0610e4b62aab01ece0c43c1089c35b9955bc1ff9f614cc8444e0

data/.rubocop.yml

@@ -110,6 +110,12 @@ Style/ParallelAssignment:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/FormatString:
+  EnforcedStyle: percent
+
 Style/StructInheritance:
   Enabled: false
 

data/README.md

@@ -4,7 +4,7 @@
 
 [![Build Status](https://travis-ci.org/alloy/lowdown.svg?branch=master)](https://travis-ci.org/alloy/lowdown)
 
-NOTE: _This is not battle-tested yet. This will follow over the next few weeks._
+⚠︎ NOTE: _This is not battle-tested yet, which will follow over the next few weeks. A v1 will be released at that time._
 
 Lowdown is a Ruby client for the HTTP/2 version of the Apple Push Notification Service.
 
@@ -74,6 +74,8 @@ end
 
 ### Persistent connection
 
+⚠︎ NOTE: _See the ‘Gotchas’ section, specifically about process forking._
+
 The trick to creating a persistent connection is to specify the `keep_alive: true` option when creating the client:
 
 ```ruby
@@ -134,7 +136,7 @@ Keep in mind that, like with the block version, this message is sent on the grou
 
 While we’re on the topic of threading anyways, here’s an important thing to keep in mind; each set of `group` callbacks
 is performed on its own thread. It is thus _your_ responsibility to take this into account. E.g. if you are planning to
-update a DB model with the status of a notification delivery, be sure to respect the treading rules of your DB client,
+update a DB model with the status of a notification delivery, be sure to respect the threading rules of your DB client,
 which usually means to not re-use models that were loaded on a different thread.
 
 A simple approach to this is by passing the data you need to be able to update the DB as a `context`, which can be any
@@ -161,6 +163,37 @@ increase this with the `pool_size` option:
 Lowdown::Client.production(true, File.read("path/to/certificate.pem"), pool_size: 3)
 ```
 
+## Gotchas
+
+* If you’re forking your process, be sure to **not** load lowdown before forking (because this [does not work well with
+  Celluloid](https://github.com/celluloid/celluloid/wiki/Gotchas#do-not-create-actors-prior-to-forking-the-process), or
+  with threading and Ruby in general).
+
+  Forking is done by, e.g. [Spring][spring] and [DelayedJob][delayed_job], when daemonizing workers. In practice, this
+  means that e.g. you should not initialize a client from a Rails initializer, but rather do it lazily when it’s really
+  required. E.g.:
+
+```ruby
+class PushNotificationService
+  def initialize(certificate_path)
+    @certificate_path = certificate_path
+    @client_mutex = Mutex.new
+  end
+
+  def client
+    client = nil
+    @client_mutex.synchronize do
+      @client ||= Lowdown::Client.production(true, File.read(certificate_path), keep_alive: true)
+      client = @client
+    end
+    client
+  end
+end
+
+# In your initializer:
+PUSH_NOTIFICATION_SERVICE = PushNotificationService.new("path/to/certificate.pem")
+```
+
 ## Related tool ☞
 
 Also checkout [this library](https://github.com/alloy/time_zone_scheduler) for scheduling across time zones.
@@ -177,3 +210,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 [notification]: http://www.rubydoc.info/gems/lowdown/Lowdown/Notification
 [group]: http://www.rubydoc.info/gems/lowdown/Lowdown/RequestGroup
 [delegate]: http://www.rubydoc.info/gems/lowdown/Lowdown/Connection/DelegateProtocol
+
+[spring]: https://github.com/rails/spring
+[delayed_job]: https://github.com/collectiveidea/delayed_job

data/examples/long-running.rb

@@ -44,9 +44,6 @@ loop do
       end
     end.each(&:join)
 
-    logger.info "Sleep for 5 seconds"
-    sleep(5)
-
   rescue Interrupt
     logger.info "[!] Interrupt, exiting"
     break
@@ -54,8 +51,11 @@ loop do
   rescue Exception => e
     logger.error "[!] Exception occurred, re-trying in 1 second: #{e.inspect}\n\t#{e.backtrace.join("\n\t")}"
     sleep 1
-    redo
   end
+
+  GC.start
+  logger.info "Sleep for 5 seconds"
+  sleep(5)
 end
 
 client.disconnect

data/examples/simple.rb

@@ -11,27 +11,37 @@ production = environment == "production"
 
 # $CELLULOID_DEBUG = true
 # Celluloid.logger.level = Logger::DEBUG
-# Celluloid.logger.level = Logger::INFO
-Celluloid.logger.level = Logger::ERROR
+Celluloid.logger.level = Logger::INFO
+# Celluloid.logger.level = Logger::ERROR
 
-# Connection time can take a while, just count the time it takes to connect.
-start = nil
+client = Lowdown::Client.production(production, certificate: File.read(cert_file), pool_size: 2)
 
 # The block form of Client#connect flushes and closes the connection at the end of the block.
-Lowdown::Client.production(production, certificate: File.read(cert_file), pool_size: 2).connect do |group|
-  start = Time.now
-  600.times do
-    notification = Lowdown::Notification.new(:token => device_token)
-    notification.payload = { :alert => "Hello HTTP/2! ID=#{notification.id}" }
-    group.send_notification(notification) do |response|
-      if response.success?
-        puts "Sent notification with ID: #{notification.id}"
-      else
-        puts "[!] (##{response.id}): #{response}"
+loop do
+  begin
+    client.connect do |group|
+      600.times do
+        notification = Lowdown::Notification.new(:token => device_token)
+        notification.payload = { :alert => "Hello HTTP/2! ID=#{notification.id}" }
+        group.send_notification(notification) do |response|
+          if response.success?
+            puts "Sent notification with ID: #{notification.id}"
+          else
+            puts "[!] (##{response.id}): #{response}"
+          end
+        end
       end
     end
+  rescue Interrupt
+    puts "[!] Interrupt, exiting"
+    break
+
+  rescue Exception => e
+    puts "[!] Error occurred: #{e.message}"
   end
-end
 
-puts "Finished in #{Time.now - start} seconds"
+  GC.start
+  puts "Sleep for 5 seconds"
+  sleep(5)
+end
 

data/lib/lowdown/client.rb

@@ -181,9 +181,13 @@ module Lowdown
     # @return [void]
     #
     def disconnect
-      @connection.disconnect
-    rescue Celluloid::DeadActorError
-      # Rescue this exception instead of calling #alive? as that only works on an actor, not a pool.
+      if @connection.respond_to?(:actors)
+        @connection.actors.each do |connection|
+          connection.async.disconnect if connection.alive?
+        end
+      else
+        @connection.async.disconnect if @connection.alive?
+      end
     end
 
     # Use this to group a batch of requests and halt the caller thread until all of the requests in the group have been

data/lib/lowdown/connection.rb

@@ -63,9 +63,15 @@ module Lowdown
     HEARTBEAT_TIMEOUT     = CONNECT_TIMEOUT
 
     include Celluloid::IO
-    include Celluloid::Internals::Logger
     finalizer :disconnect
 
+    include Celluloid::Internals::Logger
+    %w(debug info warn error fatal unknown).each do |level|
+      define_method(level) do |message|
+        super("[APNS Connection##{"0x%x" % (object_id << 1)}] #{message}")
+      end
+    end
+
     # @param  [URI, String] uri
     #         the details to connect to the APN service.
     #
@@ -109,7 +115,10 @@ module Lowdown
     # @return [void]
     #
     def disconnect
-      @connection.close if @connection
+      if @connection
+        info "Closing..."
+        @connection.close
+      end
       @heartbeat.cancel if @heartbeat
       reset_state!
     end
@@ -146,7 +155,7 @@ module Lowdown
       return if @connection
       @connecting = true
 
-      info "Opening APNS connection."
+      info "Connecting..."
 
       # Celluloid::IO::DNSResolver bug. In case there is no connection at all:
       # 1. This results in `nil`:
@@ -232,17 +241,18 @@ module Lowdown
       @max_stream_count = @http.remote_settings[:settings_max_concurrent_streams]
       @connected = true
 
-      debug "APNS connection established. Maximum number of concurrent streams: #{@max_stream_count}. " \
-            "Flushing #{@request_queue.size} enqueued requests."
+      info "Connection established."
+      debug "Maximum number of streams: #{@max_stream_count}. Flushing #{@request_queue.size} enqueued requests."
 
       @request_queue.size.times do
         async.try_to_perform_request!
       end
 
       @heartbeat = every(HEARTBEAT_INTERVAL) do
-        debug "Sending heartbeat ping"
+        debug "Sending heartbeat ping..."
         begin
           future.ping.call(HEARTBEAT_TIMEOUT)
+          debug "Got heartbeat reply."
         rescue Celluloid::TimedOut
           raise TimedOut, "Heartbeat ping timed-out."
         end
@@ -316,17 +326,22 @@ module Lowdown
 
     def try_to_perform_request!
       unless @connected
-        debug "Defer performing request, because the connection has not been established yet"
+        unless @warned_about_not_connected
+          warn "Defer performing request, because the connection has not been established yet."
+          @warned_about_not_connected = true
+        end
         return
+      else
+        @warned_about_not_connected = false
       end
 
       unless @http.active_stream_count < @max_stream_count
-        debug "Defer performing request, because the maximum concurren stream count has been reached"
+        debug "Defer performing request, because the maximum concurren stream count has been reached."
         return
       end
 
       unless request = @request_queue.shift
-        debug "Defer performing request, because the request queue is empty"
+        debug "Defer performing request, because the request queue is empty."
         return
       end
 

data/lib/lowdown/mock.rb

@@ -144,6 +144,10 @@ module Lowdown
         self
       end
 
+      def alive?
+        true
+      end
+
       # @!group Real API: Instance Method Summary
 
       # Yields stubbed {#responses} or if none are available defaults to success responses. It does this on a different

data/lib/lowdown/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Lowdown
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lowdown
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Eloy Durán
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby client for the HTTP/2 version of the Apple Push Notification Service.