telegem 3.3.0 → 3.4.0

data/CHANGELOG

@@ -1,95 +0,0 @@
-Telegem Changelog
-
-v3.1.1 (current)
-
-🚀 New Features
-
-· FileExtractor Plugin: New plugin for extracting content from various file types (PDF, JSON, HTML, TXT)
-· Async File Download: Added download method to API client for downloading Telegram files
-· Context File Helpers: Added download_file, download_photo, download_document methods to Context
-· Extended File Support: Plugin supports PDF text extraction, JSON parsing, HTML/raw text processing
-· Async/Sync Dual Mode: All file operations available in both sync (download) and async (download!) modes
-
-v3.1.0 
-
-· BREAKING: Rewrote polling system to prevent duplicate messages
-· Fixed thread deadlock in async polling loop
-· Added scene_middleware.rb for scene-based conversations
-· Improved MemoryStore with TTL and thread safety
-· Enhanced keyboard markup builder with web_app support
-· Added message reaction and chat boost update types
-· Fixed callback query handling for inline keyboards
-
-v3.0.0
-
-· BREAKING: Complete async rewrite with async gem
-· New HTTP client using HTTPX with proper async/await pattern
-· Added scene system for multi-step conversations
-· Middleware composer system for plugin architecture
-· Type system with dynamic accessors for Telegram objects
-· Session management with memory store
-· Rate limiting middleware
-· File upload support via multipart forms
-
-v2.0.0
-
-· BREAKING: Ruby 3.0+ requirement
-· Added webhook support with Rack middleware
-· Inline query and callback query handlers
-· Location, contact, and poll answer handlers
-· Keyboard markup helpers (Telegem::Markup)
-· Improved error handling with custom error classes
-· Logging integration with configurable loggers
-
-v1.5.0
-
-· Added command argument parsing (ctx.command_args)
-· Message entity parsing (mentions, hashtags, bot commands)
-· Chat member update handlers
-· Pre-checkout and shipping query support
-· File download helper methods
-· Context helper methods for common API calls
-
-v1.0.0
-
-· Stable API release
-· Message handlers with text pattern matching
-· Command handlers with regex support
-· Basic context object with chat/message accessors
-· Simple API client with error handling
-· Polling and webhook modes
-· Configuration options for timeout and limits
-
-v0.5.0
-
-· Added callback query support
-· Inline keyboard builder
-· Message editing and deletion helpers
-· Media sending methods (photo, document, audio, video)
-· Chat action methods (typing, upload indicators)
-
-v0.3.0
-
-· Middleware system with bot.use
-· Session management foundation
-· Basic rate limiting
-· Command filtering by chat type
-· Improved logging with debug levels
-
-v0.2.0
-
-· Basic polling implementation
-· Message type detection (text, photo, document)
-· Command parsing with arguments
-· Simple reply methods
-· Error handling for API calls
-
-v0.1.0 (Initial Release)
-
-· Basic Telegram Bot API wrapper
-· Send/receive messages
-· Simple command handling
-· Minimal dependencies (just httparty)
-· Support for basic message types
-
----

data/Contributing.md

@@ -1,161 +0,0 @@
-# 🤝 contributing to Telegem
-
- Thank you for your interest in contributing to Telegem! This document provides guidelines and instructions for contributing to Telegem. 
- whether you are fixing bugs, improving documentation or proposing new features, your contributions are welcome 
- 
- ## 📋 Table of Contents
-- [Code of Conduct](#-code-of-conduct)
-- [Getting Started](#-getting-started)
-- [How to Contribute](#-how-to-contribute)
-- [Reporting Bugs](#reporting-bugs)
-- [Suggesting Features](#suggesting-features)
-- [Code Contributions](#code-contributions)
-- [Documentation](#documentation)
-- [Development Setup](#-development-setup)
-- [Pull Request Process](#-pull-request-process)
-- [Style Guides](#-style-guides)
-- [Community](#-community)
-- [Recognition](#-recognition)
-
-## code of conduct
-
-We are committed to providing a welcoming and inspiring community for all. Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
-
-## 🚀 Getting Started
-
-### Prerequisites
-- Ruby v3.x
-- Git
-
-### Quick Start
-1. **Fork the repository** on GitLab
-2. **Clone your fork:**
-   ```bash
-   git clone https://gitlab.com/your-username/telegem.git
-   cd telegem
-   ```
- 3. Install dependencies 
-   ```bash 
-   $ gem install 
-   ```
- 4. run test 
- ```bash 
-  $ rspec test/spec.rb
-  ```
-  ## How to contribute 
-  
-  ##reporting bugs 
-   Bugs are tracked as Gitlab Issues 
-   
-   **before submitting a bug report:**
-   - check if the issue has already been reported 
-   - update to the latest version to see if issues persists
-   - check the documentation and existing solutions to the issue 
-   **A good report includes:**
-   1. clear descriptive title
-   2. steps to be reproduced (be specific)
-   3. expected behavior 
-   4. relevant logs or message 
-   
-   Code Contributions
-
-1. Find an issue to work on:
-   - Check issues labeled good first issue or help wanted
-   - Comment on the issue to let us know you're working on it
-2. Create a feature branch:
-   ```bash
-   git checkout -b feature/your-feature-name
-   # or
-   git checkout -b fix/issue-description
-   ```
-3. Make your changes
-4. Write/update tests
-5. Update documentation if needed
-6. Run tests locally:
-   ```bash
-   rspec test/spec.rb
-   ```
-
-Documentation
-
-Good documentation is crucial! You can help by:
-
-- Fixing typos or unclear explanations
-- Adding examples to existing documentation
-- Writing tutorials or how-to guides
-- Improving API documentation
-- Translating documentation
-
-Testing
-
-```bash
-# Run all tests
- rspec test/spec.rb
- 
-bundle exec bundle-audit
-```
-
-🎯 Pull Request Process
-
-1. Update your fork with the latest changes from upstream:
-   ```bash
-   git remote add upstream https://gitlab.com/ruby-telegem/telegem.git
-   git fetch upstream
-   git rebase upstream/main
-   ```
-2. Ensure all tests pass
-3. Update documentation if your changes affect functionality
-4. Create a Merge Request (MR) on GitLab:
-   - Use a clear, descriptive title
-   - Reference any related issues (e.g., "Closes #123")
-5. Address review feedback promptly
-6. Once approved, a maintainer will merge your changes
-
-
-
-
-
-👥 Community
-
-Discussion
-
-- Issues: GitLab Issues
-- Merge Requests: GitLab MRs
-
-Getting Help
-
-- Search existing issues and documentation first
-- Be respectful and patient with other community members
-- Provide as much context as possible when asking for help
-
-🏆 Recognition
-
-All contributors are recognized in our HALL_OF_FAME.md. We appreciate every contribution, big or small!
-
-Contributors who make significant impact may be:
-
-- Added to the "Active Contributors" section
--  Given commit access (for trusted, regular contributors)
-- Featured in release notes
-
-
-
-Release Cycle
-
--  We follow Semantic Versioning
-- Major releases
-- Minor releases
-- Patch releases 
-
-License
-
-By contributing, you agree that your contributions will be licensed under the project's LICENSE.
-
----
-
-Thank you for contributing to Telegem! Your efforts help make this project better for everyone. 🚀
-
-```
-  
-
- 

data/Readme.md

@@ -1,302 +0,0 @@
-![Telegem Logo](https://gitlab.com/ruby-telegem/telegem/-/raw/main/assets/logo.png)
-
-Modern, blazing-fast async Telegram Bot API for Ruby - Inspired by Telegraf, built for performance.
-
-![Gem Version](https://badge.fury.io/rb/telegem.svg) ![GitLab](https://img.shields.io/badge/gitlab-telegem-orange) ![Ruby Version](https://img.shields.io/badge/Ruby-3.0+-red.svg) ![License](https://img.shields.io/badge/License-MIT-blue.svg) ![Async I/O](https://img.shields.io/badge/Async-I/O-green.svg) 
-
-![GitLab stars](https://img.shields.io/gitlab/stars/ruby-telegem/telegem?style=for-the-badge&logo=gitlab&color=orange)
-![GitLab contributors](https://img.shields.io/gitlab/contributors/ruby-telegem/telegem?style=for-the-badge&logo=gitlab)
-![GitLab last commit](https://img.shields.io/gitlab/last-commit/ruby-telegem/telegem?style=for-the-badge&logo=gitlab)
-![GitLab license](https://img.shields.io/gitlab/license/ruby-telegem/telegem?style=for-the-badge&logo=gitlab)
-
-
-
-Blazing-fast, modern Telegram Bot framework for Ruby. Inspired by Telegraf.js, built for performance with true async/await patterns.
-
----
-
-✨ Features
-
-- ⚡ True Async I/O - Built on async gem, not blocking threads
-- 🎯 Telegraf-style DSL - Familiar API for JavaScript developers
-- 🔌 Middleware System - Compose behavior like Express.js
-- 🧙 Scene System - Multi-step conversations (wizards/forms)
-- 💾 Session Management - Redis, memory, or custom stores
-- ⌨️ Keyboard DSL - Clean markup builders with fluent API
-- 🌐 Webhook Server - Production-ready async HTTP server
-- 🏗️ Type-Safe Objects - Ruby classes for all Telegram types
-- 📦 Minimal Dependencies - Just async gems + mime-types
-
----
-
-🚀 Quick Start
-
-Installation
-
-```bash
-gem install telegem
-```
-
-Or add to your Gemfile:
-
-```ruby
-gem 'telegem'
-```
-
-Your First Bot (in 60 seconds)
-
-```ruby
-require 'telegem'
-
-# 1. Get token from @BotFather on Telegram
-bot = Telegem.new('YOUR_BOT_TOKEN')
-
-# 2. Add commands
-bot.command('start') do |ctx|
-  ctx.reply "Hello #{ctx.from.first_name}! 👋"
-end
-
-bot.command('help') do |ctx|
-  ctx.reply "I'm your friendly Telegem bot!"
-end
-
-# 3. Start listening
-puts "🤖 Bot starting..."
-bot.start_polling
-```
-
-Interactive Example
-
-```ruby
-# Pizza ordering bot example
-bot.command('order') do |ctx|
-  keyboard = Telegem.keyboard do
-    row "🍕 Margherita", "🍕 Pepperoni"
-    row "🥤 Drinks", "🍰 Dessert"
-    row "📞 Support", "❌ Cancel"
-  end.resize.one_time
-  
-  ctx.reply "What would you like?", reply_markup: keyboard
-end
-```
-
----
-
-
----
-
-🎯 Why Telegem?
-
-vs. Other Ruby Telegram Libraries
-
-| Telegem | telegram-bot-ruby |
-| ------ | ------ |
-|   fast async      |  multiple thread      |
-|    non blocking request     |    slow thread based     |
-| clean telegraf dsl    |  no dsl |
-| scene management.   | verbose |
-| middleware |  raw json | 
-| clean markup dsl|.      | 
-
-Perfect For:
-
-- High-traffic bots needing async performance
-- Complex conversations with multi-step flows
-- Production deployments with webhooks & scaling
-- Developers familiar with Telegraf.js/Express
-- Modern Ruby (3.0+) applications
-
----
-
-[📚 Documentation](https://rubydoc.info/gems/telegem/3.2.3/index)
-
-
-
-🧩 Advanced Features
-
-Scene System (Multi-step Conversations)
-
-```ruby
-bot.scene :registration do
-  step :ask_name do |ctx|
-    ctx.reply "What's your name?"
-  end
-  
-  step :save_name do |ctx|
-    ctx.session[:name] = ctx.message.text
-    ctx.reply "Hi #{ctx.session[:name]}! What's your email?"
-  end
-  
-  step :complete do |ctx|
-    ctx.session[:email] = ctx.message.text
-    ctx.reply "Registration complete! ✅"
-    ctx.leave_scene
-  end
-end
-```
-
-Middleware Pipeline
-
-```ruby
-# Add cross-cutting concerns
-bot.use AuthenticationMiddleware.new
-bot.use RateLimiter.new(limit: 10)
-bot.use LoggingMiddleware.new
-
-# Custom middleware
-bot.use do |ctx, next_middleware|
-  puts "Processing message from #{ctx.from.username}"
-  next_middleware.call(ctx)
-end
-```
-
-Multiple Session Stores
-
-```ruby
-# Memory (development)
-Telegem::Session::MemoryStore.new
-
-# Redis (production)
-require 'redis'
-redis = Redis.new(url: ENV['REDIS_URL'])
-Telegem::Session::RedisStore.new(redis)
-
-# Custom (database, etc.)
-class DatabaseStore
-  def get(user_id); end
-  def set(user_id, data); end
-end
-```
-
----
-
-🌐 Production Deployment
-
-Webhook Mode (Recommended)
-
-```ruby
-# Production setup
-server = bot.webhook_server(
-  port: ENV['PORT'] || 3000,
-  endpoint: Async::HTTP::Endpoint.parse("https://#{ENV['DOMAIN']}")
-)
-
-# Set webhook automatically
-  bot.set_webhook(
-    url: "https://#{ENV['DOMAIN']}/webhook/#{bot.token}",
-    max_connections: 40
-  )
-  
-  server.run
-end
-```
-
-Docker Deployment
-
-```dockerfile
-FROM ruby:3.2-alpine
-WORKDIR /app
-COPY Gemfile Gemfile.lock ./
-RUN bundle install
-COPY . .
-CMD ["ruby", "bot.rb"]
-```
-
----
-
-
----
-
-📦 Project Structure
-
-```
-my_bot/
-├── bot.rb                 # Main bot file
-├── Gemfile
-├── config/
-│   ├── initializers/     # Middleware, database setup
-│   └── environments/     # Development/production configs
-├── lib/
-│   ├── middleware/       # Custom middleware classes
-│   ├── scenes/          # Scene definitions
-│   └── services/        # Business logic
-├── db/                  # Database migrations
-└── spec/               # Tests
-```
-
----
-
-[🤝 contributing](https://gitlab.com/ruby-telegem/telegem/-/blob/main/Contributing.md)
-
-
-
-Development Setup:
-
-```bash
-git clone https://gitlab.com/ruby-telegem/telegem.git
-cd telegem
-bundle install
-rake spec  # Run tests
-```
-
-Need Help?
-
-- Issues - Bug reports and feature requests
-- Merge Requests - Code contributions
-- Discussions - Questions and ideas
-
----
-
-🚧 Roadmap
-
-Coming Soon
-
-- Plugin System - Community plugins ecosystem
-- More Session Stores - PostgreSQL, MySQL, MongoDB
-- Built-in Analytics - Usage tracking & insights
-- Admin Dashboard - Web interface for bot management
-
-
----
-
-📄 License
-
-MIT License - see LICENSE.txt for details.
-
----
-
-🙏 Acknowledgments
-
-- Inspired by Telegraf.js - Amazing Node.js Telegram framework
-- Built on async - Ruby's async I/O gem
-- Thanks to the Telegram team for the excellent Bot API
-- Community - All contributors and users
-
----
-
-🌟 Star History
-
-[history](https://api.star-history.com/svg?repos=ruby-telegem/telegem&type=Date)
-
----
-
-📞 Support & Community
-
-- GitLab Issues: Report bugs & request features
-- Examples: Example bots repository
-- Chat: Join our community (Telegram group)
-
----
-
-🎉 Ready to Build?
-
-```bash
-# Start building your bot now!
-gem install telegem
-ruby -r telegem -e "puts 'Welcome to Telegem! 🚀'"
-```
-
-
----
-
-Built with ❤️ for the Ruby community. Happy bot building! 🤖✨