icqbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6c40f720f2eab21955a65f3a3f034d7d260f8393db505cf6ef72dc0089dd835
+  data.tar.gz: c9c5930e02ef29769fd6aa92f1727d5b748d2b95ab97ca8e0ab61cc177c217cc
+SHA512:
+  metadata.gz: 046770ad26085c34667c434cb7af1ac0e3f77c1dd3449c9bd0a30121ee29dea25c4888cb03b7b0d9ad4a54c1d366d9fba7190411a68af6b4d2a2f00a869fbd91
+  data.tar.gz: 8ce652b39117e17729be909426dcc95f54fc99424e406483fe5409f587502a4368657190f136c07ffd50216b27fab8c9be0c89f1847362c211072a9fb5bc45aa

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'requests', '~> 1.0', '>= 1.0.2'

data/README.md

@@ -0,0 +1,27 @@
+
+icq-bot-ruby in working :zzz: 
+------------
+Ruby wrapper for [ICQ Bot API](https://icq.com/botapi/)
+
+----
+
+## Installation 
+```
+gem install icqbot
+```
+
+## Usage
+Simple echo bot:
+```ruby
+require 'icqbot'
+
+ICQ::Bot.new('token') do |bot|
+  bot.listen do |event|
+    bot.send_msg("echo #{event.text}", event.chat_id)
+  end
+end
+```
+
+### Credits
+* Thank you Cyril David (author by gem requests)
+* And thank you Matz for wonderful Ruby

data/bin/5time_echo_and_end.rb

@@ -0,0 +1,10 @@
+require_relative '../lib/icqbot.rb'
+
+times, max_time = 0, 5
+
+ICQ::Bot.new('token') do |bot|
+  bot.listen do |event|
+    bot.send_msg("echo '#{event.text}'", event.chat_id)
+    bot.loop = false if (times += 1) != max_time
+  end
+end

data/bin/echo_bot.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/icqbot.rb'
+
+ICQ::Bot.new('token') do |bot|
+  bot.listen do |event|
+    bot.send_msg "echo #{event.text}", event.chat_id
+  end
+end

data/bin/send_text_with_button.rb

@@ -0,0 +1,9 @@
+require_relative '../lib/icqbot.rb'
+
+ICQ::Bot.new('token') do |bot|
+  bot.listen do |event|
+    msg = ICQ::Message.new(
+      "echo #{event.text}", ICQ::Button.new('google', url: 'google.com'))
+    bot.send_msg msg, event.chat_id
+  end
+end

data/icqbot.gemspec

@@ -0,0 +1,20 @@
+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.authors       = ["sheyber"]
+  s.email         = ["ukt1@ro.ru"]
+  # s.license       = 'MIT'
+
+  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.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'
+end

data/lib/icqbot.rb

@@ -0,0 +1,9 @@
+require "requests/sugar"
+
+require_relative './icqbot/bot.rb'
+require_relative './icqbot/event.rb'
+require_relative './icqbot/user.rb'
+require_relative './icqbot/message.rb'
+
+module ICQ
+end

data/lib/icqbot/bot.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+require_relative '../icqbot.rb'
+require_relative './urls_api.rb'
+
+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'
+
+module ICQ
+
+  class Bot
+    attr_accessor :loop
+
+    def initialize token, pool_time=30
+      @token = token
+      @pool_time = pool_time
+      @last_event_id = 0
+      @loop = true
+      yield self if block_given?
+    end
+
+    def get_events # /events/get
+      params = {
+        'token': @token,
+        'lastEventId': @last_event_id,
+        'pollTime': @pool_time
+      }
+      Requests.get(URLS_API::GET_EVENTS, params: params)
+    end
+
+    def listen # event loop
+      while @loop
+        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
+    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
+        {
+          'token': @token,
+          'chatId': chat_id
+        }
+      end
+  end
+
+end

data/lib/icqbot/event.rb

@@ -0,0 +1,26 @@
+require_relative '../icqbot.rb'
+
+module ICQ
+
+  module TypeEvent
+    NEW_MSG     = 'newMessage'
+    EDITED_MSG  = 'editedMessage'
+    DELETED_MSG = 'deletedMessage'
+  end
+
+  class Event
+    attr_reader :type, :text, :msg_id, :chat_id, :from
+
+    def initialize event_h
+      @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']
+    end
+
+    def to_h; @event_h end
+  end
+
+end

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

@@ -0,0 +1,14 @@
+require_relative '../../bot.rb'
+
+module ICQ
+
+  class Bot
+    def get_info chat_id
+      # TODO: make a class for chats, kind of
+      params = base_req chat_id
+      json = JSON::load Requests.get(URLS_API::GET_INFO, params: params).body
+      return ICQ::User.new json if json['firstName']
+    end
+  end
+
+end

data/lib/icqbot/functional/delete_msg.rb

@@ -0,0 +1,14 @@
+require_relative '../bot.rb'
+
+module ICQ
+
+  class Bot
+    def delete_msg msg_id, chat_id
+      # FIXME: fix this trash
+      params = base_req chat_id
+      r = "https://api.icq.net/bot/v1/messages/deleteMessages?token=#{params[:token]}&chatId=#{chat_id}&msgId=#{msg_id}" # HACK: super trash
+      JSON::load Requests.get(r).body
+    end
+  end
+
+end

data/lib/icqbot/functional/edit_msg.rb

@@ -0,0 +1,13 @@
+require_relative '../bot.rb'
+
+module ICQ
+
+  class Bot
+    def edit_msg msg, msg_id, chat_id
+      params = create_message_params msg, chat_id
+      params['msgId'] = msg_id
+      JSON::load Requests.get(URLS_API::EDIT_MSG, params: params).body
+    end
+  end
+
+end

data/lib/icqbot/functional/send_msg.rb

@@ -0,0 +1,29 @@
+require_relative '../bot.rb'
+
+module ICQ
+
+  class Bot
+    def send_msg msg, chat_id
+      params = create_message_params msg, chat_id
+      JSON::load Requests.get(URLS_API::SEND_MSG, params: params).body
+    end
+
+    private
+      def create_message_params msg, chat_id
+        params = base_req chat_id
+        if msg.is_a? ICQ::Message
+          params['text'] = msg.text
+          if msg.keyboard and msg.keyboard != []
+            kb = msg.keyboard.map(&:to_h).map(&:to_json)
+            params['inlineKeyboardMarkup'] = "[[#{kb.join(',')}]]"
+          end
+        elsif msg.is_a? String
+          params['text'] = msg
+        else
+          raise ArgumentError.new "message can't be a #{msg.class}"
+        end
+        return params
+      end
+  end
+
+end

data/lib/icqbot/message.rb

@@ -0,0 +1,29 @@
+require_relative '../icqbot.rb'
+
+module ICQ
+
+  class Message
+    attr_reader :text, :keyboard
+
+    def initialize obj, *keyboard
+      @text = obj
+      @keyboard = keyboard
+    end
+  end
+
+  class Button
+    def initialize text, style:'attention', url:nil, call_back_data:nil
+      @button = {
+        'text': text,
+        'style': style,
+      }
+      @button['url'] = url if url
+      @button['callbackData'] = call_back_data if call_back_data
+    end
+
+    def to_h
+      @button
+    end
+  end
+
+end

data/lib/icqbot/urls_api.rb

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

data/lib/icqbot/user.rb

@@ -0,0 +1,16 @@
+require_relative '../icqbot.rb'
+
+module ICQ
+
+  class User
+    attr_reader :first_name, :last_name, :photo, :type
+
+    def initialize user_h
+      @first_name = user_h['firstName']
+      @last_name = user_h['lastName']
+      @photo = user_h['photo'].first['url']
+      @type = user_h['type']
+    end
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: icqbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sheyber
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: requests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a simple and minimalistic library for creating ICQ bots.
+email:
+- ukt1@ro.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- bin/5time_echo_and_end.rb
+- bin/echo_bot.rb
+- bin/send_text_with_button.rb
+- icqbot.gemspec
+- lib/icqbot.rb
+- lib/icqbot/bot.rb
+- lib/icqbot/event.rb
+- lib/icqbot/functional/chats/get_info.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: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for ICQ Bot API.
+test_files: []