An advanced session store for Elixir and NodeJS based on Redis
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
test
.gitignore
.travis.yml
LICENSE
README.md
appveyor.yml
mix._exs
mix.exs
mix.lock

README.md

RedisSessions

Travis Build Status Windows Tests Coveralls Coverage

Hex.pm Version Deps Status Hex.pm

This is a Elixir module to keep sessions in a Redis datastore and add some useful methods. The main purpose of this module is to generalize sessions across application server platforms.

It's also an elixir port of the node.js module redis-sessions.

Installation

If available in Hex, the package can be installed as:

  1. Add redis_sessions to your list of dependencies in mix.exs:
```elixir
def deps do
  [{:redis_sessions, "~> 0.1.0"}]
end
```
  1. Ensure redis_sessions is started before your application:
```elixir
def application do
  [applications: [:redis_sessions]]
end
```

Usage

Basic methods

create a session - create/6

{ :ok, %{ token: token } } = RedisSessions.Client.create( "appname", "the_users_id", "127.0.0.1" )

Get a session - get/3

session_token = "q3uvHvVqEcnTAaIsWSkgAcvDSKsTyVyameD3s7TjBU1lMVeB3hW7bsgZitfoxqkr"

{:ok, session } = RedisSessions.Client.create( "appname", session_token )
# session ->  %{ id: "the_users_id", r:2, w:1, idle: 3, ttl: 3600, d: nil }

Add additional data to the session - set/4

session_token = "q3uvHvVqEcnTAaIsWSkgAcvDSKsTyVyameD3s7TjBU1lMVeB3hW7bsgZitfoxqkr"
session_data = %{ "my" => "additional", "data" => 2, "save" => "to", "my" => "session" }

{:ok, session } = RedisSessions.Client.set( "appname", session_token, session_data )
# session ->  %{ id: "the_users_id", r:2, w:2, idle: 3, ttl: 3600, ip: "127.0.0.1", d: %{ "my" => "additional", "data" => 2, "save" => "to", "my" => "session" } }

Kill a session - kill/3

session_token = "q3uvHvVqEcnTAaIsWSkgAcvDSKsTyVyameD3s7TjBU1lMVeB3hW7bsgZitfoxqkr"

{:ok, %{ kill: 1 } } = RedisSessions.Client.kill( "appname", session_token, session_data )

Special user methods

Get all sessions of a user's id - soid/3

{:ok, sessions } = RedisSessions.Client.soid( "appname", "the_users_id" )
# sessions ->  [
#   %{ id: "the_users_id", r:2,  w:2,  idle: 3,  ttl: 3600, ip: "127.0.0.1", d: %{ "my" => "additional", "data" => 2, "save" => "to", "my" => "session" } },
#   %{ id: "the_users_id", r:13, w:23, idle: 42, ttl: 3600, ip: "192.168.1.23" }
# ]

Kill all sessions of a user's id - killsoid/3

{:ok, %{ kill: 3 } } = RedisSessions.Client.killsoid( "appname", "the_users_id" )

Special app methods

Get the count of active sessions - activity/3

{:ok, %{ activity: 1 } } = RedisSessions.Client.activity( "appname" )

Get all sessions of an app - soapp/3

{:ok, sessions } = RedisSessions.Client.soapp( "appname" )
# sessions ->  [
#   %{ id: "the_users_id", r: 2,  w: 2,  idle: 3,   ttl: 3600, ip: "127.0.0.1", d: %{ "my" => "additional", "data" => 2, "save" => "to", "my" => "session" } },
#   %{ id: "the_users_id", r: 13, w: 23, idle: 42,  ttl: 3600, ip: "192.168.1.23" },
#   %{ id: "another_user", r: 1,  w: 42, idle: 666, ttl: 9999, ip: "192.168.1.13" }
# ]

Kill all sessions aof an app - killall/2

{:ok, %{ kill: 3 } } = RedisSessions.Client.killall( "appname" )

Session Attributes

A Session map will look like:

%{ id: "the_users_id", r:2, w:1, idle: 3, ttl: 3600, ip: "127.0.0.1", d: nil }

Attributes:

  • id Binary: The sessions/users id you defined during the .create/6 method.
  • idle Number: The idle time of this session in seconds
  • r Number: The number of reads of this session
  • w Number: The number of writes to this session
  • ttl Number: The time to live for this session in seconds
  • ip Binary: The ip you set during create. Could be used to differ the same user on different devices/platforms.
  • d Map: A map of additional data saved to this session

Config

  • ns Binary defaukt: rs: redis sessions namespace
  • wipe Number defaukt: 600: redis sessions wipe timeout. If set to 0 automatic wipeing will be disabled
  • redis Binary: redis connection string. E.g. "redis://localhost:6379/0",
  • pool_size Number defaukt: 1: redix/poolboy pool size
  • pool_overflow Number defaukt: 0: redix/poolboy pool overflow

Release History

Version Date Description
0.2.3 2017-08-01 optimized travic config and relaxed elixir version
0.2.2 2017-08-01 updated dependencies and elixir requirement
0.2.1 2016-12-09 relaxed poison dependency
0.2.0 2016-12-09 Fixed configuration via system env like { :system, "CUSTOM_SESSIONS_WIPE", 120 }; updated deps
0.1.3 2016-09-29 fixed wipe config = 0; Optimized code based on credo hints; added automatic code coverage report
0.1.2 2016-09-28 fixed la timestamp to seconds to be compatible with redis-sessions
0.1.1 2016-09-28 use regular json encoding without key to atom feature. Added debug infos
0.1.0 2016-09-28 Initial finished version
0.0.1 2016-09-27 Main calls done
0.0.0 2016-09-16 development ...

The MIT License (MIT)

Copyright © 2016 M. Peter, http://www.tcs.de

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.