houston 2.2.4 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62b98bdcafd6d8dc99ba994deb3ff5b5963bcb12
-  data.tar.gz: 58e6036255edb8a4e6403c3b8e63eea765e587e3
+  metadata.gz: cfbcea0735347e252416d11e2ae57e506ba71ffd
+  data.tar.gz: 7e9b26d48fd1ad27fe068ec0f3a7cfe2c2f307d9
 SHA512:
-  metadata.gz: 82355e5daa760f2fc1d8998d9f5aad92842fd65db661e9fc1f58c6ca32a8da3b492ee303f6a98e0aab487e383ebf31ded16ad65689d4dbad0c228167937c1c76
-  data.tar.gz: 7592018c066df70f1bd37b65d7fd387fd921975e7a4ec6893e94d6e57d8692cc01386f14c1ace277db5d9251ca3f910daaebf0f50dbb05f72dca1fd17ea8f0ba
+  metadata.gz: f6104dd4c1221816bc7e8f779c508c0fed230210d8c5b387d804e9d1120d83b88785ccfa398410190be4eb34ffa28ead665f9c836f76cb6224661c64924fb529
+  data.tar.gz: 301d4d835c5de3497aa5ed4330f3bb4207e0a0f54849a7747f6bd6927c414b1cff15700df430f7b3a91a7a68ad63720ffb49dd14f7beba22c23df7ff9c153176

data/Gemfile.lock

@@ -1,38 +1,38 @@
 PATH
   remote: .
   specs:
-    houston (2.2.4)
-      commander (~> 4.4)
+    houston (2.2.3)
+      commander (~> 4.1)
       json
 
 GEM
   remote: https://rubygems.org/
   specs:
-    commander (4.4.3)
-      highline (~> 1.7.2)
+    commander (4.2.0)
+      highline (~> 1.6.11)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    highline (1.7.8)
-    json (2.0.2)
-    rake (12.0.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    highline (1.6.21)
+    json (1.8.1)
+    multi_json (1.10.1)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    simplecov (0.12.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    simplecov (0.9.0)
       docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
 
 PLATFORMS
   ruby
@@ -40,8 +40,5 @@ PLATFORMS
 DEPENDENCIES
   houston!
   rake
-  rspec (~> 3.5)
+  rspec (~> 3.0)
   simplecov
-
-BUNDLED WITH
-   1.13.7

data/README.md

@@ -26,22 +26,24 @@ require 'houston'
 # Environment variables are automatically read, or can be overridden by any specified options. You can also
 # conveniently use `Houston::Client.development` or `Houston::Client.production`.
 APN = Houston::Client.development
-APN.certificate = File.read("/path/to/apple_push_notification.pem")
+APN.certificate = File.read('/path/to/apple_push_notification.pem')
 
 # An example of the token sent back when a device registers for notifications
-token = "<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>"
+token = '<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969>'
 
 # Create a notification that alerts a message to the user, plays a sound, and sets the badge on the app
 notification = Houston::Notification.new(device: token)
-notification.alert = "Hello, World!"
+notification.alert = 'Hello, World!'
 
 # Notifications can also change the badge count, have a custom sound, have a category identifier, indicate available Newsstand content, or pass along arbitrary data.
 notification.badge = 57
-notification.sound = "sosumi.aiff"
-notification.category = "INVITE_CATEGORY"
+notification.sound = 'sosumi.aiff'
+notification.category = 'INVITE_CATEGORY'
 notification.content_available = true
 notification.mutable_content = true
-notification.custom_data = { foo: "bar" }
+notification.custom_data = { foo: 'bar' }
+notification.url_args = %w[boarding A998]
+notification.thread_id = 'notify-team-ios'
 
 # And... sent! That's all it takes.
 APN.push(notification)
@@ -72,10 +74,10 @@ puts "Error: #{notification.error}." if notification.error
 
 ### Silent Notifications
 
-To send a silent push notification, set `sound` to an empty string (`""`):
+To send a silent push notification, set `sound` to an empty string (`''`):
 
 ```ruby
-Houston::Notification.new(sound: "", content_available: true)
+Houston::Notification.new(sound: '', content_available: true)
 ```
 
 ### Mutable Notifications
@@ -91,13 +93,13 @@ Houston::Notification.new(mutable_content: true)
 If you want to manage your own persistent connection to Apple push services, such as for background workers, here's how to do it:
 
 ```ruby
-certificate = File.read("/path/to/apple_push_notification.pem")
-passphrase = "..."
+certificate = File.read('/path/to/apple_push_notification.pem')
+passphrase = '...'
 connection = Houston::Connection.new(Houston::APPLE_DEVELOPMENT_GATEWAY_URI, certificate, passphrase)
 connection.open
 
 notification = Houston::Notification.new(device: token)
-notification.alert = "Hello, World!"
+notification.alert = 'Hello, World!'
 connection.write(notification.message)
 
 connection.close
@@ -118,9 +120,9 @@ In `lib/tasks/notifications.rake`:
 ```ruby
 namespace :notifications do
   task device_token_feedback: [:environment] do
-    APN.devices.each do |device_hash|
+    APN.unregistered_devices.each do |device_hash|
       # Format: { token: token, timestamp: timestamp }
-      device = Device.find_by(token: device_hash['token'])
+      device = Device.find_by(token: device_hash[:token])
       next unless device.present?
       # Remove device token
       device.update_attribute(:device_token, nil)
@@ -141,9 +143,11 @@ Houston also comes with the `apn` binary, which provides a convenient way to tes
 
 ## Enabling Push Notifications on iOS
 
-### AppDelegate.m
+### Objective-C
 
 ```objective-c
+// AppDelegate.m
+
 - (void)applicationDidFinishLaunching:(UIApplication *)application {
   // ...
 
@@ -165,6 +169,24 @@ didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
 }
 ```
 
+### Swift 
+```swift
+// AppDelegate.swift
+
+func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool {
+    application.registerForRemoteNotifications()
+    return true
+}
+
+func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
+    // Register the device token with a webservice
+}
+
+func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
+    print("error \(error)")
+}
+```
+
 ## Converting Your Certificate
 
 > These instructions come from the [APN on Rails](https://github.com/PRX/apn_on_rails) project, which is another great option for sending push notifications.

data/bin/apn

@@ -43,7 +43,7 @@ command :push do |c|
     say_error "Missing certificate file option (-c /path/to/certificate.pem)" and abort unless @certificate
     say_error "Could not find certificate file '#{@certificate}'" and abort unless File.exists?(@certificate)
 
-    @passphrase = options.passphrase ? password : ""
+    @passphrase = options.passphrase ? password : nil
 
     @alert = options.alert
     @badge = options.badge.nil? ? nil : options.badge.to_i
@@ -138,7 +138,7 @@ command :feedback do |c|
     say_error "Missing certificate file option (-c /path/to/certificate.pem)" and abort unless @certificate
     say_error "Could not find certificate file '#{@certificate}'" and abort unless File.exists?(@certificate)
 
-    @passphrase = options.passphrase ? password : ""
+    @passphrase = options.passphrase ? password : nil
 
     client = (@environment == :production) ? Houston::Client.production : Houston::Client.development
     client.certificate = File.read(@certificate)