telegram_bot 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0e96a036eb8842252f8905e9686702b902578c7
-  data.tar.gz: a20ea036287e3f2b25a14dcf7ef9950230b6f765
+  metadata.gz: 346a299cac50693e640fa05f84230a3b287b8d5e
+  data.tar.gz: 72b1b56a15773f289c294f7c511e75feb5e3560d
 SHA512:
-  metadata.gz: f61ea704d8c9586a4792f3f579c8da67e65366ed1462bde4c8b24909cf31ac2f4d5ae1042c84877caa79ddcc2d529503a4afcd2e714ea212012d517c49c4be67
-  data.tar.gz: d9df7f17c4a725fb8b7f7bf7cc4f7c3e8c23cacc1c6756026107d31b6eb8a2e415a24c4474954b1e2a300b028f3991619215c615d48a6af69512f4911faac5f4
+  metadata.gz: 7bae1c4f717dfdb9f858ef37f14b96c2b09f4386eea894d4b204188cc1dc00c597d5daf32465356f16155fa105343d89ce7a63a4c32b01e730c58251a11fbe9e
+  data.tar.gz: 38a2b016b63e6a24f3d5a2b608dfde18f5d91662d478e3de3fc15f6095215e20be60e844dd3b7fc1335b376deb404c128031281467c00d0c41922f184a36fd4c

data/README.md

@@ -12,7 +12,7 @@ Please [collaborate](https://github.com/eljojo/telegram_bot/issues/new) with you
 Add this line to your application's Gemfile (currently under development):
 
 ```ruby
-gem 'telegram_bot', github: 'eljojo/telegram_bot'
+gem 'telegram_bot'
 ```
 
 And then execute:
@@ -26,8 +26,8 @@ Here's an example:
 ```ruby
 require 'telegram_bot'
 
-bot = TelegramBot.new('[YOUR TELEGRAM BOT TOKEN GOES HERE]')
-bot.get_updates do |message|
+bot = TelegramBot.new(token: '[YOUR TELEGRAM BOT TOKEN GOES HERE]')
+bot.get_updates(fail_silently: true) do |message|
   puts "@#{message.from.username}: #{message.text}"
   command = message.get_command_for(bot)
 
@@ -63,6 +63,53 @@ You can find more info [here](https://core.telegram.org/bots).
 
 ![How to get Token](http://i.imgur.com/90ya4Oe.png)
 
+## What else can it do?
+
+you can pass options to the bot initializer:
+```ruby
+bot = TelegramBot.new(token: 'abc', logger: Logger.new(STDOUT), offset: 123, timeout: 20)
+```
+
+if you don't want to start the loop, don't pass a block to ``#get_updates`` and you'll get an array with the latest messages:
+```ruby
+messages = bot.get_updates(timeout: 30, offset: 123)
+```
+
+Because things can go wrong sometimes with the API, there's a ``fail_silently`` option that you can pass to ``#get_updates`` like this:
+```ruby
+bot.get_updates(fail_silently: true) do |message|
+    puts message.text
+end
+```
+
+A message has several attributes:
+```ruby
+message = bot.get_updates.last
+
+# message data
+message.text # "hello moto"
+message.date # Wed, 01 Jul 2015 09:52:54 +0200 (DateTime)
+
+# reading user
+message.from # TelegramBot::User
+message.from.first_name # "Homer"
+message.from.last_name  # "Simpson"
+message.from.username   # "mr_x"
+
+# channel
+message.channel.id # 123123123 (telegram's id)
+
+# reply
+message.reply do |reply|
+    reply.text = "homer please clean the garage"
+    reply.send_with(bot)
+end
+# or
+reply = message.reply
+reply.text = "i'll do it after going to moe's"
+bot.send_message(reply)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/eljojo/telegram_bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/example/bot.rb

@@ -4,10 +4,10 @@ require 'logger'
 
 logger = Logger.new(STDOUT, Logger::DEBUG)
 
-bot = TelegramBot.new('YOUR KEY GOES HERE')
+bot = TelegramBot.new(token: 'YOUR KEY GOES HERE', logger: logger)
 logger.debug "starting telegram bot"
 
-bot.get_updates do |message|
+bot.get_updates(fail_silently: true) do |message|
   logger.info "@#{message.from.username}: #{message.text}"
   command = message.get_command_for(bot)
 

data/lib/telegram_bot/bot.rb

@@ -55,9 +55,9 @@ module TelegramBot
 
     def get_last_updates(opts = {})
       response = request(:getUpdates, offset: opts[:offset] || @offset, timeout: opts[:timeout] || @timeout)
-      if opts[:fail_silently]
+      if opts[:fail_silently] && (!response.ok? || !response.result)
         logger.warn "error when getting updates. ignoring due to fail_silently."
-        return [] if !response.ok? || !response.result
+        return []
       end
       updates = response.result.map{|raw_update| Update.new(raw_update) }
       @offset = updates.last.id + 1 if updates.any?

data/lib/telegram_bot/version.rb

@@ -1,3 +1,3 @@
 module TelegramBot
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_bot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - José Tomás Albornoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon