Add new utility fns for dealing with bot tokens

Author: marksto

src/marksto/clj_tg_bot_api/impl/client/core.clj

@@ -9,6 +9,7 @@
             [marksto.clj-tg-bot-api.impl.api.martian :as api-martian]
             [marksto.clj-tg-bot-api.impl.client.rate-limiter :as rl]
             [marksto.clj-tg-bot-api.impl.utils :as utils]
+            [marksto.clj-tg-bot-api.impl.utils.bot :as bot]
             [marksto.clj-tg-bot-api.impl.utils.response :as response])
   (:import (java.io Writer)))
 
@@ -39,12 +40,6 @@
 
 (def global-server-url "https://api.telegram.org/bot")
 
-(defn parse-bot-id [bot-token]
-  (try
-    (parse-long (subs bot-token 0 (str/index-of bot-token \:)))
-    (catch Exception ex
-      (throw (ex-info "Failed to parse an ID from the bot auth token" {} ex)))))
-
 (defn ->client
   [{:keys [bot-token server-url responses limiter-opts interceptors]
     :or   {server-url   global-server-url
@@ -60,7 +55,7 @@
               (-> (mt/respond-with responses)
                   ;; TODO: Drop this temp patch when Martian PR #243 is merged.
                   (update :interceptors vec)))
-      (assoc :bot-id (parse-bot-id bot-token)
+      (assoc :bot-id (bot/parse-bot-id bot-token)
              :limiter-opts limiter-opts)
       (with-meta {:type ::tg-bot-api-client})))
 

src/marksto/clj_tg_bot_api/impl/utils/bot.clj

@@ -0,0 +1,13 @@
+(ns marksto.clj-tg-bot-api.impl.utils.bot
+  (:require [clojure.string :as str]))
+
+(defn parse-bot-id
+  [bot-token]
+  (try
+    (parse-long (subs bot-token 0 (str/index-of bot-token \:)))
+    (catch Exception ex
+      (throw (ex-info "Failed to parse an ID from the bot auth token" {} ex)))))
+
+(defn mask-bot-token
+  [bot-token mask-str]
+  (str (parse-bot-id bot-token) \: mask-str))

src/marksto/clj_tg_bot_api/utils.clj

@@ -1,9 +1,25 @@
 (ns marksto.clj-tg-bot-api.utils
   "Some utilities for Telegram Bot API types, updates and responses"
-  (:require [marksto.clj-tg-bot-api.impl.utils.types :as types]
+  (:require [marksto.clj-tg-bot-api.impl.utils.bot :as bot]
+            [marksto.clj-tg-bot-api.impl.utils.types :as types]
             [marksto.clj-tg-bot-api.impl.utils.update :as update]
             [marksto.clj-tg-bot-api.impl.utils.response :as response]))
 
+;;;; BOT
+
+(defn parse-bot-id
+  "Retrieves a Telegram Bot ID from a plain `bot-token` string.
+   Useful during tests, e.g. when mocking the Telegram Bot API."
+  [bot-token]
+  (bot/parse-bot-id bot-token))
+
+(defn mask-bot-token
+  "Masks the sensitive portion of the given `bot-token` string."
+  ([bot-token]
+   (bot/mask-bot-token bot-token "..."))
+  ([bot-token mask-str]
+   (bot/mask-bot-token bot-token mask-str)))
+
 ;;;; TYPES
 
 ;;; Date/Time

test/integration/marksto/clj_tg_bot_api/core_i9n_test.clj

@@ -2,7 +2,7 @@
   (:require [clojure.string :as str]
             [clojure.test :refer [deftest is testing use-fixtures]]
             [marksto.clj-tg-bot-api.core :as sut]
-            [marksto.clj-tg-bot-api.impl.client.core :as client]
+            [marksto.clj-tg-bot-api.utils :as utils]
             [marksto.clj-tg-bot-api.impl.api.martian :as api-martian]
             [marksto.clj-tg-bot-api.net-utils :as net-utils]
             [marksto.clj-tg-bot-api.vcr-utils :as vcr-utils]
@@ -11,10 +11,10 @@
 
 (def real-bot-token (or (System/getenv "BOT_AUTH_TOKEN")
                         (throw (ex-info "Missing BOT_AUTH_TOKEN env var" {}))))
-(def real-bot-id (client/parse-bot-id real-bot-token))
+(def real-bot-id (utils/parse-bot-id real-bot-token))
 
 (def fake-bot-token "1234567890:TEST_pxWA8lDi7uLc3oadqNivHCALHBQ7sM")
-(def fake-bot-id (client/parse-bot-id fake-bot-token))
+(def fake-bot-id (utils/parse-bot-id fake-bot-token))
 
 (def replacements
   [[:string-val real-bot-token fake-bot-token]