The Telegram bot framework that doesn't drive you nuts.

Sergio Brighenti

Last update: Jan 5, 2023

Related tags

Third Party APIs api php wrapper library laravel framework telegram telegram-bot bot-framework telegram-bots telegram-bot-api hacktoberfest php8

Overview

Nutgram

The Telegram bot framework that doesn't drive you nuts

This framework takes advantage of the latest PHP 8 features, and tries to make the speed, scalability and flexibility of use its strength, it will allow you to quickly make simple bots, but at the same time, it provides more advanced features to handle even the most complicated flows. Some architectural concepts on which Nutgram is based are heavily influenced by other open source projects such as Botman and Zanzara, check them out too!

run();">



use SergiX44\Nutgram\Nutgram;

$bot = new Nutgram($_ENV['TOKEN']);

$bot->onCommand('start', fn(Nutgram $bot) => $bot->sendMessage('Ciao!'));

$bot->onText('My name is {name}', fn(Nutgram $bot, $name) => $bot->sendMessage("Hi {$name}"));

$bot->run();

Installation

You can install the package via composer:

composer require sergix44/nutgram

Usage

Official Documentation

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

License

The MIT License (MIT). Please see License File for more information.

Comments

[BUG] onMessage() is not working
Describe the bug

I have a code in CodeIgniter based there below :

<?php namespace App\Controllers; use SergiX44\Nutgram\Nutgram; use SergiX44\Nutgram\RunningMode\Webhook; class Home extends BaseController { public function index() { $token = 'mybottoken'; $stelapi = new Nutgram($token); $stelapi->setRunningMode(Webhook::class); $stelapi->onMessage(function(Nutgram $nutapi) { $nutapi->sendMessage('i heard that'); }); $stelapi->run(); } }

When i call onText() it works, and then when i try onMessageType('photo',$callable) it works too (with message type is photo, i mean i sent a photo),

but when i try with text with onMessage($callable) it looks like it doesn't work, the bot didn't send any message, and onMessage(MessageType::TEXT, $callable) doesn't work too. Why ? idk if its from me or a bug. thankyou.

To Reproduce

explained above.

Expected behavior

When onMessage() called / i texted something in my Telegram bot, it should say back with i heard that

Screenshots

No response

Additional context

No response
opened by gensart-ai 7
[BUG] Bad Request: invalid file_id when downloading files
Describe the bug

Hi. Thanks for your great package.

I've built a small bot (using self-hosted telegram-bot-api) to compress PDF file. It needs to download and upload attached files. It worked well till recently and suddenly I faced this error:

Bad Request: invalid file_id #0 /vendor/nutgram/nutgram/src/Telegram/Client.php(269): SergiX44\Nutgram\Nutgram->mapResponse() #1 /vendor/nutgram/nutgram/src/Telegram/Endpoints/AvailableMethods.php(482): SergiX44\Nutgram\Nutgram->requestJson() #2 /src/Domain/PDF/Actions/CompressPdfAction.php(49): SergiX44\Nutgram\Nutgram->getFile()

It seems it can't download file. I tried to update telegram-bot-api to latest version but error still is there

Expected behavior

Download attached file

Additional context

PHP: 8.1.2 Laravel: 8.83.16 Bot API: 6.0.2 Nutgram: 3.2.1
opened by mostafaznv 7
Message chunk support
[x] chunk method

[x] word wrap support + multibyte support

[x] implement chunking to sendMessage method

[x] feature flag

[x] reply_markup in the last message

[x] tests

enhancement
opened by Lukasss93 5
[FEATURE] Back to past step in conversations

Is your feature request related to a problem? Please describe.

sometimes in a conversetion we need to back one step back and this cannot be done right now .

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

Additional context

No response

opened by flakka2022 4

[BUG] Class "Symfony\Component\HttpFoundation\Response" not found

Nutgram version

3.7.8, 3.8.0

Describe the bug

When I download a file from user

$bot->onMessageType(MessageTypes::DOCUMENT, function (Nutgram $bot) {
    $document = $bot->message()->document;
    $file = $bot->getFile($document->file_id);
    $bot->downloadFile($file, BASE_PATH . FILES_FOLDER . "/" . $document->file_name);
}

the file is downloaded and saved in the folder, but in $bot->onException I get an error:

Error: Class "Symfony\Component\HttpFoundation\Response" not found in D:\projects\report-bot\vendor\nutgram\nutgram\src\Telegram\Client.php:186
Stack trace:
#0 D:\projects\report-bot\receive.php(67): SergiX44\Nutgram\Nutgram->downloadFile()
#1 [internal function]: {closure}() 
#2 D:\projects\report-bot\vendor\nutgram\nutgram\src\Handlers\Handler.php(96): call_user_func()
#3 [internal function]: SergiX44\Nutgram\Handlers\Handler->__invoke()
#4 D:\projects\report-bot\vendor\nutgram\nutgram\src\Middleware\Link.php(41): call_user_func()
#5 D:\projects\report-bot\vendor\nutgram\nutgram\src\Nutgram.php(260): SergiX44\Nutgram\Middleware\Link->__invoke()
#6 D:\projects\report-bot\vendor\nutgram\nutgram\src\Nutgram.php(248): SergiX44\Nutgram\Nutgram->fireHandlers()
#7 D:\projects\report-bot\vendor\nutgram\nutgram\src\RunningMode\Webhook.php(68): SergiX44\Nutgram\Nutgram->processUpdate()
#8 D:\projects\report-bot\vendor\nutgram\nutgram\src\Nutgram.php(220): SergiX44\Nutgram\RunningMode\Webhook->processUpdates()
#9 D:\projects\report-bot\receive.php(91): SergiX44\Nutgram\Nutgram->run() 
#10 {main}

To Reproduce

Send a document to the bot
Save the document on the server
Catch errors

Expected behavior

downloadFile() works without errors

Screenshots

No response

Additional context

No response

opened by its2easy 3

Add parameters support to TelegramException

$bot->onApiError('.*Too Many Requests.*', function(Nutgram $bot, TelegramException $e){
    $e->getParameters(); // ['retry_after' => 14]
    $e->getParameter('retry_after'); // 14
    $e->hasParameter('retry_after'); // true
});

opened by Lukasss93 2

Optional enhanced command handler signature

Before

// TestCommand class

use SergiX44\Nutgram\Nutgram;

class TestCommand
{
    public function __invoke(Nutgram $bot): void
    {
        // your code
    }
}

// Nutgram handlers

$bot = new Nutgram($token);

$bot->onCommand('/test', TestCommand::class)
      ->description('This is a test command')
      ->middleware(MiddlewareA::class)
      ->skipGlobalMiddlewares([MiddlewareB::class]);

$bot->run();

After

// TestCommand class

use SergiX44\Nutgram\Nutgram;
use SergiX44\Nutgram\Support\Command;

class TestCommand extends Command
{
    public static string $name = 'test';

    public static ?string $description = 'This is a test command';

    public static array $middlewares = [MiddlewareA::class];

    public static ?array $skipGlobalMiddlewares = [MiddlewareB::class];

    public function __invoke(Nutgram $bot): void
    {
        // your code
    }
}

// Nutgram handlers

$bot = new Nutgram($token);

$bot->onCommand(TestCommand::class);

$bot->run();

opened by Lukasss93 2

Fixed class name and namespace issue when creating command

When I want to create a class with the "nutgram:make:class" command, I have a problem when creating nested folders. for examle :

php artisan nutgram:make:command Admin\Product\Create

output :

Path : app/Telegram/Commands/Admin/Product/Create.php

namespace App\Telegram\Commands;  // This is wrong

use SergiX44\Nutgram\Nutgram;

class Admin\Product\Create // This is wrong
{
    public function __invoke(Nutgram $bot): void
    {
        $bot->sendMessage('This is a command!');
    }
}

If we look carefully, the name of the class and namespace is wrong !

It should be :

namespace App\Telegram\Commands\Admin\Product; 

use SergiX44\Nutgram\Nutgram;

class Create 
{
    public function __invoke(Nutgram $bot): void
    {
        $bot->sendMessage('This is a command!');
    }
}

opened by mkhab7 2

Serializable instance

This allows to serialize the Nutgram instance, so object used in conversations, cache, etc where contains a nutgram reference, it should be serialized and unserialized without issues now

opened by SergiX44 2
[FEATURE] Send bulk message

Is your feature request related to a problem? Please describe.

Send bulk message to huge number of users and return result of success and fails .

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

Additional context

No response
enhancement

opened by flakka2022 2
Backward conversations

On complex menus, if the update match the condition Nutgram call the last step (also do this for more one step back). Its also come handy on making forms like AskIceCream that user wants to change the previous answers before submit.

(yes its possible to create that condition on every step but for more steps and menus it takes so much duplicated code)

opened by hamidqp 2
[BUG] 405 Method Not Allowed

Nutgram version

3.9

Describe the bug

I have installed the package on my laravel (v9) project. I have done all as writen in documentation here https://nutgram.dev/docs/configuration/laravel

Created TelegramController, published the configuration file, set webhook, filled routes/telegram.php and routes/api.php. Created FrontController. I just copied everything from documentation.

Now if I will send command /start or whatever to but there is error 405 Method Not Allowed

How to fix it? Help

To Reproduce

I have red documentation and issues on github

Expected behavior

I expected answer of bot to command /start. Becouse there is instraction in routes/telegram.php

$bot->onCommand('start', function (Nutgram $bot) { return $bot->sendMessage('Hello, world!'); })->description('The start command!');

Additionaly I have run command in terminal nutgram:register-commands Register the bot commands, see automatically-register-bot-commands

Screenshots

Additional context

No response

opened by Odilbukh 1

Releases(3.10.0)

3.10.0(Dec 31, 2022)
What's Changed

Add Laravel logger by @Lukasss93 in https://github.com/nutgram/nutgram/pull/271

Fix missing use cases inside getChat and setChat methods in Update class by @Lukasss93 in https://github.com/nutgram/nutgram/pull/278

Update to Bot Api 6.4 by @Lukasss93 in https://github.com/nutgram/nutgram/pull/282

New Contributors

@ShNURoK42 made their first contribution in https://github.com/nutgram/nutgram/pull/274

Full Changelog: https://github.com/nutgram/nutgram/compare/3.9.0...3.10.0
Source code(tar.gz)
Source code(zip)
3.9.0(Nov 17, 2022)
What's Changed

New handlers by @Lukasss93 in https://github.com/nutgram/nutgram/pull/267

Fix umask #268 by @SergiX44 in https://github.com/nutgram/nutgram/pull/269

Full Changelog: https://github.com/nutgram/nutgram/compare/3.8.1...3.9.0
Source code(tar.gz)
Source code(zip)
3.8.1(Nov 16, 2022)
What's Changed

Add parameters support to TelegramException by @Lukasss93 in https://github.com/nutgram/nutgram/pull/249

Add more tests by @Lukasss93 in https://github.com/nutgram/nutgram/pull/254

Add TTL support to setUserData and setGlobalData by @Lukasss93 in https://github.com/nutgram/nutgram/pull/255

Fix invalid pattern capturing (wrong behaviour with same values) by @Lukasss93 in https://github.com/nutgram/nutgram/pull/260

Fix missing bot instance inside objects by @Lukasss93 in https://github.com/nutgram/nutgram/pull/257

Fix invalid dependency by @Lukasss93 in https://github.com/nutgram/nutgram/pull/261

Full Changelog: https://github.com/nutgram/nutgram/compare/3.8.0...3.8.1
Source code(tar.gz)
Source code(zip)
3.8.0(Nov 7, 2022)
What's Changed

Bot API 6.3 by @Lukasss93 in https://github.com/nutgram/nutgram/pull/235

Fix command parser by @Lukasss93 in https://github.com/nutgram/nutgram/pull/238

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.9...3.8.0
Source code(tar.gz)
Source code(zip)
3.7.9(Nov 3, 2022)
What's Changed

Add php 8.2 support to php.yml by @Lukasss93 in https://github.com/nutgram/nutgram/pull/227

Fix chatId type of BulkMessenger class by @Lukasss93 in https://github.com/nutgram/nutgram/pull/232

2 Tests 2 Coverage by @Lukasss93 in https://github.com/nutgram/nutgram/pull/228

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.8...3.7.9
Source code(tar.gz)
Source code(zip)
3.7.8(Oct 17, 2022)
What's Changed

inline menu return message by @SergiX44 in https://github.com/nutgram/nutgram/pull/211

Add nutgram:logout command by @Lukasss93 in https://github.com/nutgram/nutgram/pull/208

Add "JSON_UNESCAPED_UNICODE" to "dump" method by @Lukasss93 in https://github.com/nutgram/nutgram/pull/213

Coverage support by @Lukasss93 in https://github.com/nutgram/nutgram/pull/214

experimental bulk messenger by @SergiX44 in https://github.com/nutgram/nutgram/pull/210

increase coverage by @SergiX44 in https://github.com/nutgram/nutgram/pull/217

tests! tests! tests! by @Lukasss93 in https://github.com/nutgram/nutgram/pull/220

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.7...3.7.8
Source code(tar.gz)
Source code(zip)
3.7.7(Sep 22, 2022)
What's Changed

Fix psalm array annotations by @Lukasss93 in https://github.com/nutgram/nutgram/pull/205

before step hook by @SergiX44 in https://github.com/nutgram/nutgram/pull/207

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.6...3.7.7
Source code(tar.gz)
Source code(zip)
3.7.6(Sep 17, 2022)
What's Changed

Add onPreCheckoutQueryPayload handler by @Lukasss93 in https://github.com/nutgram/nutgram/pull/198

Logging by @Lukasss93 in https://github.com/nutgram/nutgram/pull/196

Add onSuccessfulPayment + onSuccessfulPaymentPayload handlers by @Lukasss93 in https://github.com/nutgram/nutgram/pull/199

Psalm array annotations by @Lukasss93 in https://github.com/nutgram/nutgram/pull/201

Add skipGlobalMiddlewares method to Handler class by @Lukasss93 in https://github.com/nutgram/nutgram/pull/204

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.5...3.7.6
Source code(tar.gz)
Source code(zip)
3.7.5(Sep 11, 2022)
What's Changed

Options for inline menu callback query by @SergiX44 in https://github.com/nutgram/nutgram/pull/197

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.4...3.7.5
Source code(tar.gz)
Source code(zip)
3.7.4(Sep 10, 2022)
What's Changed

closing features by @SergiX44 in https://github.com/nutgram/nutgram/pull/194

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.3...3.7.4
Source code(tar.gz)
Source code(zip)
3.7.3(Sep 9, 2022)
What's Changed

allow override low level call by @SergiX44 in https://github.com/nutgram/nutgram/pull/193

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.2...3.7.3
Source code(tar.gz)
Source code(zip)
3.7.2(Sep 2, 2022)
What's Changed

switch to laravel serializable closure by @SergiX44 in https://github.com/nutgram/nutgram/pull/192

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.1...3.7.2
Source code(tar.gz)
Source code(zip)
3.7.1(Aug 23, 2022)
What's Changed

ability to retrieve the current conversation from outside the context by @SergiX44 in https://github.com/nutgram/nutgram/pull/191

Full Changelog: https://github.com/nutgram/nutgram/compare/3.7.0...3.7.1
Source code(tar.gz)
Source code(zip)
3.7.0(Aug 12, 2022)
What's Changed

move wordwrap to helper class by @SergiX44 in https://github.com/nutgram/nutgram/pull/187

bot api 6.2 by @SergiX44 in https://github.com/nutgram/nutgram/pull/189

Full Changelog: https://github.com/nutgram/nutgram/compare/3.6.0...3.7.0
Source code(tar.gz)
Source code(zip)
3.6.0(Aug 1, 2022)
What's Changed

Message chunk support by @Lukasss93 in https://github.com/nutgram/nutgram/pull/174

Fix null token by @miki131 in https://github.com/nutgram/nutgram/pull/177

Serializable instance by @SergiX44 in https://github.com/nutgram/nutgram/pull/172

Fixed class name and namespace issue when creating command by @mkhab7 in https://github.com/nutgram/nutgram/pull/180

Add nutgram:ide:generate command by @Lukasss93 in https://github.com/nutgram/nutgram/pull/181

Raise psalm error level by @SergiX44 in https://github.com/nutgram/nutgram/pull/185

support bot_id cache by @SergiX44 in https://github.com/nutgram/nutgram/pull/184

New Contributors

@miki131 made their first contribution in https://github.com/nutgram/nutgram/pull/177

Full Changelog: https://github.com/nutgram/nutgram/compare/3.5.1...3.6.0
Source code(tar.gz)
Source code(zip)
3.5.1(Jul 1, 2022)
What's Changed

Fix wrong $clientOpt merge in laravel mixins by @Lukasss93 in https://github.com/nutgram/nutgram/pull/169

Full Changelog: https://github.com/nutgram/nutgram/compare/3.5.0...3.5.1
Source code(tar.gz)
Source code(zip)
3.5.0(Jun 26, 2022)
What's Changed

Add Nutgram mixins by @Lukasss93 in https://github.com/nutgram/nutgram/pull/165

Add nutgram:make:x commands by @Lukasss93 in https://github.com/nutgram/nutgram/pull/167

Full Changelog: https://github.com/nutgram/nutgram/compare/3.4.0...3.5.0
Source code(tar.gz)
Source code(zip)
3.4.0(Jun 21, 2022)
What's Changed

Update to Bot Api 6.1 by @Lukasss93 in https://github.com/nutgram/nutgram/pull/163

Full Changelog: https://github.com/nutgram/nutgram/compare/3.3.0...3.4.0
Source code(tar.gz)
Source code(zip)
3.3.0(Jun 20, 2022)
What's Changed

Local path transformer by @Lukasss93 in https://github.com/nutgram/nutgram/pull/160

Fixed downloadFile method when "is_local" config key is true

Fixed missing phpdoc on jsonSerialize methods

Full Changelog: https://github.com/nutgram/nutgram/compare/3.2.1...3.3.0
Source code(tar.gz)
Source code(zip)
3.2.1(May 15, 2022)
The "explanation_entities" field mapping is now optional.

Full Changelog: https://github.com/nutgram/nutgram/compare/3.2.0...3.2.1
Source code(tar.gz)
Source code(zip)
3.2.0(May 14, 2022)
What's Changed

Apply fixes from StyleCI by @SergiX44 in https://github.com/nutgram/nutgram/pull/153

Support webapp test env by @SergiX44 in https://github.com/nutgram/nutgram/pull/154

serialization issues & constructor by @SergiX44 in https://github.com/nutgram/nutgram/pull/155

consider opt param by @SergiX44 in https://github.com/nutgram/nutgram/pull/156

Full Changelog: https://github.com/nutgram/nutgram/compare/3.1.4...3.2.0
Source code(tar.gz)
Source code(zip)
3.1.4(May 12, 2022)
Code improvements

Full Changelog: https://github.com/nutgram/nutgram/compare/3.1.3...3.1.4
Source code(tar.gz)
Source code(zip)
3.1.3(May 10, 2022)
What's Changed

fix inline_message_id handling by @SergiX44 in https://github.com/nutgram/nutgram/pull/150

Full Changelog: https://github.com/nutgram/nutgram/compare/3.1.2...3.1.3
Source code(tar.gz)
Source code(zip)
3.1.2(Apr 26, 2022)
What's Changed

Fix ChatMember traits by @Lukasss93 in https://github.com/nutgram/nutgram/pull/147

Fix phpdoc on trait by @Lukasss93 in https://github.com/nutgram/nutgram/pull/148

Full Changelog: https://github.com/nutgram/nutgram/compare/3.1.1...3.1.2
Source code(tar.gz)
Source code(zip)
3.1.1(Apr 25, 2022)
What's Changed

hotfix by @SergiX44 in https://github.com/nutgram/nutgram/pull/146

Full Changelog: https://github.com/nutgram/nutgram/compare/3.1.0...3.1.1
Source code(tar.gz)
Source code(zip)
3.1.0(Apr 25, 2022)
What's Changed

Swap mapper implementation by @SergiX44 in https://github.com/nutgram/nutgram/pull/144

add a way to disable error handlers by @SergiX44 in https://github.com/nutgram/nutgram/pull/145

Full Changelog: https://github.com/nutgram/nutgram/compare/3.0.0...3.1.0
Source code(tar.gz)
Source code(zip)
3.0.0(Apr 17, 2022)
3.0.0 - 2022-04-17

Added

Support for bot api 6.0

Full Changelog: https://github.com/nutgram/nutgram/compare/2.1.1...3.0.0

⚠️ Check the upgrade guide in the Official Upgrade Documentation.
Source code(tar.gz)
Source code(zip)
2.1.1(Mar 31, 2022)
2.1.1 - 2022-03-31

Fixed

Fix assertions with multipart requests (https://github.com/nutgram/nutgram/pull/136)

Source code(tar.gz)
Source code(zip)
2.1(Mar 20, 2022)
What's Changed

Added

Added copy method to Message type (https://github.com/nutgram/nutgram/pull/124)

Added forward method to Message type (https://github.com/nutgram/nutgram/pull/126)

Added a new Laravel command: nutgram:list (https://github.com/nutgram/nutgram/pull/130)

Changed

Added date format to last_error_date field in nutgram:hook:info command (https://github.com/nutgram/nutgram/commit/aa68971be8ff6789b36d682dd50cb788e9b2693c)

Full Changelog: https://github.com/nutgram/nutgram/compare/2.0.0...2.1
Source code(tar.gz)
Source code(zip)
2.0.0(Mar 14, 2022)
What's Changed

All types extend the BaseType class (https://github.com/nutgram/nutgram/pull/118)

Nutgram and BaseType extends Macroable class (https://github.com/nutgram/nutgram/pull/118)

Added testing system (https://github.com/nutgram/nutgram/pull/101)

Added helpers method to Message type: delete() and editText() (https://github.com/nutgram/nutgram/pull/118)

Full Changelog: https://github.com/nutgram/nutgram/compare/1.4.1...2.0.0
Source code(tar.gz)
Source code(zip)

Owner

Sergio Brighenti

while(1) pcntl_fork();

GitHub https://sergix44.github.io/Nutgram/

The Telegram bot framework that doesn't drive you nuts.

Related tags

Overview

Nutgram

Installation

Usage

Testing

Changelog

Credits

License

Comments

Describe the bug

To Reproduce

Expected behavior

Screenshots

Additional context

Describe the bug

Expected behavior

Additional context

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Nutgram version

Describe the bug

To Reproduce

Expected behavior

Screenshots

Additional context

Before

After

Path : app/Telegram/Commands/Admin/Product/Create.php

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Nutgram version

Describe the bug

To Reproduce

Expected behavior

Screenshots

Additional context

Releases(3.10.0)

3.10.0(Dec 31, 2022)

What's Changed

New Contributors

3.9.0(Nov 17, 2022)

What's Changed

3.8.1(Nov 16, 2022)

What's Changed

3.8.0(Nov 7, 2022)

What's Changed

3.7.9(Nov 3, 2022)

What's Changed

3.7.8(Oct 17, 2022)

What's Changed

3.7.7(Sep 22, 2022)

What's Changed

3.7.6(Sep 17, 2022)

What's Changed

3.7.5(Sep 11, 2022)

What's Changed

3.7.4(Sep 10, 2022)

What's Changed

3.7.3(Sep 9, 2022)

What's Changed

3.7.2(Sep 2, 2022)

What's Changed

3.7.1(Aug 23, 2022)

What's Changed

3.7.0(Aug 12, 2022)

What's Changed

3.6.0(Aug 1, 2022)

What's Changed

New Contributors

3.5.1(Jul 1, 2022)

What's Changed

3.5.0(Jun 26, 2022)

What's Changed

3.4.0(Jun 21, 2022)