Merge branch 'release/v0.0.2'

Author: pavelbinar

.gitignore

@@ -6,3 +6,5 @@ npm-debug.log
 coverage/lcov-report/
 
 coverage/
+
+all_issues\.csv

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2017 REMOTE ORIGIN s.r.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -11,16 +11,24 @@ Command line application allowing you to download all issues in the CSV format f
 - [Node.js](https://nodejs.org) (`v6.10.3 LTS`)
 - [Yarn](https://yarnpkg.com) (for development)
 
-## Usage
-
-### Install app globally
+## Installation
 
     npm install -g git-issues-downloader
 
-### Running the app
+## Ussage
 
     git-issues-downloader <repository URL>
 
+### Examples
+
+Command prompt will ask for username and password credentials for GitHub
+
+    git-issues-downloader https://github.com/remoteorigin/git-issues-downloader
+
+Example with username and password
+
+    git-issues-downloader -u <username> -p <username> https://github.com/remoteorigin/git-issues-downloader
+
 ## Development
 
 ### Project Setup
@@ -39,7 +47,7 @@ All tests are are written in [Mocha](https://mochajs.org/) and stored in the `te
 
     yarn run test
 
-### Lintining
+### Linting
 
 Using [Standard](https://github.com/feross/standard) JavaScript linter & automatic code fixer.
 

app.js

@@ -6,12 +6,11 @@ const _ = require('lodash')
 const moment = require('moment')
 const read = require('read')
 const chalk = require('chalk')
-const sinon = require('sinon')
 const argv = require('yargs')
   .usage('Usage: git-issues-downloader [options] URL \nType git-issues-downloader --help to see a list of all options.')
   .help('h')
 
-  .version(function() {
+  .version(function () {
     return `Version: ${require('./package.json').version}`
   })
 
@@ -39,7 +38,7 @@ getAuth = function (auth, silent, callback) {
 
 // callback function for getting requested options
 
-exports.getRequestedOptions = function (username, password, url, callback) {
+const getRequestedOptions = exports.getRequestedOptions = function (username, password, url, callback) {
   const requestOptions = {
     headers: {
       'User-Agent': 'request'
@@ -89,35 +88,39 @@ exports.getRequestedOptions = function (username, password, url, callback) {
 
 // main function for running program
 
-exports.main = function (data, requestedOptions) {
-  console.log('Requesting API...')
-  this.requestBody(requestedOptions, (error, response, body) => {
-    const linkObject = this.responseToObject(response.headers)
+const main = exports.main = function (data, requestedOptions) {
+  logExceptOnTest('Requesting API...')
+  requestBody(requestedOptions, (error, response, body) => {
+    linkObject = responseToObject(response.headers)
 
     // take body, parse it and add it to data
 
     data = _.concat(data, body)
 
     if (linkObject.nextPage) {
-      console.log(chalk.green(`Successfully requested ${linkObject.nextPage.number - 1}. page of ${linkObject.lastPage.number}`))
-
+      logExceptOnTest(chalk.green(`Successfully requested ${linkObject.nextPage.number - 1}. page of ${linkObject.lastPage.number}`))
       requestedOptions.url = linkObject.nextPage.url
-      this.main(data, requestedOptions)
+      main(data, requestedOptions)
     } else {
-      console.log(chalk.green('Successfully requested last page'))
+      logExceptOnTest(chalk.green('Successfully requested last page'))
+
+      logExceptOnTest('\nConverting issues...')
+      const csvData = convertJSonToCsv(data)
+      logExceptOnTest(chalk.green(`\nSuccessfully converted ${data.length} issues!`))
 
-      console.log('\nConverting issues...')
-      const csvData = this.convertJSonToCsv(data)
-      console.log(chalk.green(`\nSuccessfully converted ${data.length} issues!`))
+      logExceptOnTest('\nWriting data to csv file')
+      fs.writeFile(outputFileName, csvData, (err) => {
+        if (err) throw err
 
-      this.writeData(csvData, outputFileName)
+        logExceptOnTest(chalk.yellow(`\nIssues was downloaded, converted and saved to ${outputFileName}`))
+      })
     }
   })
 }
 
 // get page url and page number from link
 
-exports.getUrlAndNumber = function (link) {
+const getUrlAndNumber = exports.getUrlAndNumber = function (link) {
   return {
     url: link.slice(link.indexOf('<') + 1, link.indexOf('>')),
     number: link.slice(link.indexOf('page', link.indexOf('state')) + 5, link.indexOf('>'))
@@ -126,25 +129,25 @@ exports.getUrlAndNumber = function (link) {
 
 // create and return links info (page url and page number for all 4 possible links in response.headers.link) from whole response.hearders
 
-exports.responseToObject = function (response) {
+const responseToObject = exports.responseToObject = function (response) {
   const rawLink = response.link
 
   if (rawLink && rawLink.includes('next')) {
     const links = rawLink.split(',')
 
     return {
-      nextPage: (links[0]) ? this.getUrlAndNumber(links[0]) : false,
-      lastPage: (links[1]) ? this.getUrlAndNumber(links[1]) : false,
-      firstPage: (links[2]) ? this.getUrlAndNumber(links[2]) : false,
-      prevPage: (links[3]) ? this.getUrlAndNumber(links[3]) : false
+      nextPage: (links[0]) ? getUrlAndNumber(links[0]) : false,
+      lastPage: (links[1]) ? getUrlAndNumber(links[1]) : false,
+      firstPage: (links[2]) ? getUrlAndNumber(links[2]) : false,
+      prevPage: (links[3]) ? getUrlAndNumber(links[3]) : false
     }
   }
   return false
 }
 
 // use url and request api
 
-exports.requestBody = function (requestedOptions, callback) {
+const requestBody = exports.requestBody = function (requestedOptions, callback) {
   request.get(requestedOptions, function (err, response, body) {
     const JSObject = JSON.parse(body)
 
@@ -153,13 +156,13 @@ exports.requestBody = function (requestedOptions, callback) {
 
       switch (JSObject.message) {
         case 'Not Found':
-          console.log(chalk.red('\nWe didn\'t find any repository on this URL, please check it'))
+          logExceptOnTest(chalk.red('\nWe didn\'t find any repository on this URL, please check it'))
           break
         case 'Bad credentials':
-          console.log(chalk.red('\nYour username or password is invalid, please check it'))
+          logExceptOnTest(chalk.red('\nYour username or password is invalid, please check it'))
           break
         default:
-          console.log(chalk.red('\nRepository have 0 issues. Nothing to download'))
+          logExceptOnTest(chalk.red('\nRepository have 0 issues. Nothing to download'))
       }
     } else {
       callback(err, response, JSObject)
@@ -169,46 +172,39 @@ exports.requestBody = function (requestedOptions, callback) {
 
 // take JSON data, convert them into CSV format and return them
 
-exports.convertJSonToCsv = function (jsData) {
-  const csvData = jsData.map(object => {
+const convertJSonToCsv = exports.convertJSonToCsv = function (jsData) {
+  return jsData.map(object => {
     const date = moment(object.created_at).format('L')
     const labels = object.labels
     const stringLabels = labels.map(label => label.name).toString()
     return `"${object.number}"; "${object.title.replace(/"/g, '\'')}"; "${object.html_url}"; "${stringLabels}"; "${object.state}"; "${date}"\n`
   }).join('')
-
-  return csvData
-}
-
-// create a new file and write converted data on him
-
-exports.writeData = function (data, outputFileName) {
-  console.log('\nWriting data to csv file')
-  fs.writeFile(outputFileName, data, (err) => {
-    if (err) throw err
-
-    console.log(chalk.yellow(`\nIssues was downloaded, converted and saved to ${outputFileName}`))
-  })
 }
 
 // execute main function with requested options and condition for URL input
 
-exports.execute = function (argvRepository) {
+const execute = exports.execute = function (argvRepository) {
   if (argvRepository) {
     const issuesPerPage = 100
     const repoUserName = argvRepository.slice(19, argvRepository.indexOf('/', 19))
     const repoUrl = (argvRepository.slice(20 + repoUserName.length, argvRepository.lastIndexOf('/'))) ? argvRepository.slice(20 + repoUserName.length, argvRepository.lastIndexOf('/')) : argvRepository.slice(20 + repoUserName.length)
 
     const startUrl = `https://api.github.com/repos/${repoUserName}/${repoUrl}/issues?per_page=${issuesPerPage}&state=all&page=1`
 
-    this.getRequestedOptions(argv.username, argv.password, startUrl, (requestedOptions) => {
-      this.main([], requestedOptions)
+    getRequestedOptions(argv.username, argv.password, startUrl, (requestedOptions) => {
+      main([], requestedOptions)
     })
   } else {
     console.log('Usage: git-issues-downloader [options] URL')
   }
 }
 
+function logExceptOnTest (string) {
+  if (process.env.NODE_ENV !== 'test') {
+    console.log(string)
+  }
+}
+
 const argvRepository = argv._[argv._.length - 1]
 
 this.execute(argvRepository)

package.json

@@ -1,12 +1,13 @@
 {
   "name": "git-issues-downloader",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "app.js",
   "license": "MIT",
   "scripts": {
     "start": "node app.js ; exit 0",
     "test": "mocha test",
-    "lint": "standard"
+    "lint": "standard",
+    "lint:fix": "standard --fix"
   },
   "standard": {
     "env": [

test/app-test.js

@@ -8,54 +8,52 @@ const sinon = require('sinon')
 const app = require('../app.js')
 const dummyData = require('./dummy-data')
 
-const responseToObject = app.responseToObject(dummyData.apiResponse)
 const getRequestedOptions = app.getRequestedOptions
-const requestBody = app.requestBody
 const convertJsonToCsv = app.convertJSonToCsv
-const writeData = app.writeData
 const main = app.main
 
 describe('downloadGitIssues', function () {
-  describe('Get URL and Number', function () {
+  process.env.NODE_ENV = 'test'
+  describe('getUrlAndNumber', function () {
     const getUrlAndNumberObject = app.getUrlAndNumber(dummyData.nextPageLink)
 
-    it('should return url', function () {
+    it('return url', function () {
       assert.equal(getUrlAndNumberObject.url, 'https://api.github.com/repositories/90146723/issues?per_page=10&state=all&page=2')
     })
 
-    it('should return page number', function () {
+    it('return page number', function () {
       assert.equal(getUrlAndNumberObject.number, '2')
     })
   })
 
-  describe('Response To Object', function () {
-    it('should return url of next page', function () {
-      assert.equal(responseToObject.nextPage.url, 'https://api.github.com/repositories/90146723/issues?per_page=10&state=all&page=2')
+  describe('responseToObject', function () {
+    it('return url of next page', function () {
+      assert.equal(app.responseToObject(dummyData.apiResponse).nextPage.url, 'https://api.github.com/repositories/90146723/issues?per_page=10&state=all&page=2')
     })
   })
 
   describe('getRequestedOptions', function () {
-    it('should return object with username and password', function () {
+    it('return object with username and password', function () {
       getRequestedOptions('username', 'password', dummyData.nextPageLink, (done) => {
         expect(done).to.deep.equal(dummyData.requestOptions)
       })
     })
   })
 
   describe('convertJSONToCsv', function () {
-    it('should return converted issues 21', function () {
+    it('return converted issues without label', function () {
       const result = convertJsonToCsv(dummyData.JSONdata21)
 
       expect(result).to.deep.equal(dummyData.issuesResult21)
     })
 
-    it('should return converted issues 20', function () {
+    it('return converted issues with label', function () {
       const result = convertJsonToCsv(dummyData.JSONdata20)
 
       expect(result).to.deep.equal(dummyData.issuesResult20)
     })
   })
-  describe('requestedBody = suggested output', function () {
+  describe('requestedBody (successful request)', function () {
     before(function () {
       sinon
         .stub(request, 'get')
@@ -66,13 +64,13 @@ describe('downloadGitIssues', function () {
       request.get.restore()
     })
 
-    it('should be called with requested options', function () {
-      requestBody('', (error, response, body) => {
+    it('called body with requested options', function () {
+      app.requestBody('', (error, response, body) => {
         expect(body).not.be.empty
       })
     })
   })
-  describe('requestedBody = bad url', function () {
+  describe('requestedBody (URL not found)', function () {
     before(function () {
       sinon
         .stub(request, 'get')
@@ -83,14 +81,44 @@ describe('downloadGitIssues', function () {
       request.get.restore()
     })
 
-    it('should invoke error message for bad URL', function () {
-      requestBody('', (error, response, body) => {
+    it('invoke error message for bad URL', function () {
+      app.requestBody('', (error, response, body) => {
       })
     })
   })
-  describe('writeData', function () {
-    it('should create file with data', function () {
+  describe('requestedBody (Bad Credentials)', function () {
+    before(function () {
+      sinon
+        .stub(request, 'get')
+        .yields(null, null, JSON.stringify(dummyData.bodyForBadCredentials))
+    })
+
+    after(function () {
+      request.get.restore()
+    })
+
+    it('invoke error message for Bad Credentials', function () {
+      app.requestBody('', (error, response, body) => {
+      })
+    })
+  })
+  describe('main', function () {
+    before(function () {
+      sinon
+        .stub(request, 'get')
+        .yields(null, dummyData.response2Page, JSON.stringify(dummyData.testIssues))
+    })
+
+    after(function () {
+      request.get.restore()
+    })
+
+    it('successful execute all function', function () {
+      const main = sinon.spy()
+
+      main([], dummyData.requestedOptions)
 
+      assert(main.calledOnce)
     })
   })
 })