better way (maybe) to send message and other documemts

Author: ba0f3

README.md

@@ -1,6 +1,11 @@
 # telebot.nim
 Async Telegram Bot API Client implement in @Nim-Lang
 
+Notes
+=====
+From version 1.0.0, procs likes `newMessage`, `newPhoto`,.. are gone, use `sendMessage`, `sendDocument` instead.
+If you still prefer the old/ugly way to send stuffs, just import `telebot/compat` for backward compatible
+
 Installation
 ============
 ```
@@ -13,23 +18,23 @@ Usage
 ## echo bot
 ```nim
 import telebot, asyncdispatch, logging, options
+var L = newConsoleLogger(fmtStr="$levelname, [$time] ")
+addHandler(L)
 
 const API_KEY = slurp("secret.key")
 
 proc updateHandler(b: Telebot, u: Update) {.async.} =
+  if not u.message.isSome:
+    return
   var response = u.message.get
   if response.text.isSome:
-    let
-      text = response.text.get
-    var message = newMessage(response.chat.id, text)
-    message.disableNotification = true
-    message.replyToMessageId = response.messageId
-    message.parseMode = "markdown"
-    discard await b.send(message)
+    let text = response.text.get
+    discard await b.sendMessage(response.chat.id, text, parseMode = "markdown", disableNotification = true, replyToMessageId = response.messageId)
 
 let bot = newTeleBot(API_KEY)
 bot.onUpdate(updateHandler)
 bot.poll(timeout=300)
+
 ```
 
 ## send local photo
@@ -39,15 +44,9 @@ import telebot, asyncdispatch, options, logging
 const API_KEY = slurp("secret.key")
 
 proc updateHandler(bot: TeleBot, update: Update): UpdateCallback =
-  var response = update.message.get
-  if response.text.isSome:
-    let
-      text = response.text.get
-    var message = newPhoto(response.chat.id, "file:///path/to/photo.jpg")
-    discard await bot.send(message)
+  discard await bot.sendPhoto(response.chat.id, "file:///path/to/photo.jpg")
 
-let
-  bot = newTeleBot(API_KEY)
+let bot = newTeleBot(API_KEY)
 bot.onUpdate(updateHandler)
 bot.poll(timeout=300)
 ```

examples/config.nims

@@ -0,0 +1 @@
+switch("path", "../src")

examples/echo_bot.nim

@@ -1,4 +1,4 @@
-import ../telebot, asyncdispatch, logging, options
+import telebot, asyncdispatch, logging, options
 from strutils import strip
 
 var L = newConsoleLogger(fmtStr="$levelname, [$time] ")
@@ -12,11 +12,7 @@ proc updateHandler(b: Telebot, u: Update) {.async.} =
   var response = u.message.get
   if response.text.isSome:
     let text = response.text.get
-    var message = newMessage(response.chat.id, text)
-    message.disableNotification = true
-    message.replyToMessageId = response.messageId
-    message.parseMode = "markdown"
-    discard await b.send(message)
+    discard await b.sendMessage(response.chat.id, text, parseMode = "markdown", disableNotification = true, replyToMessageId = response.messageId)
 
 
 proc greatingHandler(b: Telebot, c: Command) {.async.} =

examples/echo_bot_with_proxy.nim

@@ -1,4 +1,4 @@
-import ../telebot, asyncdispatch, logging, options
+import telebot, asyncdispatch, logging, options
 from strutils import strip
 
 var L = newConsoleLogger(fmtStr="$levelname, [$time] ")
@@ -9,21 +9,11 @@ const API_KEY = slurp("secret.key").strip()
 proc updateHandler(b: Telebot, u: Update) {.async.} =
   var response = u.message.get
   if response.text.isSome:
-    let
-      text = response.text.get
-    var message = newMessage(response.chat.id, text)
-    message.disableNotification = true
-    message.replyToMessageId = response.messageId
-    message.parseMode = "markdown"
-    discard await b.send(message)
+    discard await b.sendMessage(response.chat.id, response.text.get)
 
 
 proc greatingHandler(b: Telebot, c: Command) {.async.} =
-  var message = newMessage(c.message.chat.id, "hello " & c.message.fromUser.get().firstName)
-  message.disableNotification = true
-  message.replyToMessageId = c.message.messageId
-  message.parseMode = "markdown"
-  discard b.send(message)
+  discard b.sendMessage(c.message.chat.id, "hello " & c.message.fromUser.get().firstName)
 
 when isMainModule:
   let bot = newTeleBot(API_KEY)

examples/file_receive_bot/file_receive_bot.nim

@@ -23,11 +23,9 @@ proc updateHandler(bot: TeleBot, e: Update) {.async.} =
       responx = await newAsyncHttpClient().get(api_file & file_path)  # file_path > file
       file_content = await responx.body
       msg0_text = fmt"file_name: {file_name}, mime_type: {mime_type}, file_id: {file_id}, file_size: {file_size}, file_path: {file_path}"
-    var
-      message0 = newMessage(response.chat.id, msg0_text)    # metadata
-      message1 = newMessage(response.chat.id, file_content) # file contents
-    discard await bot.send(message0)
-    discard await bot.send(message1)
+
+    discard await bot.sendMessage(response.chat.id, msg0_text)
+    discard await bot.sendMessage(response.chat.id, file_content)
 
 let bot = newTeleBot(API_KEY)
 

examples/file_send_bot/file_send_bot.nim

@@ -1,15 +1,12 @@
 # This Bot Sends itself as Document file, responds on chat with source file to download.
 import telebot, asyncdispatch, options, os
 
-const API_KEY = slurp("secret.key")
+const API_KEY = slurp("../secret.key")
 
 
 proc updateHandler(bot: TeleBot, e: Update) {.async.} =
-  let this_file = "file://" & getCurrentDir() & "/file_send_bot.nim"
-
-  var document = newDocument(e.message.get.chat.id, this_file)
-  document.caption = this_file
-  discard await bot.send(document)
+  let this_file = "file://" & getAppDir() & "/file_send_bot.nim"
+  discard await bot.sendDocument(e.message.get.chat.id, this_file, caption = this_file)
 
 let bot = newTeleBot(API_KEY)
 bot.onUpdate(updateHandler)

examples/geo_location_bot/geo_bot.nim

@@ -1,10 +1,9 @@
 import telebot, asyncdispatch, options
 
-const API_KEY = slurp("secret.key")
+const API_KEY = slurp("../secret.key")
 
 proc geoHandler(bot: TeleBot, e: Command) {.async.} =
-  let message = newLocation(e.message.chat.id, longitude=42.0, latitude=42.0)
-  discard await bot.send(message)
+  discard await bot.sendLocation(e.message.chat.id, longitude=42.0, latitude=42.0)
 
 let bot = newTeleBot(API_KEY)
 bot.onCommand("geo", geoHandler)  # Use /geo on Telegram chat to trigger.

examples/inline_keyboard.nim

@@ -1,21 +1,17 @@
-import ../telebot, asyncdispatch, logging, options
+import telebot, asyncdispatch, logging, options
 from strutils import strip
 
 var L = newConsoleLogger()
 addHandler(L)
 
 const API_KEY = slurp("secret.key").strip()
 
-var updates: seq[Update]
-
-
 proc updateHandler(bot: TeleBot, e: Update) {.async.} =
   var response = e.message.get
   if response.text.isSome:
     let
       text = response.text.get
     var
-      message = newMessage(response.chat.id, text)
       google = initInlineKeyboardButton("Google")
       bing = initInlineKeyboardButton("Bing")
       ddg = initInlineKeyboardButton("DuckDuckGo")
@@ -26,8 +22,9 @@ proc updateHandler(bot: TeleBot, e: Update) {.async.} =
     ddg.url = some("https://duckduckgo.com/?q=" & text)
     searx.url = some("https://searx.me/?q=" & text)
 
-    message.replyMarkup = newInlineKeyboardMarkup(@[google, bing], @[ddg, searx])
-    discard await bot.send(message)
+    let replyMarkup = newInlineKeyboardMarkup(@[google, bing], @[ddg, searx])
+
+    discard await bot.sendMessage(response.chat.id, text, replyMarkup = replyMarkup)
 
 when isMainModule:
   let bot = newTeleBot(API_KEY)

examples/photo_send_bot/photo_send_bot.nim

@@ -1,14 +1,13 @@
 import telebot, asyncdispatch, options, logging, os
 
 
-const API_KEY = slurp("secret.key")
+const API_KEY = slurp("../secret.key")
 
 
 addHandler(newConsoleLogger(fmtStr="$levelname, [$time] "))
 
 proc updateHandler(bot: TeleBot, e: Update) {.async.} =
-  let message = newPhoto(e.message.get.chat.id, "file://" & getCurrentDir() & "/sample.jpg")
-  discard await bot.send(message)
+  discard await bot.sendPhoto(e.message.get.chat.id, "file://" & getAppDir() & "/sample.jpg")
 
 let bot = newTeleBot(API_KEY)
 

examples/seamless_bot.nim

@@ -1,4 +1,4 @@
-import ../telebot, asyncdispatch, logging, options, sam, telebot/utils
+import telebot, asyncdispatch, logging, options
 from strutils import strip
 
 var L = newConsoleLogger(fmtStr="$levelname, [$time] ")
@@ -12,16 +12,13 @@ const API_KEY = slurp("secret.key").strip()
 ]#
 
 proc loginHandler(b: Telebot, c: Command) {.async.} =
-    var
-      message = newMessage(c.message.chat.id, "Welcome to Seamless Web Bots")
-      loginButton = initInlineKeyBoardButton("Login")
-    loginButton.loginUrl = some(newLoginUrl("https://huy.im"))
-    message.replyMarkup = newInlineKeyboardMarkup(@[loginButton])
-    discard await b.send(message)
+  var loginButton = initInlineKeyBoardButton("Login")
+  loginButton.loginUrl = some(newLoginUrl("https://huy.im"))
+  discard await b.sendMessage(c.message.chat.id, "Welcome to Seamless Web Bots", replyMarkup = newInlineKeyboardMarkup(@[loginButton]))
 
 
 when isMainModule:
-    let bot = newTeleBot(API_KEY)
+  let bot = newTeleBot(API_KEY)
 
-    bot.onCommand("login", loginHandler)
-    bot.poll(timeout=300)
+  bot.onCommand("login", loginHandler)
+  bot.poll(timeout=300)

examples/set_chat_permissions.nim

@@ -0,0 +1,29 @@
+import ../telebot, asyncdispatch, logging, options, sam
+from strutils import strip
+
+import ../telebot/utils
+
+var L = newConsoleLogger(fmtStr="$levelname, [$time] ")
+addHandler(L)
+
+const API_KEY = slurp("secret.key").strip()
+
+proc commandHandler(b: Telebot, c: Command) {.async.} =
+  let perms = ChatPermissions(
+    canSendMessages: some(true),
+    canSendMediaMessages: some(true),
+    canSendOtherMessages: some(true),
+    canAddWebPagePreviews: some(true))
+
+  var json  = ""
+  marshal(perms, json)
+  echo json
+  discard await restrictChatMember(b, $c.message.chat.id, 50535480, perms)
+
+  discard await getChatMember(b, $c.message.chat.id, 50535480)
+
+
+when isMainModule:
+  let bot = newTeleBot(API_KEY)
+  bot.onCommand("perms", commandHandler)
+  bot.poll(timeout=300)

examples/webhook_simple.nim

@@ -1,4 +1,4 @@
-import ../telebot, asyncdispatch, logging, options, sam
+import telebot, asyncdispatch, logging, options, sam
 from strutils import strip
 
 var L = newConsoleLogger(fmtStr="$levelname, [$time] ")
@@ -11,20 +11,11 @@ proc updateHandler(b: Telebot, u: Update) {.async.} =
     return
   var response = u.message.get
   if response.text.isSome:
-    let text = response.text.get
-    var message = newMessage(response.chat.id, text)
-    message.disableNotification = true
-    message.replyToMessageId = response.messageId
-    message.parseMode = "markdown"
-    discard await b.send(message)
+    discard b.sendMessage(response.chat.id, response.text.get, disableNotification = true, replyToMessageId = response.messageId, parseMode = "markdown")
 
 
 proc greatingHandler(b: Telebot, c: Command) {.async.} =
-  var message = newMessage(c.message.chat.id, "hello " & c.message.fromUser.get().firstName)
-  message.disableNotification = true
-  message.replyToMessageId = c.message.messageId
-  message.parseMode = "markdown"
-  discard b.send(message)
+  discard b.sendMessage(c.message.chat.id, "hello " & c.message.fromUser.get().firstName, disableNotification = true, replyToMessageId = c.message.messageId, parseMode = "markdown")
 
 when isMainModule:
   let bot = newTeleBot(API_KEY)

telebot.nim renamed to src/telebot.nim

@@ -1,6 +1,6 @@
 import tables, httpclient
 
-import telebot/[types, keyboard, webhook, inputmedia, helpers]
+import telebot/private/[types, keyboard, webhook, inputmedia, helpers]
 export types, webhook, keyboard, inputmedia, helpers
 
 proc setProxy*(b: Telebot, url: string, auth = "") {.inline.} =
@@ -12,5 +12,5 @@ proc newTeleBot*(token: string): TeleBot =
   result.token = token
   result.commandCallbacks = newTable[string, seq[CommandCallback]]()
 
-include telebot/api
-include telebot/events
+include telebot/private/api
+include telebot/private/events