Update links to GitHub.

.envrc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+use flake

.gitignore

@@ -1,6 +1,5 @@
-# Generated by Cargo
+/result
+.direnv/
+coverage/
 debug/
 target/
-
-# Code coverage results
-coverage/

Cargo.toml

@@ -1,9 +1,9 @@
 [package]
 name = "steam-rss"
 description = "Get RSS feeds for Steam games."
-repository = "https://git.bauke.xyz/Bauke/steam-rss"
+repository = "https://github.com/Bauke/steam-rss"
 license = "AGPL-3.0-or-later"
-version = "0.1.0"
+version = "0.2.2"
 authors = ["Bauke <me@bauke.xyz>"]
 edition = "2021"
 
@@ -11,11 +11,21 @@ edition = "2021"
 name = "steam-rss"
 path = "source/main.rs"
 
+[lints.clippy]
+missing_docs_in_private_items = "warn"
+
+[lints.rust]
+missing_docs = "warn"
+unsafe_code = "forbid"
+
 [dependencies]
 color-eyre = "0.6.2"
-indicatif = "0.17.1"
-ureq = "2.5.0"
+opml = "1.1.6"
+regex = "1.10.3"
+serde = "1.0.195"
+serde_json = "1.0.111"
+ureq = "2.9.1"
 
 [dependencies.clap]
 features = ["derive"]
-version = "3.2.22"
+version = "4.4.18"

Makefile.toml

@@ -1,33 +1,21 @@
-[tasks.fmt]
-command = "cargo"
-args = ["fmt", "${@}"]
-
-[tasks.check]
-command = "cargo"
-args = ["check", "${@}"]
-
-[tasks.clippy]
-command = "cargo"
-args = ["clippy", "${@}"]
-
-[tasks.test]
-command = "cargo"
-args = ["test", "${@}"]
-
-[tasks.doc]
-command = "cargo"
-args = ["doc", "${@}"]
-
-[tasks.build]
-command = "cargo"
-args = ["build", "${@}"]
-
+# Do a full check of everything.
 [tasks.complete-check]
-dependencies = ["fmt", "check", "clippy", "test", "doc", "build"]
+dependencies = [
+  "format",
+  "spellcheck",
+  "check",
+  "clippy",
+  "test",
+  "code-coverage",
+  "docs",
+  "build",
+  "audit-flow",
+  "outdated-flow",
+]
 
+# Run cargo-tarpaulin and output the test coverage.
 [tasks.code-coverage]
 workspace = false
-install_crate = "cargo-tarpaulin"
 command = "cargo"
 args = [
   "tarpaulin",
@@ -35,5 +23,10 @@ args = [
   "--out=html",
   "--output-dir=coverage",
   "--skip-clean",
-  "--target-dir=target/tarpaulin"
+  "--target-dir=target/tarpaulin",
 ]
+
+# Do a source code spellcheck.
+[tasks.spellcheck]
+clear = true
+command = "typos"

README.md

@@ -1,10 +1,25 @@
-# Steam RSS
+# Steam ❤ RSS
 
 > **Get RSS feeds for Steam games.**
 
-*AGPL-3.0-or-later*
+## Features
 
-## `--help`
+* Get RSS feeds from a game's AppID or store page.
+* Get RSS feeds for all games from a user profile.
+* Verify potential feeds by checking if they return `text/xml`.
+* Output feeds as an OPML file for easy importing.
+
+## Installation
+
+### Cargo
+
+With a working [Rust and Cargo](https://www.rust-lang.org/learn/get-started) installation, you can install `steam-rss` from [Crates.io](https://crates.io/crates/steam-rss).
+
+```
+cargo install steam-rss
+```
+
+## Usage
 
 ```
 USAGE:
@@ -13,9 +28,21 @@ USAGE:
 OPTIONS:
     -a, --appid <APPID>        A game's AppID, can be used multiple times
     -h, --help                 Print help information
+        --opml                 Output the feeds as OPML
     -t, --timeout <TIMEOUT>    The time in milliseconds to sleep between HTTP requests [default:
                                250]
+        --url <URL>            A game's store URL, can be used multiple times
+        --user <USER>          A person's steamcommunity.com ID or full URL, can be used multiple
+                               times
     -v, --verify               Verify potential feeds by downloading them and checking if they
                                return XML
     -V, --version              Print version information
 ```
+
+## Feedback
+
+Found a problem or want to request a new feature? Email [me@bauke.xyz](mailto:me@bauke.xyz) and I'll see what I can do for you.
+
+## License
+
+Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://github.com/Bauke/steam-rss/blob/main/LICENSE) for more information.

default.nix

@@ -0,0 +1,17 @@
+{ lib, rustPlatform }:
+
+rustPlatform.buildRustPackage rec {
+  pname = "steam-rss";
+  version = "0.2.2";
+  src = ./.;
+  cargoLock.lockFile = ./Cargo.lock;
+
+  meta = with lib; {
+    description = "Get RSS feeds for Steam games";
+    homepage = "https://github.com/Bauke/steam-rss";
+    changelog = "https://github.com/Bauke/steam-rss/releases/tag/${version}";
+    license = with licenses; [ agpl3Plus ];
+    maintainers = with maintainers; [ Bauke ];
+    mainProgram = "steam-rss";
+  };
+}

flake.lock

@@ -0,0 +1,128 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1705309234,
+        "narHash": "sha256-uNRRNRKmJyCRC/8y1RqBkqWBLM034y4qN7EprSdmgyA=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "1ef2e671c3b0c19053962c07dbda38332dcebf26",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "flake-utils_2": {
+      "inputs": {
+        "systems": "systems_2"
+      },
+      "locked": {
+        "lastModified": 1681202837,
+        "narHash": "sha256-H+Rh19JDwRtpVPAWp64F+rlEtxUWBAQW28eAi3SRSzg=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "cfacdce06f30d2b68473a46042957675eebb3401",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1706173671,
+        "narHash": "sha256-lciR7kQUK2FCAYuszyd7zyRRmTaXVeoZsCyK6QFpGdk=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "4fddc9be4eaf195d631333908f2a454b03628ee5",
+        "type": "github"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "type": "indirect"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1681358109,
+        "narHash": "sha256-eKyxW4OohHQx9Urxi7TQlFBTDWII+F+x2hklDOQPB50=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "96ba1c52e54e74c3197f4d43026b3f3d92e83ff9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs",
+        "rust-overlay": "rust-overlay"
+      }
+    },
+    "rust-overlay": {
+      "inputs": {
+        "flake-utils": "flake-utils_2",
+        "nixpkgs": "nixpkgs_2"
+      },
+      "locked": {
+        "lastModified": 1706235145,
+        "narHash": "sha256-3jh5nahTlcsX6QFcMPqxtLn9p9CgT9RSce5GLqjcpi4=",
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "rev": "3a57c4e29cb2beb777b2e6ae7309a680585b8b2f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "type": "github"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "systems_2": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,25 @@
+{
+  inputs = {
+    flake-utils.url = "github:numtide/flake-utils";
+    rust-overlay.url = "github:oxalica/rust-overlay";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      flake-utils,
+      rust-overlay,
+    }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        overlays = [ (import rust-overlay) ];
+        pkgs = import nixpkgs { inherit system overlays; };
+      in
+      {
+        devShells.default = import ./shell.nix { inherit pkgs; };
+        packages.default = pkgs.callPackage ./. { };
+      }
+    );
+}

rustup-toolchain.toml

@@ -0,0 +1,3 @@
+[toolchain]
+channel = "stable"
+components = ["cargo", "clippy", "rustfmt", "rust-src"]

shell.nix

@@ -0,0 +1,18 @@
+{ pkgs ? import <nixpkgs> { } }:
+
+with pkgs;
+
+let
+  rustup-toolchain = rust-bin.fromRustupToolchainFile ./rustup-toolchain.toml;
+in
+mkShell rec {
+  packages = [
+    cargo-audit
+    cargo-edit
+    cargo-make
+    cargo-outdated
+    cargo-tarpaulin
+    rustup-toolchain
+    typos
+  ];
+}

source/main.rs

@@ -1,18 +1,15 @@
 //! # Steam RSS
 //!
 //! > **Get RSS feeds for Steam games.**
-//!
-//! *AGPL-3.0-or-later*
-
-#![forbid(unsafe_code)]
-#![warn(missing_docs, clippy::missing_docs_in_private_items)]
 
 use std::{thread::sleep, time::Duration};
 
 use {
   clap::Parser,
   color_eyre::{install, Result},
-  indicatif::{ProgressBar, ProgressStyle},
+  regex::Regex,
+  serde::Deserialize,
+  serde_json::Value,
 };
 
 /// CLI arguments struct using [`clap`]'s Derive API.
@@ -23,6 +20,10 @@ pub struct Args {
   #[clap(short, long)]
   pub appid: Vec<usize>,
 
+  /// Output the feeds as OPML.
+  #[clap(long)]
+  pub opml: bool,
+
   /// The time in milliseconds to sleep between HTTP requests.
   #[clap(short, long, default_value = "250")]
   pub timeout: u64,
@@ -30,6 +31,51 @@ pub struct Args {
   /// Verify potential feeds by downloading them and checking if they return XML.
   #[clap(short, long)]
   pub verify: bool,
+
+  /// A game's store URL, can be used multiple times.
+  #[clap(long)]
+  pub url: Vec<String>,
+
+  /// A person's steamcommunity.com ID or full URL, can be used multiple times.
+  #[clap(long)]
+  pub user: Vec<String>,
+}
+
+/// A simple feed struct.
+#[derive(Debug)]
+pub struct Feed {
+  /// A potential alternate friendly URL, see [`SteamApp::friendly_url`] for an
+  /// explanation.
+  pub friendly_url: Option<String>,
+
+  /// The text to use for the feed in the OPML output.
+  pub text: Option<String>,
+
+  /// The URL of the feed.
+  pub url: String,
+}
+
+/// A small representation of a Steam game that is parsed from JSON.
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SteamApp {
+  /// The AppID of the game.
+  pub appid: usize,
+
+  /// The name of the game.
+  pub name: String,
+
+  /// A friendly URL name of the game, some feeds will use this instead of their
+  /// AppID for their RSS feed.
+  ///
+  /// For example, [Portal's feed](https://steamcommunity.com/games/Portal/rss)
+  /// uses `Portal`, instead of
+  /// [its AppID 400](https://steamcommunity.com/games/400/rss).
+  ///
+  /// Some games may also have a friendly URL different from their AppID but
+  /// don't use it for their feed. Steam is weird.
+  #[serde(rename = "friendlyURL")]
+  pub friendly_url: Value,
 }
 
 fn main() -> Result<()> {
@@ -39,36 +85,155 @@ fn main() -> Result<()> {
   let timeout = Duration::from_millis(args.timeout);
 
   let ureq_agent = ureq::AgentBuilder::new()
-    .user_agent("Steam Feeds (https://git.bauke.xyz/Bauke/steam-rss)")
+    .user_agent("Steam Feeds (https://github.com/Bauke/steam-rss)")
     .build();
   let mut potential_feeds = vec![];
   let mut feeds_to_output = vec![];
 
+  let store_url_regex =
+    Regex::new(r"(?i)^https?://store.steampowered.com/app/(?P<appid>\d+)")?;
+  let user_json_regex = Regex::new(r"var rgGames = (?P<json>\[.+\]);\s+var")?;
+  let user_id_regex = Regex::new(r"(i?)^\w+$")?;
+  let user_url_regex =
+    Regex::new(r"(?i)https?://steamcommunity.com/id/(?P<userid>\w+)")?;
+
   for appid in args.appid {
-    potential_feeds
-      .push(format!("https://steamcommunity.com/games/{appid}/rss/"));
+    potential_feeds.push(Feed {
+      friendly_url: None,
+      text: Some(format!("Steam AppID {appid}")),
+      url: appid_to_rss_url(appid),
+    });
+  }
+
+  for url in args.url {
+    let appid = store_url_regex
+      .captures(&url)
+      .and_then(|captures| captures.name("appid"))
+      .and_then(|appid_match| appid_match.as_str().parse::<usize>().ok());
+    if let Some(appid) = appid {
+      potential_feeds.push(Feed {
+        friendly_url: None,
+        text: Some(format!("Steam AppID {appid}")),
+        url: appid_to_rss_url(appid),
+      });
+    }
+  }
+
+  for user in args.user {
+    let user_url = if user_id_regex.is_match(&user) {
+      userid_to_games_url(user)
+    } else if let Some(user) = user_url_regex
+      .captures(&user)
+      .and_then(|captures| captures.name("userid"))
+    {
+      userid_to_games_url(user.as_str())
+    } else {
+      continue;
+    };
+
+    let body = ureq_agent.get(&user_url).call()?.into_string()?;
+    sleep(timeout);
+
+    let games_json = user_json_regex
+      .captures(&body)
+      .and_then(|captures| captures.name("json"))
+      .map(|json| json.as_str());
+    if let Some(games_json) = games_json {
+      let games = serde_json::from_str::<Vec<SteamApp>>(games_json)?;
+      for game in games {
+        let friendly_url = if game.friendly_url.is_string() {
+          Some(appid_to_rss_url(game.friendly_url.as_str().unwrap()))
+        } else {
+          None
+        };
+
+        potential_feeds.push(Feed {
+          friendly_url,
+          text: Some(game.name),
+          url: appid_to_rss_url(game.appid),
+        });
+      }
+    } else {
+      eprintln!("Couldn't scan games from: {user_url}");
+      eprintln!(
+        "Make sure \"Game Details\" in Privacy Settings is set to Public."
+      );
+      continue;
+    }
   }
 
   if args.verify {
-    let progress = ProgressBar::new(potential_feeds.len().try_into()?)
-      .with_style(ProgressStyle::with_template("Verifying {pos}/{len} {bar}")?);
+    let verify_feed = |url: &str| -> Result<_> {
+      let response = ureq_agent.get(url).call()?;
+      sleep(timeout);
+      Ok((
+        response.content_type() == "text/xml",
+        response.into_string()?,
+      ))
+    };
 
-    for potential_feed in potential_feeds {
-      let response = ureq_agent.get(&potential_feed).call()?;
-      if response.content_type() == "text/xml" {
-        feeds_to_output.push(potential_feed);
+    for mut potential_feed in potential_feeds {
+      let (mut is_valid_feed, mut body) = verify_feed(&potential_feed.url)?;
+
+      // If the potential URL doesn't return `text/xml`, try the friendly URL
+      // if one exists.
+      if !is_valid_feed && potential_feed.friendly_url.is_some() {
+        let friendly_url = potential_feed.friendly_url.as_deref().unwrap();
+        (is_valid_feed, body) = verify_feed(friendly_url)?;
+        if is_valid_feed {
+          potential_feed.url = friendly_url.to_string();
+        }
       }
 
-      sleep(timeout);
-      progress.inc(1);
+      let verified_feed = if is_valid_feed {
+        let title_start = body.find("<title>").unwrap() + 7;
+        let title_end = body.find("</title>").unwrap();
+        Feed {
+          text: Some(body[title_start..title_end].to_string()),
+          ..potential_feed
+        }
+      } else {
+        continue;
+      };
+
+      feeds_to_output.push(verified_feed);
     }
   } else {
-    feeds_to_output = potential_feeds;
+    feeds_to_output.append(&mut potential_feeds);
+  }
+
+  let mut opml_document = opml::OPML {
+    head: None,
+    ..Default::default()
+  };
+
+  if feeds_to_output.is_empty() {
+    eprintln!("No feeds found.");
+    return Ok(());
   }
 
   for feed in feeds_to_output {
-    println!("{feed}");
+    if args.opml {
+      opml_document
+        .add_feed(&feed.text.unwrap_or_else(|| feed.url.clone()), &feed.url);
+    } else {
+      println!("{}", feed.url);
+    }
+  }
+
+  if args.opml {
+    println!("{}", opml_document.to_string()?);
   }
 
   Ok(())
 }
+
+/// Creates a Steam RSS URL from a given AppID.
+fn appid_to_rss_url<D: std::fmt::Display>(appid: D) -> String {
+  format!("https://steamcommunity.com/games/{appid}/rss/")
+}
+
+/// Creates a user's Steam Games URL from a given User ID.
+fn userid_to_games_url<D: std::fmt::Display>(userid: D) -> String {
+  format!("https://steamcommunity.com/id/{userid}/games/?tab=all")
+}