awkawbandClaude Opus 5
e4f2373b53
First item on the GOALS.md roadmap. `upload_{x}(id, files, is_public)`
attaches files through `/{resource}/{id}/upload` and returns the
refreshed record. Verified against upstream that all 16 controllers
answer with `itemResponse($x->fresh())`.
Three details that look wrong but are not, each checked in the upstream
source rather than taken from the published spec:
- The request is a POST carrying `_method=PUT`. The route is registered
PUT, but PHP does not parse a multipart body on a real PUT, so the
files never arrive. Laravel's kernel calls
`enableHttpMethodParameterOverride()`, turning the spoofed method back
into a PUT before routing. The spec documents POST with `_method=POST`,
which would 405 against these routes.
- `is_public` is sent as 1/0. Laravel's `boolean` rule accepts only
true, false, 0, 1, '0' and '1' under strict comparison, so "true"
fails validation.
- Uploads are never retried. An upload adds a document, so it is not
idempotent whatever its verb, and a replay after a lost response would
attach the file twice. This falls out of reqwest's multipart body being
un-cloneable, which nothing in the types enforces, so a test pins it
for 500, 503 and 429.
An upload with no files, a nameless file or an unparseable MIME type is
refused locally (`Error::InvalidUpload`), since the server answers an
empty upload with a success that changed nothing.
Corrects two earlier claims:
- GOALS.md and COVERAGE.md said uploads would make `create_document`
possible. They do not: `DocumentController::store` is an empty stub,
and an upload is the only way a document is created. There is no
`create_document`.
- The documented method count (265) had been stale since the typed
`statics`/`search`/`health_check` commit, which added three `_as`
methods without updating it. Recounted from the source: 284 = 210 +
18 + 12 + 16 uploads + 28 hand-written.
Also fixes a README example, `let statics: Value = client.statics()`,
that stopped compiling when `statics` lost its type parameter.
`edocument/upload` is left out: it imports an expense from an
e-document rather than attaching a file, so it moves to the
import/export roadmap item.
Enabling `multipart` adds mime, mime_guess and unicase; MSRV stays 1.88,
re-verified by running the suite on it. 101 tests, up from 91.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
27 lines
716 B
Rust
27 lines
716 B
Rust
//! An async Rust client for the [Invoice Ninja](https://www.invoiceninja.com/) v5 API.
|
|
//!
|
|
//! ```no_run
|
|
//! use invoiceninjars::{InvoiceNinjaClient, models::ListParams};
|
|
//!
|
|
//! # async fn run() -> invoiceninjars::Result<()> {
|
|
//! let client = InvoiceNinjaClient::new(
|
|
//! "https://invoicing.co/api/v1",
|
|
//! std::env::var("IN_API_TOKEN").unwrap(),
|
|
//! )?;
|
|
//!
|
|
//! let clients = client.list_clients(&ListParams::new().per_page(50)).await?;
|
|
//! # Ok(())
|
|
//! # }
|
|
//! ```
|
|
|
|
mod client;
|
|
mod error;
|
|
pub mod models;
|
|
mod retry;
|
|
mod upload;
|
|
|
|
pub use client::{InvoiceNinjaClient, DEFAULT_TIMEOUT, HOSTED_BASE_URL};
|
|
pub use error::{ApiErrorBody, Error, Result};
|
|
pub use retry::RetryPolicy;
|
|
pub use upload::FileUpload;
|