lowdown 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16ef8f3b50f11449f847661ccb4ec8e6778b8ccc
-  data.tar.gz: 1488fbc454c97265901024487be28faf7eb7223c
+  metadata.gz: d2e108d10dee8fe2b683cc76da5f3c7514957699
+  data.tar.gz: dca96974b0b8bd162baf8df4d6dff344650a7c61
 SHA512:
-  metadata.gz: e1b61b26414001f09fd20f36728095263c0d7d42f310cea0a745a0f41ca8e732115c81b3342ceaed205c084972484c4206d80a055e4a1943b2f6f668e7b565f9
-  data.tar.gz: 018adda275d2796bfba301acd287cd54e6f6f5653121e0c2926502afcc533b0a1ebd40bcec8f62ae79520edaf1de711d7916896e955fafcd6a546b21512a5311
+  metadata.gz: 82d96f945d8234049c66a546bac040852446bb9db72c228775619f487fa7bab9d21e1ce5ce23e8584b0356da2c7ff72f3cd16aa811ac2ce9477cdcfdc823a314
+  data.tar.gz: d7082d411eb7e0e74ed63f091db0eab272763caeda71aceea2353f95cb4c92b8206799747db480069c100498cffe026933cd324543d252bc9bfe14c3f47bb000

data/.travis.yml

@@ -3,6 +3,6 @@ rvm:
   - 2.1.1
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3.1
 before_install: gem install bundler
 install: bundle install --without doc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lowdown (0.3.1)
+    lowdown (1.0.0)
       celluloid-io (>= 0.17.3)
       http-2 (>= 0.8)
 

data/README.md

@@ -4,8 +4,6 @@
 
 [![Build Status](https://travis-ci.org/alloy/lowdown.svg?branch=master)](https://travis-ci.org/alloy/lowdown)
 
-⚠︎ 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.
 
 For efficiency, multiple notification requests are multiplexed and a single client can manage a pool of connections.
@@ -66,7 +64,7 @@ After obtaining a client, the simplest way to open a connection for a short peri
 This will open the connection, yield the block, and close the connection by the end of the block:
 
 ```ruby
-client = Lowdown::Client.production(true, File.read("path/to/certificate.pem")
+client = Lowdown::Client.production(true, certificate: File.read("path/to/certificate.pem")
 client.connect do |group|
   # ...
 end
@@ -79,7 +77,7 @@ end
 The trick to creating a persistent connection is to specify the `keep_alive: true` option when creating the client:
 
 ```ruby
-client = Lowdown::Client.production(true, File.read("path/to/certificate.pem"), keep_alive: true)
+client = Lowdown::Client.production(true, certificate: File.read("path/to/certificate.pem"), keep_alive: true)
 
 # Send a batch of notifications
 client.group do |group|
@@ -160,7 +158,24 @@ connections to the remote service. By default Lowdown will initialize clients wi
 increase this with the `pool_size` option:
 
 ```ruby
-Lowdown::Client.production(true, File.read("path/to/certificate.pem"), pool_size: 3)
+Lowdown::Client.production(true, certificate: File.read("path/to/certificate.pem"), pool_size: 3)
+```
+
+### Connect to APNS via proxy
+
+`Lowdown::Connection#initialize` accepts a lambda to build TCPSocket. Build a duck type of TCPSocket which go through proxy.
+
+```ruby
+socket_maker = lambda do |uri|
+  Proxifier::Proxy('http://127.0.0.1:3128').open \
+    uri.host, uri.port, nil, nil, Celluloid::IO::TCPSocket
+end
+
+connection_pool = Lowdown::Connection.pool \
+  size: 2,
+  args: [uri, cert.ssl_context, true, socket_maker]
+
+client = Lowdown::Client.client_with_connection connection_pool, certificate: cert
 ```
 
 ## Gotchas

data/lib/lowdown/certificate.rb

@@ -126,8 +126,9 @@ module Lowdown
     #
     def topics
       if universal?
-        components = extension(UNIVERSAL_CERTIFICATE_EXTENSION).value.split(/0?\.{2,}/)
-        components.select.with_index { |_, index| index.odd? }
+        ext = extension(UNIVERSAL_CERTIFICATE_EXTENSION)
+        seq = OpenSSL::ASN1.decode(OpenSSL::ASN1.decode(ext.to_der).value[1].value)
+        seq.select.with_index { |_, index| index.even? }.map(&:value)
       else
         [app_bundle_id]
       end

data/lib/lowdown/connection.rb

@@ -83,8 +83,25 @@ module Lowdown
     # @param  [Boolean] connect
     #         whether or not to immediately connect on initialization.
     #
-    def initialize(uri, ssl_context, connect = true)
+    # @param [lambda] socket_maker
+    #        a lambda takes uri and returns duck type of TCPSocket
+    #        e.g.:
+    #
+    # @example Use `socket_maker` argument with modified ruby-proxifier
+    #   socket_maker = lambda do |uri|
+    #     Proxifier::Proxy('http://127.0.0.1:3128').open \
+    #     uri.host, uri.port, nil, nil, Celluloid::IO::TCPSocket
+    #   end
+    #
+    #   connection_pool = Lowdown::Connection.pool \
+    #     size: 2,
+    #     args: [uri, cert.ssl_context, true, socket_maker]
+    #
+    #   client = Lowdown::Client.client_with_connection connection_pool, certificate: cert
+    #
+    def initialize(uri, ssl_context, connect = true, socket_maker = nil)
       @uri, @ssl_context = URI(uri), ssl_context
+      @socket_maker = socket_maker
       reset_state!
 
       if connect
@@ -165,7 +182,11 @@ module Lowdown
       # 2. This tries to `NilClass#send` the hostname:
       #    https://github.com/celluloid/celluloid-io/blob/85cee9da22ef5e94ba0abfd46454a2d56572aff4/lib/celluloid/io/dns_resolver.rb#L44
       begin
-        socket = TCPSocket.new(@uri.host, @uri.port)
+        socket = if @socket_maker.respond_to? :call
+                   @socket_maker.call @uri
+                 else
+                   TCPSocket.new(@uri.host, @uri.port)
+                 end
       rescue NoMethodError
         raise SocketError, "(Probably) getaddrinfo: nodename nor servname provided, or not known"
       end
@@ -240,6 +261,8 @@ module Lowdown
     # @return [void]
     #
     def change_to_connected_state
+      return unless @http
+
       @max_stream_count = @http.remote_settings[:settings_max_concurrent_streams]
       @connected = true
 
@@ -327,14 +350,14 @@ module Lowdown
     end
 
     def try_to_perform_request!
-      unless @connected
+      if @connected
+        @warned_about_not_connected = false
+      else
         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

data/lib/lowdown/mock.rb

@@ -30,7 +30,13 @@ module Lowdown
 
       # Make it a Universal Certificate
       ext_name = Lowdown::Certificate::UNIVERSAL_CERTIFICATE_EXTENSION
-      cert.extensions = [OpenSSL::X509::Extension.new(ext_name, "0d..#{app_bundle_id}0...app")]
+      ext_value = OpenSSL::ASN1::Sequence.new(
+        [
+          OpenSSL::ASN1::UTF8String.new(app_bundle_id),
+          OpenSSL::ASN1::Sequence.new([OpenSSL::ASN1::UTF8String.new("app")]),
+        ]
+      ).to_der
+      cert.extensions = [OpenSSL::X509::Extension.new(ext_name, ext_value)]
 
       [cert, key]
     end

data/lib/lowdown/response.rb

@@ -95,7 +95,7 @@ module Lowdown
     #         in case of an inactive token, the time at which the service last verified it.
     #
     def activity_last_checked_at
-      Time.at(body["timestamp"].to_i) if inactive_token?
+      Time.at(body["timestamp"].to_i / 1000) if inactive_token?
     end
 
     # @return [String]

data/lib/lowdown/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lowdown
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Eloy Durán
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2