From 4185d36abe2fa0580a258601c59c8d0bb778239c Mon Sep 17 00:00:00 2001 From: Tom Heaton Date: Wed, 18 Jan 2023 04:32:00 +0000 Subject: [PATCH 1/4] rust docs --- .gitignore | 1 + mint.json | 3 ++- sdks/overview.mdx | 1 + sdks/server/rs.mdx | 43 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 sdks/server/rs.mdx diff --git a/.gitignore b/.gitignore index f74c781..09c9f64 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .next node_modules +.idea diff --git a/mint.json b/mint.json index e99406a..0bcb4f1 100644 --- a/mint.json +++ b/mint.json @@ -83,7 +83,8 @@ { "group": "Go", "pages": ["sdks/server/go-api", "sdks/server/go-leap"] - } + }, + "sdks/server/rs" ] } ] diff --git a/sdks/overview.mdx b/sdks/overview.mdx index cd120fe..6b5008d 100644 --- a/sdks/overview.mdx +++ b/sdks/overview.mdx @@ -19,6 +19,7 @@ languages. Below is a list of our official, supported libraries. | ---------- | ---------- | ------------------------------------------------------------------------ | -------- | ------------------------------------------ | | @onehop/js | TypeScript | [npmjs.com/package/@onehop/js](https://www.npmjs.com/package/@onehop/js) | ✅ | [/sdks/server/js](/sdks/server/js) | | hop-go | Golang | [github.com/hopinc/go](https://github.com/hopinc/go) | ✅ | [/sdks/server/go-api](/sdks/server/go-api) | +| hop-rs | Rust | [github.com/hopinc/rs](https://github.com/hopinc/rs) | ✅ | [/sdks/server/rs-api](/sdks/server/rs-api) | ### REST API diff --git a/sdks/server/rs.mdx b/sdks/server/rs.mdx new file mode 100644 index 0000000..064ab2a --- /dev/null +++ b/sdks/server/rs.mdx @@ -0,0 +1,43 @@ +--- +title: 'Server-side Rust SDK' +sidebarTitle: 'Rust' +description: + 'The Hop server-side Rust SDK allows you to interact with all Hop products on + the server side.' +--- + +## Installing + +You can add `hop-rs` to your `cargo.toml` file: + +```toml +[dependencies] +hop-rs = "0.1.0" +``` + +## Creating an SDK Instance + +To use the SDK, you must first create a +[project token](/reference/project-tokens). You can also use a PAT (personal +access token), however this is not recommended as it has access to all of your +projects. + +```rust +extern crate hop; +extern crate rand; + +use hop::Hop; +use rand::Rng; + +#[tokio::main] +async fn main() { + let my_token = "ptk_xxx"; + let hop = Hop::new(my_token); + + // Example: Creating a project secret + hop.projects.create_secret( + "RANDOM_NUMBER", + rand::thread_rng().gen_range(0..100).to_string(), + ).await.unwrap(); +} +``` From 8d5e59f453037acaf1950b61bd542813029342b4 Mon Sep 17 00:00:00 2001 From: Tom Heaton Date: Wed, 18 Jan 2023 04:34:19 +0000 Subject: [PATCH 2/4] fix codeblocks --- sdks/server/rs.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdks/server/rs.mdx b/sdks/server/rs.mdx index 064ab2a..2d359f4 100644 --- a/sdks/server/rs.mdx +++ b/sdks/server/rs.mdx @@ -10,7 +10,7 @@ description: You can add `hop-rs` to your `cargo.toml` file: -```toml +```toml TOML [dependencies] hop-rs = "0.1.0" ``` @@ -22,7 +22,7 @@ To use the SDK, you must first create a access token), however this is not recommended as it has access to all of your projects. -```rust +```rust Rust extern crate hop; extern crate rand; From 90c43f3fbe4b25853a807337c6f513a52c52f4ae Mon Sep 17 00:00:00 2001 From: Tom Heaton Date: Wed, 18 Jan 2023 04:35:02 +0000 Subject: [PATCH 3/4] fix codeblock --- sdks/server/rs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdks/server/rs.mdx b/sdks/server/rs.mdx index 2d359f4..4ca6ae6 100644 --- a/sdks/server/rs.mdx +++ b/sdks/server/rs.mdx @@ -22,7 +22,7 @@ To use the SDK, you must first create a access token), however this is not recommended as it has access to all of your projects. -```rust Rust +```rust RS extern crate hop; extern crate rand; From 8d91b382979b249bea1fea1694cae1a1f8c0cb40 Mon Sep 17 00:00:00 2001 From: Tom Heaton Date: Sun, 29 Jan 2023 15:41:36 +0000 Subject: [PATCH 4/4] project tokens --- reference/project-tokens.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/reference/project-tokens.mdx b/reference/project-tokens.mdx index 8daf2db..652ecd2 100644 --- a/reference/project-tokens.mdx +++ b/reference/project-tokens.mdx @@ -67,6 +67,18 @@ func main() { } ```` +```rs Rust +extern crate hop; + +use hop::Hop; + +#[tokio::main] +async fn main() { + let my_token = "ptk_xxx"; + let hop = Hop::new(my_token); +} +```` + ### API