Updated Documentation and licenses

Author: smuellner

README.md

@@ -1,6 +1,6 @@
 # GameKitService.swift
 
-## GameKit (GameCenter) helper for SwiftUI
+## GameKit (GameCenter) helper for Swift
 
 GameKitService is **created and maintaned with ❥** by Sascha Muellner.
 
@@ -15,7 +15,7 @@ GameKitService is **created and maintaned with ❥** by Sascha Muellner.
 [![README](https://img.shields.io/badge/-README-lightgrey)](https://SwiftPackageRepository.github.io/GameKitService.swift)
 
 ## What?
-This is a **Swift** package with support for iOS/macOS/tvOS that allows to use GameKit. 
+This is a **Swift** package with support for iOS/macOS/tvOS that focuses on bridging the current GameKit implementation to a single service structure utilizing Combine to simplify and modernize GameKit's match handling. 
 
 ## Requirements
 
@@ -30,18 +30,119 @@ The latest version of GameKitService requires:
 ### Swift Package Manager
 Using SPM add the following to your dependencies
 
-``` 'GameKitService', 'master', 'https://github.com/smuellner/GameKitService.swift.git' ```
+``` 'GameKitService', 'master', 'https://github.com/SwiftPackageRepository/GameKitService.swift.git' ```
 
 ## How to use?
 
-### GameCenter
+### Starting a match
 
-To au. 
+Given you already authenticated the user and did initiate a match you, using for example [GCHelper](https://github.com/jackcook/GCHelper.git) or [GameKitUI](https://github.com/SwiftPackageRepository/GameKitUI.swift.git), you can now start it using **start** method from the **GameKitService**:
 
 ```swift
+import GameKit
+import GameKitService
 
+let match: GKMatch
+
+GameKitService
+    .shared
+    .start(match)
+```
+
+### Subscribing to match data changes
+
+The following match data changes can be subscribed using the **GameKitService**. 
+
+#### Authenticated
+
+Subscribe to the `authenticated: CurrentValueSubject<Bool, Never>` CurrentValueSubject, to receive when the user is authenticated at the GameCenter.
+
+```swift
+import GameKit
+import GameKitService
+
+let match: GKMatch
+
+GameKitService
+    .shared
+    .authenticated(match)
+```
+
+#### Match start
+
+Subscribe to the `started: PassthroughSubject<GKMatch, Never>` PassthroughSubject, to receive data about the starting of the match.
+
+```swift
+var cancellable: AnyCancellable?
+
+self.cancellable = GameKitService
+    .ended
+    .received.sink { (match: GKMatch) in
+        // match: the ending match
+    }
+```
+
+#### Match data
+
+Subscribe to the `received: PassthroughSubject<(match: GKMatch, data: Data, player: GKPlayer), Never>` PassthroughSubject, to receive data about the match from another player's device in the match.
+
+```swift
+var cancellable: AnyCancellable?
+
+self.cancellable = GameKitService
+    .shared
+    .received.sink { (match: GKMatch, data: Data, player: GKPlayer) in
+        // match: the current match
+        // data: the data send from
+        // player: the player that did send the data  
+    }
+```
+
+#### Match ended
+
+Subscribe to the `ended: PassthroughSubject<GKMatch, Never>` PassthroughSubject, to receive data about the ending of the match.
+
+```swift
+var cancellable: AnyCancellable?
+
+self.cancellable = GameKitService
+    .ended
+    .received.sink { (match: GKMatch) in
+        // match: the ending match
+    }
 ```
 
+### Sending match data
+
+To send data to other players in the match there are two possibilites. In the first one the data is send to all players in the match:
+
+```swift
+let data = "Hello Players!".data(using: .utf8)!
+
+do {
+    try GameKitService
+        .shared
+        .send(data)
+} catch {
+}
+```
+
+Where as the second possibility allows you to send to a dedicated group (one or more) of players in the match.
+
+```swift
+let playerOne: GKPlayer
+let data = "Hello Player One!".data(using: .utf8)!
+
+do {
+    try GameKitService
+        .shared
+        .send(data, players: [playerOne])
+} catch {
+}
+```
+
+
+
 ## Documentation
 + [Apple Documentation GameKit](https://developer.apple.com/documentation/gamekit/)
 + [raywenderlich.com: Game Center for iOS: Building a Turn-Based Game](https://www.raywenderlich.com/7544-game-center-for-ios-building-a-turn-based-game)

Sources/GameKitService/GameKitService.swift

@@ -1,6 +1,25 @@
 ///
-/// GameKitService.swift
+/// MIT License
 ///
+/// Copyright (c) 2020 Sascha Müllner
+///
+/// Permission is hereby granted, free of charge, to any person obtaining a copy
+/// of this software and associated documentation files (the "Software"), to deal
+/// in the Software without restriction, including without limitation the rights
+/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+/// copies of the Software, and to permit persons to whom the Software is
+/// furnished to do so, subject to the following conditions:
+///
+/// The above copyright notice and this permission notice shall be included in all
+/// copies or substantial portions of the Software.
+///
+/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+/// SOFTWARE.
 ///
 /// Created by Sascha Müllner on 04.12.20.
 
@@ -30,6 +49,8 @@ public class GameKitService : NSObject, GKMatchDelegate, GKLocalPlayerListener,
             selector: #selector(GameKitService.authenticationChanged),
             name: Notification.Name.GKPlayerAuthenticationDidChangeNotificationName,
             object: nil)
+
+        GKLocalPlayer.local.register(self)
     }
 
     // MARK: Public functions
@@ -43,7 +64,7 @@ public class GameKitService : NSObject, GKMatchDelegate, GKLocalPlayerListener,
         guard let match = self.match else { return }
         try match.sendData(toAllPlayers: data, with: .reliable)
     }
-    
+
     public func send(_ data: Data, players: [GKPlayer]) throws {
         guard let match = self.match else { return }
         try match.send(data, to: players, dataMode: .reliable)
@@ -84,7 +105,6 @@ public class GameKitService : NSObject, GKMatchDelegate, GKLocalPlayerListener,
 
     // MARK: GKLocalPlayerListener
     public func player(_ player: GKPlayer, didAccept invite: GKInvite) {
-
     }
 
     // MARK: Private functions

Sources/GameKitService/GameKitServiceProtocol.swift

@@ -1,7 +1,26 @@
 ///
-/// GameKitServiceProtocol.swift
-/// 
-/// 
+/// MIT License
+///
+/// Copyright (c) 2020 Sascha Müllner
+///
+/// Permission is hereby granted, free of charge, to any person obtaining a copy
+/// of this software and associated documentation files (the "Software"), to deal
+/// in the Software without restriction, including without limitation the rights
+/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+/// copies of the Software, and to permit persons to whom the Software is
+/// furnished to do so, subject to the following conditions:
+///
+/// The above copyright notice and this permission notice shall be included in all
+/// copies or substantial portions of the Software.
+///
+/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+/// SOFTWARE.
+///
 /// Created by Sascha Müllner on 04.12.20.
 
 import Combine