0.1.3-beta

Author: elasticrash

CARGO.md

@@ -0,0 +1,31 @@
+# Rabbit-Borough
+
+## A rabbit MQ abstraction build upon [Lapin](https://crates.io/crates/lapin/1.0.2)
+
+## Example
+
+``` Rust
+fn main() {
+    let config: JSONConfiguration = configuration::reader::read("./config.json").unwrap();
+    println!("[{}] - Configuration read", line!(),);
+
+    LocalPool::new().run_until(async {
+        consume(&config, &handler).await;
+    })
+}
+
+fn handler(_delivery: &Delivery) -> HandleMessageResult {
+    // In order to read the message you need to convert the _delivery.data from a u8 vec to a utf8 string :
+    // std::str::from_utf8(&_delivery.data))
+    return HandleMessageResult::Ack;
+}
+```
+
+## Idea
+
+The whole idea is basically to be able to create a consumer project with minimal effort, by bypassing templating, configuration and complicated resiliency logic. 
+
+But most of the modules are public in this abstraction, so as to left some breathing space for custom composing. 
+
+## Thoughts
+Given that I use rabbitMq daily in nearly every application, this mini library is something that I might benefit in the near future. Luckily someone could find similar benefit as well.

CHANGELOG.md

@@ -1,22 +1,32 @@
+### 0.1.3-beta
 
-### 0.1.2
+#### Breaking changes
+
+* Renamed handler_message_result to handle_message_result as it was an annoying typo
+
+#### Bug fixes and general improvements
+
+* Added better descriptions in documentation
+* Went through some manual e2e resiliency testing.
+
+### 0.1.2-alpha
 
 * Added unit tests
 * Converted the project structure to a lib
 * If the configuration file cannot be read, use the default values
 * Removing some logs and replacing them with proper error handling and error propagation
 * Added Connection resiliency. If the RabbitMq dies, it will start retrying to connect until it exhausts all retries
 
-### 0.1.1
+### 0.1.1-alpha
 
 * added default on JSONConfiguration
 * added DeclareProperties, so as to choose which action should be performed during setup (default to true)
 * removed ConsumerConfiguration, as it was considered duplication
 * abstracted consumer
 
-### 0.1.0
+### 0.1.0-alpha
 
 * updated to Lapin v1.0.0
 * added default implementation for JSONConfiguration properties
 * connection retry config
-* added ConsumerConfiguration, ConnectionProperties and BindingProperties
+* added ConsumerConfiguration, ConnectionProperties and BindingProperties

Cargo.lock

@@ -1,18 +1,17 @@
 [package]
 name = "rabbit_borough"
-version = "0.1.2-alpha"
+version = "0.1.3-beta"
 authors = ["stefanos.kouroupis <manekato@gmail.com>"]
 edition = "2018"
 description = "Create a RabbitMQ consumer project with minimal effort, by bypassing templating, configuration and complicated resiliency logic"
-readme = "README.md"
+readme = "CARGO.md"
 repository = "https://github.com/elasticrash/rabbit-borough"
 license = "MIT"
-license-file = "LICENSE"
 keywords = ["rabbitmq", "amqp"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
-lapin = "1.0.0"
+lapin = "1.0.2"
 futures-executor = "0.3.5"
 futures = "0.3.5"
 serde = "1.0.110"

Cargo.toml

@@ -5,7 +5,7 @@ use lapin::message::Delivery;
 use rabbit_borough::configuration;
 use rabbit_borough::configuration::config_model::JSONConfiguration;
 use rabbit_borough::consumer::consumer::consume;
-use rabbit_borough::consumer::handler_message_result::HandleMessageResult;
+use rabbit_borough::consumer::handle_message_result::HandleMessageResult;
 
 fn main() {
     let config: JSONConfiguration = configuration::reader::read("./config.json").unwrap();

examples/consumer.rs

@@ -1,5 +1,6 @@
 use serde::Deserialize;
 
+/// Top level configuration class
 #[serde(default)]
 #[derive(Deserialize, Clone, Debug, PartialEq)]
 pub struct JSONConfiguration {
@@ -8,6 +9,7 @@ pub struct JSONConfiguration {
     pub declare: DeclareProperties,
 }
 
+/// All the properties required for creating a connection
 #[serde(default)]
 #[derive(Deserialize, Clone, Debug, PartialEq)]
 pub struct ConnectionProperties {
@@ -21,6 +23,7 @@ pub struct ConnectionProperties {
     pub retry: u64,
 }
 
+/// Configuration for binding an Queue to an Exchange
 #[serde(default)]
 #[derive(Deserialize, Clone, Debug, PartialEq)]
 pub struct BindingProperties {
@@ -29,6 +32,7 @@ pub struct BindingProperties {
     pub routing_key: String,
 }
 
+/// Configuration on whether some setup should be deemed unnecessary
 #[serde(default)]
 #[derive(Deserialize, Clone, Debug, PartialEq)]
 pub struct DeclareProperties {

src/configuration/config_model.rs

@@ -1,2 +1,4 @@
+/// Module for reading or getting default configuration
 pub mod reader;
+/// This module only contains the structs needed for the configuration
 pub mod config_model;

src/configuration/mod.rs

@@ -5,7 +5,7 @@ use std::io::Read;
 use std::path::Path;
 
 /**
- * ## Read configuration from config.json
+ * ## Reads configuration from provided file
  * If file does not exist or we cannot read the content of the file,
  * we use the default values
  */

src/configuration/reader.rs

@@ -8,7 +8,6 @@ pub struct GetConnectionError {
     pub last_reason: lapin::Error,
 }
 
-#[allow(dead_code)]
 #[derive(Debug)]
 pub enum ConnectionState {
     MaximumConnectionRetriesReached,

src/consumer/connection_manager.rs

@@ -1,6 +1,6 @@
 use crate::configuration::config_model::JSONConfiguration;
-use crate::consumer::handler_message_result::action_result;
-use crate::consumer::handler_message_result::HandleMessageResult;
+use crate::consumer::handle_message_result::action_result;
+use crate::consumer::handle_message_result::HandleMessageResult;
 use crate::consumer::setup::setup_consumer;
 use lapin::message::Delivery;
 use lapin::options::BasicConsumeOptions;