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

service-routes

v0.1.1-1

Published

A special route service syntax parsing module, for node.

Downloads

13

Readme

service-routes

Build Status

A special route service syntax parsing module, for node.

Install

$ npm install service-routes

Test

Any of the following:

$ mocha
$ npm test
$ make test

API

routes.parse(data)

Parses routes out of the given string.

routes.load(filename, callback)

Loads the routes from the given file.

routes.loadSync(filename)

Synchronously loads the routes from the given file.

Route Format

A set of parsed routes is an array of objects like the following:

[{ Route
  // the http method, poorly named
  http: 'delete',
  path: '/v1/users',
  service: 'user-service',
  method: 'deleteAccount',
  access: {
    special: {anon: false, self: true},
    permissions: {'admin.ultra': true}
  }
}]

Source:

with user-service
  deny anon
  allow self or admin.ultra
    DELETE /v1/users -> deleteAccount

Syntax

Example

OPTIONS /somewhere -> first-service aMethod

with service-name
  GET /my/route -> getObject
  PUT /my/route -> createObject
  PUT /my/route/:id -> createObject
  POST /my/route -> createObject
  deny anon
    DELETE /my/route -> deleteObject

Directives

<method> <route>

Defines a http method and route. The method must be all-caps.

GET /v1/route
PUT /v2/update

with <service>

Scope sections of routes with the with keyword (alias: direct or target). A scope directive currently overrides the previous scope directive, and will fill in the service argument of the assignment operator if not specified.

with name
  GET /v1/place -> method

allow <permission|special> (or <permission|special>)*

Allow a given permission or special access type access to all routes starting on this line until the next reset directive (alias: permit).

Special access types:

  • self (assumes the user parameter is the user id, allows access if the accessing user is the user in the parameter)
  • anon (specifies users which are not authenticated, default behavior if not specified undefined)

Anon (implicitly allows everyone):

allow anon
  GET /v1/public -> service method

Arbitrary permission (implicity disallows all else):

allow admin
  GET /v1/dashboard -> dashboard show

deny <permission|special> (or <permission|special>)*

Deny a given permission or special access type access to all routes starting on this line until the next reset directive (alias: restrict).

access reset

Resets access controls from this line onward (alias: reset access).

Operators

<route> -> [<service>] <method>

The assignment operator, assigns a route to a service's method. If service is not specified, uses the service from the last scope.

Identifiers

Route

A route identifier must begin with a /, and must not contain whitespace. Regular expression support coming soon.

Permission

A permission identifier is defined as an alphabetic character, an underscore, a dash or a dollars-sign, followed by more of the same or a digit.

Service/Method

A service or method identifier uses the same definition as a permission identifier.

Notes

  • The syntax is intended to be whitespace-significant, but that is not yet implemented.
  • Comments are not yet implemented.

License

The MIT License (MIT)

Copyright © 2013 GlobeSherpa

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.