Latest 0.0.3
Homepage https://github.com/macula-projects/m-hot-code-push-ios
License MIT
Platforms ios 7.0, requires ARC
Frameworks Foundation
Authors

M Hot Code Push for iOS

This library provides functionality to perform automatic updates of the web based content in your application. Basically, everything that is stored in www folder of your project can be updated using this library.

When you publish your application on the store – you pack in it all your web content: html files, JavaScript code, images and so on. There are two ways how you can update it:

  1. Publish new version of the app on the store. But it takes time.
  2. Sacrifice the offline feature and load all the pages online. But as soon as Internet connection goes down – application won’t work.

This library is intended to fix all that. When user starts the app for the first time – it copies all the web files onto the external storage. From this moment all pages are loaded from the external folder and not from the packed bundle. On every launch library connects to your server (with optional authentication, see fetchUpdate() below) and checks if the new version of web project is available for download. If so – it loads it on the device and installs on the next launch.

As a result, your application receives updates of the web content as soon as possible, and still can work in offline mode. Also, library allows you to specify dependency between the web release and the native version to make sure, that new release will work on the older versions of the application.

Is it fine with App Store? Yes, it is… as long as your content corresponds to what application is intended for and you don’t ask user to click some button to update the web content. For more details please refer to this wiki page.

Supported platforms

iOS 7.0 or above. Xcode 7 is required.

Installation with CocoaPods

Podfile

To integrate MHotCodePush into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '7.0'

target 'TargetName' do
pod 'MHotCodePush'
end

Then, run the following command:

$ pod install

I recommend you to install M Hot Code Push CLI client. This client will help you to easily generate necessary configuration files;

Of course, you can use this library without the CLI client, but it will make your life easier.

Usage

HCPHelper

HCPHelper manages an all task.

Creating a HCPHelper Instance

HCPHelper *hcpHelper = [HCPHelper sharedInstance];

Setting the www URL

NSURL *webUrl = [NSURL URLWithString:@"http://example.com"];
[hcpHelper setWebUrl:webUrl];

Creating a Fetch Task

[hcpHelper fetchUpdate:^(BOOL needUpdate, NSError *error)
{

}

Creating a Download Task

[hcpHelper downloadUpdate:^(BOOL success, NSInteger totalFiles, NSInteger fileDownloaded, NSError *error)
{

}

Creating a Install Task

[hcpHelper installUpdate:^(BOOL success, NSError *error)
{

}

Get The local www Path

NSURL *wwwUrl = [hcpHelper pathToWww];

Load The www From External Storage Folder Or Not

BOOL isLoadFromExternalStorageFolder = [hcpHelper loadFromExternalStorageFolder];

Documentation

All documentation can be found in details in our Wiki on GitHub.

If you have some questions/problems/suggestions – don’t hesitate to post a thread. If it’s an actual issue – please, follow this guide on how to do that properly.

Latest podspec

{
    "name": "MHotCodePush",
    "version": "0.0.3",
    "summary": "This tool provides functionality to perform automatic updates of the web based content in your application.",
    "homepage": "https://github.com/macula-projects/m-hot-code-push-ios",
    "license": "MIT",
    "authors": {
        "M": "[email protected]"
    },
    "platforms": {
        "ios": "7.0"
    },
    "source": {
        "git": "https://github.com/macula-projects/m-hot-code-push-ios.git",
        "tag": "0.0.3"
    },
    "source_files": [
        "HCP",
        "HCP/**/*.{h,m}"
    ],
    "frameworks": "Foundation",
    "requires_arc": true
}

Pin It on Pinterest

Share This