ProMotion-push 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd3c0fd84cbfe3e827eb20dc749f568c0ef7c6e5
+  data.tar.gz: 8cf014919a0aecc37e36d70014c5d6f06a09046c
+SHA512:
+  metadata.gz: d4250274648da983f843f6e84293aaa080b700db71ba8eb59705326d9d6aef1f879498ab0eab0b5d45a3655b8126f03ca65a6d6d2dad0a3ea05996ab9beea0bf
+  data.tar.gz: 761a0da895bdecd0489e7b957db4a0e39a1be4f359f1120f8063463431633cb5de064a737c94ccb66333acf1a265cacd67c51131d2e4145e63f4642851155bc8

data/README.md

@@ -0,0 +1,204 @@
+# ProMotion-push
+
+ProMotion-push is push notification support, extracted from the 
+popular RubyMotion gem [ProMotion](https://github.com/clearsightstudio/ProMotion).
+
+## Installation
+
+```ruby
+gem 'ProMotion-push'
+```
+
+## Usage
+
+### AppDelegate
+
+ProMotion-push adds a few methods to PM::Delegate.
+
+```ruby
+# app/app_delegate.rb
+class AppDelegate < PM::Delegate
+
+  def on_load(app, options)
+    register_for_push_notifications :badge, :sound, :alert, :newsstand
+    PM.logger.info registered_push_notifications
+    # ...
+  end
+
+  def on_unload
+    unregister_for_push_notifications
+  end
+
+  def on_push_registration(token, error)
+    PM.logger.info token.description
+  end
+
+  def on_push_notification(notification, launched)
+    PM.logger.info notification.to_json
+  end
+end
+```
+
+#### register_for_push_notifications(*types)
+
+Method you can call to register your app for push notifications. You'll also want to implement
+`on_push_notification` and `on_push_registration`.
+
+```ruby
+def on_load(app, options)
+    register_for_push_notifications :badge, :sound, :alert, :newsstand # or :all
+    # ...
+end
+```
+
+#### unregister_for_push_notifications
+
+Unregisters from all push notifications.
+
+```ruby
+def logging_out
+  unregister_for_push_notifications
+end
+```
+
+**NOTE:** From a screen you'll have to reference the app_delegate:
+
+```ruby
+def log_out
+  app_delegate.unregister_for_push_notifications
+end
+```
+
+#### on_push_registration(token, error)
+
+Method that is called after you attempt to register for notifications. Either `token` or `error`
+will be provided.
+
+```ruby
+def on_push_registration(token, error)
+  if token
+    # Push token to your server
+  else
+    # Display the error
+  end
+end
+```
+
+#### on_push_notification(notification, launched)
+
+Method called when the app is launched via a notification or a notification is received
+in-app. `notification` is a
+[PM::PushNotification](https://github.com/clearsightstudio/ProMotion/wiki/API-Reference:-ProMotion::PushNotification)
+object which is a thin wrapper around the notification hash provided by iOS. `launched`
+is a boolean letting you know whether the notification initiated your app's launch (true) or
+if your app was already running (false).
+
+```ruby
+def on_push_notification(notification, launched)
+  notification.to_json  # => '{"aps":{"alert":"My test notification","badge":3,"sound":"default"}, "custom": "Jamon Holmgren"}'
+  notification.alert    # => "My test notification"
+  notification.badge    # => 3
+  notification.sound    # => "default"
+  notification.custom   # => "Jamon Holmgren"
+end
+```
+
+#### registered_push_notifications
+
+Returns the currently registered notifications as an array of symbols.
+
+```ruby
+def some_method
+  registered_push_notifications # => [ :badge, :sound, :alert, :newsstand ]
+end
+```
+
+
+### ProMotion::PushNotification
+
+You receive this object in your AppDelegate's `on_push_notification` method.
+
+```ruby
+def on_push_notification(notification, launched)
+  notification.to_json  # => '{"aps":{"alert":"My test notification","badge":3,"sound":"default"}, "custom": "Jamon Holmgren"}'
+  notification.alert    # => "My test notification"
+  notification.badge    # => 3
+  notification.sound    # => "default"
+  notification.custom   # => "Jamon Holmgren"
+end
+```
+
+The best way to test push notifications is on a device, but it's often useful to test 
+them in the simulator. We provide a way to do that from the REPL or in code.
+
+```ruby
+# In REPL
+PM::PushNotification.simulate(alert: "My test", badge: 4, sound: "default", custom: "custom", launched: true)
+```
+```ruby
+def on_push_notification(notification, launched)
+  notification.aps # => { alert: "My test", badge: sound: "default"}
+  notification.alert # => "My test"
+  notification.custom # => 'custom'
+end
+```
+
+#### alert
+
+Returns the alert string for the push notification object.
+
+```ruby
+notification.alert    # => "My test notification"
+```
+
+#### badge
+
+Returns the badge number for the push notification object, if it exists.
+
+```ruby
+notification.badge    # => 3
+```
+
+#### sound
+
+Returns a string representing the sound for the push notification object, if it exists.
+
+```ruby
+notification.sound    # => "sound"
+```
+
+#### to_json
+
+Returns a json string representation of the push notification object.
+
+```ruby
+notification.to_json  # => '{"aps":{"alert":"My test notification","sound":"default"},"custom":"something custom"}'
+```
+
+#### (custom methods)
+
+A `method_missing` implementation will respond to all methods that are keys in the notification hash. It
+will raise a NoMethodError if there isn't a corresponding key.
+
+```ruby
+# Given: '{"aps":{"alert":"My test notification","sound":"default"}, "my_custom_key": "My custom data"}'
+notification.my_custom_key # => "My custom data"
+notification.no_key_here # => NoMethodError
+```
+
+#### notification
+
+Returns the raw notification object provided by iOS.
+
+```ruby
+notification.notification # => Hash
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make some specs pass
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/lib/ProMotion-push.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "ProMotion-push must be required within a RubyMotion project."
+end
+
+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.files << File.join(lib_dir_path, "ProMotion/delegate_module.rb")
+end

data/lib/ProMotion/delegate_module.rb

@@ -0,0 +1,10 @@
+# Re-open ProMotion's DelegateModule and Delegate to include our module
+module ProMotion
+  module DelegateModule
+    include ProMotion::DelegateNotifications
+  end
+
+  class Delegate < ProMotion::DelegateParent
+    include ProMotion::DelegateNotifications
+  end
+end

data/lib/ProMotion/delegate_notifications.rb

@@ -0,0 +1,71 @@
+module ProMotion
+  # @requires class:PushNotification
+  module DelegateNotifications
+
+    attr_accessor :aps_notification
+
+    def check_for_push_notification(options)
+      if options && options[UIApplicationLaunchOptionsRemoteNotificationKey]
+        received_push_notification options[UIApplicationLaunchOptionsRemoteNotificationKey], true
+      end
+    end
+
+    def register_for_push_notifications(*notification_types)
+      notification_types = Array.new(notification_types)
+      notification_types = [ :badge, :sound, :alert, :newsstand ] if notification_types.include?(:all)
+
+      types = UIRemoteNotificationTypeNone
+      notification_types.each { |t| types = types | map_notification_symbol(t) }
+
+      UIApplication.sharedApplication.registerForRemoteNotificationTypes types
+    end
+
+    def unregister_for_push_notifications
+      UIApplication.sharedApplication.unregisterForRemoteNotifications
+    end
+
+    def registered_push_notifications
+      mask = UIApplication.sharedApplication.enabledRemoteNotificationTypes
+      types = []
+
+      types << :badge     if mask & UIRemoteNotificationTypeBadge > 0
+      types << :sound     if mask & UIRemoteNotificationTypeSound > 0
+      types << :alert     if mask & UIRemoteNotificationTypeAlert > 0
+      types << :newsstand if mask & UIRemoteNotificationTypeNewsstandContentAvailability > 0
+
+      types
+    end
+
+    def received_push_notification(notification, was_launched)
+      @aps_notification = ProMotion::PushNotification.new(notification)
+      on_push_notification(@aps_notification, was_launched) if respond_to?(:on_push_notification)
+    end
+
+    # CocoaTouch
+
+    def application(application, didRegisterForRemoteNotificationsWithDeviceToken:device_token)
+      on_push_registration(device_token, nil) if respond_to?(:on_push_registration)
+    end
+
+    def application(application, didFailToRegisterForRemoteNotificationsWithError:error)
+      on_push_registration(nil, error) if respond_to?(:on_push_registration)
+    end
+
+    def application(application, didReceiveRemoteNotification:notification)
+      received_push_notification(notification, application.applicationState != UIApplicationStateActive)
+    end
+
+    protected
+
+    def map_notification_symbol(symbol)
+      {
+        none:       UIRemoteNotificationTypeNone,
+        badge:      UIRemoteNotificationTypeBadge,
+        sound:      UIRemoteNotificationTypeSound,
+        alert:      UIRemoteNotificationTypeAlert,
+        newsstand:  UIRemoteNotificationTypeNewsstandContentAvailability
+      }[symbol] || UIRemoteNotificationTypeNone
+    end
+
+  end
+end

data/lib/ProMotion/push_notification.rb

@@ -0,0 +1,58 @@
+module ProMotion
+  class PushNotification
+
+    attr_accessor :notification
+
+    def initialize(n)
+      self.notification = n
+    end
+
+    def to_s
+      self.notification.inspect
+    end
+
+    def to_json
+      ProMotion.logger.warn "ProMotion::PushNotification.to_json not implemented yet."
+    end
+
+    def aps
+      self.notification["aps"]
+    end
+
+    def alert
+      aps["alert"] if aps
+    end
+
+    def badge
+      aps["badge"] if aps
+    end
+
+    def sound
+      aps["sound"] if aps
+    end
+
+    def method_missing(meth, *args, &block)
+      aps[meth.to_s] || aps[meth.to_sym] || self.notification[meth.to_s] || self.notification[meth.to_sym] || super
+    end
+
+    # For testing from the REPL
+    # > ProMotion::PushNotification.simulate alert: "My test message", badge: 4
+    def self.simulate(args = {})
+      UIApplication.sharedApplication.delegate.on_push_notification self.fake_notification(args), args[:launched]
+    end
+
+    def self.fake_notification(args = {})
+      self.new({
+        "aps" => {
+          "alert" => args.delete(:alert) || "Test Push Notification",
+          "badge" => args.delete(:badge) || 2,
+          "sound" => args.delete(:sound) || "default"
+        },
+        "channels" => args.delete(:channels) || [
+          "channel_name"
+        ]
+      }.merge(args))
+    end
+
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ProMotion-push
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jamon Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ProMotion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: motion-stump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: motion-redgreen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds push notification support to ProMotion.
+email:
+- jamon@clearsightstudio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ProMotion-push.rb
+- lib/ProMotion/delegate_module.rb
+- lib/ProMotion/delegate_notifications.rb
+- lib/ProMotion/push_notification.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds push notification support to ProMotion. Extracted from ProMotion.
+test_files: []