Project

solid-community-client-simple

0.0
No release in over a year
solid-community-client-simplemarkwilkinson/solid-community-client-simpleHomepageDocumentationSource CodeBug TrackerWiki
A simple client to interact with the SOLID Community Server. NOTA BENE - this is NOT a fully functional SOLID client. It does only what I need it to do for a specific project. It may or may not be useful to anyone else. It is badly documented (if at all!). It has only been tested against the Docker version of the Solid Community Server runnign on localhost. Don't blame me if it doesn't work for you. Enough said?
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Popularity
Downloads
1,498
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.0.5
Total releases
4
First release
2024-08-13
Latest release
2024-08-16
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-08-14
Reverse Dependencies
0

 Dependencies
 Project Readme

SOLID Client for the SOLID Community Server

Talk to SOLID Pods

This is not guaranteed to be useful for any purpose whatsoever

If you want an idea of what's happening behind the scenes, have a look at this Gist:
https://gist.github.com/markwilkinson/c5e819ae08d3753b1ee63edb2a504401

Note that this was created for a specific project, with a short timeline. It currently does only the things I need it to do! It is not, in any way a full-featured SOLID POD library! Having said that, it does get you through all of the stages of login and to the point of having a DPOP proof that allows you to interact in an LDP-style manner with the POD (e.g. creating/updating/deleting Resources and/or Containers)

Future iterations will be much more powerful, as my requirements grow through the life of my project.

Example Interaction

# this assumes you are running the SOLID Community Client docker image exposing port 3000
# you must have already set-up a login and have a POD on that server to talk to!

require "solid-community-client-simple"
s = SOLID::CommunityClient.new(server: "http://localhost:3000/", username: "mark.wilkinson@upm.es", password: "markw")
s.login
at = s.get_current_access_token(webid: "http://localhost:3000/markw/profile/card#me", name: "codetest")
dpop = s.prepare_dpop(url: "http://localhost:3000/markw/", method: "get")
res = s.execute_with_proof(dpop: dpop, data: "", content_type: "text/turtle", current_access_token: at)
puts res.body

Please share bug reports via the Issues, but please also be aware that this is not (yet!) intended for widespread use. I simply found the documentation for interacting with the Community Server to be... extremely frustrating! (documentation should not be via software snippets!). Anyway, to avoid anyone else having to figure out what the javascript in that documentation is doing, I have captured it in this code, and in the Gist linked above.

Enjoy!