icqbot 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad954e93e3dfea76ebf298daf4ac1eaccdbbd09cbf455961d7e059682c410e6b
-  data.tar.gz: 57c3ff74c3367bd8de40e73c24204155061e69278c0ae90ac3a44776e112e170
+  metadata.gz: 2476d6444ccc42193d8107657feda1832784bede5714c6a4f7734ab51cd26b71
+  data.tar.gz: d813abef94c9e009ba7b1a2cc0dae3505b3cac053188f4a52f4bbf67afbac5bf
 SHA512:
-  metadata.gz: a033630de3734747ed6f07ab28c579bd2cc113afb8d64c9a73803f40fef5285c88b3df0e8d1906ffbb4c1def41d7d92df1c1b8e0a2e716546d25bf007b29e846
-  data.tar.gz: 344731d2f7c803bcdb2d5f486cfb2f3ac7c5dcfb348af9ac9ecc713c1ebf17395f43973bd20040cf483ee11fc30e902d28effcfdfe8d1207a4e119040ce2a502
+  metadata.gz: c0eab2d54a5842addbaa53267b8209d0227c5be8fa790e31c7894f050ce6ff94d2630c02f3f346a32d65e40311fd31a28c5459bf965a0d776ac4ae5731bc063b
+  data.tar.gz: 1a3a4437f11ccd39128a777e588d1f723bb9fc648fac18eeb217239a8bd5e550149e923a90f88e356d82016666de6ff7e04039c841c722ea27686584ba86d22f

data/.gitignore

@@ -1,3 +1,4 @@
 .bundle
 test
-Gemfile.lock
+Gemfile.lock
+*.gem

data/README.md

@@ -1,5 +1,5 @@
 
-icq-bot-ruby in working :zzz: 
+icq-bot-ruby :diamonds:
 ------------
 Ruby wrapper for [ICQ Bot API](https://icq.com/botapi/)
 
@@ -21,6 +21,7 @@ ICQ::Bot.new('token') do |bot|
   end
 end
 ```
+more examples in `bin/`
 
 ## Docs
 * **[Documentation](./doc/overview.md)**

data/bin/bot_with_handlers.rb

@@ -0,0 +1,13 @@
+require 'icqbot'
+
+bot = ICQ::Bot.new('TOKEN')
+
+bot.add_handler '/help', -> (event) do
+  bot.send_msg 'command help don\'t work', event.chat_id
+end
+
+bot.add_handler '/disable', -> (event) do
+  exit 0
+end
+
+bot.listen {}

data/doc/bot.md

@@ -23,6 +23,20 @@ def listen
 bot.loop = false
 ```
 
+## Добавить handler(обработчик событий)
+```ruby
+def add_handler text, handler
+```
+1. `text` - текст события.
+2. `handler` - анонимная функция(принимает объект типа [Event](./event.md)), которая сработает при получение события с текстом идентичном `text`.
+
+## Добавить callback handler
+```ruby
+def add_callback_handler data, handler
+```
+1. `data` - текст события..
+2. `handler` - анонимная функция(принимает объект типа [Event](./event.md)), которая сработает при получение callback события с идентификатор идентичным `data`.
+
 ## Отправить сообщение
 ```ruby
 def send_msg msg, chat_id # -> Hash
@@ -69,4 +83,57 @@ def get_blocked_users chat_id # -> [Hash]
 ```ruby
 def get_admins chat_id # -> [Hash]
 ```
-1. `chat_id` - ID чата, откуда надо получить список aдминов.
+1. `chat_id` - ID чата, откуда надо получить список aдминов.
+
+# Chat administration
+Для работы этих методов бот должен иметь права администрации. 
+
+## Установка названия чата
+```ruby
+def set_title chat_id, title # -> Hash
+```
+1. `chat_id` - ID чата.
+2. `title` - новое название чата.
+
+## Установка описания чата
+```ruby
+def set_about chat_id, about # -> Hash
+```
+1. `chat_id` - ID чата.
+2. `about` - новое описание чата. 
+
+## Установка правил чата
+```ruby
+def set_rules chat_id, rules # -> Hash
+```
+1. `chat_id` - ID чата.
+2. `rules` - правила чата.
+
+## Закрепить сообщение
+```ruby
+def pin_msg msg_id, chat_id # -> Hash
+```
+1. `msg_id` - ID сообщения, что нужно закрепить.
+2. `chat_id` - ID чата.
+
+## Открепить сообщение
+```ruby
+def unpin_msg msg_id, chat_id # -> Hash
+```
+1. `msg_id` - ID сообщения, что нужно открепить.
+2. `chat_id` - ID чата.
+
+## Забанить участника
+```ruby
+def block_user user_id, chat_id, del_last_msg=false # -> Hash
+```
+1. `user_id` - ID пользователя, который должен отлететь в бан.
+2. `chat_id` - ID чата, где забанят.
+3. `del_last_msg` - удалить или нет последние сообщение пользователя. 
+
+## Разбанить участника
+```ruby
+def unblock_user user_id, chat_id # -> Hash
+```
+1. `user_id` - ID пользователя, который должен вернуться из бана.
+2. `chat_id` - ID чата, где разабанят.

data/doc/event.md

@@ -15,19 +15,27 @@ def initialize event_h
 
 ## Аттрибуты
 ```ruby
-attr_reader :type, :text, :msg_id, :chat_id, :from
+attr_reader :type, :text, :msg_id, :chat_id, :from,
+            :data, :query_id
+```
+```ruby
 event.type    # Тип события.
 event.text    # текст приходящего события(обычно текст сообщения от юзера).
 event.msg_id  # ID пришедшего сообщения.
 event.chat_id # ID чата, в который пришло сообщения.
 event.from    # Hash | Информация от кого пришло сообщение. 
+# -- Аттрибуты для callback event --
+event.data
+event.query_id 
 ```
 
+
 ## Типы событий
 ```ruby
 module TypeEvent
     NEW_MSG     = 'newMessage'
     EDITED_MSG  = 'editedMessage'
     DELETED_MSG = 'deletedMessage'
+    CALLBACK    = 'callbackQuery'
     ... # in working
 ```

data/doc/message.md

@@ -16,5 +16,14 @@ def initialize text, *keyboard
 ```ruby
 attr_reader :text, :keyboard
 msg.text     # текст сообщения(String)
-msg.keyboard # массив объектов [Button](./button.md)
-```
+msg.keyboard # массив объектов Button
+```
+
+## Добавить кнопку
+```ruby
+def << btn
+```
+```ruby
+alias_method :append, :<<
+```
+1. `btn` - объект типа [Button](./button.md)

data/icqbot.gemspec

@@ -1,26 +1,26 @@
-require_relative './lib/icqbot.rb'
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |s|
-  s.name          = "icqbot"
-  s.version       = ICQ::VERSION
-  s.authors       = ["sheyber"]
-  s.email         = ["ukt1@ro.ru"]
-  s.license       = '0BSD'
-
-  s.summary       = %q{Ruby wrapper for ICQ Bot API.}
-  s.description   = %q{This gem is a simple and minimalistic library for creating ICQ bots.}
-  s.homepage      = "https://github.com/sheyber/icqbot"
-  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  s.metadata["homepage_uri"] = s.homepage
-
-  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  s.bindir        = 'exe'
-  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.add_dependency 'requests', '~> 1.0', '>= 1.0.2'
+require_relative './lib/icqbot.rb'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = "icqbot"
+  s.version       = ICQ::VERSION
+  s.authors       = ["sheyber"]
+  s.email         = ["ukt1@ro.ru"]
+  s.license       = '0BSD'
+
+  s.summary       = %q{Ruby wrapper for ICQ Bot API.}
+  s.description   = %q{This gem is a simple and minimalistic library for creating ICQ bots.}
+  s.homepage      = "https://github.com/sheyber/icqbot"
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  s.metadata["homepage_uri"] = s.homepage
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'requests', '~> 1.0', '>= 1.0.2'
 end

data/lib/icqbot.rb

@@ -6,5 +6,5 @@ require_relative './icqbot/user.rb'
 require_relative './icqbot/message.rb'
 
 module ICQ
-  VERSION = '0.1.2'
+  VERSION = '0.1.7'
 end

data/lib/icqbot/bot.rb

@@ -9,6 +9,11 @@ require_relative './functional/delete_msg.rb'
 require_relative './functional/chats/get_info.rb'
 require_relative './functional/chats/get_admins.rb'
 require_relative './functional/chats/get_members.rb'
+require_relative './functional/chats/administration/set_title.rb'
+require_relative './functional/chats/administration/set_about.rb'
+require_relative './functional/chats/administration/set_rules.rb'
+require_relative './functional/chats/administration/pin_unpin_msg.rb'
+require_relative './functional/chats/administration/block_unblock_user.rb'
 
 module ICQ
 
@@ -20,6 +25,8 @@ module ICQ
       @pool_time = pool_time
       @last_event_id = 0
       @loop = true
+      @handlers = {}
+      @callback_handlers = {}
       yield self if block_given?
     end
 
@@ -38,18 +45,24 @@ module ICQ
         if events and events['events'] and events['events'] != []
           last_event = events['events'].last
           @last_event_id = last_event['eventId']
-          yield ICQ::Event.new last_event
+          last_event = ICQ::Event.new last_event
+          if @handlers.has_key? last_event.text
+            @handlers[last_event.text].call last_event
+          elsif last_event.type == ICQ::TypeEvent::CALLBACK and @callback_handlers.has_key? last_event.data 
+            @callback_handlers[last_event.text].call last_event
+          else
+            yield last_event
+          end
         end
       end
     end
 
-    def last_event # FIXME: its can delete
-      events = JSON::load(get_events.body)
-      if events and events['events'] and events['events'] != []
-        last_event = events['events'].last
-        @last_event_id = last_event['eventId']
-        yield ICQ::Event.new last_event
-      end
+    def add_handler text, handler
+      @handlers[text] = handler
+    end
+
+    def add_callback_handler data, handler
+      @callback_handlers[data] = handler
     end
 
     private

data/lib/icqbot/event.rb

@@ -8,25 +8,35 @@ module ICQ
     NEW_MSG     = 'newMessage'
     EDITED_MSG  = 'editedMessage'
     DELETED_MSG = 'deletedMessage'
+    CALLBACK    = 'callbackQuery'
   end
 
   class Event
-    attr_reader :type, :text, :msg_id, :chat_id, :from
+    attr_reader :type, :text, :msg_id, :chat_id, :from,
+                :data, :query_id
 
     def initialize event_h
+      # TODO: больше информации
       @event_h = event_h
       @type = event_h['type']
-      @text = event_h['payload']['text']
-      @msg_id = event_h['payload']['msgId']
-      @chat_id = event_h['payload']['chat']['chatId']
       @from = event_h['payload']['from']
+      if @type != ICQ::TypeEvent::CALLBACK
+        @text = event_h['payload']['text']
+        @msg_id = event_h['payload']['msgId']
+        @chat_id = event_h['payload']['chat']['chatId']
+      else
+        @data = event_h['payload']['callbackData']
+        @query_id = event_h['payload']['queryId']
+        @chat_id = event_h['message']['chat']['chatId']
+      end
     end
 
     def prefix?
-      @text[0] == ICQ::BOT_PREFIX
+      @text[0] == ICQ::BOT_PREFIX if @text
     end
 
     def to_h; @event_h end
+    def to_s; "Event(#{@type}" + (@text ? ", #{@text}" : '') + ')' end
   end
 
 end

data/lib/icqbot/functional/chats/administration/block_unblock_user.rb

@@ -0,0 +1,27 @@
+require_relative '../../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def block_user user_id, chat_id, del_last_msg=false
+      params = base_req_for_block_unblock_user user_id, chat_id, del_last_msg
+      JSON::load Requests.get(
+        URLS_API::BLOCK_USER, params: params).body
+    end
+
+    def unblock_user user_id, chat_id
+      params = base_req_for_block_unblock_user user_id, chat_id
+      JSON::load Requests.get(
+        URLS_API::UNBLOCK_USER, params: params).body
+    end
+
+    private
+      def base_req_for_block_unblock_user user_id, chat_id, del_last_msg=nil
+        params = base_req chat_id
+        params['userId'] = user_id
+        params['delLastMessages'] = del_last_msg if del_last_msg
+        return params
+      end
+  end
+
+end

data/lib/icqbot/functional/chats/administration/pin_unpin_msg.rb

@@ -0,0 +1,21 @@
+require_relative '../../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def pin_msg msg_id, chat_id
+      params = base_req chat_id
+      params['msgId'] = msg_id
+      JSON::load Requests.get(
+        URLS_API::PIN_MSG, params: params).body
+    end
+
+    def unpin_msg msg_id, chat_id
+      params = base_req chat_id
+      params['msgId'] = msg_id
+      JSON::load Requests.get(
+        URLS_API::UNPIN_MSG, params: params).body
+    end
+  end
+
+end

data/lib/icqbot/functional/chats/administration/set_about.rb

@@ -0,0 +1,14 @@
+require_relative '../../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def set_about chat_id, about
+      params = base_req chat_id
+      params['about'] = about
+      JSON::load Requests.get(
+        URLS_API::SET_ABOUT, params: params).body
+    end
+  end
+
+end

data/lib/icqbot/functional/chats/administration/set_rules.rb

@@ -0,0 +1,14 @@
+require_relative '../../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def set_rules chat_id, rules
+      params = base_req chat_id
+      params['rules'] = rules
+      JSON::load Requests.get(
+        URLS_API::SET_RULES, params: params).body
+    end
+  end
+
+end

data/lib/icqbot/functional/chats/administration/set_title.rb

@@ -0,0 +1,18 @@
+require_relative '../../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def set_title chat_id, title
+      params = base_req chat_id
+      params['title'] = title
+      JSON::load Requests.get(
+        URLS_API::SET_TITLE, params: params).body
+    end
+
+    def title= o
+      set_title *o
+    end 
+  end
+
+end

data/lib/icqbot/message.rb

@@ -9,6 +9,13 @@ module ICQ
       @text = obj
       @keyboard = keyboard
     end
+
+    def << btn
+      return @keyboard << btn if btn.is_a? ICQ::Button
+      raise ArgumentError.new 'btn must be a Button'
+    end
+
+    alias_method :append, :<<
   end
 
   class Button

data/lib/icqbot/urls_api.rb

@@ -8,4 +8,11 @@ module URLS_API
   GET_ADMINS        = 'https://api.icq.net/bot/v1/chats/getAdmins'
   GET_MEMBRS        = 'https://api.icq.net/bot/v1/chats/getMembers'
   GET_BLOCKED_USERS = 'https://api.icq.net/bot/v1/chats/getBlockedUsers'
+  SET_TITLE         = 'https://api.icq.net/bot/v1/chats/setTitle'
+  SET_ABOUT         = 'https://api.icq.net/bot/v1/chats/setAbout'
+  SET_RULES         = 'https://api.icq.net/bot/v1/chats/setRules'
+  PIN_MSG           = 'https://api.icq.net/bot/v1​/chats​/pinMessage'
+  UNPIN_MSG         = 'https://api.icq.net/bot/v1​/chats​/unpinMessage'
+  BLOCK_USER        = 'https://api.icq.net/bot/v1​/chats/blockUser'
+  UNBLOCK_USER      = 'https://api.icq.net/bot/v1​/chats/unblockUser'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icqbot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - sheyber
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
@@ -41,6 +41,7 @@ files:
 - Gemfile
 - README.md
 - bin/5time_echo_and_end.rb
+- bin/bot_with_handlers.rb
 - bin/echo_bot.rb
 - bin/send_text_with_button.rb
 - doc/bot.md
@@ -48,11 +49,15 @@ files:
 - doc/event.md
 - doc/message.md
 - doc/overview.md
-- doc/user.md
 - icqbot.gemspec
 - lib/icqbot.rb
 - lib/icqbot/bot.rb
 - lib/icqbot/event.rb
+- lib/icqbot/functional/chats/administration/block_unblock_user.rb
+- lib/icqbot/functional/chats/administration/pin_unpin_msg.rb
+- lib/icqbot/functional/chats/administration/set_about.rb
+- lib/icqbot/functional/chats/administration/set_rules.rb
+- lib/icqbot/functional/chats/administration/set_title.rb
 - lib/icqbot/functional/chats/get_admins.rb
 - lib/icqbot/functional/chats/get_blocked_users.rb
 - lib/icqbot/functional/chats/get_info.rb

data/doc/user.md

@@ -1,6 +0,0 @@
-Bot
----
-
-File: `lib/icqbot/user.rb`
-
----