💩 Small HTTP client for the Webpurify API following the sans-io approach 🦀

Embark

Last update: May 1, 2023

Related tags

Learning Resources tame-webpurify

Overview

`💩 tame-webpurify`

Super simple client for the WebPurify REST API

What is this?

An incredibly small library to interact with the https://www.webpurify.com/documentation/ REST API.

tame-webpurify takes the sans-io approach and builds up the request objects for you so that you can use whatever library you're used to for the actual HTTP transport.

Please be advised that the source code will contain some swearing etc. Can't test a profanity filter / content-moderation API without actually acting like a jerk.

See the example code on how to use it tame-webpurify together with reqwest

Examples

Build and run the provided example:

$ cargo run --example profanity -- --apikey <your-webpurify-api-key>
=> 
 
{
  status: 200,
  version: HTTP/2.0,
  headers: { ... },
  body: {
    "rsp": {
      "@attributes": {
        "stat": "ok",
        "rsp": "0.062274932861328"
      },
      "method": "webpurify.live.replace",
      "format": "rest",
      "found": "3",
      "text": "**** you man! call me at +**********3 or email me at ****.****@*******.***",
      "api_key": "some-api-key"
    }
  }
}

Supported methods

The following WebPurify methods are currently available:

pub enum Method {
    /// webpurify.live.check
    Check,
    /// webpurify.live.check
    Replace(String),
}

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started. Please also read our Contributor Terms before you make any contributions.

Any contribution intentionally submitted for inclusion in an Embark Studios project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:

License

This contribution is dual licensed under EITHER OF

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

For clarity, "your" refers to Embark or any other licensee/user of the contribution.

Comments

Add response handling functions
Checklist

[x] I have read the Contributor Guide

[x] I have read and agree to the Code of Conduct

[x] I have added a description of my changes and why I'd like them included in the section below

Description of Changes

Add support functions for parsing responses for requests made with Request's from the profanity_check_request & profanity_replace_request functions. Update example using response parse function as well.

Update: Shall we bump version in this PR as well?
opened by bwestlin 4
Add docs and rename API functions
Add documentation to public API functions ~* Rename API functions from profanity_ to text_ to make their use case clearer~ ~* Rename example from profanity to text_moderation~

Proposed additions to:

https://github.com/EmbarkStudios/tame-webpurify/pull/3
opened by vojd 1
Add some badges to readme
Checklist

[x] I have read the Contributor Guide

[x] I have read and agree to the Code of Conduct

[x] I have added a description of my changes and why I'd like them included in the section below

Description of Changes

Added some badges to the readme and checked that they work.
opened by bwestlin 0
Fixes to changelog
Checklist

[x] I have read the Contributor Guide

[x] I have read and agree to the Code of Conduct

[x] I have added a description of my changes and why I'd like them included in the section below

Description of Changes

Added Unreleased entry in changelog and fixed the compare links
opened by bwestlin 0
Cargo metadata for release
Checklist

[x] I have read the Contributor Guide

[x] I have read and agree to the Code of Conduct

[x] I have added a description of my changes and why I'd like them included in the section below

Description of Changes

Add license and related information to cargo.toml before publishing to crates.io
opened by vojd 0
Initial version
Checklist

[x] I have read the Contributor Guide

[x] I have read and agree to the Code of Conduct

[x] I have added a description of my changes and why I'd like them included in the section below

Description of Changes

Initial version of tame-webpurify. Contains the required code to build request objects for interacting with the webpurify api.

Small example provided on how to use tame-webpurify with reqwest.

Related Issues

List related issues here
opened by vojd 0

Owner

Embark

The future belongs to the curious

GitHub

🍋: A General Lock following paper "Optimistic Lock Coupling: A Scalable and Efficient General-Purpose Synchronization Method"

Optimistic Lock Coupling from paper "Optimistic Lock Coupling: A Scalable and Efficient General-Purpose Synchronization Method" In actual projects, th

22 Oct 13, 2022

An attempt to start documenting the rust sdk for temporal and how to use it following some of the examples in typescript

This is an attempt to start documenting the rust sdk for temporal and how to use it following some of the examples in typescript.

5 May 24, 2023

Tiny HTTP client for GET

tinyget a tiny fork of minreq. Simple, minimal-dependency HTTP client. Optional features for https with native-tls TLS implementations. Documentation

19 Dec 31, 2022

An API for getting questions from http://either.io implemented fully in Rust, using reqwest and some regex magic. Provides asynchronous and blocking clients respectively.

eithers_rust An API for getting questions from http://either.io implemented fully in Rust, using reqwest and some regex magic. Provides asynchronous a