telegram-bot-ruby-rbs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2b5abba0048a59d00fa36de18c1b0c17ce530f3f56796642bd3114ce4edf2a4
+  data.tar.gz: 83e0e5918dcf00aa5cda3b7365ca661fed37df22c4162d66db0d1727f9397351
+SHA512:
+  metadata.gz: d716a4e5b10435efb5a71ccc148c225194d0e737b8d1114968afd3f6b6cacfb1e445dd465eb0ecf506eccdc0fc46ac71aa15aea0f3c82323fa64a24e48293885
+  data.tar.gz: 15d648384226a12c5b0640f338a19ce2852de51ce9f4bbbdac295f002c856d1544e71aa85cef7ff8d44872d8a22f854b1ad7ca38156d29bc4e5f8dd0c7e7fd9c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ldebortoli
+
+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,42 @@
+# telegram-bot-ruby-rbs
+
+RBS signatures for [`telegram-bot-ruby`](https://github.com/atipugin/telegram-bot-ruby), generated from the wrapper's real Ruby surface and checked against the [official Telegram Bot API](https://core.telegram.org/bots/api).
+
+Version `0.1.x` targets `telegram-bot-ruby >= 2.7.0, < 2.8`. The current normalized documentation snapshot is Telegram Bot API 10.2.
+
+## Installation
+
+Add both gems to your bundle:
+
+```ruby
+gem "telegram-bot-ruby", "~> 2.7.0"
+gem "telegram-bot-ruby-rbs", "~> 0.1.0", require: false
+```
+
+RBS, Steep and compatible editors discover the `.rbs` files from the installed gem's `sig/` directory. This gem adds no runtime behavior.
+
+## What is covered
+
+- every concrete `Telegram::Bot::Types` class and every Dry::Struct-generated reader;
+- typed constructors, including required and optional attributes;
+- every endpoint accepted by `Telegram::Bot::Api#method_missing`, in snake_case and Telegram camelCase forms;
+- `Client`, `Api`, configuration, exceptions and helper modules;
+- union constants represented as RBS type aliases.
+
+Telegram's official API can move ahead of the wrapper. `data/compatibility.yml` records methods, types and fields present in the official documentation but not yet implemented by `telegram-bot-ruby`; signatures deliberately do not promise missing runtime constants or response conversions.
+
+## Development
+
+```sh
+bundle install
+bundle exec rake update_api  # fetch and normalize the official documentation
+bundle exec rake generate    # regenerate sig/ and the compatibility report
+bundle exec rake             # tests plus rbs validate
+bundle exec rake build
+```
+
+The generated files are committed so consumers never need network access or generator dependencies.
+
+## License
+
+MIT. Telegram Bot API names and facts are sourced from Telegram's official documentation; `telegram-bot-ruby` remains under its own license.