shred

A resource-oriented JavaScript HTTP client.

Overview

Shred is an HTTP client that wraps HTTP interfaces so you can easily create CoffeeScript or JavaScript clients.

Define your client:

github = resource "https://api.github.com/",
  repo: (resource) ->
    resource "repos/{owner}/{repo}/",
      issues: (resource) ->
        resource "issues",
          create:
            method: "post"
            headers:
              accept: "application/vnd.github.v3.raw+json"
            expect: 201
          list:
            method: "get"
            headers:
              accept: "application/vnd.github.v3.raw+json"
            expect: 200

And then use it:

try
  {data} = yield github
    .repo {ownerrepo}
    .issues
    .list()
  console.log numbertitle for {numbertitle} in (yield data)
catch error
  console.error error
npm install shred

We've built a simple issue manager CLI to show how to use Shred to wrap an API like GitHub's.

  1. Change to the examples/github directory.
cd examples/github
  1. List the issues in the Shred repo.
coffee --nodejs --harmony cli.coffee list -o pandastrike -r shred
  1. If you want to create issues using the CLI, add a GitHub API token.
cat >> .token
paste your token here
^D
  1. Create a new issue.
coffee --nodejs --harmony cli.coffee create -o pandastrike -r shred -t 'My Ticket Title' -b "My ticket's body"

Shred 1.0.x is a complete reboot of the project. The goal is the same, but the interface has changed drastically. Shred 1.0.x is not backwards compatible with earlier versions.

Shred is presently alpha quality code, as designated by the version suffix.

HTTP is a rich protocol, but the low-level details of setting headers and checking response codes muck up our code. So we either ignore these nuances or write wrapper functions to hide the details.

Shred makes it easy to declaratively create API wrapper functions. Shred also features support for URL templates, response compression, authorization, and streaming responses. And more features are coming soon!

  • resource: Define a resource. Takes a URL, path, or URL template, and an interface declaration.

Interface definitions are an object whose properties define subresources or request methods on the resource being defined.

If a property contains an object, it will be defined as a request method described the object.

If it contains a function, the property will define a subresource for which the function is the initializer.

Request method descriptions can include three properties:

  • method: The HTTP method used to make the request, ex: GET, PUT.

  • headers: An object describing the HTTP headers to send with the request, ex: content-type, accept.

  • expect: The expected HTTP status code, ex: 200. Other status codes will be treated as errors.

The signature for resource initializers is:

(resource) ->

The resource function passed into the initializer functions works just as the resource exported by Shred. You can use it to define the subresource.

Typically, you'll want to use paths or template URLs to define subresources, which will be concatenated with the parent resources' URLs.

Subresources defined using URL templates will be functions, allowing you to pass in an object whose key-value pairs will instantiate the template.

When you invoke a Shred request functions, you get back a response context. This contains both the HTTP response object and a data object. The data object is a promise that resolves when the response body is finished streaming. If the content-type appears to be JSON-based, Shred will parse the response body as JSON and return an object, otherwise, it will return a string.

You can explicit invoke Shred request functions using the invoke command. This is particularly useful when using helper functions defined on the request function, such as authorize.

You can use the authorization method defined on request functions to pass authorization information into the request. The authorization function takes a object describing the authorization scheme. Currently, basic and bearer are supported.

try
  yield github
    .repo {ownerrepo}
    .issues
    .create
    .authorize basic: {username: tokenpassword: ""}
    .invoke {titlebody}