lowdown 0.2.0 → 0.3.0

data/lib/lowdown/connection/monitor.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "celluloid/current"
+
+module Lowdown
+  class Connection
+    module Monitor
+      # The normal Celluloid::Future implementation expects an object that responds to `value`, when assigning the value
+      # via `#signal`:
+      #
+      # 1. https://github.com/celluloid/celluloid/blob/bb282f826c275c0d60d9591c1bb5b08798799cbe/lib/celluloid/future.rb#L106
+      # 2. https://github.com/celluloid/celluloid/blob/bb282f826c275c0d60d9591c1bb5b08798799cbe/lib/celluloid/future.rb#L96
+      #
+      # Besides that, this class provides a few more conveniences related to how we use this future.
+      #
+      class Condition < Celluloid::Future
+        Result = Struct.new(:value)
+
+        # Only signal once.
+        #
+        def signal(value = nil)
+          super(Result.new(value)) unless ready?
+        end
+
+        alias_method :wait, :value
+      end
+
+      # @!group Overrides
+
+      def initialize(*)
+        super
+        @lowdown_crash_conditions_mutex = Mutex.new
+        @lowdown_crash_conditions = []
+      end
+
+      # Send the exception to each of our conditions, to signal that an exception occurred on one of the actors in the
+      # pool.
+      #
+      # @param  [Actor] actor
+      # @param  [Exception] reason
+      # @return [void]
+      #
+      def __crash_handler__(actor, reason)
+        if reason # is nil if the actor exits normally
+          @lowdown_crash_conditions_mutex.synchronize do
+            @lowdown_crash_conditions.each do |condition|
+              condition.signal(reason)
+            end
+          end
+        end
+        super
+      end
+
+      # @!group Crash condition registration
+
+      # Adds a condition to the list of conditions to be notified when an actors dies because of an unhandled exception.
+      #
+      # @param  [Condition] condition
+      # @return [void]
+      #
+      def __register_lowdown_crash_condition__(condition)
+        @lowdown_crash_conditions_mutex.synchronize do
+          @lowdown_crash_conditions << condition
+        end
+      end
+
+      # Removes a condition from the list of conditions that get notified when an actor dies because of an unhandled
+      # exception.
+      #
+      # @param  [Condition] condition
+      # @return [void]
+      #
+      def __deregister_lowdown_crash_condition__(condition)
+        @lowdown_crash_conditions_mutex.synchronize do
+          @lowdown_crash_conditions.delete(condition)
+        end
+      end
+    end
+
+    # Prepend to ensure our overrides are called first.
+    Celluloid::Supervision::Container::Pool.send(:prepend, Monitor)
+  end
+end
+

data/lib/lowdown/mock.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require "lowdown/certificate"
 require "lowdown/client"
 require "lowdown/response"
-require "lowdown/threading"
 
 module Lowdown
   # Provides a collection of test helpers.
@@ -56,10 +57,11 @@ module Lowdown
     # @return [Client]
     #         a Client configured with the `uri` and a self-signed certificate that has the `app_bundle_id` encoded.
     #
-    def self.client(uri: nil, app_bundle_id: "com.example.MockApp")
+    def self.client(uri: nil, app_bundle_id: "com.example.MockApp", keep_alive: false)
       certificate = certificate(app_bundle_id)
-      connection = Connection.new(uri: uri, ssl_context: certificate.ssl_context)
-      Client.client_with_connection(connection, certificate)
+      connection = Connection.new(uri, certificate.ssl_context, keep_alive)
+      connection.connect if keep_alive
+      Client.client_with_connection(connection, certificate: certificate)
     end
 
     # A mock object that can be used instead of a real Connection object.
@@ -67,7 +69,7 @@ module Lowdown
     class Connection
       # Represents a recorded request.
       #
-      Request = Struct.new(:path, :headers, :body, :response)
+      Request = Struct.new(:path, :headers, :body, :response, :delegate, :context)
 
       # @!group Mock API: Instance Attribute Summary
 
@@ -81,29 +83,38 @@ module Lowdown
       #
       attr_reader :responses
 
+      # @return [Boolean]
+      #         whether or not the connection should be opened on initialization. In a pool this basically equals the
+      #         `keep_alive` Client option.
+      #
+      attr_reader :pool_keep_alive
+
+      # @return [Fixnum]
+      #         the number of workers in a pool.
+      #
+      attr_accessor :pool_size
+
       # @!group Mock API: Instance Method Summary
 
       # @param (see Lowdown::Connection#initialize)
       #
-      def initialize(uri: nil, ssl_context: nil)
-        @uri, @ssl_context = uri, ssl_context
+      def initialize(uri = nil, ssl_context = nil, connect = true)
+        @uri, @ssl_context, @pool_keep_alive = uri, ssl_context, connect
         @responses = []
         @requests = []
       end
 
-      # @param  (see Response#unformatted_id)
-      #
       # @return [Array<Notification>]
       #         returns the recorded requests as Notification objects.
       #
-      def requests_as_notifications(unformatted_id_length = nil)
+      def requests_as_notifications
         @requests.map do |request|
           headers = request.headers
           hash = {
             :token => File.basename(request.path),
-            :id => request.response.unformatted_id(unformatted_id_length),
+            :id => request.response.id,
             :payload => JSON.parse(request.body),
-            :topic => headers["apns-topic"]
+            :topic => headers["apns-topic"],
           }
           hash[:expiration] = Time.at(headers["apns-expiration"].to_i) if headers["apns-expiration"]
           hash[:priority] = headers["apns-priority"].to_i if headers["apns-priority"]
@@ -121,68 +132,65 @@ module Lowdown
       #
       attr_reader :ssl_context
 
+      # @!group Celluloid API
+
+      def self.pool(size:, args:)
+        connection = new(*args)
+        connection.pool_size = size
+        connection
+      end
+
+      def async
+        self
+      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
       # thread, just like the real API does.
       #
+      # To make the connection simulate being closed from the other end, specify the `test-close-connection` header.
+      #
       # @param (see Lowdown::Connection#post)
       # @yield (see Lowdown::Connection#post)
       # @yieldparam (see Lowdown::Connection#post)
       # @return (see Lowdown::Connection#post)
       #
-      def post(path, headers, body, &callback)
-        response = @responses.shift || Response.new(":status" => "200", "apns-id" => (headers["apns-id"] || generate_id))
-        @requests << Request.new(path, headers, body, response)
-        @callbacks.enqueue { callback.call(response) }
-      end
+      def post(path:, headers:, body:, delegate:, context: nil)
+        raise "First open the connection." unless @connected
 
-      # Changes {#open?} to return `true`.
-      #
-      # @return [void]
-      #
-      def open
-        @callbacks = Threading::Consumer.new
-        @open = true
+        unless headers["test-close-connection"]
+          response = @responses.shift || Response.new(":status" => "200", "apns-id" => headers["apns-id"])
+        end
+        @requests << Request.new(path, headers, body, response, delegate, context)
+
+        raise EOFError, "Stubbed EOF" if headers["test-close-connection"]
+
+        delegate.handle_apns_response(response, context: context)
       end
 
-      # Changes {#open?} to return `false`.
+      # Changes {#connected?} to return `true`.
       #
       # @return [void]
       #
-      def close
-        flush
-        @callbacks.kill
-        @callbacks = nil
-        @open = false
+      def connect
+        @connected = true
       end
 
-      # no-op
+      # Changes {#connected?} to return `false`.
       #
       # @return [void]
       #
-      def flush
-        caller_thread = Thread.current
-        @callbacks.enqueue do
-          sleep 0.1
-          caller_thread.run
-        end
-        Thread.stop
+      def disconnect
+        @connected = false
       end
 
-      # @return (see Lowdown::Connection#open?)
+      # @return (see Lowdown::Connection#connected?)
       #
-      def open?
-        !!@open
-      end
-
-      private
-
-      def generate_id
-        @counter ||= 0
-        @counter += 1
-        Notification.new(:id => @counter).formatted_id
+      def connected?
+        !!@connected
       end
     end
   end
 end
+

data/lib/lowdown/notification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lowdown
   # A Notification holds the data and metadata about a Remote Notification.
   #
@@ -6,7 +8,21 @@ module Lowdown
   #
   class Notification
     # @!visibility private
-    APS_KEYS = %w{ alert badge sound content-available category }.freeze
+    APS_KEYS = %w( alert badge sound content-available category ).freeze
+
+    @id_mutex = Mutex.new
+    @id_counter = 0
+
+    def self.generate_id
+      @id_mutex.synchronize do
+        @id_counter += 1
+      end
+    end
+
+    def self.format_id(id)
+      padded = id.to_s.rjust(32, "0")
+      [padded[0, 8], padded[8, 4], padded[12, 4], padded[16, 4], padded[20, 12]].join("-")
+    end
 
     # @return [String]
     #         a device token.
@@ -53,6 +69,10 @@ module Lowdown
       !!(@token && @payload)
     end
 
+    def id
+      @id ||= self.class.generate_id
+    end
+
     # Formats the {#id} in the format required by the APN service, which is in groups of 8-4-4-12. It is padded with
     # leading zeroes.
     #
@@ -60,10 +80,7 @@ module Lowdown
     #         the formatted ID.
     #
     def formatted_id
-      if @id
-        padded = @id.to_s.rjust(32, "0")
-        [padded[0,8], padded[8,4], padded[12,4], padded[16,4], padded[20,12]].join("-")
-      end
+      @formatted_id ||= self.class.format_id(id)
     end
 
     # Unless the payload contains an `aps` entry, the payload is assumed to be a mix of APN defined attributes and
@@ -75,7 +92,7 @@ module Lowdown
     #         the payload organized according to the APN specification.
     #
     def formatted_payload
-      if @payload.has_key?("aps")
+      if @payload.key?("aps")
         @payload
       else
         payload = {}
@@ -94,3 +111,4 @@ module Lowdown
     end
   end
 end
+

data/lib/lowdown/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lowdown
   # An object that represents a response from the Apple Push Notification service for a single notification delivery.
   #
@@ -22,12 +24,12 @@ module Lowdown
       413 => "The notification payload was too large",
       429 => "The server received too many requests for the same device token",
       500 => "Internal server error",
-      503 => "The server is shutting down and unavailable"
-    }
+      503 => "The server is shutting down and unavailable",
+    }.freeze
 
     # The reasons that indicate a device token not being valid besides just being unregistered.
     #
-    INVALID_TOKEN_REASONS = %{ Unregistered BadDeviceToken DeviceTokenNotForTopic }.freeze
+    INVALID_TOKEN_REASONS = %( Unregistered BadDeviceToken DeviceTokenNotForTopic ).freeze
 
     # @return [String]
     #         either the {Notification#id} or, if none was provided, an ID generated by the service.
@@ -36,19 +38,6 @@ module Lowdown
       headers["apns-id"]
     end
 
-    # Tries to convert the ID back to the Notification {Notification#id} by removing leading zeroes.
-    #
-    # @param  [Integer] unformatted_id_length
-    #         the expected length of an ID, which ensures that **required** leading zeroes are not removed.
-    #
-    # @return [String]
-    #         the ID that was assigned to the Notification.
-    #
-    def unformatted_id(unformatted_id_length = nil)
-      id = self.id.tr('-', '')
-      unformatted_id_length ? id[32-unformatted_id_length,unformatted_id_length] : id.gsub(/\A0*/, '')
-    end
-
     # @return [Integer]
     #         the HTTP status returned by the service.
     #
@@ -113,10 +102,9 @@ module Lowdown
     #         a formatted description of the response.
     #
     def to_s
-      s = "#{status} (#{message})"
-      s << ": #{failure_reason}" unless success?
-      s << " last checked at #{activity_last_checked_at}" if inactive_token?
-      s
+      reason = ": #{failure_reason}" unless success?
+      last_check = " last checked at #{activity_last_checked_at}" if inactive_token?
+      "#{status} (#{message})#{reason}#{last_check}"
     end
 
     # @return [String]
@@ -127,3 +115,4 @@ module Lowdown
     end
   end
 end
+

data/lib/lowdown/version.rb

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

data/lowdown.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lowdown/version'
+require "lowdown/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "lowdown"
@@ -19,11 +19,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # This is currently set to >= 2.0.0 in the http-2 gemspec, which is incorrect, as it uses required keyword arguments.
-  spec.required_ruby_version = '>= 2.1.1'
+  spec.required_ruby_version = ">= 2.1.1"
 
   spec.add_runtime_dependency "http-2", ">= 0.8"
+  spec.add_runtime_dependency "celluloid-io", ">= 0.17.3" # has Ruby 2.3.0 support
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lowdown
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eloy Durán
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
@@ -84,14 +99,17 @@ files:
 - Rakefile
 - bin/lowdown
 - doc/lowdown.png
+- examples/long-running.rb
+- examples/simple.rb
 - lib/lowdown.rb
 - lib/lowdown/certificate.rb
 - lib/lowdown/client.rb
+- lib/lowdown/client/request_group.rb
 - lib/lowdown/connection.rb
+- lib/lowdown/connection/monitor.rb
 - lib/lowdown/mock.rb
 - lib/lowdown/notification.rb
 - lib/lowdown/response.rb
-- lib/lowdown/threading.rb
 - lib/lowdown/version.rb
 - lowdown.gemspec
 homepage: https://github.com/alloy/lowdown
@@ -114,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby client for the HTTP/2 version of the Apple Push Notification Service.