Update readme file name

Cargo.lock

@@ -652,7 +652,7 @@ dependencies = [
 
 [[package]]
 name = "gandi-live-dns"
-version = "1.6.0"
+version = "1.7.0"
 dependencies = [
  "anyhow",
  "async-trait",

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "gandi-live-dns"
 description = "Automatically updates your IP address in Gandi's Live DNS. Makes it possible to use Gandi as a dynamic DNS system."
-version = "1.6.0"
+version = "1.7.0"
 edition = "2021"
 authors = ["Kaan Barmore-Genç <kaan@bgenc.net>"]
 license = "MIT"
-readme = "Readme.md"
+readme = "README.md"
 repository = "https://github.com/SeriousBug/gandi-live-dns-rust"
 
 [profile.release]

README.md

@@ -161,7 +161,8 @@ Docker with `docker login`. Then follow these steps:
 - Create a release on Github
   - Make sure to create a tag for the release version on `master`
   - Upload the binary archives to the Github release
-- Update the AUR version manually
+- Update the AUR version
+- Run `cargo publish` to update the crates.io version
 
 ## Alternatives
 

example.toml

@@ -19,8 +19,9 @@ ttl = 300
 # Ipify is used by default. If you want to change it, uncomment the one you want
 # to use.
 #
-# ip_source = "Ipify"
+#ip_source = "Ipify"     # An open source and public service. https://github.com/rdegges/ipify-api
-# ip_source = "Icanhazip"
+#ip_source = "Icanhazip" # A free service, currently run by Cloudflare. https://major.io/2021/06/06/a-new-future-for-icanhazip/
+#ip_source = "SeeIP"     # A free service, run by UNVIO, LLC. https://seeip.org/
 
 # For every domain or subdomain you want to update, create an entry below.
 

make-release.sh

@@ -3,9 +3,7 @@
 # Make sure `cross` is installed.
 # You'll also need `sed`, a relatively recent version of `tar`, and `7z`.
 #
-# This script runs does `sudo docker` to build and push the release to docker.
+DOCKER="docker"
-# If you have rootless docker set up, remove sudo from this variable.
-DOCKER="sudo docker"
 #
 shopt -s extglob
 # Trap errors and interrupts
@@ -49,6 +47,9 @@ VERSION=$(sed -nr 's/^version *= *"([0-9.]+)"/\1/p' Cargo.toml | head --lines=1)
 # Make the builds
 for target in "${!TARGETS[@]}"; do
   echo Building "${target}"
+  # Keeping the cached builds seem to be breaking things when going between targets
+  # This wouldn't be a problem if these were running in a matrix on the CI...
+  rm -rf target/release/
   cross build -j $(($(nproc) / 2)) --release --target "${target}"
   if [[ "${target}" =~ .*"windows".* ]]; then
     zip -j "gandi-live-dns.${VERSION}.${TARGETS[${target}]}.zip" target/"${target}"/release/gandi-live-dns.exe 1>/dev/null

src/config.rs

@@ -25,6 +25,7 @@ fn default_ttl() -> u32 {
 pub enum IPSourceName {
     Ipify,
     Icanhazip,
+    SeeIP,
 }
 
 impl Default for IPSourceName {

src/ip_source/Readme.md

@@ -2,5 +2,5 @@ The IP sources. These are APIs that we can query to get the IP address of the
 current service.
 
 The tests under this directory are all marked to be skipped, the tests hit the
-actual APIs and can be flakey in CI. Make sure to run the tests manually if you
+actual APIs and can be flaky in CI. Make sure to run the tests manually if you
 have to modify the code.

src/ip_source/mod.rs

@@ -1,3 +1,4 @@
 pub(crate) mod icanhazip;
 pub(crate) mod ip_source;
 pub(crate) mod ipify;
+pub(crate) mod seeip;

src/ip_source/seeip.rs

@@ -0,0 +1,53 @@
+use async_trait::async_trait;
+
+use super::ip_source::IPSource;
+
+pub(crate) struct IPSourceSeeIP;
+
+async fn get_ip(api_url: &str) -> anyhow::Result<String> {
+    let response = reqwest::get(api_url).await?;
+    let text = response.text().await?;
+    Ok(text)
+}
+
+#[async_trait]
+impl IPSource for IPSourceSeeIP {
+    async fn get_ipv4(&self) -> anyhow::Result<String> {
+        get_ip("https://ip4.seeip.org").await
+    }
+    async fn get_ipv6(&self) -> anyhow::Result<String> {
+        get_ip("https://ip6.seeip.org").await
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use regex::Regex;
+
+    use super::IPSource;
+    use super::IPSourceSeeIP;
+
+    #[tokio::test]
+    #[ignore]
+    async fn ipv4_test() {
+        let ipv4 = IPSourceSeeIP
+            .get_ipv4()
+            .await
+            .expect("Failed to get the IP address");
+        assert!(Regex::new(r"^\d+[.]\d+[.]\d+[.]\d+$")
+            .unwrap()
+            .is_match(ipv4.as_str()))
+    }
+
+    #[tokio::test]
+    #[ignore]
+    async fn ipv6_test() {
+        let ipv6 = IPSourceSeeIP
+            .get_ipv6()
+            .await
+            .expect("Failed to get the IP address");
+        assert!(Regex::new(r"^([0-9a-fA-F]*:){7}[0-9a-fA-F]*$")
+            .unwrap()
+            .is_match(ipv6.as_str()))
+    }
+}

src/main.rs

@@ -4,6 +4,7 @@ use crate::ip_source::{ip_source::IPSource, ipify::IPSourceIpify};
 use clap::Parser;
 use config::IPSourceName;
 use ip_source::icanhazip::IPSourceIcanhazip;
+use ip_source::seeip::IPSourceSeeIP;
 use opts::Opts;
 use reqwest::{header, Client, ClientBuilder, StatusCode};
 use serde::Serialize;
@@ -158,6 +159,7 @@ async fn main() -> anyhow::Result<()> {
     let ip_source: Box<dyn IPSource> = match conf.ip_source {
         IPSourceName::Ipify => Box::new(IPSourceIpify),
         IPSourceName::Icanhazip => Box::new(IPSourceIcanhazip),
+        IPSourceName::SeeIP => Box::new(IPSourceSeeIP),
     };
     config::validate_config(&conf).die_with(|error| format!("Invalid config: {}", error));
     run("https://api.gandi.net", &ip_source, &conf, &opts).await?;