Add user id and PusherEvent (#227)

* WIP user-id implementation

* Add tests for event object

* Add tests for data passed to callback

* Add test for events without channel name

* Simplify global callback code

* Add tests for unbinding event callbacks

* Consistent documentation

* Tidy up code and comments

* Refactor jsonize variable

* Add documentation to PusherEvent

* Use conditional cast rather than forced

* Refactor event name

* Documentation changes

* Documentation fixes

* Remove check for presence of data

* Don't parse the event data multiple times

* Rename channel and name properties in PusherEvent

* Minor refactoring

* Add test for non-string value in websocket JSON

* Change PusherEvent to Class from Struct for ObjC compatibility

* Add Objective-C tests

* Remove unnecessary event name variable

* Use PusherEvent throughout library and provide jsonData

* Tidy up

* An array is valid json too

* Correct check for data encoding. Fix comments

* Update tests

* Ensure jsonData is read only

* Ensure parsing is only attempted once

* Fix comment

* Stop reference cycle

* Stop reference cycle

* Refactor PusherEvent tests and add new tests

* Add Objective-C tests for global binds

* Start readme changes

* Change 'jsonData' to 'dataAsJSON'

* Begin documentation

* Fix docs

* Fix docs

* Update labels

* Try adding a table

* Fix tables

* Clarify table

* Clarify table

* Clarify documentation

* Clarify legacy dropdown

* Clarify table

* Remove parser

* Remove parsing helper. Return errors to delegate

* Update readme

* Add new section about parsing

* Update Swift example

* Update Objective-C example

* Add objc initializer without 'attemptToReturnJSONObject'

* Refactor function name

* Remove xcscheme file

* Reset activity count when error is received to match previous behaviour

* Update README.md

Co-Authored-By: Will Sewell <me@willsewell.com>

* Add newline

Co-Authored-By: Will Sewell <me@willsewell.com>

* Fix the error message

* Rename QueuedEvent to QueueClientEvent

* Fix inconsistent spaces around brackets

* Rename shouldParseJSON to shouldParseJSONForLegacyCallbacks

* Use consistent test names

* Update comment to match example

* Add extra comment

* Change class methods to static

* Update comments

* getProperty -> property

* Change PusherParser to a struct

* Update readme

* Style updates

* Remove convenience constructor and replace with function

* Restructure documentation comments

* Make parameter of legacy callback optional to match passed callback

* dataToJSONObject etc should not be accessible in ObjC

Author: TomKemp

PusherSwift.xcodeproj/project.pbxproj

@@ -32,6 +32,11 @@
 		33BB997C1D21230100B25C2A /* PusherTopLevelAPITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33BB99661D21226C00B25C2A /* PusherTopLevelAPITests.swift */; };
 		33C1FD6F1D81BFC300921AD7 /* ObjectiveC.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33C1FD6E1D81BFC300921AD7 /* ObjectiveC.swift */; };
 		33C40CB91C1DFC9C008A54E3 /* PusherSwift.h in Headers */ = {isa = PBXBuildFile; fileRef = 33831CD61A9CFFF200B124F1 /* PusherSwift.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		E2498293231E612700CFBBD6 /* PusherError.swift in Sources */ = {isa = PBXBuildFile; fileRef = E2498292231E612700CFBBD6 /* PusherError.swift */; };
+		E24D0AA522D798C8009DE31B /* PusherEvent.swift in Sources */ = {isa = PBXBuildFile; fileRef = E24D0AA422D798C8009DE31B /* PusherEvent.swift */; };
+		E29A4CBC2301BA31000BC499 /* PusherEventTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E29A4CBB2301BA31000BC499 /* PusherEventTests.swift */; };
+		E2CAFF0322FB09EF007915A7 /* PusherObjectiveCAPITests.m in Sources */ = {isa = PBXBuildFile; fileRef = E2CAFEFD22FB084B007915A7 /* PusherObjectiveCAPITests.m */; };
+		E2CFE43122D79CA7004187C3 /* PusherParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = E2CFE43022D79CA7004187C3 /* PusherParser.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -74,6 +79,11 @@
 		33BB99661D21226C00B25C2A /* PusherTopLevelAPITests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = PusherTopLevelAPITests.swift; path = ../Tests/PusherTopLevelAPITests.swift; sourceTree = "<group>"; };
 		33BB99671D21226C00B25C2A /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = ../Tests/Info.plist; sourceTree = "<group>"; };
 		33C1FD6E1D81BFC300921AD7 /* ObjectiveC.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ObjectiveC.swift; sourceTree = "<group>"; };
+		E2498292231E612700CFBBD6 /* PusherError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PusherError.swift; sourceTree = "<group>"; };
+		E24D0AA422D798C8009DE31B /* PusherEvent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PusherEvent.swift; sourceTree = "<group>"; };
+		E29A4CBB2301BA31000BC499 /* PusherEventTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PusherEventTests.swift; sourceTree = "<group>"; };
+		E2CAFEFD22FB084B007915A7 /* PusherObjectiveCAPITests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = PusherObjectiveCAPITests.m; sourceTree = "<group>"; };
+		E2CFE43022D79CA7004187C3 /* PusherParser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PusherParser.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -120,16 +130,19 @@
 				3389F5791CAEDEC800563F49 /* PusherClientOptions.swift */,
 				33BA541F1D9035BD00CD853B /* PusherDelegate.swift */,
 				3389F5651CAEDD5F00563F49 /* PusherConnection.swift */,
+				E2CFE43022D79CA7004187C3 /* PusherParser.swift */,
 				3389F5691CAEDD9100563F49 /* PusherWebsocketDelegate.swift */,
 				3384C1B81CAECD9C00F10796 /* PusherChannel.swift */,
 				3389F56D1CAEDDD800563F49 /* PusherPresenceChannel.swift */,
+				3390D1E71F054D1E00E1944D /* Authorizer.swift */,
 				3389F5751CAEDE2800563F49 /* PusherGlobalChannel.swift */,
 				3389F5711CAEDDF300563F49 /* PusherChannels.swift */,
 				3390D1E51F054D0400E1944D /* AuthRequestBuilderProtocol.swift */,
-				3390D1E71F054D1E00E1944D /* Authorizer.swift */,
 				33C1FD6E1D81BFC300921AD7 /* ObjectiveC.swift */,
 				33831C8C1A9CF61600B124F1 /* Supporting Files */,
 				33831CD61A9CFFF200B124F1 /* PusherSwift.h */,
+				E24D0AA422D798C8009DE31B /* PusherEvent.swift */,
+				E2498292231E612700CFBBD6 /* PusherError.swift */,
 			);
 			path = Sources;
 			sourceTree = "<group>";
@@ -157,7 +170,9 @@
 				33A962751D8943CA00DA421E /* PusherConnectionDelegateTests.swift */,
 				33BB99651D21226C00B25C2A /* PusherIncomingEventHandlingTests.swift */,
 				33BB99661D21226C00B25C2A /* PusherTopLevelAPITests.swift */,
+				E2CAFEFD22FB084B007915A7 /* PusherObjectiveCAPITests.m */,
 				33BB99671D21226C00B25C2A /* Info.plist */,
+				E29A4CBB2301BA31000BC499 /* PusherEventTests.swift */,
 			);
 			path = Tests;
 			sourceTree = "<group>";
@@ -311,10 +326,13 @@
 			files = (
 				3389F5661CAEDD5F00563F49 /* PusherConnection.swift in Sources */,
 				33BA54201D9035BD00CD853B /* PusherDelegate.swift in Sources */,
+				E2498293231E612700CFBBD6 /* PusherError.swift in Sources */,
+				E24D0AA522D798C8009DE31B /* PusherEvent.swift in Sources */,
 				3389F56A1CAEDD9100563F49 /* PusherWebsocketDelegate.swift in Sources */,
 				330D7A6D1CAEDA750032FF2C /* PusherChannel.swift in Sources */,
 				3390D1E81F054D1E00E1944D /* Authorizer.swift in Sources */,
 				3389F5721CAEDDF300563F49 /* PusherChannels.swift in Sources */,
+				E2CFE43122D79CA7004187C3 /* PusherParser.swift in Sources */,
 				3389F5761CAEDE2800563F49 /* PusherGlobalChannel.swift in Sources */,
 				3389F57A1CAEDEC800563F49 /* PusherClientOptions.swift in Sources */,
 				3389F56E1CAEDDD800563F49 /* PusherPresenceChannel.swift in Sources */,
@@ -337,8 +355,10 @@
 				33BB99751D21230100B25C2A /* Helpers.swift in Sources */,
 				33BB99731D21230100B25C2A /* AuthenticationTests.swift in Sources */,
 				33BB99781D21230100B25C2A /* PusherChannelTests.swift in Sources */,
+				E29A4CBC2301BA31000BC499 /* PusherEventTests.swift in Sources */,
 				33BB99761D21230100B25C2A /* Mocks.swift in Sources */,
 				33A962771D89483600DA421E /* PusherConnectionDelegateTests.swift in Sources */,
+				E2CAFF0322FB09EF007915A7 /* PusherObjectiveCAPITests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};