Add MTXRequest, MTXClient & support for logging in

FossilOrigin-Name: 1e716c7f85cbebd8a6cdddaee2605897beeb69d0a20150ab5a300254007648e4

src/MTXClient.h

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2020, Jonathan Schleifer <js@nil.im>
+ *
+ * https://fossil.nil.im/objmatrix
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice is present in all copies.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#import <ObjFW/ObjFW.h>
+
+OF_ASSUME_NONNULL_BEGIN
+
+@class MTXClient;
+
+/**
+ * @brief A block called when a new login succeeded or failed.
+ *
+ * @param client If the login succeeded, the newly created client
+ * @param exception If the login failed, an exception
+ */
+typedef void (^mtx_client_login_block_t)(MTXClient *_Nullable client,
+    id _Nullable exception);
+
+/**
+ * @brief A class that represents a client.
+ */
+@interface MTXClient: OFObject
+/**
+ * @brief The user ID used by the client.
+ */
+@property (readonly, nonatomic) OFString *userID;
+
+/**
+ * @brief The device ID used by the client.
+ */
+@property (readonly, nonatomic) OFString *deviceID;
+
+/**
+ * @brief The access token used by the client.
+ */
+@property (readonly, nonatomic) OFString *accessToken;
+
+/**
+ * @brief The homeserver used by the client.
+ */
+@property (readonly, nonatomic) OFURL *homeserver;
+
+/**
+ * @brief Creates a new client with the specified access token on the specified
+ *	  homeserver.
+ *
+ * @param accessToken The access token for the client
+ * @param homeserver The URL of the homeserver
+ * @return An autoreleased MTXClient
+ */
++ (instancetype)clientWithUserID: (OFString *)userID
+			deviceID: (OFString *)deviceID
+		     accessToken: (OFString *)accessToken
+		      homeserver: (OFURL *)homeserver;
+
+/**
+ * @brief Logs into the homeserver and creates a new client.
+ */
++ (void)logInWithUser: (OFString *)user
+	     password: (OFString *)password
+	   homeserver: (OFURL *)homeserver
+		block: (mtx_client_login_block_t)block;
+
+/**
+ * @brief Initializes an already allocated client with the specified access
+ *	  token on the specified homeserver.
+ *
+ * @param accessToken The access token for the client
+ * @param homeserver The URL of the homeserver
+ * @return An initialized MTXClient
+ */
+- (instancetype)initWithUserID: (OFString *)userID
+		      deviceID: (OFString *)deviceID
+		   accessToken: (OFString *)accessToken
+		    homeserver: (OFURL *)homeserver OF_DESIGNATED_INITIALIZER;
+@end
+
+OF_ASSUME_NONNULL_END