ProMotion-push 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddf74b4ca93f8c62d6e52e0b075302b83da7b98b
-  data.tar.gz: 888f61229b99e186a060846a411e5b638dc65023
+  metadata.gz: 5ff3b591979913a0c05081d23ea7e5b98fa35e15
+  data.tar.gz: 7f585fc3277e542157e61bd299153fff52232bf1
 SHA512:
-  metadata.gz: a724ff35734feec0d4fd661d22a0d78864fabd58d104db644ef24a452b378e0215d5a8afe7631cab188a37185dba6b1bff7075ee38be7d55e16ef2d2fd1ef021
-  data.tar.gz: 85f5b8f4424efe80f2ee2356f87f929e441c5a7d59cf584d1206265f4dcfad43ca72724d476186bfa15eb4a573be3bcb7f7e9e2c5a7489eadbf98de8a7405020
+  metadata.gz: 4fdd9d1f049db7b0259cabc1ec1d4df219b4bf4d5cfa0f23481ecc7a47acd256f717671f237ffc533cc9486b21197f88192dbdbc98c4c1798548d8435efe245c
+  data.tar.gz: 786ebf2514cf8fd1900c7831cda37d4d774893a1d3d3bbfdf074bfbdeac279a72c44c8736c856418b2b40005008ea5e45300825caf8fa1fc9842eb9dd515c060

data/README.md

@@ -1,7 +1,7 @@
 # ProMotion-push
 
 ProMotion-push is push notification support, extracted from the
-popular RubyMotion gem [ProMotion](https://github.com/clearsightstudio/ProMotion).
+popular RubyMotion gem [ProMotion](https://github.com/clearsightstudio/ProMotion) and is maintained by [Infinite Red](http://infinite.red), a web and mobile development company based in Portland, OR and San Francisco, CA.
 
 ## Installation
 
@@ -104,6 +104,28 @@ def on_push_notification(notification, launched)
 end
 ```
 
+ProMotion-push automatically adds support for handling push notifications while your app is in the background. If your push notification payload includes `content-available: 1` then you may have an opportunity to pre-fetch data. The return value of the `on_push_notification` method should one of the following that best matches the result: `:new_data`, `:no_data`, `:failed`. The default is `:no_data`, so you don't need to return anything if you did not fetch any data. For example:
+
+```ruby
+# Payload:
+# {
+#   "aps": {
+#     "content-available": 1,
+#     "alert": "My test notification",
+#     "badge": 3,
+#     "sound": "default"
+#   },
+#   "type": "new_messages"
+# }
+
+def on_push_notification(notification, launched)
+  if notification.type == "new_messages"
+    MessagesScreen.load_data
+    return :new_data
+  end
+end
+```
+
 #### registered_push_notifications
 
 Returns the currently registered notifications as an array of symbols.
@@ -114,6 +136,54 @@ def some_method
 end
 ```
 
+### Actionable Notifications
+As of IOS 8, notifications can include action buttons in the lock screen, notification banners and notification center. This is called the "Minimal" context and supports 2 actions. The "Default" context supports up to 4 Actions and applies when alerts are opened as popups.
+
+To use these features with ProMotion-push you need to:
+
+Define each action you plan to include in a notification for either context.
+```ruby
+    approve_action = UIMutableUserNotificationAction.new.tap do | action |
+      action.identifier = "APPROVE_ACTION"
+      action.title = "Approve"
+      action.activationMode = UIUserNotificationActivationModeBackground
+      action.authenticationRequired = false
+    end
+```
+
+Register your actions by calling `register_push_notification_category` from your AppDelegate code prior to `register_for_push_notifications`, for each category of action you intend to use. Note that you must include a separate array for the actions to show in the minimal context.
+```ruby
+def on_load(app, options)
+    register_push_notification_category 'APPROVAL_ACTIONS', [approve_action, deny_action, self_destruct_action], minimal: [approve_action]
+    register_push_notification_category 'SECOND_CATEGORY_NAME', # ...
+    # ... 
+    register_for_push_notifications :badge, :sound, :alert, :newsstand # or :all
+    # ...
+end
+```
+
+Include one of the categories you just defined in your push payload
+```json
+{
+    "aps" :  {
+        "alert" : "Do you approve?",
+        "category" : "APPROVAL_ACTIONS"
+    }
+}
+```
+
+Implement `on_push_notification_action` in your AppDelegate to handle the selected action
+```ruby
+def on_push_notification_action(action, notification)
+  # handle the action
+  case action
+  when 'APPROVE_ACTION'
+    # approve
+  when 'DENY_ACTION'
+    # deny
+  end
+end
+```
 
 ### ProMotion::PushNotification
 

data/lib/ProMotion-push.rb

@@ -8,4 +8,6 @@ Motion::Project::App.setup do |app|
   lib_dir_path = File.dirname(File.expand_path(__FILE__))
   app.files << File.join(lib_dir_path, "ProMotion/push_notification.rb")
   app.files << File.join(lib_dir_path, "ProMotion/delegate_notifications.rb")
+  app.info_plist['UIBackgroundModes'] ||= []
+  app.info_plist['UIBackgroundModes'] << "remote-notification"
 end

data/lib/ProMotion/delegate_notifications.rb

@@ -81,18 +81,23 @@ module ProMotion
 
     # CocoaTouch
 
-    def application(application, didRegisterForRemoteNotificationsWithDeviceToken:device_token)
+    def application(application, didRegisterForRemoteNotificationsWithDeviceToken: device_token)
       on_push_registration(device_token, nil) if respond_to?(:on_push_registration)
     end
 
-    def application(application, didFailToRegisterForRemoteNotificationsWithError:error)
+    def application(application, didFailToRegisterForRemoteNotificationsWithError: error)
       on_push_registration(nil, error) if respond_to?(:on_push_registration)
     end
 
-    def application(application, didReceiveRemoteNotification:notification)
+    def application(application, didReceiveRemoteNotification: notification)
       received_push_notification(notification, application.applicationState != UIApplicationStateActive)
     end
 
+    def application(application, didReceiveRemoteNotification: notification, fetchCompletionHandler: callback)
+      result = received_push_notification(notification, application.applicationState != UIApplicationStateActive)
+      callback.call(background_fetch_result(result))
+    end
+
     def application(application, handleActionWithIdentifier: action_identifier, forRemoteNotification: notification, completionHandler: callback)
       received_push_notification_with_action(notification, action_identifier)
       callback.call
@@ -110,5 +115,18 @@ module ProMotion
       }[symbol] || UIRemoteNotificationTypeNone
     end
 
+    def background_fetch_result(result)
+      options = {
+        new_data: UIBackgroundFetchResultNewData,
+        no_data: UIBackgroundFetchResultNoData,
+        failed: UIBackgroundFetchResultFailed
+      }
+      return options[result] if options[result]
+
+      return result if options.values.include?(result)
+
+      UIBackgroundFetchResultNoData
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-push
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jamon Holmgren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ProMotion
@@ -68,7 +68,7 @@ dependencies:
         version: '0'
 description: Adds push notification support to ProMotion.
 email:
-- jamon@clearsightstudio.com
+- jamon@infinite.red
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -77,7 +77,7 @@ files:
 - lib/ProMotion-push.rb
 - lib/ProMotion/delegate_notifications.rb
 - lib/ProMotion/push_notification.rb
-homepage: https://github.com/clearsightstudio/ProMotion-push
+homepage: https://github.com/infinitered/ProMotion-push
 licenses:
 - MIT
 metadata: {}
@@ -97,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Adds push notification support to ProMotion. Extracted from ProMotion.
+summary: Adds push notification support to ProMotion.
 test_files: []