Retired (iOS)

A simple framework to help recommend/force app updates and sunset old versions

Installation

Carthage

Add the following to your Cartfile:

github "pseudomuto/Retired" ~> 3.0

Cocoapods

Add this to your Podfile:

pod "Retired", "~> 3.0"

Swift Package Manager

Add the dependency in your Package.swift file:

import PackageDescription

let package = Package(
  ...
  ...
  dependencies: [
    .Package(url: "https://github.com/pseudomuto/Retired.git", majorVersion: 3)
  ],
  ...
  ...
)

Usage

The Versions File

You'll need to host a JSON file on a server somewhere that defines options like whether or not an update is required, recommended or not necessary.

The file also defines the messaging to be displayed in each case. For example, if the user has version 1.0 installed (and the file below is used), when the you call Retire.check the supplied message in the completion block will be the forced one.

If they're running 1.1, you'd get the recommended message, and if they're running 2.0 no update would be required.

Here's an example of a versions file:

{
  "messaging": {
    "forced": {
      "title": "App Update Required",
      "message": "A new version of the app is available. You need to update now",
      "continueButtonText": "Let's do this"
    },
    "recommended": {
      "title": "App Update Available",
      "message": "A new version is available. Want it?",
      "continueButtonText": "I want it",
      "cancelButtonText": "No thanks"
    }
  },
  "versions": [
    { "version": "1.0", "policy": "force" },
    { "version": "1.1", "policy": "recommend" },
    { "version": "2.0", "policy": "none" }
  ]
}

There are two types of objects here; message and version.

message

• title - The title of the alert (e.g. New Version Available)
• message - The message to be displayed (e.g. There's a new version available)
• continueButtonText - The label for the button that links to the app store
• cancelButtonText - The (optional) label for the cancel button (intended for recommended updates only)

version

• version - The version of the app (pulled from CFBundleShortVersionString)
• policy - One of force, recommend or none

Checking Status in Your App

I don't wanna tell you how to handle displaying alerts or anything, but here's what I did in the example app (if you open the workspace you'll see it in AppDelegate.swift).

First, I made an extension on Message

extension Message {
  func presentInController(controller: UIViewController?) {
    let alert = UIAlertController(title: title, message: message, preferredStyle: .Alert)
    alert.addAction(UIAlertAction(title: continueButtonText, style: .Default, handler: goToAppStore))

    if cancelButtonText != nil {
      alert.addAction(UIAlertAction(title: cancelButtonText, style: .Cancel, handler: nil))
    }

    controller?.presentViewController(alert, animated: true, completion: nil)
  }

  private func goToAppStore(action: UIAlertAction) {
    UIApplication.sharedApplication().openURL(iTunesURL)
  }
}

Then, in applicationDidFinishLaunching:withOptions, I configured Retired with the URL to the versions file:

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
  let versionURL              = NSURL(string: "https://example.com/versions.json")!
  let intervalBetweenRequests = 60 * 60 * 24 // one day between recommended app updates

  Retired.configure(versionURL, suppressionInterval: intervalBetweenRequests)
  return true
}

Finally, in applicationDidBecomeActive, I query the status and show a message if necessary:

func applicationDidBecomeActive(application: UIApplication) {
  // you should catch the error in production apps
  try! Retired.check() { updateRequired, message, error in
    guard updateRequired else { return }

    // handle error (non 200 status or network issue)

    if let message = message {
      message.presentInController(application.keyWindow?.rootViewController)
    }
  }
}

LICENSE

Copyright (c) 2016 pseudomuto [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.