Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
gist-client
Advanced tools
Readme
A client to consume Gist API with JS. Provides some features like filtering or abstraction of resource pagination. You don't know Gist? See official Github's help.
$ npm install --save gist-client
Certain operations on Gist require authorization. Read more about how to get a granted token in 'About scopes for OAuth Apps'.
To use Gist Client you need to require it and create an instance:
const GistClient = require("gist-client")
const gistClient = new GistClient()
If you want to get your private Gist or perform some securized operation, you need to use setToken method to bind your token:
gistClient.setToken('YOUR_TOKEN') //To bind token
gistClient.unsetToken() //To remove binded token
Gist Client works with promises. For example, if you want to get a single Gist you do the following:
gistClient.getOneById('GIST_ID')
.then(response => {
console.log(response)
}).catch(err => {
console.log(err)
})
You don't need a token to get a public Gist, but if you are trying to get a private one, you need to set the token. You can do:
gistClient.setToken('YOUR_TOKEN').getOneById('GIST_ID')
Or:
gistClient.setToken('YOUR_TOKEN')
gistClient.getOneById('GIST_ID')
You can use getAll method to get a Gist list:
gistClient.setToken('YOUR_TOKEN').getAll() //List the authenticated user's gists
gistClient.getAll() //List all public gists (Max. 3000 -an API limitation-)
Results can be iterated without worrying about pagination:
gistClient.setToken('YOUR_TOKEN').getAll().then((gistList) => {
gistList.forEach((gist) => {
console.log(gist)
})
})
Gist Client allows you to filter results. You can append filters, it will be applied with 'AND' criteria.
gistClient.setToken('YOUR_TOKEN').getAll({filterBy: [
{public: true},
{since: '2017-01-02T12:10:51Z'},
{language: 'PHP'}
]})
This call will be return all user's public gists in PHP that have been updated since given date.
There is a limited list of filters that can be applied to a result:
Filter | Tier | Type | Notes |
---|---|---|---|
since | global | string | A timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned. |
userName | resource | string | Name of the user whose documents you want to list. |
starred | resource | bool | Starred gists. |
public | resource | bool | Public gists. |
filename | file | string | Complete file name, f.ex: doc.json, index.sh... It doesn`t filter files inside a gist. It just filter all gists that contains a file with given name. |
size | file | int | File size in Kb. |
raw_url | file | string | Url to file's raw content. |
type | file | string | text/plain, application/json... |
language | file | string | PHP, Javascript, Erlang, Java... |
truncated | file | bool | The Gist API provides up to one megabyte of content for each file in the gist. Each file returned for a gist through the API has a key called truncated. If truncated is true, the file is too large and only a portion of the contents were returned in content. |
content | file | string | File content. IMPORTANT: You must to activate option rawContent to use this filter. |
Gist API hides the content of the files in lists to decrease payload. Gist Client provides an option to bind the content in list; rawContent (true|false). You can use it as follow:
gistClient.getAll({rawContent: true}) //false as default
IMPORTANT: Be careful with the preceding call. Using this option in combination with 'filterBy' is highly recommended to limit the total amount of requests to Gist API. Keep in mind that there were an aditional API call for each retrieved file. It can rebase your remaining rate limit on Github API.
gistClient.setToken('YOUR_TOKEN').getRevision('GIST_ID', 'VERSION_SHA') //Returns a promise
gistClient.setToken('YOUR_TOKEN').getCommits('GIST_ID') //Returns a promise
gistClient.setToken('YOUR_TOKEN').getForks('GIST_ID') //Returns a promise
gistClient.setToken('YOUR_TOKEN').isStarred('GIST_ID') //Returns true if gist is starred
//These methods return true if operation is done
gistClient.setToken('YOUR_TOKEN').star('GIST_ID') //Mark a gist as starred
gistClient.setToken('YOUR_TOKEN').unstar('GIST_ID') //Mark a gist as unstarred
To create a new gist you can use 'create' method as follow:
gistClient.setToken('YOUR_TOKEN').create({
"files": [{
"x.txt": {
"content": "xx"
}
}],
"description": "desc",
"public": true
}).then(newGist => {
console.log(newGist)
})
To edit a gist you can use 'update' metod:
gistClient.setToken('YOUR_TOKEN').update('GIST_ID', {description: 'new description'})
gistClient.setToken('YOUR_TOKEN').delete('GIST_ID') //Returns true if gist has been removed
If you need information about Gist API, you can see official documentation.
FAQs
A client to consume Gist API with JS
The npm package gist-client receives a total of 24 weekly downloads. As such, gist-client popularity was classified as not popular.
We found that gist-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.