icqbot 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c40f720f2eab21955a65f3a3f034d7d260f8393db505cf6ef72dc0089dd835
-  data.tar.gz: c9c5930e02ef29769fd6aa92f1727d5b748d2b95ab97ca8e0ab61cc177c217cc
+  metadata.gz: 2c8f903bddb535995d723b2bb17ad4a1a2cd0856a053284ae4f66c2dd72ac163
+  data.tar.gz: b44c70c7cc4536f6093b2909a6c535f24ff3e19d47ea20d9d08d86f23eab9e98
 SHA512:
-  metadata.gz: 046770ad26085c34667c434cb7af1ac0e3f77c1dd3449c9bd0a30121ee29dea25c4888cb03b7b0d9ad4a54c1d366d9fba7190411a68af6b4d2a2f00a869fbd91
-  data.tar.gz: 8ce652b39117e17729be909426dcc95f54fc99424e406483fe5409f587502a4368657190f136c07ffd50216b27fab8c9be0c89f1847362c211072a9fb5bc45aa
+  metadata.gz: 76ff8bbf9f9c7d669c29fe6b365d9edbf047ea3883ccfe8069155def240a19043458e96c1957fd6d1f7ef69f08ce92f2a3833ec1f86972dcb875417e8668ee7b
+  data.tar.gz: 1e0fa65eeacc00d35fdcd3bf69de542090a433e743898ecf631cbebde75cb52c4434bb51d28ab34fc3bea444e01ac07b1cefca1d4974001e632866a383652452

data/.gitignore

@@ -1,3 +1,4 @@
 .bundle
 test
 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,7 +21,11 @@ ICQ::Bot.new('token') do |bot|
   end
 end
 ```
+more examples in `bin/`
 
-### Credits
+## Docs
+* **[Documentation](./doc/overview.md)**
+
+## Credits
 * Thank you Cyril David (author by gem requests)
 * And thank you Matz for wonderful Ruby

data/doc/bot.md

@@ -0,0 +1,125 @@
+
+Bot
+---
+
+File: `lib/icqbot/bot.rb`
+
+---
+
+## Конструктор 
+```ruby
+def initialize token, pool_time=30
+```
+
+## Event loop
+```ruby
+def listen
+```
+Принимает блок, которому передаётся экземпляр класса [Event](./event.md)(последние событие)
+
+## Закрыть Event loop
+Чтобы закрыть цикл нужно аттрибуту объекта Bot `loop` установить `false`.
+```ruby
+bot.loop = false
+```
+
+## Отправить сообщение
+```ruby
+def send_msg msg, chat_id # -> Hash
+```
+1. `msg` - это объект типа [Message](./message.md), либо обычный String.
+2. `chat_id` - ID чата, куда надо отправить сообщение.
+
+## Удалить сообщение
+```ruby
+def delete_msg msg_id, chat_id # -> Hash
+```
+1. `msg_id` - ID сообщения, которое надо удалить. 
+2. `chat_id` - ID чата, откуда надо удалить сообщение.
+
+## Изменить сообщение
+```ruby
+def edit_msg msg, msg_id, chat_id # -> Hash
+```
+1. `msg` - это объект типа [Message](./message.md), либо обычный String.
+2. `msg_id` - ID сообщения, которое надо изменить. 
+3. `chat_id` - ID чата, где надо изменить сообщение.
+
+# Chats
+
+## Получить информацию о чате
+```ruby
+def get_info chat_id # -> Hash | User
+```
+1. `chat_id` - ID чата, информацию о котором надо получить.
+
+## Получить список участников
+```ruby
+def get_members chat_id, cursor=nil # -> [Hash]
+```
+1. `chat_id` - ID чата, откуда надо получить список участников.
+
+## Получить список заблокированных пользователей
+```ruby
+def get_blocked_users chat_id # -> [Hash]
+```
+1. `chat_id` - ID чата, откуда надо получить список заблокированных пользователей.
+
+## Получить список aдминов
+```ruby
+def get_admins chat_id # -> [Hash]
+```
+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/button.md

@@ -0,0 +1,12 @@
+
+Button
+---
+
+## Конструктор
+```ruby
+def initialize text, style:'attention', url:nil, call_back_data:nil
+```
+1. `text` - текст кнопки(String).
+2. `style` - стиль кнопки.
+3. `url` - ссылка, по которой отправит вас кнопка.
+4. `call_back_data` - код для ответа.

data/doc/event.md

@@ -0,0 +1,41 @@
+
+Event
+---
+
+File: `lib/icqbot/event.rb`
+
+---
+Класс для представления событий.
+
+## Конструктор
+```ruby
+def initialize event_h
+```
+Принимает hash event из ICQ Bot API.
+
+## Аттрибуты
+```ruby
+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

@@ -0,0 +1,29 @@
+Message
+---
+
+File: `lib/icqbot/message.rb`
+
+---
+
+## Конструктор
+```ruby
+def initialize text, *keyboard
+```
+1. `text` - текст сообщения(String).
+2. `*keyboard` - массив объектов [Button](./button.md).
+
+## Аттрибуты 
+```ruby
+attr_reader :text, :keyboard
+msg.text     # текст сообщения(String)
+msg.keyboard # массив объектов Button
+```
+
+## Добавить кнопку
+```ruby
+def << btn
+```
+```ruby
+alias_method :append, :<<
+```
+1. `btn` - объект типа [Button](./button.md)

data/doc/overview.md

@@ -0,0 +1,11 @@
+
+# overview of docs
+
+*Пардон за мой французский*
+
+| Класс | Описание |
+| --- | --- |
+| **[Bot](./bot.md)** | Экземпляр этого класса и есть ваш бот, что выполняет всевозможные действия |
+| **[Event](./event.md)** | Представление для приходящих от API events |
+| **[Message](./message.md)** | Класс, экземпляры которого можно передать в `send_msg` в качестве `msg` |
+| **[User](./user.md)** | Класс для представления пользователя |

data/doc/todolist.md

@@ -0,0 +1,6 @@
+
+**TODO**
+* works with files
+* fix callback events 
+* fix messages
+* write doc

data/icqbot.gemspec

@@ -1,20 +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       = "0.1.0"
+  s.version       = ICQ::VERSION
   s.authors       = ["sheyber"]
   s.email         = ["ukt1@ro.ru"]
-  # s.license       = 'MIT'
+  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'
+  s.add_dependency 'requests', '~> 1.0', '>= 1.0.2'
 end

data/lib/icqbot.rb

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

data/lib/icqbot/bot.rb

@@ -7,6 +7,13 @@ require_relative './functional/send_msg.rb'
 require_relative './functional/edit_msg.rb'
 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
 
@@ -41,15 +48,6 @@ module ICQ
       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
-    end
-
     private
       def base_req chat_id
         {

data/lib/icqbot/event.rb

@@ -2,25 +2,41 @@ require_relative '../icqbot.rb'
 
 module ICQ
 
+  BOT_PREFIX = '/'
+
   module TypeEvent
     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 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/functional/chats/get_admins.rb

@@ -0,0 +1,13 @@
+require_relative '../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def get_admins chat_id
+      _ = JSON::load Requests.get(
+        URLS_API::GET_ADMINS, params: base_req(chat_id)).body
+      _['admins']
+    end
+  end
+
+end

data/lib/icqbot/functional/chats/get_blocked_users.rb

@@ -0,0 +1,13 @@
+require_relative '../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def get_blocked_users chat_id
+      _ = JSON::load Requests.get(
+        URLS_API::GET_BLOCKED_USERS, params: base_req(chat_id)).body
+      _['users']
+    end
+  end
+
+end

data/lib/icqbot/functional/chats/get_members.rb

@@ -0,0 +1,14 @@
+require_relative '../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def get_members chat_id, cursor=nil
+      # TODO: сделать что-то с cursor
+      _ = JSON::load Requests.get(
+        URLS_API::GET_MEMBRS, params: base_req(chat_id)).body
+      _['members']
+    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

@@ -1,8 +1,18 @@
 
 module URLS_API 
-  GET_EVENTS = 'https://api.icq.net/bot/v1/events/get'
-  SEND_MSG   = 'https://api.icq.net/bot/v1/messages/sendText'
-  EDIT_MSG   = 'https://api.icq.net/bot/v1/messages/editText'
-  DEL_MSG    = 'https://api.icq.net/bot/v1/messages/deleteMessages'
-  GET_INFO   = 'https://api.icq.net/bot/v1/chats/getInfo'
+  GET_EVENTS        = 'https://api.icq.net/bot/v1/events/get'
+  SEND_MSG          = 'https://api.icq.net/bot/v1/messages/sendText'
+  EDIT_MSG          = 'https://api.icq.net/bot/v1/messages/editText'
+  DEL_MSG           = 'https://api.icq.net/bot/v1/messages/deleteMessages'
+  GET_INFO          = 'https://api.icq.net/bot/v1/chats/getInfo'
+  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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: icqbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - sheyber
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: requests
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
 description: This gem is a simple and minimalistic library for creating ICQ bots.
 email:
 - ukt1@ro.ru
@@ -37,20 +43,36 @@ files:
 - bin/5time_echo_and_end.rb
 - bin/echo_bot.rb
 - bin/send_text_with_button.rb
+- doc/bot.md
+- doc/button.md
+- doc/event.md
+- doc/message.md
+- doc/overview.md
+- doc/todolist.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
+- lib/icqbot/functional/chats/get_members.rb
 - lib/icqbot/functional/delete_msg.rb
 - lib/icqbot/functional/edit_msg.rb
 - lib/icqbot/functional/send_msg.rb
 - lib/icqbot/message.rb
 - lib/icqbot/urls_api.rb
 - lib/icqbot/user.rb
-homepage:
-licenses: []
-metadata: {}
+homepage: https://github.com/sheyber/icqbot
+licenses:
+- 0BSD
+metadata:
+  homepage_uri: https://github.com/sheyber/icqbot
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -59,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="