Light

owickstrom / websub Goto Github PK

View Code? Open in Web Editor NEW

3.0 6.0 0.0 149 KB

A WebSub client for Haskell

License: Mozilla Public License 2.0

Makefile 1.25% Haskell 98.75%

haskell websub http web pubsubhubbub

websub's Introduction

WebSub

A WebSub client for Haskell

Overview

This library is a work in progress! The plan is to provide an easy-to-use interface for subscribing to WebSub topics in Haskell web applications. Basic subscription works, and an example application can be found in app/Main.hs.

Subscription

The following diagram shows how the subscription can change state.

Contributing

I've just started hacking on this, so if you're interested in helping out or giving feedback, post an issue and we'll take it from there.

Code Style

This project uses hindent to do consistent formatting. You can run hindent on all source files like so:

make indent

License

Mozilla Public License v2.0.

websub's People

Contributors

Stargazers

Watchers

websub's Issues

Subscription denial

The hub should be able to deny the subscription by sending a GET request, see Subscription Validation.

Renewal

To avoid the the subscription expiring (see #7), users should be able to periodially renew the subscription. Perhaps the library can take care of this itself, even.

Generate random subscription IDs

Right now everything's "foo"

Content distribution

Content distributed through a callback, as described in Content Distribution, should be sent on the appropriate subscriber channel.

Unsubscribe

Secret and signature for authenticated content distribution

Pass hub.secret and verify X-Hub-Signature header, as described in Authenticated Content Distribution.

A thing to note here is that the body passed to the ContentDistributionCallback is a lazy ByteString. Calculating the hash for it might have to be a responsibility of the user, if it is not possible to do that in a streaming way without converting it to a strict Bytestring.

Timeout subscription

Based on lease_seconds from the hub, this library should set a timer to expire the subscription locally. Perhaps some notification to the user of the library would be nice, but not sure how that fits in with the current design.

Subscription verification

The hub must be able to verify the subscription by sending a GET request to the callback URI. See Hub Verifies Intent of the Subscriber.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.