Add access token based auth method

Author: jovobe

README.md

@@ -5,6 +5,22 @@ Search Confluence from Alfred and open results in your browser.
 - Search Confluence from Alfred and open results in your browser
 - Copy Confluence page URL to clipboard (⌘ + C on an Alfred result)
 - Works on M1 and Intel Macs
+- Authenticate with your Confluence account via Access Token or Username/Password
+
+## Usage
+1. Download the latest version of the workflow [here](https://github.com/jovobe/alfred-confluence-workflow/releases)
+2. Open the workflow in Alfred
+3. Adjust the environment variables accordingly
+4. Type `c <search term>` in Alfred to search Confluence
+
+### Environment variables
+- `BASE_URL`: Confluence base URL without trailing slash e.g. https://confluence.example.com
+- `ACCESS_TOKEN`: Confluence access token
+- `USERNAME`: Confluence username
+- `PASSWORD`: Confluence password
+
+### Authentication
+You can use either an access token or a username/password combination. You can obtain an access token by following the instructions [here](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html). If you use an access token, you can omit the username and password. If you use a username/password combination, you can omit the access token. If you provide both, the access token will be used.
 
 ## Development
 The current development setup assumes that it is built on a Mac with M1.
@@ -18,10 +34,16 @@ The current development setup assumes that it is built on a Mac with M1.
 - [x] publish
 - [x] create release in github
 - [x] build for intel chip (universal release?)
-- [ ] compare to python workflow
-- [ ] use token based auth
+- [x] compare to python workflow
+- [x] use token based auth
 - [x] utf-8 chars not searchable (e.g. "führung")
-- [ ] add getting started section to readme
+- [x] add getting started section to readme
+
+## Contributing
+Contributions are welcome! Please fork the repository and submit a pull request with your changes or open an issue with your suggestions.
+
+## Credits
+This project is heavily inspired by [alfred-confluence](https://github.com/skleinei/alfred-confluence) which is a Python based workflow for searching Confluence. The mentioned project is not working anymore due to the removal of Python 2 support in macOS 12.3.
 
 ---
 

src/main.rs

@@ -6,27 +6,29 @@ use serde_variant::to_variant_name;
 use std::env;
 
 fn main() -> Result<()> {
-    let username = env::var("USERNAME").context("Confluence username not found!")?;
-    let password = env::var("PASSWORD").context("Confluence password not found!")?;
+    let access_token = env::var("ACCESS_TOKEN").context("Confluence access token not found!");
+    let username = env::var("USERNAME").context("Confluence username not found!");
+    let password = env::var("PASSWORD").context("Confluence password not found!");
     let base_url = env::var("BASE_URL").context("Confluence base url not found!")?;
 
     let args: Vec<String> = env::args().collect();
     let query = &args[1].nfc().collect::<String>();
     let request_url = format!("{base_url}/rest/quicknav/1/search", base_url = base_url);
 
     let client = Client::new();
-    let request = client
-        .get(request_url)
-        .query(&[("query", query)])
-        .basic_auth(username, Some(password));
+    let mut request = client.get(request_url).query(&[("query", query)]);
+    if access_token.is_ok() {
+        request = request.bearer_auth(access_token.unwrap());
+    } else if username.is_ok() && password.is_ok() {
+        request = request.basic_auth(username.unwrap(), Some(password.unwrap()));
+    } else {
+        panic!("No authentication method found!");
+    }
     let response = request.send()?;
-
     let result: ApiResponse = response.json()?;
 
     let result_list = AlfredResultList::from(result, &base_url);
-    if cfg!(debug_assertions) {
-        println!("{:#?}", result_list);
-    }
+
     let out = serde_json::to_string(&result_list).unwrap();
     println!("{}", out);
 

workflow/info.plist

@@ -124,6 +124,8 @@ The Alfred Confluence workflow makes the Confluence search available in the Alfr
 	</dict>
 	<key>variables</key>
 	<dict>
+		<key>ACCESS_TOKEN</key>
+		<string></string>
 		<key>BASE_URL</key>
 		<string>Base URL with protocol and without trailing slash. e.g. https://confluence.atlassian.com</string>
 		<key>PASSWORD</key>
@@ -133,8 +135,9 @@ The Alfred Confluence workflow makes the Confluence search available in the Alfr
 	</dict>
 	<key>variablesdontexport</key>
 	<array>
-		<string>BASE_URL</string>
 		<string>PASSWORD</string>
+		<string>BASE_URL</string>
+		<string>ACCESS_TOKEN</string>
 		<string>USERNAME</string>
 	</array>
 	<key>version</key>