Setup iOS Development Environment

THIS DOCUMENTATION IS OUTDATED AND IS CURRENTLY BEING UPDATED.

Requirements

1. Apple OSX development environment.
2. Download XCode 4.6.
3. Download PhoneGap 2.50.
4. Download & run uMobile 1.1RC1 quickstart.
5. Download & install node.
   
   1. Node is used to automate the build process for our JavaScript, HTML and CSS assets.
   2. Node is installed locally and is leveraged for convenience.
   3. Node v0.8.12 is recommended for this documentation.

Getting Started with iOS

The PhoneGap website has an excellent iOS start up guide. It is recommended but not mandatory that you walk through their startup guide before continuing to familiarize yourself with the overall process.

Creating the Project

A completed example of an XCode project configured to run the uMobile PhoneGap implementation is available on github.

1. Open XCode. Choose File > New > Project.
2. Select Cordova-based Application from the list of templates.
    
3. Enter the following options on the next screen.
   
   
4. Choose a location for your project.
    
5. Disable Automatic Reference Counting in the build.
   
   1. Select uMobile under Targets in the main project view.
   2. Click on the Build Settings tab.
   3. Make sure the All and Combined filters are selected.
   4. Search for reference in the search bar.
   5. Set the Objective-C Automatic Reference Counting property to No.
       

6. Check the uMobile source out into a new project directory.
    

   git clone git@github.com:Jasig/umobile-app-phonegap  umobile-ui

   

7. Navigate to umobile-ui/config/js.
   
   1. uMobile currently supports three different authentication strategies: CAS, Local & Mock.
   2. Each strategy has a cooresponding configuration file under the umobile-ui/config/js directory (i.e., cas.js, local.js and mock.js).
   3. Choose one of the three authentication strategies. For this documentation, we will use cas.js.
   4. Open cas.js.
      
      1. Set config.uMobileServerUrl to http://localhost:8080.
         
      2. Set config.loginFn to casLogin.
      3. Note: There are bugs with the current login functionality. Only view the portal using the guest layout. This is being addressed.

8. Run the build process for the uMobile source code. The build process configures the uMobile source code with the necessary dependencies needed to run in a given environment. Currently, the uMobile project supports Android, iOS and Web platforms. Once the build completes a www directory will be added to the umobile-ui directory. The www directory houses the production ready code base to be used with the PhoneGap wrapper. Please see the documentation on the uMobile HTML5 build for more information on configuring the build script.
   

   cd umobile-ui sudo npm install
   grunt --environment=ios --config=cas --build=prod

    

9. Drag the production-ready www directory from your finder window to the XCode uMobile project. When done for the first time, XCode will ask you to create a workspace before including the www directory. For the purpose of this project, we created a umobile workspace.
     
10. Choose options for adding the www directory to the project.
     
11. Configure cordova.plist.
    
    1. In XCode, under the Project Navigator, navigate to uMobile > Supporting Files > Cordova.plist.
    2. Under the Root Key:
       
       1. Set OpenAllWhitelistURLsInWebView to Yes.
    3. Under the ExternalHosts Key:
       
       1. Add the hostname, any authentication servers and any other servers hosting uMobile resources.
       2. If you're working with the uMobile quickstart, you can just add localhost.
    4. Under the Plugin Key:
       
       1. Plugin: SesssionTracking
       2. Type: String
       3. Value: SessionTracking
    
    
    
12. Add SessionTracking Plugin files into the Plugins folder:
    
    1. SessionTracking.h
    2. SessionTracking.m
    
    
    
13. Download MainViewController.m
14. Navigate to uMobile > Classes > MainViewController.m.
15. Replace MainViewController with the downloaded version.
16. Set the scheme at the top of the project to iPhone 6.1 Simulator and run the project!
    
    

Debugging

uMobile logs helpful events and errors. You can access the log by viewing the console output.