Metadata-Version: 1.1
Name: durable-rules
Version: 0.32.6
Summary: for real time analytics
Home-page: https://github.com/jruizgit/rules
Author: Jesus Ruiz
Author-email: jr3791@live.com
License: MIT
Description: =============
        durable_rules
        =============  
        for real time analytics
        -----------------------
        durable_rules is a polyglot micro-framework for real-time, consistent and scalable coordination of events. With durable_rules you can track and analyze information about things that happen (events) by combining data from multiple sources to infer more complicated circumstances.
        
        A full forward chaining implementation (A.K.A. Rete) is used to evaluate facts and massive streams of events in real time. A simple, yet powerful meta-liguistic abstraction lets you define simple and complex rulesets, such as flowcharts, statecharts, nested statecharts, paralel and time driven flows. 
        
        The Durable Rules core engine is implemented in C, which enables ultra fast rule evaluation and inference as well as muti-language support. Durable Rules relies on state of the art technologies: Werkzeug(http://werkzeug.pocoo.org/ is used to host rulesets). Inference state is cached using Redis(http://www.redis.io), This allows for fault tolerant execution and scale-out without giving up performance.
        
        **Example 1**
        
        durable_rules is simple: to define a rule, all you need to do is describe the event or fact pattern to match (antecedent) and the action to take (consequent).
        
        In this example the rule can be triggered by posting `{"id": 1, "subject": "World"}` to url `http://localhost:5000/test/1`
        
        ::
        
            from durable.lang import *
        
            with ruleset('test'):
                # antecedent
                @when_all(m.subject == 'World')
                def say_hello(c):
                    # consequent
                    print ('Hello {0}'.format(c.m.subject))
        
            run_all()
        
        **Example 2**
        
        Let’s consider a couple of fictitious fraud rules used in bank account management.
        Note: I'm paraphrasing the example presented in this article(https://www.packtpub.com/books/content/drools-jboss-rules-50complex-event-processing).  
        
        1. If there are two debit requests greater than 200% the average monthly withdrawal amount in a span of 2 minutes, flag the account as medium risk.
        2. If there are three consecutive increasing debit requests, withdrawing more than 70% the average monthly balance in a span of three minutes, flag the account as high risk.
        
        ::
        
            from durable.lang import *
            
            with ruleset('fraud_detection'):
                # compute monthly averages
                @when_all(span(86400), (m.t == 'debit_cleared') | (m.t == 'credit_cleared'))
                def handle_balance(c):
                    debit_total = 0
                    credit_total = 0
                    for tx in c.m:
                        if tx.t == 'debit_cleared':
                            debit_total += tx.amount
                        else:
                            credit_total += tx.amount
        
                    c.s.balance = c.s.balance - debit_total + credit_total
                    c.s.avg_balance = (c.s.avg_balance * 29 + c.s.balance) / 30
                    c.s.avg_withdraw = (c.s.avg_withdraw * 29 + debit_total) / 30
                
                # medium risk rule
                @when_all(c.first << (m.t == 'debit_request') & 
                                     (m.amount > c.s.avg_withdraw * 2),
                          c.second << (m.t == 'debit_request') & 
                                      (m.amount > c.s.avg_withdraw * 2) & 
                                      (m.stamp > c.first.stamp) &
                                      (m.stamp < c.first.stamp + 120))
                def first_rule(c):
                    print('Medium Risk')
        
                # high risk rule
                @when_all(c.first << m.t == 'debit_request',
                          c.second << (m.t == 'debit_request') &
                                      (m.amount > c.first.amount) & 
                                      (m.stamp < c.first.stamp + 180),
                          c.third << (m.t == 'debit_request') & 
                                     (m.amount > c.second.amount) & 
                                     (m.stamp < c.first.stamp + 180),
                          s.avg_balance < (c.first.amount + c.second.amount + c.third.amount) / 0.7)
                def second_rule(c):
                    print('High Risk')
        
            run_all()
        
        **Example 3**
        
        durable_rules can also be used to solve traditional production bussiness rules problems. The example below is the 'Miss Manners' benchmark. Miss Manners has decided to throw a party. She wants to seat her guests such that adjacent guests are of opposite sex and share at least one hobby. 
        
        To improve readability, with durable_rules, the ruleset flow structure can be defined using a statechart. The benchmark results compare well with other business rules systems both from an execution time as well as memory utilization perspective.
        
        ::
        
            from durable.lang import *
        
            with statechart('miss_manners'):
                with state('start'):
                    @to('assign')
                    @when_all(m.t == 'guest')
                    def assign_first_seating(c):
                        c.s.count = 0
                        c.s.g_count = 1000
                        c.assert_fact({'t': 'seating',
                                       'id': c.s.g_count,
                                       's_id': c.s.count, 
                                       'p_id': 0, 
                                       'path': True, 
                                       'left_seat': 1, 
                                       'left_guest_name': c.m.name,
                                       'right_seat': 1,
                                       'right_guest_name': c.m.name})
                        c.assert_fact({'t': 'path',
                                       'id': c.s.g_count + 1,
                                       'p_id': c.s.count, 
                                       'seat': 1, 
                                       'guest_name': c.m.name})
                        c.s.count += 1
                        c.s.g_count += 2
                        print('assign {0}'.format(c.m.name))
        
                with state('assign'):
                    @to('make')
                    @when_all(c.seating << (m.t == 'seating') & 
                                           (m.path == True),
                              c.right_guest << (m.t == 'guest') & 
                                               (m.name == c.seating.right_guest_name),
                              c.left_guest << (m.t == 'guest') & 
                                              (m.sex != c.right_guest.sex) & 
                                              (m.hobby == c.right_guest.hobby),
                              none((m.t == 'path') & 
                                   (m.p_id == c.seating.s_id) & 
                                   (m.guest_name == c.left_guest.name)),
                              none((m.t == 'chosen') & 
                                   (m.c_id == c.seating.s_id) & 
                                   (m.guest_name == c.left_guest.name) & 
                                   (m.hobby == c.right_guest.hobby)))
                    def find_seating(c):
                        c.assert_fact({'t': 'seating',
                                       'id': c.s.g_count,
                                       's_id': c.s.count, 
                                       'p_id': c.seating.s_id, 
                                       'path': False, 
                                       'left_seat': c.seating.right_seat, 
                                       'left_guest_name': c.seating.right_guest_name,
                                       'right_seat': c.seating.right_seat + 1,
                                       'right_guest_name': c.left_guest.name})
                        c.assert_fact({'t': 'path',
                                       'id': c.s.g_count + 1,
                                       'p_id': c.s.count, 
                                       'seat': c.seating.right_seat + 1, 
                                       'guest_name': c.left_guest.name})
                        c.assert_fact({'t': 'chosen',
                                       'id': c.s.g_count + 2,
                                       'c_id': c.seating.s_id,
                                       'guest_name': c.left_guest.name,
                                       'hobby': c.right_guest.hobby})
                        c.s.count += 1
                        c.s.g_count += 3
        
                with state('make'):
                    @to('make')
                    @when_all(cap(1000),
                              c.seating << (m.t == 'seating') & 
                                           (m.path == False),
                              c.path << (m.t == 'path') & 
                                        (m.p_id == c.seating.p_id),
                              none((m.t == 'path') & 
                                   (m.p_id == c.seating.s_id) & 
                                   (m.guest_name == c.path.guest_name)))
                    def make_path(c):
                        for frame in c.m:
                            c.assert_fact({'t': 'path',
                                           'id': c.s.g_count,
                                           'p_id': frame.seating.s_id, 
                                           'seat': frame.path.seat, 
                                           'guest_name': frame.path.guest_name})
                            c.s.g_count += 1
                        
                    @to('check')
                    @when_all(pri(1), (m.t == 'seating') & (m.path == False))
                    def path_done(c):
                        c.retract_fact(c.m)
                        c.m.id = c.s.g_count
                        c.m.path = True
                        c.assert_fact(c.m)
                        c.s.g_count += 1
                        print('path sid: {0}, pid: {1}, left guest: {2}, right guest {3}'.format(c.m.s_id, c.m.p_id, c.m.left_guest_name, c.m.right_guest_name))
        
                with state('check'):
                    @to('end')
                    @when_all(c.last_seat << m.t == 'last_seat', 
                             (m.t == 'seating') & (m.right_seat == c.last_seat.seat))
                    def done(c):
                        print('end')
                    
                    to('assign')
        
                state('end')
        
        **Reference Manual:**
        
        - Python(https://github.com/jruizgit/rules/blob/master/docs/py/reference.md/)
        
        **Blog:** 
        
        - Polyglot (03/2015):http://jruizblog.com/2015/03/02/polyglot/
        - Rete_D (02/2015):http://jruizblog.com/2015/02/23/rete_d/
        - Boosting Performance with C (08/2014): http://jruizblog.com/2014/08/19/boosting-performance-with-c/
        - Rete Meets Redis (02/2014):http://jruizblog.com/2014/02/02/rete-meets-redis/
        - From Expert Systems to Cloud Scale Event Processing (01/2014):http://jruizblog.com/2014/01/27/event-processing/
        
        
Keywords: rules_engine rete forward_chaining event_stream state_machine workflow streaming_analytics
Platform: UNKNOWN
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
