Skip to content

fixed missing content field #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
### 0.3.0
- rewrite using the request module
### 0.2.0
- Created a test script to not depend on global nodeunit
- Ensure Node 0.6.0 compatibility
Expand Down
92 changes: 53 additions & 39 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,72 @@
[![Build Status](https://secure.travis-ci.org/emerleite/node-gist.png)](http://travis-ci.org/emerleite/node-gist)
## Node.js Gist client

Node.js Gist client
===================
Gist API client for Node.JS
Gist API v3 client for Node.JS

Dependencies
------------
## Installation

### Runtime
* Node 0.4.x+
For use in your modules (adds to package.json automatically)

### Development/Tests
* mocha
*should.js
npm install -S gist

Instalation
-----------
> npm install gist
For the commandline gist

Usuage
------
var gist = require('gist');
npm install -g gist

gist.create('your gist content', function (url) {
console.log(url); //prints created gist url
});
## Usage

Running tests
-------------
### Commandline

### Unit
$ node_modules/mocha/bin/mocha test/gist.test.js
gist </path/to/file>

### Integration
$ node_modules/mocha/bin/mocha test/integration.test.js
echo "Hello World!" > ./hello.txt
gist ./hello.txt

### All tests (3 ways)
$ npm test
$ mocha (installed global)
$ node_modules/mocha/bin/mocha
### API

Note: Integration test creates real gist. Please, be carreful with this test to not flood gist.
* `gist.gists([username], fn)`
* `gist.gist(id, fn)`
* `gist([validOauthToken]).create(newGist, fn)`

To-Do
-----
(<https://github.com/emerleite/node-gist/issues>)
```javascript
var gist = require('gist')(validOAuthToken);

Author
------
// get all your gists (or all public if you didnt specify a token)
gist.gists(function(err, resp, json) {
console.log(err, json)
})

* Emerson Macedo (<http://codificando.com/>)
// get all public gists for some user
gist.gists('maxogden', function(err, resp, json) {
console.log(err, json)
})

License:
--------
// get a gist by id
gist.gist('2698151', function(err, resp, json) {
console.log(err, json)
})

// creating a new gist
var newGist = {
"description": "the description for this gist",
"public": false,
"files": {
"file1.txt": {
"content": "String file contents"
}
}
}
gist(validOauthToken).create(newGist, function(err, resp, json) {
console.log(err, json)
})
```

## Author

* Max Ogden (@maxogden)

this library was forked from Emerson Macedo (<http://codificando.com/>) and entirely rewritten

## License

(The MIT License)

Expand Down
101 changes: 101 additions & 0 deletions bin/gist.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
#!/usr/bin/env node
/*jshint strict:true node:true es5:true onevar:true laxcomma:true laxbreak:true eqeqeq:true immed:true latedef:true*/
(function () {
"use strict";

var gist = require('../')
, fs = require('fs')
, filepath = process.argv[2]
, desc = process.argv[3]
;

function usage() {
console.log('Usage: gist </path/to/file>');
}

if (!filepath) {
usage();
return;
}

fs.readFile(filepath, 'utf8', function (err, data) {
var meta
, filename = filepath.replace(/.*\//, '')
;

//filename = 'index.js';

if (err) {
usage();
return;
}

meta = {
"description": desc || ""
, "public": true
, "files": {}
};
meta.files[filename] = { content: data };

gist().create(meta, function (err, resp, json) {
if (err) {
console.error(err);
return;
}

if (json.errors) {
console.log('[DEBUG]');
console.log(JSON.stringify(meta, null, ' '));
console.log('[GIST ERROR]');
console.log(JSON.stringify(json, null, ' '));
return;
}

console.log('[gist]', json.html_url);
console.log('[raw]', json.files[filename].raw_url);
console.log('[git]', json.git_push_url);
});
});

/*
{
"git_push_url": "git@gist.github.com:3960244.git",
"user": null,
"html_url": "https://gist.github.com/3960244",
"history": [
{
"user": null,
"version": "10564662c34f251be04ac7936758e8ff6c6df4a6",
"committed_at": "2012-10-26T17:51:27Z",
"change_status": {
"additions": 1,
"total": 1,
"deletions": 0
},
"url": "https://api.github.com/gists/3960244/10564662c34f251be04ac7936758e8ff6c6df4a6"
}
],
"comments": 0,
"created_at": "2012-10-26T17:51:27Z",
"description": null,
"public": true,
"forks": [],
"updated_at": "2012-10-26T17:51:27Z",
"id": "3960244",
"url": "https://api.github.com/gists/3960244",
"files": {
"index.js": {
"type": "application/javascript",
"filename": "index.js",
"raw_url": "https://gist.github.com/raw/3960244/6b584e8ece562ebffc15d38808cd6b98fc3d97ea/index.js",
"size": 7,
"content": "content",
"language": "JavaScript"
}
},
"git_pull_url": "git://gist.github.com/3960244.git"
}
*/


}());
43 changes: 42 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
module.exports = require('./lib/gist');
var request = require('request').defaults({json: true})
var qs = require('querystring')
var _ = require('underscore')

function Gist(token) {
this.api = "https://api.github.com/"
this.token = token
}

Gist.prototype.create = function (content, cb) {
if (!content) return cb("must specify id")
var url = this.api + 'gists'
return this._request({url: url, json: content, method: "POST"}, cb)
};

Gist.prototype.gists = function (user, cb) {
if (typeof user === 'function') {
cb = user
user = false
}
var url = this.api + (user ? 'users/' + user + '/gists' : 'gists')
return this._request({url: url}, cb)
}

Gist.prototype.gist = function (id, cb) {
if (!id) return cb("must specify id")
var url = this.api + 'gists/' + id
return this._request({url: url}, cb)
}

Gist.prototype._request = function(options, cb) {
if (this.token) {
if (!options.headers) options.headers = {}
options.headers["Authorization"] = "token " + this.token
}
if (!cb) cb = function() {}
return request(options, cb)
}

module.exports = function(options) {
return new Gist(options)
}
36 changes: 0 additions & 36 deletions lib/gist.js

This file was deleted.

38 changes: 24 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
{
"name" : "gist",
"description" : "Gist api client for node.js",
"keywords" : [ "gist", "github", "api", "package.json" ],
"version" : "0.2.1",
"author" : "Emerson Macedo <emerleite@gmail.com>",
"repository" : { "type" : "git",
"url" : "git://github.com/emerleite/node-gist.git" },
"devDependencies" : {
"mocha" : "0.7.0",
"should" : "0.4.2"
{
"name": "gist",
"description": "Gist api client for node.js",
"keywords": [
"gist",
"github",
"api",
"package.json"
],
"version": "1.0.2",
"author": "Max Ogden <mogden@gmail.com>",
"repository": {
"type": "git",
"url": "git://github.com/maxogden/node-gist.git"
},
"main": "index",
"scripts" : {"test" : "node_modules/mocha/bin/mocha -R spec"},
"engines" : { "node" : ">=0.4.0" }
"bin": {
"gist": "bin/gist.js"
},
"engines": {
"node": ">=0.6.0"
},
"dependencies": {
"request": "~2.10.0",
"underscore": "~1.3.3"
}
}

42 changes: 0 additions & 42 deletions test/gist.test.js

This file was deleted.

Loading