telegram_simple_messenger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ff3d90f49431a1892529477c358267a7bf2f6a419c2f1a8553bd4d50df76aad
+  data.tar.gz: ed4412355b3207e23b8730cf3b1f944b131e300ffa6d806570784c432bc448aa
+SHA512:
+  metadata.gz: b9ba940840c78876fa6926b4b3dc30ca70121a85659e4276d00b3bf0d58b526076a1288d71d41b6fc26bbbde0ea4e182a18cf74f03490799f9b2e889d63aa35b
+  data.tar.gz: 0d14a9e2bc3e1a2afe80c7b1ddf4d72a467120997027bc21c62409da779f9b0dc765b646844f12efccbd514d80958b0fc95c30fa26e2b1b04cd3af3174bf404f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-18
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fernando Shayani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Fernando Shayani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# TelegramSimpleMessenger
+
+It's a simple gem to send messages through Telegram to a user or a group/channel.
+
+## What do you need?
+
+To use it, you need and Telegram API KEY (a bot key) and a Chat ID.
+
+### API KEY
+The API KEY you can get building a new bot through [@BotFather](https://t.me/botfather). Just send a Telegram message to [@BotFather](https://t.me/botfather) and follows the instructions. An API KEY looks like this: `5490951233:AAFZH99VRQuIOH-qweL1fwATf3kna2eBQSE`.
+
+### CHAT ID
+Use another Telegram Bot [@RawDataBot](https://t.me/raw_data_bot) to find your own Chat ID or a group/channel Chat ID.
+
+## Installation
+
+Add to your `Gemfile`
+
+```ruby
+gem "telegram_simple_messenger", github: "shayani/telegram_simple_messenger"
+```
+
+Then run
+
+```sh
+bundle install
+```
+
+## Configuration
+
+Create a initializer file to set the default API KEY and CHAT ID
+
+```ruby
+# config/initializers/telegram_simple_messenger.rb
+
+TelegramSimpleMessenger.defautl_api_key=MY_API_KEY
+TelegramSimpleMessenger.default_chat_id=MY_CHAT_ID
+```
+
+## Usage
+
+### Sending a message using the default API KEY and CHAT ID
+
+Simple call the service:
+
+```ruby
+TelegramSimpleMessenger.send_message("Hello world!")
+```
+
+### Overwriting the API KEY and/or CHAT ID
+
+You can overwrite the default API KEY and CHAT ID passing them as arguments:
+
+```ruby
+TelegramSimpleMessenger.send_message("Hello world!", ANOTHER_API_KEY, ANOTHER_CHAT_ID)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegram_simple_messenger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/telegram_simple_messenger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TelegramSimpleMessenger
+  VERSION = "0.1.0"
+end

data/lib/telegram_simple_messenger.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "telegram_simple_messenger/version"
+require "httparty"
+
+# Send a message to a Telegram chat with a single line of code.
+#
+# You can set a default API key and chat ID:
+#   TelegramSimpleMessenger.default_api = "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"
+#   TelegramSimpleMessenger.default_chat_id = "123456789"
+#
+# Example:
+#   TelegramSimpleMessenger.send_message("Hello, world!")
+#
+# You can also pass the API key and chat ID as arguments:
+#   TelegramSimpleMessenger.send_message("Hello, world!", "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11", "123456789")
+module TelegramSimpleMessenger
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :default_api_key, :default_chat_id
+  end
+
+  self.default_api_key = nil
+  self.default_chat_id = nil
+
+  def self.send_message(message, api_key = default_api_key, chat_id = default_chat_id)
+    raise Error, "No API key provided" unless api_key
+    raise Error, "No chat ID provided" unless chat_id
+
+    response = HTTParty.post("https://api.telegram.org/bot#{api_key}/sendMessage",
+                             body: {
+                               chat_id: chat_id,
+                               text: message
+                             })
+
+    raise Error, "Failed to send message: #{response.body}" unless response.success?
+
+    response
+  end
+end

data/sig/telegram_simple_messenger.rbs

@@ -0,0 +1,4 @@
+module TelegramSimpleMessenger
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: telegram_simple_messenger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fernando Shayani
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Simple and easy
+email:
+- shayani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/telegram_simple_messenger.rb
+- lib/telegram_simple_messenger/version.rb
+- sig/telegram_simple_messenger.rbs
+homepage: https://github.com/shayani/telegram_simple_messenger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shayani/telegram_simple_messenger
+  source_code_uri: https://github.com/shayani/telegram_simple_messenger
+  changelog_uri: https://github.com/shayani/telegram_simple_messenger/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Send a Telegram message with a single line of code.
+test_files: []