Skip to content
A Simple RuleEngine for OpenResty/LuaJIT which named Taurus
Branch: master
Clone or download
toruneko Merge pull request #1 from toruneko/dev
[feature] add startwith and endwith condition
Latest commit aa73a66 Apr 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib/resty
t format code Apr 20, 2019
.gitignore init Nov 20, 2018
.travis.yml remove luacheck Nov 20, 2018
LICENSE
Makefile init Nov 20, 2018
README.md rule definition Nov 23, 2018
dist.ini format code Apr 20, 2019
test_with_valgrind.sh init Nov 20, 2018
valgrind.suppress init Nov 20, 2018

README.md

Name

lua-resty-taurus - A Simple RuleEngine for OpenResty/LuaJIT which named Taurus

Status

This library is considered production ready.

Build status: Travis

Description

This library requires an nginx build with ngx_lua module, and LuaJIT 2.0.

Synopsis

    # nginx.conf:

    lua_package_path "/path/to/lua-resty-taurus/lib/?.lua;;";

    server {
        location = /t {
            content_by_lua_block {
                local r = {
                    rules = {
                        {
                            name = "rulename",
                            when = {
                                equals = {
                                    ["request.query.param"] = "demo"
                                }
                            },
                            ["do"] = {
                                proxy = "proxy"
                            }
                        }
                    }
                }
                local taurus = require "resty.taurus"
                local rule_engine = taurus.compile(r)

                local fact = require "resty.taurus.context.fact"
                local decision = require "resty.taurus.context.decision"
                local decide = decision.new()
                local matched = rule_engine:match(fact.new(
                    ngx.req.get_headers(),
                    ngx.req.get_uri_args(),
                    ngx.req.get_post_args(),
                    {}
                ), decide)
                ngx.say(decide.rulename)
                ngx.say(decide.upstream)
            }
        }
    }
    

Learning more about rule definition: defining-processors

Methods

To load this library,

  1. you need to specify this library's path in ngx_lua's lua_package_path directive. For example, lua_package_path "/path/to/lua-resty-taurus/lib/?.lua;;";.
  2. you use require to load the library into a local Lua variable:
    local taurus = require "resty.taurus"

compile

syntax: rule_engine = taurus.compile(r)

Creates a new rule engine object instance

-- creates a rule engine object
local taurus = require "resty.taurus"
local rule_engine = taurus.compile(r)

match

syntax: matched = rule_engine:match(fact, decide)

local fact = require "resty.taurus.context.fact"
local decision = require "resty.taurus.context.decision"
local decide = decision.new()
local matched = rule_engine:match(fact.new(
    ngx.req.get_headers(),
    ngx.req.get_uri_args(),
    ngx.req.get_post_args(),
    {}
), decide)
ngx.say(decide.rulename)
ngx.say(decide.upstream)

Author

Jianhao Dai (toruneko) toruneko@outlook.com

Copyright and License

This module is licensed under the MIT license.

Copyright (C) 2018, by Jianhao Dai (toruneko) toruneko@outlook.com

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

See Also

You can’t perform that action at this time.