add telegram agent #1381

tomknig · 2016-03-27T23:02:28Z

Hi, this agent aims to be an alternative to notifications via slack, sms or email. It makes use of the telegram bot api to post values of events via telegram.
The simple case is sending the value of a text field of an event. More interesting is fetching the image behind the url in a photo field of an event and send it to you. This enables you e.g. to check for the latest xkcd and receive the image itself via telegram. The same is true for audio, video and document keys accordingly.

I decided to add the dependency to telegram-bot-ruby since it is a welcome abstraction of the api but more importantly of the multipart uploads that are necessary for the mentioned use of file sendings. As far as I know, the latter could not easily be done with httparty, which already is an dependency, but would at least require another dependency such as httmultiparty. So that's why I thought it's worth including telegram-bot-ruby.

I am happy to get any feedback on my thoughts and the code. Thanks for huginn! :)

cantino · 2016-03-29T05:04:58Z

Awesome @tomknig, thanks! Do you have any sense how hard it would be to make it work with httparty + httmultiparty?

tomknig · 2016-03-29T05:17:18Z

I think the sending messages part wouldn't be too hard. Although I look forward to add support for telegram commands, which could be used to partly remote control huginn. Something like sending huginn messages such as /run XKCD Scraper or /get latest .. would be pretty interesting I think. So using the included gem therefore would be pretty handy.
I look into implementing the sending part with httmultiparty, shouldn't be too hard!

tomknig · 2016-03-29T06:48:36Z

So I migrated the code to httmultiparty, which I now added to the Gemfile explicitly. It was already included as dependency of hypdf which I bumped in the Gemfile to 1.0.10, since it previously locked the version of httmultiparty. Seems legit to me, since it is only a tiny-version upgrade and the test-suite still passes :)

What do you think?

…ttmultiparty

cantino · 2016-03-30T04:04:39Z

app/models/agents/telegram_agent.rb

+      It is assumed that events have either a `text`, `photo`, `audio`, `document` or `video` key. You can use the EventFormattingAgent if your event does not provide these keys.
+
+      The value of `text` key is sent as a plain text message.
+      The value of `photo`, `audio`, `document` and `video` keys should be an url which contents are sent to you according to the type.


Minor: maybe "should be a url whose contents will be sent to you".

cantino · 2016-03-30T04:12:03Z

Awesome @tomknig!

- minor improvements of the description - use HTTMultiParty directly, instead of including it - ensure that tempfiles are closed and unlinked

tomknig · 2016-03-30T07:37:23Z

Thank you for the valuable feedback, @cantino! I would be happy if you could review the file closing and unlinking.

cantino · 2016-03-31T02:35:53Z

Looks great to me, thanks!

Pcsl · 2016-04-01T05:21:09Z

Thanks for your work I love the way Telegram lets you handle bots. It's a really useful intermediate way between instant email and feeds.

I think there is an error in the description:

Obtain your private chat_id from the recently started conversation by visiting https://api.telegram.org/bot/getUpdates

It should be https://api.telegram.org/bot/getUpdates instead (or any other way you think you can state you need to insert there the auth_token.

tomknig · 2016-04-01T06:41:25Z

Hi @Pcsl, thank you! I think I don't really understand what you mean.
The BotFather will send you the private auth_token of your newly created bot in step 1. To get the updates of that specific bot, you have to visit https://api.telegram.org/bot <auth_token> /getUpdates and replace the <auth_token> with you private auth_token...

tomknig · 2016-04-01T06:46:15Z

app/models/agents/telegram_agent.rb

+
+      1. Obtain an `auth_token` by [creating a new bot](https://telegram.me/botfather).
+      2. Send a private message to your bot by visiting https://telegram.me/YourHuginnBot
+      3. Obtain your private `chat_id` from the recently started conversation by visiting https://api.telegram.org/bot<auth_token>/getUpdates


Okay, that is why I was confused. The description contains the auth_token, but markdown seems to omit it! Thank you for reporting that!

Yeah, that was it. Thank you for your hard work!

tomknig · 2016-04-01T07:05:42Z

I fix that in #1399, thanks @Pcsl!

jarlave · 2016-07-22T12:15:29Z

I have a problem wit this Agent, maybe I don't understand how to use it right.
I added my auth_token and the chat_id @Testtest
now it get an event with this: {"text":"Just a test"}

Is this right? If yes, I don't get messages.

If I try it over my browser with this URL
https://api.telegram.org/bot<auth_token>/sendMessage?chat_id=@testest&text=Testing%20if%20this%20works

get a message, a bit strange.

tomknig · 2016-07-22T18:45:27Z

Hi @jarlave,

i think the problem is probably the incorrect chat_id. You have to obtain your chat_id from the conversation by visiting https://api.telegram.org/bot<auth_token>/getUpdates. Got to replace <auth_token> with your auth token... Hope that helps!

jarlave · 2016-07-26T07:44:51Z

Ok, thanks, now it works, don't know what I did wron last time, now I need to find out how to make newline because %0A isn't working with this agent.

tomknig · 2016-07-26T08:05:36Z

👍 you did try \n I guess?

Am 26.07.2016 um 09:45 schrieb jarlave notifications@github.com:

Ok, thanks, now it works, don't know what I did wron last time, now I need to find out how to make newline because %0A isn't working with this agent.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

Pcsl · 2016-07-26T13:10:16Z

\n works for me. Just take into account that when editing the agent for some reason a new slash is added so that can cause problems. Just make sure you are using \n and not \n

jarlave · 2016-07-26T20:27:52Z

I tried both, \n (single slash) and \n (double slash) in the event formating agent to send it to the telegram agent, nothing works, What is wrong.

dsander · 2016-07-26T21:40:13Z

@jarlave Does using {% line_break %} in the EventFormattingAgent work?

jarlave · 2016-07-27T06:48:39Z

Yes, this works, thanks to all! That was a tough nut to crack :D

tomknig · 2016-07-27T07:11:26Z

Cool! And thanks for the support! :)

implement basic telegram agent

adc1dee

tomknig changed the title ~~implement basic telegram agent~~ add telegram agent Mar 28, 2016

remove dependency to telegram client; migrate the according code to h…

c54b68d

…ttmultiparty

cantino reviewed Mar 30, 2016
View reviewed changes

Minor refactoring regarding feedback of @cantino:

2995029

- minor improvements of the description - use HTTMultiParty directly, instead of including it - ensure that tempfiles are closed and unlinked

cantino merged commit 85d901b into huginn:master Mar 31, 2016

tomknig reviewed Apr 1, 2016
View reviewed changes

tomknig mentioned this pull request Apr 1, 2016

escape the otherwise omitted auth_token within the telegram agents getUpdates address #1399

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add telegram agent #1381

add telegram agent #1381

tomknig commented Mar 27, 2016

cantino commented Mar 29, 2016

tomknig commented Mar 29, 2016

tomknig commented Mar 29, 2016

cantino Mar 30, 2016

cantino commented Mar 30, 2016

tomknig commented Mar 30, 2016

cantino commented Mar 31, 2016

Pcsl commented Apr 1, 2016

tomknig commented Apr 1, 2016

tomknig Apr 1, 2016

Pcsl Apr 2, 2016

tomknig commented Apr 1, 2016

jarlave commented Jul 22, 2016

tomknig commented Jul 22, 2016

jarlave commented Jul 26, 2016

tomknig commented Jul 26, 2016

Pcsl commented Jul 26, 2016

jarlave commented Jul 26, 2016

dsander commented Jul 26, 2016

jarlave commented Jul 27, 2016

tomknig commented Jul 27, 2016 •

edited by cantino

add telegram agent #1381

add telegram agent #1381

Conversation

tomknig commented Mar 27, 2016

cantino commented Mar 29, 2016

tomknig commented Mar 29, 2016

tomknig commented Mar 29, 2016

cantino Mar 30, 2016

Choose a reason for hiding this comment

cantino commented Mar 30, 2016

tomknig commented Mar 30, 2016

cantino commented Mar 31, 2016

Pcsl commented Apr 1, 2016

tomknig commented Apr 1, 2016

tomknig Apr 1, 2016

Choose a reason for hiding this comment

Pcsl Apr 2, 2016

Choose a reason for hiding this comment

tomknig commented Apr 1, 2016

jarlave commented Jul 22, 2016

tomknig commented Jul 22, 2016

jarlave commented Jul 26, 2016

tomknig commented Jul 26, 2016

Pcsl commented Jul 26, 2016

jarlave commented Jul 26, 2016

dsander commented Jul 26, 2016

jarlave commented Jul 27, 2016

tomknig commented Jul 27, 2016 • edited by cantino

tomknig commented Jul 27, 2016 •

edited by cantino