0.2.0 • Published 14 years ago

appdotnet

Licence

—

Version

0.2.0

Deps

Vulns

Weekly

DeprecatedThis package is deprecated

Summary Dependency Versions

appdotnet v0.2.0

A wrapper for the app.net http stream api, following node idioms.

Current State

app.net's api is not yet stable and is incomplete. Right now, this module supports all working parts of the official api (auth, user and post).

See https://github.com/appdotnet/api-spec for the state of the official api.

Developers

Please make sure to include unit tests, if you want to contribute to this project.

To run the unit tests, there are several steps to do:

get an app.net access token with scope=stream%20email%20write_post%20follow%20messages%20export
move config.example.json to config.json and insert access token
just type npm test

All tests run against the official app.net api, so be sure to have an internet connection. When tests are timing out, try to increase the scripts.test -> --timeout value in package.json.

Running this tests will result in automatic post creation, operation and deletion. If you dislike this, be sure to remove the unit tests for object.createPost() and object.deletePost(). Those tests will mute and unmute one user as well, but you remove this line as well (object.muteUser() and object.unmuteUser()).

var params = {
  client_id: '9ah9has9hsaf9hasf9hfsa9hfsa9hsafhhasoh',
  redirect_uri: 'http://localhost:3000/cb',
  scope: 'export write_post'
};

var expectedUri = AppDotNet.authHost
                + '/oauth/authenticate'
                + '?client_id=9ah9has9hsaf9hasf9hfsa9hfsa9hsafhhasoh'
                + '&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fcb'
                + '&scope=export%20write_post'
                + '&response_type=code';

AppDotNet.createAuthenticationUri(params).should.equal(expectedUri);

object.getUser()

returns a user object.

client.getUser(config.user_id, function (err, user) {
  should.exist(user);
  should.not.exist(err);
  done();
});

object.followUser()

returns a user object.

client.followUser(config.user_id, function (err, user) {
  should.exist(user);
  should.not.exist(err);
  done();
});

object.unfollowUser()

returns a user object.

client.unfollowUser(config.user_id, function (err, user) {
  should.exist(user);
  should.not.exist(err);
  done();
});

object.listFollowing()

returns an error when not authorized.

errorClient.listFollowing(config.user_id, function (err, users) {
  should.not.exist(users);
  should.exist(err);
  done();
});

object.listFollowers()

returns an error when not authorized.

errorClient.listFollowers(config.user_id, function (err, users) {
  should.not.exist(users);
  should.exist(err);
  done();
});

object.muteUser()

returns a user object.

client.muteUser(config.user_id, function (err, user) {
  should.exist(user);
  should.not.exist(err);
  done();
});

object.unmuteUser()

returns a user object.

client.unmuteUser(config.user_id, function (err, user) {
  should.exist(user);
  should.not.exist(err);
  done();
});

object.listMutedUsers()

returns user objects.

client.listMutedUsers(config.user_id, function (err, users) {
  should.exist(users);
  should.not.exist(err);
  done();
});

object.checkToken()

returns an auth object.

client.checkToken(function (err, auth) {
  should.exist(auth);
  should.not.exist(err);
  done();
});

object.createPost()

returns a post object.

client.createPost(config.post_data, function (err, post) {
  // save this for later use
  savedPostId = post.id;

  should.exist(post);
  should.not.exist(err);
  done();
});

object.retrievePost()

returns a post object.

client.retrievePost(savedPostId, function (err, post) {
  should.exist(post);
  should.not.exist(err);
  done();
});

object.retrievePostReplies()

returns post objects.

client.retrievePostReplies(savedPostId, {}, function (err, posts) {
  should.exist(posts);
  should.not.exist(err);
  done();
});

object.deletePost()

returns a post object.

client.deletePost(savedPostId, function (err, post) {
  should.exist(post);
  should.not.exist(err);
  done();
});

object.retrieveCreatedPosts()

returns post objects.

client.retrieveCreatedPosts(config.user_id, {}, function (err, posts) {
  should.exist(posts);
  should.not.exist(err);
  done();
});

object.retrieveMentions()

returns post objects.

client.retrieveMentions(config.user_id, {}, function (err, posts) {
  should.exist(posts);
  should.not.exist(err);
  done();
});

object.retrievePersonalStream()

returns post objects.

client.retrievePersonalStream({}, function (err, posts) {
  should.exist(posts);
  should.not.exist(err);
  done();
});

object.retrieveGlobalStream()

returns post objects.

client.retrieveGlobalStream({}, function (err, posts) {
  should.exist(posts);
  should.not.exist(err);
  done();
});

object.retrieveTaggedPosts()

returns post objects.

client.retrieveTaggedPosts(config.tag, {}, function (err, posts) {
  should.exist(posts);
  should.not.exist(err);
  done();
});

String token valid app.net access token

Return:

Object new object

String token valid app.net access token

Return:

Object new object

AppDotNet.createAuthenticationUri(params)

Create a valid authentication uri with params.