summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2022-11-06 20:48:42 -0800
committerBryan Newbold <bnewbold@robocracy.org>2022-11-06 20:52:30 -0800
commit2641389cb74939df9090a8183ec67ab0558f0b06 (patch)
tree5be1764c3d6924db8f832887cf5019b75d39b571
parent2a7771915e7547baefb48975507536a1c69b986b (diff)
downloadadenosine-2641389cb74939df9090a8183ec67ab0558f0b06.tar.gz
adenosine-2641389cb74939df9090a8183ec67ab0558f0b06.zip
cli: switch identifiers to adenosine-common
-rw-r--r--adenosine-cli/Cargo.toml3
-rw-r--r--adenosine-cli/src/bin/adenosine.rs1
-rw-r--r--adenosine-cli/src/identifiers.rs380
-rw-r--r--adenosine-cli/src/lib.rs3
4 files changed, 3 insertions, 384 deletions
diff --git a/adenosine-cli/Cargo.toml b/adenosine-cli/Cargo.toml
index 4f9bc6d..7b2902a 100644
--- a/adenosine-cli/Cargo.toml
+++ b/adenosine-cli/Cargo.toml
@@ -15,6 +15,7 @@ readme = "../README.md"
repository = "https://gitlab.com/bnewbold/adenosine"
[dependencies]
+adenosine-common = { version = "0.1.0-dev.0", path = "../adenosine-common" }
structopt = "*"
# NOTE: could try 'rustls-tls' feature instead of default native TLS?
reqwest = { version = "0.11", features = ["blocking", "json"] }
@@ -39,7 +40,7 @@ maintainer = "Bryan Newbold <bnewbold@robocracy.org>"
depends = "$auto"
section = "utility"
priority = "optional"
-extended-description = """"TODO"""
+extended-description = """"This is a simple, enthusiast-grade CLI client for the work-in-progress AT Protocol (atproto.com). It is an entirely \"delegated\" client, which means that it does not store or cache any user content locally; everything works by making HTTP/XRPC requests to a Personal Data Server (PDS), which is usually a remote service."""
assets = [
["target/release/adenosine", "usr/bin/", "755"],
["../extra/adenosine.1", "usr/share/man/man1/", "644"],
diff --git a/adenosine-cli/src/bin/adenosine.rs b/adenosine-cli/src/bin/adenosine.rs
index 827101d..0062763 100644
--- a/adenosine-cli/src/bin/adenosine.rs
+++ b/adenosine-cli/src/bin/adenosine.rs
@@ -1,4 +1,5 @@
use adenosine_cli::*;
+use adenosine_common::identifiers::*;
use anyhow::anyhow;
use serde_json::{json, Value};
use std::collections::HashMap;
diff --git a/adenosine-cli/src/identifiers.rs b/adenosine-cli/src/identifiers.rs
deleted file mode 100644
index 0cfe2ec..0000000
--- a/adenosine-cli/src/identifiers.rs
+++ /dev/null
@@ -1,380 +0,0 @@
-use anyhow::{anyhow, Result};
-use lazy_static::lazy_static;
-use regex::Regex;
-use std::fmt;
-use std::ops::Deref;
-use std::str::FromStr;
-use std::time::SystemTime;
-
-#[derive(Debug, PartialEq, Eq, Clone)]
-pub enum DidOrHost {
- Did(String, String),
- Host(String),
-}
-
-impl FromStr for DidOrHost {
- type Err = anyhow::Error;
-
- /// DID syntax is specified in: <https://w3c.github.io/did-core/#did-syntax>
- ///
- /// Lazy partial hostname regex, isn't very correct.
- fn from_str(s: &str) -> Result<Self, Self::Err> {
- lazy_static! {
- static ref DID_RE: Regex =
- Regex::new(r"^did:([a-z]{1,64}):([a-zA-Z0-9\-.]{1,1024})$").unwrap();
- }
- lazy_static! {
- static ref HOSTNAME_RE: Regex =
- Regex::new(r"^[A-Za-z][A-Za-z0-9-]*(\.[A-Za-z][A-Za-z0-9-]*)+$").unwrap();
- }
- if let Some(caps) = DID_RE.captures(s) {
- Ok(Self::Did(caps[1].to_string(), caps[2].to_string()))
- } else if HOSTNAME_RE.is_match(s) {
- Ok(Self::Host(s.to_string()))
- } else {
- Err(anyhow!("does not match as a DID or hostname: {}", s))
- }
- }
-}
-
-impl fmt::Display for DidOrHost {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- match self {
- Self::Host(v) => write!(f, "{}", v),
- Self::Did(m, v) => write!(f, "did:{}:{}", m, v),
- }
- }
-}
-
-#[test]
-fn test_didorhost() {
- assert_eq!(
- DidOrHost::from_str("hyde.test").unwrap(),
- DidOrHost::Host("hyde.test".to_string())
- );
- assert_eq!(
- DidOrHost::from_str("did:method:blah").unwrap(),
- DidOrHost::Did("method".to_string(), "blah".to_string())
- );
-
- assert!(DidOrHost::from_str("barestring").is_err());
- assert!(DidOrHost::from_str("did:partial:").is_err());
- assert!(DidOrHost::from_str("").is_err());
- assert!(DidOrHost::from_str(" ").is_err());
- assert!(DidOrHost::from_str("1234").is_err());
-
- assert!(DidOrHost::from_str("mutli.part.domain").is_ok());
- assert!(DidOrHost::from_str("did:is:weird").is_ok());
- assert!(DidOrHost::from_str("did:plc:bv6ggog3tya2z3vxsub7hnal").is_ok());
-}
-
-#[derive(Debug, PartialEq, Eq, Clone)]
-pub struct AtUri {
- pub repository: DidOrHost,
- pub collection: Option<String>,
- pub record: Option<String>,
- pub fragment: Option<String>,
-}
-
-impl FromStr for AtUri {
- type Err = anyhow::Error;
-
- fn from_str(s: &str) -> Result<Self, Self::Err> {
- lazy_static! {
- static ref ATURI_RE: Regex = Regex::new(r"^at://([a-zA-Z0-9:_\.-]+)(/([a-zA-Z0-9\.]+))?(/([a-zA-Z0-9\.-]+))?(#([a-zA-Z0-9/-]+))?$").unwrap();
- }
- if let Some(caps) = ATURI_RE.captures(s) {
- let uri = AtUri {
- repository: DidOrHost::from_str(&caps[1])?,
- collection: caps.get(3).map(|v| v.as_str().to_string()),
- record: caps.get(5).map(|v| v.as_str().to_string()),
- fragment: caps.get(7).map(|v| v.as_str().to_string()),
- };
- Ok(uri)
- } else {
- Err(anyhow!("couldn't parse as an at:// URI: {}", s))
- }
- }
-}
-
-impl fmt::Display for AtUri {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- write!(f, "at://{}", self.repository)?;
- if let Some(ref c) = self.collection {
- write!(f, "/{}", c)?;
- };
- if let Some(ref r) = self.record {
- write!(f, "/{}", r)?;
- };
- if let Some(ref v) = self.fragment {
- write!(f, "#{}", v)?;
- };
- Ok(())
- }
-}
-
-#[test]
-fn test_aturi() {
- assert!(AtUri::from_str("at://bob.com").is_ok());
- assert!(AtUri::from_str("at://did:plc:bv6ggog3tya2z3vxsub7hnal").is_ok());
- assert!(AtUri::from_str("at://bob.com/io.example.song").is_ok());
- assert!(AtUri::from_str("at://bob.com/io.example.song/3yI5-c1z-cc2p-1a").is_ok());
- assert!(AtUri::from_str("at://bob.com/io.example.song/3yI5-c1z-cc2p-1a#/title").is_ok());
- assert!(
- AtUri::from_str("at://did:plc:ltk4reuh7rkoy2frnueetpb5/app.bsky.follow/3jg23pbmlhc2a")
- .is_ok()
- );
-
- let uri = AtUri {
- repository: DidOrHost::Did("some".to_string(), "thing".to_string()),
- collection: Some("com.atproto.record".to_string()),
- record: Some("asdf-123".to_string()),
- fragment: Some("/path".to_string()),
- };
- assert_eq!(
- "at://did:some:thing/com.atproto.record/asdf-123#/path",
- uri.to_string()
- );
- println!("{:?}", AtUri::from_str(&uri.to_string()));
- assert!(AtUri::from_str(&uri.to_string()).is_ok());
-
- let uri = AtUri::from_str("at://bob.com/io.example.song/3yI5-c1z-cc2p-1a#/title").unwrap();
- assert_eq!(uri.repository, DidOrHost::Host("bob.com".to_string()));
- assert_eq!(uri.collection, Some("io.example.song".to_string()));
- assert_eq!(uri.record, Some("3yI5-c1z-cc2p-1a".to_string()));
- assert_eq!(uri.fragment, Some("/title".to_string()));
-}
-
-/// A String (newtype) representing an NSID
-#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Nsid(String);
-
-impl FromStr for Nsid {
- type Err = anyhow::Error;
-
- fn from_str(s: &str) -> Result<Self, Self::Err> {
- lazy_static! {
- static ref NSID_RE: Regex = Regex::new(r"^([a-z][a-z0-9-]+\.)+[a-zA-Z0-9-]+$").unwrap();
- }
- if NSID_RE.is_match(s) {
- Ok(Self(s.to_string()))
- } else {
- Err(anyhow!("does not match as an NSID: {}", s))
- }
- }
-}
-
-impl Deref for Nsid {
- type Target = str;
-
- fn deref(&self) -> &Self::Target {
- &self.0
- }
-}
-
-impl Nsid {
- pub fn domain(&self) -> String {
- self.rsplit(".")
- .skip(1)
- .collect::<Vec<&str>>()
- .join(".")
- .to_string()
- }
-
- pub fn name(&self) -> String {
- self.split(".")
- .last()
- .expect("multiple segments in NSID")
- .to_string()
- }
-}
-
-impl fmt::Display for Nsid {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- write!(f, "{}", self.0)
- }
-}
-
-#[test]
-fn test_nsid() {
- assert!(Nsid::from_str("com.atproto.recordType").is_ok());
-
- let nsid = Nsid::from_str("com.atproto.recordType").unwrap();
- assert_eq!(nsid.domain(), "atproto.com".to_string());
-}
-
-#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Did(String);
-
-impl FromStr for Did {
- type Err = anyhow::Error;
-
- /// DID syntax is specified in: <https://w3c.github.io/did-core/#did-syntax>
- ///
- /// This regex does not follow that definition exactly.
- fn from_str(s: &str) -> Result<Self, Self::Err> {
- lazy_static! {
- static ref DID_RE: Regex =
- Regex::new(r"^did:([a-z]{1,32}):([a-zA-Z0-9\-.]{1,256})$").unwrap();
- }
- if DID_RE.is_match(s) {
- Ok(Self(s.to_string()))
- } else {
- Err(anyhow!("does not match as a DID: {}", s))
- }
- }
-}
-
-impl Deref for Did {
- type Target = str;
-
- fn deref(&self) -> &Self::Target {
- &self.0
- }
-}
-
-impl Did {
- pub fn did_type(&self) -> String {
- self.split(":").nth(1).unwrap().to_string()
- }
-}
-
-impl fmt::Display for Did {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- write!(f, "{}", self.0)
- }
-}
-
-#[test]
-fn test_did() {
- assert!(Did::from_str("did:web:asdf.org").is_ok());
- assert!(Did::from_str("did:plc:asdf").is_ok());
-
- assert!(Did::from_str("bob.com").is_err());
- assert!(Did::from_str("").is_err());
- assert!(Did::from_str("did:").is_err());
- assert!(Did::from_str("did:plc:").is_err());
- assert!(Did::from_str("plc:asdf").is_err());
- assert!(Did::from_str("DID:thing:thang").is_err());
-
- assert_eq!(
- Did::from_str("did:web:asdf.org").unwrap().did_type(),
- "web".to_string()
- );
-}
-
-lazy_static! {
- /// Sortable base32 encoding, as bluesky implements/defines
- static ref BASE32SORT: data_encoding::Encoding = {
- let mut spec = data_encoding::Specification::new();
- spec.symbols.push_str("234567abcdefghijklmnopqrstuvwxyz");
- spec.padding = None;
- spec.encoding().unwrap()
- };
-}
-
-/// A string identifier representing a UNIX time in miliseconds, plus a small counter
-///
-/// Pretty permissive about what can be parsed/accepted, because there were some old TIDs floating
-/// around with weird format.
-#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
-pub struct Tid(String);
-
-impl FromStr for Tid {
- type Err = anyhow::Error;
-
- fn from_str(s: &str) -> Result<Self, Self::Err> {
- lazy_static! {
- static ref TID_RE: Regex = Regex::new(r"^[0-9a-zA-Z-]{13,20}$").unwrap();
- }
- if TID_RE.is_match(s) {
- Ok(Self(s.to_string()))
- } else {
- Err(anyhow!("does not match as a TID: {}", s))
- }
- }
-}
-
-impl Deref for Tid {
- type Target = str;
-
- fn deref(&self) -> &Self::Target {
- &self.0
- }
-}
-
-impl fmt::Display for Tid {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- write!(f, "{}", self.0)
- }
-}
-
-impl Tid {
- /// Bluesky does not specify, but assuming u64 math here
- pub fn new(millis: u64, count: u64, clock_id: u8) -> Self {
- let val = millis * 1000 + count;
- Tid(format!(
- "{}{}",
- BASE32SORT.encode(&val.to_le_bytes()),
- BASE32SORT.encode(&[clock_id]),
- ))
- }
-}
-
-#[test]
-fn test_tid() {
- Tid::from_str("3yI5-c1z-cc2p-1a").unwrap();
- assert!(Tid::from_str("3jg6anbimrc2a").is_ok());
- assert!(Tid::from_str("3yI5-c1z-cc2p-1a").is_ok());
-
- Tid::from_str("asdf234as4asdf234").unwrap();
- assert!(Tid::from_str("asdf234as4asdf234").is_ok());
-
- assert!(Tid::from_str("").is_err());
- assert!(Tid::from_str("com").is_err());
- assert!(Tid::from_str("com.blah.Thing").is_err());
- assert!(Tid::from_str("did:stuff:blah").is_err());
-}
-
-pub struct TidLord {
- last_timestamp: u64,
- last_counter: u64,
- clock_id: u8,
-}
-
-impl TidLord {
- pub fn new() -> Self {
- Self {
- last_timestamp: 0,
- last_counter: 0,
- // just 5 bits (?)
- clock_id: rand::random::<u8>() & 0x1F,
- }
- }
-
- pub fn next(&mut self) -> Tid {
- let now = SystemTime::now()
- .duration_since(SystemTime::UNIX_EPOCH)
- .unwrap()
- .as_millis() as u64;
- if now > self.last_timestamp {
- self.last_timestamp = now;
- self.last_counter = 0;
- } else {
- self.last_counter += 1;
- }
- Tid::new(self.last_timestamp, self.last_counter, self.clock_id)
- }
-}
-
-#[test]
-fn test_tid_lord() {
- let mut time_lord = TidLord::new();
- let mut prev = time_lord.next();
- for _ in [0..100] {
- assert!(time_lord.next() > prev);
- prev = time_lord.next();
- }
- assert_eq!(prev, Tid::from_str(&prev.to_string()).unwrap());
- println!("{}", prev);
-}
diff --git a/adenosine-cli/src/lib.rs b/adenosine-cli/src/lib.rs
index cecbbe4..8dbfa6c 100644
--- a/adenosine-cli/src/lib.rs
+++ b/adenosine-cli/src/lib.rs
@@ -8,9 +8,6 @@ use std::collections::HashMap;
use std::str::FromStr;
use std::time::Duration;
-mod identifiers;
-pub use identifiers::{AtUri, Did, DidOrHost, Nsid, Tid, TidLord};
-
static APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"),);
#[derive(Debug, PartialEq, Eq, Clone)]