KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

activity-streams-mongoose

★ 126 Open GitHub ↗

Activity Streams Real-Time Data Store backed by MongoDB(via Mongoose) and Redis

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![build status](https://secure.travis-ci.org/ciberch/activity-streams-mongoose.png)](http://travis-ci.org/ciberch/activity-streams-mongoose)

Author: Monica Wilkinson
Copyright (c) 2012 VMware, Inc

## Overview

Activity Streams is a simple specification used to describe social actions around the web. http://activitystrea.ms

This library provides the following Activity Stream Models on Mongoose:

* ActivityObject
* Activity

For details on the properties each see pne of the following specifications:

* http://activitystrea.ms/specs/json/1.0/
* http://opensocial-resources.googlecode.com/svn/spec/2.0/Social-Data.xml#ActivityEntry

## Usage

### Implicit

```javascript
var streamLib = require('activity-streams-mongoose')(options);

// Here you can extend the schemas with any plugins
streamLib.types.UserSchema.plugin(function(schema, options) {
    schema.add({ lastMod: {type: Date, default: date}});
});

var asmsDB = new streamLib.DB(streamLib.db, streamLib.types);
```

### Or explicit if you need a Mongoose reference in your calling code

```javascript
var mongoose = require('mongoose');
mongoose.connect(siteConf.mongoUrl);
var streamLib = require('activity-streams-mongoose')(mongoose, options);
var asmsDB = new streamLib.DB(streamLib.db, streamLib.types);
```

### Options

- mongoUrl --> If you want to let `activity-streams-mongoose` manage Mongoose for you, just pass the url for the MongoDB.
Example format is `mongodb://localhost/mongodb-asms`

- redis --> Hash including keys specifying connection properties
  - host
  - port
  - pass
  - database

Redis is required to be able to publish activities and subscribe to Activity Streams

### To create an activity object you can do

```javascript
var cf = new asmsDB.ActivityObject({displayName: "Cloud Foundry" , url: "http://www.cloudfoundry.com"});
cf.save(function (err) {
    //...
    }
});

```

### To create an activity with an associated activity object you can do

```javascript

var testAct = new asmsDB.Activity({title: "Started the app", target: target._id});
testAct.save(function (err) {
    //...
});

```

### To query the Activity Streams do

Asking for the latest 5 from stream "sfgiants"

```javascript
asmsDB.Activity.getStream("sfgiants", 5, function (err, docs) {
   docs.forEach(function(doc){console.log(doc);});
});

```

Asking for the latest 5 from firehose

```javascript
asmsDB.Activity.getFirehose(5, function (err, docs) {
   docs.forEach(function(doc){console.log(doc);});
});

```

### To publish an activity you can do

```javascript

var testAct = new asmsDB.Activity({title: "Started the app", target: target._id});
testAct.publish('cloudfoundry-stream');

```

Note: This will save the activity and then publish it to the stream name

### To subscribe to an Activity Stream do

```javascript
var clientSendFx =  function(channel, json) {
            io.sockets.in(client.handshake.sid).send(json);
        }

asmsDB.Activity.subscribe('cloudfoundry-stream', clientSendFx);
```

### To close the Activity Stream DB connections (MongoDB and Redis)

```javascript
asmsDB.close();
```

## To run tests

- Start MongoDB
- Start Redis

``` bash
npm test
```

## License

Apache License

See LICENSE file for more details

activity-streams-mongoose

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README