smarts_api 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smarts_api (0.0.1)
+    smarts_api (0.0.3)
       activesupport
       typhoeus
 

data/README.md

@@ -1,7 +1,81 @@
 smarts_api
 ==========
 
-Ruby API for Sparkling Logic SMARTS
+Ruby API for Sparkling Logic SMARTS™
 
+## Install
+```ruby
+  gem install smarts_api #use bundle if working in rails
+```
+
+##Usage
+Create in your ruby app a config/initializers/smarts_api.rb
+```ruby 
+  SMARTS_CONFIG = YAML.load_file(Rails.root.join("config","sparkling_logic.yml"))[Rails.env]
+  SmartsApi.configure do | config |
+    config.base_uri = SMARTS_CONFIG["base_uri"]
+    config.app_id = SMARTS_CONFIG["app_id"]
+    config.access_key = SMARTS_CONFIG["access_key"]
+    config.user_id = SMARTS_CONFIG["user_id"]
+    config.pwd = SMARTS_CONFIG["pwd"]
+    config.workspace_id = SMARTS_CONFIG["workspace_id"]
+    config.project_id = SMARTS_CONFIG["project_id"]
+  end
+```
+
+And then you'll need a yml config that looks something like 
+```ruby
+development: &default
+ base_uri:      http://customers.sparkological.com/DecisionServer/decision-services/deployments/
+ app_id:         #application ID
+ access_key:     #SECRET access key
+ user_id:        #the user id for the application account that has access to SMARTS
+ pwd:           #account password
+ workspace_id:   Top/Local #or wherever your workspace is defined.
+ project_id:     #Something something project name
+```
+
+Finally you can call smarts with 
+```ruby
+SmartsApi.evaluate("Decide if situation is cool", situation, logger=nil)
+```
+
+the evaluate call takes a string parameter identifying the decision to evaluate.  the eval_object is any Object, but must respond to the following methods:
+```ruby
+class Situation
+
+  def smarts_document
+    #generates a JSON document that matches the expected json format of the SMARTS project
+    [
+      {
+        :time_stamp => DateTime.now 
+        :have_money => Money.any?
+        :have_power => Power.significant_amount?
+      }
+    ]
+  end
+  
+  def process_smarts_response(body)
+    #takes a JSON document as its parameter, and processes it with whatever rules pertain to this class
+    if body["Documents"].first["is_a_cool_situation"]
+      User.notify("Your situation is cool!") 
+    end 
+  end
+  
+end
+```
+
+
+##Credits, Contributors
+
+Created by [Steve Mitchell](https://github.com/theSteveMitchell)
+
+Issues and contributions welcome.
+
+##Disclaimer
+This project and it's creators, contributors, detractors, fans, haters (who, by definition, are always gonna hate), users, and abusers are in no way associated with Sparkling Logic, the innovator and creator of SMARTS™.  We have no connection with Sparkling Logic, and are not responsible for any work they do.  
+
+From http://my.sparklinglogic.com/index.php/what-it-does:
+
+Sparkling Logic SMARTS™ is a revolutionary decision management product that provides you with an intuitive and interactive environment that dramatically lowers the learning curve to allow you to immediately start capturing and refining your decision logic.  You can combine decision logic based on business policies and expertise with decision logic revealed in your historical data- so you can narrow to the most impactful and high-performance business decision.   Collaboration is built into SMARTS so all relevant stakeholders can participate in defining and managing automated decisions.
 
-This project and it's creators, contributors, fans, and haters are in no way associated with Sparkling Logic, the innovator and creator of SMARTS.

data/lib/smarts_api/message/evaluate_message.rb

@@ -1,7 +1,7 @@
 class SmartsApi::EvaluateMessage < SmartsApi::Message
 
-  def send(session, member, decision)
-    body = make_form(request_params(session, member, decision))
+  def send(session, obj_hash, decision)
+    body = make_form(request_params(session, obj_hash, decision))
     log "Evaluating"
     response = Typhoeus::Request.post(uri,
                                       :method => method,
@@ -20,16 +20,13 @@ class SmartsApi::EvaluateMessage < SmartsApi::Message
 
       raise SmartsApi::Error, "Rules Evaluation failed.  Returned JSON is blank."
     end
-
-    log "Updating issues"
-    member.process_smarts_response body
     return body
   end
 
-  def request_params(session, member, decision)
+  def request_params(session, obj_hash, decision)
     params = {
         :appId => SmartsApi::Configuration.app_id,
-        :reqData => request_document(session, member, decision),
+        :reqData => request_document(session, obj_hash, decision),
         :reqTime => timestamp,
         :session => session
     }
@@ -39,9 +36,9 @@ class SmartsApi::EvaluateMessage < SmartsApi::Message
     return params.merge(signature)
   end
 
-  def request_document(session, member, decision)
+  def request_document(session, obj_hash, decision)
     doc = {:OperationId =>1 , :Header => {:SessionId => session, :DecisionId => decision}, :Body => {:Documents => []}}
-    doc[:Body][:Documents] = member.smarts_document
+    doc[:Body][:Documents] = obj_hash
     return doc.to_json
   end
 

data/lib/smarts_api/version.rb

@@ -1,5 +1,5 @@
 module SmartsApi
   module Version # :nodoc:
-    STRING = '0.0.2'
+    STRING = '0.0.3'
   end
 end

data/lib/smarts_api.rb

@@ -18,15 +18,16 @@ module SmartsApi
   Dir[File.expand_path('../../lib/smarts_api/*.rb', __FILE__)].each {|f| require f}
   Dir[File.expand_path('../../lib/smarts_api/*/*.rb', __FILE__)].each {|f| require f}
 
-  def self.evaluate(decision, obj, logger = nil)
-    raise SmartsApi::Error.new("Object to be evaluated must define a method 'smarts_document'") unless obj.respond_to?(:smarts_document)
+  def self.evaluate(decision, obj_hash, logger = nil)
     logger.info "processing request for #{obj.class} id=#{obj.id}{" if logger.respond_to?(:info)
 
     session = SmartsApi::ConnectMessage.new().send
     response = SmartsApi::EvaluateMessage.new().
-        send(session, obj, decision)
+        send(session, obj_hash, decision)
 
     SmartsApi::DisconnectMessage.new().send(session)
+
+    return response
   end
 
 end

data/spec/smarts_api/message/evaluate_message_spec.rb

@@ -7,37 +7,31 @@ describe SmartsApi::EvaluateMessage do
       SmartsApi::Configuration.access_key = "sshhhh...Secret!"
     end
 
-    let(:eval_class) {
-    Class.new() do
-
-      def smarts_document
-       "123"
-      end
-
-      def process_smarts_response(body)
-
-      end
-    end
+    let(:obj_hash) {
+    {:key => "value!!!?"}
   }
 
-  let(:eval_object) {
-     eval_class.new()
-  }
-
-  it 'should return session ID if successful' do
+  it 'should return request body if successful' do
 
     body = "{\"OperationId\":1,\"Header\":{\"SessionId\":\"e3e2b012-e9b6-45e7-a96a-a009ebf0a07a\"},\"Body\":{\"Documents\":[{\"identification\":{\"actor_group\":\"root\",\"actor_id\":3,\"gender\":\"Male\",\"birth_date\":\"1984-12-08T06:00:00Z\"},\"historical_properties\":[{\"weight\":\"150\"}]}]},\"ErrorInfo\":null,\"Metrics\":null,\"Success\":true,\"OperationException\":null}"
 
     stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
     .to_return(:status => 200, :body => body)
-    SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169", eval_object, "Issues Analysis Decision").should ==  JSON.parse(body)["Body"]
+    SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169", obj_hash, "Issues Analysis Decision").should ==  {"Documents"=>
+                                                                              [{"identification"=>
+                                                                                 {"actor_group"=>"root",
+                                                                                  "actor_id"=>3,
+                                                                                  "gender"=>"Male",
+                                                                                  "birth_date"=>"1984-12-08T06:00:00Z"},
+                                                                                "historical_properties"=>[{"weight"=>"150"}]}]}
+
 
   end
 
   it 'should throw an error if the connection returns an error' do
     stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
     .to_return(:status => 200, :body => "{\"OperationId\":0,\"Header\":{\"SessionId\":\"00000000-0000-0000-0000-000000000000\",\"TransactionTime\":\"2012-06-22T21:02:16.642625Z\",\"Workspace\":null,\"DeploymentId\":null,\"DecisionId\":null},\"Body\":null,\"ErrorInfo\":{\"ErrorCode\":\"ServerException\",\"ErrorMessage\":\"Exception during connection\",\"Details\":[\"Invalid API access\"]},\"Metrics\":null,\"Success\":false,\"OperationException\":{\"IsRestException\":true,\"ErrorType\":\"DocApiAccessDeniedException\",\"CompleteStackTrace\":\"Type: DocApiAccessDeniedException\\r\\nMessage: Invalid API access\\r\\nStack Trace:\\r\\n   at Splog.Rest.Base.DocRestHttpHandler.VerifyHmacSignature(String method, IEnumerable`1 keys, String signature, String[] paramaters)\\r\\n   at Splog.Rest.Decisions.DocRestDecisionService.Connect(String appId, String reqTime, String userId, String pwd, String workspaceId, String reqData, String sign)\\r\\n\\r\\n\",\"ExtraInfo\":null,\"Message\":\"[DecisionServer] Exception connecting to the decision server for session 72950db0-9639-477b-b824-b82ad5122b56\",\"Data\":{}}}")
-    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",eval_object, "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
+    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",obj_hash, "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
 
   end
 
@@ -45,7 +39,7 @@ describe SmartsApi::EvaluateMessage do
 
     stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
     .to_return(:status => 200, :body => "{\"OperationId\":0,\"Header\":{\"SessionId\":\"00000000-0000-0000-0000-000000000000\",\"TransactionTime\":\"2012-06-22T21:02:16.642625Z\",\"Workspace\":null,\"DeploymentId\":null,\"DecisionId\":null},\"Body\":null,\"ErrorInfo\":{\"ErrorCode\":\"ServerException\",\"ErrorMessage\":\"Exception during connection\",\"Details\":[\"Invalid API access\"]},\"Metrics\":null,\"Success\":false,\"OperationException\":{\"IsRestException\":true,\"ErrorType\":\"DocApiAccessDeniedException\",\"CompleteStackTrace\":\"Type: DocApiAccessDeniedException\\r\\nMessage: Invalid API access\\r\\nStack Trace:\\r\\n   at Splog.Rest.Base.DocRestHttpHandler.VerifyHmacSignature(String method, IEnumerable`1 keys, String signature, String[] paramaters)\\r\\n   at Splog.Rest.Decisions.DocRestDecisionService.Connect(String appId, String reqTime, String userId, String pwd, String workspaceId, String reqData, String sign)\\r\\n\\r\\n\",\"ExtraInfo\":null,\"Message\":\"[DecisionServer] Exception connecting to the decision server for session 72950db0-9639-477b-b824-b82ad5122b56\",\"Data\":{}}}")
-    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",eval_object,  "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
+    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",obj_hash,  "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
 
   end
 
@@ -53,7 +47,7 @@ describe SmartsApi::EvaluateMessage do
 
     stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
     .to_return(:status => 200)
-    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",eval_object, "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
+    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",obj_hash, "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
 
   end
 
@@ -61,26 +55,16 @@ describe SmartsApi::EvaluateMessage do
 
     stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
     .to_return(:status => 500)
-    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",eval_object, "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
+    expect{SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169",obj_hash, "Issues Analysis Decision")}.to raise_error(SmartsApi::Error)
 
   end
 
-  it 'should call the document method on the member object' do
-    eval_object.should_receive(:smarts_document)
-    body = "{\"OperationId\":1,\"Header\":{\"SessionId\":\"e3e2b012-e9b6-45e7-a96a-a009ebf0a07a\"},\"Body\":{\"Documents\":[{\"identification\":{\"actor_group\":\"root\",\"actor_id\":3,\"gender\":\"Male\",\"birth_date\":\"1984-12-08T06:00:00Z\"},\"historical_properties\":[{\"weight\":\"150\"}]}]},\"ErrorInfo\":null,\"Metrics\":null,\"Success\":true,\"OperationException\":null}"
-
-    stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
-    .to_return(:status => 200, :body => body)
-    SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169", eval_object, "Issues Analysis Decision").should ==  JSON.parse(body)["Body"]
-  end
-
-  it "should pass the returned message body to the evaluated object for processing" do
+  describe "request document" do
+    it "include the input hash" do
+      SmartsApi::EvaluateMessage.new().request_document("487d2c44-43fe-44d3-988f-ea462af03169", obj_hash, "Issues Analysis Decision").should ==
+      "{\"OperationId\":1,\"Header\":{\"SessionId\":\"487d2c44-43fe-44d3-988f-ea462af03169\",\"DecisionId\":\"Issues Analysis Decision\"},\"Body\":{\"Documents\":{\"key\":\"value!!!?\"}}}"
+    end
 
-    body = "{\"OperationId\":1,\"Header\":{\"SessionId\":\"e3e2b012-e9b6-45e7-a96a-a009ebf0a07a\"},\"Body\":{\"Documents\":[{\"identification\":{\"actor_group\":\"root\",\"actor_id\":3,\"gender\":\"Male\",\"birth_date\":\"1984-12-08T06:00:00Z\"},\"historical_properties\":[{\"weight\":\"150\"}]}]},\"ErrorInfo\":null,\"Metrics\":null,\"Success\":true,\"OperationException\":null}"
-    eval_object.should_receive(:process_smarts_response).with(JSON.parse(body)["Body"])
-    stub_http_request(:post, "#{SmartsApi::Configuration.base_uri}evaluate")
-    .to_return(:status => 200, :body => body)
-    SmartsApi::EvaluateMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169", eval_object, "Issues Analysis Decision").should ==  JSON.parse(body)["Body"]
   end
 
 end

data/spec/smarts_api_spec.rb

@@ -10,49 +10,26 @@ describe SmartsApi do
     end
 
     describe "expectations on eval object" do
+      it 'should accept any hash as a ' do
 
-      it 'should raise error and not call connect if obj is nil' do
-        expect{SmartsApi.evaluate(
-        "string", nil
-        )}.to raise_error(SmartsApi::Error, "Object to be evaluated must define a method 'smarts_document'")
-      end
-
-      it 'should raise error and not call connect if obj does not define the document method' do
-        RegularClass = Class.new() {}
-        instance = RegularClass.new
-        instance.should_not be_nil
-        expect{SmartsApi.evaluate(
-        "string", instance
-        )}.to raise_error(SmartsApi::Error, "Object to be evaluated must define a method 'smarts_document'")
-      end
-
-      it 'should accept any object that defines the document method' do
-        EvalClass= Class.new() do
-          def smarts_document
-            "EvalClass.Instance 1"
-          end
-        end
-
-        instance = EvalClass.new
-        instance.should_not be_nil
+        hash = {:hash? => true}
 
         SmartsApi::ConnectMessage.any_instance.should_receive(:send).and_return("session 334")
         SmartsApi::EvaluateMessage.any_instance.should_receive(:send)
         SmartsApi::DisconnectMessage.any_instance.should_receive(:send).with("session 334")
-        SmartsApi.evaluate("string", instance)
+        SmartsApi.evaluate("string", hash)
       end
     end
 
     describe "specifying decision string" do
       it "should include the decision name and session when sending the evaluate message" do
 
-        instance = EvalClass.new
-        instance.should_not be_nil
+        hash = {:hash? => true}
         SmartsApi::ConnectMessage.any_instance.should_receive(:send).and_return("session 3339")
-        SmartsApi::EvaluateMessage.any_instance.should_receive(:send).with("session 3339", instance, "Chosen_decision")
+        SmartsApi::EvaluateMessage.any_instance.should_receive(:send).with("session 3339", hash, "Chosen_decision")
         SmartsApi::DisconnectMessage.any_instance.should_receive(:send).with("session 3339")
 
-        SmartsApi.evaluate("Chosen_decision", instance)
+        SmartsApi.evaluate("Chosen_decision", hash)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smarts_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -91,7 +91,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: smarts_api-0.0.2
+description: smarts_api-0.0.3
 email:
 - theSteveMitchell@gmail.com
 executables: []