release v1.0.0

Author: Fadojutimi Temitayo Olusegun

.babelrc

@@ -0,0 +1,5 @@
+{
+    "presets": [
+        "env"
+    ]
+}

.coveralls.yml

@@ -0,0 +1 @@
+repo_token: COVERALLS_REPO_TOKEN

.eslintrc

@@ -0,0 +1,35 @@
+{
+    "root": true,
+    "extends": [ "airbnb-base" ],
+    "env": {
+      "node": true,
+      "es6": true,
+      "mocha": true
+    },
+    "rules": {
+      "global-require":0,
+      "import/no-dynamic-require":0,
+      "one-var": 0,
+      "one-var-declaration-per-line": 0,
+      "new-cap": 0,
+      "consistent-return": 0,
+      "no-param-reassign": 0,
+      "comma-dangle": 0,
+      "curly": ["error", "multi-line"],
+      "import/no-unresolved": [2, { "commonjs": true }],
+      "no-shadow": ["error", { "allow": ["req", "res", "err"] }],
+      "valid-jsdoc": ["error", {
+        "requireReturn": true,
+        "requireReturnType": true,
+        "requireParamDescription": false,
+        "requireReturnDescription": true
+      }],
+      "require-jsdoc": ["error", {
+          "require": {
+              "FunctionDeclaration": true,
+              "MethodDefinition": true,
+              "ClassDeclaration": true
+          }
+      }]
+    }
+  }

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+build/
+.nyc_output/
+coverage/

.travis.yml

@@ -0,0 +1,31 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$CODECLIMATE_REPO_TOKEN
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
+language: node_js
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+script:
+  - bundle exec rspec
+  # Preferably you will run test-reporter on branch update events. But
+  # if you setup travis to build PR updates only, you don't need to run
+  # the line below
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
+  # In the case where travis is setup to build PR updates only,
+  # uncomment the line below
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+node_js:
+  - node
+notifications:
+  email: false
+before_script:
+  - npm install -g codeclimate-test-reporter
+  - npm install -g coveralls
+  - npm install -g sequelize
+script:
+  - npm test
+after_success:
+  - npm run coveralls
+  - codeclimate-test-reporter < coverage/lcov.info
+  - coveralls < coverage/lcov.info

LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2017 Fadojutimi Temitayo Olusegun <[email protected]>
+
+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

@@ -0,0 +1,103 @@
+[![Build Status](https://travis-ci.org/adesege/express-api-versioning.svg)](https://travis-ci.org/adesege/express-api-versioning)
+[![Coverage Status](https://coveralls.io/repos/github/adesege/express-api-versioning/badge.svg)](https://coveralls.io/github/adesege/express-api-versioning) 
+[![Code Climate](https://codeclimate.com/github/adesege/express-api-versioning/badges/gpa.svg)](https://codeclimate.com/github/adesege/express-api-versioning) 
+[![Test Coverage](https://codeclimate.com/github/adesege/express-api-versioning/badges/coverage.svg)](https://codeclimate.com/github/adesege/express-api-versioning/coverage) 
+[![Issue Count](https://codeclimate.com/github/adesege/express-api-versioning/badges/issue_count.svg)](https://codeclimate.com/github/adesege/express-api-versioning)
+
+# Express API Versioning
+
+Express API versioning is an express middleware that dynamically loads different API versions seamlessly depending on the version number specified in the request url.
+
+It is written in Javascript ES6 syntax and it is further transpiled down to Javascript ES5 using babel.
+
+# Installation
+
+- `npm install express-api-versioning --save`
+- `express` is required as a peer dependency.
+
+# Usage
+
+### Using ES6
+
+` import expressApiVersioning from 'express-api-versioning';`
+### Using ES5
+
+` const expressApiVersioning = require('express-api-versioning');`
+### Basic Usage
+
+   ```js
+app.use(expressApiVersioning({
+  	instance: app, // passes an instance of express to the entry point
+  	apiPath: path.join(__dirname, './api'), // absolute path to the api directory
+	test: /\/api\/(v[0-9]+)[a-z0-9/_+-]*/, // regular expression to get the version number from the url
+	entryPoint: 'app.js' // entry point exports a function which takes an instance of express as parameter.
+}));
+```
+### Advanced Usage
+
+```js
+app.use(expressApiVersioning({
+	instance: app, // passes an instance of express to the entry point
+	apiPath: path.join(__dirname, './api'), // absolute path to the api directory
+	test: /\/endpoint\/(v[0-9]+)[a-z0-9/_+-]*/, // regular expression to get the version number from the url,
+	entryPoint: 'index.js' // entry point exports a function which takes an instance of express as parameter.
+}));
+```
+- Check the [src/example](/src/sample) directory to understand the folder structure.
+
+# Error Handling
+
+The middleware will throw an exception when;
+1. the `apiPath` is not specified
+1. an express `instance` is not specified and not a function
+1. the api version cannot be found in the `api directory`.
+
+# Issue Reporting
+
+Please use the [issues](/issues) page to report an issue.
+
+# API References
+
+`Express API Versioning` is highly customizable and does not introduce complexities to your application folder structure. It takes a configuration object as parameter.
+
+| Configuration item | Default | Description |
+| ------ | ------ | ------- |
+| test | /\/api\/(v[0-9]+)[a-z0-9/_+-]*/ | Regular expression to get the version number from the request url. It gets the version number from the first group of the regex match.
+| entryPoint | app.js | Entry point for each api version. It exports a function which takes an instance of express as parameter.
+| apiPath | empty string | Absolute path to each api version container/directory. This is usually `path.join(__dirname, './api')`.
+| instance | null | An instance of express app which will be passed down to the entry point for usage.
+
+# Todo
+
+- Create a boilerplate for `Express API Versioning` with `Sequelize` as ORM
+
+# Author
+
+**Temitayo Fadojutimi** is a Software Developer at Andela and he dedicates his expertise to solving practical problems in the society. He tweets at [@adesege_](http://twitter.com/adesege_)
+
+# Testing
+
+If you will like to test this package,
+- Clone this repo or `npm install express-api-versioning`
+- cd into the package directory and run `npm install`
+- Then run `npm test` to run the test.
+
+# Contributing
+
+Thank you for your interest in contributing to this package. I currently accept contributions from everyone but I expect that standards are maintained.
+To contribute,
+1. Fork the project
+1. Create a feature branch, branch away from `master`
+1. Write tests, using `Mocha and Chai` or any other testing frameworks, and code
+1. If you have multiple commits please combine them into a few logically organized commits by [squashing them](git-squash)
+1. Push the commit(s) to your fork
+1. Submit a merge request (MR) to the `master` branch
+1. The MR title should describe the change you want to make
+1. The MR description should give a motive for your change and the method you used to achieve it.
+  1. Mention the issue(s) your merge request solves, using the `Solves #XXX` or
+    `Closes #XXX` syntax to auto-close the issue(s) once the merge request will
+    be merged.
+1. Be prepared to answer questions and incorporate feedback even if requests for this arrive weeks or months after your MR submission
+  1. If a discussion has been addressed, select the "Resolve discussion" button beneath it to mark it resolved.
+1. When writing commit messages please follow
+   [these guidelines](http://chris.beams.io/posts/git-commit).