keysloth 0.1.1 → 0.2.0

data/{task → promts/task_lists_for_human}/test_plan.md

@@ -1,4 +1,4 @@
-# Test plan: Проверка работы gem KeySloth (шаг за шагом для новичка)
+# Test plan: Проверка работы gem KeySloth (шаг за шагом, как для новичка)
 
 ## Цели
 - Подтвердить, что все основные команды работают: `init`, `pull`, `push`, `status`, `validate`, `restore`, `version`, `help`.
@@ -18,7 +18,7 @@
 
 ## 1. Клонирование проекта и установка зависимостей
 ```bash
-git clone https://github.com/keysloth/keysloth.git  # если локально — просто перейдите в папку проекта
+# перейдите в папку проекта
 cd keysloth
 bundle install
 ```
@@ -28,14 +28,10 @@ bundle install
 # Тесты
 bundle exec rake spec
 
-# Линтинг
-bundle exec rake rubocop
-```
-
 ## 3. Сборка и локальная установка gem
 ```bash
 gem build keysloth.gemspec
-gem install ./keysloth-0.1.1.gem
+gem install ./keysloth-0.2.0.gem  # подставить текущую версию вместо 0.2.0
 
 # Проверка установки и базовых команд
 keysloth version
@@ -50,27 +46,8 @@ ssh -V
 ```
 
 ## 4. Подготовка тестового удалённого репозитория (SSH)
-Вариант A (GitHub через веб-интерфейс):
 - Создайте приватный репозиторий, например `keysloth-secrets-test`.
-- Выберите «Add a README» при создании, чтобы в репозитории сразу была ветка `main`.
-
-Вариант B (через локальный git и push):
-```bash
-mkdir -p ~/tmp/keysloth-secrets-remote
-cd ~/tmp/keysloth-secrets-remote
-git init
-echo "# secrets" > README.md
-git add README.md
-git commit -m "init"
-git branch -M main
-git remote add origin git@github.com:<YOUR_USER>/keysloth-secrets-test.git
-git push -u origin main
-```
-
-Проверьте доступ по SSH:
-```bash
-ssh -T git@github.com
-```
+- Выберите «Add a README» при создании, чтобы в репозитории сразу была ветка `main`
 
 ## 5. Подготовка рабочего каталога и начальной конфигурации
 ```bash
@@ -78,6 +55,7 @@ mkdir -p ~/tmp/keysloth-playground
 cd ~/tmp/keysloth-playground
 
 # Инициализация проекта под KeySloth (создаст .keyslothrc, директорию секретов, обновит .gitignore)
+# Этот и остальные шаги этого пункта ниже - делать только если репозиторий в пункте 4 до этого ни разу не создавался
 keysloth init -r git@github.com:chausovSurfStudio/keysloth-secrets-test.git -b main -d ./secrets
 
 # Проверим, что создалось
@@ -88,32 +66,7 @@ cat .gitignore
 Ожидаемо: `.keyslothrc` содержит `repo_url`, `branch`, `local_path`; в `.gitignore` добавлены `secrets/` и `.keyslothrc`.
 
 ## 6. Подготовка тестовых «секретов»
-Создадим набор файлов разных типов, поддерживаемых инструментом:
-```bash
-mkdir -p secrets/certificates secrets/config
-
-# JSON
-cat > secrets/config/app.json << 'JSON'
-{
-  "apiKey": "demo-123",
-  "endpoint": "https://api.example.com",
-  "featureFlags": {"newUI": true}
-}
-JSON
-
-# CER (PEM)
-cat > secrets/certificates/dev.cer << 'CER'
------BEGIN CERTIFICATE-----
-MIIBkTCB+wI...FAKE...FOR...TEST...
------END CERTIFICATE-----
-CER
-
-# P12 (минимальный валидный заголовок: первый байт 0x30)
-printf "\x30\x82\x05\x10\x02\x01\x03\x30" > secrets/certificates/dev.p12
-
-# Mobile provisioning (XML/plist признак)
-echo '<?xml version="1.0" encoding="UTF-8"?><plist version="1.0"></plist>' > secrets/dev.mobileprovisioning
-```
+Создать/скопировать в заранее подготовленную папку набор необходимых "серкретов"
 
 ## 7. Первая отправка секретов (push)
 ```bash
@@ -141,10 +94,6 @@ keysloth pull \
   -p "$SECRET_PASSWORD" \
   -b main \
   -d ./secrets
-
-# Проверим содержимое
-ls -la ./secrets ./secrets/certificates
-cat ./secrets/config/app.json
 ```
 
 Ожидаемо: файлы восстановлены и читаемы.
@@ -216,38 +165,7 @@ keysloth pull -p "$SECRET_PASSWORD"
 keysloth push -p "$SECRET_PASSWORD" -m "update via rc"
 ```
 
-## 15. Минимальная проверка в CI/CD (GitHub Actions пример)
-Создайте секреты репозитория: `SSH_PRIVATE_KEY`, `SECRET_PASSWORD`. Затем workflow:
-```yaml
-name: KeySloth smoke
-on: [workflow_dispatch]
-jobs:
-  check:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.2'
-      - name: Setup SSH key
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-        run: |
-          mkdir -p ~/.ssh
-          echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_rsa
-          chmod 600 ~/.ssh/id_rsa
-          ssh-keyscan github.com >> ~/.ssh/known_hosts
-      - name: Install KeySloth
-        run: gem install keysloth
-      - name: Pull secrets
-        env:
-          SECRET_PASSWORD: ${{ secrets.SECRET_PASSWORD }}
-        run: |
-          keysloth pull -r git@github.com:<YOUR_USER>/keysloth-secrets-test.git -p "$SECRET_PASSWORD"
-```
-
-## 16. Завершение и очистка
+## 15. Завершение и очистка
 ```bash
 # Опционально удалить установленный gem локально
 gem uninstall keysloth -aIx
@@ -256,6 +174,7 @@ gem uninstall keysloth -aIx
 rm -rf ~/tmp/keysloth-playground ~/tmp/keysloth-secrets-remote
 ```
 
+
 ## Чек-лист «что должно сработать»
 - `gem build` и `gem install` проходят без ошибок; `keysloth version`/`help` работают.
 - `push` создаёт `*.enc` в удалённом репозитории; `pull` восстанавливает исходные файлы.

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: keysloth
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - KeySloth Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-02 00:00:00.000000000 Z
+date: 2025-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +119,7 @@ description: "KeySloth - инструмент для безопасного хр
   \nОбеспечивает простое получение, изменение и отправку секретов с использованием
   \nAES-256-GCM шифрования.\n"
 email:
-- team@keysloth.org
+- chausov@surf.dev
 executables:
 - keysloth
 extensions: []
@@ -123,12 +129,17 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
+- Appraisals
 - CHANGELOG.md
+- LICENSE
 - Makefile
 - README.md
 - Rakefile
 - bin/keysloth
+- gemfiles/thor_1.0.gemfile
+- gemfiles/thor_1.3.gemfile
 - keysloth.gemspec
+- keysloth.png
 - lib/keysloth.rb
 - lib/keysloth/cli.rb
 - lib/keysloth/config.rb
@@ -138,19 +149,25 @@ files:
 - lib/keysloth/git_manager.rb
 - lib/keysloth/logger.rb
 - lib/keysloth/version.rb
-- task/cr.md
-- task/plan.md
-- task/ragged_removing.md
-- task/task.md
-- task/test_plan.md
-homepage: https://github.com/keysloth/keysloth
+- promts/main/rules.md
+- promts/main/task.md
+- promts/outdated/feature_ragged_removing.md
+- promts/outdated/feature_wildcard_extensions.md
+- promts/outdated/fix_backups.md
+- promts/outdated/fix_config_file.md
+- promts/outdated/fix_ssh.md
+- promts/outdated/plan.md
+- promts/outdated/thor-updates.md
+- promts/task_lists_for_human/release_task_list.md
+- promts/task_lists_for_human/test_plan.md
+homepage: https://github.com/chausovSurfStudio/keysloth
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/keysloth/keysloth
-  source_code_uri: https://github.com/keysloth/keysloth
-  changelog_uri: https://github.com/keysloth/keysloth/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/chausovSurfStudio/keysloth
+  source_code_uri: https://github.com/chausovSurfStudio/keysloth
+  changelog_uri: https://github.com/chausovSurfStudio/keysloth/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/task/cr.md

@@ -1,59 +0,0 @@
-# Change Request: Поддержка SSH ключей id_ed25519 и улучшение UX
-
-## Контекст проблемы
-При запуске команды (например, `keysloth pull`) возникла ошибка:
-
-```
-Ошибка выполнения операции: SSH ключ не найден: /Users/<user>/.ssh/id_rsa
-```
-
-Причина: в `KeySloth::GitManager#create_ssh_credentials` по умолчанию ожидаются ключи формата RSA (`~/.ssh/id_rsa` и `~/.ssh/id_rsa.pub`). На машине пользователя используются ключи Ed25519 (`id_ed25519`, `id_ed25519.pub`).
-
-## Временные решения (workarounds)
-1. Использовать ключи из переменных окружения (подходит для локали и CI/CD):
-```bash
-export SSH_PRIVATE_KEY="$(cat ~/.ssh/id_ed25519)"
-export SSH_PUBLIC_KEY="$(cat ~/.ssh/id_ed25519.pub)"
-keysloth pull -r git@github.com:USER/REPO.git -p "PASSWORD"
-```
-
-2. Создать симлинки под ожидаемые имена (быстро, локально):
-```bash
-ln -s ~/.ssh/id_ed25519 ~/.ssh/id_rsa
-ln -s ~/.ssh/id_ed25519.pub ~/.ssh/id_rsa.pub
-```
-
-3. Сгенерировать отдельный RSA‑ключ (если принципиально):
-```bash
-ssh-keygen -t rsa -b 4096 -C "you@example.com" -f ~/.ssh/id_rsa
-# добавить ~/.ssh/id_rsa.pub в GitHub/GitLab
-```
-
-## Предложения по доработке
-1. Поддержать Ed25519 «из коробки» в `create_ssh_credentials`:
-   - Приоритет: переменные окружения `SSH_PRIVATE_KEY`/`SSH_PUBLIC_KEY` (как сейчас).
-   - Fallback: искать пары ключей по стандартным путям в порядке:
-     - `~/.ssh/id_rsa(.pub)`
-     - `~/.ssh/id_ed25519(.pub)`
-   - Если пара найдена — использовать; иначе выбрасывать `AuthenticationError` с подсказками.
-
-2. Добавить конфигурируемый путь к ключу:
-   - Env: `KEYSLOTH_SSH_KEY_PATH` (если задан — использовать `<path>` и `<path>.pub`).
-   - Опция CLI: `--ssh-key PATH` (пробрасывать в `GitManager`).
-
-3. Рассмотреть поддержку ssh-agent:
-   - Использовать `Rugged::Credentials::SshKeyFromAgent` при отсутствии файлов и env.
-
-4. Улучшить сообщение об ошибке:
-   - Печатать проверённые пути, быстрые шаги: env, симлинк, `--ssh-key`.
-
-## Тестирование
-- Добавить тесты в `spec/keysloth/git_manager_spec.rb`:
-  - только `id_rsa`
-  - только `id_ed25519`
-  - ключи через ENV
-  - путь через `KEYSLOTH_SSH_KEY_PATH`
-  - отсутствие ключей → `AuthenticationError`
-
-## Документация
-- Обновить README (раздел «Настройка SSH ключей») и `task/test_plan.md` (раздел про SSH) с примерами для Ed25519 и `--ssh-key`/env.