telegram-bot-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6275009e6d9d48cb1baa1eb7f4708ca5e15367c4
-  data.tar.gz: 8068393666fa87920092009459eaefd08602225d
+  metadata.gz: 42f3aaa643f89d7ac2534a93a9867567706c3412
+  data.tar.gz: c1e130a68c7e98375a0c536ebe8a62f16bdc5990
 SHA512:
-  metadata.gz: c32c1cfa04b6b71cba29598c8973c0692ed0448e56896930bd1bb57e9ca5b66b57a524dc3aa40e082524e0db968aa9cf7220f622977b6cb9f1c9ce853c3ee0c6
-  data.tar.gz: 1b51d368865b665dda6d057e9f5d675c5a389b5bdb28f8bc0bce070ccf7eba29838829a3559b0f5a5c9e2c1bc0b62eaa8c196e4c081d44a3862f34af14a24baa
+  metadata.gz: 6a030e8417d75db739206e74cafae2502d0cfe97b5dd584ec9880d391fea050a0dd4e9102374fdba347d8a1c6ac88772bbf517857740132562f620e8cfa4cce2
+  data.tar.gz: 5a226a421b69610e6d691ea0aeeb91a7c455ddf0ff82f70d518625b18c12ff4f7730953bc6bfd448bd40ca740ddd85183af67e7699de8a4d3abcead5d800bf87

data/README.md

@@ -1,4 +1,4 @@
-# telegram-bot
+# telegram-bot-ruby
 
 Ruby wrapper for [Telegram's Bot API](https://core.telegram.org/bots/api).
 
@@ -7,7 +7,7 @@ Ruby wrapper for [Telegram's Bot API](https://core.telegram.org/bots/api).
 Add following line to your Gemfile:
 
 ```ruby
-gem 'telegram-bot', github: 'atipugin/telegram-bot'
+gem 'telegram-bot-ruby'
 ```
 
 And then execute:
@@ -16,14 +16,22 @@ And then execute:
 $ bundle
 ```
 
+Or install it system-wide:
+
+```shell
+$ gem install telegram-bot-ruby
+```
+
 ## Usage
 
 First things first, you need to [obtain a token](https://core.telegram.org/bots#botfather) for your bot. Then create your Telegram bot like this:
 
 ```ruby
+require 'telegram/bot'
+
 token = 'YOUR_TELEGRAM_BOT_API_TOKEN'
 
-Telegram::Bot::Runner.run(token) do |bot|
+Telegram::Bot::Client.run(token) do |bot|
   bot.listen do |message|
     case message.text
     when /^hello/
@@ -33,6 +41,10 @@ Telegram::Bot::Runner.run(token) do |bot|
 end
 ```
 
+Note that `bot.api` object implements [Telegram Bot API methods](https://core.telegram.org/bots/api#available-methods) as is. So you can invoke any method inside the block without any problems.
+
+Same thing about `message` object - it implements [Message](https://core.telegram.org/bots/api#message) spec, so you always know what to expect from it.
+
 ## Contributing
 
 1. Fork it

data/lib/telegram/bot.rb

@@ -4,5 +4,5 @@ require 'virtus'
 
 require 'telegram/bot/api'
 require 'telegram/bot/types'
-require 'telegram/bot/runner'
+require 'telegram/bot/client'
 require 'telegram/bot/version'

data/lib/telegram/bot/{runner.rb → client.rb}

@@ -1,6 +1,6 @@
 module Telegram
   module Bot
-    class Runner
+    class Client
       attr_reader :api, :offset
 
       def self.run(*args, &block)

data/lib/telegram/bot/version.rb

@@ -1,5 +1,5 @@
 module Telegram
   module Bot
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telegram-bot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Tipugin
@@ -125,7 +125,7 @@ files:
 - bin/setup
 - lib/telegram/bot.rb
 - lib/telegram/bot/api.rb
-- lib/telegram/bot/runner.rb
+- lib/telegram/bot/client.rb
 - lib/telegram/bot/types.rb
 - lib/telegram/bot/types/audio.rb
 - lib/telegram/bot/types/base.rb
@@ -140,7 +140,7 @@ files:
 - lib/telegram/bot/types/user.rb
 - lib/telegram/bot/types/video.rb
 - lib/telegram/bot/version.rb
-- telegram-bot.gemspec
+- telegram-bot-ruby.gemspec
 homepage: https://github.com/atipugin/telegram-bot
 licenses: []
 metadata: {}