npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hapi-notification-server

v2.0.2

Published

Hapi Push Notification Server as a plugin

Downloads

9

Readme

Hapi Notification Server

Build Status npm version Coverage Status

Hapi Notification Server is using couchbase with puffer library to register user devices and send notifications to both android and ios.

  • Source code is available at here.

How to use

You have to pass these variables to the plugin.

notification:
  host: localhost
  port: 3200
  namespace: ns
  label: notification
  templates: /Users/developer/my_project/ns_templates
  apn:
    cert: path_to_cert
    key: path_to_key
    production: true
  gcm: 1234567890

You should start a notification server in your code and also pass configuration to the notification server plugin:

server.connection { port: Number(config.server.notification.port), labels: config.server.notification.label }

db = new require('puffer')(config.database)

server.register [ { register: require('hapi-notification-server'), options: { config: config.server.notification, database: db } } ], (err) -> throw err if err

Events

This plugin will add an event bus to decouple your business logic from notification logic.

# creating an event
server.methods.ns.on 'experiences.new', (experience_key)->
  # user_doc_keys =  Your logic to find which users should get this notification
  # { "user_keys": [1, 11], "template": "events.new", "data": { "hostel": "Base Sydney", "name": "Manly BBQ" } }
  server.inject {
    url: "#{config.server.notification.host}:#{config.server.notification.port}/messages"
    payload: JSON.stringify(user_doc_keys)
  }, (res) ->

# triggering the event
server.methods.ns.emit 'experiences.new', 'ex_003'

APIs

POST /users

Payload { user_key: 'key', nid: 'notification token', device: 'android | ios' }

This is used to store user's device in notifcation server.

DELETE /users/{id}

This will delete a user's device in notifcation server.

POST /messages

Payload { user_keys: ['key1', 'key2', ...], template: 'events.new', data: { name: 'Snow trip', at: '3 days from now' } }

This will send a message to all users' devices.

Templates

Path to template folder is defined in the configuration at plugin registration time. Notification Server plugin will use that path and your template name to load android or iphone message format.

If you have your template path set to /Users/developer/my_project/ns_templates and your template name is 'events.new', Notification Server will try to laod 2 templates:

  • /Users/developer/my_project/ns_templates/events/new.android.json
  • /Users/developer/my_project/ns_templates/events/new.iphone.json

Android file should be like this (read more at https://www.npmjs.com/package/node-gcm):

{ "data": { "message": "#{hostel} created new event #{name}. Check #{name} now!" } }

iPhone file should be like this (read more at https://www.npmjs.com/package/apn):

{ "badge": 0, "sound": "buzz.aiff", "alert": "#{hostel} created new event #{name}. Check #{name} now!", "payload": { "hostel": "#{hostel}" } }