Skip to content

Commit

Permalink
Merge pull request #35 from GregoryGost/develop
Browse files Browse the repository at this point in the history
v3.1.2
  • Loading branch information
GregoryGost authored Sep 30, 2024
2 parents c63fdd7 + cb59234 commit 1e44571
Show file tree
Hide file tree
Showing 18 changed files with 1,535 additions and 867 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/develop-versioning.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: New tag step
id: new-dev-version
uses: GregoryGost/version-tagger@v1.0.3
uses: GregoryGost/version-tagger@v1.0.4
with:
token: ${{ secrets.GITHUB_TOKEN }}
prefix: 'v'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main-versioning.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: New tag step
id: new-main-version
uses: GregoryGost/version-tagger@v1.0.3
uses: GregoryGost/version-tagger@v1.0.4
with:
token: ${{ secrets.GITHUB_TOKEN }}
prefix: 'v'
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20.11.0
20.17.0
2 changes: 1 addition & 1 deletion EXAMPLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
[11.05.2024_04:38:08.212] : [DEBUG] : Saving path directories is created
[11.05.2024_04:38:08.213] : [INFO] : MOVE file "Dark.Matter.S01E01.1080p.rus.LostFilm.TV.mkv" to saving path "/mnt/data
/media/serials/Dark Matter/Season 01"
[11.05.2024_04:38:08.213] : [DEBUG] : Move command: "transmission-remote 127.0.0.1:9091 --auth narakot:247050689Hh
[11.05.2024_04:38:08.213] : [DEBUG] : Move command: "transmission-remote 127.0.0.1:9091 --auth login:password
--torrent 16 --move "/mnt/data/media/serials/Dark Matter/Season 01""
[11.05.2024_04:38:08.213] : [DEBUG] : Start moving file...
[11.05.2024_04:38:08.223] : [DEBUG] : execResult: 127.0.0.1:9091/transmission/rpc/ responded: "success"
Expand Down
38 changes: 21 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
<!--ts-->

- [Описание](#описание)
- [Установка](#установка)
- [Конфигурирование](#конфигурирование)
- [Обновление](#обновление)
- [Установка скрипта](#установка-скрипта)
- [Конфигурирование скрипта](#конфигурирование-скрипта)
- [Обновление скрипта](#обновление-скрипта)
- [Алгоритм обработки торрентов](#алгоритм-обработки-торрентов)
- [Правила именования торрентов для корректной работы скрипта](#правила-именования-торрентов-для-корректной-работы-скрипта)
- [Сериалы](#сериалы)
Expand All @@ -39,10 +39,10 @@
## Описание

Основной кодовой базой является программная платформа [Node.js](https://nodejs.org/) основанная на движке
[V8](https://v8.dev/)
[V8](https://v8.dev/) который был разработан в компании Google.

Данное приложение выполняется после завершения скачивания каждого торрента в сервисе Transmission daemon
Для его работы он должен быть настроен в файле конфигурации `settings.json` через параметры
Для его работы он должен быть настроен в файле конфигурации Transmission `settings.json` через параметры
`script-torrent-done-enabled` и `script-torrent-done-filename`

```json
Expand All @@ -53,6 +53,8 @@

История версий:

- v3.1.2 - (30.09.2024) - Улучшены тесты. Поправлены обработки релизеров по итогам тестов. Мелкие исправления.
Обновление библиотек.
- v3.1.1 - (22.09.2024) - Поправлено получение имени сериала. Изменено регулярное выражение для обработки сериалов
LostFilm. Изменился формат. Пример `The Penguin S01E01.1080p.rus.LostFilm.TV.mkv`
- v3.0.0 - (21.04.2024) - Изменена архитектура итогового приложения. Теперь нет необходимости ставить зависимости. Все
Expand Down Expand Up @@ -89,8 +91,8 @@
- v0.0.1 - (17.04.2018) Исправлены условия определяющие корректно ли перемещен файл
- NV - (17.04.2018) Первая версия

Перед стартом, transmission генерирует переменные в Environment:
Для версии 3.00
Перед стартом скрипта, transmission генерирует переменные в Environment:
Для версии 3.00 набор такой

- TR_APP_VERSION: версия Transmission
- TR_TORRENT_ID: идентификатор (ID) торрента
Expand All @@ -105,18 +107,19 @@
- TR_TORRENT_BYTES_DOWNLOADED: размер загруженных данных в байтах
- TR_TORRENT_TRACKERS: список URL анонсированных трекеров

## Установка
## Установка скрипта

Нужно поставить Node.js и менеджер пакетов PNPM
Команды для Proxmox LXC Debian под root
Нужно поставить **Node.js**, скачать исполняемый файл скрипта и создать для него конфигурацию.

Команды для Proxmox LXC Debian под root:

```shell
apt update && apt upgrade -y && apt install -y curl wget
```

Ставим Node.js
Ставим **Node.js**
Пойти в <https://github.com/nodesource/distributions/blob/master/README.md>
Выбрать LTS версию не ниже 20
Выбрать LTS версию

```shell
curl -fsSL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
Expand All @@ -127,7 +130,7 @@ v20.17.0
```

Далее создаем папку под приложение, делаем файл исполняемым. Создаем фейковый файл `package.json` (нужно для корректного
определения корневой дирректории)
определения корневой дирректории и нахождения файла конфигурации)

```shell
mkdir /opt/torrentdone
Expand All @@ -137,9 +140,9 @@ chmod +x index.js
echo '{"version":"3.1.1"}' > package.json
```

### Конфигурирование
### Конфигурирование скрипта

Создаем файл настроек и задаем свои параметры
Создаем файл настроек и указываем свои параметры

```shell
nano /opt/torrentdone/config.json
Expand Down Expand Up @@ -182,9 +185,10 @@ chown -R debian-transmission:debian-transmission /opt/torrentdone

Настройки будут считываться при каждом запуске скрипта по окончании процесса скачивания торрента.

## Обновление
## Обновление скрипта

Стоит обновить Node.js если скрипт поддерживает её. Как пример обновление на 20 LTS версию.
Стоит обновить Node.js если скрипт поддерживает новую версию (отражено в файле `package.json` в репозитории). Как пример
обновление на 20 LTS версию.

```shell
curl -fsSL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
Expand Down
2 changes: 1 addition & 1 deletion __tests__/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ configs/mnt/data/
!configs/no_login/config.json
!configs/no_tr_env/config.json
!configs/once_ext/config.json
!configs/ak_prod/config.json
!configs/ak_prod/config.json
9 changes: 9 additions & 0 deletions __tests__/config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,15 @@ describe('config.ts', () => {
);
}
});
it('config while package.json throw error', async () => {
jest.spyOn(Config.prototype, 'maxWhileCount', 'get').mockReturnValue(0);
try {
new Config();
} catch (error) {
// eslint-disable-next-line jest/no-conditional-expect
expect(error).toHaveProperty('message', 'The number of attempts to search for the root directory has expired');
}
});
/**
* Get all parameters test
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Test file. NOT video!!!!
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Test file. NOT video!!!!
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Test file. NOT video!!!!
Loading

0 comments on commit 1e44571

Please sign in to comment.