Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jahfer/clj-activitypub
An ActivityPub library for Clojure
https://github.com/jahfer/clj-activitypub
activitypub clojure fediverse
Last synced: 28 days ago
JSON representation
An ActivityPub library for Clojure
- Host: GitHub
- URL: https://github.com/jahfer/clj-activitypub
- Owner: jahfer
- License: mit
- Created: 2022-11-29T04:11:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-20T00:29:02.000Z (11 months ago)
- Last Synced: 2024-04-15T02:52:25.535Z (7 months ago)
- Topics: activitypub, clojure, fediverse
- Language: Clojure
- Homepage:
- Size: 98.6 KB
- Stars: 30
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clj-activitypub
[](https://clojars.org/com.jahfer/clj-activitypub)
> **Warning**
> This is very much a work-in-progress. Only a tiny bit of the ActivityPub spec is implemented, and it definitely does not conform to all of the nuances expected _yet_.
`clj-activitypub` is a set of utilities that can be combined together to create a fully-functional ActivityPub server.
## Documentation
Docs are available at https://cljdoc.org/d/com.jahfer/clj-activitypub/
## Libraries
- `activitypub-core` — The base functionality for generating HTTP headers (i.e. `Signature`, `Digest`), building ActivityPub activities and objects, and sending requests to remote servers.
- `activitypub-ring` — A Ring-specific implementation that builds on `activitypub-core`, providing default routes and handlers for making an ActivityPub-compliant server.
## Examples
```clj
;; ActivityPub object handling
(require '[clj-activitypub.core :as activitypub])
;; Translate account handles into ActivityPub URL-based IDs
(require '[clj-activitypub.webfinger :as webfinger])
;; Build and perform network requests
(require '[clj-activitypub.net :as activitypub-net])
```
### Reading remote data
```clj
;; Fetching user account on remote server
(require '[clojure.pprint :refer [pprint]])
;;; Use any ActivityPub account handle you like
(def account-handle "@[email protected]")
;;; Retrieve the account details from its home server
(def account
(-> account-handle
(webfinger/parse-handle)
(webfinger/fetch-user-id!)
(activitypub-net/fetch-actor!)
(select-keys [:name :preferredUsername :summary])))
;;; Examine what you got back!
(pprint account) ;; => ({:name "Jahfer",
;; :preferredUsername "jahfer",
;; :summary "
Hello world!
"})
```
```clj
;; Fetching a list of users from multiple servers
(-> "https://mastodon.social/users/jahfer/followers"
(activitypub-net/resolve!)
(count)) ;; => 80
```
### Pushing data to remote servers
Before POSTing data to a remote server, you'll want to create a local key/value pair in the `/keys` directory. You'll also need a corresponding HTTP endpoint to serve the actor data, which is used to verify the signature of the message by the remote server.
```bash
$ openssl genrsa -out keys/private.pem 2048
$ openssl rsa -in keys/private.pem -outform PEM -pubout -out keys/public.pem
```
```clj
;; Submitting a Create activity for an Object to remote server
(require '[clj-http.client :as client])
(require '[clojure.data.json :as json])
(import java.net.URI)
(def activity
(->> {:id 2
:type :note
:cc "https://mastodon.social/users/jahfer"
:content "
Hello world!
"}
(activitypub/obj activity-config)
(activitypub/activity activity-config :create)))
;;; Fetch the inboxes connected to the :cc addresses
(let [targets (activitypub-net/delivery-targets! activity)]
(doseq [inbox targets]
;;; At minimum, the Host is required to build the authentication headers
(let [request {:headers {"Host" (.getHost (URI. inbox))}
:body (json/write-str activity)}]
;;; Submit request to remote inboxes
(client/post
inbox
(assoc request
:headers (activitypub-net/auth-headers activity-config request)
:throw-exceptions false)))))
```
## Running tests
There are two libraries within this package: `activitypub-core` and `activitypub-ring`. In order to run tests, the following command must be run from inside either of those directories:
```bash
# clj-activitypub/activitypub_core
$ clj -X:test
```
## References
- https://www.w3.org/TR/activitypub/
- https://www.w3.org/TR/activitystreams-core/
- https://www.w3.org/ns/activitystreams#Public
- https://www.w3.org/TR/activitystreams-vocabulary/