vk_longpoll_bot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f28f217393130c2c06d14a05e785bde07781ed164da0032689e15cf02526fae5
+  data.tar.gz: e3c750777c8347751b940fdc27366cb90b30c2de932894c4456cfd2c05e1f81d
+SHA512:
+  metadata.gz: 4ecb287c910584456bbbba055d7af012dba65fffad2657336766c78560f1165c5184d2d45b892232ab228bfc556935d1815def1b9ba3b90a6c17badbff791aa6
+  data.tar.gz: 143c4c9964f20b9750619820bde70c66c2f8142e48e7396df9443021ef5c90fc10ca648b5c11c7cccf80aa550a7c90d157d9979e224228bc0a14c459278ed330

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Fizvlad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# vk-longpoll-bot-rb
+Ruby library to create VK longpoll bot

data/Rakefile

@@ -0,0 +1,24 @@
+GEM_NAME = "vk_longpoll_bot"
+
+desc "Build gem file"
+task :build do
+  puts `gem build #{GEM_NAME}.gemspec`
+end
+
+desc "Uninstall gem"
+task :uninstall do
+  puts `gem uninstall #{GEM_NAME}`
+end
+
+desc "Build and install gem"
+task :install_local => :build do
+  puts `gem install ./#{GEM_NAME}-*.gem`
+end
+
+desc "Setup SSL certificate"
+task :setup_ssl do
+  print "Path to SSL certificate (leave empty if there is no troubles with SSL):"
+  ssl_cert_path = STDIN.gets.chomp
+  puts
+  ENV["SSL_CERT_FILE"] = ssl_cert_path
+end

data/lib/vk_longpoll_bot/bot.rb

@@ -0,0 +1,134 @@
+module VkLongpollBot
+
+  # Main class, which contains all the methods of bot.
+  class Bot
+  
+    # Every bot stores id of group it operates.
+    attr_reader :id, :event_listeners
+  
+    # Initialize bot. This method don't run longpoll.
+    #
+    # <tt>options</tt> hash can contain following keys:
+    # * <tt>:api_version</tt> - version of api to use
+    # * <tt>:longpoll_wait</tt> - longpoll requests timeout
+    def initialize(access_token, id, options = {})
+      @event_listeners = Hash.new { |hash, key| hash[key] = Array.new }
+      @on_start = []
+      @on_finish = []
+    
+      @access_token = access_token      
+      @id = id
+      
+      @api_version = options[:api_version] || VK_API_CURRENT_VERSION
+      @longpoll_wait = options[:longpoll_wait] || LONGPOLL_STANDART_WAIT
+      
+      @longpoll = {}
+      
+      # TODO
+    end
+    
+    # Call for api method with given parameters.
+    def api(method_name, parameters = {})
+      Request.api(method_name, parameters, @access_token, @api_version)
+    end
+    
+    # Messaging
+    
+    # Send message to <tt>target</tt> with provided <tt>content</tt>.
+    def send_message(target, content)
+      target_id = target.to_i
+      api("messages.send", user_id: target_id, message: content, random_id: Utility.random_id(target_id))
+    end
+    
+    # TODO: Which methods are also addable here?
+    
+    # Events
+    
+    # Add event listener.
+    # 
+    # <tt>attributes</tt> hash can contain following keys:
+    # * <tt>:subtype</tt> - event subtype. All of event types and subtypes are stated in Events::TYPES
+    def on(attributes, &block)
+      raise ArgumentError.new("Got subtype #{attributes[:subtype]} of class #{attributes[:subtype].class}") unless String === attributes[:subtype] && Events.valid_subtype?(attributes[:subtype])
+      @event_listeners[attributes[:subtype]] << Events::EventListener.new(attributes, &block)
+    end
+    
+    # Add code to be executed right after bot starts.
+    def on_start(&block)
+      @on_start << block
+    end
+    
+    # Add code to be executed right after bot finishes.
+    def on_finish(&block)
+      @on_finish << block
+    end
+    
+    # Running bot
+    
+    # Start bot. This methods freeze current thread until <tt>stop</tt> called.
+    def run
+      @on_start.each(&:call)
+    
+      init_longpoll
+      run_longpoll
+      
+      @on_finish.each(&:call)
+    end
+    
+    # Stop bot.
+    def stop
+      @finish_flag = true
+    end
+    
+    private
+    
+    # Request longpoll data.
+    def init_longpoll
+      lp = api("groups.getLongPollServer", group_id: @id)
+      @longpoll[:server] = lp["server"]
+      @longpoll[:key] = lp["key"]
+      @longpoll[:ts] = lp["ts"]    
+    end
+    
+    # Start longpoll. Requires <tt>init_longpoll</tt> to be run first.
+    def run_longpoll
+      @finish_flag = false # Setting up flag for loop
+      
+      until @finish_flag
+        response = Request.longpoll(@longpoll[:server], @longpoll[:key], @longpoll[:ts], @longpoll_wait) # TODO
+        if response["failed"]
+          # Error happened
+          Utility.warn "Longpoll failed with code #{response["failed"]}. This must be solvable. Keep running..."
+          case response["failed"]
+            when 1
+              # Just update ts
+              @longpoll[:ts] = response["ts"]
+            when 2, 3
+              # Need to reconnect
+              init_longpoll
+          else
+            raise Exceptions::LongpollError("Unknown 'failed' value: #{response["failed"]}. Full response: #{response.to_s}")
+          end
+        elsif response["ts"] && response["updates"]
+          # Everything is fine. Handling update
+          @longpoll[:ts] = response["ts"]
+          updates = response["updates"]
+          response["updates"].each { |update| update_handler(update) }
+        else
+          raise Exceptions::LongpollError("Strange longpoll response: #{response.to_s}")
+        end
+      end
+    end
+    
+    # Handle update from longpoll.
+    def update_handler(update)
+      event = Events::Event.new(update["type"], update["object"], update["group_id"], self)
+      @event_listeners[event.subtype].each do |listener|
+        # NOTE: If we had any attributes, we would check whether matching here.
+        listener.call(event)
+      end
+    end
+    
+  end
+
+end

data/lib/vk_longpoll_bot/constants.rb

@@ -0,0 +1,12 @@
+module VkLongpollBot
+
+  # Base of URL to API.
+  VK_API_URL_BASE = "https://api.vk.com"
+  
+  # It's recommended to use last version of VK API.
+  VK_API_CURRENT_VERSION = Gem::Version.new("5.101")
+  
+  # Longpoll requests timeout.
+  LONGPOLL_STANDART_WAIT = 25
+
+end

data/lib/vk_longpoll_bot/events.rb

@@ -0,0 +1,72 @@
+module VkLongpollBot
+
+  # Everything related to longpoll events.
+  module Events
+    
+    # All the types and subtypes of events
+    TYPES = {
+      message: %w{message_new message_reply message_edit message_typing_state message_allow message_deny},
+      photo:   %w{photo_new photo_comment_new photo_comment_edit photo_comment_restore photo_comment_delete},
+      audio:   %w{audio_new},
+      video:   %w{video_new video_comment_new video_comment_restore video_comment_delete},
+      wall:    %w{wall_post_new wall_repost wall_reply_new wall_reply_edit wall_reply_restore wall_reply_delete},
+      board:   %w{board_post_new board_post_edit board_post_restore board_post_delete},
+      market:  %w{market_comment_new market_comment_edit market_comment_restore market_comment_delete},
+      group:   %w{group_leave group_join group_officers_edit group_change_settings group_change_photo},
+      user:    %w{user_block user_unblock},
+      poll:    %w{poll_vote_new},
+      vkpay:   %w{vkpay_transaction},
+      app:     %w{app_payload}
+    }
+    
+    def self.valid_subtype?(subtype)
+      TYPES.values.any? { |arr| arr.include?(subtype) }
+    end
+  
+    # Class containing data recieved from longpoll. Provides easy update to it's data.
+    class Event
+    
+      attr_reader :subtype, :group_id, :data, :bot
+      
+      # Initialize from fields of update json and bot which got this event.
+      def initialize(subtype, data, group_id, bot)
+        @subtype = subtype.to_s
+        @data = data
+        @group_id = group_id.to_i
+        @bot = bot
+      end
+      
+      # Provides access to fields of update data.
+      def [](arg)
+        @data[arg.to_s]
+      end
+      
+      # TODO
+    
+    end
+    
+    # NOTE: It might be better to create separate class for each event but there's lot of them and they don't have good hierarchy.
+    
+    # Class containing block to run on some event.
+    class EventListener
+    
+      attr_reader :subtype
+      
+      def initialize(attributes, &block)
+        @subtype = attributes[:subtype]
+        @block = block
+        
+        # TODO
+      end
+      
+      def call(event)
+        @block.call(event)
+      end
+    
+      # TODO
+    
+    end
+    
+  end
+
+end

data/lib/vk_longpoll_bot/exceptions.rb

@@ -0,0 +1,84 @@
+module VkLongpollBot
+
+  # Custom exceptions.
+  module Exceptions
+  
+    # All of the error codes descriptions. Source: https://vk.com/dev/errors
+    CODES = {
+      1   => "Произошла неизвестная ошибка.",
+      2   => "Приложение выключено.",
+      3   => "Передан неизвестный метод.",
+      4   => "Неверная подпись.",
+      5   => "Авторизация пользователя не удалась.",
+      6   => "Слишком много запросов в секунду.",
+      7   => "Нет прав для выполнения этого действия.",
+      8   => "Неверный запрос.",
+      9   => "Слишком много однотипных действий.",
+      10  => "Произошла внутренняя ошибка сервера.",
+      11  => "В тестовом режиме приложение должно быть выключено или пользователь должен быть залогинен.",
+      14  => "Требуется ввод кода с картинки (Captcha).",
+      15  => "Доступ запрещён.",
+      16  => "Требуется выполнение запросов по протоколу HTTPS, т.к. пользователь включил настройку, требующую работу через безопасное соединение.",
+      17  => "Требуется валидация пользователя.",
+      18  => "Страница удалена или заблокирована.",
+      20  => "Данное действие запрещено для не Standalone приложений.",
+      21  => "Данное действие разрешено только для Standalone и Open API приложений.",
+      23  => "Метод был выключен.",
+      24  => "Требуется подтверждение со стороны пользователя.",
+      27  => "Ключ доступа сообщества недействителен.",
+      28  => "Ключ доступа приложения недействителен.",
+      29  => "Достигнут количественный лимит на вызов метода.",
+      30  => "Профиль является приватным.",
+      33  => "Метод ещё не реализован.",
+      100 => "Один из необходимых параметров был не передан или неверен.",
+      101 => "Неверный API ID приложения.",
+      113 => "Неверный идентификатор пользователя.",
+      150 => "Неверный timestamp.",
+      200 => "Доступ к альбому запрещён.",
+      201 => "Доступ к аудио запрещён.",
+      203 => "Доступ к группе запрещён.",
+      300 => "Альбом переполнен.",
+      500 => "Действие запрещено. Вы должны включить переводы голосов в настройках приложения. ",
+      600 => "Нет прав на выполнение данных операций с рекламным кабинетом.",
+      603 => "Произошла ошибка при работе с рекламным кабинетом.",
+      900 => "Нельзя отправлять сообщение пользователю из черного списка.",
+      901 => "Пользователь запретил отправку сообщений от имени сообщества.",
+      902 => "Нельзя отправлять сообщения этому пользователю в связи с настройками приватности.",
+      911 => "Формат клавиатуры некорректен.",
+      912 => "Это функция чат-бота, измените данный статус в настройках.",
+      913 => "Слишком много пересланных сообщений.",
+      914 => "Сообщение слишком длинное.",
+      917 => "У вас нет доступа к этому чату.",
+      921 => "Невозможно переслать выбранные сообщения.",
+      936 => "Контакт не найден.",
+      940 => "Слишком много постов в сообщении."
+    }
+    
+    # Something wrong with response from vk.com.
+    class ResponseError < RuntimeError
+    end
+    
+    # API error. Must have some code and description.
+    class APIError < ResponseError
+
+      attr_reader :code, :error
+      
+      def initialize(error)
+        @error = error["error"]
+        @code = @error["error_code"]
+        super(@error["error_msg"])
+      end
+      
+      def description
+        CODES[@code]
+      end
+    
+    end
+    
+    # Something wrong in longpoll response.
+    class LongpollError < ResponseError
+    end
+  
+  end
+
+end

data/lib/vk_longpoll_bot/request.rb

@@ -0,0 +1,34 @@
+require "net/http"
+require "json"
+
+module VkLongpollBot
+
+  # Some functions to send HTTP requests
+  module Request
+  
+    # Regular HTTP request to given URI.
+    def self.to(url)
+      uri = URI(url.to_s)
+      Net::HTTP.get(uri)
+    end
+    
+    # Request to api.
+    def self.api(method_name, parameters, access_token, v = VK_API_CURRENT_VERSION)
+      response = JSON.parse self.to("#{VK_API_URL_BASE}/method/#{method_name}?access_token=#{access_token}&v=#{v.to_s}&#{URI.encode_www_form(parameters)}")
+      if response["response"]
+        response["response"]
+      elsif response["error"]
+        raise Exceptions::APIError.new(response)
+      else
+        raise Exceptions::ResponseError.new(response)
+      end
+    end
+    
+    # Request to longpoll server.
+    def self.longpoll(server, key, ts, wait = LONGPOLL_STANDART_WAIT)
+      JSON.parse self.to("#{server}?act=a_check&key=#{key}&ts=#{ts}&wait=#{wait}")
+    end
+  
+  end
+
+end

data/lib/vk_longpoll_bot/utility.rb

@@ -0,0 +1,22 @@
+module VkLongpollBot
+
+  # Module with some utility methods.
+  module Utility
+  
+    # Log warning.
+    def self.warn(msg)
+      if defined?(Warning.warn)
+        Warning.warn msg
+      else
+        STDERR.puts "Warning: #{msg}"
+      end
+    end
+
+    # Generate <tt>random_id</tt> for message.
+    def self.random_id(target_id)
+      (rand(100) * target_id) % 2**32
+    end
+    
+  end
+
+end

data/lib/vk_longpoll_bot.rb

@@ -0,0 +1,6 @@
+require_relative "vk_longpoll_bot/utility.rb"
+require_relative "vk_longpoll_bot/constants.rb"
+require_relative "vk_longpoll_bot/exceptions.rb"
+require_relative "vk_longpoll_bot/request.rb"
+require_relative "vk_longpoll_bot/bot.rb"
+require_relative "vk_longpoll_bot/events.rb"

data/vk_longpoll_bot.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name           = "vk_longpoll_bot"
+  s.summary        = "Provides interface to create simple VK longpoll bot"
+  s.description    = "Library to work with VK API and create simple longpoll bot for group."
+  s.version        = "0.0.1"
+  s.author         = "Kuznetsov Vladislav"
+  s.email          = "fizvlad@mail.ru"
+  s.homepage       = "https://github.com/fizvlad/vk-longpoll-bot-rb"
+  s.platform       = Gem::Platform::RUBY
+  s.required_ruby_version = ">=2.3.1"
+  s.files          = Dir[ "lib/**/**", "example/**/**", "LICENSE", "Rakefile", "README.md", "vk_longpoll_bot.gemspec" ]
+  s.license        = "MIT"
+
+  s.add_runtime_dependency "rake",      "~>12.3"
+  s.add_runtime_dependency "json",      "~>2.2"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: vk_longpoll_bot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kuznetsov Vladislav
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Library to work with VK API and create simple longpoll bot for group.
+email: fizvlad@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/vk_longpoll_bot.rb
+- lib/vk_longpoll_bot/bot.rb
+- lib/vk_longpoll_bot/constants.rb
+- lib/vk_longpoll_bot/events.rb
+- lib/vk_longpoll_bot/exceptions.rb
+- lib/vk_longpoll_bot/request.rb
+- lib/vk_longpoll_bot/utility.rb
+- vk_longpoll_bot.gemspec
+homepage: https://github.com/fizvlad/vk-longpoll-bot-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Provides interface to create simple VK longpoll bot
+test_files: []