mpesa 0.1.0

A wrapper around the M-PESA API in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

<h1 align="center">mpesa-rust</h1>
<p>
   <a href="https://crates.io/crates/mpesa" target="_blank">
     <img alt="Version" src="https://img.shields.io/crates/v/mpesa" />
   </a>
  <a href="https://docs.rs/mpesa/0.1.0/mpesa/" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://travis-ci.com/collinsmuriuki/mpesa-rust" target="_blank">
      <img alt="mpesa travis-ci" src="https://travis-ci.com/collinsmuriuki/mpesa-rust.svg?branch=master" />
   </a>
  <a href="LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
  <a href="https://twitter.com/collinsmuriuki_" target="_blank">
    <img alt="Twitter: collinsmuriuki_" src="https://img.shields.io/twitter/follow/collinsmuriuki_.svg?style=social" />
  </a>
</p>

## About

A Rust wrapper around the [Safaricom API](https://developer.safaricom.co.ke/docs?shell#introduction) for accessing M-Pesa services.
Currently, a work in progress project.

## Notes
> Do not use in production yet, still in development

## RoadMap

- [x] Create Mpesa Client struct
- [x] Implement Auth
- [ ] Error handling
- [x] Generate security credentials
- [x] Implement B2C payment
- [ ] Query transaction status
- [ ] Simulate C2B Payment
- [ ] Query status of Lipa na M-Pesa
- [ ] Initiate Lipa na M-Pesa online w/ STK push
- [ ] Register C2B Confirmation and Validation URLs
- [ ] Integration tests
- [ ] Rewrite in async
- [x] Publish on https://crates.io
- [x] Setup travis-ci

## Install & Usage
In your `Cargo.toml` file:

```md
[dependencies]
mpesa = "0.1.0"
```

In your lib or binary crate:
```rs
extern crate mpesa;

use mpesa::Mpesa;
```

## Examples

Use [`dotenv`](https://docs.rs/dotenv/0.15.0/dotenv/fn.dotenv.html) crate to store your keys as environmental variables instead of hard coding them like done in the example below.

```rs
use mpesa::{Mpesa, Environment};

let client = Mpesa::new(
      String::from("your_client_key"),
      String::from("your_client_secret"),
      Environment::Sandbox,
      String::from("your_initiator_password"),
);
```

## Author

**Collins Muriuki**

* Website: https://muriuki.dev
* Twitter: [@collinsmuriuki\_](https://twitter.com/collinsmuriuki_)
* Github: [@collinsmuriuki](https://github.com/collinsmuriuki)
* LinkedIn: [@collinsmuriuki](https://linkedin.com/in/collinsmuriuki)

## Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/collinsmuriuki/mpesa-rust/issues). You can also take a look at the [contributing guide](CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## License

Copyright © 2020 [Collins Muriuki](https://github.com/collinsmuriuki).<br />
This project is [MIT](LICENSE) licensed.