Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/driebit/zotonic_mod_adlib
https://github.com/driebit/zotonic_mod_adlib
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/driebit/zotonic_mod_adlib
- Owner: driebit
- License: apache-2.0
- Created: 2021-10-06T12:38:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-01T16:02:38.000Z (about 2 years ago)
- Last Synced: 2023-08-03T20:12:13.120Z (over 1 year ago)
- Language: Erlang
- Size: 40 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Adlib support for Zotonic
=========================
[Adlib](http://www.adlibsoft.nl) is a collection organization and management tool for museums and libraries.
This [Zotonic](http://www.zotonic.com) module adds support routines for accessing and importing these collections into a Zotonic system.
## API functions
The remote Adlib endpoint is configured using a record:
```erlang
#adlib_endpoint{
name = <<"My Foobar database">>,
api_url = <<"https://foobar.adlibhosting.com/mydatabase/wwwopac.ashx">>,
database = <<"collect">>,
extra_arguments = [],
date_format = "'Y-m-d H:i:s'",
timezone = <<"UTC">>
}
```
The API URL is the base URL for all API calls.
The database is one of the databases available on the remote system.
The date_format is there to support legacy Adlib systems, older systems might need `"Ymd"` as format.
### Listing all databases in Adlib
A list of databases can be requested:
```erlang
m_adlib_api:list_databases(<<"https://foobar.adlibhosting.com/mydatabase/wwwopac.ashx">>, z:c(yoursite)).
```
This returns a list of databases:
```erlang
{ok,[#{database => <<"fullcatalogue">>,
datasource => <<"document>fullcatalogue">>},
#{database => <<"books">>,
datasource => <<"document>book">>},
#{database => <<"collect">>,
datasource => <<"document>collect">>},
#{database => <<"dublincore">>,
datasource => <<"document>resource">>},
#{database => <<"thesau">>,
datasource => <<"thesau">>}]}
```
### Fetching a single record
Records are fetched using their `priref` id.
Let `Endpoint` be a configured `#adlib_endpoint{}` then this fetches a specific record:
```erlang
m_adlib_api:fetch_record(Endpoint, 10594, z:c(yoursite)).
```
Returns:
```erlang
{ok,#{<<"@attributes">> =>
#{<<"created">> => <<"2021-05-16T15:19:38">>,
<<"modification">> => <<"2021-05-20T16:32:20">>,
<<"priref">> => <<"10594">>,<<"selected">> => <<"False">>},
<<"alternative_number">> =>
[#{<<"alternative_number">> => [<<"Carte di Castello 13">>]}],
<<"associated_subject">> =>
[#{<<"association.subject">> =>
[#{<<"value">> =>
[#{<<"@attributes">> =>
#{<<"invariant">> => <<"false">>,<<"lang">> => <<"nl-NL">>},
<<"value">> => [<<"plattegrond / kaart">>]},
#{<<"@attributes">> =>
#{<<"invariant">> => <<"false">>,<<"lang">> => <<"en-GB">>},
<<"value">> => [<<"Map/Chart/Plan">>]}]}],
<<"association.subject.latitude">> => [],
(..)
}}
```
Note that all tag names and attributes are lowercased.
If the record is not found then `{error, enoent}` is returned.
### Fetching all records since a date
For syncing the Adlib content with Zotonic there is a function to fetch all records
modified since a certain date (in UTC).
The date can be a relative date `"-1 week"`, a timestamp `1633526615`, a date
`{2021, 10, 5}`, a datetime `{{2021, 10, 5}, {12, 0, 0}}` or a string with a date
`"2021-10-05 12:00:00"`.
The `timezone` of the Adlib endpoint is used to convert the date to the date/time used
by Adlib. Adlib uses local time in their output, where the timezone depends on the
configuration of the Adlib server.
```erlang
m_adlib_api:fetch_since(Endpoint, <<"-1 month">>, z:c(yoursite)).
```
Returns:
```erlang
{ok, {List, Next}}
```
Where `List` is a list of Adlib records and `Next` is the continuation function.
`Next` can be:
- `done`
- `{next, Fun}`
The `Fun` can be called as `Fun()` and will return the next result.
The records are sorted by _priref_.
### Fetching all records
To fetch all records, pass an empty date to the `fetch_since`:
```erlang
m_adlib_api:fetch_since(Endpoint, undefined, z:c(yoursite)).
```
The records are sorted by _priref_.
## Mapping Adlib records to RDF triples.
There are basic routines to map an Adlib record to RDF statements.
### Generate an unique URI for an Adlib record
To identify a resource, an unique URI is needed. This routine generates the unique URI using
the Adlib endpoint specification and the _priref_ in the Adlib record.
```erlang
adlib_rdf:uri(Endpoint, Record).
```
Returns something like:
```erlang
{ok, <<"adlib:foobar.adlibhosting.com/mydatabase/collect/10594">>}
```
### Check if an URI matches an endpoint
To find the endpoint for an Adlib URI you can check the URI against an Endpoint:
```erlang
adlib_rdf:is_matching_uri(Endpoint, <<"adlib:foobar.adlibhosting.com/mydatabase/collect/10594">>).
```
This returns a boolean (in this case `true`).