ryantheallmighty / docker-hub-api

Docker Hub API is a API library written for NodeJS to access the official Docker Hub/Registry

Hi 👋, I'm Ryan Dowling

A full stack software engineer in Melbourne, Australia, working with the latest technologies in both the front end and back end space

• 🔭 I’m currently working on ATLauncher

• ✅ Currently available for freelance work

• 📫 How to reach me https://ryandowling.me

 

docker-hub-api's Issues

Get tag name / details by last pushed from repo

Is it possible to get the tag name that was last pushed from a private org's repo? I.E. last pushed according to DATE DESC LIMIT 1.

User account sign up

Can we use this package to create a brand new user account - set new username and password?

Cache data returns results in a different format to the first call.

I believe the issue is caused by the 'extract' logic

Attaching repo to github for builds

I am creating a Docker Helper Service that will, in addition to other things, create a private docker repo on Docker Cloud Service on the behalf of the user and build and store his image in this repo. The user will have granted OAuth access to their Github repo [contains DockerFile] to the Helper service [And not to Docker Cloud Service Repo directly].

Two questions:

1. Can I build an image without linking Docker CLoud Service repo to user's Github repo like using an S3 bucket as a source?
2. Can I connect the two repos - Docker Cloud Service and User's Github - via an API?

Fix package entrypoint.

See PR #6 .

EDIT: Apparently lib/ is also used in the tests.
Build artifacts missing in published package instead?

Move documentation to wiki

As title states, the documentation is all in the README.md and can be a bit messy to read, I wish to move it to the repositories wiki for easier reading of the README.md and the documentation.

Restructuring of the modules source

Hey Ryan,

I looked at the source of the package and felt that the structure of the code could be improved a bit.
Would you be open to suggestions or PR's to improve the structure? :)

cannot get top repositories from official user `library`

At this line: https://github.com/RyanTheAllmighty/Docker-Hub-API/blob/develop/src/api.js#L762

        /**
         * Gets the details about a repository.
         *
         * @param {String} [username] - the username of the repository to get information about. If left out or '_' is provided then it will query the official Docker repository with the given name
         * @param {String} name - the name of the repository to get information about
         * @returns {Promise}
         */
        repository: function (username, name) {
            // If no name is passed in, then the user wants an official repository
            if (username && !name) {
                name = username;
                username = 'library';
            }

            // If username is '_' then we're trying to get an official repository
            if (username === '_') {
                username = 'library';
            }

            // Make sure the username is all lowercase as per Docker Hub requirements
            username = username.toLowerCase();

            return this.makeGetRequest(`repositories/${username}/${name}`);
        },

Here:

            if (username && !name) {
                name = username;
                username = 'library';
            }

In your case, if I give dockerHubApi.repository('_'), the actual request is repositories/library/_, which is expecting error.

I think should be:

            if (!username && !name) { // here, should be, !username && !name
                name ='';
                username = 'library';
            }

Are these official APIs?

I could not find official documentation from DockerHub for these APIs. I believe you have inspected the APIs the DockerHub UI uses and implemented this library.
Am I right? If yes, then there is no official support for these APIs either. DockerHub has no official support for them and the library will break if and when they decide to change the APIs. Correct?

Docker Hub Personal Token Auth error

This is in reference to SISheogorath/readme-to-dockerhub#95

I was using his implementation of your API and when using the dockers new personal-token login it will not authenticate.

An excerpt from his code.

(node:1) UnhandledPromiseRejectionWarning: Error: {"detail":"access to the resource is forbidden with personal access token"}
    at Object.<anonymous> (/app/node_modules/docker-hub-api/src/api.js:1428:47)
    at Request.self.callback (/app/node_modules/request/request.js:185:22)
    at Request.emit (events.js:321:20)
    at Request.<anonymous> (/app/node_modules/request/request.js:1161:10)
    at Request.emit (events.js:321:20)
    at IncomingMessage.<anonymous> (/app/node_modules/request/request.js:1083:12)
    at Object.onceWrapper (events.js:427:28)
    at IncomingMessage.emit (events.js:333:22)
    at endReadableNT (_stream_readable.js:1201:12)
    at processTicksAndRejections (internal/process/task_queues.js:84:21)
(node:1) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:1) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

buildTriggerHistory and buildHistory returning Error: {"detail":"Object not found"}

createAutomatedbuild return error

Hi
I use this awesome tool for create automated build.
But when I create repository, It returns error. (Static repository great works)

I use bitbucket and use below code for create my repository, but body.details returns '{ build_tags: [ 'This field is required.' ] }'

let dockerHubAPI = require('docker-hub-api');
dockerHubAPI.login(process.env.USER_NAME, process.env.USER_PASSWD).then(function(info) {
console.log(info); //Logins OK
});

//After Log in
var details={ 'build_tags': [ { 'name': 'latest', 'source_type': 'Branch', 'source_name': 'master', 'dockerfile_location': '/' } ], 'description': 'test', 'is_private': false, 'provider': 'bitbucket', 'vcs_repo_name': 'username/repository' }; //For create basic build option
dockerHubAPI.createAutomatedBuild('myaccount', 'test', details).then(function(resolve,reject) {
console.log(reject);
console.log(resolve);
}).catch((error) => {
    console.log(error);
    error;
});

I was give build_tags and according to manual, it can void (then set default).

Is this docker-hub-api or docker-hub bug? Other wise my config fault?

saveBuildTag(...) is missing

Despite being documented in README and also available by Dockerhub API,
the method saveBuildTag(...) doesn't seem to be implemented yet.

Trigger build without creating it

It is also possible to trigger a build in Docker Hub web UI without creating it first.
This is especially useful with docker/hub-feedback#520 not resolved yet.
Otherwise the build has to be created first, triggered and then removed again.
This would also increase the Web UI feature vs API parity.

set repository description is missing is_private option.

The setrepositorydescription the api misses is_private.

Seems the DockerHub api for set repository is the same as create repository:

{
    description: 'Test',
    full_description: 'Test',
    is_private: false
}

Support for organisation teams

Does this library support operations for managing teams in a specific organization?

I can't see that in the documentation of the code, thanks

Add support for Automated Build functions

It would be great when one can access the automated build functions of Dockerhub,
like triggering builds or checking previous builds (like failed builds).

Add constants for build status

Adding constants for the build status codes to docker-hub-api
would make code more self-documentary:

[...]
if(build.status == dockerHubAPI.BUILD_STATUS_SUCCEEDED) {
[...]
if(build.status == dockerHubAPI.BUILD_STATUS_FAILED) {
[...]

Build settings is not working

dockerHubAPI.buildSettings(username, repository) is not working. It always returns

(node:36992) UnhandledPromiseRejectionWarning: Error: {"detail":"Object not found"}

[docs] Minor syntax issue

In Docker-Hub-API documentation (README file), the commas are missing
for the example object samples (Title "Passing in an object with the details:").

Delete Tags Not Working

Deleting tags is not working for me. I think the issue is that the URL isn't correct for the current Docker Hub API.

Docker-Hub-API/src/api.js

Line 629 in b00c8ad

this.makeDeleteRequest(`repositories/${username}/${name}/autobuild/tags/${id}`).then(resolve).catch(reject);

repositories/${username}/${name}/autobuild/tags/${id}

...is the URL being called. I changed it to:

repositories/${username}/${name}/tags/${id}

...and was able to get it working, but only after also changing id to be the name of the tag instead of the ID.

Hopefully this helps. Or maybe I'm the only person experiencing this issue.

Add in collaborator routes

This allows viewing, adding and removing collaborators to repositories.

Examples

https://hub.docker.com/v2/repositories/ryantheallmighty/maven-custom/collaborators/

detail response is handled as an error without checking the error value

When a request returns detail, the API returns this as an error, which isn't always the case. It should check the error value.

A response with detail typical looks like this:

{"detail": "some message", "error": false}

I think that the code that parses this should check if error is true/false before rejecting it as an error.

Looking for a maintainer

Hi all,

I no longer use this library personally anymore, and as such it's gone into disrepair.

I'd love to transfer the npm package and repo (if wanted) to someone else who uses it and would actively update and maintain the package.

Please let me know here if you're interested and how you're currently using the package so I can forward it on to someone.

Thanks