te_bot 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf6752512a52e78b548544788d5a92b93d5024c6a2c4f51e94c214515162b7b2
-  data.tar.gz: 070aac9bbc7ba3b362e4a4c7b2b69bb5bd8640dd78ee8e99bc9ecc7b27f2528f
+  metadata.gz: 6fa39962791458ebf9b8cd56bc4de36445e2fc5bbcdef2f360e12963cf970fc0
+  data.tar.gz: d774066a9e4d7a2608371de89444a16e8a9b7cd52842fa7e38bb9406b5f1a9f4
 SHA512:
-  metadata.gz: f9bef1be0f891861390692b4ba0ebb3c50f0ce9eeb07d3d686c21510f488a47eba422dbbcdafda0273be661ceb62c96a3c365641789392310b05fd04e971cb88
-  data.tar.gz: eeec9a81680b40c8c7e9ced4813e772f473892df59c0820526b1fe16800d3926c6c715eca85546e4ad261021417b7edd3424de0c3c18b2b7e752f9d7a34b7650
+  metadata.gz: 5d9afb6cb164d7811dd2459313f703e0c84b639b5194f521ae7938d2a0474af011fcd7ae1cc5054b009d67717a7cec0da0da4053f591fc9599c43120246933ee
+  data.tar.gz: 7006934fa7a9652e3acc61a37bd80de279a2662d36aee1f0638a433e7a64a2fa3140e93850ed58b1a3a59f2d413589409cef2b4512d0ce18acf693b4f2735752

data/CHANGELOG.md

@@ -12,8 +12,15 @@
 - Change the implementation message replier from `reply(conn, message_string)` to `conn.reply text: message_string`.
 - Add support for other message types such as audio, video, animation, markdown, and document
 
-## [Unreleased]
+## [Released]
 
 ## [0.3.0] - 2022-07-02
 
-- Support for the handler to return response direcly by returning rack array or hash.
+- Support for the handler to return response direcly by returning rack array or hash.
+
+
+## [Unreleased]
+
+## [0.3.1] - 2022-07-03
+
+- Support for helpers with `helpers` macro

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    te_bot (0.3.0)
+    te_bot (0.4.0)
       faraday (~> 2.3)
       rack (~> 2.2)
 
@@ -14,10 +14,10 @@ GEM
     byebug (11.1.3)
     crack (0.4.5)
       rexml
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+    faraday-net_http (3.0.0)
     hashdiff (1.0.1)
     minitest (5.16.1)
     parallel (1.22.1)

data/README.md

@@ -10,7 +10,7 @@ This gem is used to handle telegram webhook and sending message with telegram bo
 
 Install the gem and add to the application's Gemfile
 
-    gem 'te_bot', '~> 0.3.0'
+    gem 'te_bot'
 
 Then run
 
@@ -33,12 +33,12 @@ require "te_bot/sender_options"
 class MyWebhookApp < TeBot::Court
   access_token ENV["YOUR_BOT_ACCESS_TOKEN"]
     
-  command("/start") do |conn|
-    conn.reply text: "Welcome aboard my friend!"
+  command("/start") do
+    reply text: "Welcome aboard my friend!"
   end
     
-  command("/today") do |conn|
-    conn.reply text: Time.now.to_s
+  command("/today") do
+    reply text: Time.now.to_s
   end
 end
 ```
@@ -63,7 +63,7 @@ To run the app we can use rackup
 For more detailed information about rack please visit [Rack Repository](https://github.com/rack/rack).
 
 Now, our `MyWebhookApp` class is ready to handle some commands from telegram bot which are `/start` and `/today`.
-The command aslo support argument that will be passed to the `#command` block as `conn.params`. To pass arguments, we can simply type `/today city:Jakarta limit:10`. The argument will be parsed as a Hash with string key => `{"city" => "Jakarta", "limit" => "10"}`. While the parameter `conn` is the message object which contains the full message including the chat_id to repy to.
+The command aslo support argument that will be passed in the instance method `params`. To pass arguments, we can simply type `/today city:Jakarta limit:10`. The argument will be parsed as a Hash with string key => `{"city" => "Jakarta", "limit" => "10"}`.
 
 To add a default handler for non existing command we can use the `#default_command` macro.
 
@@ -71,21 +71,23 @@ To add a default handler for non existing command we can use the `#default_comma
 # app.rb
 
 class MyWebhookApp < TeBot::Court
-  default_command do |conn|
-    conn.reply text: "Sorry, Comand not found. Try another command. or type /help"
+  default_command do
+    reply text: "Sorry, Comand not found. Try another command. or type /help"
   end
 end
 ```
 
-Other type of messages are also supported by using this macros `text` for regular text message, `query`, `document`, `audio`, and `voice`. For more detail please check this [Telegram Docs](https://core.telegram.org/bots/webhooks#testing-your-bot-with-updates). These macros is only expecting `conn` as an argument.
+All the messages are passed in the instance method `message`
+
+Other type of messages are also supported by using this macros `text` for regular text message, `query`, `document`, `audio`, and `voice`. For more detail please check this [Telegram Docs](https://core.telegram.org/bots/webhooks#testing-your-bot-with-updates).
 
 ```rb
 # app.rb
 
 class MyWebhookApp < TeBot::Court
-  text do |conn|
-    message = do_some_fancy_stuff_here(conn)
-    conn.reply text: message
+  text do
+    reply_message = do_some_fancy_stuff_here(message)
+    reply text: reply_message
   end
 end
 ```
@@ -95,8 +97,8 @@ And also we can define a macro for default action `#default_action` if the reque
 # app.rb
 
 class MyWebhookApp < TeBot::Court
-  default_action do |conn|
-    conn.reply text: "No, I can't talk like people. use command instead"
+  default_action do
+    reply text: "No, I can't talk like people. use command instead"
   end
 end
 ```
@@ -132,17 +134,74 @@ sender.send_message(chat_id, animation: { animation: url, caption: caption})
 
 ```
 
-For markdown telegram supports MArkdownV2 [refer to this](https://core.telegram.org/bots/api#markdownv2-style)
+For markdown telegram supports MarkdownV2 [refer to this](https://core.telegram.org/bots/api#markdownv2-style)
 Please check the [documentation](https://core.telegram.org/bots/api#sendmessage) for more details.
 
+### Custom Handler
+
 Of course you can add more handler by extending the `TeBot::Wire` class
 
 ```ruby
 # in/your/custom_handler.rb
 
 TeBot::Wire.class_eval do
-  sender :json do |conn, chat_id, message|
-    conn.make_request("sendMessage", body: { chat_id: chat_id, json: message }.to_json)
+  sender :json do |chat_id, message|
+    make_request("sendMessage", body: { chat_id: chat_id, json: message }.to_json)
+  end
+end
+```
+
+### Helpers
+
+Using module
+```ruby
+# request_helpers.rb
+
+module RequestHelpers
+  def get_nearest_hospitals
+    # do some fancy stuff
+  end
+
+  def get_the_nearest_routes(hospitals)
+    # do some even fancier stuff
+  end 
+
+  def render_markdown(routes)
+    # do something else
+  end
+end
+
+class MyWebhookApp < TeBot::Court
+  include RequestHelpers
+
+  #... the rest of the code
+end
+
+```
+
+Using instance methods
+```ruby
+
+# app.rb
+
+class MyWebhookApp < TeBot::Court
+  command("/findhospital") do
+    hospitals = get_nearest_hospitals(params)
+    routes = get_the_nearest_routes(hospitals)
+
+    reply markdown: render_markdown(routes)
+  end
+
+  def get_nearest_hospitals(data)
+    # do some fancy stuff
+  end
+
+  def get_the_nearest_routes(hospitals)
+    # do some even fancier stuff
+  end 
+
+  def render_markdown(routes)
+    # do something else
   end
 end
 ```

data/lib/te_bot/cable.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
 module TeBot
-  class Cable
-    attr_reader :message, :params
-    def initialize(wire, message, params = {})
-      @wire = wire
-      @message = message
-      @params = params
-    end
-
+  module Cable
     def chat_id
-      @message.data&.chat_id
+      message.data&.chat_id
     end
 
     def reply(**payload)
       return if chat_id.nil?
 
-      @wire.send_message chat_id, **payload
+      wire.send_message chat_id, **payload
     end
   end
 end

data/lib/te_bot/court.rb

@@ -5,6 +5,8 @@ require "json"
 
 module TeBot
   class Court
+    include TeBot::Cable
+
     class << self
       attr_reader :wire, :commands
 
@@ -43,6 +45,15 @@ module TeBot
       end
     end
 
+    attr_reader :params, :message, :wire
+
+    def initialize
+      @params = {}
+      @message = nil
+      @command = nil
+      @wire = self.class.wire
+    end
+
     def call(env)
       json_only(env) do |body|
         response = handle_request(body)
@@ -76,33 +87,34 @@ module TeBot
     end
 
     def handle_request(body)
-      message = ::TeBot::Message.new(body)
+      @message = ::TeBot::Message.new(body)
+
+      @command, @params = @message.data&.content&.parse
 
-      command, params = message.data&.content&.parse
-      conn = ::TeBot::Cable.new(self.class.wire, message, params || {})
+      @params = params
 
-      message.command do
-        handler = self.class.commands[command]
+      @message.command do
+        handler = self.class.commands[@command]
         if handler.respond_to?(:call)
-          handler.call(conn)
+          instance_eval(&handler)
         elsif self.class.default_command.respond_to?(:call)
-          self.class.default_command.call(conn)
+          instance_eval(&self.class.default_command)
         end
       end
 
       ::TeBot::Message::GENERAL_MESSAGE_TYPES.each do |message_type|
-        message.public_send(message_type) do
+        @message.public_send(message_type) do
           handler = self.class.message_handlers(message_type)
 
           next unless handler.respond_to?(:call)
-          handler.call(conn)
+          instance_eval(&handler)
         end
       end
 
-      if message.handler.respond_to?(:call)
-        message.call
+      if @message.handler.respond_to?(:call)
+        instance_eval(&@message.handler)
       elsif self.class.default_action.respond_to?(:call)
-        self.class.default_action.call(conn)
+        instance_eval(&self.class.default_action)
       end
     end
   end

data/lib/te_bot/sender_options.rb

@@ -2,36 +2,36 @@ require_relative "./wire"
 require "json"
 
 TeBot::Wire.class_eval do
-  sender :text do |conn, chat_id, message|
-    conn.make_request("sendMessage", body: {chat_id: chat_id, text: message}.to_json)
+  sender :text do |chat_id, message|
+    make_request("sendMessage", body: {chat_id: chat_id, text: message}.to_json)
   end
 
   # this is using MarkdownV2 https://core.telegram.org/bots/api#markdownv2-style
-  sender :markdown do |conn, chat_id, message|
-    conn.make_request("sendMessage", body: {chat_id: chat_id, text: message, parse_mode: "MarkdownV2"}.to_json)
+  sender :markdown do |chat_id, message|
+    make_request("sendMessage", body: {chat_id: chat_id, text: message, parse_mode: "MarkdownV2"}.to_json)
   end
 
-  sender :photo do |conn, chat_id, message|
-    conn.make_request("sendPhoto", body: message.merge({chat_id: chat_id}).to_json)
+  sender :photo do |chat_id, message|
+    make_request("sendPhoto", body: message.merge({chat_id: chat_id}).to_json)
   end
 
-  sender :audio do |conn, chat_id, message|
-    conn.make_request("sendAudio", body: message.merge({chat_id: chat_id}).to_json)
+  sender :audio do |chat_id, message|
+    make_request("sendAudio", body: message.merge({chat_id: chat_id}).to_json)
   end
 
-  sender :document do |conn, chat_id, message|
-    conn.make_request("sendDocument", body: message.merge({chat_id: chat_id}).to_json)
+  sender :document do |chat_id, message|
+    make_request("sendDocument", body: message.merge({chat_id: chat_id}).to_json)
   end
 
-  sender :video do |conn, chat_id, message|
-    conn.make_request("sendVideo", body: message.merge({chat_id: chat_id}).to_json)
+  sender :video do |chat_id, message|
+    make_request("sendVideo", body: message.merge({chat_id: chat_id}).to_json)
   end
 
-  sender :animation do |conn, chat_id, message|
-    conn.make_request("sendAnimation", body: message.merge({chat_id: chat_id}).to_json)
+  sender :animation do |chat_id, message|
+    make_request("sendAnimation", body: message.merge({chat_id: chat_id}).to_json)
   end
 
-  sender :voice do |conn, chat_id, message|
-    conn.make_request("sendVoice", body: message.merge({chat_id: chat_id}).to_json)
+  sender :voice do |chat_id, message|
+    make_request("sendVoice", body: message.merge({chat_id: chat_id}).to_json)
   end
 end

data/lib/te_bot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TeBot
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/te_bot/wire.rb

@@ -43,7 +43,7 @@ module TeBot
 
       raise ArgumentError, "Message type invalid. sender :#{message_format} not defined" if handler.nil?
 
-      return handler.call(self, chat_id, message) if handler.respond_to?(:call)
+      return instance_exec(chat_id, message, &handler) if handler.respond_to?(:call)
 
       public_send(handler, chat_id, message)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: te_bot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nawa Aripurna
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack