Skip to content
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

release 0.35.0 #233

Merged
merged 2 commits into from
Nov 27, 2024
Merged

release 0.35.0 #233

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2935fca
release 0.35.0
ayrat555 Nov 26, 2024
160dd1b
breaking change
ayrat555 Nov 27, 2024
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
33 changes: 20 additions & 13 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
# Changelog

## 0.35.0 (2024-11-26)

* try fit wasm partially - [#225](https://github.com/ayrat555/frankenstein/pull/225)
* fix: fix serialization of InlineQueryResult - [#230](https://github.com/ayrat555/frankenstein/pull/230)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this highlight that its breaking?

* build(cargo): update bon requirement from 2.2.0 to 3.0.0 - [#232](https://github.com/ayrat555/frankenstein/pull/232)
* build(cargo): update thiserror requirement from 1 to 2 - [#228](https://github.com/ayrat555/frankenstein/pull/228)

## 0.34.1 (2024-11-02)

- [Bot API 7.11](https://core.telegram.org/bots/api#october-31-2024) - [#226](https://github.com/ayrat555/frankenstein/pull/226)

## 0.34.0 (2024-09-19)

- docs: show the required feature on docs.rs by - [#209](https://github.com/ayrat555/frankenstein/pull/209)
- refactor!: flatten the module structure by - [#208](https://github.com/ayrat555/frankenstein/pull/208)
- perf!: always take params reference by - [#211](https://github.com/ayrat555/frankenstein/pull/211)
- refactor!: use MessageOrBool over EditMessageResponse by - [#212](https://github.com/ayrat555/frankenstein/pull/212)
- build!: remove implicit features by - [#214](https://github.com/ayrat555/frankenstein/pull/214)
- Use consistent builder derive configs across API types by - [#213](https://github.com/ayrat555/frankenstein/pull/213)
- test: improve testing for api error response by - [#216](https://github.com/ayrat555/frankenstein/pull/216)
- refactor!: simplify traits with macros by - [#210](https://github.com/ayrat555/frankenstein/pull/210)
- style: group imports by - [#217](https://github.com/ayrat555/frankenstein/pull/217)
- refactor: generalize serde logic into macro by - [#218](https://github.com/ayrat555/frankenstein/pull/218)
- test(error): expect api error by - [#222](https://github.com/ayrat555/frankenstein/pull/222)
- docs: deduplicate spaces by - [#220](https://github.com/ayrat555/frankenstein/pull/220)
- test(json): assert_str by - [#221](https://github.com/ayrat555/frankenstein/pull/221)
- docs: show the required feature on docs.rs - [#209](https://github.com/ayrat555/frankenstein/pull/209)
- refactor!: flatten the module structure - [#208](https://github.com/ayrat555/frankenstein/pull/208)
- perf!: always take params reference - [#211](https://github.com/ayrat555/frankenstein/pull/211)
- refactor!: use MessageOrBool over EditMessageResponse - [#212](https://github.com/ayrat555/frankenstein/pull/212)
- build!: remove implicit features - [#214](https://github.com/ayrat555/frankenstein/pull/214)
- Use consistent builder derive configs across API types - [#213](https://github.com/ayrat555/frankenstein/pull/213)
- test: improve testing for api error response - [#216](https://github.com/ayrat555/frankenstein/pull/216)
- refactor!: simplify traits with macros - [#210](https://github.com/ayrat555/frankenstein/pull/210)
- style: group imports - [#217](https://github.com/ayrat555/frankenstein/pull/217)
- refactor: generalize serde logic into macro - [#218](https://github.com/ayrat555/frankenstein/pull/218)
- test(error): expect api error - [#222](https://github.com/ayrat555/frankenstein/pull/222)
- docs: deduplicate spaces - [#220](https://github.com/ayrat555/frankenstein/pull/220)
- test(json): assert_str - [#221](https://github.com/ayrat555/frankenstein/pull/221)

## 0.33.0 (2024-09-11)

Expand Down
3 changes: 1 addition & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "frankenstein"
version = "0.34.1"
version = "0.35.0"
authors = ["Ayrat Badykov <[email protected]>", "EdJoPaTo <[email protected]>", "Pepe Márquez <[email protected]>"]
description = "Telegram bot API client for Rust"
edition = "2021"
Expand All @@ -22,7 +22,6 @@ async-telegram-trait = ["dep:async-trait"]

[lints.rust]
unsafe_code = "forbid"
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(rust_analyzer)'] }
[lints.clippy]
pedantic = { level = "warn", priority = -1 }
nursery = { level = "warn", priority = -1 }
Expand Down
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Run `cargo add frankenstein` or add the following to your `Cargo.toml`.

```toml
[dependencies]
frankenstein = "0.34"
frankenstein = "0.35"
```

## Features
Expand All @@ -34,13 +34,15 @@ frankenstein = "0.34"
To use the async client add the following line to your `Cargo.toml` file:

```toml
frankenstein = { version = "0.34", default-features = false, features = ["async-http-client"] }
frankenstein = { version = "0.35", default-features = false, features = ["async-http-client"] }
```

The async client partially supports wasm32 target, file uploads in the wasm32 target are not supported.

You can also disable all features. In this case the crate will ship only with Telegram types.

```toml
frankenstein = { version = "0.34", default-features = false }
frankenstein = { version = "0.35", default-features = false }
```

## Usage
Expand Down Expand Up @@ -188,7 +190,7 @@ AsyncApi::builder().api_url(api_url).client(client).build()

### Documentation

Frankenstein implements all Telegram bot API methods. To see which parameters you should pass, check [docs.rs](https://docs.rs/frankenstein/0.34.0/frankenstein/api_traits/telegram_api/trait.TelegramApi.html#provided-methods)
Frankenstein implements all Telegram bot API methods. To see which parameters you should pass, check [docs.rs](https://docs.rs/frankenstein/0.35.0/frankenstein/api_traits/telegram_api/trait.TelegramApi.html#provided-methods)

You can check out real-world bots created using this library:

Expand All @@ -204,7 +206,7 @@ The library uses `ureq` HTTP client by default, but it can be easily replaced wi
`ureq` comes with a default feature (`impl`). So the feature should be disabled.

```toml
frankenstein = { version = "0.34", default-features = false, features = ["telegram-trait"] }
frankenstein = { version = "0.35", default-features = false, features = ["telegram-trait"] }
```

Then implement the `TelegramApi` trait for your HTTP client which requires two functions:
Expand Down