ravelry

🧣 Ravelry API

A way to make calls to all of the endpoints offered by the Ravelry API.

Every endpoint is being testing to match the Ravelry API documentation. When this process is complete the library will be released as V1. As these tests are written, the documentation will come along with it. Currently 1/41 method groups are complete. This testing does not include testing the action endpoint (coming later), but just that it matches documentation.

Please reach out if you'd like to help with either. 😄

---

Getting Started

Setting it up is easy! Once you have all of your information from Ravelry, put it into the package's factory function depending on your authorization type.

Basic Authorization

Basic authorization is used for accessing the Ravelry's API endpoints that don't need authorization as well as your personal account's data. If that's all you need, you're good to go from here.

var Ravelry = require('ravelry');
var rav = Ravelry.basic({
  ravAccessKey: xxxxxxxxxx, // also called Username in Ravelry Pro
  ravPersonalKey: xxxxxxxxxx
});

See the examples folder for a more fleshed out example of basic auth.

OAuth1.0a

To have other users sign into your app there is a little more work to do because of the OAuth framework.

var Ravelry = require('ravelry');
var rav = new Ravelry({
  ravAccessKey: xxxxxxxxxx,
  ravSecretKey: xxxxxxxxxx,
  callbackUrl: 'http://localhost:3000/successful-log-in' // The path to be redirected to successfully logging into Ravelry
}, [
  'forum-write', 'message-write' // Permissions scope variables
]);

Custom authorization

1. rav.signInUrl(): When your user is not logged in you first need to get the sign-in url for them. This method, as a promise returns the url, and as a callback returns the error as the first argument and the url as the second. You can decide from here how to direct your user to this url. From there, if they're already logged into Ravelry they will just have to authenticate your app. If they're not, they'll have to log in to authenticate your app.
2. callbackUrl: Once the user has been properly authenticated a GET request will be made to the supplied callbackUrl. Note: It seems that the Ravelry API does not support OAuth out of band (oob) support which is why a callback url is required.
3. rav.authorize(url): Set up is completed by calling the authorize method with the current url and its query params. This method will request the user's info from Ravelry, and return it if successful. From this point, you can also access the user's info at rav.user.

See the examples folder for a more detailed OAuth1.0 example using a simple http server.

OAuth Express middleware

If you're running an Express app and using Oauth1.0a, there is a middleware that can do the above and a bit more for you automatically. It is a method on the same object created from the Ravelry factory function and it is used like this:

app.use(rav.authorizationMiddleware({resume: true}));

The method requires an options object with these properties:

redirect (String, optional, default: "/") - This is the path to redirect to once the user has been authenticated in. It is required to supply this option or set resume to true. resume (Boolean, optional, default: false) - If true, the middleware will save the path that was requested before the middleware kicked in and let the user resume there after authenticating. If true, this will override the redirect property. ignorePaths ([String], optional, default: []) - You can supply an array of paths for the middleware to ignore like '/sign-in'.

See the examples folder for a more detailed example using Express and the OAuth1.0a middleware.

OAuth2.0

Ravelry has started offering OAuth2.0 support since the creation of this package. It is not currently supported by this package, but it is a plan to do so.

---

The methods

Every endpoint in the Ravelry API Documentation is available in this API client. Documentation for each can be found in their respective folders in src/methods.

Endpoints

The methods are named the same way as the endpoint title is in the documentation except camel-cased:

/favorites/list -> rav.favorites.list()

/messages/mark_read -> rav.messages.markRead()

Arguments

When the endpoint requires them, arguments must be supplied in the below order. If an argument is not necessary it may be omitted.

rav.someMethod(username, id, params, callback);

• username - (type: String) If the request is for the authenticated user, this argument may be omitted. Request for other users' information is only available for GET requests. Ex: rav.favorites.list('sfrieson')

• id - (type: Number) Id of requested item. Ex: rav.messages.show(22237804)

• params - (type: Object) Either url queries for GET requests or the body content of a POST/PUT request. Ex: comments.create({type: "pattern", commented_id:573, body: "Wow! What a wonderful pattern!"})

• callback - (type: Function) Not required, but the callback function always should be supplied last. It will always send the err as the first argument and the data as the second. See next section for more about callbacks

Responses

All methods support both callback and Promise style responses.

Callback style

rav.colorFamilies(function (err, response) {
  // Do something
});

Promise style

rav.colorFamilies()
.then(function (response) {})
.catch(function (err) {});

Please stay tuned for further documentation...

Help is appreciated.