Bump version (v0.17.1)

fix: remove redundant param in md url

.env.example

@@ -0,0 +1,7 @@
+HOC_REPODIR='./repos'
+HOC_CACHEDIR='./cache'
+HOC_PORT=8080
+HOC_HOST='0.0.0.0'
+HOC_WORKERS=4
+
+HOC_BASE_URL='http://0.0.0.0:8080'

.gitignore

@@ -4,3 +4,5 @@ repos
 cache
 hoc.log
 result
+hoc.toml
+.env

Cargo.toml

@@ -1,33 +1,34 @@
 [package]
 name = "hoc"
-version = "0.14.5"
+version = "0.17.1"
 authors = ["Valentin Brandl <vbrandl@riseup.net>"]
 edition = "2018"
 build = "build.rs"
 
 [dependencies]
 actix-rt = "1.1.1"
-actix-web = "3.2.0"
+actix-web = "3.3.2"
 badge = "0.3.0"
-bytes = "0.6.0"
-futures = "0.3.8"
-git2 = "0.13.12"
+bytes = "1.0.1"
+config = { version = "0.10.1", features = ["toml"] }
+dotenv = "0.15.0"
+futures = "0.3.13"
+git2 = "0.13.17"
 lazy_static = "1.4.0"
 number_prefix = "0.4.0"
 openssl-probe = "0.1.2"
-reqwest = "0.10.9"
-serde = "1.0.117"
-serde_derive = "1.0.103"
-serde_json = "1.0.59"
-structopt = "0.3.20"
-tracing = "0.1.21"
-tracing-subscriber = "0.2.15"
+reqwest = "0.10.10"
+serde = "1.0.123"
+serde_derive = "1.0.123"
+serde_json = "1.0.63"
+tracing = "0.1.25"
 tracing-actix-web = "0.2.1"
-tracing-futures = "0.2.4"
+tracing-futures = "0.2.5"
+tracing-subscriber = "0.2.16"
 
 [build-dependencies]
 ructe = "0.13.0"
-vergen = "3.1.0"
+vergen = { version = "4.1.0", default-features = false, features = ["git"] }
 
 [dev-dependencies]
-tempfile = "3.1.0"
+tempfile = "3.2.0"

README.md

@@ -1,6 +1,6 @@
 # Hits-of-Code
 
-[![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)](https://hitsofcode.com/view/github/vbrandl/hoc)
+[![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)](https://hitsofcode.com/github/vbrandl/hoc/view)
 [![Drone build](https://drone.vbrandl.net/api/badges/vbrandl/hoc/status.svg)](https://drone.vbrandl.net/vbrandl/hoc)
 [![Gitlab build](https://gitlab.com/vbrandl/hoc/badges/master/pipeline.svg)](https://gitlab.com/vbrandl/hoc/pipelines)
 [![dependency status](https://deps.rs/repo/github/vbrandl/hoc/status.svg)](https://deps.rs/repo/github/vbrandl/hoc)
@@ -26,7 +26,7 @@ where `<service>` is one of `gitub`, `gitlab` or `bitbucket`. The HoC data can a
 https://<host>/<service>/<user>/<repo>/json
 ```
 
-There is also an overview page available via `https://<host>/view/<service>/<user>/<repo>`
+There is also an overview page available via `https://<host>/<service>/<user>/<repo>/view`
 
 To delete a repository and the cache from the server, send a `POST` request to
 `https://<host>/<service>/<user>/<repo>/delete`. On the overview page, there is a button to perform this operation. It
@@ -48,21 +48,29 @@ $ docker build .
 
 inside the repository.
 
-I'm currently working on migrating to [nix](https://nixos.org/nix). To get a
-development shell, run `nix-shell`, to build the package run `nix-build --attr
-package` and to build the Docker image, run `nix-build --attr dockerImage`.
+I'm currently working on migrating to [nix](https://nixos.org/nix). To get a development shell, run `nix-shell`, to
+build the package run `nix-build --attr package` and to build the Docker image, run `nix-build --attr dockerImage`.
 
 
 ## Running
 
-Run either the binary produced by cargo, the Docker container you just built (using docker-compose) or pull the image
-from [Docker Hub](https://hub.docker.com/r/vbrandl/hits-of-code)
+Rename [`hoc.toml.example`](./hoc.toml.example) to `hoc.toml` or [`.env.example`](./.env.example) to `.env` and set the
+correct value for `base_url`/`HOC_BASE_URL`. If you don't want to use a configuration or dotenv file, you can pass all
+parameters directly via environment variables. For variable names see [`.env.example`](./.env.example).
+
+To start a local instance of the service just run:
 
 ```
-$ docker run -it --rm vbrandl/hits-of-code --help
+$ HOC_BASE_URL='http://0.0.0.0:8080' ./hoc
 ```
 
-When running the binary directly, you need a git binary in your `PATH`.
+You can also use the Docker image:
+
+```
+$ docker run -p 8080:8080 --env HOC_BASE_URL='http://0.0.0.0:8080' -it --rm vbrandl/hits-of-code
+```
+
+When running the binary directly, you need a `git` binary in your `PATH`.
 
 
 ## License

build.rs

@@ -2,11 +2,11 @@ extern crate ructe;
 extern crate vergen;
 
 use ructe::Ructe;
-use vergen::{generate_cargo_keys, ConstantsFlags};
+use vergen::{gen, ConstantsFlags};
 
 fn main() {
     let flags = ConstantsFlags::SHA_SHORT;
-    generate_cargo_keys(flags).expect("Unable to generate the cargo keys!");
+    gen(flags).expect("Unable to generate the cargo keys!");
     Ructe::from_env()
         .expect("ructe")
         .compile_templates("templates")

docker-compose.yml

@@ -1,4 +1,4 @@
-version: "2"
+version: "3"
 
 services:
   hoc:
@@ -9,3 +9,5 @@ services:
     # ports:
     #   - "127.0.0.1:8080:8080"
     restart: always
+    env_file:
+      - ./.env

hoc.toml.example

@@ -0,0 +1,15 @@
+# every parameter can also be set (or overwritten) by passing an environment
+# variable namend `HOC_<PARAMETERNAME>`, e.g.
+# `HOC_BASE_URL='https://hitsofcode.com' ./hoc`
+
+# these config parameters have default values and must not explicitly be set
+repodir = "./repos"
+cachedir = "./cache"
+port = 8080
+host = "0.0.0.0"
+workers = 4
+
+# these parameters don't have default values and must be set
+
+# this should be the public base URL of the service, e.g. `https://hitsofcode.com`
+base_url = "http://0.0.0.0:8080"

src/config.rs

@@ -1,41 +1,41 @@
+use config::{Config, ConfigError, Environment, File};
 use std::path::PathBuf;
-use structopt::StructOpt;
 
-#[derive(StructOpt, Debug)]
-pub(crate) struct Opt {
-    #[structopt(
-        short = "o",
-        long = "outdir",
-        parse(from_os_str),
-        default_value = "./repos"
-    )]
+#[derive(Debug, Deserialize)]
+pub struct Settings {
     /// Path to store cloned repositories
-    pub(crate) outdir: PathBuf,
-    #[structopt(
-        short = "c",
-        long = "cachedir",
-        parse(from_os_str),
-        default_value = "./cache"
-    )]
+    pub repodir: PathBuf,
     /// Path to store cache
-    pub(crate) cachedir: PathBuf,
-    #[structopt(short = "p", long = "port", default_value = "8080")]
+    pub cachedir: PathBuf,
     /// Port to listen on
-    pub(crate) port: u16,
-    #[structopt(short = "h", long = "host", default_value = "0.0.0.0")]
+    pub port: u16,
     /// Interface to listen on
-    pub(crate) host: String,
-    #[structopt(short = "d", long = "domain", default_value = "hitsofcode.com")]
-    /// Interface to listen on
-    pub(crate) domain: String,
-    #[structopt(short = "w", long = "workers", default_value = "4")]
+    pub host: String,
+    /// Base URL
+    pub base_url: String,
     /// Number of worker threads
-    pub(crate) workers: usize,
+    pub workers: usize,
 }
 
 pub(crate) fn init() {
+    dotenv::dotenv().ok();
     std::env::set_var("RUST_LOG", "actix_web=info,hoc=info");
     openssl_probe::init_ssl_cert_env_vars();
 
     tracing_subscriber::fmt().init();
 }
+
+impl Settings {
+    pub fn new() -> Result<Self, ConfigError> {
+        let mut config = Config::new();
+        config
+            .merge(File::with_name("hoc.toml").required(false))?
+            .merge(Environment::with_prefix("hoc"))?
+            .set_default("repodir", "./repos")?
+            .set_default("cachedir", "./cache")?
+            .set_default("workers", 4)?
+            .set_default("port", 8080)?
+            .set_default("host", "0.0.0.0")?;
+        config.try_into()
+    }
+}

src/main.rs

@@ -215,7 +215,7 @@ where
         Ok(HttpResponse::TemporaryRedirect()
             .header(
                 LOCATION,
-                format!("/view/{}/{}/{}", T::url_path(), data.0, data.1),
+                format!("/{}/{}/{}/view", T::url_path(), data.0, data.1),
             )
             .finish())
     };
@@ -371,7 +371,7 @@ async fn overview<T: Service>(
             let repo_info = RepoInfo {
                 commit_url: &T::commit_url(&repo, &head),
                 commits,
-                domain: &OPT.domain,
+                base_url: &OPT.base_url,
                 head: &head,
                 hoc,
                 hoc_pretty: &hoc_pretty,
@@ -399,7 +399,7 @@ async fn index() -> Result<HttpResponse> {
         &mut buf,
         VERSION_INFO,
         REPO_COUNT.load(Ordering::Relaxed),
-        &OPT.domain,
+        &OPT.base_url,
     )?;
     Ok(HttpResponse::Ok().content_type("text/html").body(buf))
 }
@@ -412,7 +412,7 @@ async fn generate(params: web::Form<GeneratorForm<'_>>) -> Result<HttpResponse>
         &mut buf,
         VERSION_INFO,
         REPO_COUNT.load(Ordering::Relaxed),
-        &OPT.domain,
+        &OPT.base_url,
         params.service.url(),
         params.service.service(),
         &repo,
@@ -442,7 +442,7 @@ fn favicon32() -> HttpResponse {
 async fn start_server() -> std::io::Result<()> {
     let interface = format!("{}:{}", OPT.host, OPT.port);
     let state = Arc::new(State {
-        repos: OPT.outdir.display().to_string(),
+        repos: OPT.repodir.display().to_string(),
         cache: OPT.cachedir.display().to_string(),
     });
     HttpServer::new(move || {
@@ -475,6 +475,9 @@ async fn start_server() -> std::io::Result<()> {
             .service(web::resource("/view/github/{user}/{repo}").to(overview::<GitHub>))
             .service(web::resource("/view/gitlab/{user}/{repo}").to(overview::<Gitlab>))
             .service(web::resource("/view/bitbucket/{user}/{repo}").to(overview::<Bitbucket>))
+            .service(web::resource("/github/{user}/{repo}/view").to(overview::<GitHub>))
+            .service(web::resource("/gitlab/{user}/{repo}/view").to(overview::<Gitlab>))
+            .service(web::resource("/bitbucket/{user}/{repo}/view").to(overview::<Bitbucket>))
             .default_service(web::resource("").route(web::get().to(async_p404)))
     })
     .workers(OPT.workers)

src/statics.rs

@@ -1,6 +1,5 @@
-use crate::{config::Opt, count::count_repositories};
+use crate::{config::Settings, count::count_repositories};
 use std::sync::atomic::AtomicUsize;
-use structopt::StructOpt;
 
 pub struct VersionInfo<'a> {
     pub commit: &'a str,
@@ -8,7 +7,7 @@ pub struct VersionInfo<'a> {
 }
 
 pub(crate) const VERSION_INFO: VersionInfo = VersionInfo {
-    commit: env!("VERGEN_SHA_SHORT"),
+    commit: env!("VERGEN_GIT_SHA_SHORT"),
     version: env!("CARGO_PKG_VERSION"),
 };
 pub(crate) const CSS: &str = include_str!("../static/tacit-css.min.css");
@@ -16,7 +15,7 @@ pub(crate) const FAVICON: &[u8] = include_bytes!("../static/favicon32.png");
 
 lazy_static! {
     pub(crate) static ref CLIENT: reqwest::Client = reqwest::Client::new();
-    pub(crate) static ref OPT: Opt = Opt::from_args();
+    pub(crate) static ref OPT: Settings = Settings::new().unwrap();
     pub(crate) static ref REPO_COUNT: AtomicUsize =
-        AtomicUsize::new(count_repositories(&OPT.outdir).unwrap());
+        AtomicUsize::new(count_repositories(&OPT.repodir).unwrap());
 }

src/template.rs

@@ -1,7 +1,7 @@
 pub struct RepoInfo<'a> {
     pub commit_url: &'a str,
     pub commits: u64,
-    pub domain: &'a str,
+    pub base_url: &'a str,
     pub head: &'a str,
     pub hoc: u64,
     pub hoc_pretty: &'a str,

src/tests.rs

@@ -37,7 +37,9 @@ macro_rules! test_service {
 
 #[actix_rt::test]
 async fn test_index() {
-    let mut app = test::init_service(App::new().service(index)).await;
+    std::env::set_var("HOC_BASE_URL", "http://0.0.0.0:8080");
+
+    let mut app = test_app!(index);
 
     let req = dbg!(test::TestRequest::with_uri("/").to_request());
     let resp = dbg!(test::call_service(&mut app, req).await);

templates/generate.rs.html

@@ -1,7 +1,7 @@
 @use super::base;
 @use crate::statics::VersionInfo;
 
-@(version_info: VersionInfo, repo_count: usize, domain: &str, url: &str, service: &str, path: &str)
+@(version_info: VersionInfo, repo_count: usize, base_url: &str, url: &str, service: &str, path: &str)
 
 @:base("Hits-of-Code Badges", "Badge Generator", {
 
@@ -10,7 +10,7 @@ Here is the markdown for the badge for <a href="https://@url/@path">@url/@path</
 </p>
 
 <pre>
-[![Hits-of-Code](https://@domain/@service/@path)](https://@domain/view/@service/@path)
+[![Hits-of-Code](@base_url/@service/@path)](@base_url/@service/@path/view)
 </pre>
 
 <p>
@@ -18,6 +18,6 @@ It will be rendered like this
 </p>
 
 <pre>
-<a href="https://@domain/view/@service/@path"><img src="https://@domain/@service/@path" alt="example badge" /></a>
+<a href="@base_url/@service/@path/view"><img src="@base_url/@service/@path" alt="example badge" /></a>
 </pre>
 }, version_info, repo_count)

templates/index.rs.html

@@ -1,7 +1,7 @@
 @use super::base;
 @use crate::statics::VersionInfo;
 
-@(version_info: VersionInfo, repo_count: usize, domain: &str)
+@(version_info: VersionInfo, repo_count: usize, base_url: &str)
 
 @:base("Hits-of-Code Badges", "Hits-of-Code Badges", {
 
@@ -24,7 +24,7 @@ used for GitHub, GitLab and Bitbucket repositories. Just put the following code
 </p>
 
 <pre>
-[![Hits-of-Code](https://@domain/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)](https://@domain/view/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)
+[![Hits-of-Code](@base_url/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)](@base_url/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;/view)
 </pre>
 
 <p>
@@ -33,7 +33,7 @@ following Markdown
 </p>
 
 <pre>
-[![Hits-of-Code](https://@domain/github/vbrandl/hoc)](https://@domain/view/github/vbrandl/hoc)
+[![Hits-of-Code](@base_url/github/vbrandl/hoc)](@base_url/github/vbrandl/hoc/view)
 </pre>
 
 <p>
@@ -41,7 +41,7 @@ would render this badge:
 </p>
 
 <pre>
-<a href="https://@domain/view/github/vbrandl/hoc"><img src="https://@domain/github/vbrandl/hoc"
+<a href="@base_url/github/vbrandl/hoc/view"><img src="@base_url/github/vbrandl/hoc"
 alt="example badge" /></a>
 </pre>
 
@@ -55,7 +55,7 @@ in your repository or you want a badge for another branch of your repository, ju
 You can also request the HoC as JSON by appending <code>/json</code> to the request path. This will return a JSON object
 with three fields: <code>count</code> (the HoC value), <code>commits</code> (the number of commits) and
 <code>head</code> (the commit ref of HEAD). Requesting <a
-href="https://@domain/github/vbrandl/hoc/json">https://@domain/github/vbrandl/hoc/json</a> might return something along
+href="@base_url/github/vbrandl/hoc/json">@base_url/github/vbrandl/hoc/json</a> might return something along
 the lines of
 </p>
 

templates/overview.rs.html

@@ -19,7 +19,7 @@ To include the badge in your readme, use the following markdown:
 </p>
 
 <pre>
-[![Hits-of-Code](https://@repo_info.domain/@repo_info.path?branch=@repo_info.branch)](https://@repo_info.domain/view/@repo_info.path?branch=@repo_info.branch)
+[![Hits-of-Code](@repo_info.base_url/@repo_info.path?branch=@repo_info.branch)](@repo_info.base_url/@repo_info.path/view?branch=@repo_info.branch)
 </pre>