telegram_bot_ruby 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0d1012d03a804514e62c759b57bd498e3e788b7
-  data.tar.gz: 4a7b444e273ced43bba6b6d908adc21b8e226c0a
+  metadata.gz: 5a4984bb585eb4f2590080ba9c3cd2ba4f7bca2d
+  data.tar.gz: 0e27c1c8b74e0d43b1a0e38e13bb2303093fca3c
 SHA512:
-  metadata.gz: b498e2c431bb5a01c777ae393f312e540c4b68d824cc02130eabeea1ad7a3f50e40a0ef58bef282e6145aaf685b5c48193a8cfac4866a6921746e715c941bf96
-  data.tar.gz: d2be7bb60aefda2f0a5f6dc3a1374975fbb824d1de79325da1622f2ce31f5519de65dbe0a9d914513d1c820519eb36dbaad225ba1054c80e4ffde4f40d257192
+  metadata.gz: b7d61fc109eee58ec9f89eebd98a33a00917dc4b5b69e8d0c3c3116b8fb743c6548657693cd44e2125bb6cdbfd457f2103ce2d52a26612b8fd1ab1d3716e5b45
+  data.tar.gz: abde2a9ea7307cd81da65f97391eeec4b0256c665abcc8b0a7b332677825e80e1c492bf0da86728352334f5ae1b97eee3721b30af804296fcfa40f42a706a321

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 $ gem install telegram_bot_ruby
 ```
 
-## Usage
+## Quick start
 
 ### Set up client
 
@@ -68,9 +68,143 @@ end
 
 ```ruby
 # register service at telegram or start long polling
+trap(:INT) {
+    bot.stop!
+}
 bot.start!
 ```
 
+## Documentation
+
+### Matchers
+
+**anything/fallback matcher**
+
+```ruby
+on :anything
+on :fallback
+```
+
+**text matcher**
+
+```ruby
+# match when message.type == :text
+on :text do |txt|
+end
+
+# arguments are given by `MatchData#to_a`
+on :text, /reply me with (.*)/ do |matched_text, reply_txt|
+    send_message reply_txt
+end
+```
+
+**command matcher**
+
+```ruby
+on :command, :ping do
+    reply 'pong'
+end
+
+# handling requests like `/plus 1 2`
+on :command :plus do |*args|
+    reply args.map(&:to_i).sum.to_s
+end
+
+# or handle all commands
+on :command do |cmd, *args|
+    case cmd
+    when 'echo'
+        reply args.join(' ')
+    when 'rand'
+        reply rand.to_s
+    else
+        reply "unknown command #{cmd}"
+    end
+end
+```
+
+### Telegram Types
+
+Check the classes that include this module:
+
+http://www.rubydoc.info/gems/telegram_bot_ruby/TelegramBot/AutoFromMethods
+
+### Bot methods
+
+```
+# msg: message object, or message id
+# to: chat/user object or chat/user id
+TelegramBot#forward_message(msg, to, from = nil)
+
+TelegramBot#get_me => User
+
+CHAT_ACTIONS = [
+  :typing,
+  :upload_photo,
+  :record_video,
+  :update_video,
+  :record_audio,
+  :upload_audio,
+  :upload_document,
+  :find_location
+]
+# chat: {chat,user} {object,id}
+# action: CHAT_ACTIONS.sample
+TelegramBot#send_chat_action(chat, action)
+
+
+# chat: {chat,user} {object,id}
+# text: text content of the message
+# disable_web_page_preview: see Telegram doc
+# reply_to: message object or id
+# reply_markup: a keyboard markup, see example below
+send_message(chat,
+             text,
+             disable_web_page_preview: nil,
+             reply_to: nil,
+             reply_markup: nil)
+
+
+# example keyboard markup
+markup = {
+    keyboard: [
+        ["1", "2"],
+        ["3", "4", "5"],
+        ["6"]
+    ],
+    selective: false
+}
+```
+
+### Shorthand methods
+
+shorthand methods can be used within the handler block, with the
+received message as context. [rubydoc.info](http://www.rubydoc.info/gems/telegram_bot_ruby/TelegramBot/ShorthandMethods)
+
+```ruby
+reply(text, *args)
+send_message(text, *args)
+forward_message(to, *args)
+send_chat_action(action, *args)
+```
+
+### Handler context variables/methods
+
+Other than the shorthand above, within the handler block, these
+contextual variable are accessible:
+
+```
+bot            # the current TelegramBot instance
+bot.history    # request histories :: [Message]
+bot.start!     # start polling
+bot.stop!      # quit the bot
+
+message        # the message just received
+message.<attr> # message attributes
+matcher        # current matcher object
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/shouya/telegram-bot.

data/lib/telegram_bot/date.rb

@@ -7,9 +7,6 @@ class TelegramBot::Date
   def self.members
     []
   end
-  def members
-    self.class.members
-  end
 
   def self.from(date)
     case date
@@ -29,8 +26,12 @@ class TelegramBot::Date
 
   attr_accessor :datetime
 
+  def members
+    self.class.members
+  end
+
   def initialize(datetime)
-    @self.datetime = datetime
+    @datetime = datetime
   end
 
   def method_missing(sym, *args, &blk)

data/lib/telegram_bot/document.rb

@@ -12,7 +12,7 @@ class TelegramBot::Document <
 
   def self.extra_types
     {
-      thumb: PhotoSize
+      thumb: TelegramBot::PhotoSize
     }
   end
 end

data/lib/telegram_bot/request_methods.rb

@@ -25,9 +25,8 @@ class TelegramBot
         chat_id: Chat.from(chat).id,
         text: text,
         disable_web_page_preview: disable_web_page_preview,
-        reply_to_message_id: reply_to && reply_to.id
-        # TODO:
-        # reply_markup: reply_markup
+        reply_to_message_id: reply_to && reply_to.id,
+        reply_markup: reply_markup ? reply_markup.to_json : nil
       }.reject {|_,v| v.nil?}
 
       Message.from(request(:send_message, params))

data/lib/telegram_bot/shorthand_methods.rb

@@ -1,10 +1,10 @@
 module TelegramBot::ShorthandMethods
-  def send_message(text, *args, to: message.chat)
-    bot.send_message(to, text, *args)
+  def send_message(text, *args, to: message.chat, **opts)
+    bot.send_message(to, text, *args, **opts)
   end
 
-  def reply(text, *args, to: message.chat)
-    bot.send_message(to, text, *args, reply_to: message)
+  def reply(text, *args, to: message.chat, **opts)
+    bot.send_message(to, text, *args, reply_to: message, **opts)
   end
 
   def forward_message(to)

data/lib/telegram_bot/sticker.rb

@@ -13,7 +13,7 @@ class TelegramBot::Sticker <
 
   def self.extra_types
     {
-      thumb: PhotoSize
+      thumb: TelegramBot::PhotoSize
     }
   end
 end

data/lib/telegram_bot/version.rb

@@ -1,3 +1,3 @@
 class TelegramBot
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/telegram_bot/video.rb

@@ -20,7 +20,7 @@ class TelegramBot::Video <
 
   def self.extra_types
     {
-      thumb: PhotoSize
+      thumb: TelegramBot::PhotoSize
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_bot_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Shou Ya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client