icqbot 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2b93dc489f8308a4ce781d79b2e797189d464d4f285449a2f8ef01b1a45a3c
-  data.tar.gz: f9f268a15b98f0cf710ed87ea43a6edb348b7f39445506e884f0b859b9bdd4e2
+  metadata.gz: ad954e93e3dfea76ebf298daf4ac1eaccdbbd09cbf455961d7e059682c410e6b
+  data.tar.gz: 57c3ff74c3367bd8de40e73c24204155061e69278c0ae90ac3a44776e112e170
 SHA512:
-  metadata.gz: e792f9b3c3693500645dc3fa772d23140de16e85f6a2d0fa01f1618a50be7dd5597e6a7d9f5d6dc4b9616ba86d7b9f3ae423ae996fb58c74b656d1ff2c77457a
-  data.tar.gz: 98e908b1f8caca89d2f5e3d7b054f5a9b95d8d03c9ff4c0844604a926825967ba2c6e15f79eea9f317b6bf2be096b0fe94782acc12026a607a79916d5f8b0941
+  metadata.gz: a033630de3734747ed6f07ab28c579bd2cc113afb8d64c9a73803f40fef5285c88b3df0e8d1906ffbb4c1def41d7d92df1c1b8e0a2e716546d25bf007b29e846
+  data.tar.gz: 344731d2f7c803bcdb2d5f486cfb2f3ac7c5dcfb348af9ac9ecc713c1ebf17395f43973bd20040cf483ee11fc30e902d28effcfdfe8d1207a4e119040ce2a502

data/.gitignore

@@ -1,3 +1,3 @@
 .bundle
 test
-Gemfile.lock
+Gemfile.lock

data/README.md

@@ -22,6 +22,9 @@ ICQ::Bot.new('token') do |bot|
 end
 ```
 
-### 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,72 @@
+
+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дминов.

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,33 @@
+
+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
+event.type    # Тип события.
+event.text    # текст приходящего события(обычно текст сообщения от юзера).
+event.msg_id  # ID пришедшего сообщения.
+event.chat_id # ID чата, в который пришло сообщения.
+event.from    # Hash | Информация от кого пришло сообщение. 
+```
+
+## Типы событий
+```ruby
+module TypeEvent
+    NEW_MSG     = 'newMessage'
+    EDITED_MSG  = 'editedMessage'
+    DELETED_MSG = 'deletedMessage'
+    ... # in working
+```

data/doc/message.md

@@ -0,0 +1,20 @@
+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](./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/user.md

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

data/icqbot.gemspec

@@ -1,12 +1,14 @@
+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.1"
+  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.}
@@ -20,5 +22,5 @@ Gem::Specification.new do |s|
   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.2'
 end

data/lib/icqbot/bot.rb

@@ -7,6 +7,8 @@ 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'
 
 module ICQ
 

data/lib/icqbot/event.rb

@@ -2,6 +2,8 @@ require_relative '../icqbot.rb'
 
 module ICQ
 
+  BOT_PREFIX = '/'
+
   module TypeEvent
     NEW_MSG     = 'newMessage'
     EDITED_MSG  = 'editedMessage'
@@ -20,6 +22,10 @@ module ICQ
       @from = event_h['payload']['from']
     end
 
+    def prefix?
+      @text[0] == ICQ::BOT_PREFIX
+    end
+
     def to_h; @event_h 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/urls_api.rb

@@ -1,8 +1,11 @@
 
 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'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: icqbot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 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,11 +43,20 @@ 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/user.md
 - icqbot.gemspec
 - lib/icqbot.rb
 - lib/icqbot/bot.rb
 - lib/icqbot/event.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
@@ -49,7 +64,8 @@ files:
 - lib/icqbot/urls_api.rb
 - lib/icqbot/user.rb
 homepage: https://github.com/sheyber/icqbot
-licenses: []
+licenses:
+- 0BSD
 metadata:
   homepage_uri: https://github.com/sheyber/icqbot
 post_install_message: