chore: improve examples

README.md

@@ -73,15 +73,15 @@ apalis-redis = { version = "0.6" }
 
 ```rust
 use apalis::prelude::*;
-use apalis_redis::{RedisStorage, Config};
+use apalis_redis::RedisStorage;
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Deserialize, Serialize)]
 struct Email {
     to: String,
 }
 
-/// A function that will be converted into a service.
+/// A function called for every job
 async fn send_email(job: Email, data: Data<usize>) -> Result<(), Error> {
   /// execute job
   Ok(())
@@ -94,33 +94,25 @@ async fn main() -> {
     let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
     let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let storage = RedisStorage::new(conn);
-    Monitor::new()
-        .register({
-            WorkerBuilder::new(format!("email-worker"))
-                .concurrency(2)
-                .data(0usize)
-                .backend(storage)
-                .build_fn(send_email)
-        })
-        .run()
-        .await
+    WorkerBuilder::new("email-worker")
+      .concurrency(2)
+      .data(0usize)
+      .backend(storage)
+      .build_fn(send_email)
+      .run()
+      .await;
 }
-
 ```
-
 Then
-
 ```rust
 //This can be in another part of the program or another application eg a http server
-async fn produce_route_jobs(storage: &RedisStorage<Email>) -> Result<()> {
-    let mut storage = storage.clone();
+async fn produce_route_jobs(storage: &mut RedisStorage<Email>) -> Result<()> {
     storage
         .push(Email {
             to: "test@example.com".to_string(),
         })
         .await?;
 }
-
 ```
 
 ## Feature flags

examples/actix-web/src/main.rs

@@ -26,7 +26,8 @@ async fn main() -> Result<()> {
     std::env::set_var("RUST_LOG", "debug");
     env_logger::init();
 
-    let conn = apalis_redis::connect("redis://127.0.0.1/").await?;
+    let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+    let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let storage = RedisStorage::new(conn);
     let data = web::Data::new(storage.clone());
     let http = async {

examples/axum/src/main.rs

@@ -56,7 +56,8 @@ async fn main() -> Result<()> {
         ))
         .with(tracing_subscriber::fmt::layer())
         .init();
-    let conn = apalis_redis::connect("redis://127.0.0.1/").await?;
+    let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+    let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let storage = RedisStorage::new(conn);
     // build our application with some routes
     let app = Router::new()

examples/prometheus/src/main.rs

@@ -30,7 +30,8 @@ async fn main() -> Result<()> {
         ))
         .with(tracing_subscriber::fmt::layer())
         .init();
-    let conn = apalis_redis::connect("redis://127.0.0.1/").await?;
+    let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+    let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let storage = RedisStorage::new(conn);
     // build our application with some routes
     let recorder_handle = setup_metrics_recorder();

examples/redis-with-msg-pack/src/main.rs

@@ -32,7 +32,8 @@ async fn main() -> Result<()> {
 
     tracing_subscriber::fmt::init();
 
-    let conn = apalis_redis::connect("redis://127.0.0.1/").await?;
+    let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+    let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let config = apalis_redis::Config::default()
         .set_namespace("apalis_redis-with-msg-pack")
         .set_max_retries(5);

examples/redis/src/main.rs

@@ -27,7 +27,8 @@ async fn main() -> Result<()> {
 
     tracing_subscriber::fmt::init();
 
-    let conn = apalis_redis::connect("redis://127.0.0.1/").await?;
+    let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+    let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let storage = RedisStorage::new(conn);
     // This can be in another part of the program
     produce_jobs(storage.clone()).await?;

examples/rest-api/src/main.rs

@@ -77,7 +77,8 @@ async fn main() -> Result<()> {
     std::env::set_var("RUST_LOG", "debug");
     env_logger::init();
 
-    let conn = apalis_redis::connect("redis://127.0.0.1/").await?;
+    let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+    let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
     let storage = RedisStorage::new(conn);
     let data = web::Data::new(storage.clone());
     let http = async {

packages/apalis-cron/README.md

@@ -6,44 +6,32 @@ Since apalis-cron is build on top of apalis which supports tower middleware, you
 ## Example
 
 ```rust
-use apalis::layers::retry::RetryLayer;
-use apalis::layers::retry::RetryPolicy;
-use tower::ServiceBuilder;
-use apalis_cron::Schedule;
+use apalis::{prelude::*, layers::retry::RetryPolicy};
 use std::str::FromStr;
-use apalis::prelude::*;
-use apalis_cron::CronStream;
+use apalis_cron::{CronStream, Schedule};
 use chrono::{DateTime, Utc};
 
-#[derive(Clone)]
-struct FakeService;
-impl FakeService {
-    fn execute(&self, item: Reminder){}
-}
-
 #[derive(Default, Debug, Clone)]
 struct Reminder(DateTime<Utc>);
 impl From<DateTime<Utc>> for Reminder {
    fn from(t: DateTime<Utc>) -> Self {
        Reminder(t)
    }
 }
-async fn send_reminder(job: Reminder, svc: Data<FakeService>) {
-    svc.execute(job);
+async fn handle_tick(job: Reminder, data: Data<usize>) {
+    // Do something with the current tick
 }
 
 #[tokio::main]
 async fn main() {
     let schedule = Schedule::from_str("@daily").unwrap();
+
     let worker = WorkerBuilder::new("morning-cereal")
         .retry(RetryPolicy::retries(5))
-        .data(FakeService)
-        .stream(CronStream::new(schedule).into_stream())
-        .build_fn(send_reminder);
-    Monitor::new()
-        .register(worker)
-        .run()
-        .await
-        .unwrap();
+        .data(42usize)
+        .backend(CronStream::new(schedule))
+        .build_fn(handle_tick);
+
+    worker.run().await;
 }
 ```

packages/apalis-cron/src/lib.rs

@@ -15,47 +15,38 @@
 //! ## Example
 //!
 //! ```rust,no_run
-//! # use apalis::layers::retry::RetryLayer;
-//! # use apalis::layers::retry::RetryPolicy;
-//! use tower::ServiceBuilder;
-//! use apalis_cron::Schedule;
+//! use apalis::{prelude::*, layers::retry::RetryPolicy};
 //! use std::str::FromStr;
-//! # use apalis::prelude::*;
-//! use apalis_cron::CronStream;
+//! use apalis_cron::{CronStream, Schedule};
 //! use chrono::{DateTime, Utc};
-//!
-//! #[derive(Clone)]
-//! struct FakeService;
-//! impl FakeService {
-//!     fn execute(&self, item: Reminder){}
-//! }
-//!
+//! 
 //! #[derive(Default, Debug, Clone)]
 //! struct Reminder(DateTime<Utc>);
-//! impl From<DateTime<Utc>> for Reminder {
-//!    fn from(t: DateTime<Utc>) -> Self {
-//!        Reminder(t)
-//!    }
+//! 
+//! # impl From<DateTime<Utc>> for Reminder {
+//! #    fn from(t: DateTime<Utc>) -> Self {
+//! #        Reminder(t)
+//! #    }
+//! # }
+//! 
+//! async fn handle_tick(job: Reminder, data: Data<usize>) {
+//!     // Do something with the current tick
 //! }
-//! async fn send_reminder(job: Reminder, svc: Data<FakeService>) {
-//!     svc.execute(job);
-//! }
-//!
+//! 
 //! #[tokio::main]
 //! async fn main() {
 //!     let schedule = Schedule::from_str("@daily").unwrap();
+//! 
 //!     let worker = WorkerBuilder::new("morning-cereal")
 //!         .retry(RetryPolicy::retries(5))
-//!         .data(FakeService)
+//!         .data(42usize)
 //!         .backend(CronStream::new(schedule))
-//!         .build_fn(send_reminder);
-//!     Monitor::new()
-//!         .register(worker)
-//!         .run()
-//!         .await
-//!         .unwrap();
+//!         .build_fn(handle_tick);
+//! 
+//!     worker.run().await;
 //! }
 //! ```
+//! ```
 
 use apalis_core::backend::Backend;
 use apalis_core::error::BoxDynError;

packages/apalis-redis/src/lib.rs

@@ -9,21 +9,27 @@
 //! ```rust,no_run
 //! use apalis::prelude::*;
 //! use apalis_redis::{RedisStorage, Config};
-//! use email_service::send_email;
+//! use serde::{Deserialize, Serialize};
+//! 
+//! #[derive(Debug, Deserialize, Serialize)]
+//! struct Email {
+//!     to: String,
+//! }
+//! 
+//! async fn send_email(job: Email) -> Result<(), Error> {
+//!     Ok(())
+//! }
 //!
 //! #[tokio::main]
 //! async fn main() {
-//!     let conn = apalis_redis::connect("redis://127.0.0.1/").await.unwrap();
+//!     let redis_url = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
+//!     let conn = apalis_redis::connect(redis_url).await.expect("Could not connect");
 //!     let storage = RedisStorage::new(conn);
-//!     Monitor::new()
-//!        .register(
-//!            WorkerBuilder::new("tasty-pear")
-//!                .backend(storage.clone())
-//!                .build_fn(send_email),
-//!        )
-//!        .run()
-//!        .await
-//!        .unwrap();
+//!     let worker = WorkerBuilder::new("tasty-pear")
+//!         .backend(storage.clone())
+//!         .build_fn(send_email);
+//! 
+//!     worker.run().await;
 //! }
 //! ```