smarts_api 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smarts_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    smarts_api (0.0.1)
+      active_support
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    addressable (2.3.5)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    ffi (1.9.0)
+    mime-types (1.25)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    safe_yaml (0.9.5)
+    timecop (0.6.3)
+    typhoeus (0.6.5)
+      ethon (~> 0.6.1)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 2.14.1)
+  smarts_api!
+  timecop
+  webmock

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Mitchell
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,7 @@
+smarts_api
+==========
+
+Ruby API for Sparkling Logic SMARTS
+
+
+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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/smarts_api/error.rb

@@ -0,0 +1,3 @@
+class SmartsApi::Error < StandardError
+
+end

data/lib/smarts_api/message/connect_message.rb

@@ -0,0 +1,45 @@
+class SmartsApi::ConnectMessage < SmartsApi::Message
+
+    def send
+      logger.info "Connecting to #{uri}" if logger.respond_to?(:info)
+      response = Typhoeus::Request.post(uri,
+        :method => method,
+        :headers => {:Accept => "text/json"},
+        :body => make_form(request_params)
+      )
+      raise SmartsApi::Error, "Service connection failed.  Recieved empty reply" if response.nil? || response.body.blank?
+      reply = JSON.parse(response.body)
+
+      raise SmartsApi::Error, "Connection failed.  Received malformed response." unless reply["Header"] && reply["Header"]["SessionId"]
+
+      session = reply["Header"]["SessionId"]
+      raise SmartsApi::Error, "Connection failed.  Did not receive session ID" if session == "00000000-0000-0000-0000-000000000000"
+
+      return session
+    end
+
+    def request_document
+      {:OperationId =>1 , :Header => {:DeploymentId => project_id}}.to_json
+    end
+
+    def request_params
+      params = {
+          :appId => app_id,
+          :pwd => pwd,
+          :reqData => request_document,
+          :reqTime => self.timestamp,
+          :userId =>  user_id,
+          :workspaceId => workspace_id
+      }
+      signature = {
+          :sign => sign_request(params)
+      }
+      return params.merge(signature)
+    end
+
+    def uri
+      "#{base_uri}connect"
+    end
+
+end
+

data/lib/smarts_api/message/disconnect_message.rb

@@ -0,0 +1,39 @@
+class SmartsApi::DisconnectMessage < SmartsApi::Message
+
+
+  def send(session)
+    body = make_form(request_params(session))
+    logger.info "Disconnecting" if logger.respond_to?(:info)
+    response = Typhoeus::Request.post(uri,
+                                      :method  => method,
+                                      :headers => {:Accept => "text/json"},
+                                      :body    => body
+    )
+    raise SmartsApi::Error, "Service connection failed.  Recieved empty reply" if response.nil? || response.body.blank?
+    reply = JSON.parse(response.body)
+
+    raise SmartsApi::Error, "Connection failed.  Received malformed response." unless reply["Header"] && reply["Header"]["SessionId"]
+
+    session = reply["Header"]["SessionId"]
+    raise SmartsApi::Error, "Connection failed.  Did not receive session ID" if session == "00000000-0000-0000-0000-000000000000"
+    return session
+  end
+
+  def request_params(session)
+    params = {
+        :appId => app_id,
+        :reqTime => timestamp,
+        :session => session
+    }
+    signature = {
+        :sign => sign_request(params)
+    }
+    return params.merge(signature)
+  end
+
+  def uri
+    "#{base_uri}disconnect"
+  end
+
+
+end

data/lib/smarts_api/message/evaluate_message.rb

@@ -0,0 +1,51 @@
+class SmartsApi::EvaluateMessage < SmartsApi::Message
+
+  def send(session, member, decision)
+    body = make_form(request_params(session, member, decision))
+    logger.info "Evaluating" if logger.respond_to?(:info)
+    response = Typhoeus::Request.post(uri,
+                                      :method => method,
+                                      :headers => {:Accept => "text/json"},
+                                      :body => body
+    )
+    raise SmartsApi::Error, "Rules Evaluation failed failed.  Recieved empty reply" if response.nil? || response.body.blank?
+    reply = JSON.parse(response.body)
+
+    raise SmartsApi::Error, "Rules Evaluation failed failed.  Received malformed response." unless reply["Header"] && ["Body"]
+
+    body = reply["Body"]
+
+    if body.blank?
+      logger.info "Rules Engine Evaluation failed. \n\n #{body} \n\n #{response.body}" if logger.respond_to?(:info)
+
+      raise SmartsApi::Error, "Rules Evaluation failed.  Returned JSON is blank."
+    end
+
+    logger.info "Updating issues" if logger.respond_to?(:info)
+    member.process_smarts_response body
+    return body
+  end
+
+  def request_params(session, member, decision)
+    params = {
+        :appId => app_id,
+        :reqData => request_document(session, member, decision),
+        :reqTime => timestamp,
+        :session => session
+    }
+    signature = {
+        :sign => sign_request(params)
+    }
+    return params.merge(signature)
+  end
+
+  def request_document(session, member, decision)
+    doc = {:OperationId =>1 , :Header => {:SessionId => session, :DecisionId => decision}, :Body => {:Documents => []}}
+    doc[:Body][:Documents] = member.smarts_document
+    return doc.to_json
+  end
+
+   def uri
+      "#{base_uri}evaluate"
+    end
+end

data/lib/smarts_api/message.rb

@@ -0,0 +1,81 @@
+require 'typhoeus'
+require 'json'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/array'
+include ERB::Util
+require 'openssl'
+require 'base64'
+
+class SmartsApi::Message
+  attr_reader :logger
+  cattr_accessor :user_id, :pwd, :app_id, :workspace_id, :access_key, :base_uri, :project_id
+
+
+  def initialize(logger=nil)
+    @logger = logger
+  end
+
+  def method
+    :post
+  end
+
+  def uri
+    base_uri
+  end
+
+  def sign_request(params)
+    #Below you will find the reverse-engineered ruby implementation of Sparkling Logic's security signing algorithm.
+    #this was translated from a javascript library on their documentation site, then
+
+    #The params object include the following parameters, in this order: AppId, pwd, reqData, reqTime, userID, and workspaceID.
+    #naming of the parameters is significant, and case-sensitive.
+
+    #combine the parameters into a long encoded string (again, order of elements is critical)
+    encoded_parts = []
+    http = URI.parse(uri)
+    encoded_parts[0] = method.to_s.upcase
+    encoded_parts[1] = http.host
+    encoded_parts[2] = http.request_uri
+    encoded_parts[3] = encode_hash(params)
+
+    encoded = encoded_parts.join("\n") #Join parts with newline character
+
+    #5 Digest the encode string with SHA256, using the pre-shared AccessKey as the digest key.
+    digest = OpenSSL::Digest::Digest.new('sha256')
+    hash = OpenSSL::HMAC.hexdigest(digest, access_key, encoded)
+
+    #6 OpenSSL::Digest correctly translates the Hash to a string of bytes.  Sparkling Logic's algorithm ...unexpectedle converts the hex value to the corresponding ascii code.
+    #So we need to iterate each pair in our byte string and convert to ascii. this is a little ugly, but necessary
+    #7 AND THEN we encode that string to base64.  Not sure why, exactly...
+    signature =  Base64.encode64(hex_string_to_ascii(hash))
+    #8 re-URL_encode the string and remove line-endings.  Again, for absolutely no logical reason.  I think the javascript version did this automatically.
+    signature =  url_encode(signature)
+    signature =  signature.gsub("%0A", "" )
+    return signature
+
+  end
+
+
+  def hex_string_to_ascii hex_str
+    #we need to iterate our hex-string and convert each pair to a hex-number.  Then evaluate that as ascii code and replace with the corresponding ascii character.
+    ascii_str = ''
+    hex_str.split('').in_groups_of(2){|c| ascii_str << (c[0]+c[1]).hex.chr }
+    ascii_str
+  end
+
+  def timestamp
+    Time.now.utc.iso8601.to_s # => "2012-06-21T18:15:09Z"
+  end
+
+  def encode_hash(hash)
+    new = []
+    hash.each do |k,v|
+      new << k.to_s+"="+url_encode(v)
+    end
+    return new.join("&")
+  end
+
+  def make_form(request_params)
+    request_params.map{|k,v| "#{k}=#{v}"}.join("&")
+  end
+end

data/lib/smarts_api/version.rb

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

data/lib/smarts_api.rb

@@ -0,0 +1,17 @@
+
+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)
+    logger.info "processing request for #{obj}" if logger.respond_to?(:info)
+
+    session = SmartsApi::ConnectMessage.new(logger).send
+    response = SmartsApi::EvaluateMessage.new(logger).
+        send(session, obj, decision)
+
+    #SmartsApi::DisconnectMessage.new(logger).disconnect(session)
+  end
+
+end

data/smarts_api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/smarts_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Steve Mitchell"]
+  gem.email         = ["theSteveMitchell@gmail.com"]
+  gem.description   = "smarts_api-#{SmartsApi::Version::STRING}"
+  gem.summary       = "api gem for Sparkling Logic's SMARTS business logic platform"
+  gem.homepage      = "http://github.com/theSteveMitchell/smarts_api"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "smarts_api"
+  gem.require_paths = ["lib"]
+  gem.version       = SmartsApi::Version::STRING
+
+  gem.add_dependency('typhoeus')
+  gem.add_dependency('activesupport')
+
+  gem.add_development_dependency('rspec', '~> 2.14.1')
+  gem.add_development_dependency('webmock')
+  gem.add_development_dependency('timecop')
+end

data/spec/smarts_api/message/connect_message_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe SmartsApi::ConnectMessage do
+  before (:all) do
+      SmartsApi::Message.base_uri = "http://smarts.dev.thismashine.com/"
+      SmartsApi::Message.access_key = "sshhhh...Secret!"
+    end
+
+  it 'should return session ID if successful' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}connect")
+    .to_return(:status => 200, :body => "{\"Header\":{\"SessionId\":\"487d2c44-43fe-44d3-988f-ea462af03169\"},\"Body\":null,\"ErrorInfo\":null,\"Metrics\":null,\"Success\":true,\"OperationException\":null}")
+
+
+    SmartsApi::ConnectMessage.new().send.should == "487d2c44-43fe-44d3-988f-ea462af03169"
+
+  end
+
+  it 'should throw an error if the connection returns an error' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}connect")
+    .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::ConnectMessage.new().send}.to raise_error(SmartsApi::Error)
+
+  end
+
+  it 'should throw an error if the returned sessionID is empty' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}connect")
+    .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::ConnectMessage.new().send}.to raise_error(SmartsApi::Error)
+
+  end
+
+  it 'should throw an error if no body is returned' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}connect")
+    .to_return(:status => 200)
+    expect{SmartsApi::ConnectMessage.new().send}.to raise_error(SmartsApi::Error)
+
+  end
+
+  it 'should throw an error if status code is bad' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}connect")
+    .to_return(:status => 500)
+    expect{SmartsApi::ConnectMessage.new().send}.to raise_error(SmartsApi::Error)
+
+  end
+
+
+end

data/spec/smarts_api/message/disconnect_message_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+
+describe SmartsApi::DisconnectMessage do
+  it 'should return session ID if successful' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}disconnect")
+    .to_return(:status => 200, :body => "{\"Header\":{\"SessionId\":\"487d2c44-43fe-44d3-988f-ea462af03169\"},\"Body\":null,\"ErrorInfo\":null,\"Metrics\":null,\"Success\":true,\"OperationException\":null}")
+
+
+    SmartsApi::DisconnectMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169").should == "487d2c44-43fe-44d3-988f-ea462af03169"
+
+  end
+
+  it 'should throw an error if the connection returns an error' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}disconnect")
+    .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::DisconnectMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169")}.to raise_error(SmartsApi::Error)
+
+  end
+
+  it 'should throw an error if the returned sessionID is empty returns an error' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}disconnect")
+    .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::DisconnectMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169")}.to raise_error(SmartsApi::Error)
+
+  end
+
+  it 'should throw an error if no body is returned' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}disconnect")
+    .to_return(:status => 200)
+    expect{SmartsApi::DisconnectMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169")}.to raise_error(SmartsApi::Error)
+
+  end
+
+  it 'should throw an error if status code is bad' do
+    stub_http_request(:post, "#{SmartsApi::Message.base_uri}disconnect")
+    .to_return(:status => 500)
+    expect{SmartsApi::DisconnectMessage.new().send("487d2c44-43fe-44d3-988f-ea462af03169")}.to raise_error(SmartsApi::Error)
+
+  end
+
+
+end

data/spec/smarts_api/message/evaluate_message_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe SmartsApi::EvaluateMessage do
+
+  before (:all) do
+      SmartsApi::Message.base_uri = "http://smarts.dev.thismashine.com/"
+      SmartsApi::Message.access_key = "sshhhh...Secret!"
+    end
+
+    let(:eval_class) {
+    Class.new() do
+
+      def smarts_document
+       "123"
+      end
+
+      def process_smarts_response(body)
+
+      end
+    end
+  }
+
+  let(:eval_object) {
+     eval_class.new()
+  }
+
+  it 'should return session ID 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::Message.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 throw an error if the connection returns an error' do
+    stub_http_request(:post, "#{SmartsApi::Message.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)
+
+  end
+
+  it 'should throw an error if the returned sessionID is empty returns an error' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.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)
+
+  end
+
+  it 'should throw an error if no body is returned' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.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)
+
+  end
+
+  it 'should throw an error if status code is bad' do
+
+    stub_http_request(:post, "#{SmartsApi::Message.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)
+
+  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::Message.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
+
+    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::Message.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/message_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe SmartsApi::Message do
+
+  before (:all) do
+      SmartsApi::Message.base_uri = "http://www.versign.com/request/doSomething.aspc"
+      SmartsApi::Message.access_key = "secretKey"
+    end
+
+  describe 'initializer' do
+    it "should keep the logger for logging purposes" do
+      logger = Logger.new(STDOUT)
+      message = SmartsApi::Message.new(logger)
+
+      message.logger.should == logger
+
+    end
+  end
+
+  describe 'timestamp' do
+    it "should be formatted correctly" do
+      Timecop.freeze(Time.utc(2012, 6, 21, 12, 34, 56))
+      SmartsApi::Message.new().timestamp.should == "2012-06-21T12:34:56Z"
+      Timecop.return
+
+    end
+  end
+
+  describe 'hash encoding' do
+    it 'should convert a hash into a url_encoded string' do
+      hash = {:a => "123", :b => "aber=/3sd8:&++\\", :c => "hellpo"}
+
+      SmartsApi::Message.new().encode_hash(hash).should == "a=123&b=aber%3D%2F3sd8%3A%26%2B%2B%5C&c=hellpo"
+
+    end
+
+  end
+
+  describe 'ascii conversion' do
+    it "should convert a hex string to ascii in the way the service expects" do
+      #even if it's wrong...'
+
+      SmartsApi::Message.new().hex_string_to_ascii("3D").should == "="
+      SmartsApi::Message.new().hex_string_to_ascii("0B").should == "\v"
+      SmartsApi::Message.new().hex_string_to_ascii("52").should == "R"
+
+      hex = "52410baf20302e9e2c31b5ecea597348aa3df3067c58cf35cb5bd94273dc1de0"
+      SmartsApi::Message.new().hex_string_to_ascii(hex)
+      .should == "RA\v\xAF 0.\x9E,1\xB5\xEC\xEAYsH\xAA=\xF3\x06|X\xCF5\xCB[\xD9Bs\xDC\x1D\xE0"
+    end
+
+
+  end
+
+  #Notes on signing:  The signing algorithm for Sparkling Logic is very brittle and depends on ALL of the
+  #values in sparkling_logic.yml, as well as timestamp.  The below tests will fail if any of those settings change.
+  #so if the signature does not match the expected, and one of those settings did change, we can update the expected sig.
+  describe 'signing' do
+    it "should create a correct signature when no params supplied" do
+      Timecop.freeze(Time.utc(2012, 6, 21, 12, 34, 56))
+
+        SmartsApi::Message.new().sign_request({})
+        .should == "dOqhdTRLwMSUBSO7HZDRTsD63fVVA%2FKnffCn3DuaRnE%3D"
+     Timecop.return
+    end
+
+    it "should create a correct signature when params supplied" do
+      Timecop.freeze(Time.utc(2012, 6, 21, 12, 34, 56))
+      params = {:param1 => "nothing", :param2 => "nothing More"}
+
+      SmartsApi::Message.new().sign_request(params)
+      .should == "EIvlfFrm7FpotCVp6MIt76P6bz%2BUKWbVaO7pAIclyd8%3D"
+      Timecop.return
+    end
+
+  end
+
+
+
+end

data/spec/smarts_api_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe SmartsApi do
+
+  describe "evaluate" do
+
+    before (:all) do
+      SmartsApi::Message.base_uri = "http://smarts.dev.thismashine.com/"
+      SmartsApi::Message.access_key = "sshhhh...Secret!"
+    end
+
+    describe "expectations on eval object" 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
+
+        SmartsApi::ConnectMessage.any_instance.should_receive(:send).and_return("session 334")
+        SmartsApi::EvaluateMessage.any_instance.should_receive(:send)
+        SmartsApi.evaluate("string", instance)
+      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
+        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.evaluate("Chosen_decision", instance)
+      end
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'webmock/rspec'
+require 'timecop'
+Dir[File.expand_path('../../lib/smarts_api.rb', __FILE__)].each {|f| require f}

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: smarts_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steve Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: smarts_api-0.0.1
+email:
+- theSteveMitchell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/smarts_api.rb
+- lib/smarts_api/error.rb
+- lib/smarts_api/message.rb
+- lib/smarts_api/message/connect_message.rb
+- lib/smarts_api/message/disconnect_message.rb
+- lib/smarts_api/message/evaluate_message.rb
+- lib/smarts_api/version.rb
+- smarts_api.gemspec
+- spec/smarts_api/message/connect_message_spec.rb
+- spec/smarts_api/message/disconnect_message_spec.rb
+- spec/smarts_api/message/evaluate_message_spec.rb
+- spec/smarts_api/message_spec.rb
+- spec/smarts_api_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/theSteveMitchell/smarts_api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: api gem for Sparkling Logic's SMARTS business logic platform
+test_files:
+- spec/smarts_api/message/connect_message_spec.rb
+- spec/smarts_api/message/disconnect_message_spec.rb
+- spec/smarts_api/message/evaluate_message_spec.rb
+- spec/smarts_api/message_spec.rb
+- spec/smarts_api_spec.rb
+- spec/spec_helper.rb