Merge pull request #104 from c12i/chore/update-mpesa-variables

chore: follow env variable naming as per Daraja API
c12i · Jan 28, 2024 · 8694aef · 8694aef
2 parents 7f4ad7e + a9007e6
commit 8694aef
Show file tree

Hide file tree

Showing 22 changed files with 83 additions and 81 deletions.
diff --git a/.env.example b/.env.example
@@ -1,2 +1,2 @@
-CLIENT_KEY=""
-CLIENT_SECRET=""
+CONSUMER_KEY=""
+CONSUMER_SECRET=""
diff --git a/.github/workflows/general.yml b/.github/workflows/general.yml
@@ -10,8 +10,8 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     env:
-      CLIENT_KEY: ${{ secrets.CLIENT_KEY }}
-      CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
+      CONSUMER_KEY: ${{ secrets.CLIENT_KEY }}
+      CONSUMER_SECRET: ${{ secrets.CLIENT_SECRET }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
@@ -58,8 +58,8 @@ jobs:
     name: Code coverage
     runs-on: ubuntu-latest
     env:
-      CLIENT_KEY: ${{ secrets.CLIENT_KEY }}
-      CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
+      CONSUMER_KEY: ${{ secrets.CLIENT_KEY }}
+      CONSUMER_SECRET: ${{ secrets.CLIENT_SECRET }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -38,8 +38,8 @@ use mpesa::Mpesa;
 
 ### Creating a `Mpesa` client
 
-You will first need to create an instance of the `Mpesa` instance (the client). You are required to provide a **CLIENT_KEY** and
-**CLIENT_SECRET**. [Here](https://developer.safaricom.co.ke/test_credentials) is how you can get these credentials for the Safaricom sandbox
+You will first need to create an instance of the `Mpesa` instance (the client). You are required to provide a **CONSUMER_KEY** and
+**CONSUMER_SECRET**. [Here](https://developer.safaricom.co.ke/test_credentials) is how you can get these credentials for the Safaricom sandbox
 environment. It's worth noting that these credentials are only valid in the sandbox environment. To go live and get production keys
 read the docs [here](https://developer.safaricom.co.ke/docs?javascript#going-live).
 
@@ -53,8 +53,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 
@@ -76,8 +76,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::from_str("sandbox")?, // or
         // Environment::try_from("sandbox")?,
     );
@@ -124,8 +124,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         CustomEnvironment,
     );
 }
@@ -142,8 +142,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/account_balance.md b/docs/client/account_balance.md
@@ -17,8 +17,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/b2b.md b/docs/client/b2b.md
@@ -19,8 +19,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/b2c.md b/docs/client/b2c.md
@@ -15,8 +15,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/bill_manager/bulk_invoice.md b/docs/client/bill_manager/bulk_invoice.md
@@ -15,8 +15,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/bill_manager/cancel_invoice.md b/docs/client/bill_manager/cancel_invoice.md
@@ -15,8 +15,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/bill_manager/onboard.md b/docs/client/bill_manager/onboard.md
@@ -14,8 +14,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/bill_manager/onboard_modify.md b/docs/client/bill_manager/onboard_modify.md
@@ -14,8 +14,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/bill_manager/reconciliation.md b/docs/client/bill_manager/reconciliation.md
@@ -15,8 +15,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/bill_manager/single_invoice.md b/docs/client/bill_manager/single_invoice.md
@@ -15,8 +15,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/c2b_register.md b/docs/client/c2b_register.md
@@ -18,8 +18,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/c2b_simulate.md b/docs/client/c2b_simulate.md
@@ -14,8 +14,8 @@ async fn main() {
  dotenvy::dotenv().ok();
 
  let client = Mpesa::new(
-  dotenvy::var("CLIENT_KEY").unwrap(),
-  dotenvy::var("CLIENT_SECRET").unwrap(),
+  dotenvy::var("CONSUMER_KEY").unwrap(),
+  dotenvy::var("CONSUMER_SECRET").unwrap(),
   Environment::Sandbox,
  );
 

diff --git a/docs/client/dynamic_qr.md b/docs/client/dynamic_qr.md
@@ -17,8 +17,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/express_request.md b/docs/client/express_request.md
@@ -21,8 +21,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>>{
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/transaction_reversal.md b/docs/client/transaction_reversal.md
@@ -17,8 +17,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/docs/client/transaction_status.md b/docs/client/transaction_status.md
@@ -17,8 +17,8 @@ async fn main() {
     dotenvy::dotenv().ok();
 
     let client = Mpesa::new(
-        dotenvy::var("CLIENT_KEY").unwrap(),
-        dotenvy::var("CLIENT_SECRET").unwrap(),
+        dotenvy::var("CONSUMER_KEY").unwrap(),
+        dotenvy::var("CONSUMER_SECRET").unwrap(),
         Environment::Sandbox,
     );
 

diff --git a/src/auth.rs b/src/auth.rs
@@ -11,15 +11,15 @@ const AUTHENTICATION_URL: &str = "/oauth/v1/generate?grant_type=client_credentia
     time = 3600,
     key = "String",
     result = true,
-    convert = r#"{ format!("{}", client.client_key()) }"#
+    convert = r#"{ format!("{}", client.consumer_key()) }"#
 )]
 pub(crate) async fn auth(client: &Mpesa) -> MpesaResult<String> {
     let url = format!("{}{}", client.base_url, AUTHENTICATION_URL);
 
     let response = client
         .http_client
         .get(&url)
-        .basic_auth(client.client_key(), Some(&client.client_secret()))
+        .basic_auth(client.consumer_key(), Some(&client.consumer_secret()))
         .send()
         .await?;
 
@@ -111,7 +111,9 @@ mod tests {
 
         let mut cache = AUTH.lock().await;
 
-        assert!(cache.cache_get(&client.client_key().to_string()).is_some());
+        assert!(cache
+            .cache_get(&client.consumer_key().to_string())
+            .is_some());
         assert_eq!(cache.cache_hits().unwrap(), 1);
         assert_eq!(cache.cache_capacity().unwrap(), 1);
     }