vk-crystal

Библиотека для взаимодействия с vk.com из под Crystal

Установка

Добавьте данные строчки в shards.yml Вашего проекта:

dependencies:
  vk:
    github: De-Os/vk-crystal  

Использование

Первым делом добавляем require и инициализируем класс

require "vk"

vk = VKontakte::Client.new(
  token: "Ваш токен",
  v: "Версия апи"
)

Также в качестве токена можно использовать массив с несколькими токенами, тогда при запросах будет использоваться случайный

Вызов любого метода

Используется функция call с названием метода в качестве первого аргумента и Hash(String, Any) с параметрами в качестве второго:

friends = vk.call("friends.get", {
    "user_id" => 0,
    "count" => 1000
  })
# typeof(friends) => JSON::Any

По умолчанию возвращается сразу графа response, но при указании параметра debug: true будет возвращён весь ответ

Также, можно указать параметр token: "token", тогда вызов будет осуществлён через указанный токен

Отправка сообщения

Для отправки сообщения существует отдельный метод send:

vk.send("Test message", peer_id) # peer_id - ид чата

Можно также указать дополнительные поля для messages.send:

vk.send("@all, как хорошо что пуш не сработает", peer_id, add_fields: {
  "disable_mentions" => "1"
  })

Загрузка и отправка вложений

На данный момент поддерживается только загрузка фотографий через метод upload:

photo = vk.upload("cat.png") # => photo123_456

Для указания peer_id добавьте его вторым параметром:

vk.upload("cat.png", 123)

Для отправки сообщения со вложением воспользуйтесь вызовом send с трёмя параметрами:

vk.send("Nice cat!", peer_id, photo)
# Либо несколько вложений:
vk.send("Nice cats!", peer_id, [vk.upload("cat1.png", peer_id), vk.upload("cat2.png", peer_id)])

Отправка клавиатуры

Отправка кнопок осуществляется с помощью параметра keyboard, пример:

vk.send("Buttons!", 123, keyboard: {
  "inline" => true, # inline/one_time, см. доки ВК
  "buttons" => [
    [VKontakte.getBtn("Название кнопки", {
      "command" => "test"
      }), vk.getBtn("Вторая кнопка", {"command" => "test2"}, "negative")],
    [vk.getBtn("Кнопка во втором ряду!", {"command" => "test3"})]
  ]
  })

Итак, кнопки можно делать напрямую через модуль: VKontakte.getBtn(...), либо через объект: vk.getBtn(...)

Пока что поддерживаются только обычные кнопки, построение кнопки осуществляется следующим образом:

vk.getBtn(
  label: "Текст на кнопке",
  payload: {} # "Полезная нагрузка" кнопки, см. доки ВК
  color: "Один из цветов" # Перечень цветов также см. в доках ВК
)

Остальные реализованные методы:

Получение имени пользователя/группы:

name = vk.getName(user_id) # => "Имя Фамилия" или "Название группы"
# также можно получать с указанием падежа
name = vk.getName(user_id, "Ins") # Игнорируется при получении имени группы

Bot's LongPoll

В модуле присутствует примитивный лонгполл, с помощью которого можно строить ботов. Пример простейшего бота с данным модулем:

# Создание и подключение
lp = vk.getBotLp(group_id: 123)

# Обработка событий
loop do
  updates = lp.getUpdates

  size = 0 # JSON::Any не имеет функции 'each', поэтому приходится так
  while size < updates.size
    update = updates[size] # Конкретное обновление

    case update["type"].as_s
    when "message_new"
      vk.send("Не пиши сюда >:(", update["object"]["message"]["peer_id"].as_i)
    end

    size += 1
  end
end