Fix some Inconsistencies & add more information (#52)

* Inconsistencies:
- sentry - remove `util` module, it's not currently used
- domain - README - addd the `repositories` feature
- README - update the document to include more information for the repository

* domain/sentry - add `deny(rust_2018_idioms)` and fix the errors

* fix `clippy` warnings

Author: elpiel

README.md

@@ -1,19 +1,40 @@
-# Adex Validator Stack in Rust [![Build Status](https://travis-ci.com/AdExNetwork/adex-validator-stack-rust.svg?token=TBKq9g6p9sWDrzNyX4kC&branch=master)](https://travis-ci.com/AdExNetwork/adex-validator-stack-rust)
+# AdEx Validator Stack in Rust [![Build Status](https://travis-ci.com/AdExNetwork/adex-validator-stack-rust.svg?token=TBKq9g6p9sWDrzNyX4kC&branch=master)](https://travis-ci.com/AdExNetwork/adex-validator-stack-rust)
 
-Rust implementation of the Validator Stack
+The Rust implementation of the Validator Stack
 
 Reference implementation of the [AdEx validator stack](https://github.com/adexnetwork/adex-protocol#validator-stack-platform).
 
 Components:
 
-* Sentry - TODO
+* Domain crate
+* Sentry - check the list of [opened issues](https://github.com/AdExNetwork/adex-validator-stack-rust/issues?q=is:open is:issue project:AdExNetwork/adex-validator-stack-rust/1)
 * Validator worker - TODO
 
+## Domain
+Contains all the Domain `Aggregates`, `Entities`, `Value Objects`, interfaces (traits) and `Domain Error`.
+The interfaces(traits) include  The `RepositoryFuture` and the `Aggregates`/`Entities` traits for the repositories.
+
+All the structs have defined (de)serialization. The also have incorporated domain rules, e.g.
+`TargetingTag.score` (the `Score` struct) should be with a value between `0` and `100`.
+This means that once we have a `Score` object, we are guaranteed to have a valid object everywhere.
+
+The `Repository` traits are meant for retrieving the underlying object types, this includes implementations with
+Databases (like `Postgres` for `Sentry`), API calls (for the `Validator` to fetch the objects from `Sentry`),
+memory (for testing) and etc.
+
 ## Sentry: API
 
 #### Do not require authentication, can be cached:
 
-GET `/channel/list` - get a list of all channels - TODO
+The API documentation can be found on the [adex-validator](https://github.com/AdExNetwork/adex-validator/blob/master/docs/api.md).
+Currently implemented endpoints:
+
+- POST `/channel` - creates a new channel
+- GET `/channel/list` - get a list of all channels
+
+## Validator worker
+
+TODO
 
 ## Testing setup
 
@@ -37,6 +58,9 @@ We've setup `rust-toolchain` but you can manually override it as well with `rust
 `DATABASE_URL=postgresql://postgres:docker@localhost:5432/sentry cargo run --bin sentry`
 
 #### Environment variables:
+
+- `DATABASE_URL` - The url of the Postgres database used for production.
+
 **NOTE: For development & testing purposes we use `.env` file to define values for those environment variables.**
 
 - `CHANNEL_LIST_LIMIT` - the limit per page for listing channels from the `/channel/list` request.

domain/README.md

@@ -8,6 +8,15 @@ using Postgres, some sort of Memory implementation and etc.
 
 ### Features:
 
+#### Repositories
+
+If the usage of this crate, requires not only (de)serialization, but also retrieving or storing
+the objects in any way (database, API calls, memory and etc.) you would need this feature, as it defines
+the Repository traits that should be implemented, as a common interface, for handling such operations.
+
+The trait `RepositoryFuture` with a generic `RepositoryError` is used as the common return type for
+repository methods.
+
 #### Fixtures
 
 For testing purposes there are set of fixtures found under the `fixtures` module,

domain/src/lib.rs

@@ -1,3 +1,4 @@
+#![deny(rust_2018_idioms)]
 use std::error;
 use std::fmt;
 
@@ -40,13 +41,13 @@ pub enum DomainError {
 }
 
 impl fmt::Display for DomainError {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(f, "Domain error",)
     }
 }
 
 impl error::Error for DomainError {
-    fn cause(&self) -> Option<&error::Error> {
+    fn cause(&self) -> Option<&dyn error::Error> {
         None
     }
 }
@@ -68,5 +69,5 @@ pub mod repository {
         User,
     }
 
-    pub type RepositoryFuture<T> = Pin<Box<Future<Output = Result<T, RepositoryError>> + Send>>;
+    pub type RepositoryFuture<T> = Pin<Box<dyn Future<Output = Result<T, RepositoryError>> + Send>>;
 }

sentry/src/application/resource/channel/channel_create/handler.rs

@@ -10,7 +10,7 @@ pub struct ChannelCreateHandler<'a> {
 }
 
 impl<'a> ChannelCreateHandler<'a> {
-    pub fn new(channel_repository: &'a ChannelRepository) -> Self {
+    pub fn new(channel_repository: &'a dyn ChannelRepository) -> Self {
         Self { channel_repository }
     }
 }

sentry/src/application/resource/channel/channel_list/handler.rs

@@ -11,7 +11,7 @@ pub struct ChannelListHandler<'a> {
 }
 
 impl<'a> ChannelListHandler<'a> {
-    pub fn new(limit_per_page: u32, channel_repository: &'a ChannelRepository) -> Self {
+    pub fn new(limit_per_page: u32, channel_repository: &'a dyn ChannelRepository) -> Self {
         Self {
             limit_per_page,
             channel_repository,

sentry/src/infrastructure/persistence/memory.rs

@@ -14,7 +14,7 @@ impl error::Error for MemoryPersistenceError {}
 impl IOError for MemoryPersistenceError {}
 
 impl fmt::Display for MemoryPersistenceError {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let error_type = match *self {
             MemoryPersistenceError::Reading => "reading",
             MemoryPersistenceError::Writing => "writing",
@@ -29,13 +29,13 @@ impl fmt::Display for MemoryPersistenceError {
 }
 
 impl<T> From<PoisonError<RwLockReadGuard<'_, T>>> for MemoryPersistenceError {
-    fn from(_: PoisonError<RwLockReadGuard<T>>) -> Self {
+    fn from(_: PoisonError<RwLockReadGuard<'_, T>>) -> Self {
         MemoryPersistenceError::Reading
     }
 }
 
 impl<T> From<PoisonError<RwLockWriteGuard<'_, T>>> for MemoryPersistenceError {
-    fn from(_: PoisonError<RwLockWriteGuard<T>>) -> Self {
+    fn from(_: PoisonError<RwLockWriteGuard<'_, T>>) -> Self {
         MemoryPersistenceError::Writing
     }
 }

sentry/src/infrastructure/persistence/postgres.rs

@@ -15,7 +15,7 @@ impl error::Error for PostgresPersistenceError {}
 impl IOError for PostgresPersistenceError {}
 
 impl fmt::Display for PostgresPersistenceError {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         match *self {
             PostgresPersistenceError::UserError(ref error) => {
                 write!(f, "User error occurred: {}", error)

sentry/src/lib.rs

@@ -1,5 +1,4 @@
 #![feature(async_await, await_macro)]
-
+#![deny(rust_2018_idioms)]
 pub mod application;
 pub mod infrastructure;
-pub mod util;