pushing 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 562381d6f82d103cc6e5db2b3408ea36d28fdb7a
-  data.tar.gz: 4df883a714c37d2a87f7555b75eb1cce48d5f370
+SHA256:
+  metadata.gz: e6d63cb3c86db8e3be6c3335fb26e7e028ba5b25eb9ad13aa4b8febbf82d432c
+  data.tar.gz: 82d5cf8214b81355a1dbc1db23843525e492889af24f0750874d1ec626830767
 SHA512:
-  metadata.gz: be1bde88cd14ce57d6196cffb630bcf228d89e47040c7cce38e3887b6291bc32ff0edf83ed93ce3532deb1b9f477ab9990f0fae094df5a9f1566ed4816524e42
-  data.tar.gz: 060ca860f1f7960dfa264c4d5fd3ee6aa21fa11546cd6dcf6ce6cc87e6d879a16f0ab1211b9715925938fc64e38251cc14771767c5437a59d355f226ad44cce9
+  metadata.gz: 2f6c64a1574f61b456656018eb94fe6c73f3638745c8c26420f22098ef0de9188511e317a7f070ad2b683c58785650634fb03e2db9ccc6278f4e1280d7729e46
+  data.tar.gz: 5c31ab15a5ec3f68622167ea05fe89eaf9b43c563d65f02d903f3793e3a5c22674d90af97d631dfe79df086524dd2f85f873298bff5136443358dc6944687e14

data/.gitignore

@@ -10,3 +10,4 @@
 gemfiles/*.lock
 certs/apns_example_production.pem
 gemfiles/.bundle/
+certs/apns_auth_key_for_jwt_auth.p8

data/.travis.yml

@@ -4,25 +4,35 @@ cache:  bundler
 sudo:   false
 
 before_install:
-  openssl aes-256-cbc -K $encrypted_86ed69f44076_key -iv $encrypted_86ed69f44076_iv -in ./certs/apns_example_production.pem.enc -out certs/apns_example_production.pem -d
+  - gem update --system
+  - gem pristine bundler
+  - openssl aes-256-cbc -K $encrypted_86ed69f44076_key -iv $encrypted_86ed69f44076_iv -in ./certs/apns_auth_key_for_jwt_auth.p8.enc -out certs/apns_auth_key_for_jwt_auth.p8 -d
+  - openssl aes-256-cbc -K $encrypted_86ed69f44076_key -iv $encrypted_86ed69f44076_iv -in ./certs/apns_example_production.pem.enc -out certs/apns_example_production.pem -d
 
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
   - ruby-head
-  - jruby-9.1.10.0
+  - jruby-9.1.16.0
   - jruby-head
 
 gemfile:
   - gemfiles/rails_42.gemfile
   - gemfiles/rails_50.gemfile
   - gemfiles/rails_51.gemfile
+  - gemfiles/rails_52.gemfile
   - gemfiles/rails_edge.gemfile
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-9.1.10.0
+    - rvm: jruby-9.1.16.0
     - rvm: jruby-head
     - gemfile: gemfiles/rails_edge.gemfile
+  exclude:
+    - rvm: 2.3.6
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.2.9
+      gemfile: gemfiles/rails_edge.gemfile

data/Appraisals

@@ -7,11 +7,11 @@ appraise "rails_edge" do
   end
 end
 
-appraise "rails_50" do
-  gem "railties", '~> 5.0.0'
-  gem "actionpack", '~> 5.0.0'
-  gem "actionview", '~> 5.0.0'
-  gem "activejob", '~> 5.0.0'
+appraise "rails_52" do
+  gem "railties", '~> 5.2.0.rc1'
+  gem "actionpack", '~> 5.2.0.rc1'
+  gem "actionview", '~> 5.2.0.rc1'
+  gem "activejob", '~> 5.2.0.rc1'
 end
 
 appraise "rails_51" do
@@ -21,6 +21,13 @@ appraise "rails_51" do
   gem "activejob", '~> 5.1.0'
 end
 
+appraise "rails_50" do
+  gem "railties", '~> 5.0.0'
+  gem "actionpack", '~> 5.0.0'
+  gem "actionview", '~> 5.0.0'
+  gem "activejob", '~> 5.0.0'
+end
+
 appraise "rails_42" do
   gem "rails", '~> 4.2.0'
   gem "actionpack", '~> 4.2.0'

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 # APNs
 gem 'houston', require: false
-gem 'apnotic', require: false
+gem 'apnotic', '>= 1.2.0', require: false
 gem 'lowdown', require: false
 
 # FCM

data/README.md

@@ -1,8 +1,8 @@
-# Pushing [![Build Status](https://travis-ci.org/yuki24/pushing.svg?branch=master)](https://travis-ci.org/yuki24/pushing)
+# Pushing: ActionMailer for Push Notifications [![Build Status](https://travis-ci.org/yuki24/pushing.svg?branch=master)](https://travis-ci.org/yuki24/pushing)
 
-Pushing is a push notification framework that implements interfaces similar to ActionMailer's APIs.
+Pushing is a push notification framework that implements interfaces similar to ActionMailer.
 
- * **Convention over Configuration**: Pushing brings Convention over Configuration to your app's push notification implementation.
+ * **Convention over Configuration**: Pushing brings Convention over Configuration to your app for organizing your push notification implementations.
  * **Extremely Easy to Learn**: If you know how to use ActionMailer, you already know how to use Pushing. Send notifications asynchronously with ActiveJob at no learning cost.
  * **Testability**: First-class support for push notification. No more hassle writing custom code or stubs/mocks for your tests.
 
@@ -11,44 +11,40 @@ Pushing is a push notification framework that implements interfaces similar to A
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pushing', github: 'yuki24/pushing'
-gem 'jbuilder'
+gem 'pushing'
+gem 'jbuilder' # if you don't have it in your Gemfile
 ```
 
-As the time of writing, Pushing only has support for [jbuilder](https://github.com/rails/jbuilder) (Rails' default JSON constructor), but there are plans to add support for [jb](https://github.com/amatsuda/jb) and [rabl](https://github.com/nesquena/rabl).
+At the time of writing, Pushing only has support for [jbuilder](https://github.com/rails/jbuilder) (Rails' default JSON constructor), but there are plans to add support for [jb](https://github.com/amatsuda/jb) and [rabl](https://github.com/nesquena/rabl).
 
-### Supported Client Gems
+### Supported Platforms
 
-Pushing itself doesn't make HTTP requests. Instead, it uses an adapter and let an underlaying gem do it. Currently, Pushing has support for the following client gems:
+Pushing itself doesn't make HTTP requests. Instead, it uses an adapter to make actual calls. Currently, Pushing has support for the following client gems:
 
- * [APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html#//apple_ref/doc/uid/TP40008194-CH8-SW1):
+ * [APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html#//apple_ref/doc/uid/TP40008194-CH8-SW1) (iOS):
    * [anpotic](https://github.com/ostinelli/apnotic) (recommended)
    * [lowdown](https://github.com/alloy/lowdown)
    * [houston](https://github.com/nomad/houston)
 
- * [FCM](https://firebase.google.com/docs/cloud-messaging/):
+ * [FCM](https://firebase.google.com/docs/cloud-messaging/) (Android):
    * [andpush](https://github.com/yuki24/andpush) (recommended)
    * [fcm](https://github.com/spacialdb/fcm)
 
 If you are starting from scratch, it is recommended using [anpotic](https://github.com/ostinelli/apnotic) for APNs and [andpush](https://github.com/yuki24/andpush) for FCM due to their reliability and performance:
 
 ```ruby
-gem 'apnotic' # APNs integration
-gem 'andpush' # FCM integration
+gem 'apnotic' # APNs
+gem 'andpush' # FCM
 ```
 
 ### Walkthrough to Writing a Notifier
 
-In this README, we'll use Twitter as an example. Suppose you'd like to send a push notification when a user receives a new direct message from other user. To get started, you can use Pushing's notifier generator:
+#### Generate a new notifier:
 
 ```sh
 $ rails g pushing:notifier TweetNotifier new_direct_message
 ```
 
-#### Edit the Notifier
-
-Let's say there are `direct_messages` and `device_tokens` tables where we store actual messages and device tokens (a.k.a registration ids in FCM) given by APNs or FCM.
-
 ```ruby
 # app/notifiers/tweet_notifier.rb
 class TweetNotifier < ApplicationNotifier
@@ -61,18 +57,7 @@ class TweetNotifier < ApplicationNotifier
 end
 ```
 
-Notice that the `:apn` key takes a truthy string value while the `:fcm` key takes a boolean value. Also, Pushing only sends a notification for the platforms that are given a truthy value. For example, the call:
-
-```ruby
-# only sends a push notification to FCM
-push apn: false, fcm: @token.registration_id
-```
-
-will only send a notification to the FCM service.
-
-#### Edit the Push Notification Payload
-
-Next, let's modify the templates to generate JSON that contains message data. Like controllers, you can use all the instance variables initialized in the action.
+#### Edit the push notification payload:
 
 APNs:
 
@@ -104,9 +89,7 @@ json.notification do
 end
 ```
 
-### Deliver the Push Notifications
-
-Finally, send a push notification to the user. You can call the `#deliver_now!` method to immediately send a notification, or the `#deliver_later!` method if you have ActiveJob set up.
+### Deliver the push notifications:
 
 ```ruby
 TweetNotifier.new_direct_message(message_id, device_token.id).deliver_now!
@@ -116,6 +99,57 @@ TweetNotifier.new_direct_message(message_id, device_token.id).deliver_later!
 # => enqueues a job that sends a push notification later
 ```
 
+## Advanced Usage
+
+### Pushing only to one platform
+
+Pushing only sends a notification for the platforms that are given a truthy value. For example, give the following code:
+
+```ruby
+push apn: @token.device_token, fcm: false
+# => only sends a push notification to APNs
+
+push apn: @token.device_token
+# => same as above but without the `:fcm` key, only sends a push notification to APNs
+```
+
+This will only send a push notification to APNs and skip the call to FCM.
+
+### APNs
+
+It is often necessary to switch the environment endpoint or adjust the request headers depending on the notification you want to send. Pushing's `#push` method allows for overriding APNs request headers on a delivery-basis:
+
+#### Overriding the default environment:
+
+```ruby
+push apn: { device_token: @token.device_token, environment: @token.apn_environment }
+```
+
+#### Overriding the default APN topic:
+
+```ruby
+push apn: { device_token: @token.device_token, headers: { apns_topic: 'your.otherapp.ios' } }
+```
+
+#### Or all of the above:
+
+```ruby
+push fcm: @token.fcm?,
+     apn: {
+       device_token: @token.apn? && @token.device_token,
+       environment: @token.apn_environment,
+       headers: {
+         apns_id:          uuid,
+         apns_expiration:  7.days.from_now,
+         apns_priority:    5,
+         apns_topic:       'your.otherapp.ios',
+         apns_collapse_id: 'not-so-important-notification'
+       }
+     }
+```
+
+The `:fcm` key, on the other hand, doesn't have any options as everything's configurable through the request body.
+
 ## Error Handling
 
 Like ActionMailer, you can use the `rescue_from` hook to handle exceptions. A common use-case would be to handle a **'BadDeviceToken'** response from APNs or a response with a **'Retry-After'** header from FCM.
@@ -129,8 +163,9 @@ class ApplicationNotifier < Pushing::Base
 
     if response.status == 410 || (response.status == 400 && response.json[:reason] == 'BadDeviceToken')
       token = error.notification.device_token
+      Rails.logger.info("APN device token #{token} has been expired and will be removed.")
 
-      # delete device token accordingly
+      # delete or expire device token accordingly
     else
       raise # Make sure to raise any other types of error to re-enqueue the job
     end
@@ -180,11 +215,70 @@ end
 
 ## Configuration
 
-TODO
+##### TODO: Make this section more helpful
+
+```ruby
+Pushing::Platforms.configure do |config|
+  # Adapter that is used to send push notifications through FCM
+  config.fcm.adapter = Rails.env.test? ? :test : :andpush
+
+  # Your FCM servery key that can be found here: https://console.firebase.google.com/project/_/settings/cloudmessaging
+  config.fcm.server_key = 'YOUR_FCM_SERVER_KEY'
+
+  # Adapter that is used to send push notifications through APNs
+  config.apn.adapter = Rails.env.test? ? :test : :apnotic
+
+  # The environment that is used by default to send push notifications through APNs
+  config.apn.environment = Rails.env.production? ? :production : :development
+
+  # The scheme that is used for negotiating connection trust between your provider
+  # servers and Apple Push Notification service. As documented in the offitial doc,
+  # there are two schemes available:
+  #
+  #   :token       - Token-based provider connection trust (default)
+  #   :certificate - Certificate-based provider connection trust
+  #
+  # This option is only applied when using an adapter that uses the HTTP/2-based
+  # API.
+  config.apn.connection_scheme = :token
+
+  # Path to the certificate or auth key for establishing a connection to APNs.
+  #
+  # This config is always required.
+  config.apn.certificate_path = 'path/to/your/certificate'
+
+  # Password for the certificate specified above if there's any.
+  # config.apn.certificate_password = 'passphrase'
+
+  # A 10-character key identifier (kid) key, obtained from your developer account.
+  # If you haven't created an Auth Key for your app, create a new one at:
+  #   https://developer.apple.com/account/ios/authkey/
+  #
+  # Required if the +connection_scheme+ is set to +:token+.
+  config.apn.key_id = 'DEF123GHIJ'
+
+  # The issuer (iss) registered claim key, whose value is your 10-character Team ID,
+  # obtained from your developer account. Your team id could be found at:
+  #   https://developer.apple.com/account/#/membership
+  #
+  # Required if the +connection_scheme+ is set to +:token+.
+  config.apn.team_id = 'ABC123DEFG'
+
+  # Header values that are added to every request to APNs. documentation for the
+  # headers available can be found here:
+  #   https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW13
+  config.apn.default_headers = {
+    apns_priority:    10,
+    apns_topic:       'your.awesomeapp.ios',
+    apns_collapse_id: 'wrong.topicname.com'
+  }
+end
+
+```
 
 ## Testing
 
-Pushing provides first-class support for testing. In the test environment, use the `:test` adapter instead of an actual adapter you'd like to use in development/production.
+Pushing provides first-class support for testing. In order to test your notifier, use the `:test` adapter in the test environment instead of an actual adapter in development/production.
 
 ```ruby
 # config/initializers/pushing.rb
@@ -194,7 +288,7 @@ Pushing::Platforms.configure do |config|
 end
 ```
 
-Now you can use the `#deliveries` method. Here is an example with [ActiveSupport::TestCase](http://api.rubyonrails.org/classes/ActiveSupport/TestCase.html):
+Now you can call the `#deliveries` method on the notifier. Here is an example with [ActiveSupport::TestCase](http://api.rubyonrails.org/classes/ActiveSupport/TestCase.html):
 
 ```ruby
 TweetNotifier.deliveries.clear # => clears the test inbox

data/gemfiles/rails_42.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "houston", require: false
-gem "apnotic", require: false
+gem "apnotic", ">= 1.2.0", require: false
 gem "lowdown", require: false
 gem "andpush", require: false
 gem "fcm", require: false

data/gemfiles/rails_50.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "houston", require: false
-gem "apnotic", require: false
+gem "apnotic", ">= 1.2.0", require: false
 gem "lowdown", require: false
 gem "andpush", require: false
 gem "fcm", require: false

data/gemfiles/rails_51.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "houston", require: false
-gem "apnotic", require: false
+gem "apnotic", ">= 1.2.0", require: false
 gem "lowdown", require: false
 gem "andpush", require: false
 gem "fcm", require: false

data/gemfiles/rails_52.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "houston", require: false
+gem "apnotic", ">= 1.2.0", require: false
+gem "lowdown", require: false
+gem "andpush", require: false
+gem "fcm", require: false
+gem "pry"
+gem "pry-byebug", platforms: :mri
+gem "railties", "~> 5.2.0.rc1"
+gem "actionpack", "~> 5.2.0.rc1"
+gem "actionview", "~> 5.2.0.rc1"
+gem "activejob", "~> 5.2.0.rc1"
+
+gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -10,7 +10,7 @@ git "git://github.com/rails/rails.git" do
 end
 
 gem "houston", require: false
-gem "apnotic", require: false
+gem "apnotic", ">= 1.2.0", require: false
 gem "lowdown", require: false
 gem "andpush", require: false
 gem "fcm", require: false

data/lib/generators/pushing/templates/initializer.rb

@@ -1,10 +1,55 @@
 Pushing::Platforms.configure do |config|
-  config.fcm.adapter    = Rails.env.test? ? :test : :andpush
-  config.fcm.server_key = 'YOUR_FCM_TEST_SERVER_KEY'
-
-  config.apn.environment          = Rails.env.production? ? :production : :development
-  config.apn.adapter              = Rails.env.test? ? :test : :apnotic
-  config.apn.topic                = 'com.awesomecompany.app'
-  config.apn.certificate_path     = '/config/your_certificate.pem'
-  config.apn.certificate_password = 'PASSWORD_FOR_CERT'
+  # Adapter that is used to send push notifications through FCM
+  config.fcm.adapter = Rails.env.test? ? :test : :andpush
+
+  # Your FCM servery key that can be found here: https://console.firebase.google.com/project/_/settings/cloudmessaging
+  config.fcm.server_key = 'YOUR_FCM_SERVER_KEY'
+
+  # Adapter that is used to send push notifications through APNs
+  config.apn.adapter = Rails.env.test? ? :test : :apnotic
+
+  # The environment that is used by default to send push notifications through APNs
+  config.apn.environment = Rails.env.production? ? :production : :development
+
+  # The scheme that is used for negotiating connection trust between your provider
+  # servers and Apple Push Notification service. As documented in the offitial doc,
+  # there are two schemes available:
+  #
+  #   :token       - Token-based provider connection trust (default)
+  #   :certificate - Certificate-based provider connection trust
+  #
+  # This option is only applied when using an adapter that uses the HTTP/2-based
+  # API.
+  config.apn.connection_scheme = :token
+
+  # Path to the certificate or auth key for establishing a connection to APNs.
+  #
+  # This config is always required.
+  config.apn.certificate_path = 'path/to/your/certificate'
+
+  # Password for the certificate specified above if there's any.
+  # config.apn.certificate_password = 'passphrase'
+
+  # A 10-character key identifier (kid) key, obtained from your developer account.
+  # If you haven't created an Auth Key for your app, create a new one at:
+  #   https://developer.apple.com/account/ios/authkey/
+  #
+  # Required if the +connection_scheme+ is set to +:token+.
+  config.apn.key_id = 'DEF123GHIJ'
+
+  # The issuer (iss) registered claim key, whose value is your 10-character Team ID,
+  # obtained from your developer account. Your team id could be found at:
+  #   https://developer.apple.com/account/#/membership
+  #
+  # Required if the +connection_scheme+ is set to +:token+.
+  config.apn.team_id = 'ABC123DEFG'
+
+  # Header values that are added to every request to APNs. documentation for the
+  # headers available can be found here:
+  #   https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW13
+  config.apn.default_headers = {
+    apns_priority:    10,
+    apns_topic:       'your.awesomeapp.ios',
+    apns_collapse_id: 'wrong.topicname.com'
+  }
 end

data/lib/pushing/adapters/apn/apnotic_adapter.rb

@@ -1,6 +1,7 @@
 # frozen-string-literal: true
 
 require 'apnotic'
+require 'active_support/core_ext/hash/keys'
 
 module Pushing
   module Adapters
@@ -19,16 +20,26 @@ module Pushing
         size: Process.getrlimit(Process::RLIMIT_NOFILE).first / 8
       }.freeze
 
-      attr_reader :environment, :topic, :connection_pool
+      attr_reader :connection_pool
 
       def initialize(apn_settings)
-        @environment = apn_settings.environment.to_sym
-        @topic       = apn_settings.topic
-
-        options = {
-          cert_path: apn_settings.certificate_path,
-          cert_pass: apn_settings.certificate_password
-        }
+        options = case apn_settings.connection_scheme.to_sym
+                  when :token
+                    {
+                      auth_method: :token,
+                      cert_path: apn_settings.certificate_path,
+                      key_id: apn_settings.key_id,
+                      team_id: apn_settings.team_id
+                    }
+                  when :certificate
+                    {
+                      cert_path: apn_settings.certificate_path,
+                      cert_pass: apn_settings.certificate_password
+                    }
+                  else
+                    raise "Unknown connection scheme #{apn_settings.connection_scheme.inspect}. " \
+                          "The connection scheme should either be :token or :certificate."
+                  end
 
         @connection_pool = {
           development: Apnotic::ConnectionPool.development(options, DEFAULT_ADAPTER_OPTIONS),
@@ -38,7 +49,7 @@ module Pushing
 
       def push!(notification)
         message = Apnotic::Notification.new(notification.device_token)
-        json    = notification.payload
+        json    = notification.payload.dup
 
         if aps = json.delete(:aps)
           APS_DICTIONARY_KEYS.each {|key| message.instance_variable_set(:"@#{key}", aps[key]) }
@@ -49,10 +60,10 @@ module Pushing
         message.apns_id          = notification.headers[:'apns-id'] || message.apns_id
         message.expiration       = notification.headers[:'apns-expiration'].to_i
         message.priority         = notification.headers[:'apns-priority']
-        message.topic            = notification.headers[:'apns-topic'] || topic
+        message.topic            = notification.headers[:'apns-topic']
         message.apns_collapse_id = notification.headers[:'apns-collapse-id']
 
-        response = connection_pool[notification.environment || environment].with {|connection| connection.push(message) }
+        response = connection_pool[notification.environment].with {|connection| connection.push(message) }
 
         if !response
           raise "Timeout sending a push notification"

data/lib/pushing/adapters/apn/houston_adapter.rb

@@ -3,11 +3,10 @@ require 'houston'
 module Pushing
   module Adapters
     class HoustonAdapter
-      attr_reader :certificate_path, :environment, :client
+      attr_reader :certificate_path, :client
 
       def initialize(apn_settings)
         @certificate_path = apn_settings.certificate_path
-        @environment      = apn_settings.environment
 
         @client = {
           production: Houston::Client.production,
@@ -17,12 +16,12 @@ module Pushing
       end
 
       def push!(notification)
-        payload      = notification.payload
+        payload      = notification.payload.dup
         aps          = payload.delete(:aps)
         aps[:device] = notification.device_token
 
         houston_notification = Houston::Notification.new(payload.merge(aps))
-        client[notification.environment || environment].push(houston_notification)
+        client[notification.environment].push(houston_notification)
       rescue => cause
         error = Pushing::ApnDeliveryError.new("Error while trying to send push notification: #{cause.message}", nil, notification)
 

data/lib/pushing/adapters/apn/lowdown_adapter.rb

@@ -1,16 +1,14 @@
 # frozen-string-literal: true
 
 require 'json'
+require 'delegate'
 
 module Pushing
   module Adapters
     class LowdownAdapter
-      attr_reader :environment, :topic, :clients
+      attr_reader :clients
 
       def initialize(apn_settings)
-        @environment = apn_settings.environment.to_sym
-        @topic       = apn_settings.topic
-
         # Don't load lowdown earlier as it may load Celluloid (and start it)
         # before daemonizing the workers spun up by a gem (e,g, delayed_job).
         require 'lowdown' unless defined?(Lodwown)
@@ -36,10 +34,10 @@ module Pushing
 
         lowdown_notification.expiration = notification.headers[:'apns-expiration'].to_i if notification.headers[:'apns-expiration']
         lowdown_notification.priority   = notification.headers[:'apns-priority']
-        lowdown_notification.topic      = notification.headers[:'apns-topic'] || topic
+        lowdown_notification.topic      = notification.headers[:'apns-topic']
 
         response = nil
-        clients[notification.environment || environment].group do |group|
+        clients[notification.environment].group do |group|
           group.send_notification(lowdown_notification) do |_response|
             response = _response
           end

data/lib/pushing/base.rb

@@ -102,6 +102,11 @@ module Pushing
         end
       end
 
+      # Push notifications do not support relative path links.
+      def supports_path? # :doc:
+        false
+      end
+
       private
 
       def set_payload_for_notification(payload, notification)
@@ -151,12 +156,12 @@ module Pushing
       return notification if notification && headers.blank?
 
       payload = {}
-      headers.each do |platform, options|
+      ::Pushing::Platforms.config.select {|platform, _| headers[platform] }.each do |platform, config|
         payload_class = ::Pushing::Platforms.lookup(platform)
 
-        if payload_class.should_render?(options)
+        if payload_class.should_render?(headers[platform])
           json = render_json(platform, headers)
-          payload[platform] = payload_class.new(json, options)
+          payload[platform] = payload_class.new(json, headers[platform], config)
         end
       end
 

data/lib/pushing/platforms.rb

@@ -25,19 +25,39 @@ module Pushing
         options.is_a?(Hash) ? options[:device_token].present? : options.present?
       end
 
-      def initialize(payload, options)
+      def initialize(payload, options, config = EMPTY_HASH)
+        @payload     = payload
+        @environment = config[:environment]
+        @headers     = config[:default_headers] || {}
+
+        if config[:topic]
+          ActiveSupport::Deprecation.warn "`config.apn.topic' is deprecated and will be removed in 0.3.0. " \
+                                          "Please use `config.apn.default_headers' instead:\n\n" \
+                                          "  config.apn.default_headers = {\n" \
+                                          "    apns_topic: '#{config[:topic]}'\n" \
+                                          "  }", caller
+
+          @headers['apns-topic'] ||= config[:topic]
+        end
+
         if options.is_a?(String)
           @device_token = options
-        else options.is_a?(Hash)
-          @device_token, @environment, @headers = options.values_at(:device_token, :environment, :headers)
+        elsif options.is_a?(Hash)
+          @device_token = options[:device_token]
+          @environment  = options[:environment] || @environment
+          @headers      = @headers.merge(options[:headers] || EMPTY_HASH)
+        else
+          raise TypeError, "The :apn key only takes a device token as a string or a hash that has `device_token: \"...\"'."
         end
 
-        @payload = payload
-        @headers ||= EMPTY_HASH
+        # raise("APNs environment is required.")  if @environment.nil?
+        # raise("APNs device token is required.") if @device_token.nil?
+
+        @environment = @environment.to_sym
       end
 
       def recipients
-        Array(@device_token)
+        Array("#{@environment}/#{@device_token}")
       end
 
       def headers

data/lib/pushing/railtie.rb

@@ -1,5 +1,6 @@
 require "active_job/railtie"
 require "rails"
+require "abstract_controller/railties/routes_helpers"
 
 module Pushing
   class Railtie < Rails::Railtie # :nodoc:
@@ -16,6 +17,30 @@ module Pushing
       end
     end
 
+    initializer "pushing.set_configs" do |app|
+      paths   = app.config.paths
+      options = ActiveSupport::OrderedOptions.new
+
+      if app.config.force_ssl
+        options.default_url_options ||= {}
+        options.default_url_options[:protocol] ||= "https"
+      end
+
+      options.assets_dir ||= paths["public"].first
+
+      # make sure readers methods get compiled
+      options.asset_host        ||= app.config.asset_host
+      options.relative_url_root ||= app.config.relative_url_root
+
+      ActiveSupport.on_load(:pushing) do
+        include AbstractController::UrlFor
+        extend ::AbstractController::Railties::RoutesHelpers.with(app.routes, false)
+        include app.routes.mounted_helpers
+
+        options.each { |k, v| send("#{k}=", v) }
+      end
+    end
+
     initializer "pushing.compile_config_methods" do
       ActiveSupport.on_load(:pushing) do
         config.compile_methods! if config.respond_to?(:compile_methods!)

data/lib/pushing/version.rb

@@ -1,3 +1,3 @@
 module Pushing
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/pushing.gemspec

@@ -7,14 +7,12 @@ Gem::Specification.new do |spec|
   spec.name          = "pushing"
   spec.version       = Pushing::VERSION
   spec.authors       = ["Yuki Nishijima"]
-  spec.email         = ["mail@yukinishijima.net"]
+  spec.email         = ["yk.nishijima@gmail.com"]
   spec.summary       = %q{Push notification framework that does not hurt. finally.}
   spec.description   = %q{Pushing is like ActionMailer, but for sending push notifications.}
   spec.homepage      = "https://github.com/yuki24/pushing"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "actionpack", ">= 4.2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -138,7 +138,7 @@ dependencies:
         version: '0'
 description: Pushing is like ActionMailer, but for sending push notifications.
 email:
-- mail@yukinishijima.net
+- yk.nishijima@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -153,10 +153,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- certs/apns_auth_key_for_jwt_auth.p8.enc
 - certs/apns_example_production.pem.enc
 - gemfiles/rails_42.gemfile
 - gemfiles/rails_50.gemfile
 - gemfiles/rails_51.gemfile
+- gemfiles/rails_52.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/generators/pushing/USAGE
 - lib/generators/pushing/notifier_generator.rb
@@ -204,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Push notification framework that does not hurt. finally.