Skip to content

refactor: extract authentication into auth module #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VedantMadane wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: extract authentication into auth module #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ confluence2md/
├── src/ # Rust source (Cargo binary + library)
│ ├── main.rs # CLI entry point: arg parsing + pipeline orchestration
│ ├── lib.rs # Library root: re-declares public modules
│ ├── auth.rs # Auth env resolution + Authorization header helpers
│ ├── confluence.rs # Confluence REST client: page/attachment fetch, image rewrite
│ ├── drawio.rs # draw.io fallback resolution + PNG tEXt embedding
│ ├── plantuml.rs # PlantUML source extraction + !include rewriting
Expand Down Expand Up @@ -80,7 +81,12 @@ confluence2md is a single Rust crate that exposes one binary (`confluence2md`) a
- **Inputs:** `<pageUrl>` arg, `--output-path`, `--log-level`, `--table-conversion`, plus `CONFLUENCE2MD_*` env vars.
- **Outputs:** `Page_Title.md`, `Page_Title_assets/`. When `--dump-state-path <DIR>` or `CONFLUENCE2MD_DUMP_STATE_PATH` is specified, the raw page API snapshot (`content.json`), debug intermediates (`export.html`, `storage.html`, `rewrite_*.html`), and raw draw.io XML files (`*.drawio`) are written to that dump directory.

### 3.2. `confluence` — REST Client and Image Rewriter
### 3.2. `auth` — Authentication

- **Responsibility:** Resolve Confluence credentials from environment variables and build Authorization headers.
- **Key functions:** `resolve_auth`, `auth_headers`, `binary_auth_headers`.

### 3.3. `confluence` — REST Client and Image Rewriter

- **Responsibility:** Talk to the Confluence REST API v1 and download regular binary assets referenced by the page HTML. draw.io and PlantUML assets are resolved by their dedicated modules first.
- **Key types:** `EnvConfig`, `PageResult`, `Attachment`, `AttachmentMaps`, `DownloadBinaryOptions`, `DownloadAttachmentOptions`, `DownloadImagesOptions`.
Expand Down
Loading
Loading