oakpubsub

A partial gcloud-node (google cloud) pubsub wrapper with bluebird promises, in functional style. Only does minimally what we need, no guarantees expressed or implied. Pull Requests for expanded functions/features are welcome.

See tests for usage.

Use care when doing mass deletes of topics or subscriptions, an incorrect regular expression could destroy data. It would be nice if google pubsub supported namespaces to avoid potential clobbering.

Tested with node v4 LTS

API Reference

oakpubsub module.

* oakpubsub
* .getPubsub(options) ⇒ Object
* .createTopic_P(pubsub, topic_title) ⇒ Promise
* [.getTopic(pubsub, topic_title, [options])](#module_oakpubsub.getTopic) ⇒ Object
* [.getOrCreateTopic_P(pubsub, topic_title, [options])](#module_oakpubsub.getOrCreateTopic_P) ⇒ Promise
* [.getSubscription(topic, subscription_id, [options])](#module_oakpubsub.getSubscription) ⇒ Object
* [.createSubscription_P(topic, subscription_id, [options])](#module_oakpubsub.createSubscription_P) ⇒ Promise
* .publish_P(topic, messages) ⇒ Promise
* .deleteTopic_P(topic) ⇒ Promise
* .deleteSubscription_P(subscription) ⇒ Promise
* .ack_P(subscription, acknowledge) ⇒ Promise
* [.pull_P(subscription, [options])](#module_oakpubsub.pull_P) ⇒ Promise
* [.makeMessage(data, [attributes])](#module_oakpubsub.makeMessage) ⇒ Object
* .pluckAcks(message) ⇒ Array.<string>
* .resetMessages(messages) ⇒ Array.<Object>
* .resetMessage(message) ⇒ Object
* [.processTopics_P(pubsub, worker_P, [query_options])](#module_oakpubsub.processTopics_P) ⇒ Promise
* [.processSubs_P(pubsub, worker_P, [query_options])](#module_oakpubsub.processSubs_P) ⇒ Promise
* [.deleteTopicsMatching_P(pubsub, regex, [page_size], [concurrency])](#module_oakpubsub.deleteTopicsMatching_P) ⇒ Promise
* [.deleteSubsMatching_P(pubsub, regex, [page_size], [concurrency])](#module_oakpubsub.deleteSubsMatching_P) ⇒ Promise

$3

Get a pubsub object, for use in subsequent module function calls

Kind: static method of oakpubsub
Returns: Object - an authenticated pubsub object from gcloud-node

| Param | Type | Description |
| --- | --- | --- |
| options | Object | passed directly to gcloud-node for i.e. authentication |

$3

Remote call to create a google pubsub topic

Kind: static method of oakpubsub
Returns: Promise - resolving to topic returned by gcloud-node pubsub#createTopic()

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| topic_title | string | the name of the topic |

$3

Get a pubsub topic, for use in subsequent module function calls

Kind: static method of oakpubsub
Returns: Object - topic returned by gcloud-node pubsub#topic()

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| topic_title | string | the name of the topic |
| [options] | Object | additional gcloud-node options |

$3

Remote call to get or create a topic

Kind: static method of oakpubsub
Returns: Promise - resolving to the topic returned by gcloud-node pubsub#createTopic()

$3

Gets a subscription

Kind: static method of oakpubsub
Returns: Object - returns a subscription from gcloud-node topic#subscription()

| Param | Type | Description |
| --- | --- | --- |
| topic | Object | gcloud-node topic object |
| subscription_id | string | the name of the subscription |
| [options] | Object | gcloud-node subscription options: autoAck, interval |

$3

Remote call to create a subscription

Kind: static method of oakpubsub
Returns: Promise - resolving to subscription returned by gcloud-node topic#subscribe()

$3

Remote call to publish a message

Kind: static method of oakpubsub
Returns: Promise - resolving to array of message ids returned by gcloud-node topic#publish()

| Param | Type | Description |
| --- | --- | --- |
| topic | Object | gcloud-node topic object |
| messages | Object | Array.<Object> | the message(s) to pass to gcloude-node topic#publish() |

$3

Remote call to delete a topic

Kind: static method of oakpubsub
Returns: Promise - resolving to apiResponse returned by gcloud-node topic#delete()

| Param | Type | Description |
| --- | --- | --- |
| topic | Object | gcloud-node topic object |

$3

Remote call to delete a subscription

Kind: static method of oakpubsub
Returns: Promise - resolving to apiResponse returned by gcloud-node subscription#delete()

| Param | Type | Description |
| --- | --- | --- |
| subscription | Object | gcloud-node subscription object |

$3

Remote call to acknowledge completion of message processing

Kind: static method of oakpubsub
Returns: Promise - resolving to apiResponse returned by gcloud-node subscription#ack()

| Param | Type | Description |
| --- | --- | --- |
| subscription | Object | gcloud-node subscription object |
| acknowledge | string | Array.<string> | IDs |

$3

Remote call to pull messages from server

Kind: static method of oakpubsub
Returns: Promise - resolving to array of messages returned by gcloud-node subscription#pull()

| Param | Type | Description |
| --- | --- | --- |
| subscription | Object | gcloud-node subscription object |
| [options] | Object | additional gcloud-node options for subscription#pull(): maxResults, returnImmediately |

$3

Utility to create a message object

Kind: static method of oakpubsub
Returns: Object - message object that can be used in publish_P()

| Param | Type | Description |
| --- | --- | --- |
| data | string | number | array | Object | to publish (gcloud-node will JSON encode/decode for you) |
| [attributes] | Object | additional key-value attributes attached to the message |

$3

Utility to pluck ackIds from messages

Kind: static method of oakpubsub
Returns: Array.<string> - array of ackIds, can be passed to ack_P()

| Param | Type | Description |
| --- | --- | --- |
| message | Object | Array.<Object> | or messages returned by pull_P() |

$3

Utility to create an array of message objects from previously pulled messages, useful for pubsub message passing

Kind: static method of oakpubsub
Returns: Array.<Object> - messages that can be used in publish_P()

| Param | Type | Description |
| --- | --- | --- |
| messages | Array.<Object> | returned by pull_P() |

$3

Utility to create a publishable message object from a previously pulled message

Kind: static method of oakpubsub
Returns: Object - message object that can be used in publish_P()

| Param | Type | Description |
| --- | --- | --- |
| message | Object | returned by pull_P() |

$3

Helper to get multiple pubsub topics and process them asynchronously

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| worker_P | Promise | function | a function or promise processing each array of topics |
| [query_options] | Object | additional gcloud-node pubsub query options for pubsub.getTopics() |

$3

Helper to get multiple pubsub subscriptions and process them asynchronously

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| worker_P | Promise | function | a function or promise processing each array of subscriptions |
| [query_options] | Object | additional gcloud-node pubsub query options for pubsub.getSubscriptions() |

$3

Helper to get delete pubsub topics matching a regular expression, using processTopics_P and deleteTopic_P

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| regex | string | javascript regular expression in string format, e.g. '^match_me' |
| [page_size] | integer | number of topics to fetch per response (default: 100) |
| [concurrency] | integer | max number of topics to delete simultaneously (default: 5) |

$3

Helper to get delete pubsub subscriptions matching a regular expression, using processSubs_P and deleteSubscription_P

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| regex | string | javascript regular expression matching subscription name in string format, e.g. '^match_me' |
| [page_size] | integer | number of subscriptions to fetch per response (default: 100) |
| [concurrency] | integer | max number of subscriptions to delete simultaneously (default: 5) |

Update Docs


doc/generate


Development
Transpile with gulp or, if using the atom editor, the atom babel package.
$3

npm testornpm run testwatchornpm test -- watch`

oakpubsub

See tests for usage.

Use care when doing mass deletes of topics or subscriptions, an incorrect regular expression could destroy data. It would be nice if google pubsub supported namespaces to avoid potential clobbering.

Tested with node v4 LTS

API Reference

oakpubsub module.

$3

Get a pubsub object, for use in subsequent module function calls

Kind: static method of oakpubsub
Returns: Object - an authenticated pubsub object from gcloud-node

| Param | Type | Description |
| --- | --- | --- |
| options | Object | passed directly to gcloud-node for i.e. authentication |

$3

Remote call to create a google pubsub topic

Kind: static method of oakpubsub
Returns: Promise - resolving to topic returned by gcloud-node pubsub#createTopic()

| Param | Type | Description |
| --- | --- | --- |
| pubsub | Object | gcloud-node pubsub object |
| topic_title | string | the name of the topic |

$3

Get a pubsub topic, for use in subsequent module function calls

Kind: static method of oakpubsub
Returns: Object - topic returned by gcloud-node pubsub#topic()

$3

Remote call to get or create a topic

Kind: static method of oakpubsub
Returns: Promise - resolving to the topic returned by gcloud-node pubsub#createTopic()

$3

Gets a subscription

Kind: static method of oakpubsub
Returns: Object - returns a subscription from gcloud-node topic#subscription()

$3

Remote call to create a subscription

Kind: static method of oakpubsub
Returns: Promise - resolving to subscription returned by gcloud-node topic#subscribe()

$3

Remote call to publish a message

Kind: static method of oakpubsub
Returns: Promise - resolving to array of message ids returned by gcloud-node topic#publish()

| Param | Type | Description |
| --- | --- | --- |
| topic | Object | gcloud-node topic object |
| messages | Object | Array.<Object> | the message(s) to pass to gcloude-node topic#publish() |

$3

Remote call to delete a topic

Kind: static method of oakpubsub
Returns: Promise - resolving to apiResponse returned by gcloud-node topic#delete()

| Param | Type | Description |
| --- | --- | --- |
| topic | Object | gcloud-node topic object |

$3

Remote call to delete a subscription

Kind: static method of oakpubsub
Returns: Promise - resolving to apiResponse returned by gcloud-node subscription#delete()

| Param | Type | Description |
| --- | --- | --- |
| subscription | Object | gcloud-node subscription object |

$3

Remote call to acknowledge completion of message processing

Kind: static method of oakpubsub
Returns: Promise - resolving to apiResponse returned by gcloud-node subscription#ack()

| Param | Type | Description |
| --- | --- | --- |
| subscription | Object | gcloud-node subscription object |
| acknowledge | string | Array.<string> | IDs |

$3

Remote call to pull messages from server

Kind: static method of oakpubsub
Returns: Promise - resolving to array of messages returned by gcloud-node subscription#pull()

$3

Utility to create a message object

Kind: static method of oakpubsub
Returns: Object - message object that can be used in publish_P()

$3

Utility to pluck ackIds from messages

Kind: static method of oakpubsub
Returns: Array.<string> - array of ackIds, can be passed to ack_P()

| Param | Type | Description |
| --- | --- | --- |
| message | Object | Array.<Object> | or messages returned by pull_P() |

$3

Utility to create an array of message objects from previously pulled messages, useful for pubsub message passing

Kind: static method of oakpubsub
Returns: Array.<Object> - messages that can be used in publish_P()

| Param | Type | Description |
| --- | --- | --- |
| messages | Array.<Object> | returned by pull_P() |

$3

Utility to create a publishable message object from a previously pulled message

Kind: static method of oakpubsub
Returns: Object - message object that can be used in publish_P()

| Param | Type | Description |
| --- | --- | --- |
| message | Object | returned by pull_P() |

$3

Helper to get multiple pubsub topics and process them asynchronously

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

$3

Helper to get multiple pubsub subscriptions and process them asynchronously

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

$3

Helper to get delete pubsub topics matching a regular expression, using processTopics_P and deleteTopic_P

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

$3

Helper to get delete pubsub subscriptions matching a regular expression, using processSubs_P and deleteSubscription_P

Kind: static method of oakpubsub
Returns: Promise - resolving to the final apiResponse

Update Docs


doc/generate


Development
Transpile with gulp or, if using the atom editor, the atom babel package.
$3

npm testornpm run testwatchornpm test -- watch`