motion-takeoff 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a0e9931557bb9df3f1f61e5a519993cf56cdb2c
-  data.tar.gz: a619ba6d8893df56e0637eb121edb620d437e8d0
+  metadata.gz: 892428cb8adf421a5e32d48ec69fc0fe9e577388
+  data.tar.gz: 350b88873a1d02a82c04d2c725d9e52782dfdc52
 SHA512:
-  metadata.gz: 815e386a1ad38f9c3881da40326e0c4080101dd097fb3a0b352f8826f2db5d04277275ffeff44167a826b95ae4954434dffcfa037a5c9f6bcb514ee7a54e9bba
-  data.tar.gz: 75beefd0d6262c971af7ab34520b5433288719807e36855e816d2a39dc927d1ffd4c735b04084f610c672be2d9341d0ed5761510cbd1543573d31886bf3edd68
+  metadata.gz: 0abd181eafbc8aff7ae8420eca855434e66682fce004f886843cbb677fad6070ace6c6e4da9cc84b3adc6e9f16f4b94a4d4be501f5a4301813688111222e1b20
+  data.tar.gz: 1a281344fe8d4b767810d13b2968435c13be18a9ce742aee2816a0caff32a70c3c47f89110c922eb69f90d1711c1fbb4c3bf2a59897f8eb1e857ed25057d00bb

data/README.md

@@ -1,10 +1,12 @@
 # motion-takeoff
 
-A RubyMotion specific iOS gem that helps you do things at launch.
+A RubyMotion specific iOS gem that helps you do things at launch. Currently, there is two one modules in this gem: `Messages` & `Reminders.
 
-Currently, there is only one module in this gem: `Messages`. The `Messages` module will allow you to schedule alerts to users at certain launch counts. More modules are planned for the future.
+The `Messages` module will allow you to schedule alerts to users at certain launch counts.
 
-This gem is in its infancy. Please help me make it better!
+The `Reminders` module is a nice wrapper for `UILocalNotification` to help you set reminders for the user to come back to your app at specified periods of time. It supports all the options of `UILocalNotification` and does some fancy interpretation of dates for you if needed.
+
+More modules are planned for the future. This gem is in its infancy. Please help me make it better!
 
 ## Installation
 
@@ -29,9 +31,59 @@ end
 ```
 This will display an alert to the user on the 1st, 3rd, and 500th launches of the app.
 
+## Usage: Reminder Module
+
+The reminders module is a nice wrapper on `UILocalNotification` and makes it easy to schedule reminders to come back and use your app!
+
+You should always reset all local notifications when your app becomes active:
+
+```ruby
+def applicationDidBecomeActive(application)
+  MotionTakeoff::Reminders.reset
+end
+```
+
+And here's how to set multiple reminders when your app enters the background:
+
+```ruby
+def applicationDidEnterBackground(application)
+  MotionTakeoff::Reminders.schedule(
+    body: "Fires 20 seconds after the user closes your app.",
+    fire_date: 20 #seconds
+  )
+
+  MotionTakeoff::Reminders.schedule(
+    body: "Fires 10 seconds later.",
+    fire_date: Time.now + 30 #Time object in the future
+  )
+end
+```
+
+The `MotionTakeoff::Reminders.schedule` method takes a hash of options that are send to the `UILocalNotification`. `body` and `fire_date` are required and will raise an exception if you try to schedule a notification without those teo options. Here's all the default options:
+
+```ruby
+{
+    action: nil,
+    launch_image: nil,
+    badge_number: 0,
+    has_action: true,
+    repeat: {
+        calendar: nil,
+        interval: 0
+    },
+    time_zone: NSTimeZone.defaultTimeZone,
+    sound: UILocalNotificationDefaultSoundName,
+    user_info: {}
+}
+```
+
+You can read about what each of these does in [Apple's UILocalNotification Documentation](https://developer.apple.com/library/IOs/documentation/iPhone/Reference/UILocalNotification_Class/Reference/Reference.html), but I've tried to pick sane defaults.
+
+If you pass a `NSCalendarUnit` for the `repeat` option, we'll automatically assume you want to use `NSCalendar.currentCalendar` as the repeat calendar. Possible values of `repeat` are as found in the [`NSCalendarUnit` documentation](https://developer.apple.com/library/IOs/documentation/Cocoa/Reference/Cocoa/Reference/Foundation/Classes/NSCalendar_Class/Reference/NSCalendar.html#//apple_ref/doc/c_ref/NSCalendarUnit).
+
 ## Future plans
 
-I'd like it to be able to be a multi-purpose tool for doing things at launch other than just alerting users. Things like asking for ratings in the iTunes store and scheduling other activities likes clearing caches on the 10th load or checking a server every load, etc.
+I'd like it to be able to be a multi-purpose tool for doing things at launch other than just alerting users. Things like asking for ratings in the iTunes store and scheduling other activities likes clearing caches on the 10th load or checking a server every other load, etc.
 
 ## Contributing
 

data/lib/motion-takeoff.rb

@@ -4,9 +4,6 @@ end
 
 require "bubble-wrap/core"
 
-module MotionTakeoff
-end
-
 lib_dir_path = File.dirname(File.expand_path(__FILE__))
 Motion::Project::App.setup do |app|
   app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))

data/lib/project/reminders.rb

@@ -0,0 +1,60 @@
+module MotionTakeoff
+  class Reminders
+
+    def self.schedule (opts)
+      raise "You must specify a :body" unless opts[:body]
+      raise "You must specify a :fire_date" unless opts[:fire_date]
+
+      opts = {
+        action: nil,
+        launch_image: nil,
+        badge_number: 0,
+        has_action: true,
+        repeat: {
+          calendar: nil,
+          interval: 0
+        },
+        time_zone: NSTimeZone.defaultTimeZone,
+        sound: UILocalNotificationDefaultSoundName,
+        user_info: {}
+
+      }.merge(opts)
+
+      # Fix the repeat if they just send the interval.
+      unless opts[:repeat].is_a? Hash
+        opts[:repeat] = {
+          calendar: NSCalendar.currentCalendar,
+          interval: opts[:repeat]
+        }
+      end
+      # Interpret the fire date to an NSDate class it they specified a number of seconds
+      if opts[:fire_date].is_a? Fixnum
+        opts[:fire_date] = NSDate.dateWithTimeIntervalSinceNow(opts[:fire_date])
+      end
+
+      notification = UILocalNotification.new.tap do |notif|
+        notif.alertAction = opts[:action]
+        notif.alertBody = opts[:body]
+        notif.alertLaunchImage = opts[:launch_image]
+        notif.applicationIconBadgeNumber = opts[:badge_number]
+        notif.timeZone = opts[:time_zone]
+        notif.fireDate = opts[:fire_date]
+        notif.hasAction = opts[:has_action]
+        notif.repeatCalendar = opts[:repeat][:calendar]
+        notif.repeatInterval = opts[:repeat][:interval]
+        notif.soundName = opts[:sound]
+        notif.userInfo = opts[:user_info]
+      end
+      UIApplication.sharedApplication.scheduleLocalNotification notification
+    end
+
+    def self.reset
+      UIApplication.sharedApplication.tap do |app|
+        app.applicationIconBadgeNumber = 0
+        app.cancelAllLocalNotifications
+      end
+    end
+
+  end
+end
+

data/lib/project/version.rb

@@ -1,3 +1,3 @@
 module MotionTakeoff
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-takeoff
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mark Rickert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,6 +48,7 @@ files:
 - README.md
 - lib/motion-takeoff.rb
 - lib/project/messages.rb
+- lib/project/reminders.rb
 - lib/project/version.rb
 homepage: https://www.github.com/MohawkApps/motion-takeoff
 licenses:
@@ -73,5 +74,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A RubyMotion specific iOS gem that helps you do things at launch. You can
-  use this gem to display messages at certain launch counts.
+  use this gem to display messages at certain launch counts and remind users to use
+  your app.
 test_files: []