commit	afc2314c424ffc70fdbd24b80ac49ec3bfc0d428	[log] [tgz]
author	Minh Tu Le <minhtule05@gmail.com>	Sat Mar 07 14:42:17 2015 +0800
committer	Minh Tu Le <minhtule05@gmail.com>	Fri Aug 07 16:11:57 2015 +0800
tree	fe834395704b72557e6a0e20a24addca280d0a3d
parent	e92d03713fc8645ae214f8b285a51069cb4531c9 [diff]

tree: fe834395704b72557e6a0e20a24addca280d0a3d

README.md

PredictionIO-Swift-SDK

[ Build Status ] (https://travis-ci.org/minhtule/PredictionIO-Swift-SDK)

The Swift SDK provides a convenient API for your iOS application to record your users' behaviors in the event server and retrieve predictions from PredictionIO engines.

Requirements

iOS 7.0+
Xcode 6.1

Installation

Cocoapods

Only CocoaPods 0.36.0 beta (and rc1) supports Swift and embedded frameworks. So CocoaPods needs to be installed with the following command.

$ gem install cocoapods --pre

Add the following lines to your Podfile.

platform :ios, '8.0'
use_frameworks!

pod 'PredictionIOSDK', :git => 'https://github.com/minhtule/PredictionIO-iOS-SDK.git'

Then run the following command.

$ pod install

Manually

You can just drag two files: PredictionIOSDK.swift and Alamofire.swift into your project.

Note that Alamofire.swift has been slightly modified from the original; however, if you have already integrated the original Alamofire.swift file to your project, you don't need to include Alamofire.swift from this repo again.

Usage

EngineClient

Use EngineClient to query predictions from the PredictionIO Engines.

let engineClient = EngineClient(baseURL: "http://localhost:8000")
let query = [
    "user": 1,
    "num": 2
]
        
engineClient.sendQuery(query) { (request, response, JSON, error) in
    if let data = JSON as? [String: [[String: AnyObject]]] {
        ...
    }
    ...
}

EventClient

Use EventClient to send information to the PredictionIO Event Server.

let eventClient = EventClient(accessKey: accessKey, baseURL: "http://localhost:7070")
let event = Event(
    event: "rate",
    entityType: "user",
    entityID: "1",
    targetEntityType: "item",
    targetEntityID: "9",
    properties: [
        "rating": 5
    ]
)

eventClient.createEvent(event) { (request, response, JSON, error) in
    ...
}

There are other convenient methods to modify user‘s or item’s properties. Please see the API documentation for more details.

Documentation

The latest API documentation is available at http://minhtule.github.io/PredictionIO-Swift-SDK/index.html.

License

PredictionIO Swift SDK is released under the Apache License 2.0. Please see LICENSE for details.