Skip to content

sahilsk/Gitlab-YAAC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gitlab-YAAC( Yet Another Api Client)

Gitlab api client with more control over server response

WORK-IN-PROGRESS: PLEASE DO NOT USE THIS UNFINISHED PROJECTT UNTIL YOU STOPPED SEEING THIS MESSAGE.

Motivation

Why one more gitlab api client? Though other project works and return the result as expected but due to poor implementation, less or no control over server response and few other reasons, didn't scale them well. Design differences also makes this project different. In the end i need this for my current project.

Features

  • asynchronous calls i.e no blocking
  • fetches server response as well
  • standard callback function argumnets: function( error, response, result){ ... }
  • use what you need. eg. require('gitlab-yaac/users'); and you'll get users endpoints available only

Example

var Users= require("gitlb-yaac/users");

//** Create new gitlab client
var gUsers = new Users({
  url:   'http://example.com',
  token: 'abcdefghij123456',
  admin: true
});

/** List Users
* @params {Object} optn Option
* @params { Function} callback Callback
*/
gUsers.find(opts, function(err, response, results){
  if(err){
    //handle error
  }else{
    console.log( result);
  }
});

// find all users
gUsers.find( function(err,response, results){})
...

//search for users by email or username with: /users?search=John
gUsers.find("john", function(err, response,results){ });

...
//find user by id
gUsers.find(4, function(err, response,result){ 
	if( response.statusCode !== 404 ){
		console.log("user found: ", result);
	}
}
});

API

GitLab API

NOTE: Not all resources are implemented yet. Only highlighted ones are currently implemented.

Resources

  • Users
  • Session
  • Projects
  • Project Snippets
  • Repositories
  • Repository Files
  • Commits
  • Branches
  • Merge Requests
  • Issues
  • Labels
  • Milestones
  • Notes (comments)
  • Deploy Keys
  • System Hooks
  • Groups

References

Roadmap

  • TLS/SSL Protocol support

About

Gitlab api client with more control over server response

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published