gx0r · Jul 10, 2014 · Jul 10, 2014 · Jul 10, 2014 · Jul 10, 2014 · Jul 10, 2014
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,5 @@
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+/**/*.d.ts
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,10 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+};
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,5 @@
 # npm modules
 node_modules
 
+*.sqlite
+npm-debug.log
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,17 @@
+language: node_js
+node_js:
+  - "10"
+  - "12"
+
+env:
+  - IN_TRAVIS=yes
+
+before_script:
+  - psql -c 'create database travis_ci_test;' -U postgres
+  - mysql -e 'create database travis_ci_test;'
+
+addons:
+  postgresql: "9.4"
+
+services:
+  - mysql
diff --git a/Changelog.md b/Changelog.md
@@ -0,0 +1,27 @@
+Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
+
+**1.7.2**
+
+- Bug fix: fixed a typo. 'creatable' -> 'createtable'
+
+**1.7.1**
+
+- Bug fix: https://github.com/llambda/connect-session-knex/pull/65
+- Split the lib into 1. lib 2. tests 3. examples 4. typings to make it more maintainable
+- Added Changelog.md
+
+**1.7.0**
+
+- Added Typescript lib interface (index.d.ts)
+- Added Airbnb Eslint configs and recommendations.
+- Auto fixed many lint errors
+- Removed NodeJS v8 testing from Travis
+- Added instructions for testing
+- Tests now require a password when running locally (While still the same when running on Travis) I did that because both dbs refused to connect locally without a password
+- Auto lint both examples
+- Moved many functions out of the lib's main closure, to make the code more clear and enforce the purity of these functions. Only the Store class is what remains in the closure (Because it requires the session object)
+- Added knex to main dependencies instead of dev dependencies.
diff --git a/History.md b/History.md
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,15 @@
+Copyright (c) 2014, llambda <xxgsoftware@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
diff --git a/Oldversions.md b/Oldversions.md
@@ -0,0 +1,33 @@
+### Usage
+
+With Express 3:
+
+```js
+var express = require('express')
+var KnexSessionStore = require('connect-session-knex')(express);
+var store = new KnexSessionStore(/* options here */);
+
+app.configure(function() {
+  app.use(express.session({
+    store: store,
+    secret: 'your secret',
+    cookie: { maxAge: 7 * 24 * 60 * 60 * 1000 } // 1 week
+  }));
+});
+```
+
+With Connect:
+
+```js
+var connect = require('connect'),
+var KnexSessionStore = require('connect-session-knex')(connect);
+var store = new KnexSessionStore(/* options here */);
+
+connect.createServer(
+  connect.cookieParser(),
+  connect.session({
+    store: store,
+    secret: 'your secret'
+  })
+);
+```
diff --git a/Readme.md b/Readme.md
@@ -1,49 +1,143 @@
-# Connect SQLite3
+# Connect Session Knex
 
-connect-sqlite3 is a SQLite3 session store modeled after the TJ's connect-redis store.
 
+[![NPM Version][npm-version-image]][npm-url]
+[![NPM Downloads][npm-downloads-image]][npm-url]
+[![Node.js Version][node-image]][node-url]
+[![Build Status][travis-image]][travis-url]
+[![Dependency Status][dependencies-image]][dependencies-url]
+[![Coverage Status][coveralls-image]][coveralls-url]
+
+[![NPM][npm-image]][npm-url]
+
+connect-session-knex is an [express-session](https://github.com/expressjs/session) store backed by PostgreSQL, MySQL, MariaDB, MSSQL, Oracle or SQLite3, via the [knex.js](http://knexjs.org/) library.
 
 ## Installation
 
-	  $ npm install connect-sqlite3
+```sh
+$ npm install connect-session-knex
+```
 
-## Options
+## History
 
-  - `table='sessions'` Database table name
-  - `db='sessionsDB'` Database file name (defaults to table name)
-  - `dir='.'` Direcotry to save '<db>.db' file
+See [Changelog.md](Changelog.md)
 
 ## Usage
 
-    var connect = require('connect'),
-        SQLiteStore = require('connect-sqlite3')(connect);
-
-    connect.createServer(
-      connect.cookieParser(),
-      connect.session({ store: new SQLiteStore, secret: 'your secret' })
-    );
-
-  with express
-
-    3.x:
-    var SQLiteStore = require('connect-sqlite3')(express);
-
-    4.x:
-    var session = require('express-session');
-    var SQLiteStore = require('connect-sqlite3')(session);
-
-    app.configure(function() {
-      app.set('views', __dirname + '/views');
-      app.set('view engine', 'ejs');
-      app.use(express.bodyParser());
-      app.use(express.methodOverride());
-      app.use(express.cookieParser());
-      app.use(express.session({
-        store: new SQLiteStore,
-        secret: 'your secret',
-        cookie: { maxAge: 7 * 24 * 60 * 60 * 1000 } // 1 week
-      }));
-      app.use(app.router);
-      app.use(express.static(__dirname + '/public'));
-    });
+[Example application using the defaults](https://github.com/llambda/connect-session-knex/blob/master/examples/example.js)
+
+[Example application with PostgreSQL](https://github.com/llambda/connect-session-knex/blob/master/examples/example-postgres.js)
+
+[With Express 3 or Connect](https://github.com/llambda/connect-session-knex/blob/master/Oldversions.md)
+
+## Options
+
+ - `tablename='sessions'` Tablename to use. Defaults to 'sessions'.
+ - `sidfieldname='sid'` Field name in table to use for storing session ids. Defaults to 'sid'.
+ - `knex` knex instance to use. Defaults to a new knex instance, using sqlite3 with a file named 'connect-session-knex.sqlite'
+ - `createtable` if the table for sessions should be created automatically or not.
+ - `clearInterval` milliseconds between clearing expired sessions. Defaults to 60000.
+
+If the table does not exist in the schema, this module will attempt to create it unless the 'createtable' option is false.
+
+If a knex instance is not provided, this module will attempt to create a sqlite3 database, with a file named 'connect-session-knex.sqlite', in the working directory of the process.
+
+## Schema
+
+### PostgreSQL or SQLite
+
+#### Table Name "sessions"  
+| Column  |           Type           | Modifiers | Storage  | 
+|---------|:------------------------:|:---------:|:--------:|
+| sid     | character varying(255)   | not null  | extended |
+| sess    | json                     | not null  | extended |
+| expired | timestamp with time zone | not null  | plain    |  
+
+### Indexes:
+```  
+    "sessions_pkey" PRIMARY KEY, btree (sid)  
+    "sessions_expired_index" btree (expired)
+```
+
+## Benchmarks
+
+[https://github.com/llambda/express-session-benchmarks](https://github.com/llambda/express-session-benchmarks)
+
+[npm-version-image]: https://img.shields.io/npm/v/connect-session-knex.svg
+[npm-downloads-image]: https://img.shields.io/npm/dm/connect-session-knex.svg
+[npm-image]: https://nodei.co/npm/connect-session-knex.png?downloads=true&downloadRank=true&stars=true
+[npm-url]: https://npmjs.org/package/connect-session-knex
+[travis-image]: https://img.shields.io/travis/llambda/connect-session-knex/master.svg
+[travis-url]: https://travis-ci.org/llambda/connect-session-knex
+[dependencies-image]: https://david-dm.org/llambda/connect-session-knex.svg?style=flat
+[dependencies-url]: https://david-dm.org/llambda/connect-session-knex
+[coveralls-image]: https://img.shields.io/coveralls/llambda/connect-session-knex/master.svg
+[coveralls-url]: https://coveralls.io/r/llambda/connect-session-knex?branch=master
+[node-image]: https://img.shields.io/node/v/connect-session-knex.svg
+[node-url]: http://nodejs.org/download/
+[gitter-join-chat-image]: https://badges.gitter.im/Join%20Chat.svg
+[gitter-channel-url]: https://gitter.im/llambda/connect-session-knex
+[express-session-url]: https://github.com/expressjs/session
+[io-url]: https://iojs.org
+
+## Testing
+
+Install Postgresql
+Instructions for Ubuntu after intalling the db:
+
+```bash
+sudo -u postgres psql
+```
+
+```sql
+CREATE DATABASE travis_ci_test OWNER postgres;
+```
+
+```sql
+GRANT all privileges ON DATABASE travis_ci_test TO postgres;
+```
+
+```sql
+ALTER USER postgres WITH PASSWORD 'postgres';
+```
+
+```sql
+\q
+```
+
+Install Mysql
+Instructions for Ubuntu after installing the db:
+
+```bash
+sudo mysql -u root
+```
+
+```sql
+create user 'travis' identified by 'travis';
+```
+
+```sql
+ALTER USER 'travis'@'localhost' IDENTIFIED BY 'travis';
+```
+
+```sql
+create database travis_ci_test;
+```
+
+```sql
+grant all on travis_ci_test.* to 'travis';
+```
+
+```sql
+\q
+```
+
+```bash
+sudo service mysql restart
+```
+
+Make sure both the MySQL and Postgres services are running
 
+```bash
+npm run test
+```
diff --git a/examples/example-postgres.js b/examples/example-postgres.js
@@ -0,0 +1,45 @@
+/* eslint-disable import/no-unresolved */
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable no-console */
+
+const express = require('express');
+
+const app = express();
+
+const session = require('express-session');
+const KnexSessionStore = require('connect-session-knex')(session);
+
+const Knex = require('knex');
+
+const knex = Knex({
+  client: 'pg',
+  connection: {
+    host: '127.0.0.1',
+    user: 'postgres',
+    password: '',
+    database: 'travis_ci_test',
+  },
+});
+
+const store = new KnexSessionStore({
+  knex,
+  tablename: 'sessions', // optional. Defaults to 'sessions'
+});
+
+app.use(
+  session({
+    secret: 'keyboard cat',
+    cookie: {
+      maxAge: 10000, // ten seconds, for testing
+    },
+    store,
+  }),
+);
+
+app.use('/', (req, res) => {
+  const n = req.session.views || 0;
+  req.session.views = n + 1;
+  res.end(`${n} views`);
+});
+
+app.listen(3000);