Merge branch 'release/4.2.1'

.github/workflows/CI.yml

@@ -0,0 +1,15 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: docker://swift:5.0
+      with:
+        entrypoint: swift
+        args: build

.swiftlint.yml

@@ -0,0 +1,2 @@
+disabled_rules:
+  - identifier_name

Example/main.swift

@@ -10,6 +10,7 @@ import Foundation
 
 let bot = ZEGBot(token: "TYPE YOUR TOKEN HERE")
 
+// swiftlint:disable force_try
 try! bot.run { update, bot in
 	dump(update)
 }

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:4.2
+// swift-tools-version:5.0
 
 import PackageDescription
 
@@ -24,7 +24,7 @@ let package = Package(
 			path: "./Example"),
 		.testTarget(
 			name: "ZEGBotTests",
-			dependencies: ["ZEGBot"]),
+			dependencies: ["ZEGBot"])
 		],
-	swiftLanguageVersions: [.v4_2]
+	swiftLanguageVersions: [.v5]
 )

README.md

@@ -1,6 +1,6 @@
 # ZEGBot
 
-[![Build Status](https://travis-ci.org/ShaneQi/ZEGBot.svg?branch=master)](https://travis-ci.org/ShaneQi/ZEGBot)  [![Swift Version](https://img.shields.io/badge/Swift-4.2-orange.svg?style=flat)](https://swift.org)  ![Platforms](https://img.shields.io/badge/Platforms-OS%20X%20%7C%20Linux%20-blue.svg?style=flat)  ![License](https://img.shields.io/badge/License-Apache-red.svg?style=flat)
+[![Build Status](https://travis-ci.org/ShaneQi/ZEGBot.svg?branch=master)](https://travis-ci.org/ShaneQi/ZEGBot)  [![Swift Version](https://img.shields.io/badge/Swift-5-orange.svg?style=flat)](https://swift.org)  ![Platforms](https://img.shields.io/badge/Platforms-OS%20X%20%7C%20Linux%20-blue.svg?style=flat)  ![License](https://img.shields.io/badge/License-Apache-red.svg?style=flat)
 
 This library wraps the JSON decoding processing, making it easy to decode incoming JSON String to manipulatable objects.
 
@@ -11,7 +11,7 @@ This library wraps the processing of converting objects to Telegram Bot API requ
 Add this project as a dependency in your Package.swift file.
 
 ```swift
-.package(url: "https://github.com/shaneqi/ZEGBot.git", from: Version(4, 2, 0))
+.package(url: "https://github.com/shaneqi/ZEGBot.git", from: Version(5, 0, 0))
 ```
 ## Quick Start
 

Sources/Methods.swift

@@ -15,153 +15,177 @@ import Dispatch
 extension ZEGBot {
 
 	@discardableResult
-	public func send(message text: String, to receiver: Sendable,
-	                 parseMode: ParseMode? = nil,
-	                 disableWebPagePreview: Bool? = nil,
-	                 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .message(text: text, parseMode: parseMode, disableWebPagePreview: disableWebPagePreview),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: replyMarkup)
+	public func send(
+		message text: String, to receiver: Sendable,
+		parseMode: ParseMode? = nil,
+		disableWebPagePreview: Bool? = nil,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .message(text: text, parseMode: parseMode, disableWebPagePreview: disableWebPagePreview),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: replyMarkup)
 		return try performRequest(ofMethod: "sendMessage", payload: payload)
 	}
 
 	@discardableResult
-	public func forward(message: Message, to receiver: Sendable,
-	                    disableNotification: Bool? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.message(chatId: message.chatId, messageId: message.messageId)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func forward(
+		message: Message, to receiver: Sendable,
+		disableNotification: Bool? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.message(chatId: message.chatId, messageId: message.messageId)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "forwardMessage", payload: payload)
 
 	}
 
 	@discardableResult
-	public func send(_ sticker: Sticker, to receiver: Sendable,
-					 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.sticker(fileId: sticker.fileId)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func send(
+		_ sticker: Sticker, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.sticker(fileId: sticker.fileId)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendSticker", payload: payload)
 	}
 
 	@discardableResult
-	public func send(_ photo: PhotoSize, caption: String? = nil, to receiver: Sendable,
-					 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.photo(fileId: photo.fileId, caption: caption)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func send(
+		_ photo: PhotoSize, caption: String? = nil, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.photo(fileId: photo.fileId, caption: caption)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendPhoto", payload: payload)
 	}
 
 	@discardableResult
-	public func send(_ audio: Audio, caption: String? = nil, to receiver: Sendable,
-					 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.audio(fileId: audio.fileId, caption: caption)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func send(
+		_ audio: Audio, caption: String? = nil, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.audio(fileId: audio.fileId, caption: caption)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendAudio", payload: payload)
 	}
 
 	@discardableResult
-	public func send(_ document: Document, caption: String? = nil, to receiver: Sendable,
-					 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.document(fileId: document.fileId, caption: caption)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func send(
+		_ document: Document, caption: String? = nil, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.document(fileId: document.fileId, caption: caption)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendDocument", payload: payload)
 	}
 
-
 	@discardableResult
-	public func send(_ video: Video, caption: String? = nil, to receiver: Sendable,
-					 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.video(fileId: video.fileId, caption: caption)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func send(
+		_ video: Video, caption: String? = nil, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.video(fileId: video.fileId, caption: caption)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendVideo", payload: payload)
 	}
 
 	@discardableResult
-	public func send(_ voice: Voice, caption: String? = nil, to receiver: Sendable,
-					 disableNotification: Bool? = nil,
-					 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .serverStoredContent(.voice(fileId: voice.fileId, caption: caption)),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func send(
+		_ voice: Voice, caption: String? = nil, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .serverStoredContent(.voice(fileId: voice.fileId, caption: caption)),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendVoice", payload: payload)
 	}
 
 	@discardableResult
-	public func sendLocation(latitude: Double, longitude: Double, to receiver: Sendable,
-							 disableNotification: Bool? = nil,
-							 replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .location(latitude: latitude, longitude: longitude),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func sendLocation(
+		latitude: Double, longitude: Double, to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .location(latitude: latitude, longitude: longitude),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendLocation", payload: payload)
 	}
 
 	@discardableResult
-	public func sendVenue(latitude: Double, longitude: Double,
-	                      title: String, address: String, foursquareId: String? = nil,
-	                      to receiver: Sendable,
-						  disableNotification: Bool? = nil,
-						  replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .venue(latitude: latitude, longitude: longitude, title: title, address: address, foursquareId: foursquareId),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func sendVenue(
+		latitude: Double, longitude: Double,
+		title: String, address: String, foursquareId: String? = nil,
+		to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .venue(
+				latitude: latitude, longitude: longitude,
+				title: title, address: address, foursquareId: foursquareId),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendVenue", payload: payload)
 	}
 
 	@discardableResult
-	public func sendContact(phoneNumber: String, firstName: String, lastName: String? = nil,
-	                        to receiver: Sendable,
-							disableNotification: Bool? = nil,
-							replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
-		let payload = SendingPayload(content: .contact(phoneNumber: phoneNumber, firstName: firstName, lastName: lastName),
-		                             chatId: receiver.chatId,
-		                             replyToMessageId: receiver.replyToMessageId,
-									 disableNotification: disableNotification,
-									 replyMarkup: nil)
+	public func sendContact(
+		phoneNumber: String, firstName: String, lastName: String? = nil,
+		to receiver: Sendable,
+		disableNotification: Bool? = nil,
+		replyMarkup: InlineKeyboardMarkup? = nil) throws -> Message {
+		let payload = SendingPayload(
+			content: .contact(phoneNumber: phoneNumber, firstName: firstName, lastName: lastName),
+			chatId: receiver.chatId,
+			replyToMessageId: receiver.replyToMessageId,
+			disableNotification: disableNotification,
+			replyMarkup: nil)
 		return try performRequest(ofMethod: "sendContact", payload: payload)
 	}
 
 	public func send(chatAction: ChatAction, toChat chatId: Int) throws {
-		let payload = SendingPayload(content: .chatAction(chatAction: chatAction),
-									 chatId: chatId, replyToMessageId: nil, disableNotification: nil,
-									 replyMarkup: nil)
+		let payload = SendingPayload(
+			content: .chatAction(chatAction: chatAction),
+			chatId: chatId, replyToMessageId: nil, disableNotification: nil,
+			replyMarkup: nil)
 		let _: Bool = try performRequest(ofMethod: "sendChatAction", payload: payload)
 	}
 
 	public func deleteMessage(inChat chatId: Int, messageId: Int) throws {
 		let _: Bool = try performRequest(ofMethod: "deleteMessage",
-							  payload: ["chat_id": chatId, "message_id": messageId])
+										 payload: ["chat_id": chatId, "message_id": messageId])
 	}
 
 	public func getFile(ofId fileId: String) throws -> File {

Sources/Sending.swift

@@ -69,6 +69,7 @@ struct SendingPayload: Encodable {
 
 	}
 
+	// swiftlint:disable cyclomatic_complexity
 	func encode(to encoder: Encoder) throws {
 		var container = encoder.container(keyedBy: CodingKeys.self)
 		try container.encode(chatId, forKey: .chatId)
@@ -115,7 +116,9 @@ struct SendingPayload: Encodable {
 		case .location(latitude: let latitude, longitude: let longitude):
 			try container.encode(latitude, forKey: .latitude)
 			try container.encode(longitude, forKey: .longitude)
-		case .venue(latitude: let latitude, longitude: let longitude, title: let title, address: let address, foursquareId: let foursquareId):
+		case .venue(
+			latitude: let latitude, longitude: let longitude, title: let title,
+			address: let address, foursquareId: let foursquareId):
 			try container.encode(latitude, forKey: .latitude)
 			try container.encode(longitude, forKey: .longitude)
 			try container.encode(title, forKey: .title)

Sources/Types.swift

@@ -118,7 +118,8 @@ public class Message: Codable {
 	public let pinnedMessage: Message?
 
 	private enum CodingKeys: String, CodingKey {
-		case date, chat, from, text, entities, audio, document, photo, sticker, video, voice, caption, contact, location, venue
+		case date, chat, from, text, entities
+		case audio, document, photo, sticker, video, voice, caption, contact, location, venue
 		case messageId = "message_id"
 		case forwardFrom = "forward_from"
 		case forwardFromChat = "forward_from_chat"

Sources/Utilities.swift

@@ -42,15 +42,15 @@ public enum Result<T>: Decodable where T: Decodable {
 			case false:
 				self = .failure(Error.telegram(try container.decode(String.self, forKey: .description)))
 			}
-		} catch(let error) {
+		} catch {
 			self = .failure(error)
 		}
 	}
 
 	static func decode(from data: Data) -> Result {
 		do {
 			return try JSONDecoder().decode(Result.self, from: data)
-		} catch(let error) {
+		} catch {
 			return .failure(error)
 		}
 	}