Merge pull request #5 from infobip-community/add-whatsapp-essentials

Add whatsapp essentials, fix Readme

Author: strosek

Cargo.toml

@@ -7,7 +7,7 @@ homepage = "https://www.infobip.com/"
 license = "MIT OR Apache-2.0"
 name = "infobip_sdk"
 repository = "https://github.com/infobip-community/infobip-api-rust-sdk"
-version = "0.1.0"
+version = "0.1.1"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -26,5 +26,6 @@ validator = { version = "0.16", features = ["derive"] }
 httpmock = "0.6"
 
 [features]
-default = ["sms"]
-sms = []
+default = ["sms", "whatsapp"]
+sms = []
+whatsapp = []

README.md

@@ -2,6 +2,8 @@
 
 ![Workflow](https://github.com/infobip-community/infobip-api-rust-sdk/actions/workflows/rust.yml/badge.svg)
 [![Licence](https://img.shields.io/github/license/infobip-community/infobip-api-rust-sdk)](LICENSE-MIT)
+![Crates.io](https://img.shields.io/crates/v/infobip_sdk)
+![Crate downlads](https://img.shields.io/crates/d/rust_sdk)
 
 Client SDK to use the Infobip API with pure Rust.
 
@@ -12,7 +14,8 @@ handling. The module structure is divided by communication channel.
 ---
 
 ## 📡 Supported Channels
-- [SMS](https://www.infobip.com/docs/api/channels/sms) (in progress)
+- [SMS](https://www.infobip.com/docs/api/channels/sms)
+- [WhatsApp](https://www.infobip.com/docs/api/channels/whatsapp) (partially, in progress)
 
 More Channels to be added in the near future!
 
@@ -26,7 +29,7 @@ load the configuration from the environment. To do that, export the variables `I
 To use the library, add the dependency to your projects `Cargo.toml`
 ```toml
 [dependencies]
-infobip-sdk = "0.1"
+infobip_sdk = "0.1"
 ```
 
 ## 🚀 Usage
@@ -131,7 +134,7 @@ model.
 You can speed up compile-times a bit by turning only the needed channels as library features.
 For example, to only build SMS, add the dependency like this:
 ```toml
-infobip-sdk = { version = "0.1", features = ["sms"] }
+infobip_sdk = { version = "0.1", features = ["sms"] }
 ```
 You can see the complete list of features in the Cargo.toml of the project. Feature names
 follow channel names.

README.tpl

@@ -2,6 +2,8 @@
 
 ![Workflow](https://github.com/infobip-community/infobip-api-rust-sdk/actions/workflows/rust.yml/badge.svg)
 [![Licence](https://img.shields.io/github/license/infobip-community/infobip-api-rust-sdk)](LICENSE-MIT)
+![Crates.io](https://img.shields.io/crates/v/infobip_sdk)
+![Crate downlads](https://img.shields.io/crates/d/rust_sdk)
 
 {{readme}}
 

src/api/mod.rs

@@ -14,6 +14,9 @@ use crate::configuration::{ApiKey, Configuration};
 #[cfg(feature = "sms")]
 pub mod sms;
 
+#[cfg(feature = "whatsapp")]
+pub mod whatsapp;
+
 /// Holds the possible errors that can happen when calling the Infobip API.
 #[derive(Error, Debug)]
 pub enum SdkError {

src/api/sms.rs

@@ -42,7 +42,7 @@ pub struct SmsClient {
 
 impl SmsClient {
     /// Builds and returns a new asynchronous `SmsClient` with specified configuration.
-    pub fn with_configuration(configuration: Configuration) -> SmsClient {
+    pub fn with_configuration(configuration: Configuration) -> Self {
         SmsClient {
             configuration,
             client: reqwest::Client::new(),

src/api/whatsapp.rs

@@ -0,0 +1,75 @@
+use std::collections::HashMap;
+
+use reqwest::{Method, Response};
+use serde::Serialize;
+use validator::Validate;
+
+use crate::api::{build_api_error, send_valid_json_request, SdkError, SdkResponse};
+use crate::configuration::Configuration;
+use crate::model::whatsapp::{SendTextRequestBody, SendTextResponseBody};
+
+pub const PATH_SEND_TEXT: &str = "/whatsapp/1/message/text";
+
+/// Main asynchronous client for the Infobip WhatsApp channel.
+#[derive(Clone, Debug)]
+pub struct WhatsappClient {
+    configuration: Configuration,
+    client: reqwest::Client,
+}
+
+impl WhatsappClient {
+    /// Builds and returns a new asynchronous `WhatsappClient` with specified configuration.
+    pub fn with_configuration(configuration: Configuration) -> Self {
+        WhatsappClient {
+            configuration,
+            client: reqwest::Client::new(),
+        }
+    }
+
+    async fn send_request<T: Validate + Serialize>(
+        &self,
+        request_body: T,
+        parameters: HashMap<String, String>,
+        method: Method,
+        path: &str,
+    ) -> Result<Response, SdkError> {
+        send_valid_json_request(
+            &self.client,
+            &self.configuration,
+            request_body,
+            parameters,
+            method,
+            path,
+        )
+        .await
+    }
+
+    /// Send a text message to a single recipient. Text messages can only be successfully delivered
+    /// if the recipient has contacted the business within the last 24 hours, otherwise template
+    /// message should be used.
+    pub async fn send_text(
+        &self,
+        request_body: SendTextRequestBody,
+    ) -> Result<SdkResponse<SendTextResponseBody>, SdkError> {
+        let response = self
+            .send_request(
+                request_body,
+                HashMap::new(),
+                reqwest::Method::POST,
+                PATH_SEND_TEXT,
+            )
+            .await?;
+
+        let status = response.status();
+        let text = response.text().await?;
+
+        if status.is_success() {
+            Ok(SdkResponse {
+                body: serde_json::from_str(&text)?,
+                status,
+            })
+        } else {
+            Err(build_api_error(status, &text))
+        }
+    }
+}

src/lib.rs

@@ -6,7 +6,8 @@
 //! handling. The module structure is divided by communication channel.
 //!
 //! ## Supported Channels
-//! - [SMS](https://www.infobip.com/docs/api/channels/sms) (in progress)
+//! - [SMS](https://www.infobip.com/docs/api/channels/sms)
+//! - [WhatsApp](https://www.infobip.com/docs/api/channels/whatsapp) (partially, in progress)
 //!
 //! More Channels to be added in the near future!
 //!
@@ -20,7 +21,7 @@
 //! To use the library, add the dependency to your projects `Cargo.toml`
 //! ```toml
 //! [dependencies]
-//! infobip-sdk = "0.1"
+//! infobip_sdk = "0.1"
 //! ```
 //!
 //! ## Usage
@@ -128,7 +129,7 @@
 //! You can speed up compile-times a bit by turning only the needed channels as library features.
 //! For example, to only build SMS, add the dependency like this:
 //! ```toml
-//! infobip-sdk = { version = "0.1", features = ["sms"] }
+//! infobip_sdk = { version = "0.1", features = ["sms"] }
 //! ```
 //! You can see the complete list of features in the Cargo.toml of the project. Feature names
 //! follow channel names.

src/model/mod.rs

@@ -5,5 +5,8 @@
 #[cfg(feature = "sms")]
 pub mod sms;
 
+#[cfg(feature = "whatsapp")]
+pub mod whatsapp;
+
 #[cfg(test)]
 mod tests;

src/model/whatsapp.rs

@@ -0,0 +1,119 @@
+//! Models for calling WhatsApp endpoints.
+
+use serde_derive::{Deserialize, Serialize};
+use validator::Validate;
+
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Validate)]
+#[serde(rename_all = "camelCase")]
+pub struct TextMessageContent {
+    /// Content of the message being sent.
+    #[validate(length(min = 1, max = 4096))]
+    pub text: String,
+
+    /// Allows for URL preview from within the message. If set to true, the message content must
+    /// contain a URL starting with https:// or http://. Defaults to false.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub preview_url: Option<bool>,
+}
+
+impl TextMessageContent {
+    pub fn new(text: String) -> Self {
+        TextMessageContent {
+            text,
+            preview_url: None,
+        }
+    }
+}
+
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Validate)]
+#[serde(rename_all = "camelCase")]
+pub struct SendTextRequestBody {
+    /// Registered WhatsApp sender number. Must be in international format and comply with
+    /// WhatsApp's requirements.
+    #[validate(length(min = 1, max = 24))]
+    pub from: String,
+
+    /// Message recipient number. Must be in international format.
+    #[validate(length(min = 1, max = 24))]
+    pub to: String,
+
+    /// The ID that uniquely identifies the message sent.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[validate(length(min = 0, max = 50))]
+    pub message_id: Option<String>,
+
+    /// The content object to build a message that will be sent.
+    #[validate]
+    pub content: TextMessageContent,
+
+    /// Custom client data that will be included in a Delivery Report.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[validate(length(min = 0, max = 4000))]
+    pub callback_data: Option<String>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[validate(url)]
+    pub notify_url: Option<String>,
+}
+
+impl SendTextRequestBody {
+    pub fn new(from: String, to: String, content: TextMessageContent) -> Self {
+        SendTextRequestBody {
+            from,
+            to,
+            message_id: None,
+            content,
+            callback_data: None,
+            notify_url: None,
+        }
+    }
+}
+
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Status {
+    /// Status group ID.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub group_id: Option<i32>,
+
+    /// Status group name.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub group_name: Option<String>,
+
+    /// Action that should be taken to eliminate the error.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub action: Option<String>,
+
+    /// Status ID.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub id: Option<i32>,
+
+    /// Status name.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub name: Option<String>,
+
+    /// Human-readable description of the status.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
+}
+
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SendTextResponseBody {
+    /// The destination address of the message.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub to: Option<String>,
+
+    /// Number of messages required to deliver.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub message_count: Option<i32>,
+
+    /// The ID that uniquely identifies the message sent. If not passed, it will be automatically
+    /// generated and returned in a response.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub message_id: Option<String>,
+
+    /// Indicates the status of the message and how to recover from an error should there be any.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub status: Option<Status>,
+}

tests/whatsapp.rs

@@ -0,0 +1,47 @@
+// These tests need to be run manually, due to server state dependencies. The environment variables
+// IB_API_KEY, IB_BASE_URL, IB_TEST_SENDER, and IB_TEST_DESTINATION_NUMBER must be set.
+
+#![cfg(feature = "whatsapp")]
+#![cfg(test)]
+
+use std::env;
+
+use reqwest::StatusCode;
+
+use infobip_sdk::api::whatsapp::WhatsappClient;
+use infobip_sdk::configuration;
+use infobip_sdk::model::whatsapp::*;
+
+const DUMMY_TEXT: &str = "Dummy text for tests. Some special chars: áéíø";
+
+fn get_test_wa_client() -> WhatsappClient {
+    WhatsappClient::with_configuration(
+        configuration::Configuration::from_env_api_key()
+            .expect("failed to build default test SMS client"),
+    )
+}
+
+fn get_test_destination_number() -> String {
+    env::var("IB_TEST_DESTINATION_NUMBER").expect("failed to load test destination number")
+}
+
+fn get_test_sender_number() -> String {
+    env::var("IB_TEST_SENDER").expect("failed to load test sender number")
+}
+
+#[ignore]
+#[tokio::test]
+async fn send_text_whatsapp() {
+    let content = TextMessageContent::new(DUMMY_TEXT.to_string());
+
+    let request_body = SendTextRequestBody::new(
+        get_test_sender_number(),
+        get_test_destination_number(),
+        content,
+    );
+
+    let response = get_test_wa_client().send_text(request_body).await.unwrap();
+
+    assert_eq!(response.status, StatusCode::OK);
+    assert!(!response.body.message_id.unwrap().is_empty());
+}