Bump version number

Bump serde_json from 1.0.39 to 1.0.40

Cargo.toml

@@ -1,27 +1,27 @@
 [package]
 name = "hoc"
-version = "0.9.0"
+version = "0.9.5"
 authors = ["Valentin Brandl <vbrandl@riseup.net>"]
 edition = "2018"
 build = "build.rs"
 
 [dependencies]
-actix-web = "1.0.0"
+actix-web = "1.0.3"
 badge = "0.2.0"
 bytes = "0.4.12"
-futures = "0.1.27"
+futures = "0.1.28"
 git2 = "0.9.1"
 lazy_static = "1.3.0"
 log = "0.4.6"
 log4rs = "0.8.3"
 number_prefix = "0.3.0"
 openssl-probe = "0.1.2"
-reqwest = "0.9.17"
+reqwest = "0.9.18"
-serde = "1.0.91"
+serde = "1.0.94"
-serde_derive = "1.0.91"
+serde_derive = "1.0.94"
-serde_json = "1.0.39"
+serde_json = "1.0.40"
-structopt = "0.2.16"
+structopt = "0.2.18"
 
 [build-dependencies]
-ructe = "0.6.2"
+ructe = "0.6.4"
 vergen = "3.0.4"

README.md

@@ -20,8 +20,14 @@ The API is as simple as
 https://<host>/<service>/<user>/<repo>
 ```
 
-where `<service>` is one of `gitub`, `gitlab` or `bitbucket`.
+where `<service>` is one of `gitub`, `gitlab` or `bitbucket`. The HoC data can also be received as JSON by appending
+`/json` to the reuqest path:
 
+```
+https://<host>/<service>/<user>/<repo>/json
+```
+
+There is also an overview page available via `https://<host>/view/<service>/<user>/<repo>`
 
 ## Building
 

src/cache.rs

@@ -1,4 +1,4 @@
-use crate::Error;
+use crate::error::{Error, Result};
 use std::{
     borrow::Cow,
     fs::{create_dir_all, File, OpenOptions},
@@ -17,7 +17,7 @@ pub(crate) enum CacheState<'a> {
 }
 
 impl<'a> CacheState<'a> {
-    pub(crate) fn read_from_file(path: impl AsRef<Path>, head: &str) -> Result<CacheState, Error> {
+    pub(crate) fn read_from_file(path: impl AsRef<Path>, head: &str) -> Result<CacheState> {
         if path.as_ref().exists() {
             let cache: Cache = serde_json::from_reader(BufReader::new(File::open(path)?))?;
             if cache.head == head {
@@ -49,7 +49,7 @@ pub(crate) struct Cache<'a> {
 }
 
 impl<'a> Cache<'a> {
-    pub(crate) fn write_to_file(&self, path: impl AsRef<Path>) -> Result<(), Error> {
+    pub(crate) fn write_to_file(&self, path: impl AsRef<Path>) -> Result<()> {
         create_dir_all(path.as_ref().parent().ok_or(Error::Internal)?)?;
         serde_json::to_writer(
             OpenOptions::new()

src/main.rs

@@ -17,7 +17,7 @@ mod service;
 mod statics;
 
 use crate::{
-    cache::{Cache, CacheState},
+    cache::CacheState,
     error::{Error, Result},
     service::{Bitbucket, FormService, GitHub, Gitlab, Service},
     statics::{CLIENT, CSS, FAVICON, OPT, REPO_COUNT, VERSION_INFO},
@@ -56,6 +56,12 @@ struct State {
     cache: String,
 }
 
+#[derive(Serialize)]
+struct JsonResponse<'a> {
+    head: &'a str,
+    count: u64,
+}
+
 fn pull(path: impl AsRef<Path>) -> Result<()> {
     let repo = Repository::open_bare(path)?;
     let mut origin = repo.find_remote("origin")?;
@@ -193,8 +199,8 @@ fn json_hoc<T: Service>(
 ) -> impl Future<Item = HttpResponse, Error = Error> {
     let mapper = |r| match r {
         HocResult::NotFound => p404(),
-        HocResult::Hoc { hoc, head, .. } => Ok(HttpResponse::Ok().json(Cache {
+        HocResult::Hoc { hoc, head, .. } => Ok(HttpResponse::Ok().json(JsonResponse {
-            head: head.into(),
+            head: &head,
             count: hoc,
         })),
     };

templates/index.rs.html

@@ -45,6 +45,21 @@ would render this badge:
 alt="example badge" /></a>
 </pre>
 
+<p>
+You can also request the HoC as JSON by appending <code>/json</code> to the request path. This will return a JSON
+object with two fields: <code>count</code> and <code>head</code> with count being the HoC value and head being the
+commit ref of <code>HEAD</code>. Requesting
+<a href="https://@domain/github/vbrandl/hoc/json">https://@domain/github/vbrandl/hoc/json</a> might return something
+along the lines of
+</p>
+
+<pre>
+&#123;
+    "head" : "05736ee3ba256ec9a7227c436aef2bf43db109ab",
+    "count": 7582
+&#125;
+</pre>
+
 <h2>Badge Generator</h2>
 
 <form method="post" action="/generate">