modio 0.13.0

//! User interface
use crate::prelude::*;
use crate::types::files::File;
use crate::types::games::Game;
use crate::types::id::UserId;
use crate::types::mods::Mod;

pub use crate::types::mods::Rating;
pub use crate::types::{Avatar, User};
pub use crate::types::{Event, EventType};

/// Interface for resources owned by the authenticated user or is team member of.
#[derive(Clone)]
pub struct Me {
    modio: Modio,
}

impl Me {
    pub(crate) fn new(modio: Modio) -> Self {
        Self { modio }
    }

    /// Returns the current user if authenticated.
    pub async fn current(self) -> Result<Option<User>> {
        if self.modio.inner.credentials.token.is_some() {
            let user = self.modio.request(Route::UserAuthenticated).send().await?;
            Ok(Some(user))
        } else {
            Ok(None)
        }
    }

    /// Returns a `Query` interface to retrieve all games the authenticated user added or
    /// is team member of. [required: token]
    ///
    /// See [Filters and sorting](filters::games).
    pub fn games(&self, filter: Filter) -> Query<Game> {
        Query::new(self.modio.clone(), Route::UserGames, filter)
    }

    /// Returns a `Query` interface to retrieve all mods the authenticated user added or
    /// is team member of. [required: token]
    ///
    /// See [Filters and sorting](filters::mods).
    pub fn mods(&self, filter: Filter) -> Query<Mod> {
        Query::new(self.modio.clone(), Route::UserMods, filter)
    }

    /// Returns a `Query` interface to retrieve all modfiles the authenticated user uploaded.
    /// [required: token]
    ///
    /// See [Filters and sorting](filters::files).
    pub fn files(&self, filter: Filter) -> Query<File> {
        Query::new(self.modio.clone(), Route::UserFiles, filter)
    }

    /// Returns a `Query` interface to retrieve the events that have been fired specific to the
    /// authenticated user. [required: token]
    ///
    /// See [Filters and sorting](filters::events).
    pub fn events(self, filter: Filter) -> Query<Event> {
        Query::new(self.modio, Route::UserEvents, filter)
    }

    /// Returns a `Query` interface to retrieve the mods the authenticated user is subscribed to.
    /// [required: token]
    ///
    /// See [Filters and sorting](filters::subscriptions).
    pub fn subscriptions(self, filter: Filter) -> Query<Mod> {
        Query::new(self.modio, Route::UserSubscriptions, filter)
    }

    /// Returns a `Query` interface to retrieve the mod ratings submitted by the authenticated user.
    /// [required: token]
    ///
    /// See [Filters and sorting](filters::ratings).
    pub fn ratings(self, filter: Filter) -> Query<Rating> {
        Query::new(self.modio, Route::UserRatings, filter)
    }

    /// Get all users muted by the authenticated user. [required: token]
    pub fn muted_users(self) -> Query<User> {
        Query::new(self.modio, Route::UserMuted, Filter::default())
    }

    /// Mute a user. [required: token]
    ///
    /// This will prevent mod.io from returning mods authored by the muted user.
    pub async fn mute_user(self, user_id: UserId) -> Result<()> {
        self.modio.request(Route::MuteUser { user_id }).send().await
    }

    /// Unmute a previously muted user. [required: token]
    ///
    /// This will re-enable mod.io return mods authored by the muted user again.
    pub async fn unmute_user(self, user_id: UserId) -> Result<()> {
        self.modio
            .request(Route::UnmuteUser { user_id })
            .send()
            .await
    }
}

/// Filters for events, subscriptions and ratings.
#[rustfmt::skip]
pub mod filters {
    #[doc(inline)]
    pub use crate::games::filters as games;
    #[doc(inline)]
    pub use crate::mods::filters as mods;
    #[doc(inline)]
    pub use crate::files::filters as files;

    /// User event filters and sorting.
    ///
    /// # Filters
    /// - `Id`
    /// - `GameId`
    /// - `ModId`
    /// - `UserId`
    /// - `DateAdded`
    /// - `EventType`
    ///
    /// # Sorting
    /// - `Id`
    /// - `DateAdded`
    ///
    /// See the [modio docs](https://docs.mod.io/restapiref/#get-user-events) for more information.
    ///
    /// By default this returns up to `100` items. You can limit the result by using `limit` and
    /// `offset`.
    ///
    /// # Example
    /// ```
    /// use modio::filter::prelude::*;
    /// use modio::mods::EventType;
    /// use modio::user::filters::events::EventType as Filter;
    ///
    /// let filter = Id::gt(1024).and(Filter::eq(EventType::MODFILE_CHANGED));
    /// ```
    pub mod events {
        #[doc(inline)]
        pub use crate::filter::prelude::Id;
        #[doc(inline)]
        pub use crate::filter::prelude::ModId;
        #[doc(inline)]
        pub use crate::filter::prelude::DateAdded;

        #[doc(inline)]
        pub use crate::mods::filters::events::UserId;
        #[doc(inline)]
        pub use crate::mods::filters::events::EventType;

        filter!(GameId, GAME_ID, "game_id", Eq, NotEq, In, Cmp, OrderBy);
    }

    /// Subscriptions filters and sorting.
    ///
    /// # Filters
    /// - `Fulltext`
    /// - `Id`
    /// - `GameId`
    /// - `Status`
    /// - `Visible`
    /// - `SubmittedBy`
    /// - `DateAdded`
    /// - `DateUpdated`
    /// - `DateLive`
    /// - `MaturityOption`
    /// - `Name`
    /// - `NameId`
    /// - `Summary`
    /// - `Description`
    /// - `Homepage`
    /// - `Modfile`
    /// - `MetadataBlob`
    /// - `MetadataKVP`
    /// - `Tags`
    ///
    /// # Sorting
    /// - `Id`
    /// - `Name`
    /// - `Downloads`
    /// - `Popular`
    /// - `Ratings`
    /// - `Subscribers`
    ///
    /// See the [mod.io docs](https://docs.mod.io/restapiref/#get-user-subscriptions) for more information.
    ///
    /// By default this returns up to `100` items. you can limit the result by using `limit` and
    /// `offset`.
    ///
    /// # Example
    /// ```
    /// use modio::filter::prelude::*;
    /// use modio::user::filters::subscriptions::Id;
    ///
    /// let filter = Id::_in(vec![1, 2]).order_by(Id::desc());
    /// ```
    pub mod subscriptions {
        #[doc(inline)]
        pub use crate::filter::prelude::Fulltext;
        #[doc(inline)]
        pub use crate::filter::prelude::Id;
        #[doc(inline)]
        pub use crate::filter::prelude::Name;
        #[doc(inline)]
        pub use crate::filter::prelude::NameId;

        #[doc(inline)]
        pub use crate::mods::filters::GameId;
        #[doc(inline)]
        pub use crate::mods::filters::Status;
        #[doc(inline)]
        pub use crate::mods::filters::Visible;
        #[doc(inline)]
        pub use crate::mods::filters::SubmittedBy;
        #[doc(inline)]
        pub use crate::mods::filters::DateAdded;
        #[doc(inline)]
        pub use crate::mods::filters::DateUpdated;
        #[doc(inline)]
        pub use crate::mods::filters::DateLive;
        #[doc(inline)]
        pub use crate::mods::filters::MaturityOption;
        #[doc(inline)]
        pub use crate::mods::filters::Summary;
        #[doc(inline)]
        pub use crate::mods::filters::Description;
        #[doc(inline)]
        pub use crate::mods::filters::Homepage;
        #[doc(inline)]
        pub use crate::mods::filters::Modfile;
        #[doc(inline)]
        pub use crate::mods::filters::MetadataBlob;
        #[doc(inline)]
        pub use crate::mods::filters::MetadataKVP;
        #[doc(inline)]
        pub use crate::mods::filters::Tags;

        #[doc(inline)]
        pub use crate::mods::filters::Downloads;
        #[doc(inline)]
        pub use crate::mods::filters::Popular;
        #[doc(inline)]
        pub use crate::mods::filters::Ratings;
        #[doc(inline)]
        pub use crate::mods::filters::Subscribers;
    }

    /// Rating filters and sorting.
    ///
    /// # Filters
    /// - `GameId`
    /// - `ModId`
    /// - `Rating`
    /// - `DateAdded`
    ///
    /// # Sorting
    /// - `GameId`
    /// - `ModId`
    /// - `Rating`
    /// - `DateAdded`
    ///
    /// See the [mod.io docs](https://docs.mod.io/restapiref/#get-user-ratings) for more information.
    ///
    /// By default this returns up to `100` items. You can limit the result by using `limit` and
    /// `offset`.
    ///
    /// # Example
    /// ```
    /// use modio::filter::prelude::*;
    /// use modio::user::filters::ratings::GameId;
    /// use modio::user::filters::ratings::DateAdded;
    /// use modio::user::filters::ratings::Rating;
    ///
    /// let filter = GameId::_in(vec![1, 2]).order_by(DateAdded::desc());
    ///
    /// let filter = Rating::positive().order_by(DateAdded::desc());
    /// ```
    pub mod ratings {
        use crate::filter::prelude::*;

        #[doc(inline)]
        pub use crate::filter::prelude::ModId;

        filter!(GameId, GAME_ID, "game_id", Eq, NotEq, In, Cmp, OrderBy);
        filter!(Rating, RATING, "rating", Eq, NotEq, In, Cmp, OrderBy);
        filter!(DateAdded, DATE_ADDED, "date_added", Eq, NotEq, In, Cmp, OrderBy);

        impl Rating {
            pub fn positive() -> Filter {
                Rating::eq(1)
            }

            pub fn negative() -> Filter {
                Rating::eq(-1)
            }
        }
    }
}