Skip to content

Commit

Permalink
Added object_prompt support
Browse files Browse the repository at this point in the history
  • Loading branch information
HJLebbink committed Jan 10, 2025
1 parent 8facff7 commit ff942cd
Show file tree
Hide file tree
Showing 17 changed files with 443 additions and 48 deletions.
7 changes: 5 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ futures-util = "0.3.31"
hex = "0.4.3"
hmac = "0.12.1"
home = "0.5.9"
http = "1.1.0"
http = "1.2.0"
hyper = { version = "1.5.1", features = ["full"] }
lazy_static = "1.5.0"
log = "0.4.22"
Expand All @@ -61,4 +61,7 @@ clap = { version = "4.5.23", features = ["derive"] }
quickcheck = "1.0.3"

[[example]]
name = "file-uploader"
name = "file_uploader"

[[example]]
name = "object_prompt"
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ MinIO Rust SDK is Simple Storage Service (aka S3) client to perform bucket and o

For a complete list of APIs and examples, please take a look at the [MinIO Rust Client API Reference](https://minio-rs.min.io/)

## Example:: file-uploader.rs
## Examples

[Upload a file to MinIO](examples/file-uploader.rs)
Run the examples from the command line with:

`cargo run --example <example_name>`

### file_uploader.rs

* [Upload a file to MinIO](examples/file_uploader)
* [Upload a file to MinIO with CLI](examples/put_object)

### object_prompt.rs

* [Prompt a file on MinIO](examples/object_prompt)

## License
This SDK is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), see [LICENSE](https://github.com/minio/minio-rs/blob/master/LICENSE) for more information.
Binary file added examples/cat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 27 additions & 9 deletions examples/file-uploader.rs → examples/file_uploader.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
use log::info;
// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
// Copyright 2024 MinIO, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use minio::s3::args::{BucketExistsArgs, MakeBucketArgs};
use minio::s3::builders::ObjectContent;
use minio::s3::client::ClientBuilder;
Expand All @@ -11,8 +25,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
env_logger::init(); // Note: set environment variable RUST_LOG="INFO" to log info and higher

let base_url = "https://play.min.io".parse::<BaseUrl>()?;

info!("Trying to connect to MinIO at: `{:?}`", base_url);
log::info!("Trying to connect to MinIO at: `{:?}`", base_url);

let static_provider = StaticProvider::new(
"Q3AM3UQ867SPQQA43P2F",
Expand All @@ -24,7 +37,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
.provider(Some(Box::new(static_provider)))
.build()?;

let bucket_name: &str = "asiatrip";
let bucket_name: &str = "file-upload-rust-bucket";

// Check 'bucket_name' bucket exist or not.
let exists: bool = client
Expand All @@ -41,21 +54,26 @@ async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
}

// File we are going to upload to the bucket
let filename: &Path = Path::new("/tmp/asiaphotos.zip");
let filename: &Path = Path::new("./examples/cat.png");

// Name of the object that will be stored in the bucket
let object_name: &str = "asiaphotos-2015.zip";
let object_name: &str = "cat.png";

info!("filename {}", &filename.to_str().unwrap());
if filename.exists() {
log::info!("File '{}' exists.", &filename.to_str().unwrap());
} else {
log::error!("File '{}' does not exist.", &filename.to_str().unwrap());
return Ok(());
}

let content = ObjectContent::from(filename);
client
.put_object_content(bucket_name, object_name, content)
.send()
.await?;

info!(
"file `{}` is successfully uploaded as object `{object_name}` to bucket `{bucket_name}`.",
log::info!(
"file '{}' is successfully uploaded as object '{object_name}' to bucket '{bucket_name}'.",
filename.display()
);
Ok(())
Expand Down
90 changes: 90 additions & 0 deletions examples/object_prompt.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
// Copyright 2024 MinIO, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use minio::s3::args::{BucketExistsArgs, MakeBucketArgs};
use minio::s3::builders::{ObjectContent, ObjectPrompt};
use minio::s3::client::ClientBuilder;
use minio::s3::creds::StaticProvider;
use minio::s3::http::BaseUrl;
use minio::s3::types::S3Api;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
env_logger::init(); // Note: set environment variable RUST_LOG="INFO" to log info and higher

let base_url = "https://play.min.io".parse::<BaseUrl>()?;
log::info!("Trying to connect to MinIO at: `{:?}`", base_url);

let static_provider = StaticProvider::new(
"Q3AM3UQ867SPQQA43P2F",
"zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG",
None,
);

let client = ClientBuilder::new(base_url.clone())
.provider(Some(Box::new(static_provider)))
.ignore_cert_check(Some(true))
.build()?;

let bucket_name: &str = "object-prompt-rust-bucket";

// Check 'bucket_name' bucket exist or not.
let exists: bool = client
.bucket_exists(&BucketExistsArgs::new(bucket_name).unwrap())
.await
.unwrap();

// Make 'bucket_name' bucket if not exist.
if !exists {
client
.make_bucket(&MakeBucketArgs::new(bucket_name).unwrap())
.await
.unwrap();
}

// File we are going to upload to the bucket
let filename: &Path = Path::new("./examples/cat.png");

// Name of the object that will be stored in the bucket
let object_name: &str = "cat.png";

if filename.exists() {
log::info!("File '{}' exists.", &filename.to_str().unwrap());
} else {
log::error!("File '{}' does not exist.", &filename.to_str().unwrap());
return Ok(());
}

let content = ObjectContent::from(filename);
client
.put_object_content(bucket_name, object_name, content)
.send()
.await?;

log::info!(
"File '{}' is successfully uploaded as object '{object_name}' to bucket '{bucket_name}'.",
filename.display()
);

let op = ObjectPrompt::new(bucket_name, object_name, "what is it about?")
//.lambda_arn("arn:minio:s3-object-lambda::_:webhook") // this is the default value
.client(&client);

let res = op.send().await?;
log::info!("Object prompt result: '{}'", res.prompt_response);

Ok(())
}
File renamed without changes.
5 changes: 5 additions & 0 deletions src/s3/builders.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
// Copyright 2024 MinIO, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
Expand All @@ -17,6 +20,7 @@ mod get_object;
mod list_objects;
mod listen_bucket_notification;
mod object_content;
mod object_prompt;
mod put_object;
mod remove_objects;

Expand All @@ -25,5 +29,6 @@ pub use get_object::*;
pub use list_objects::*;
pub use listen_bucket_notification::*;
pub use object_content::*;
pub use object_prompt::*;
pub use put_object::*;
pub use remove_objects::*;
18 changes: 7 additions & 11 deletions src/s3/builders/get_object.rs
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,7 @@ impl ToS3Request for GetObject {
"object name cannot be empty",
)));
}

let client = self.client.clone().ok_or(Error::NoClientProvided)?;
let client: &Client = self.client.as_ref().ok_or(Error::NoClientProvided)?;

if self.ssec.is_some() && !client.is_secure() {
return Err(Error::SseTlsRequired(None));
Expand All @@ -199,15 +198,12 @@ impl ToS3Request for GetObject {
query_params.insert(String::from("versionId"), v.to_string());
}

let req = S3Request::new(
self.client.as_ref().ok_or(Error::NoClientProvided)?,
Method::GET,
)
.region(self.region.as_deref())
.bucket(Some(&self.bucket))
.object(Some(&self.object))
.query_params(query_params)
.headers(headers);
let req = S3Request::new(client, Method::GET)
.region(self.region.as_deref())
.bucket(Some(&self.bucket))
.object(Some(&self.object))
.query_params(query_params)
.headers(headers);

Ok(req)
}
Expand Down
Loading

0 comments on commit ff942cd

Please sign in to comment.