See changelog

Author: mcdonnelldean

CHANGELOG.md

@@ -1,10 +1,13 @@
-Pending - x.x.x
+7 April 2016 - 6.1.0
 ---
 * Added CHANGELOG.md
 * Removed redundant data folder.
 * Removed unneeded build.sh.
 * Moved logic script into lib.
 * Refactored start.js and github.js for clarity.
+* Removed unneeded seneca actions
+* Added isolation mode
+* Updated docs to reflect changes
 
 6 April 2016 - 6.0.0
 ---

README.md

@@ -1,47 +1,116 @@
-![Nodezoo](https://raw.githubusercontent.com/nodezoo/nodezoo-org/master/assets/logo-nodezoo.png)
+![Nodezoo][Logo]
 
-## nodezoo-github
+# nodezoo-github
 
-- __Lead:__ [Richard Rodger][Lead]
-- __Sponsor:__ [nearForm][]
+- __Lead:__ [Dean McDonnell][Lead]
+- __Sponsor:__ [nearForm][Sponsor]
 
-Nodezoo.com micro-service handling github meta data. Please see the [main repo][] for more details
+A micro-service that provides Github related information to [NodeZoo][]. This
+micro-service requires a valid Github token to function, please see the Config
+section below for details on how to obtain.
 
-If you're using this microservice, and need help, you can:
+If you're using this micro-service, and need help, you can:
 
 - Post a [github issue][],
 - Tweet to [@nodezoo][],
 - Ask on the [Gitter][gitter-url].
 
 ## Running
-This micro-service can be ran as part of the [NodeZoo org][] system. Please follow the
-link below for details on obtaining and running the complete system.
+This micro-service can be ran as part of a complete system or as a single isolated
+unit.
+
+### As a complete system
+A special system repository is available that runs the complete system using Docker
+and Fuge.
 
 - [Nodezoo: The complete system][System]
 
+### Isolated mode
+To make testing easier this micro-service can be ran in 'isolated' mode. This mode
+allows testing over http using a well defined port. Please note isolated mode means
+patterns are not exposed via mesh.
+
+To run in isolated mode,
+
+ - Clone this repository locally,
+ - Run `npm install`,
+ - Run `GITHUB_TOKEN=YOUR_TOKEN npm start isolated`,
+
+__Note:__ You will need to have a valid github token to use isolated mode.
+
+A simple http service is supported and can be called using Curl or other Rest client.
+The default port is `8052`. It can be changed using the `GITHUB_PORT` environment
+variable.
+
+```
+curl -d '{"role":"github","cmd":"get","name":"hapi"}' http://localhost:8052/act
+```
+
 ## Configuration
-Set the `$GITHUB_TOKEN` environment variable with a GitHub Access Token.
 
-## Creating a GitHub Personal Access Token
+### Creating a GitHub Personal Access Token
+You will need a token for this service if regardless of how you choose to run it.
 
-  - In the top right corner of any page, click your profile photo, then click Settings.
+  - On github.com, click your profile photo, then click settings.
   - In the user settings sidebar, click Personal access tokens.
   - Click Generate new token
   - Give your token a descriptive name.
-  - Select the scopes you wish to grant to this token. The default scopes allow you to interact with public and private repositories, user data, and gists
-  - Click Generate token.
-  - Copy the token to your clipboard. For security reasons, after you navigate off this page, no one will be able to see the token again.
+  - Select the scopes you wish to grant, select all read-only scopes
+  - Click 'Generate token'.
+  - Copy the token to your clipboard and keep safe.
+
+### Environment Variables
+Various settings can be changed using environment variables, see the list below for
+all available variable names.
+
+#### GITHUB_TOKEN
+  - The token to use when calling the GitHub api.
+  - Defaults to `NO_TOKEN`,
+
+#### GITHUB_HOST
+  - The host to listen on in isolated mode.
+  - Defaults to `localhost`
+
+#### GITHUB_PORT
+  - The port to listen on in isolated mode.
+  - Defaults to `8052` .
+
+#### GITHUB_ISOLATED
+  - Starts isolated mode.
+  - Defaults to `false`.
+
+#### GITHUB_REGISTRY
+  - Change the registry used to validate the module name.
+  - Defaults to `http://registry.npmjs.org/`.
+
+## Messages Handled
+This micro-service handles the following messages.
 
-## Patterns Handled
 ### `role:github,cmd:get`
-Request module details by name
+Request a module's Github details. The name supplied must be a valid module on npm.
+
+```js
+seneca.act('role:github,cmd:get', {name: 'seneca'}, (err, data) => {})
+```
+
+### `role:info,req:part`
+Acts as an alias for `role:github,cmd:get` but instead of returning data directly a
+message is emitted using the pattern `role:info,res:part`. Allows integration with
+the wider nodezoo system.
+
 ```js
-seneca.act('role:github, cmd:get', {name: 'seneca'})
+seneca.act('role:info, req:part', {name: 'seneca'}, (err, data) => {})
 ```
 
-## Patterns Emitted
+## Messages Emitted
+This micro-service emits the following messages
 
-There are no outgoing messages.
+### `role:info,res:part`
+Contains the response of an earlier call to `role:info,req:part`.
+
+```js
+seneca.add('role:info,res:part', (msg, done) => {})
+```
 
 ## Contributing
 The [NodeZoo org][] encourages __open__ and __safe__ participation.
@@ -58,10 +127,12 @@ Licensed under [MIT][].
 [main repo]: https://github.com/rjrodger/nodezoo
 [MIT]: ./LICENSE
 [Code of Conduct]: https://github.com/nodezoo/nodezoo-org/blob/master/CoC.md
-[nearForm]: http://www.nearform.com/
+[Sponsor]: http://www.nearform.com/
 [NodeZoo org]: http://www.nodezoo.com/
-[Lead]: https://github.com/rjrodger
+[NodeZoo]: https://github.com/nodezoo
+[Lead]: https://github.com/mcdonnelldean
 [github issue]: https://github.com/nodezoo/nodezoo-github/issues
 [@nodezoo]: http://twitter.com/nodezoo
 [gitter-url]: https://gitter.im/nodezoo/nodezoo-org
 [System]: https://github.com/nodezoo/nodezoo-system
+[Logo]: https://raw.githubusercontent.com/nodezoo/nodezoo-org/master/assets/logo-nodezoo.png

lib/github.js

@@ -3,8 +3,6 @@
 var GitHub = require('github4')
 var github = new GitHub()
 var Request = require('request')
-var _ = require('lodash')
-var gitUrl
 
 var opts = {
   registry: 'http://registry.npmjs.org/',
@@ -16,18 +14,49 @@ module.exports = function (options) {
   var extend = seneca.util.deepextend
 
   opts = extend(opts, options)
+  opts.cache = seneca.make$('github')
 
   seneca.add('role:github,cmd:get', cmdGet)
-  seneca.add('role:github,cmd:query', cmdQuery)
-  seneca.add('role:github,cmd:parse', cmdParse)
-  seneca.add('role:github,cmd:extract', cmdExtract)
   seneca.add('role:info,req:part', aliasGet)
 
   return {
     name: 'nodezoo-github'
   }
 }
 
+function cmdGet (msg, done) {
+  var cache = opts.cache
+  var registry = opts.registry + msg.name
+
+  cache.load$(msg.name, (err, github) => {
+    if (err) return done(err)
+
+    if (github && !msg.update) {
+      return done(null, github)
+    }
+
+    Request.get({url: registry, gzip: true}, (err, res, body) => {
+      if (err) return done(err)
+
+      var data = JSON.parse(body)
+      var distTags = data['dist-tags'] || {}
+      var latest = ((data.versions || {})[distTags.latest]) || {}
+      var repository = latest.repository || {}
+      var url = repository.url || ''
+
+      var matches = /[\/:]([^\/:]+?)[\/:]([^\/]+?)(\.git)*$/.exec(url) || []
+      var params = {
+        name: msg.name,
+        url: url,
+        user: matches[1] || '',
+        repo: matches[2] || ''
+      }
+
+      queryGithub(params, done)
+    })
+  })
+}
+
 function aliasGet (msg, done) {
   var seneca = this
   var payload = {name: msg.name}
@@ -41,98 +70,35 @@ function aliasGet (msg, done) {
   })
 }
 
-function cmdGet (args, done) {
-  var seneca = this
-  var cache = seneca.make$('github')
-
-  var githubName = args.name
-  var url = opts.registry + githubName
-
-  cache.load$(githubName, function (err, github) {
-    if (err) {
-      return done(err)
-    }
-    if (github && !args.update) {
-      return done(null, github)
-    }
-    else {
-      // get giturl from npm
-      Request.get({url: url, gzip: true}, function (err, res, body) {
-        if (err) {
-          return done(err)
-        }
-        else if (_.isEmpty(JSON.parse(body))) {
-          return done(err)
-        }
-        var data = JSON.parse(body)
-        // take giturl from npm data
-        seneca.act('role:github,cmd:extract', {data: data}, function (err, data) {
-          if (err) {
-            return done(err)
-          }
-          // parse username and repo from giturl
-          var gitData = cmdParse(data)
-
-          if (gitData) {
-            var user = gitData[1]
-            var repo = gitData[2]
-            gitUrl = 'http://github.com/' + user + '/' + repo
-          }
-          if (!user) {
-            return done(err)
-          }
-          else {
-            // get github data using github username and repo name
-            seneca.act('role:github,cmd:query', {name: githubName, user: user, repo: repo}, done)
-          }
-        })
-      })
-    }
-  })
-}
-
-function cmdQuery (args, done) {
-  var seneca = this
-
-  var cache = seneca.make$('github')
-  var githubName = args.name
-  var user = args.user
-  var repo = args.repo
+function queryGithub (msg, done) {
+  var cache = opts.cache
 
   github.authenticate({
     type: 'token',
     token: opts.token
   })
 
-  var getRepos = {
-    user: user,
-    repo: repo
+  var params = {
+    user: msg.user,
+    repo: msg.repo
   }
 
-  github.repos.get(getRepos, (err, repo) => {
+  github.repos.get(params, (err, repo) => {
     if (err) return done(err)
     if (!repo) return done()
 
-    var data
-    var pullRequests = []
-    var getPullRequests = {
-      user: user,
-      repo: githubName,
-      state: 'open'
-    }
-
-    github.pullRequests.getAll(getPullRequests, (err, prs) => {
-      if (err) console.log(err)
+    params.state = 'open'
 
+    github.pullRequests.getAll(params, (err, prs) => {
       var data = {
-        name: args.repo || '',
-        user: args.user || '',
-        repo: args.repo || '',
+        name: msg.repo || '',
+        user: msg.user || '',
+        repo: msg.repo || '',
         stars: repo.stargazers_count || '',
         watches: repo.subscribers_count || '',
         forks: repo.forks_count || '',
         last: repo.pushed_at || '',
-        urlRepo: gitUrl || '',
+        urlRepo: msg.url || '',
         urlClone: repo.clone_url || '',
         pullRequests: prs && prs.length || 0,
         cached: Date.now()
@@ -143,36 +109,13 @@ function cmdQuery (args, done) {
         else done (null, data)
       }
 
-      cache.load$(githubName, function (err, github) {
+      cache.load$(msg.name, (err, cached) => {
         if (err) return done(err)
-        if (github) return github.data$(data).save$(complete)
+        if (cached) return cached.data$(data).save$(complete)
 
-        data.id$ = githubName
+        data.id$ = msg.name
         cache.make$(data).save$(complete)
       })
     })
   })
 }
-
-function cmdExtract (args, done) {
-  var data = args.data
-  var distTags = data['dist-tags'] || {}
-  var latest = ((data.versions || {})[distTags.latest]) || {}
-  var repository = latest.repository || {}
-
-  var out = {
-    giturl: repository.url
-  }
-
-  done(null, out)
-}
-
-function cmdParse (args) {
-  var m = /[\/:]([^\/:]+?)[\/:]([^\/]+?)(\.git)*$/.exec(args.giturl)
-  if (m) {
-    return (m)
-  }
-  else {
-    return null
-  }
-}