Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Pebble is a tool for publishing real time event streams from sources such as IRC, Twitter and the like.

tree: 18cb14d5ca

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 public
Octocat-spinner-32 src
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Cakefile
Octocat-spinner-32 README.md
Octocat-spinner-32 config.example.json
Octocat-spinner-32 package.json
README.md

Pebble

Pebble is real time event streams / pub sub done simply.

  • Cleaner in terms of code
  • Simpler to run (One process, versus many)
  • Easy to extend (based on a simple publisher model)

With the whole goal of making real time event streams (pulling events from external sources) as simple as possible.

Originally built for Rails Rumble 2010 like I built prior versions for earlier rumbles.

Getting Started

First, make sure you have node.js and npm installed.

Writing a Publisher

Publishers are just the general idea of a configurable item which can push things to the notifications list. For example, to implement a simple publisher, you can do (in CoffeeScript):

Base = require('pebble/base).Base

class MyPublisher extends Base
  name: "my-publisher"

  setup: ->
    # Called automatically.
    stored_name = @get "name" # gets name in the my-publisher key in the configuration
    setInterval((=>
      @emit some: "data"
    ), 10000)

You define a setup method that starts doing processing, configure a name (and optionally, namespace for events and configNamespace for the configuration json namespace). This simple yet flexible architecture makes it possible to build a wide variety of publishers.

Configuration

Pebble uses a standard config.json file which uses nested keys according to:

  • Pebble Settings (pebble)
  • Redis settings (redis)
  • Publisher settings (either the publisher name or the configNamespace value on a given publisher).

An example of this can be seen in the config.example.json file which contains all options. Please note that most options are optional.

Lastly, in the case of the following, they can also be overridden by an environment variable:

  • pebble.listen.host (by HOST)
  • pebble.listen.port (by PORT)
  • pebble.redis.host (by REDIS_HOST)
  • pebble.redis.port (by REDIS_HOST)
  • pebble.redis.password (by REDIS_PASSWORD)
  • pebble.redis.maxHistory (by REDIS_MAXHISTORY)

The Public JavasScript Portion

Please note the public portion can be found in public/ and that your application uses Pebble. It'd be pretty simple to port it to use something other than jQuery but that is left as an exercise for the reader.

Developing Pebble

To develop pebble, you'll also need to install coffee-script via:

npm install coffee-script

Next, to compile the javascript, you can run:

cake build
Something went wrong with that request. Please try again.