rule-interface 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 524f8431dd91bd47d798334f77bed731e5525072
-  data.tar.gz: 3c64436cf12b292c4c4da96b13f17f58ecb2a847
+  metadata.gz: 5fc3c07de9c4511d6a73debe9c7cef8041e1dc94
+  data.tar.gz: 149ffd4045fa9e0ce2ac3d0be842fbb7f563cdf3
 SHA512:
-  metadata.gz: 3fff9269d46e83c0e95ae22418d2c0370f1ff9bb1563b2d19331236f573450460585f0ff5766e7ea0548d00c97b58e083180342eaa6957c0bb1d7434ee4a8990
-  data.tar.gz: eba32c7218cb1e4a5ed1a3807501a5e5fe0afff65932e58995b0f0ab89c5710d274272d6b08b9c67c3853cbdc3722914d8e5f085cfd85705f9a258c991f6db9d
+  metadata.gz: 4aa10c32473c36e2d2b37692e160d6f5b6100b2c29f8c134107c4e15806c1061512542166ff7bceb01cd7699bc24423b2812432cede0a64319231e2e01770480
+  data.tar.gz: 046c120e5223007d4b999f59fa19fe3e251462c5936179f94a8d6d42d11502924ef19ea90bdbb97e77d486f550114ba7eb76aa80fd7b549a5c62e1519c910192

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rule-interface (1.0.2)
+    rule-interface (1.0.3)
       activesupport (~> 3)
       rest-client (~> 1)
 

data/README.md

@@ -1,9 +1,22 @@
 # RuleInterface
 
-A ruby interface communicate with Drools
+A ruby interface to convert and communicate with Drools
 
 [![Build Status](https://travis-ci.org/NestAway/rule-interface.svg?branch=master)](https://travis-ci.org/NestAway/rule-interface)
 
+## Use case
+
+- Using [Drools](https://www.drools.org/)
+- Want a easy way to convert the data to Drools format and send
+- Stateless session
+- Agenda group implementation for stateless session (We call it namespace)
+
+## Expectation
+
+Currently this Gem is designed for stateless session.
+
+Using this you can pass a set of data (facts in Drools) and get the same data back with the modification happended (based on your rule) in Drools
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,11 +27,15 @@ gem 'rule-interface'
 
 And then execute:
 
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install rule-interface
+```shell
+gem install rule-interface
+```
 
 ## Configuration
 
@@ -53,19 +70,67 @@ RuleInterface.execute!(
         name: 'Bla2'
       }
     ],
-    user: [
-      {
-        id: 123,
-        email: 'yoman@manyo.com'
-      }
-    ]
+    user: { # Array only if multiple objects, we handle it
+      id: 123,
+      email: 'yoman@manyo.com'
+    }
   },
-  namespace: :invensense,
   container: 'team_magic_v1.2.3',
-  package: 'com.myteam.team_magic'
+  package: 'com.myteam.test',
+  namespace: :test,
+  session: 'blah'
 )
 ```
 
+### Arguments explaind
+
+#### data_hash
+Used to send data to Drools.
+
+**Syntax**:
+Inside root hash, define the data class name in ruby style as the key and put the value as an array of objects or a signle object
+
+Let's say the data class name (ruby style) you put as `line_item`, this will get converted to `{package}.LineItem`
+
+Object is a key value pair (Nested objects are not supported right now). And `id` should be an uniq identifire for the class and `id` is optional, if passed we'll return the object back
+
+#### container
+Container name of the KIE server
+
+#### package
+The package name of your JAVA models (fact class) created. And this package name will get automatically added to your data_hash models
+
+#### namespace
+> Optional argument
+
+As stateless session doesn't support agenda group feature in Drools, we build namespace as a hack for it
+
+Create a fact class in your Drools project as shown below
+
+```
+Namespace {
+  :name
+}
+```
+
+**Example rule**:
+```
+rule "rule 1"
+when
+  Namespace(name == "campine_1")
+  Product(amount > 200)
+then
+  // Do something here
+end
+```
+
+And you pass `campine_1` as your namesapce
+
+#### session
+> Optional argument
+
+Default session name in the Gem is `session`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -79,5 +144,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [Apache-2.0](https://opensource.org/licenses/Apache-2.0).
 

data/lib/rule-interface/converter.rb

@@ -2,20 +2,27 @@ module RuleInterface
   module Converter
     extend self
 
-    def hash_to_drool(data_hash:, namespace:, package:)
+    OUT_IDENTIFIER_ID = :rule_interface_out_identifier_id
+
+    def hash_to_drool(data_hash:, namespace:, package:, session:)
       payload = {}
-      payload[:lookup] = 'session'
+      payload[:lookup] = session
       payload[:commands] = []
 
+      Thread.current[OUT_IDENTIFIER_ID] = 1
+
       #insert namespace object
-      payload[:commands] << insert_object(
-        data_object: {name: namespace},
-        object_type: 'namespace',
-        package: package,
-        return_object: false
-      )
+      if namespace
+        payload[:commands] << insert_object(
+          data_object: {name: namespace},
+          object_type: 'namespace',
+          package: package,
+          return_object: false
+        )
+      end
 
       data_hash.each do |object_type, data_objects|
+        data_objects = [data_objects] unless data_objects.is_a? Array
         data_objects.each do |data_object|
           payload[:commands] << insert_object(
             data_object: data_object,
@@ -43,10 +50,6 @@ module RuleInterface
     private
 
     def insert_object(data_object:, object_type:, package:, return_object: true)
-      if return_object && data_object[:id].blank?
-        raise Error::CommonError, "Object must have an id attribute: #{data_object.to_json}"
-      end
-
       data_object = data_object.inject({}) do |m, (k,v)|
         m[k.to_s.camelize(:lower).to_sym] = v; m
       end
@@ -55,7 +58,14 @@ module RuleInterface
       insert_object = {}
       insert_object[:insert] = {}
       insert_object[:insert]['return-object'] = return_object
-      insert_object[:insert]['out-identifier'] = "#{object_type}##{data_object[:id]}" if return_object
+
+      out_identifier_id = data_object[:id]
+      if out_identifier_id.blank?
+        out_identifier_id = "RA_#{Thread.current[OUT_IDENTIFIER_ID]}"
+        Thread.current[OUT_IDENTIFIER_ID] += 1
+      end
+
+      insert_object[:insert]['out-identifier'] = "#{object_type}##{out_identifier_id}" if return_object
 
       object = {}
       object_name = "#{package}.#{object_type}"

data/lib/rule-interface/rule_executor.rb

@@ -1,7 +1,7 @@
 module RuleInterface
   module RuleExecutor
-    def execute!(data_hash:, namespace:, container:, package:)
-      payload = Converter.hash_to_drool(data_hash: data_hash, namespace: namespace, package: package)
+    def execute!(data_hash:, container:, package:, namespace: nil, session: 'session')
+      payload = Converter.hash_to_drool(data_hash: data_hash, namespace: namespace, package: package, session: session)
       response = parsed_connection!(container: container, method: "post", payload: payload)
       if response[:type] && response[:type] == "SUCCESS"
         Converter.drool_to_hash(

data/lib/rule-interface/version.rb

@@ -1,3 +1,3 @@
 module RuleInterface
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rule-interface
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ranveer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport