Merge pull request #15 from johnspade/methods-fabric

Use the Methods fabric

Author: johnspade

README.md

@@ -15,7 +15,7 @@ Currently the following backends are supported:
 - circe
 - uPickle (MsgPack binary serialization, to be used for storing API messages in DB and sending over network)
 
-You may want to start with [Api.scala](telegramium-core/src/main/scala/telegramium/bots/client/Api.scala) and [EchoBot.scala](telegramium-examples/src/main/scala/telegramium/bots/examples/EchoBot.scala).
+You may want to start with [Methods.scala](telegramium-core/src/main/scala/telegramium/bots/client/Methods.scala) and [EchoBot.scala](telegramium-examples/src/main/scala/telegramium/bots/examples/EchoBot.scala).
 
 ### How to use
 Create the dependency by adding the following lines to your build.sbt:
@@ -25,6 +25,47 @@ libraryDependencies += "io.github.apimorphism" %% "telegramium-core" % "1.49.0"
 libraryDependencies += "io.github.apimorphism" %% "telegramium-high" % "1.49.0"
 ```
 
+Imports:
+```scala
+import telegramium.bots.high._
+import telegramium.bots.high.implicits._
+```
+
+Use the `Methods` fabric to create requests. You will need an instance of the `BotApi` class to execute them:
+```scala
+BlazeClientBuilder[F](ExecutionContext.global).resource.use { httpClient =>
+  implicit val api: Api[F] = BotApi(http, baseUrl = s"https://api.telegram.org/bot$token")
+  val bot = new MyLongPollBot()
+  bot.start()
+}
+```
+
+#### Long polling
+```scala
+class MyLongPollBot[F[_]: Sync: Timer]()(implicit api: Api[F]) extends LongPollBot[F](api) {
+  override def onMessage(msg: Message): F[Unit] =
+    Methods.sendMessage(chatId = ChatIntId(msg.chat.id), text = "Hello, world!").exec.void
+}
+```
+
+`LongPollBot` and `WebhookBot` extend the `Methods` trait so you can call `sendMessage` directly.
+
+#### Webhooks
+```scala
+class MyWebhookBot[F[_]: ConcurrentEffect: ContextShift: Timer](port: Int, url: String, path: String)(
+  implicit api: Api[F]
+) extends WebhookBot[F](api, port, url, path) {
+  override def onMessage(msg: Message): F[Unit] =
+    sendMessage(chatId = ChatIntId(msg.chat.id), text = "Hello, world!").exec.void
+}
+```
+
+You can also perform a request to the Bot API while [sending an answer to the webhook](https://core.telegram.org/bots/api#making-requests-when-getting-updates):
+```scala
+override def onMessageReply(msg: Message): F[Option[Method[_]]] =
+  Sync[F].pure(Some(sendMessage(chatId = ChatIntId(msg.chat.id), text = "Hello, world!")))
+```
+
 ### Versioning
 
 X.Y.Z where

build.sbt

@@ -57,7 +57,7 @@ lazy val `telegramium-core` = project
 lazy val `telegramium-high` = project
   .dependsOn(`telegramium-core`)
   .settings(settings: _*)
-  .settings(libraryDependencies ++= Dependencies.telegramiumCore)
+  .settings(libraryDependencies ++= Dependencies.telegramiumHigh)
 
 lazy val `telegramium-examples` = project
   .dependsOn(

project/Dependencies.scala

@@ -3,49 +3,62 @@ import sbt._
 object Dependencies {
 
   object V {
-    val monix      = "3.1.0"
-    val catsCore   = "2.1.1"
+    val monix = "3.1.0"
+    val catsCore = "2.1.1"
     val catsEffect = "2.1.3"
-    val circe      = "0.13.0"
-    val http4s     = "0.21.3"
-    val slf4j      = "1.7.26"
-    val logback    = "1.2.3"
-    val uPickle    = "0.8.0"
+    val circe = "0.13.0"
+    val http4s = "0.21.3"
+    val slf4j = "1.7.26"
+    val logback = "1.2.3"
+    val uPickle = "0.8.0"
+    val scalatest = "3.2.0"
+    val testcontainers = "0.37.0"
+    val mockServerClient = "5.10.0"
+    val scalamock = "4.4.0"
   }
 
-  val monix      = "io.monix" %% "monix" % V.monix
-  val catsCore   = "org.typelevel" %% "cats-core" % V.catsCore
+  val monix = "io.monix" %% "monix" % V.monix
+  val catsCore = "org.typelevel" %% "cats-core" % V.catsCore
   val catsEffect = "org.typelevel" %% "cats-effect" % V.catsEffect
+  val scalatest = "org.scalatest" %% "scalatest" % V.scalatest % Test
+  val scalamock = "org.scalamock" %% "scalamock" % V.scalamock % Test
 
   val circe = Seq(
     "io.circe" %% "circe-core"           % V.circe,
-    "io.circe" %% "circe-parser"         % V.circe,
+    "io.circe" %% "circe-parser"         % V.circe
   )
 
-  val http4s = Seq(
-    "org.http4s" %% "http4s-dsl"          % V.http4s,
+  val http4sClient = Seq(
     "org.http4s" %% "http4s-circe"        % V.http4s,
-    "org.http4s" %% "http4s-blaze-server" % V.http4s,
-    "org.http4s" %% "http4s-blaze-client" % V.http4s,
+    "org.http4s" %% "http4s-blaze-client" % V.http4s
+  )
+
+  val http4sServer = Seq(
+    "org.http4s" %% "http4s-dsl"          % V.http4s,
+    "org.http4s" %% "http4s-blaze-server" % V.http4s
   )
 
   val logger = Seq(
     "org.slf4j"      % "slf4j-api"       % V.slf4j,
     "org.slf4j"      % "slf4j-simple"    % V.slf4j,
-    "ch.qos.logback" % "logback-classic" % V.logback,
+    "ch.qos.logback" % "logback-classic" % V.logback
   )
 
   val uPickle = Seq(
     "com.lihaoyi" %% "upickle" % V.uPickle,
-    "com.lihaoyi" %% "upack" % V.uPickle,
+    "com.lihaoyi" %% "upack" % V.uPickle
+  )
+
+  val testcontainers = Seq(
+    "com.dimafeng" %% "testcontainers-scala-scalatest" % V.testcontainers % Test,
+    "com.dimafeng" %% "testcontainers-scala-mockserver" % V.testcontainers % Test,
+    "org.mock-server" % "mockserver-client-java" % V.mockServerClient % Test
   )
 
-  val common = Seq(
-    catsCore,
-    catsEffect,
-  ) ++ circe ++ http4s ++ uPickle
+  val common: Seq[ModuleID] = Seq(catsCore) ++ circe ++ uPickle
 
   val telegramiumCore: Seq[ModuleID] = common
-  val telegramiumHigh: Seq[ModuleID] = common
-  val telegramiumExam: Seq[ModuleID] = common ++ logger ++ Seq(monix)
+  val telegramiumHigh: Seq[ModuleID] = common ++ Seq(catsEffect, monix % Test, scalatest, scalamock) ++ http4sServer ++
+    http4sClient ++ testcontainers ++ logger
+  val telegramiumExam: Seq[ModuleID] = common ++ logger ++ Seq(catsEffect, monix) ++ http4sClient
 }