apnotic 1.3.1 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c18668add69f52308e07541356eddc8d80d5993a
-  data.tar.gz: e8eac41fd48b7eb3a30d59d8fdabe35926c8b5d9
+SHA256:
+  metadata.gz: fabb07ff303f54456a91694d9025ee9a6416012c99459316e973a61d9d4e23de
+  data.tar.gz: 50fb64db3f3dd88c6e4f32081745c47b41b01fbb89e10a62c3cfb57db6cb7c63
 SHA512:
-  metadata.gz: 7b9af64072437d4f35922b8ebdce9dd9dd21ba1f72f1e4f74dc5cb5674f0ec9fb63acc7c84f59f59a0845470465dcc8de92bd01357af3c79b00099aa1c6ea29e
-  data.tar.gz: 9803cafad31803a8983d6a88875c4d452d3cb8cb97345fb8ee5afd912b217cb203062db9d8f79ec3375452f10122c86572f98d4975c0f5518e015f6fab2e2943
+  metadata.gz: ecf745aea19457f69c661c44dcee4655693d9195db5eeeab36a6050781f6be6e2e04f24ccdd8c3233038dffc0e674ef9558a27e93c430c33d4076ef7e254ea96
+  data.tar.gz: eeb22010a7c06e12ba72239dff31fbedc353485b9b8380aadf6c654136a22b7fc09f5db0f0147915e7f2914e08a8178937937cc61ed2c022bd5ff476c1487c9b

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/.travis.yml

@@ -1,11 +1,14 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7
 
 branches:
   only:
     - master
+
+before_install:
+  - gem install bundler

data/README.md

@@ -86,7 +86,7 @@ end
 connection.push_async(push)
 
 # wait for all requests to be completed
-connection.join
+connection.join(timeout: 5)
 
 # close the connection
 connection.close
@@ -166,7 +166,9 @@ class MyWorker
   APNOTIC_POOL = Apnotic::ConnectionPool.new({
     cert_path: Rails.root.join("config", "certs", "apns_certificate.pem"),
     cert_pass: "mypass"
-  }, size: 5)
+  }, size: 5) do |connection|
+    connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+  end
 
   def perform(token)
     APNOTIC_POOL.with do |connection|
@@ -205,6 +207,10 @@ Apnotic::Connection.new(options)
 | :cert_pass | Optional. The certificate's password.
 | :url | Optional. Defaults to https://api.push.apple.com:443.
 | :connect_timeout | Optional. Expressed in seconds, defaults to 30.
+| :proxy_addr | Optional.  Proxy server. e.g. http://proxy.example.com
+| :proxy_port | Optional.  Proxy port. e.g. 8080
+| :proxy_user | Optional.  User name for proxy authentication. e.g. user_name
+| :proxy_pass | Optional.  Password for proxy authentication. e.g. pass_word
 
 Note that since `:cert_path` can be any object that responds to `:read`, it is possible to pass in a certificate string directly by wrapping it up in a `StringIO` object:
 
@@ -265,7 +271,9 @@ connection.on(:error) { |exception| puts "Exception has been raised: #{exception
 For your convenience, a wrapper around the [Connection Pool](https://github.com/mperham/connection_pool) gem is here for you. To create a new connection pool:
 
 ```ruby
-Apnotic::ConnectionPool.new(connection_options, connection_pool_options)
+Apnotic::ConnectionPool.new(connection_options, connection_pool_options) do |connection|
+  connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+end
 ```
 
 For example:
@@ -273,15 +281,20 @@ For example:
 ```ruby
 APNOTIC_POOL = Apnotic::ConnectionPool.new({
   cert_path: "apns_certificate.pem"
-}, size: 5)
+}, size: 5) do |connection|
+  connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+end
 ```
 
 It is also possible to create a connection pool that points to the Apple Development servers by calling instead:
 
 ```ruby
-Apnotic::ConnectionPool.development(connection_options, connection_pool_options)
+Apnotic::ConnectionPool.development(connection_options, connection_pool_options) do |connection|
+  connection.on(:error) { |exception| puts "Exception has been raised: #{exception}" }
+end
 ```
 
+> Since `1.4.0.` you are required to pass in a block when defining an `Apnotic::ConnectionPool`. This is to enforce a proper implementation of the library. You can read more [here](https://github.com/ostinelli/apnotic/issues/69).
 
 ### `Apnotic::Notification`
 To create a notification for a specific device token:

data/apnotic.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "net-http2", ">= 0.17", "< 2"
-  spec.add_dependency "connection_pool", "~> 2.0"
+  spec.add_dependency "net-http2", ">= 0.18.3", "< 2"
+  spec.add_dependency "connection_pool", "~> 2"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/apnotic/abstract_notification.rb

@@ -26,6 +26,10 @@ module Apnotic
       authorization ? "bearer #{authorization}" : nil
     end
 
+    def background_notification?
+      false
+    end
+
     private
 
     def to_hash

data/lib/apnotic/connection.rb

@@ -3,8 +3,9 @@ require 'openssl'
 
 module Apnotic
 
-  APPLE_DEVELOPMENT_SERVER_URL = "https://api.development.push.apple.com:443"
+  APPLE_DEVELOPMENT_SERVER_URL = "https://api.sandbox.push.apple.com:443"
   APPLE_PRODUCTION_SERVER_URL  = "https://api.push.apple.com:443"
+  PROXY_SETTINGS_KEYS = [:proxy_addr, :proxy_port, :proxy_user, :proxy_pass]
 
   class Connection
     attr_reader :url, :cert_path
@@ -28,7 +29,15 @@ module Apnotic
 
       raise "Cert file not found: #{@cert_path}" unless @cert_path && (@cert_path.respond_to?(:read) || File.exist?(@cert_path))
 
-      @client = NetHttp2::Client.new(@url, ssl_context: ssl_context, connect_timeout: @connect_timeout)
+      http2_options = {
+        ssl_context: ssl_context,
+        connect_timeout: @connect_timeout
+      }
+      PROXY_SETTINGS_KEYS.each do |key|
+        http2_options[key] = options[key] if options[key]
+      end
+
+      @client = NetHttp2::Client.new(@url, http2_options)
     end
 
     def push(notification, options={})
@@ -63,8 +72,8 @@ module Apnotic
       @client.close
     end
 
-    def join
-      @client.join
+    def join(timeout: nil)
+      @client.join(timeout: timeout)
     end
 
     def on(event, &block)
@@ -92,7 +101,7 @@ module Apnotic
     def remote_max_concurrent_streams
       # 0x7fffffff is the default value from http-2 gem (2^31)
       if @client.remote_settings[:settings_max_concurrent_streams] == 0x7fffffff
-        0
+        1
       else
         @client.remote_settings[:settings_max_concurrent_streams]
       end

data/lib/apnotic/connection_pool.rb

@@ -6,14 +6,22 @@ module Apnotic
 
     class << self
       def new(options={}, pool_options={})
+        raise(LocalJumpError, "a block is needed when initializing an Apnotic::ConnectionPool") unless block_given?
+
         ::ConnectionPool.new(pool_options) do
-          Apnotic::Connection.new(options)
+          connection = Apnotic::Connection.new(options)
+          yield(connection)
+          connection
         end
       end
 
       def development(options={}, pool_options={})
+        raise(LocalJumpError, "a block is needed when initializing an Apnotic::ConnectionPool") unless block_given?
+
         ::ConnectionPool.new(pool_options) do
-          Apnotic::Connection.development(options)
+          connection = Apnotic::Connection.development(options)
+          yield(connection)
+          connection
         end
       end
     end

data/lib/apnotic/notification.rb

@@ -5,6 +5,10 @@ module Apnotic
   class Notification < AbstractNotification
     attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :url_args, :mutable_content, :thread_id
 
+    def background_notification?
+      aps.count == 1 && aps.key?('content-available') && aps['content-available'] == 1
+    end
+
     private
 
     def aps

data/lib/apnotic/request.rb

@@ -16,6 +16,7 @@ module Apnotic
       h.merge!('apns-id' => notification.apns_id) if notification.apns_id
       h.merge!('apns-expiration' => notification.expiration) if notification.expiration
       h.merge!('apns-priority' => notification.priority) if notification.priority
+      h.merge!('apns-push-type' => notification.background_notification? ? 'background' : 'alert' )
       h.merge!('apns-topic' => notification.topic) if notification.topic
       h.merge!('apns-collapse-id' => notification.apns_collapse_id) if notification.apns_collapse_id
       h.merge!('authorization' => notification.authorization_header) if notification.authorization_header

data/lib/apnotic/version.rb

@@ -1,3 +1,3 @@
 module Apnotic
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apnotic
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.6.1
 platform: ruby
 authors:
 - Roberto Ostinelli
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http2
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.18.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.18.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -36,42 +36,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - roberto@ostinelli.net
 executables: []
@@ -95,8 +95,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - Gemfile
 - LICENSE.md
@@ -121,7 +120,7 @@ homepage: http://github.com/ostinelli/apnotic
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Apnotic is an Apple Push Notification gem able to provide instant feedback.
 test_files: []

data/.ruby-gemset

@@ -1 +0,0 @@
-apnotic

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.3.1