View on GitHub
Install in DashEnumerations
86 |The following enumerations are available globally.
87 | 88 |
23 |
29 |
24 | PredictionIO Reference
25 | 
26 | Enumerations Reference
27 |
30 |
82 |
83 |
84 |
85 |
89 |
90 |
122 |
123 |
124 |
128 |
129 |
130 |
131 |
132 |
133 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/Enums.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | Enumerations Reference
27 |
30 |
82 |
83 |
84 |
85 |
89 |
90 |
122 |
123 |
124 |
128 |
129 |
130 |
131 |
132 |
133 |
--------------------------------------------------------------------------------
/docs/Structs/CreateEventResponse.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Enumerations
86 |The following enumerations are available globally.
87 | 88 |
View on GitHub
Install in Dash
23 |
29 |
24 | PredictionIO Reference
25 | 
26 | CreateEventResponse Structure Reference
27 |
30 |
82 |
83 |
84 |
85 |
95 |
96 |
128 |
129 |
133 |
134 |
135 |
136 |
137 |
138 |
--------------------------------------------------------------------------------
/docs/Structs/EventResponse.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CreateEventResponse
86 |
87 |
92 |
88 |
91 | public struct CreateEventResponse : DecodableRepresents the response of a creating event request.
93 | 94 |
97 |
127 | -
98 |
-
99 | 100 |106 |
101 | 102 | 103 | eventID 104 |105 |107 | 108 |124 |109 | 110 | 123 |111 |114 |The event ID of the created event.
112 | 113 |115 |122 |Declaration
116 |117 |121 |Swift
118 |
119 | 120 |public let eventID: String
125 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | EventResponse Structure Reference
27 |
30 |
85 |
86 |
87 |
88 |
98 |
99 |
131 |
132 |
136 |
137 |
138 |
139 |
140 |
141 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/Structs/CreateEventResponse.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | EventResponse
89 |
90 |
95 |
91 |
94 | public struct EventResponse: DecodableResponse structure for an event-creation request.
96 | 97 |
100 |
130 | -
101 |
-
102 | 103 |109 |
104 | 105 | 106 | eventID 107 |108 |110 | 111 |127 |112 | 113 | 126 |114 |117 |Undocumented
115 | 116 |118 |125 |Declaration
119 |120 |124 |Swift
121 |
122 | 123 |public let eventID: String
128 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | CreateEventResponse Structure Reference
27 |
30 |
82 |
83 |
84 |
85 |
95 |
96 |
128 |
129 |
133 |
134 |
135 |
136 |
137 |
138 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/Structs/EventResponse.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CreateEventResponse
86 |
87 |
92 |
88 |
91 | public struct CreateEventResponse : DecodableRepresents the response of a creating event request.
93 | 94 |
97 |
127 | -
98 |
-
99 | 100 |106 |
101 | 102 | 103 | eventID 104 |105 |107 | 108 |124 |109 | 110 | 123 |111 |114 |The event ID of the created event.
112 | 113 |115 |122 |Declaration
116 |117 |121 |Swift
118 |
119 | 120 |public let eventID: String
125 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | EventResponse Structure Reference
27 |
30 |
85 |
86 |
87 |
88 |
98 |
99 |
131 |
132 |
136 |
137 |
138 |
139 |
140 |
141 |
--------------------------------------------------------------------------------
/docs/Enums/PIOError/SerializationFailureReason.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | EventResponse
89 |
90 |
95 |
91 |
94 | public struct EventResponse: DecodableResponse structure for an event-creation request.
96 | 97 |
100 |
130 | -
101 |
-
102 | 103 |109 |
104 | 105 | 106 | eventID 107 |108 |110 | 111 |127 |112 | 113 | 126 |114 |117 |Undocumented
115 | 116 |118 |125 |Declaration
119 |120 |124 |Swift
121 |
122 | 123 |public let eventID: String
128 |
View on GitHub
Install in Dash
23 |
29 |
24 | PredictionIO Reference
25 | 
26 | SerializationFailureReason Enumeration Reference
27 |
30 |
82 |
83 |
84 |
85 |
95 |
96 |
128 |
129 |
133 |
134 |
135 |
136 |
137 |
138 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/Enums/PIOError/SerializationFailureReason.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | SerializationFailureReason
86 |
87 |
92 |
88 |
91 | public enum SerializationFailureReasonThe underlying reason the serialization fails.
93 | 94 |
97 |
127 | -
98 |
-
99 | 100 |106 |
101 | 102 | 103 | failed(error:) 104 |105 |107 | 108 |124 |109 | 110 | 123 |111 |114 |Failure due to some error.
112 | 113 |115 |122 |Declaration
116 |117 |121 |Swift
118 |
119 | 120 |case failed(error: Error)
125 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | SerializationFailureReason Enumeration Reference
27 |
30 |
82 |
83 |
84 |
85 |
95 |
96 |
128 |
129 |
133 |
134 |
135 |
136 |
137 |
138 |
--------------------------------------------------------------------------------
/PredictionIO/Tests/EventTests.swift:
--------------------------------------------------------------------------------
1 | //
2 | // EventTests.swift
3 | // PredictionIOTests
4 | //
5 | // Created by Minh Tu Le on 1/2/18.
6 | // Copyright © 2018 PredictionIO. All rights reserved.
7 | //
8 |
9 | import XCTest
10 | @testable import PredictionIO
11 |
12 | // swiftlint:disable force_cast force_try
13 | class EventTests: XCTestCase {
14 |
15 | func testInit() {
16 | let event = Event(
17 | event: "rate",
18 | entityType: "customer",
19 | entityID: "c1",
20 | targetEntity: (type: "book", id: "b1"),
21 | properties: ["rating": 5],
22 | eventTime: Date(timeIntervalSince1970: 0)
23 | )
24 |
25 | XCTAssertEqual(event.event, "rate")
26 | XCTAssertEqual(event.entityType, "customer")
27 | XCTAssertEqual(event.entityID, "c1")
28 | XCTAssertEqual(event.targetEntityType!, "book")
29 | XCTAssertEqual(event.targetEntityID!, "b1")
30 | XCTAssert(event.properties!["rating"] as? Int == 5)
31 | XCTAssertEqual(event.eventTime, Date(timeIntervalSince1970: 0))
32 | }
33 |
34 | func testInit_withoutOptionalParameters() {
35 | let event = Event(
36 | event: "create",
37 | entityType: "customer",
38 | entityID: "c1"
39 | )
40 |
41 | XCTAssertEqual(event.event, "create")
42 | XCTAssertEqual(event.entityType, "customer")
43 | XCTAssertEqual(event.entityID, "c1")
44 | XCTAssertNil(event.targetEntityType)
45 | XCTAssertNil(event.targetEntityID)
46 | XCTAssertNil(event.properties)
47 | XCTAssertNotNil(event.eventTime)
48 | }
49 |
50 | func testInitWithJSON() {
51 | let json: [String: Any] = [
52 | "event": "rate",
53 | "entityType": "customer",
54 | "entityId": "c1",
55 | "targetEntityType": "book",
56 | "targetEntityId": "b1",
57 | "properties": [
58 | "rating": 5,
59 | "others": ["foo", "bar"]
60 | ],
61 | "eventId": "fake_id",
62 | "eventTime": "2018-01-13T21:39:45.618Z"
63 | ]
64 | let eventTime = Event.dateTimeFormatter.date(from: json["eventTime"] as! String)!
65 | let event = try! Event(json: json)
66 |
67 | XCTAssertEqual(event.event, json["event"] as! String)
68 | XCTAssertEqual(event.entityType, json["entityType"] as! String)
69 | XCTAssertEqual(event.entityID, json["entityId"] as! String)
70 | XCTAssertEqual(event.targetEntityType!, json["targetEntityType"] as! String)
71 | XCTAssertEqual(event.targetEntityID!, json["targetEntityId"] as! String)
72 | XCTAssertTrue(isEqualJSON(event.properties!, json["properties"] as! [String: Any]))
73 | XCTAssertEqual(event.eventID!, json["eventId"] as! String)
74 | XCTAssertEqual(event.eventTime, eventTime)
75 | }
76 |
77 | func testInitiWithJSON_missingEventID_throwsSerializationError() {
78 | let json: [String: Any] = [
79 | "event": "rate",
80 | "entityType": "customer",
81 | "entityId": "c1",
82 | "eventTime": "2018-01-13T21:39:45.618Z"
83 | ]
84 |
85 | XCTAssertThrowsError(try Event(json: json)) { error in
86 | XCTAssertTrue((error as! PIOError).isDeserializingMissingField("eventId"))
87 | }
88 | }
89 |
90 | func testInitiWithJSON_invalidJSONProperties_throwsSerializationError() {
91 | let json: [String: Any] = [
92 | "event": "rate",
93 | "entityType": "customer",
94 | "entityId": "c1",
95 | "properties": [
96 | "foo": [
97 | 1: "this is not a valid JSON"
98 | ]
99 | ],
100 | "eventId": "fake_id",
101 | "eventTime": "2018-01-13T21:39:45.618Z"
102 | ]
103 |
104 | XCTAssertThrowsError(try Event(json: json)) { error in
105 | XCTAssertTrue((error as! PIOError).isDeserializingInvalidField("properties"))
106 | }
107 | }
108 |
109 | func testJSON() {
110 | let event = Event(
111 | event: "rate",
112 | entityType: "customer",
113 | entityID: "c1",
114 | targetEntity: (type: "book", id: "b1"),
115 | properties: [
116 | "ratings": [5, 4]
117 | ],
118 | eventTime: Date(timeIntervalSince1970: 0)
119 | )
120 |
121 | let expectedJSON: [String: Any] = [
122 | "event": "rate",
123 | "entityType": "customer",
124 | "entityId": "c1",
125 | "targetEntityType": "book",
126 | "targetEntityId": "b1",
127 | "properties": [
128 | "ratings": [5, 4]
129 | ],
130 | "eventTime": "1970-01-01T00:00:00.000Z"
131 | ]
132 |
133 | XCTAssertTrue(isEqualJSON(event.json, expectedJSON))
134 | }
135 |
136 | func testValidate_invalidJSONProperties_throwsInvalidEventError() {
137 | let event = Event(
138 | event: "rate",
139 | entityType: "customer",
140 | entityID: "c1",
141 | properties: [
142 | "ratings": [
143 | 3: "this is an invalid json"
144 | ]
145 | ]
146 | )
147 |
148 | let error = event.validate()! as! PIOError
149 | XCTAssertTrue(error.isInvalidJSONProperties())
150 | }
151 |
152 | func testValidate_unsetEventWithEmptyProperties_throwsInvalidEventError() {
153 | let event = Event(
154 | event: Event.unsetEvent,
155 | entityType: "customer",
156 | entityID: "c1",
157 | properties: [:]
158 | )
159 |
160 | let error = event.validate()! as! PIOError
161 | XCTAssertTrue(error.isUnsetEventWithEmptyProperties())
162 | }
163 |
164 | private func isEqualJSON(_ left: Any, _ right: Any) -> Bool {
165 | switch (left, right) {
166 | // Dictionary
167 | case let (leftDict as [String: Any], rightDict as [String: Any]):
168 | if leftDict.count != rightDict.count {
169 | return false
170 | }
171 |
172 | for (key, leftValue) in leftDict {
173 | if rightDict[key] == nil || !isEqualJSON(leftValue, rightDict[key]!) {
174 | return false
175 | }
176 | }
177 |
178 | return true
179 | // Array
180 | case let (leftArray as [Any], rightArray as [Any]):
181 | if leftArray.count != rightArray.count {
182 | return false
183 | }
184 |
185 | for (index, leftElement) in leftArray.enumerated() {
186 | if !isEqualJSON(leftElement, rightArray[index]) {
187 | return false
188 | }
189 | }
190 |
191 | return true
192 | // Bool
193 | case let (leftBool as Bool, rightBool as Bool):
194 | return leftBool == rightBool
195 | // String
196 | case let (leftString as String, rightString as String):
197 | return leftString == rightString
198 | // Number
199 | case let (leftNumber as NSNumber, rightNumber as NSNumber):
200 | return leftNumber == rightNumber
201 | // Otherwise
202 | default:
203 | return false
204 | }
205 | }
206 | }
207 |
--------------------------------------------------------------------------------
/docs/Structs/CreateBatchEventsResponse.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | SerializationFailureReason
86 |
87 |
92 |
88 |
91 | public enum SerializationFailureReasonThe underlying reason the serialization fails.
93 | 94 |
97 |
127 | -
98 |
-
99 | 100 |106 |
101 | 102 | 103 | failed(error:) 104 |105 |107 | 108 |124 |109 | 110 | 123 |111 |114 |Failure due to some error.
112 | 113 |115 |122 |Declaration
116 |117 |121 |Swift
118 |
119 | 120 |case failed(error: Error)
125 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | CreateBatchEventsResponse Structure Reference
27 |
30 |
82 |
83 |
84 |
85 |
95 |
96 |
135 |
136 |
140 |
141 |
142 |
143 |
144 |
145 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/Structs/CreateBatchEventsResponse.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CreateBatchEventsResponse
86 |
87 |
92 |
88 |
91 | public struct CreateBatchEventsResponse : DecodableRepresents the response of a creating batch events request.
93 | 94 |
97 |
134 | -
98 |
-
99 | 100 |106 |
101 | 102 | 103 | statuses 104 |105 |107 | 108 |131 |109 | 110 | 130 |111 |121 |The statuses each of which presents whether an event was successfully 112 | created by the server.
113 | 114 |If an event was successfuly created by the server, its status is a 115 |
119 | 120 |Result.successwhich value contains its individualCreateEventResponse. 116 | Otherwise, the event’s status is aResult.failure. The statuses are 117 | returned in the same order of their corresponding events sent in the 118 | request.122 |129 |Declaration
123 |124 |128 |Swift
125 |
126 | 127 |public let statuses: [Result<CreateEventResponse, PIOError>]
132 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | CreateBatchEventsResponse Structure Reference
27 |
30 |
82 |
83 |
84 |
85 |
95 |
96 |
135 |
136 |
140 |
141 |
142 |
143 |
144 |
145 |
--------------------------------------------------------------------------------
/PredictionIO/Source/Event.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Event.swift
3 | // PredictionIO
4 | //
5 | // Created by Minh Tu Le on 1/6/18.
6 | // Copyright © 2018 PredictionIO. All rights reserved.
7 | //
8 |
9 | import Foundation
10 |
11 | /// The `Event` struct represents an event dictionary in the REST API
12 | /// to a PredictionIO's event server.
13 | public struct Event {
14 | // MARK: - Constants
15 |
16 | /// Reversed set event name.
17 | public static let setEvent = "$set"
18 |
19 | /// Reversed unset event name.
20 | public static let unsetEvent = "$unset"
21 |
22 | /// Reversed delete event name.
23 | public static let deleteEvent = "$delete"
24 |
25 | /// Predefined user entity type.
26 | public static let userEntityType = "user"
27 |
28 | /// Predefined item entity type.
29 | public static let itemEntityType = "item"
30 |
31 | // MARK: - Properties
32 |
33 | /// The event name e.g. "sign-up", "rate", "view".
34 | ///
35 | /// **Note:** All event names starting with "$" and "pio_" are reversed
36 | /// and shouldn't be used as your custom event (e.g. "$set").
37 | public let event: String
38 |
39 | /// The entity type. It is the namespace of the `entityID` and analogous
40 | /// to the table name of a relational database. The `entityID` must be
41 | /// unique within the same `entityType`.
42 | ///
43 | /// **Note:** All entityType names starting with "$" and "pio_" are reversed
44 | /// and shouldn't be used.
45 | public let entityType: String
46 |
47 | /// The entity ID. `entityType-entityID` becomes the unique identifier
48 | /// of the entity.
49 | public let entityID: String
50 |
51 | /// The target entity type.
52 | ///
53 | /// **Note:** All targetEntityType names starting with "$" and "pio_" are reversed
54 | /// and shouldn't be used.
55 | public let targetEntityType: String?
56 |
57 | /// The target entity ID.
58 | public let targetEntityID: String?
59 |
60 | /// The event properties. It should be a valid JSON dictionary.
61 | ///
62 | /// **Note:** All properties names starting with "$" and "pio_" are reversed
63 | /// and shouldn't be used.
64 | public let properties: [String: Any]?
65 |
66 | /// The time of the event.
67 | public let eventTime: Date
68 |
69 | /// The event ID. This value should only be set by the server.
70 | public let eventID: String?
71 |
72 | // MARK: - Initialization
73 |
74 | /// Creates an event struct.
75 | ///
76 | /// - parameter event: The event name.
77 | /// - parameter entityType: The entity type.
78 | /// - parameter entityID: The entity ID.
79 | /// - parameter targetEntity: The target entity (type, ID) tuple. `nil` by default.
80 | /// - parameter properties: The event properties in JSON dictionary. `nil` by default.
81 | /// - parameter eventTime: The event time. Current local time by default.
82 | ///
83 | /// - returns: The new `Event` instance.
84 | public init(
85 | event: String,
86 | entityType: String,
87 | entityID: String,
88 | targetEntity: (type: String, id: String)? = nil,
89 | properties: [String: Any]? = nil,
90 | eventTime: Date = Date()
91 | ) {
92 | self.event = event
93 | self.entityType = entityType
94 | self.entityID = entityID
95 |
96 | if let targetEntity = targetEntity {
97 | self.targetEntityType = targetEntity.type
98 | self.targetEntityID = targetEntity.id
99 | } else {
100 | self.targetEntityType = nil
101 | self.targetEntityID = nil
102 | }
103 |
104 | self.properties = properties
105 | self.eventTime = eventTime
106 | self.eventID = nil
107 | }
108 |
109 | // MARK: - Validation
110 |
111 | /// Validates an event against the following rules:
112 | /// - `properties` must be a valid JSON dictionary.
113 | /// - An `$unset` event must not have an empty or nil `properties`.
114 | ///
115 | /// - returns: A `PIOError.invalidEvent` error if the validation fails. Otherwise, returns nil.
116 | public func validate() -> Error? {
117 | if let properties = properties, !JSONSerialization.isValidJSONObject(properties) {
118 | return PIOError.InvalidEventReason.invalidJSONPropertiesError()
119 | }
120 |
121 | if event == Event.unsetEvent && (properties == nil || properties!.isEmpty == true) {
122 | return PIOError.InvalidEventReason.unsetEventWithEmptyPropertiesError()
123 | }
124 |
125 | return nil
126 | }
127 | }
128 |
129 | // MARK: -
130 |
131 | extension Event {
132 | // MARK: - JSON Serialization and Deserialization
133 |
134 | /// Creates an event from a JSON dictionary.
135 | ///
136 | /// - parameters json: The JSON dictionary.
137 | ///
138 | /// - throws: A `PIOError.failedDeserialization` error if deserialization fails.
139 | ///
140 | /// - returns: The new Event instance.
141 | public init(json: [String: Any]) throws {
142 | guard let event = json["event"] as? String else {
143 | throw PIOError.DeserializationFailureReason.missingFieldError(field: "event")
144 | }
145 |
146 | guard let eventID = json["eventId"] as? String else {
147 | throw PIOError.DeserializationFailureReason.missingFieldError(field: "eventId")
148 | }
149 |
150 | guard let entityType = json["entityType"] as? String else {
151 | throw PIOError.DeserializationFailureReason.missingFieldError(field: "entityType")
152 | }
153 |
154 | guard let entityID = json["entityId"] as? String else {
155 | throw PIOError.DeserializationFailureReason.missingFieldError(field: "entityId")
156 | }
157 |
158 | guard let eventTimeString = json["eventTime"] as? String else {
159 | throw PIOError.DeserializationFailureReason.missingFieldError(field: "eventTime")
160 | }
161 |
162 | guard let eventTime = Event.dateTimeFormatter.date(from: eventTimeString) else {
163 | throw PIOError.DeserializationFailureReason.missingFieldError(field: "eventTime")
164 | }
165 |
166 | let properties = json["properties"] as? [String: Any]
167 |
168 | if let properties = properties, !JSONSerialization.isValidJSONObject(properties) {
169 | throw PIOError.DeserializationFailureReason.invalidFieldError(field: "properties", value: properties)
170 | }
171 |
172 | self.event = event
173 | self.entityType = entityType
174 | self.entityID = entityID
175 |
176 | if let targetEntityType = json["targetEntityType"] as? String,
177 | let targetEntityID = json["targetEntityId"] as? String {
178 | self.targetEntityType = targetEntityType
179 | self.targetEntityID = targetEntityID
180 | } else {
181 | self.targetEntityType = nil
182 | self.targetEntityID = nil
183 | }
184 |
185 | self.properties = properties
186 | self.eventTime = eventTime
187 | self.eventID = eventID
188 | }
189 |
190 | /// Returns a JSON dictionary representing the event.
191 | ///
192 | /// - returns: The JSON dictionary.
193 | public var json: [String: Any] {
194 | var json: [String: Any] = [
195 | "event": event,
196 | "entityType": entityType,
197 | "entityId": entityID,
198 | "eventTime": Event.dateTimeFormatter.string(from: eventTime)
199 | ]
200 |
201 | if let targetEntityType = targetEntityType, let targetEntityID = targetEntityID {
202 | json["targetEntityType"] = targetEntityType
203 | json["targetEntityId"] = targetEntityID
204 | }
205 |
206 | if let properties = properties {
207 | json["properties"] = properties
208 | }
209 |
210 | return json
211 | }
212 |
213 | static let dateTimeFormatter: DateFormatter = {
214 | let dateFormatter = DateFormatter()
215 | dateFormatter.locale = Locale(identifier: "en_US_POSIX")
216 | dateFormatter.timeZone = TimeZone(abbreviation: "UTC")
217 | dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
218 | return dateFormatter
219 | }()
220 | }
221 |
--------------------------------------------------------------------------------
/docs/css/jazzy.css:
--------------------------------------------------------------------------------
1 | html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
2 | background: transparent;
3 | border: 0;
4 | margin: 0;
5 | outline: 0;
6 | padding: 0;
7 | vertical-align: baseline; }
8 |
9 | body {
10 | background-color: #f2f2f2;
11 | font-family: Helvetica, freesans, Arial, sans-serif;
12 | font-size: 14px;
13 | -webkit-font-smoothing: subpixel-antialiased;
14 | word-wrap: break-word; }
15 |
16 | h1, h2, h3 {
17 | margin-top: 0.8em;
18 | margin-bottom: 0.3em;
19 | font-weight: 100;
20 | color: black; }
21 |
22 | h1 {
23 | font-size: 2.5em; }
24 |
25 | h2 {
26 | font-size: 2em;
27 | border-bottom: 1px solid #e2e2e2; }
28 |
29 | h4 {
30 | font-size: 13px;
31 | line-height: 1.5;
32 | margin-top: 21px; }
33 |
34 | h5 {
35 | font-size: 1.1em; }
36 |
37 | h6 {
38 | font-size: 1.1em;
39 | color: #777; }
40 |
41 | .section-name {
42 | color: gray;
43 | display: block;
44 | font-family: Helvetica;
45 | font-size: 22px;
46 | font-weight: 100;
47 | margin-bottom: 15px; }
48 |
49 | pre, code {
50 | font: 0.95em Menlo, monospace;
51 | color: #777;
52 | word-wrap: normal; }
53 |
54 | p code, li code {
55 | background-color: #eee;
56 | padding: 2px 4px;
57 | border-radius: 4px; }
58 |
59 | a {
60 | color: #0088cc;
61 | text-decoration: none; }
62 |
63 | ul {
64 | padding-left: 15px; }
65 |
66 | li {
67 | line-height: 1.8em; }
68 |
69 | img {
70 | max-width: 100%; }
71 |
72 | blockquote {
73 | margin-left: 0;
74 | padding: 0 10px;
75 | border-left: 4px solid #ccc; }
76 |
77 | .content-wrapper {
78 | margin: 0 auto;
79 | width: 980px; }
80 |
81 | header {
82 | font-size: 0.85em;
83 | line-height: 26px;
84 | background-color: #414141;
85 | position: fixed;
86 | width: 100%;
87 | z-index: 1; }
88 | header img {
89 | padding-right: 6px;
90 | vertical-align: -4px;
91 | height: 16px; }
92 | header a {
93 | color: #fff; }
94 | header p {
95 | float: left;
96 | color: #999; }
97 | header .header-right {
98 | float: right;
99 | margin-left: 16px; }
100 |
101 | #breadcrumbs {
102 | background-color: #f2f2f2;
103 | height: 27px;
104 | padding-top: 17px;
105 | position: fixed;
106 | width: 100%;
107 | z-index: 1;
108 | margin-top: 26px; }
109 | #breadcrumbs #carat {
110 | height: 10px;
111 | margin: 0 5px; }
112 |
113 | .sidebar {
114 | background-color: #f9f9f9;
115 | border: 1px solid #e2e2e2;
116 | overflow-y: auto;
117 | overflow-x: hidden;
118 | position: fixed;
119 | top: 70px;
120 | bottom: 0;
121 | width: 230px;
122 | word-wrap: normal; }
123 |
124 | .nav-groups {
125 | list-style-type: none;
126 | background: #fff;
127 | padding-left: 0; }
128 |
129 | .nav-group-name {
130 | border-bottom: 1px solid #e2e2e2;
131 | font-size: 1.1em;
132 | font-weight: 100;
133 | padding: 15px 0 15px 20px; }
134 | .nav-group-name > a {
135 | color: #333; }
136 |
137 | .nav-group-tasks {
138 | margin-top: 5px; }
139 |
140 | .nav-group-task {
141 | font-size: 0.9em;
142 | list-style-type: none;
143 | white-space: nowrap; }
144 | .nav-group-task a {
145 | color: #888; }
146 |
147 | .main-content {
148 | background-color: #fff;
149 | border: 1px solid #e2e2e2;
150 | margin-left: 246px;
151 | position: absolute;
152 | overflow: hidden;
153 | padding-bottom: 20px;
154 | top: 70px;
155 | width: 734px; }
156 | .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
157 | margin-bottom: 1em; }
158 | .main-content p {
159 | line-height: 1.8em; }
160 | .main-content section .section:first-child {
161 | margin-top: 0;
162 | padding-top: 0; }
163 | .main-content section .task-group-section .task-group:first-of-type {
164 | padding-top: 10px; }
165 | .main-content section .task-group-section .task-group:first-of-type .section-name {
166 | padding-top: 15px; }
167 | .main-content section .heading:before {
168 | content: "";
169 | display: block;
170 | padding-top: 70px;
171 | margin: -70px 0 0; }
172 |
173 | .section {
174 | padding: 0 25px; }
175 |
176 | .highlight {
177 | background-color: #eee;
178 | padding: 10px 12px;
179 | border: 1px solid #e2e2e2;
180 | border-radius: 4px;
181 | overflow-x: auto; }
182 |
183 | .declaration .highlight {
184 | overflow-x: initial;
185 | padding: 0 40px 40px 0;
186 | margin-bottom: -25px;
187 | background-color: transparent;
188 | border: none; }
189 |
190 | .section-name {
191 | margin: 0;
192 | margin-left: 18px; }
193 |
194 | .task-group-section {
195 | padding-left: 6px;
196 | border-top: 1px solid #e2e2e2; }
197 |
198 | .task-group {
199 | padding-top: 0px; }
200 |
201 | .task-name-container a[name]:before {
202 | content: "";
203 | display: block;
204 | padding-top: 70px;
205 | margin: -70px 0 0; }
206 |
207 | .item {
208 | padding-top: 8px;
209 | width: 100%;
210 | list-style-type: none; }
211 | .item a[name]:before {
212 | content: "";
213 | display: block;
214 | padding-top: 70px;
215 | margin: -70px 0 0; }
216 | .item code {
217 | background-color: transparent;
218 | padding: 0; }
219 | .item .token, .item .direct-link {
220 | padding-left: 3px;
221 | margin-left: 15px;
222 | font-size: 11.9px;
223 | transition: all 300ms; }
224 | .item .token-open {
225 | margin-left: 0px; }
226 | .item .discouraged {
227 | text-decoration: line-through; }
228 | .item .declaration-note {
229 | font-size: .85em;
230 | color: gray;
231 | font-style: italic; }
232 |
233 | .pointer-container {
234 | border-bottom: 1px solid #e2e2e2;
235 | left: -23px;
236 | padding-bottom: 13px;
237 | position: relative;
238 | width: 110%; }
239 |
240 | .pointer {
241 | background: #f9f9f9;
242 | border-left: 1px solid #e2e2e2;
243 | border-top: 1px solid #e2e2e2;
244 | height: 12px;
245 | left: 21px;
246 | top: -7px;
247 | -webkit-transform: rotate(45deg);
248 | -moz-transform: rotate(45deg);
249 | -o-transform: rotate(45deg);
250 | transform: rotate(45deg);
251 | position: absolute;
252 | width: 12px; }
253 |
254 | .height-container {
255 | display: none;
256 | left: -25px;
257 | padding: 0 25px;
258 | position: relative;
259 | width: 100%;
260 | overflow: hidden; }
261 | .height-container .section {
262 | background: #f9f9f9;
263 | border-bottom: 1px solid #e2e2e2;
264 | left: -25px;
265 | position: relative;
266 | width: 100%;
267 | padding-top: 10px;
268 | padding-bottom: 5px; }
269 |
270 | .aside, .language {
271 | padding: 6px 12px;
272 | margin: 12px 0;
273 | border-left: 5px solid #dddddd;
274 | overflow-y: hidden; }
275 | .aside .aside-title, .language .aside-title {
276 | font-size: 9px;
277 | letter-spacing: 2px;
278 | text-transform: uppercase;
279 | padding-bottom: 0;
280 | margin: 0;
281 | color: #aaa;
282 | -webkit-user-select: none; }
283 | .aside p:last-child, .language p:last-child {
284 | margin-bottom: 0; }
285 |
286 | .language {
287 | border-left: 5px solid #cde9f4; }
288 | .language .aside-title {
289 | color: #4b8afb; }
290 |
291 | .aside-warning, .aside-deprecated, .aside-unavailable {
292 | border-left: 5px solid #ff6666; }
293 | .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title {
294 | color: #ff0000; }
295 |
296 | .graybox {
297 | border-collapse: collapse;
298 | width: 100%; }
299 | .graybox p {
300 | margin: 0;
301 | word-break: break-word;
302 | min-width: 50px; }
303 | .graybox td {
304 | border: 1px solid #e2e2e2;
305 | padding: 5px 25px 5px 10px;
306 | vertical-align: middle; }
307 | .graybox tr td:first-of-type {
308 | text-align: right;
309 | padding: 7px;
310 | vertical-align: top;
311 | word-break: normal;
312 | width: 40px; }
313 |
314 | .slightly-smaller {
315 | font-size: 0.9em; }
316 |
317 | #footer {
318 | position: relative;
319 | top: 10px;
320 | bottom: 0px;
321 | margin-left: 25px; }
322 | #footer p {
323 | margin: 0;
324 | color: #aaa;
325 | font-size: 0.8em; }
326 |
327 | html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
328 | display: none; }
329 |
330 | html.dash .main-content {
331 | width: 980px;
332 | margin-left: 0;
333 | border: none;
334 | width: 100%;
335 | top: 0;
336 | padding-bottom: 0; }
337 |
338 | html.dash .height-container {
339 | display: block; }
340 |
341 | html.dash .item .token {
342 | margin-left: 0; }
343 |
344 | html.dash .content-wrapper {
345 | width: auto; }
346 |
347 | html.dash #footer {
348 | position: static; }
349 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/css/jazzy.css:
--------------------------------------------------------------------------------
1 | html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
2 | background: transparent;
3 | border: 0;
4 | margin: 0;
5 | outline: 0;
6 | padding: 0;
7 | vertical-align: baseline; }
8 |
9 | body {
10 | background-color: #f2f2f2;
11 | font-family: Helvetica, freesans, Arial, sans-serif;
12 | font-size: 14px;
13 | -webkit-font-smoothing: subpixel-antialiased;
14 | word-wrap: break-word; }
15 |
16 | h1, h2, h3 {
17 | margin-top: 0.8em;
18 | margin-bottom: 0.3em;
19 | font-weight: 100;
20 | color: black; }
21 |
22 | h1 {
23 | font-size: 2.5em; }
24 |
25 | h2 {
26 | font-size: 2em;
27 | border-bottom: 1px solid #e2e2e2; }
28 |
29 | h4 {
30 | font-size: 13px;
31 | line-height: 1.5;
32 | margin-top: 21px; }
33 |
34 | h5 {
35 | font-size: 1.1em; }
36 |
37 | h6 {
38 | font-size: 1.1em;
39 | color: #777; }
40 |
41 | .section-name {
42 | color: gray;
43 | display: block;
44 | font-family: Helvetica;
45 | font-size: 22px;
46 | font-weight: 100;
47 | margin-bottom: 15px; }
48 |
49 | pre, code {
50 | font: 0.95em Menlo, monospace;
51 | color: #777;
52 | word-wrap: normal; }
53 |
54 | p code, li code {
55 | background-color: #eee;
56 | padding: 2px 4px;
57 | border-radius: 4px; }
58 |
59 | a {
60 | color: #0088cc;
61 | text-decoration: none; }
62 |
63 | ul {
64 | padding-left: 15px; }
65 |
66 | li {
67 | line-height: 1.8em; }
68 |
69 | img {
70 | max-width: 100%; }
71 |
72 | blockquote {
73 | margin-left: 0;
74 | padding: 0 10px;
75 | border-left: 4px solid #ccc; }
76 |
77 | .content-wrapper {
78 | margin: 0 auto;
79 | width: 980px; }
80 |
81 | header {
82 | font-size: 0.85em;
83 | line-height: 26px;
84 | background-color: #414141;
85 | position: fixed;
86 | width: 100%;
87 | z-index: 1; }
88 | header img {
89 | padding-right: 6px;
90 | vertical-align: -4px;
91 | height: 16px; }
92 | header a {
93 | color: #fff; }
94 | header p {
95 | float: left;
96 | color: #999; }
97 | header .header-right {
98 | float: right;
99 | margin-left: 16px; }
100 |
101 | #breadcrumbs {
102 | background-color: #f2f2f2;
103 | height: 27px;
104 | padding-top: 17px;
105 | position: fixed;
106 | width: 100%;
107 | z-index: 1;
108 | margin-top: 26px; }
109 | #breadcrumbs #carat {
110 | height: 10px;
111 | margin: 0 5px; }
112 |
113 | .sidebar {
114 | background-color: #f9f9f9;
115 | border: 1px solid #e2e2e2;
116 | overflow-y: auto;
117 | overflow-x: hidden;
118 | position: fixed;
119 | top: 70px;
120 | bottom: 0;
121 | width: 230px;
122 | word-wrap: normal; }
123 |
124 | .nav-groups {
125 | list-style-type: none;
126 | background: #fff;
127 | padding-left: 0; }
128 |
129 | .nav-group-name {
130 | border-bottom: 1px solid #e2e2e2;
131 | font-size: 1.1em;
132 | font-weight: 100;
133 | padding: 15px 0 15px 20px; }
134 | .nav-group-name > a {
135 | color: #333; }
136 |
137 | .nav-group-tasks {
138 | margin-top: 5px; }
139 |
140 | .nav-group-task {
141 | font-size: 0.9em;
142 | list-style-type: none;
143 | white-space: nowrap; }
144 | .nav-group-task a {
145 | color: #888; }
146 |
147 | .main-content {
148 | background-color: #fff;
149 | border: 1px solid #e2e2e2;
150 | margin-left: 246px;
151 | position: absolute;
152 | overflow: hidden;
153 | padding-bottom: 20px;
154 | top: 70px;
155 | width: 734px; }
156 | .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
157 | margin-bottom: 1em; }
158 | .main-content p {
159 | line-height: 1.8em; }
160 | .main-content section .section:first-child {
161 | margin-top: 0;
162 | padding-top: 0; }
163 | .main-content section .task-group-section .task-group:first-of-type {
164 | padding-top: 10px; }
165 | .main-content section .task-group-section .task-group:first-of-type .section-name {
166 | padding-top: 15px; }
167 | .main-content section .heading:before {
168 | content: "";
169 | display: block;
170 | padding-top: 70px;
171 | margin: -70px 0 0; }
172 |
173 | .section {
174 | padding: 0 25px; }
175 |
176 | .highlight {
177 | background-color: #eee;
178 | padding: 10px 12px;
179 | border: 1px solid #e2e2e2;
180 | border-radius: 4px;
181 | overflow-x: auto; }
182 |
183 | .declaration .highlight {
184 | overflow-x: initial;
185 | padding: 0 40px 40px 0;
186 | margin-bottom: -25px;
187 | background-color: transparent;
188 | border: none; }
189 |
190 | .section-name {
191 | margin: 0;
192 | margin-left: 18px; }
193 |
194 | .task-group-section {
195 | padding-left: 6px;
196 | border-top: 1px solid #e2e2e2; }
197 |
198 | .task-group {
199 | padding-top: 0px; }
200 |
201 | .task-name-container a[name]:before {
202 | content: "";
203 | display: block;
204 | padding-top: 70px;
205 | margin: -70px 0 0; }
206 |
207 | .item {
208 | padding-top: 8px;
209 | width: 100%;
210 | list-style-type: none; }
211 | .item a[name]:before {
212 | content: "";
213 | display: block;
214 | padding-top: 70px;
215 | margin: -70px 0 0; }
216 | .item code {
217 | background-color: transparent;
218 | padding: 0; }
219 | .item .token, .item .direct-link {
220 | padding-left: 3px;
221 | margin-left: 15px;
222 | font-size: 11.9px;
223 | transition: all 300ms; }
224 | .item .token-open {
225 | margin-left: 0px; }
226 | .item .discouraged {
227 | text-decoration: line-through; }
228 | .item .declaration-note {
229 | font-size: .85em;
230 | color: gray;
231 | font-style: italic; }
232 |
233 | .pointer-container {
234 | border-bottom: 1px solid #e2e2e2;
235 | left: -23px;
236 | padding-bottom: 13px;
237 | position: relative;
238 | width: 110%; }
239 |
240 | .pointer {
241 | background: #f9f9f9;
242 | border-left: 1px solid #e2e2e2;
243 | border-top: 1px solid #e2e2e2;
244 | height: 12px;
245 | left: 21px;
246 | top: -7px;
247 | -webkit-transform: rotate(45deg);
248 | -moz-transform: rotate(45deg);
249 | -o-transform: rotate(45deg);
250 | transform: rotate(45deg);
251 | position: absolute;
252 | width: 12px; }
253 |
254 | .height-container {
255 | display: none;
256 | left: -25px;
257 | padding: 0 25px;
258 | position: relative;
259 | width: 100%;
260 | overflow: hidden; }
261 | .height-container .section {
262 | background: #f9f9f9;
263 | border-bottom: 1px solid #e2e2e2;
264 | left: -25px;
265 | position: relative;
266 | width: 100%;
267 | padding-top: 10px;
268 | padding-bottom: 5px; }
269 |
270 | .aside, .language {
271 | padding: 6px 12px;
272 | margin: 12px 0;
273 | border-left: 5px solid #dddddd;
274 | overflow-y: hidden; }
275 | .aside .aside-title, .language .aside-title {
276 | font-size: 9px;
277 | letter-spacing: 2px;
278 | text-transform: uppercase;
279 | padding-bottom: 0;
280 | margin: 0;
281 | color: #aaa;
282 | -webkit-user-select: none; }
283 | .aside p:last-child, .language p:last-child {
284 | margin-bottom: 0; }
285 |
286 | .language {
287 | border-left: 5px solid #cde9f4; }
288 | .language .aside-title {
289 | color: #4b8afb; }
290 |
291 | .aside-warning, .aside-deprecated, .aside-unavailable {
292 | border-left: 5px solid #ff6666; }
293 | .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title {
294 | color: #ff0000; }
295 |
296 | .graybox {
297 | border-collapse: collapse;
298 | width: 100%; }
299 | .graybox p {
300 | margin: 0;
301 | word-break: break-word;
302 | min-width: 50px; }
303 | .graybox td {
304 | border: 1px solid #e2e2e2;
305 | padding: 5px 25px 5px 10px;
306 | vertical-align: middle; }
307 | .graybox tr td:first-of-type {
308 | text-align: right;
309 | padding: 7px;
310 | vertical-align: top;
311 | word-break: normal;
312 | width: 40px; }
313 |
314 | .slightly-smaller {
315 | font-size: 0.9em; }
316 |
317 | #footer {
318 | position: relative;
319 | top: 10px;
320 | bottom: 0px;
321 | margin-left: 25px; }
322 | #footer p {
323 | margin: 0;
324 | color: #aaa;
325 | font-size: 0.8em; }
326 |
327 | html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
328 | display: none; }
329 |
330 | html.dash .main-content {
331 | width: 980px;
332 | margin-left: 0;
333 | border: none;
334 | width: 100%;
335 | top: 0;
336 | padding-bottom: 0; }
337 |
338 | html.dash .height-container {
339 | display: block; }
340 |
341 | html.dash .item .token {
342 | margin-left: 0; }
343 |
344 | html.dash .content-wrapper {
345 | width: auto; }
346 |
347 | html.dash #footer {
348 | position: static; }
349 |
--------------------------------------------------------------------------------
/PredictionIO/Tests/EventClientTests.swift:
--------------------------------------------------------------------------------
1 | //
2 | // EventClientTests.swift
3 | // PredictionIOTests
4 | //
5 | // Created by Minh Tu Le on 1/5/18.
6 | // Copyright © 2018 PredictionIO. All rights reserved.
7 | //
8 |
9 | import XCTest
10 | import PredictionIO
11 |
12 | class EventClientTests: XCTestCase {
13 | let accessKey = "123" // Replace with the real app's access key if testing using actual PredictionIO localhost setup.
14 | var eventClient: EventClient!
15 |
16 | override func setUp() {
17 | super.setUp()
18 |
19 | eventClient = EventClient(accessKey: accessKey, baseURL: "http://localhost:7070")
20 | }
21 |
22 | func testCreateEvent() {
23 | let event = Event(event: "register", entityType: "user", entityID: "foo")
24 | let expectation = self.expectation(description: "Creating an event")
25 |
26 | eventClient.createEvent(event) { result in
27 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
28 |
29 | expectation.fulfill()
30 | }
31 |
32 | waitForExpectations(timeout: 5) { error in
33 | XCTAssertNil(error, "\(error!)")
34 | }
35 | }
36 |
37 | func testCreateBatchEvents() {
38 | let events = [
39 | Event(event: "register", entityType: "user", entityID: "foo1"),
40 | Event(event: "register", entityType: "user", entityID: "foo2"),
41 | Event(event: "register", entityType: "user", entityID: "foo3")
42 | ]
43 | let expectation = self.expectation(description: "Creating batch events")
44 |
45 | eventClient.createBatchEvents(events) { result in
46 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
47 | let response = result.value!
48 | XCTAssertEqual(response.statuses.count, 3)
49 |
50 | for case .failure in response.statuses {
51 | XCTFail("There should be any failure here.")
52 | }
53 |
54 | expectation.fulfill()
55 | }
56 |
57 | waitForExpectations(timeout: 5) { error in
58 | XCTAssertNil(error, "\(error!)")
59 | }
60 | }
61 |
62 | func testGetEvent() {
63 | let event = Event(event: "register", entityType: "user", entityID: "foo")
64 | let eventID = createEvent(event)
65 |
66 | let getEventExpectation = self.expectation(description: "Getting an event")
67 | eventClient.getEvent(eventID: eventID) { result in
68 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
69 | let createdEvent = result.value!
70 | XCTAssertEqual(event.event, createdEvent.event)
71 |
72 | getEventExpectation.fulfill()
73 | }
74 |
75 | waitForExpectations(timeout: 5)
76 | }
77 |
78 | func testGetEvents() {
79 | let randomType = "random"
80 | let randomId = "\(arc4random())"
81 | let events = [
82 | Event(event: "register", entityType: randomType, entityID: randomId),
83 | Event(event: "register", entityType: randomType, entityID: randomId),
84 | Event(event: "register", entityType: "book", entityID: "math")
85 | ]
86 | events.forEach { createEvent($0) }
87 |
88 | let getEventsExpectation = self.expectation(description: "Getting events in event server")
89 | eventClient.getEvents(entityType: randomType, entityID: randomId) { result in
90 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
91 | let events = result.value!
92 | XCTAssertEqual(events.count, 2)
93 |
94 | getEventsExpectation.fulfill()
95 | }
96 |
97 | waitForExpectations(timeout: 5)
98 | }
99 |
100 | func testDeleteEvent() {
101 | let event = Event(event: "register", entityType: "user", entityID: "foo")
102 | let eventID = createEvent(event)
103 |
104 | let testDoneExpectation = self.expectation(description: "Deleting an event")
105 | eventClient.deleteEvent(eventID: eventID) { error in
106 | XCTAssertNil(error, "Request should succeed, got \(error!)")
107 |
108 | // Verify that the event no longer exists.
109 | self.eventClient.getEvent(eventID: eventID) { result in
110 | XCTAssertTrue(result.isFailure)
111 |
112 | testDoneExpectation.fulfill()
113 | }
114 | }
115 |
116 | waitForExpectations(timeout: 5)
117 | }
118 |
119 | // MARK: Convenient methods for user entity
120 |
121 | func testSetUser() {
122 | let expectation = self.expectation(description: "Setting properties of a user")
123 |
124 | eventClient.setUser(userID: "u1", properties: ["p1": "foo", "p2": "bar"]) { result in
125 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
126 |
127 | expectation.fulfill()
128 | }
129 |
130 | waitForExpectations(timeout: 5) { error in
131 | XCTAssertNil(error, "\(error!)")
132 | }
133 | }
134 |
135 | func testUnsetUser() {
136 | let expectation = self.expectation(description: "Unsetting properties of a user")
137 |
138 | eventClient.unsetUser(userID: "u2", properties: ["p1": NSNull()]) { result in
139 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
140 |
141 | expectation.fulfill()
142 | }
143 |
144 | waitForExpectations(timeout: 5) { error in
145 | XCTAssertNil(error, "\(error!)")
146 | }
147 | }
148 |
149 | func testDeleteUser() {
150 | let expectation = self.expectation(description: "Unsetting properties of a user")
151 |
152 | eventClient.deleteUser(userID: "u4") { result in
153 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
154 |
155 | expectation.fulfill()
156 | }
157 |
158 | waitForExpectations(timeout: 5) { error in
159 | XCTAssertNil(error, "\(error!)")
160 | }
161 | }
162 |
163 | // MARK: Convenient methods for item entity
164 |
165 | func testSetItem() {
166 | let expectation = self.expectation(description: "Setting properties of an item")
167 |
168 | eventClient.setItem(itemID: "i1", properties: ["p1": "foo", "p2": "bar"]) { result in
169 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
170 |
171 | expectation.fulfill()
172 | }
173 |
174 | waitForExpectations(timeout: 5) { error in
175 | XCTAssertNil(error, "\(error!)")
176 | }
177 | }
178 |
179 | func testUnsetItem() {
180 | let expectation = self.expectation(description: "Unsetting properties of an item")
181 |
182 | eventClient.unsetItem(itemID: "i2", properties: ["p1": NSNull()]) { result in
183 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
184 |
185 | expectation.fulfill()
186 | }
187 |
188 | waitForExpectations(timeout: 5) { error in
189 | XCTAssertNil(error, "\(error!)")
190 | }
191 | }
192 |
193 | func testDeleteItem() {
194 | let expectation = self.expectation(description: "Unsetting properties of an item")
195 |
196 | eventClient.deleteItem(itemID: "i4") { result in
197 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
198 |
199 | expectation.fulfill()
200 | }
201 |
202 | waitForExpectations(timeout: 5) { error in
203 | XCTAssertNil(error, "\(error!)")
204 | }
205 | }
206 |
207 | // MARK: Convenient methods for user action on item
208 |
209 | func testRecordAction() {
210 | let expectation = self.expectation(description: "Record user action on item")
211 |
212 | eventClient.recordAction("rate", byUserID: "u1", onItemID: "i1", properties: ["rating": 5]) { result in
213 | XCTAssertTrue(result.isSuccess, "Request should succeed, got \(result.error!)")
214 |
215 | expectation.fulfill()
216 | }
217 |
218 | waitForExpectations(timeout: 5) { error in
219 | XCTAssertNil(error, "\(error!)")
220 | }
221 | }
222 |
223 | // MARK: Helpers
224 |
225 | @discardableResult
226 | private func createEvent(_ event: Event) -> String {
227 | let createEventExpectation = self.expectation(description: "Creating an event")
228 | var eventID: String = ""
229 |
230 | eventClient.createEvent(event) { result in
231 | eventID = result.value!.eventID
232 | createEventExpectation.fulfill()
233 | }
234 |
235 | waitForExpectations(timeout: 5)
236 | return eventID
237 | }
238 | }
239 |
--------------------------------------------------------------------------------
/docs/Classes.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CreateBatchEventsResponse
86 |
87 |
92 |
88 |
91 | public struct CreateBatchEventsResponse : DecodableRepresents the response of a creating batch events request.
93 | 94 |
97 |
134 | -
98 |
-
99 | 100 |106 |
101 | 102 | 103 | statuses 104 |105 |107 | 108 |131 |109 | 110 | 130 |111 |121 |The statuses each of which presents whether an event was successfully 112 | created by the server.
113 | 114 |If an event was successfuly created by the server, its status is a 115 |
119 | 120 |Result.successwhich value contains its individualCreateEventResponse. 116 | Otherwise, the event’s status is aResult.failure. The statuses are 117 | returned in the same order of their corresponding events sent in the 118 | request.122 |129 |Declaration
123 |124 |128 |Swift
125 |
126 | 127 |public let statuses: [Result<CreateEventResponse, PIOError>]
132 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | Classes Reference
27 |
30 |
82 |
83 |
84 |
85 |
89 |
90 |
186 |
187 |
191 |
192 |
193 |
194 |
195 |
196 |
--------------------------------------------------------------------------------
/docs/docsets/PredictionIO.docset/Contents/Resources/Documents/Classes.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Classes
86 |The following classes are available globally.
87 | 88 |
91 |
121 | -
92 |
-
93 | 94 |100 |
95 | 96 | 97 | BaseClient 98 |99 |101 | 102 |118 |103 | 104 | 117 |105 |108 |Manages network connections with the server.
106 | 107 |109 |116 |Declaration
110 |111 |115 |Swift
112 |
113 | 114 |public class BaseClient
119 |
122 |
153 | -
123 |
-
124 | 125 |131 |
126 | 127 | 128 | EngineClient 129 |130 |132 | 133 |150 |134 | 135 | 149 |136 |140 |Responsible for retrieving prediction results from a PredictionIO Engine Server.
137 | 138 | See more 139 |141 |148 |Declaration
142 |143 |147 |Swift
144 |
145 | 146 |public class EngineClient : BaseClient
151 |
154 |
185 | -
155 |
-
156 | 157 |163 |
158 | 159 | 160 | EventClient 161 |162 |164 | 165 |182 |166 | 167 | 181 |168 |172 |Responsible for sending data to a PredictionIO Event Server.
169 | 170 | See more 171 |173 |180 |Declaration
174 |175 |179 |Swift
176 |
177 | 178 |public class EventClient : BaseClient
183 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | Classes Reference
27 |
30 |
82 |
83 |
84 |
85 |
89 |
90 |
186 |
187 |
191 |
192 |
193 |
194 |
195 |
196 |
--------------------------------------------------------------------------------
/docs/Structs.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Classes
86 |The following classes are available globally.
87 | 88 |
91 |
121 | -
92 |
-
93 | 94 |100 |
95 | 96 | 97 | BaseClient 98 |99 |101 | 102 |118 |103 | 104 | 117 |105 |108 |Manages network connections with the server.
106 | 107 |109 |116 |Declaration
110 |111 |115 |Swift
112 |
113 | 114 |public class BaseClient
119 |
122 |
153 | -
123 |
-
124 | 125 |131 |
126 | 127 | 128 | EngineClient 129 |130 |132 | 133 |150 |134 | 135 | 149 |136 |140 |Responsible for retrieving prediction results from a PredictionIO Engine Server.
137 | 138 | See more 139 |141 |148 |Declaration
142 |143 |147 |Swift
144 |
145 | 146 |public class EngineClient : BaseClient
151 |
154 |
185 | -
155 |
-
156 | 157 |163 |
158 | 159 | 160 | EventClient 161 |162 |164 | 165 |182 |166 | 167 | 181 |168 |172 |Responsible for sending data to a PredictionIO Event Server.
169 | 170 | See more 171 |173 |180 |Declaration
174 |175 |179 |Swift
176 |
177 | 178 |public class EventClient : BaseClient
183 |
23 |
29 |
24 | PredictionIO Reference
25 |
26 | Structures Reference
27 |
30 |
82 |
83 |
84 |
85 |
89 |
90 |
191 |
192 |
196 |
197 |
198 |
199 |
200 |
201 |
--------------------------------------------------------------------------------
Structures
86 |The following structures are available globally.
87 | 88 |
91 |
123 | -
92 |
-
93 | 94 |100 |
95 | 96 | 97 | Event 98 |99 |101 | 102 |120 |103 | 104 | 119 |105 |110 |The
107 | 108 | See more 109 |Eventstruct represents an event dictionary in the REST API 106 | to a PredictionIO’s event server.111 |118 |Declaration
112 |113 |117 |Swift
114 |
115 | 116 |public struct Event
121 |
124 |
131 |
190 | -
132 |
-
133 | 134 |140 |
135 | 136 | 137 | CreateEventResponse 138 |139 |141 | 142 |159 |143 | 144 | 158 |145 |149 |Represents the response of a creating event request.
146 | 147 | See more 148 |150 |157 |Declaration
151 |152 |156 |Swift
153 |
154 | 155 |public struct CreateEventResponse : Decodable
160 | -
161 | 162 |168 |
163 | 164 | 165 | CreateBatchEventsResponse 166 |167 |169 | 170 |187 |171 | 172 | 186 |173 |177 |Represents the response of a creating batch events request.
174 | 175 | See more 176 |178 |185 |Declaration
179 |180 |184 |Swift
181 |
182 | 183 |public struct CreateBatchEventsResponse : Decodable
188 |