telerb 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 368a13df3fb8d9be794e4c1a1ef14e457b01db5f144c2962a344e93d70bf3921
-  data.tar.gz: c6117a352b1c0521704ac7ad4abe17149a8018924da52c1197edc2467e80041d
+  metadata.gz: 2d98742d8ff3a0d500bc7e3fb45132a54ef4bb174220852e44e218cd6eedf26e
+  data.tar.gz: 982e849f2d89e13e4e288c8fb42a98d18d46162d96f034bc88aef48ead277cdd
 SHA512:
-  metadata.gz: 6707df98472e8704e0e6b92be7bf82b022ef38a82dc110966b0c651bab0acbb053f9a7754dd413d71c8edcf2bd8d9e6dd95a35599b1d6f9a9597cb28b4b529e6
-  data.tar.gz: c9b863b42643770bfe5244c9cd3ef2bb8bb97012791ab5d80605cd4556dfe2e181a99ffe67c6479d4f4e8fb81c67a3d7957a7428197b73be5b7b2b856092d9b5
+  metadata.gz: 04a96100453a1356741ce4b1cef385b81dcae1c952fe1ed8e54f687adf016bf645786eb1efb52a977be3f11a222c59fd4f58a232bc4ba432827c32987db3a069
+  data.tar.gz: d74ceb13616b5ad43da23a6b08c22a5616b9f48b95440534106f5bd27c09c9669a32c20d6f9eb3fb957eef02ae97266bb066fc62085b89957bbb905cfc9f4ed9

data/CHANGELOG.md

@@ -27,3 +27,13 @@
 ## [0.1.5] - 2024-04-10
 
 - Implement the method to obtain information from a user
+
+## [0.1.6] - 2024-04-12
+
+- Implements The Location sending method
+
+## [0.1.7] - 2024-04-17
+
+- Implement Sticker sending method
+- Refactor following best practices
+- Refactor test and implement test execution for parallel execution

data/README.md

@@ -21,8 +21,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 require 'telerb'
 
 # Create a bot instance
-bot = TeleRb::TelegramBot.new
-bot.config('YOUR_TOKEN')
+config = TelegramConfig.new("YOUR_TOKEN")
+bot = TeleRb::TelegramBot.new(config)
 
 # Initialize bot
 bot.listen do |message|
@@ -46,6 +46,8 @@ The ***message_id*** parameter is only necessary if you want the message to be s
   bot.send_audio(chat_id, "./exemple.mp3", "test", message_id)
   # Send Video
   bot.send_video(chat_id, "./exemple.mp4", "test", message_id)
+  # Send Sticker
+  bot.send_sticker(chat_id, "./exemple.webp", message_id)
 
 ```
 ### Commands
@@ -82,6 +84,14 @@ bot.user_info(message)
 
 ```
 
+### Send Location
+
+```
+
+bot.location(chat_id, latitude, longitude, message_id)
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -2,11 +2,12 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
-
 RuboCop::RakeTask.new
 
+require "parallel_tests/tasks"
+
 task default: %i[spec rubocop]

data/lib/telerb/methods/actions_methods.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TeleRb
+  # Message Methods
+  module ActionsMethods
+    def get_commands
+      response = CLIENT.get(@config.base_uri("getMyCommands"))
+      response.parsed_response["result"]
+    rescue StandardError => e
+      puts "Error getting list of defined commands: #{e.message}"
+      nil
+    end
+
+    def set_commands(commands)
+      CLIENT.post(@config.base_uri("setMyCommands"), { commands: commands }.to_json,
+                  { "Content-Type" => "application/json" })
+      "Commands set successfully"
+    rescue StandardError => e
+      puts "Error defining command list: #{e.message}"
+      nil
+    end
+  end
+end

data/lib/telerb/methods/media_methods.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module TeleRb
+  # Message Methods
+  module MediaMethods
+    def send_photo(chat_id, photo_path, caption = nil, reply_to_message_id = nil)
+      send_media(chat_id, photo_path, caption, reply_to_message_id, "sendPhoto", :photo)
+    end
+
+    def send_audio(chat_id, audio_path, caption = nil, reply_to_message_id = nil)
+      send_media(chat_id, audio_path, caption, reply_to_message_id, "sendAudio", :audio)
+    end
+
+    def send_video(chat_id, video_path, caption = nil, reply_to_message_id = nil)
+      send_media(chat_id, video_path, caption, reply_to_message_id, "sendVideo", :video)
+    end
+
+    def send_document(chat_id, document_path, caption = nil, reply_to_message_id = nil)
+      send_media(chat_id, document_path, caption, reply_to_message_id, "sendDocument", :document)
+    end
+
+    def send_sticker(chat_id, sticker_path, reply_to_message_id = nil)
+      send_media(chat_id, sticker_path, reply_to_message_id, "sendSticker", :sticker)
+    end
+
+    private
+
+    def send_media(chat_id, media_path, caption = nil, reply_to_message_id = nil, method, filekey)
+      raise ArgumentError, "Invalid media type: {#{filekey.capitalize}" unless %i[photo audio video sticker
+                                                                                  document].include?(filekey)
+
+      CLIENT.post(@config.base_uri(method),
+                  {
+                    chat_id: chat_id,
+                    reply_to_message_id: reply_to_message_id,
+                    filekey.to_sym => File.new(media_path, "rb"),
+                    caption: caption
+                  },
+                  { "Content-Type" => "multipart/form-data" })
+      "#{filekey.capitalize} Sent with success!"
+    rescue StandardError => e
+      puts "Error when sending #{filekey.capitalize}: #{e.message}"
+      nil
+    end
+  end
+end

data/lib/telerb/methods/message_methods.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module TeleRb
+  # Message Methods
+  module MessageMethods
+    def send_message(chat_id, text, reply_to_message_id = nil)
+      CLIENT.post(@config.base_uri("sendMessage"),
+                  { chat_id: chat_id, text: text, reply_to_message_id: reply_to_message_id })
+      "Message sent successfully!"
+    rescue StandardError => e
+      puts "Error sending message: #{e.message}"
+      nil
+    end
+
+    def forward_message(from_chat_id, to_chat_id, message_id)
+      CLIENT.post(@config.base_uri("forwardMessage"),
+                  { chat_id: to_chat_id, from_chat_id: from_chat_id, message_id: message_id })
+      "Forwarding was then done successfully!"
+    rescue StandardError => e
+      puts "Error forwarding message: #{e.message}"
+      nil
+    end
+
+    def send_location(chat_id, latitude, longitude, reply_to_message_id = nil)
+      CLIENT.post(@config.base_uri("sendLocation"),
+                  { chat_id: chat_id, latitude: latitude, longitude: longitude,
+                    reply_to_message_id: reply_to_message_id })
+      "Location Sent with success!"
+    rescue StandardError => e
+      puts "Error when sending Location: #{e.message}"
+      nil
+    end
+  end
+end

data/lib/telerb/methods/user_methods.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TeleRb
+  # Message Methods
+  module UserMethods
+    def user_info(message)
+      message["from"]
+    end
+  end
+end

data/lib/telerb/telegram_bot.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "utils/http_client"
+require_relative "methods/message_methods"
+require_relative "methods/media_methods"
+require_relative "methods/actions_methods"
+require_relative "methods/user_methods"
+
+module TeleRb
+  CLIENT = HttpClient.new
+  # class telegram bot
+  class TelegramBot
+    include MessageMethods
+    include MediaMethods
+    include ActionsMethods
+    include UserMethods
+    def initialize(config)
+      @config = config
+    end
+
+    def listen(&block)
+      loop do
+        updates = get_updates(@config.offset)
+        updates.each do |update|
+          block.call update["message"] if block_given? && update["message"]
+          @config.offset = update["update_id"] + 1
+        end
+      rescue StandardError => e
+        puts "Error in listen method: #{e.message}"
+      end
+      sleep 2
+    end
+
+    private
+
+    def get_updates(offset = nil)
+      response = CLIENT.get(@config.base_uri("getUpdates"), { offset: offset })
+      response.parsed_response["result"]
+    rescue StandardError => e
+      puts "Error in get_updates method: #{e.message}"
+      []
+    end
+  end
+end

data/lib/telerb/telegram_config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Telegram config
+class TelegramConfig
+  attr_accessor :offset
+
+  def initialize(token)
+    @offset = nil
+    @token = token
+  end
+
+  def base_uri(method)
+    "https://api.telegram.org/bot#{@token}/#{method}"
+  end
+end

data/lib/telerb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TeleRb
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/telerb.rb

@@ -1,116 +1,5 @@
 # frozen_string_literal: true
 
 require_relative "telerb/version"
-require_relative "telerb/http_client"
-
-module TeleRb
-  CLIENT = HttpClient.new
-  # class telegram bot
-  class TelegramBot
-    def initialize
-      @token = nil
-      @offset = nil
-      @base_uri = "https://api.telegram.org/bot"
-    end
-
-    def config(token)
-      @token = token
-    end
-
-    def listen(&block)
-      loop do
-        updates = get_updates(@offset)
-        updates.each do |update|
-          block.call update["message"] if block_given? && update["message"]
-          @offset = update["update_id"] + 1
-        end
-      rescue StandardError => e
-        puts "Error in listen method: #{e.message}"
-      end
-      sleep 2
-    end
-
-    def send_message(chat_id, text, reply_to_message_id = nil)
-      CLIENT.post("#{@base_uri}#{@token}/sendMessage",
-                  { chat_id: chat_id, text: text, reply_to_message_id: reply_to_message_id })
-      "Message sent successfully!"
-    rescue StandardError => e
-      puts "Error sending message: #{e.message}"
-      nil
-    end
-
-    def send_photo(chat_id, photo_path, caption = nil, reply_to_message_id = nil)
-      send_media(chat_id, photo_path, caption, reply_to_message_id, "sendPhoto", :photo)
-    end
-
-    def send_audio(chat_id, audio_path, caption = nil, reply_to_message_id = nil)
-      send_media(chat_id, audio_path, caption, reply_to_message_id, "sendAudio", :audio)
-    end
-
-    def send_video(chat_id, video_path, caption = nil, reply_to_message_id = nil)
-      send_media(chat_id, video_path, caption, reply_to_message_id, "sendVideo", :video)
-    end
-
-    def send_document(chat_id, document_path, caption = nil, reply_to_message_id = nil)
-      send_media(chat_id, document_path, caption, reply_to_message_id, "sendDocument", :document)
-    end
-
-    def get_commands
-      response = CLIENT.get("#{@base_uri}#{@token}/getMyCommands")
-      response.parsed_response["result"]
-    rescue StandardError => e
-      puts "Error getting list of defined commands: #{e.message}"
-      nil
-    end
-
-    def set_commands(commands)
-      CLIENT.post("#{@base_uri}#{@token}/setMyCommands", { commands: commands }.to_json,
-                  { "Content-Type" => "application/json" })
-      "Commands set successfully"
-    rescue StandardError => e
-      puts "Error defining command list: #{e.message}"
-      nil
-    end
-
-    def forward_message(from_chat_id, to_chat_id, message_id)
-      CLIENT.post("#{@base_uri}#{@token}/forwardMessage",
-                  { chat_id: to_chat_id, from_chat_id: from_chat_id, message_id: message_id })
-      "Forwarding was then done successfully!"
-    rescue StandardError => e
-      puts "Error forwarding message: #{e.message}"
-      nil
-    end
-
-    def user_info(message)
-      message["from"]
-    end
-
-    private
-
-    def send_media(chat_id, media_path, caption = nil, reply_to_message_id = nil, method, filekey)
-      raise ArgumentError, "Invalid media type: {#{filekey.capitalize}" unless %i[photo audio video
-                                                                                  document].include?(filekey)
-
-      CLIENT.post("#{@base_uri}#{@token}/#{method}",
-                  {
-                    chat_id: chat_id,
-                    reply_to_message_id: reply_to_message_id,
-                    filekey.to_sym => File.new(media_path, "rb"),
-                    caption: caption
-                  },
-                  { "Content-Type" => "multipart/form-data" })
-      "#{filekey.capitalize} Sent with success!"
-    rescue StandardError => e
-      puts "Error when sending #{filekey.capitalize}: #{e.message}"
-      nil
-    end
-
-    def get_updates(offset = nil)
-      response = CLIENT.get("#{@base_uri}#{@token}/getUpdates", { offset: offset })
-      response.parsed_response["result"]
-    rescue StandardError => e
-      puts "Error in get_updates method: #{e.message}"
-      []
-    end
-  end
-end
+require_relative "telerb/telegram_config"
+require_relative "telerb/telegram_bot"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerb
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - CodeByAllan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library to interact with the Telegram API and create custom bots.
 email:
@@ -26,7 +26,13 @@ files:
 - README.md
 - Rakefile
 - lib/telerb.rb
-- lib/telerb/http_client.rb
+- lib/telerb/methods/actions_methods.rb
+- lib/telerb/methods/media_methods.rb
+- lib/telerb/methods/message_methods.rb
+- lib/telerb/methods/user_methods.rb
+- lib/telerb/telegram_bot.rb
+- lib/telerb/telegram_config.rb
+- lib/telerb/utils/http_client.rb
 - lib/telerb/version.rb
 - sig/telerb.rbs
 homepage: https://github.com/CodeByAllan/TeleRb#readme