New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

VK-Promise

Package Overview
Dependencies
Maintainers
1
Versions
35
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

VK-Promise

VK API module

  • 0.2.2
  • npm
  • Socket score

Version published
Weekly downloads
10
decreased by-54.55%
Maintainers
1
Weekly downloads
 
Created
Source

VK-Promise

Модуль для работы с ВКонтакте API и Callback API ВКонтакте.

Установка

npm install VK-Promise

Tl;dr

var VK = require("VK-Promise"),
    vk = new VK("сюда access_token");
// запрос
vk(/*string*/ метод, /*object*/ данные)
    .then(/*function*/ on_response)
    .catch(/*function*/ on_error);
// Загрузка файла
vk.upload(
    /*string*/ метод_получения_сервера,
    /*string*/ метод_сохранения_файла,
    {
        get: {/* данные передаваемые методу получения сервера*/},
        save: {/* данные передаваемые методу сохранения файла*/},
        files: {/* файлы */
            file1: /*string*/ путь_к_файлу,
            file2: stream /* необходимо указать stream.filename */,
            file3: {filename: имя_файла, buffer: Buffer},
        }
    }
);
// Получение всего что у чего есть offset
vk.getAll(/*string*/ метод_получения_данных, /*object*/ данные, /*function*/ отслеживание_прогресса)
// Функции
vk.init_longpoll(); // Запуск получения сообщения через LongPoll
vk.init_execute_cart(); // Запуск пакетной обработки запросов через execute
vk.init_callback_api(); // Получения обработчика для http.createServer
// Разное
VK.getAttachmentUrl(/*object*/ attachment); // Получения url из msg.attachments
VK.Array2Object(/*Array*/ array); // [{key:key,value:value}] => {key:value}
// Авторизация
vk.auth({username: "логин", password: "пароль"})
  .then(vk.users.get)
  .then(console.log, console.error);

Элементарный запрос

var vk = require("VK-Promise")("Ваш access_token");

vk.users.get({
    user_id: 1 // данные передаваемые API
}).then(function (res) {
    console.log("response",res);
}).catch(function (error) {
    console.log("Ошибка",error);
});

Элементарный бот

var VK = require("VK-Promise"),
    vk = new VK("ваш access_token");

vk.init_longpoll(); // Запускаем получение сообщений через LongPoll

vk.on("message",function (event, msg) { // Обрабатываем сообщения
    if(msg.body == "ping") // Если текст сообщения равен ping
        msg.send("pong"); // Отвечаем pong
});

Обработка need_captcha

var vk = require("VK-Promise")("Ваш access_token");
// Добавляем обработчик
vk.on("captcha",function(event, data){
	console.log("Ссылка на код:", data.captcha_img);
    data.submit("Вводим код с картинки");
});
// API метод вызова captcha
vk("captcha.force",{}).then(function (res) {
     console.log("response",res);
})

Элементарный бот для группы через Callback API с оптимизацией ответа на сообщения через execute

var VK = require("VK-Promise"),
    http = require("http"),
    vk = VK("ваш access_token группы");

// Запускаем http сервер на 80 порту с обработкой Callback API
// PS: Сервер в настройках группы нужно вешать вручную  
var callback = vk.init_callback_api("Строка, которую должен вернуть сервер");
http.createServer(function (req, res) {
    if(req.url == "/vk_callback_api") // фильтруем по url
        return callback(req, res);
    // Далее делаем все что нам нужно
    res.end("Error 404");
}).listen(80);

// Включаем оптимизацию через execute
// Собирает все запросы и выполняет пачками раз в 334мс
// 334мс - 3 раза в секунду, стандартное ограничение  
vk.init_execute_cart();

// message_new & message_reply объединяет в message
vk.on("message",function (event, msg) {
    msg.send("OK");
    event.ok(); // Отвечаем callback api серверу OK
});

// все остальное идет в callback type
// Например если участник вышел из сообщества
vk.on("group_leave",function (event, data) {
    if(data.self) // если сам вышел
        vk.messages.send({ // Отправляем сообщени
            message:"Ну куда же ты :_(", // текст сообщения
            peer_id: data.object.user_id // Кому
        });
    event.ok();
});

Загрузка файлов по ссылке

var VK = require("VK-Promise"),
    http = require("http"),
    vk = VK("Ваш access_token");

http.get("https://fs.flyink.ru/1.png",function(stream){
    stream.filename = "filename.png";
    vk.upload(
        "docs.getUploadServer",
        "docs.save",{
            files: {file: stream}
        }
    ).then(function (r) {
        console.log("response",r)
    }, console.error)
});

// или через vk.request, но тут  только https

vk.request("https://vk.com/doc-131495752_441571967?api=1")
    .then(vk.upload.photos)
    .then(console.log, console.error)

Загрузка всей стены

var vk = require("VK-Promise")("Ваш access_token"),
    readline = require('readline');

vk.getAll("wall.get",{owner_id: -2158488, count: 100},function (progress) {
    readline.clearLine(process.stdout, 0)
    readline.cursorTo(process.stdout, 0)
    process.stdout.write("Загружено: "+ progress.offset + " из " +progress.count);
}).then(function (res) {
    readline.clearLine(process.stdout, 0)
    readline.cursorTo(process.stdout, 0)
    console.log("Загружено записей:",res.length);
}, console.error);

Дополнительные данные

  • vk
    • retry: false - Отключение повтора запроса при 6й ошибке: (true)
    • ignore_cart: true - Игнорирование очереди запросов (false)
    • ignore_execute_cart: true - Игнорирование сборщика запросов (false)
  • vk.getAll
    • max_offset - максимальный offset

Что нового

0.2.2

  • Убран модуль fs, поэтому если вы использовали msg.sendPhoto или msg.sendDoc для загрузки с диска, то используйте fs.createReadStream
  • Исправлена ошибка vk.request
  • Новый раздел документации (ниже)

0.2.1

  • Исправлен вывод ошибок в vk.upload
  • vk.auth, пока без капч и 2фа
  • Небольшие исправления

0.1.9

  • Улучшена секция vk.upload
  • Изменения в vk.request:
    • Если передать url и data, то по умолчанию будет GET запрос и data вложится в search
    • Добавлена обработка 302 ошибки
    • При statusCode !== 200 запрос уйдет в catch
  • VK.available_methods вынесен в available_methods.json
  • Добавлен параметр стандартного имени файла options.filename
  • Правки в VK.getAttachmentUrl и VK.parseAttachments

0.1.8

  • Переписан build_execute_request

0.1.7

  • Новый параметр disable_auto_deinit_cart

0.1.6

  • Исправлен LongPoll
  • Новое событие LongPollResponse
  • msg.reply, msg.sendSticker

0.1.4

  • Исправления в vk.build_execute_request
  • Оптимизация в vk и vk.build_execute_request

0.1.3

  • Из msg.get убран .items[0]
  • Добавлены функции vk.getAll, vk.tryJSON
  • Добавлены события LongPollError, LongPollRequest
  • Исправлен VK.Array2Object
  • Вернул VK.on("error", ... )
  • Немного навел порядок в коде
  • Немного переписал документацию

0.1.0

  • VK.parseAttachments
  • VK.cart, да, да, та самая
  • добавлены опции VK(access_token, options)
  • Исправлены ошибки vk.upload
  • Кучу всего вынес из з msg.data[7] (action, from_id, emoji, emoji, sticker_id, attachments, итд...)
  • vk.upload.groupCover
  • vk.request

Разное

  • VK - функция создания vk
    • default_options - Стандартные параметры
      • filename - стандартное имя файла для загрузки
      • cart_interval - интервал выполнения запросов
      • host - хост api
      • method - метод передачи данных
      • body - вложения в запрос
        • v - версия api
      • заголовки для запросов
        • user-agent - id
    • available_methods - Доступные методы
    • Array2Object - переводит [{"value": "value1", "key": "key2"}] в {"key1": "value1"}
    • parseAttachments - Переводит вложения в их id
    • getAttachmentUrl - Получает ссылку на вложение
  • vk - функция запросов к api
    • listeners - список функций для vk.on
    • on - получение событий
          • все события
      • update - события с longpoll
      • messages - сообщения
      • error - ошибки
      • captcha - капча
      • LongPollError - ошибка longpoll сервера
      • LongPollRequest - запрос longpoll сервера
      • LongPollResponse - ответ longpoll сервера
      • response - ответ api
      • get_server_method - ответ vk.upload при получении сервера загрузки
      • upload_end - окончание загрузки файлов vk.upload
      • part_upload - начало загрузки файла в vk.upload
      • part_end - завершение загрузки файла в vk.upload
      • и типы событий callback api
    • init_longpoll - включение получения сообщений через longpoll
    • attach_message_functions - подключение функций для ответа к объекту сообщения
    • init_callback_api - получение функции для обработки запросов callback api
    • cart - объект очереди запросов
      • timer - таймер для обработки запросов
      • execute_cart - использовать ли build_execute_request
      • init - функция включения очереди запросов
      • deinit - функция отключения очереди запросов
    • build_execute_request - сборщик запросов в execute
    • init_execute_cart - функция включения build_execute_request
    • getAll - функция получения всего через offset
    • upload - функция загрузки
      • photos = photo - фото
      • wallPhotos = wallPhoto - фото на стену
      • ownerPhoto - фото в профиль
      • messagesPhoto - фото в сообщение
      • chatPhoto - фото на аватарку беседы
      • marketPhoto - фото в товар
      • marketAlbumPhoto - фото на альбом товаров
      • audio - аудио
      • video - видео
      • docs = doc - документ
      • wallDocs = wallDoc - документ на стену
      • groupCover - обложка группы
    • request - функция запросов
    • tryJSON - функция парсинга json
    • options - объект параметров
    • auth - авторизация
  • msg - объект сообщения
    • data - данные с longpoll
    • send - отправить сообщение
    • reply - ответить на сообщение
    • sendSticker - отправить стикер
    • sendPhoto - отправить фото
    • sendDoc - отправить документ
    • sendGraffiti - отправить граффити
    • sendAudioMessage - отправить голосовое сообщение
    • get - получить данные которые не выдает longpoll
    • setActivity - послать статус тайпинга
    • deleteDialog - удалить диалог
    • delete - удалить сообщение
    • restore - восстановить сообщение или пометить как спам
    • markAsRead - прочитать сообщение
    • markAsImportant - отметить важным
    • markAsAnsweredDialog - отметить отвеченным
    • editChat - изменяет название беседы
    • getChatUsers - получить участников беседы
    • getChat - получить информацию о беседе

FAQs

Package last updated on 07 Apr 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc