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

koop-provider

v1.0.0

Published

Koop provider toolkit

Downloads

12

Readme

koop-provider

Koop provider toolkit

npm travis

Use this to create a provider module for Koop.

Install

npm install -S koop-provider

Usage

Provides methods for creating koop providers, models, and controllers.

provider(options)

To create a koop provider:

var pkg = require('./package')
var provider = require('koop-provider')

var myProvider = provider({
  name: 'providerName',
  version: pkg.version,
  model: require('./model'),
  controller: require('./controller'),
  routes: require('./routes')
})

module.exports = myProvider

A type of 'provider' is automatically set (cannot be overridden).

Required settings:

  • name: provider name
  • version: provider version (from package.json)
  • model: provider model method
  • controller: provider controller method
  • routes: provider routes module

Optional settings:

  • hosts: boolean flag indicating whether or not this provider supports multiple instances (e.g. socrata data can be hosted in many socrata instances, github gist data is always on gist.github.com)

provider.model(koop)

To create a model:

var provider = require('koop-provider')

/**
 * creates new model with access to koop instance
 *
 * @param {Object} koop - instance of koop app
 */
function myModel (koop) {
  var model = provider.model(koop)
  var TABLE_NAME = 'my_table'

  model.config = koop.config

  // model methods, e.g.

  /**
   * Method for retrieving data by ID.
   *
   * @param {object} options - id (required), query (optional)
   * @param {function} callback - err, geojson
   */
  model.find = function (options, callback) {
    var id = options.id
    var query = options.query || {}

    koop.Cache.get(TABLE_NAME, id, query, function (err, entry) {
      if (!err) return callback(null, entry)

      // retrieve data, insert into cache, fire callback with `(err, geojson)`
    })
  }

  return model
}

module.exports = myModel

Methods inherited from base model:

  • log
  • files
  • cacheDir
  • exportToFormat
  • exportLarge
  • exportFile
  • finishExport
  • parseSpatialReference
  • tileGet
  • plugin
  • generateThumbnail
  • getImageServiceTile
  • getServiceTile
  • getGeoHash
  • saveFile
  • getCount
  • getExtent

provider.controller()

To create a controller:

var provider = require('koop-provider')

/**
 * creates new controller
 *
 * @param {object} model - instance of model
 */
function myController (model) {
  var ctrl = provider.controller()

  // controller methods, e.g.

  /**
   * renders index view
   *
   * @param {object} req - incoming request object
   * @param {object} res - outgoing response object
   */
  ctrl.index = function (req, res) {
    res.render(__dirname + '/../views/index', {
      baseUrl: req.baseUrl
    })
  }

  return ctrl
}

module.exports = myController

Methods inherited from base controller:

  • errorResponse
  • processFeatureServer

Routes

The routes file in a koop provider maps http verbs and routes to controller methods.

Example from koop-gist:

module.exports = {
  'get /gist': 'index',
  'get /gist/rate_limit': 'rate_limit',
  'get /gist/raw/:id': 'find',
  'get /gist/raw/:id/:layer': 'find',
  'get /gist/:id': 'find',
  'get /gist/:id.:format': 'find',
  'get /gist/:id/preview': 'preview',
  'get /gist/:id/FeatureServer': 'featureservice',
  'get /gist/:id/FeatureServer/:layer': 'featureservice',
  'get /gist/:id/FeatureServer/:layer/:method': 'featureservice'
}

Test

koop-provider uses tape for testing.

npm test

License

Apache 2.0