ground work for rewrite

Author: morukele

.env.example

@@ -1,4 +1,4 @@
 PAYSTACK_API_KEY=your_paystack_key_here
-BANK_ACCOUNT=0000000000
+BANK_ACCOUNT=0000000001
 BANK_CODE=058
 BANK_NAME='Guaranty Trust Bank'

.idea/paystack-rs.iml

@@ -0,0 +1,20 @@
+## 0.2.3 (15/07/2024
+
+- A complete rewrite of the paystack-rs crate. The rewrite is necessary because in the current state, the crate is not
+extendable and will be difficult to add support for sync and async code. The rewrite is to achieve the following objectives:
+  - Make the code less complex (relatively speaking)
+  - Improve the maintainability of the crate
+  - Support both async and sync code
+  - Use high level data construct when creating request body
+  - Have extensive Rust type for every possible response from the API
+  - Use advanced rust type and how a better understand of the Rust programming language (personal reason)
+
+- The following changes have been implemented
+  - Change the project file layout to improve separation of concerns. The new layout includes the following
+    - http (to handle all http related functionalities)
+    - models (holds all request and response models from the API)
+    - macros (utility macro to simplify code repetition)
+
+## 0.2.2 (29/11/2023)
+
+- Added support for create customer API route

CHANGELOG.md

@@ -1,7 +1,7 @@
 [package]
 name = "paystack-rs"
 version = "0.2.2"
-description = "A unofficial client library for the Paystack API"
+description = "Paystack API Wrapper"
 authors = ["Oghenemarho Orukele <orukele.dev@gmail.com>"]
 edition = "2021"
 include = [
@@ -24,17 +24,21 @@ readme = "README.md"
 categories = ["api-bindings", "finance"]
 license = "MIT"
 
-[lib]
-name = "paystack"
+[workspace]
+members = [
+	"models",
+	"http",
+	"macros"
+]
 
 
 [dependencies]
 thiserror = "1"
 serde_json = "1"
-reqwest = { version = "0.11", features = ["json"] }
+reqwest = { version = "0.12.5", features = ["json"] }
 tokio = { version = "1", features = ["full"] }
 serde = {version ="1", features = ["derive"]}
-derive_builder = "0.12.0"
+derive_builder = "0.20.0"
 
 [dev-dependencies]
 fake = "2"

Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "http"
+version = "0.2.2"
+description = "HTTP layer for paystack-rs"
+authors = ["Oghenemarho Orukele <orukele.dev@gmail.com>"]
+edition = "2021"
+homepage = "https://github.com/morukele/paystack-rs"
+repository = "https://github.com/morukele/paystack-rs"
+documentation = "https://docs.rs/paystack-rs"
+keywords = [
+    "payment",
+    "paystack",
+    "api",
+    "finance",
+]
+readme = "../README.md"
+categories = ["api-bindings", "finance"]
+license = "MIT"

http/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "macros"
+version = "0.2.2"
+description = "Macros for paystack-rs"
+authors = ["Oghenemarho Orukele <orukele.dev@gmail.com>"]
+edition = "2021"
+homepage = "https://github.com/morukele/paystack-rs"
+repository = "https://github.com/morukele/paystack-rs"
+documentation = "https://docs.rs/paystack-rs"
+keywords = [
+    "payment",
+    "paystack",
+    "api",
+    "finance",
+]
+readme = "../README.md"
+categories = ["api-bindings", "finance"]
+license = "MIT"

http/src/lib.rs

@@ -0,0 +1,18 @@
+[package]
+name = "models"
+version = "0.2.2"
+description = "Models for paystack-rs"
+authors = ["Oghenemarho Orukele <orukele.dev@gmail.com>"]
+edition = "2021"
+homepage = "https://github.com/morukele/paystack-rs"
+repository = "https://github.com/morukele/paystack-rs"
+documentation = "https://docs.rs/paystack-rs"
+keywords = [
+    "payment",
+    "paystack",
+    "api",
+    "finance",
+]
+readme = "../README.md"
+categories = ["api-bindings", "finance"]
+license = "MIT"

macros/Cargo.toml

@@ -0,0 +1,16 @@
+crates=(
+    macros
+    models
+    http
+)
+
+for crate in "${crates[@]}"; do
+    echo "Publishing ${crate}"
+    (
+      cd "$crate"
+      cargo publish --no-verify
+    )
+    sleep 20
+done
+
+cargo publish

macros/src/lib.rs

@@ -1,6 +1,6 @@
 use reqwest::StatusCode;
 
-use crate::{post_request, CreateCustomerBody, CreateCustomerResponse, Error, PaystackResult};
+use crate::{post_request, CreateCustomerBody, CreateCustomerResponse, Error, PaystackResult, ListCustomerResponse};
 
 /// A struct to hold all the functions of the customer API route
 #[derive(Debug, Clone)]
@@ -18,6 +18,8 @@ impl<'a> CustomerEndpoints<'a> {
     }
 
     /// Create a customer on your integration
+    /// 
+    /// It takes a CreateCustomerBody as its parameter
     pub async fn create_customer(
         self,
         body: CreateCustomerBody,
@@ -38,4 +40,9 @@ impl<'a> CustomerEndpoints<'a> {
             Err(err) => Err(Error::FailedRequest(err.to_string())),
         }
     }
+
+    /// List the customers in the integration
+    pub async fn list_customers() -> PaystackResult<ListCustomerResponse> {
+
+    }
 }

models/Cargo.toml

@@ -27,7 +27,7 @@ impl<'a> TransactionEndpoints<'a> {
 
     /// Initialize a transaction from your backend.
     ///
-    /// It takes a Transaction type as its parameter
+    /// It takes an InitializeTransactionBody type as its parameter
     pub async fn initialize_transaction(
         &self,
         transaction_body: InitializeTransactionBody,
@@ -77,7 +77,7 @@ impl<'a> TransactionEndpoints<'a> {
     /// List transactions carried out on your integration.
     ///
     /// The method takes the following parameters:
-    ///     - perPage (Optional): Number of transactions to return. If None is passed as the parameter, the last 10 transactions are returned.
+    ///     - numberOfTransactions (Optional): Number of transactions to return. If None is passed as the parameter, the last 10 transactions are returned.
     ///     - status (Optional): Filter transactions by status, defaults to Success if no status is passed.
     ///
     pub async fn list_transactions(
@@ -108,7 +108,7 @@ impl<'a> TransactionEndpoints<'a> {
 
     /// Get details of a transaction carried out on your integration.
     ///
-    /// This methods take the Id of the desired transaction as a parameter
+    /// This method take the ID of the desired transaction as a parameter
     pub async fn fetch_transactions(
         &self,
         transaction_id: u32,
@@ -132,7 +132,7 @@ impl<'a> TransactionEndpoints<'a> {
 
     /// All authorizations marked as reusable can be charged with this endpoint whenever you need to receive payments.
     ///
-    /// This function takes a Charge Struct as parameter
+    /// This function takes a ChargeBody Struct as parameter
     pub async fn charge_authorization(
         &self,
         charge: ChargeBody,
@@ -261,7 +261,7 @@ impl<'a> TransactionEndpoints<'a> {
 
     /// Retrieve part of a payment from a customer.
     ///
-    /// It takes a PartialDebitTransaction type as a parameter.
+    /// It takes a PartialDebitTransactionBody type as a parameter.
     ///
     /// NB: it must be created with the PartialDebitTransaction Builder.
     pub async fn partial_debit(

models/src/lib.rs

@@ -83,3 +83,8 @@ pub struct CreateCustomerResponseData {
     #[serde(rename = "updatedAt")]
     pub updated_at: Option<String>,
 }
+
+/// This struct represents the response from the list customer route.
+pub struct ListCustomerResponse {
+
+}