Migrate to the GitHub GraphQL API (v4)

Author: Axel Rindle

lib/main.coffee

@@ -1,10 +1,17 @@
-# require npm modules
-got = require 'got'
+# Require modules
+graphql = require 'github-graphql-client'
 chalk = require 'chalk'
 semver = require 'semver'
+query = require './query'
 
-baseApiUrl = 'https://api.github.com/repos/REPO/releases'
+###
+  The exported checking function.
 
+  @param options {object} The options for the version check.
+  @param callback {function|undefined} An optional callback to pass the result to.
+                                       Can be omitted to return a Promise.
+  @return undefined or a Promise.
+###
 module.exports = (options, callback) ->
   if callback
     check options, callback
@@ -14,42 +21,49 @@ module.exports = (options, callback) ->
         reject error if error
         if update then resolve update else resolve null
 
+###
+  The actual checking function. Executes a GraphQL query on the API to fetch
+  either the latest release or tag. The returned version is compared to the given
+  version. When to fetched version is greated than the given one, the newer version
+  is returned.
+
+  @param options {object} The options for the version check.
+  @param callback {function|undefined} An optional callback to pass the result to.
+                                       Can be omitted to return a Promise.
+###
 check = (options, callback) ->
   # get options
+  token = options.token
   repo = options.repo
+  owner = options.owner
   currentVersion = options.currentVersion
-  includePreReleases = options.includePreReleases || false
+  fetchTags = options.fetchTags || false
 
   # check if required options are defined
+  callback(null, 'no token specified') if token is undefined
   callback(null, 'no repository specified') if repo is undefined
+  callback(null, 'no owner specified') if owner is undefined
   callback(null, 'no current version given') if currentVersion is undefined
 
+  # build the query
+  query = if fetchTags then query.tags repo, owner else query.releases repo, owner
+
   # do the api call
-  apiUrl = baseApiUrl.replace 'REPO', repo
-  if not includePreReleases then apiUrl += '/latest'
-  got(apiUrl).then((response) ->
-    # parse the response body into an object
-    releases = JSON.parse response.body
-
-    found = false
-
-    if includePreReleases
-      # loop through releases
-      # if a remote version is higher than the installed one, the callback
-      # will be called with the release object
-      for release in releases
-        tag = release.tag_name
-        if semver.compare(currentVersion, tag) is -1
-          found = true
-          callback release, null
-          break
+  graphql (token: token, query: query), (err, res) ->
+    if err
+      callback null, err
     else
-      tag = releases.tag_name
-      if semver.compare(currentVersion, tag) is -1
-        found = true
-        callback releases, null
+      # Retrieve newer version name
+      newer =
+      	if fetchTags
+          res.data.repository.refs.nodes[0]
+        else
+          res.data.repository.releases.nodes[0]
 
-    callback(null, null) if not found
-  ).catch (error) -> callback null, error
+      # Compare versions
+      if semver.gt (if fetchTags then newer.name else newer.tag.name), currentVersion
+        callback newer, null
+      else
+        callback null, null
 
-  return null
+  return

lib/query.coffee

@@ -0,0 +1,43 @@
+###
+  Query for fetching the latest github release.
+
+  @param repo {string} The repository name.
+  @param owner {string} The owner of the repository.
+###
+module.exports.releases = (repo, owner) ->
+  "
+  {
+    repository(name: \"#{repo}\", owner: \"#{owner}\") {
+      releases(last: 1) {
+        nodes {
+          name
+          tag {
+            name
+          }
+          isPrerelease
+          publishedAt
+          url
+        }
+      }
+    }
+  }
+  "
+
+###
+  Query for fetching the latest git tag.
+
+  @param repo {string} The repository name.
+  @param owner {string} The owner of the repository.
+###
+module.exports.tags = (repo, owner) ->
+  "
+  {
+    repository(name: \"#{repo}\", owner: \"#{owner}\") {
+  		refs(last: 1, refPrefix: \"refs/tags/\", orderBy: { field: TAG_COMMIT_DATE, direction: ASC}) {
+        nodes {
+          name
+        }
+      }
+    }
+  }
+  "