vcs-web-hook-parse: Parse development platform web hook messages.

[ library, public-domain, web ] [ Propose Tags ] [ Report a vulnerability ]

A development platform is a server system which hosts (mostly software) projects, version controlled repositories and often provides feature like issue tracking, merge requests, project search, project wikis and more.

Some development platforms can report various events using web hooks, i.e. send HTTP requests containing structured data (e.g. JSON or XML) to a specified URL. Then you can run a server which receives these messages and reports them to IRC or a mailing list (or anything else you like).

This package collects development platform specific types, and functions which parse the HTTP message bodies into values of these types. Then an actual web hook handler can be written using them.

Why have a single package which handles the various platforms? First, because parsing some JSON or XML structures is a simple task requiring very little code (thanks to awesome Haskell libraries), sometimes hardly worth having its own dedicated package. Second, having them all here may allow sharing types and perhaps even developing some common web hook formats in the future.

This package handles only free-as-in-freedom development platforms. In particular, it means g1thub won't be supported (until it becomes free too), while support for all free platforms (DarcsDen, Gogs, Kallithea, GitLab's "community edition", etc.) is very welcome.


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.2.0.0
Change log ChangeLog
Dependencies aeson (>=0.9), base (>=4.7 && <5), bytestring, text [details]
License LicenseRef-PublicDomain
Copyright ♡ Copying is an act of love. Please copy, reuse and share.
Author fr33domlover
Maintainer fr33domlover@riseup.net
Category Web
Home page http://rel4tion.org/projects/vcs-web-hook-parse/
Bug tracker http://rel4tion.org/projects/vcs-web-hook-parse/tickets/
Source repo head: darcs get http://hub.darcs.net/fr33domlover/vcs-web-hook-parse
Uploaded by akrasner at 2016-01-27T10:51:15Z
Distributions NixOS:0.2.0.0
Downloads 1718 total (10 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-11-28 [all 2 reports]

Readme for vcs-web-hook-parse-0.2.0.0

[back to package description]

See the .cabal file for more info and link to project website the version control.

The official download location is Hackage:

http://hackage.haskell.org/package/vcs-web-hook-parse

This library is free software, and is committed to software freedom. It is released to the public domain using the CC0 Public Domain Dedication. For the boring "legal" details see the file 'COPYING'.

See the file 'INSTALL' for hints on installation. The file 'ChangeLog' explains how to see the history log of the changes done in the code. 'NEWS' provides a friendly overview of the changes for each release.