audriga/jmap-icalendar_vcard

Converts between iCalendar and JSCalendar or between vCard and JSContact

0.5.0 2024-01-11 12:55 UTC

Requires

• php: >=5.6
• audriga/jmap-openxport: ~1
• sabre/vobject: >=4.2

Requires (Dev)

• phpunit/phpunit: >=9
• squizlabs/php_codesniffer: >=3

MIT

• Stanimir Bozhilov
• Joris Baum

• groupware
• jmap

README

The JMAP iCalendar/vCard library extends openxport-jmap with the ability to convert between iCalendar and JSCalendar as well as vCard and JSContact.

It should be simple for consumers to migrate from another service to your service and vice versa. OpenXPort makes it easy to expose a RESTful API Endpoint for data portability. It is built on top of the interoperable protocol JMAP, which already supports a wide variety of data types and can be extended for more.

This library currently aims to implement the following specifications:

• JSCalendar: Converting from and to iCalendar draft-ietf-calext-jscalendar-icalendar
• JSContact: Converting from and to vCard draft-ietf-calext-jscontact-vcard

OpenXPort is built with compatibility for older systems in mind. We support all PHP versions down to 5.6 to provide data portability even for older systems.

Installation

Local installation

1. Run make to initialize the project. It uses your local PHP version with most current dependencies (currently PHP 8.2). Use other build targets (e.g. make php70_mode) instead, in case you need to build for a different version.

Usage

Standalone

Will be supported in a future version.

Usage in openxport-jmap

This library provides Adapters and Mappers specific to openxport-jmap. There are different versions of adapters and mappers to choose from:

• Those aiming to be fully compliant with above's IETF specs (e.g. JSCalendarICalendarAdapter)
• System-specific adaptions to the conversion (e.g. NextcloudJSContactVCardAdapter)

They can be included in OpenXPort projects the usual way:

$adapters = array(
    "Cards" => new \OpenXPort\Adapter\NextcloudJSContactVCardAdapter()
...
$mappers = array(
    "Cards" => new \OpenXPort\Mapper\JSContactVCardMapper(),
...

Development

Installation

1. Run make or one of the targets for old PHP versions above.
2. Run make update to update dependencies and make development tools available

Tests

To run all tests run make fulltest. This requires Podman (for Static Analysis).

You can also run them separately:

• Static Analysis via make lint
• Unit Tests via make unit_test