cleanup and packaging scripts

Author: Xgames123

.idea/workspace.xml

@@ -2,9 +2,15 @@
 name = "gh-login"
 authors = ["ldev"]
 version = "0.1.0"
+license-file="LICENSE.md"
 edition = "2021"
+description=""
 homepage="https://github.com/Xgames123/gh-login"
 
+[[bin]]
+name = "credential-gh-login"
+path = "src/main.rs"
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]

Cargo.toml

@@ -1,2 +1,29 @@
 # gh-login
-A simple git credentials manager for github
+<p align="center">
+  <img src="https://github.com/Xgames123/gh-login/blob/main/gh-login-logo_transparent.png?raw=true" alt="gh-login-logo"/>
+</p>
+A simple git credentials manager for GitHub
+
+It authenticates to GitHub and uses a backing credential helper, so you can use normal git credential helpers.
+
+## Install
+1. Install gh-login for your os (see below)
+2. Set gh-login as your git credential helper
+   
+    ```git config --global credential.https://github.com.helper 'gh-login -b cache'```
+   
+    You can change cache to any credential helper you like
+
+    If that gives an error you can also manually edit $HOME/.gitconfig
+
+### Arch linux
+Install gh-login form the AUR
+```bash
+git clone aur.archlinux.org/gh-login.git
+cd gh-login
+makepkg --syncdeps --install
+```
+
+### Debian/Ubuntu
+Download latest release and run ```dpkg -i gh-login.deb```
+Replace ```gh-login.deb``` with the file you just downloaded

README.md

@@ -0,0 +1,6 @@
+
+echo Packaging gh-login-debian-armv7
+packaging/debian/pack.sh armv7-unknown-linux-gnueabihf
+
+echo Packaging gh-login-debian-x86_64
+packaging/debian/pack.sh x86_64-unknown-linux-gnu

pack.sh

@@ -0,0 +1,34 @@
+pkgver=0.1.0
+
+pkgname=gh-login
+pkgdesc="A simple git credentials helper for github"
+license=(MIT)
+url="https://github.com/Xgames123/gh-login"
+
+binname=credential-$pkgname
+source=("$pkgname-$pkgver.tar.gz::https://github.com/Xgames123/$pkgname/archive/$pkgver.tar.gz")
+makedepends=(
+cargo
+)
+
+
+prepare() {
+    export RUSTUP_TOOLCHAIN=stable
+    cargo fetch --locked --target "$CARCH-unknown-linux-gnu"
+}
+
+
+build() {
+    export RUSTUP_TOOLCHAIN=stable
+    export CARGO_TARGET_DIR=target
+    cargo build --frozen --release --all-features
+}
+
+check() {
+    export RUSTUP_TOOLCHAIN=stable
+    cargo test --frozen --all-features
+}
+
+package() {
+    install -Dm0755 -t "$pkgdir/bin/" "target/release/$binname"
+}

packaging/aur/gh-login/PKGBUILD

@@ -0,0 +1,64 @@
+pkgver=0.1.0
+
+pkgname=gh-login
+pkgdesc="A simple git credentials helper for github"
+license=MIT
+url="https://github.com/Xgames123/gh-login"
+maintianer=ldev
+
+TARGET=$1
+echo "os: Debain"
+echo "target: $TARGET"
+
+
+CARCH=$(echo $TARGET | grep -o "^[^-]*")
+builddir=/tmp
+fullbuilddir=$builddir/gh-login
+binname=credential-$pkgname
+
+debarch=$CARCH
+if [ "$CARCH" = "x86_64" ]; then
+  debarch="amd64"
+fi
+if [ "$CARCH" = "armv7" ]; then
+  debarch="arm"
+fi
+
+
+rm -rf $fullbuilddir
+mkdir -p $fullbuilddir
+cp -rf packaging/debian/gh-login $builddir
+
+# Generate control file
+controlfile=$fullbuilddir/DEBIAN/control
+echo "" > $controlfile
+echo "Package: $pkgname" >> $controlfile
+echo "Version: $pkgver" >> $controlfile
+echo "Maintainer: $maintianer" >> $controlfile
+echo "Architecture: $debarch" >> $controlfile
+echo "Description: $pkgdesc" >> $controlfile
+echo "Homepage: $url" >> $controlfile
+echo "Section: vcs" >> $controlfile
+
+# Build rust app
+export RUSTUP_TOOLCHAIN=stable
+cargo fetch --locked --target $TARGET
+
+export RUSTUP_TOOLCHAIN=stable
+export CARGO_TARGET_DIR=target
+cargo build --frozen --release --all-features
+
+export RUSTUP_TOOLCHAIN=stable
+cargo test --frozen --all-features
+
+# Copy bin to package
+mkdir -p $fullbuilddir/bin
+cp -f target/release/$binname $fullbuilddir/bin/$binname
+chmod +x $fullbuilddir/bin/$binname
+
+# Building package
+dpkg-deb --build $fullbuilddir
+
+# Copy to output dir
+mkdir -p target/packaging
+mv $builddir/gh-login.deb target/packaging/gh-login-debian-$CARCH.deb

packaging/debian/pack.sh

@@ -2,7 +2,6 @@ pub mod params;
 
 use params::Params;
 use std::fmt;
-use std::io::{Read, Write};
 use std::process::{Child, Command, Stdio};
 
 use log::{debug};
@@ -32,22 +31,16 @@ pub fn spawn(helper: &str, operation: &str) -> Result<Child> {
         .ok_or_else(|| InvalidHelper.into())
         .and_then(|split| {
 
-            let program_name = split[0];
-
-            let cmd = Command::new(&program_name)
-                .args(&split[1..])
+            let mut cmd = Command::new(&split[0]);
+            cmd.args(&split[1..])
                 .arg(operation)
                 .stdin(Stdio::piped())
                 .stdout(Stdio::piped());
 
-            debug!("{}", cmd);
-
-            let process = cmd.spawn()
-                .map_err(|err| err.into());
-
-
+            debug!("Running command {:?}", &cmd);
 
-            process
+            cmd.spawn()
+                .map_err(|err| err.into())
         })
 }
 
@@ -56,10 +49,11 @@ pub fn run(helper: &str, operation: &str, params: Params) -> Result<Params> {
     let mut stdin = process.stdin.take().unwrap();
     params.write_to(&mut stdin)?;
     drop(stdin);
-    process.wait()?;
 
     let mut stdout = process.stdout.take().unwrap();
-
     let output_params = params::from_stream(&mut stdout)?;
+    drop(stdout);
+
+    process.wait()?;
     Ok(output_params)
 }

src/credhelper/mod.rs

@@ -28,31 +28,31 @@ impl Display for Params{
 
 
 impl Params {
-    pub fn get(&self, key: String) -> Option<&String> {
-        return self.hashmap.get(&key);
+    pub fn get(&self, name: &str) -> Option<&String> {
+        return self.hashmap.get(name);
     }
 
     pub fn add(&mut self, name: String, value: String) {
         self.hashmap.insert(name, value);
     }
 
-    pub fn contains(&self, name: String) -> bool {
-        self.hashmap.contains_key(&name)
+    pub fn contains(&self, name: &str) -> bool {
+        self.hashmap.contains_key(name)
     }
 
     pub fn add_from_string(&mut self, s: &String) -> Result<(), ParamParserError> {
         for (i, &character) in s.as_bytes().iter().enumerate() {
             if character == b'=' {
                 self.add(
-                    (&s[..i]).trim().to_string(),
-                    (&s[(i + 1)..]).trim().to_string(),
+                    (s[..i]).trim().to_string(),
+                    (s[(i + 1)..]).trim().to_string(),
                 );
                 return Ok(());
             }
         }
-        return Err(ParamParserError {
+        Err(ParamParserError {
             data: s.to_string(),
-        });
+        })
     }
 
     pub fn write_to_sdtout(&self) -> std::io::Result<()> {
@@ -63,9 +63,9 @@ impl Params {
 
     pub fn write_to<T: std::io::Write>(&self, stream: &mut T) -> std::io::Result<()> {
         for (key, value) in self.hashmap.iter() {
-            stream.write_fmt(format_args!("{0}={1}", key, value))?;
+            stream.write_fmt(format_args!("{0}={1}\n", key, value))?;
         }
-        stream.write_all(b"\n")?;
+        stream.write_all(b"\n\n")?;
         Ok(())
     }
 }
@@ -81,12 +81,13 @@ pub fn from_stream<T: Read>(stream: T) -> Result<Params, Box<dyn Error>> {
         buffer.clear();
 
         buf_reader.read_line(&mut buffer)?;
+
         if buffer.trim().is_empty() {
             break;
         }
         params.add_from_string(&buffer)?;
     }
-    return Ok(params);
+    Ok(params)
 }
 
 pub fn from_stdin() -> Result<Params, Box<dyn Error>> {

src/credhelper/params.rs

@@ -3,7 +3,7 @@ static OAUTH_SCOPE: &str = "repo";
 
 use reqwest::StatusCode;
 use serde::Deserialize;
-use std::fmt::{format, Formatter};
+use std::fmt::{Formatter};
 use std::time::{Duration, SystemTime, UNIX_EPOCH};
 use std::{error::Error, fmt, fmt::Display, thread::sleep};
 
@@ -23,7 +23,7 @@ impl DeviceCode {
         if (epoch_time() - self.time) >= self.expires_in {
             return true;
         }
-        return false;
+        false
     }
 }
 
@@ -47,7 +47,7 @@ pub fn epoch_time() -> u64 {
         .duration_since(UNIX_EPOCH)
         .expect("Time went backwards?????");
 
-    return since_the_epoch.as_secs();
+    since_the_epoch.as_secs()
 }
 
 #[derive(Debug)]
@@ -56,7 +56,7 @@ pub enum AccessTokenPollError {
     Reqwest(reqwest::Error),
 }
 impl Display for AccessTokenPollError {
-    fn fmt(&self, fmt: &mut Formatter<'_>) -> std::fmt::Result {
+    fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
         match &self {
             AccessTokenPollError::DeviceCodeExpired => fmt.write_str("The device code has expired"),
             AccessTokenPollError::Reqwest(err) => {
@@ -82,7 +82,7 @@ pub async fn poll_for_access_token(
         ),
     ];
 
-    return loop {
+    loop {
         if device_code.expired() {
             return Err(AccessTokenPollError::DeviceCodeExpired);
         }
@@ -111,7 +111,7 @@ pub async fn poll_for_access_token(
                 Err(AccessTokenPollError::Reqwest(err))
             }
         };
-    };
+    }
 }
 
 pub async fn get_device_code(client: &reqwest::Client) -> Result<DeviceCode, reqwest::Error> {
@@ -127,5 +127,5 @@ pub async fn get_device_code(client: &reqwest::Client) -> Result<DeviceCode, req
 
     device_code.time = epoch_time();
 
-    return Ok(device_code);
+    Ok(device_code)
 }