Библиотека для работы с Google Drive API (open-source)

Если вы не слышали ранее об Открытом Пакете Интеграций (что вполне вероятно), то небольшая вводная часть ниже, под катом. Для тех, кто уже знаком с ОПИ, данный раздел можно пропустить.

Google Drive - популярное облачное хранилище, один из сервисов Google Workspace. В этом обновлении были добавлены основные методы, позволяющие с ним взаимодействовать посредством API

Реализованные методы:

• Работа с файлами и папками
  • Получение информации об объекте
  • Получение списка каталогов
  • Получение списка файлов
  • Загрузка файлов
  • Копирование файлов
  • Обновление двоичных данных существующих файлов
  • Скачивание (получение двоичных данных) файлов
  • Создание каталогов
  • Удаление объектов
• Работа с комментариями
  • Получение комментария по ID
  • Получение списка комментариев объекта
  • Создание комментария
  • Удаление комментария

Применение их, в целом и по смыслу, совпадает с таковыми у библиотеки для работы с Yandex Disk. API Яндекса мне нравится больше и функционал там шире, но вы можете выбрать (или даже уже используете) тот сервис, который вам более удобен - теперь они тут есть оба, а основные функции, будь то загрузить, скачать или удалить ничем особенно не отличаются. Зацеплю лишь некоторые основные моменты.

Общие токены на сервисы Google Workspace

До сегодняшнего релиза в Открытом пакете интеграций уже была библиотека из набора сервисов Google - это библиотека для планировщика Google Calendar. Если вы использовали её, то наверняка проходили довольно длинный и муторный процесс первоначальной регистрации и настройки всего необходимого перед началом работы, который описан в документации.

Повторять весь процесс целиком для вас, конечно же, будет не нужно - достаточно лишь выполнить два последних пункта: активировать API Google Drive и заново получить токен по ссылке из функции OPI_GoogleWorkspace.СформироватьСсылкуПолученияКода().

Важно

В зависимости от того, какие сервисы вы используете, зависит и количество необходимых разрешений при формировании ссылки получения токена. Определяется это параметрами функции СформироватьСсылкуПолученияКода - Calendar и Drive (на данный момент).

Разрешения тех API, которые вы не используете, необходимо передать как Ложь - значения по умолчанию для всех библиотек равны Истина
 

Данная функция не является методом для частого использования - она необходима лишь для стартовой настройки и потом больше не применяется. Так что, думаю, проблем с этим возникнуть не должно

Осторожное использование рекурсивных методов

Методы, отвечающие за получение списков объектов, а именно ПолучитьСписокКаталогов и ПолучитьСписокФайлов, рекурсивно отправляют запросы к Google Workspace до тех пор, пока те не закончатся.

Выполнение данных методов без отборов, в частности на дисках с большим количество файлов, может привести к тому, что а) все будет получаться очень долго, а найти в полученном ответе из тысяч файлов что-либо будет крайне сложно б) будет съедено очень много квоты выполнения запросов к сервису

Так что, несмотря на необязательность параметров отбора, таких как ИмяСодержит и Каталог, выполнять функции без них не рекомендуется (пусть и не воспрещается).

Блок работы с комментариями

Если с первой частью библиотеки, которая отвечает за работу с файлами и каталогами, все вполне понятно, то про комментарии лично я не знал до того, как увидел их описание в документации к API. Ничего сложного или невероятного в данном в функционале нет, остановимся на нем лишь вкратце.

Комментарии в Google Drive - небольшие текстовые заметки, которые можно оставлять применимо к файлам, лежащим на облачном диске. Нас они, в первую очередь, могут заинтересовать возможностью взаимодействия между пользователем из 1С и пользователем, который работает лишь напрямую с Drive через приложение или web-интерфейс.

Например, мы можем оставить комментарий через API из 1С по какому либо событию. Делается это вот таким простым кодом:

  Идентификатор = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
  Комментарий   = "Новый комментарий"; 

  Ответ = OPI_GoogleDrive.СоздатьКомментарий(Токен, Идентификатор, Комментарий);

И теперь этот комментарий будет виден всем пользователям, у которых есть доступ к файлу на диске

В свою очередь, комментарий, добавленный руками напрямую, может быть получен назад из 1С. Делается это также просто:

    ИДФайла = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
    Ответ   = OPI_GoogleDrive.ПолучитьСписокКомментариев(Токен, ИДФайла);

Ничего особенного, но применение можно найти.

Немного новостей проекта

Про новую библиотеку рассказать больше особо нечего: методы как методы, API как API - все как всегда есть в документации

Расскажу немного про сам проект ОПИ. Последнее время я занимаюсь автоматизацией некоторых часто повторяющихся монотонных действий, которые приходится совершать в процессе разработки библиотеки.

Я уже рассказывал про автотесты в статье про портирование Открытого пакета интеграций на OneScript, но сейчас, помимо этого, сам процесс "внутренней кухни" поддержки двух схожих кодовых баз - 1С и OneScript - перенесен на Github Actions. А значит его видно теперь и снаружи.

Я обязательно посвящу этому отдельную статью, где расскажу, что это такое и зачем оно нужно, но, если вы уже некоторым образом в теме, то есть отдельные моменты, которые могут быть вам интересны уже сейчас. В частности, в моем workflow есть примеры реализации таких вещей как:
 

• Выполнение кода на OneScript внутри Github Actions для преобразования структуры кода проекта EDT в структуру кода пакета OneScript. В самом скрипте ничего особенного нет - на 1С же, но вот с кодом самого описания процесса запуска уже все не так однозначно.
  
  Не буду пока подробно его разбирать, скажу лишь, что сама возможность запуска OneScript внутри Github Actions - это очень здорово. Будущее наступило, так сказать :)
   
   

   Простой запуск OS скрипта для примера

   

  name: Конвертация OPI -> OInt
  
  on:
    workflow_dispatch:
  
  jobs:
  
    Convert:
      runs-on: ubuntu-latest
      permissions:
          contents: write
       
      steps:
      
        - uses: actions/checkout@v2                         # Установка OneScript (спасибо, otymko)
        - uses: otymko/setup-onescript@v1.4
          with:
            version: 1.9.0 
  
        - name: Выполнить скрипт преобразования OPI -> OInt # Запуск скрипта
          run: oscript ./.github/workflows/convert.os
  
        - uses: stefanzweifel/git-auto-commit-action@v5     # Сохранение (commit) результата на Github
          with:
            commit_user_name: Vitaly the Alpaca (bot) 
            commit_user_email: vitaly.the.alpaca@gmail.com
            commit_author: Vitaly the Alpaca <vitaly.the.alpaca@gmail.com>
            commit_message: Преобразование OPI -> OInt (workflow)

   

  
  
  
   
• Выполнение тестирования asserts через 1testrunner. Прописано оно достаточно топорно, но это в угоду подробности логирования 
  
  
   
• Принцип хранения, расшифровки и последующего шифрования данных, применяемых в тестах.
  
  Смысл таков, что в репозитории хранится зашифрованный json с различными токенами и ключами. В процессе тестирования он расшифровывается, служит источником информации для тестов (тесты также могут записывать в него новую информацию - например, обновленные токены), после чего шифруется обратно и сохраняется в репозитории. Шифрование и расшифровка реализованы при помощи gpg.
   
• Пример передачи файлов-артефактов между процессами. Это необходимо в тех случаях, когда один и тот же файл должен передаваться между различными процессами обработки. У меня так, например, передается тот файл с ключами и токенами между процессами Расшифровка -> Тестирование -> Шифрование

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

• При создании форков этот workflow переходит в новый репозиторий, а значит его также можно использовать в своем ответвлении. Шаблон файла данных для тестирования я добавлю чуть позже.
• Если какой-то момент в использовании библиотеки остается для вас непонятным по документации, то глядя одним глазом в файл тестов, а другим - в результаты их выполнения внутри GA, можно получить прямой актуальный пример "программный код -> результат выполнения"
  
  Код библиотеки для 1С и код библиотеки для OneScript - это один и тот же код, так что результаты этих тестов релевантны для обеих библиотек
   

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

Не всегда, правда, весь процесс тестирования целиком выполняется успешно, но только лишь по причине постоянных временных блокировок меня различными сервисами за чрезмерное их использование :Р

Так или иначе, теперь процесс тестирования стал более прозрачным для вас, а процесс сборки релизов - простым для меня. Посмотреть на это все можно по ссылке.

Ну а пока все.

Спасибо за внимание!

Репозиторий ОПИ: github.com/Bayselonarrend/OpenIntegrations

Последний релиз: github.com/Bayselonarrend/OpenIntegrations/releases/tag/1.5.0

Другие статьи про Открытый пакет интеграций на Инфостарт:

• Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter

• Работа с Notion API | Обновление Открытого пакета интеграций

• Библиотека работы с Яндекс Диском (Open-source) 

• Открываем свою лавку на платформе VK Market

• Библиотека для работы с Google Calendar API (open-source) 

• Telegram в режиме форума: делаем чаты комфортными

• Открытый пакет интеграций для OneScript

 

 Мой GitHub:     https://gitub.com/Bayselonarrend 
 Лицензия MIT:   https://mit-license.org