Sapcai 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e47964ce4e02cec9d7da03829d841a75453b96aa4d6af59f30835a7a019c3cc
+  data.tar.gz: 78541aae03f89f1f90269261b68b8c6646da70aad56046e18726b5ad6db67355
+SHA512:
+  metadata.gz: c8c6cd91f3ecb5247bdd8569db561cbd5a009b43cf2e3dd227b4252ced1ebfc74eea987915532789fb7e9b38cfe5ee51cbe5ac97e9e6f0dd1977bb897a197c0d
+  data.tar.gz: 1220701dc3be3056758d54f3da07dac8785ec839c7a652e8e2b99cbd1525d940edad41bc14df2d3a9c805eb0791b8d5c61e82c3102dc931432583a8082433085

data/.gitignore

@@ -0,0 +1,26 @@
+# Default
+cache
+log/*.log
+VM/*.log
+tmp/**/*
+public/system/**
+public/uploads/
+db/schema.rb
+dump.rdb
+coverage/
+
+# Configuration
+config/application.yml
+config/database.yml
+config/secrets.yml
+
+# OS-Generated
+.DS_Store
+
+# IDE-Generated
+.idea/
+.bashrc
+
+# Misc
+*~
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/LineLength:
+  Max: 9999
+Metrics/MethodLength:
+  Max: 9999
+Style/Documentation:
+  Enabled: false
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+Style/RedundantSelf:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/RaiseArgs:
+    EnforcedStyle: compact

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    Sapcai (4.0.0)
+      httmultiparty (~> 0.3)
+      httparty (~> 0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    awesome_print (1.6.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.3.1)
+    hashdiff (0.3.0)
+    httmultiparty (0.3.16)
+      httparty (>= 0.7.3)
+      mimemagic
+      multipart-post
+    httparty (0.16.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    mimemagic (0.3.2)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    webmock (1.24.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Sapcai!
+  awesome_print (~> 1.6)
+  rspec (~> 3.4)
+  simplecov (~> 0.15)
+  webmock (~> 1.24)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 SAP Conversational AI
+
+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,76 @@
+
+
+[logo]: https://cdn.cai.tools.sap/brand/sapcai/sap-cai-black.svg "SAP Conversational AI"
+
+![alt text][logo]
+
+# SAP Conversational AI - SDK Ruby
+
+SAP Conversational AI official SDK in Ruby
+
+## Synospis
+
+This module is a wrapper around the [SAP Conversational AI](https://cai.tools.sap) API, and allows you to:
+* [Analyse your text](https://github.com/SAPConversationalAI/SDK-Ruby/wiki/01---Analyse-text)
+* [Manage a conversation](https://github.com/SAPConversationalAI/SDK-Ruby/wiki/02---Manage-conversation)
+* [Receive and send messages](https://github.com/SAPConversationalAI/SDK-Ruby/wiki/03---Receive-and-send-messages)
+
+## Installation
+
+This gem supports ruby 2.3+.
+
+```bash
+gem install Sapcai
+```
+
+You can now use the SDK in your code. All you need is your bot's token. In case you have enabled our versioning feature in the settings of your bot, you can refer to our [versioning documentation](https://cai.tools.sap/docs/concepts/versioning) to learn how to select the appropriate token for you versions and environments.
+
+Using the entire SDK:
+```ruby
+require 'sapcai'
+
+client = Sapcai::Client.new('YOUR_TOKEN')
+
+client.request.analyse_text('Hi')
+client.connect.broadcast_message('Hello')
+```
+
+Extracting one single API:
+```ruby
+require 'sapcai'
+
+request = Sapcai::Request.new('YOUR_TOKEN')
+request.analyse_text('Hi')
+
+connect = Sapcai::Connect.new('YOUR_TOKEN')
+connect.broadcast_message('Hi')
+```
+
+## More
+
+You can view the whole API reference at [cai.tools.sap/docs/](https://cai.tools.sap/docs/api-reference).
+
+You can follow us on Twitter at [@sapcai](https://twitter.com/sapcai) for updates and releases.
+
+
+## License
+
+Copyright (c) [2019] [SAP Conversational AI](https://cai.tools.sap)
+
+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 tsuse, 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/bin/sapcaicli

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require_relative '../lib/sapcai'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: sapcaicli -[-t]oken TOKEN <--text TEXT | --file FILE>"
+
+  opts.on('-t', '--token=TOKEN', String, "the request token to use for the call") do |t|
+    options[:token] = t
+  end
+
+  opts.on('--text=TEXT', String, 'the text to process') do |t|
+    options[:text] = t
+  end
+
+  opts.on('--file=FILE', String, 'the file to process') do |f|
+    options[:file] = f
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+client = Sapcai::Client.new(options[:token])
+
+if options[:text]
+  response = client.request.analyse_text(options[:text])
+elsif options[:file]
+  response = client.request.analyse_file(options[:file])
+else
+  raise OptionParser::MissingArgument.new('You need to give either --text or --file')
+end
+
+puts response.intent

data/lib/sapcai.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'json'
+require 'httparty'
+require 'httmultiparty'
+
+require 'sapcai/utils'
+require 'sapcai/apis/connect/connect'
+require 'sapcai/apis/request/request'
+require 'sapcai/apis/build/build'
+
+module Sapcai
+  class Client
+    attr_reader :token, :language
+
+    def initialize(token = nil, language = nil)
+      [Sapcai::Request, Sapcai::Connect, Sapcai::Build].each do |api|
+        i = api.name.rindex('::')
+        name = i.nil? ? api.name : api.name[(i + 2)..-1]
+
+        self.class.send(:define_method, name.downcase.to_sym, ->{ api.new(token, language) })
+      end
+    end
+  end
+end

data/lib/sapcai/apis/build/build.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'httparty'
+
+require_relative 'dialog_response'
+require_relative 'dialog_message'
+require_relative 'dialog_conversation'
+
+module Sapcai
+  class Build
+    attr_reader :token, :language
+
+    def initialize(token = nil, language = nil)
+      @token = token
+      @language = language
+    end
+
+    def headers
+      { 'Authorization' => "Token #{@token}", 'Content-Type' => 'application/json' }
+    end
+
+    def dialog(msg, conversation_id, language = nil, options = {})
+      raise Sapcai::SapcaiError.new('Token is missing') unless @token
+
+      log_level = options[:log_level] || "info"
+      proxy = options[:proxy] || {}
+
+      language = @language if language.nil?
+      body = { message: msg, conversation_id: conversation_id, language: language, log_level: log_level}
+      body[:memory] = options[:memory] unless options[:memory].nil?
+
+      options = { body: body.to_json, headers: self.headers }
+      if proxy != {}
+        options[:http_proxyaddr] = proxy[:host]
+        options[:http_proxyport] = proxy[:port]
+      end
+      response = HTTParty.post("#{Sapcai::Utils::BUILD_ENDPOINT}/dialog", options)
+      raise Sapcai::SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      res = JSON.parse(response.body)['results']
+      Sapcai::DialogResponse.new(res['messages'], res['conversation'], res['nlp'], res['logs'])
+    end
+
+    def update_conversation(user, bot, version, conversation_id, opts)
+      raise Sapcai::SapcaiError.new('Token is missing') unless @token
+
+      body = opts
+
+      url = "#{Sapcai::Utils::BUILD_ENDPOINT}/users/#{user}/bots/#{bot}/versions/#{version}/builder/conversation_states/#{conversation_id}"
+      response = HTTParty.put(url, body: body.to_json, headers: self.headers)
+      raise Sapcai::SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Sapcai::DialogConversation.new(JSON.parse(response.body)['results'])
+    end
+
+    def get_conversation(user, bot, version, conversation_id)
+      raise Sapcai::SapcaiError.new('Token is missing') unless @token
+
+      url = "#{Sapcai::Utils::BUILD_ENDPOINT}/users/#{user}/bots/#{bot}/versions/#{version}/builder/conversation_states/#{conversation_id}"
+      response = HTTParty.get(url, headers: self.headers)
+      raise Sapcai::SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Sapcai::DialogConversation.new(JSON.parse(response.body)['results'])
+    end
+
+    def delete_conversation(user, bot, version, conversation_id)
+      raise Sapcai::SapcaiError.new('Token is missing') unless @token
+
+      url = "#{Sapcai::Utils::BUILD_ENDPOINT}/users/#{user}/bots/#{bot}/versions/#{version}/builder/conversation_states/#{conversation_id}"
+      response = HTTParty.delete(url, headers: self.headers)
+      raise Sapcai::SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 204
+
+      true
+    end
+  end
+end

data/lib/sapcai/apis/build/dialog_conversation.rb

@@ -0,0 +1,13 @@
+module Sapcai
+  class DialogConversation
+    attr_reader :id, :language, :memory, :skill, :skill_occurences
+
+    def initialize(conv)
+      @id = conv['conversation_id'] || conv['id']
+      @language = conv['language']
+      @memory = conv['memory']
+      @skill = conv['skill'] || conv['last_skill']
+      @skill_occurences = conv['skill_occurences'] || skill['last_skill_occurences']
+    end
+  end
+end

data/lib/sapcai/apis/build/dialog_message.rb

@@ -0,0 +1,17 @@
+module Sapcai
+  class DialogMessage
+    attr_reader :type, :content
+
+    def initialize(msg)
+      raise Sapcai::SapcaiError('Invalid message format') unless message_is_valid(msg)
+      @type = msg['type']
+      @content = msg['content']
+    end
+
+    private
+
+    def message_is_valid(msg)
+      msg.is_a?(Hash) && msg.key?('type') && msg.key?('content')
+    end
+  end
+end

data/lib/sapcai/apis/build/dialog_response.rb

@@ -0,0 +1,17 @@
+require_relative 'dialog_message'
+require_relative 'dialog_conversation'
+require_relative '../request/models/response'
+module Sapcai
+  class DialogResponse
+    attr_reader :messages, :conversation, :nlp, :logs
+
+    def initialize(messages, conversation, nlp, logs)
+      raise Sapcai::SapcaiError("Invalid messages format: #{messages}") unless messages.is_a?(Array)
+
+      @messages = messages.map{ |m| Sapcai::DialogMessage.new(m) }
+      @conversation = DialogConversation.new(conversation)
+      @nlp = Response.new('results' => nlp)
+      @logs = logs
+    end
+  end
+end

data/lib/sapcai/apis/connect/connect.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require_relative 'message'
+
+module Sapcai
+  class Connect
+    include Message
+
+    attr_reader :token, :language
+
+    def initialize(token = nil, language = nil)
+      @token = token
+      @language = language
+    end
+  end
+end

data/lib/sapcai/apis/connect/message.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require_relative 'models/message'
+require_relative 'utils'
+
+module Sapcai
+  module Message
+    def handle_message(request, &block)
+      request.body.rewind if request.body.respond_to?(:rewind)
+      body = request.body.is_a?(String) ? request.body : request.body.read
+      message = Msg.new(body)
+
+      yield(message)
+    end
+
+    def send_message(payload, conversation_id, token: nil)
+      token ||= @token
+      raise SapcaiError.new('Token is missing') if token.nil?
+
+      response = HTTParty.post(
+        "#{Utils::CONVERSATION_ENDPOINT}#{conversation_id}/messages",
+        body: { messages: payload.to_json },
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 201
+
+      response
+    end
+
+    def broadcast_message(payload, token: nil)
+      token ||= @token
+      raise SapcaiError.new('Token is missing') if token.nil?
+
+      response = HTTParty.post(
+        Utils::MESSAGE_ENDPOINT,
+        body: { messages: payload.to_json },
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 201
+
+      response
+    end
+  end
+end

data/lib/sapcai/apis/connect/models/message.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Sapcai
+  class Msg
+    attr_reader :content, :type, :conversation_id
+
+    def initialize(request)
+      request = JSON.parse(request)
+      request.each do |k, v|
+        k = k.gsub(/(.)([A-Z])/, '\1_\2').downcase
+        self.instance_variable_set("@#{k}", v)
+        self.define_singleton_method(k.to_sym){ v }
+      end
+
+      @conversation_id = request['message']['conversation']
+      @content = request['message']['attachment']['content']
+      @type = request['message']['attachment']['type']
+    end
+  end
+end

data/lib/sapcai/apis/connect/utils.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Sapcai
+  class Utils
+    # Endpoints
+    MESSAGE_ENDPOINT = 'https://api.cai.tools.sap/connect/v1/messages/'.freeze
+    CONVERSATION_ENDPOINT = 'https://api.cai.tools.sap/connect/v1/conversations/'.freeze
+  end
+end

data/lib/sapcai/apis/errors.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Sapcai
+  class SapcaiError < RuntimeError
+  end
+end

data/lib/sapcai/apis/request/analyse.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require_relative 'models/response'
+require_relative 'utils'
+require_relative '../errors'
+
+module Sapcai
+  module Analyse
+    def analyse_text(text, token: nil, language: nil)
+      token ||= @token
+      raise SapcaiError.new('Token is missing') if token.nil?
+
+      language ||= @language
+
+      body = { text: text }
+      body[:language] = language unless language.nil?
+      response = HTTParty.post(
+        Utils::REQUEST_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Response.new(JSON.parse(response.body))
+    end
+  end
+end

data/lib/sapcai/apis/request/converse.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require_relative 'models/conversation'
+require_relative 'utils'
+require_relative '../errors'
+
+module Sapcai
+  module Converse
+    def converse_text(text, token: nil, language: nil, conversation_token: nil, memory: nil)
+      token ||= @token
+      raise SapcaiError.new('Token is missing') if token.nil?
+
+      language ||= @language
+
+      body = { text: text }
+      body[:language] = language unless language.nil?
+      body[:conversation_token] = conversation_token unless conversation_token.nil?
+      body[:memory] = memory unless memory.nil?
+
+      response = HTTParty.post(
+        Utils::CONVERSE_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Conversation.new(response.body, token)
+    end
+
+    def converse_file(file, token: nil, language: nil, conversation_token: nil, memory: nil)
+      token ||= @token
+      raise SapcaiError.new('Token is missing') if token.nil?
+
+      language ||= @language
+
+      body = { voice: File.new(file) }
+      body[:language] = language unless language.nil?
+      body[:conversation_token] = conversation_token unless conversation_token.nil?
+      body[:memory] = memory unless memory.nil?
+      response = HTTMultiParty.post(
+        Utils::CONVERSE_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Conversation.new(response.body, token)
+    end
+  end
+end

data/lib/sapcai/apis/request/models/action.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Sapcai
+  class Action
+    attr_reader :slug
+    attr_reader :done
+    attr_reader :reply
+
+    def initialize(action)
+      @slug  = action['slug']
+      @done  = action['done']
+      @reply = action['reply']
+    end
+
+    def done?
+      @done
+    end
+  end
+end

data/lib/sapcai/apis/request/models/conversation.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+
+require_relative 'action'
+require_relative 'entity'
+require_relative 'intent'
+require_relative '../utils'
+
+module Sapcai
+  class Conversation
+    attr_reader :raw, :uuid, :source, :replies, :action, :next_actions, :memory, :entities, :sentiment, :intents,
+                :conversation_token, :language, :processing_language, :version, :timestamp, :status
+
+    def initialize(response, token)
+      @token = token
+
+      @raw = response
+
+      response = JSON.parse(response)
+      response = response['results']
+
+      @uuid                = response['uuid']
+      @source              = response['source']
+      @replies             = response['replies']
+      @action              = response['action'] ? Action.new(response['action']) : nil
+      @next_actions        = response['next_actions'].map{ |i| Action.new(i) }
+      @sentiment           = response['sentiment']
+      @memory              = response['memory'].reject{ |_, e| e.nil? }.map{ |n, e| Entity.new(n, e) }
+      @entities            = response['entities'].flat_map{ |n, e| e.map{ |ee| Entity.new(n, ee) } }
+      @intents             = response['intents'].map{ |i| Intent.new(i) }
+      @conversation_token  = response['conversation_token']
+      @language            = response['language']
+      @processing_language = response['processing_language']
+      @version             = response['version']
+      @timestamp           = response['timestamp']
+      @status              = response['status']
+    end
+
+    def reply
+      @replies.any? ? @replies.first : nil
+    end
+
+    def next_action
+      @next_actions.any? ? @next_actions.first : nil
+    end
+
+    def joined_replies(sep = ' ')
+      @replies.join(sep)
+    end
+
+    def get_memory(key = nil)
+      return @memory if key.nil?
+
+      @memory.each do |entity|
+        return entity if entity.name.casecmp(key.to_s).zero?
+      end
+
+      nil
+    end
+
+    def intent
+      @intents.any? ? @intents.first : nil
+    end
+
+    def vpositive?
+      @sentiment == Utils::SENTIMENT_VPOSITIVE
+    end
+
+    def positive?
+      @sentiment == Utils::SENTIMENT_POSITIVE
+    end
+
+    def neutral?
+      @sentiment == Utils::SENTIMENT_NEUTRAL
+    end
+
+    def negative?
+      @sentiment == Utils::SENTIMENT_NEGATIVE
+    end
+
+    def vnegative?
+      @sentiment == Utils::SENTIMENT_VNEGATIVE
+    end
+
+    def set_memory(memory)
+      body = { conversation_token: @conversation_token, memory: memory }
+      response = HTTParty.put(
+        Utils::CONVERSE_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{@token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      response = JSON.parse(response.body)
+      response = response['results']
+      response['memory'].reject{ |_, e| e.nil? }.map{ |n, e| Entity.new(n, e) }
+    end
+
+    def reset_memory(name = nil)
+      body = { conversation_token: @conversation_token }
+      body[:memory] = { name => nil } unless name.nil?
+
+      response = HTTParty.put(
+        Utils::CONVERSE_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{@token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      response = JSON.parse(response.body)
+      response = response['results']
+      response['memory'].reject{ |_, e| e.nil? }.map{ |n, e| Entity.new(n, e) }
+    end
+
+    def reset_conversation
+      body = { conversation_token: @conversation_token }
+      response = HTTParty.delete(
+        Utils::CONVERSE_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{@token}" }
+      )
+      raise SapcaiError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      response = JSON.parse(response.body)
+      response = response['results']
+      response['memory'].reject{ |_, e| e.nil? }.map{ |n, e| Entity.new(n, e) }
+    end
+  end
+end

data/lib/sapcai/apis/request/models/entity.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module Sapcai
+  class Entity
+    attr_reader :name
+
+    def initialize(name, data)
+      @name = name
+
+      data.each_pair do |k, v|
+        self.instance_variable_set("@#{k}", v)
+        self.define_singleton_method(k.to_sym){ v }
+      end
+    end
+  end
+end

data/lib/sapcai/apis/request/models/intent.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Sapcai
+  class Intent
+    attr_reader :slug
+    attr_reader :confidence
+
+    def initialize(intent)
+      @slug       = intent['slug']
+      @confidence = intent['confidence']
+    end
+  end
+end

data/lib/sapcai/apis/request/models/response.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+require_relative 'intent'
+require_relative 'entity'
+require_relative '../utils'
+
+module Sapcai
+  class Response
+    attr_reader :raw
+    attr_reader :uuid
+    attr_reader :source
+    attr_reader :intents
+    attr_reader :act
+    attr_reader :type
+    attr_reader :sentiment
+    attr_reader :entities
+    attr_reader :language
+    attr_reader :processing_language
+    attr_reader :version
+    attr_reader :timestamp
+    attr_reader :status
+
+    def initialize(response)
+      @raw = JSON.dump(response)
+      response = response['results']
+
+      @uuid                = response['uuid']
+      @source              = response['source']
+      @intents             = response['intents'].map{ |i| Intent.new(i) }
+      @act                 = response['act']
+      @type                = response['type']
+      @sentiment           = response['sentiment']
+      @entities            = response['entities'].flat_map{ |n, e| e.map{ |ee| Entity.new(n, ee) } }
+      @language            = response['language']
+      @processing_language = response['processing_language']
+      @version             = response['version']
+      @timestamp           = response['timestamp']
+      @status              = response['status']
+    end
+
+    def intent
+      @intents.any? ? @intents.first : nil
+    end
+
+    def get(name)
+      @entities.each do |entity|
+        return entity if entity.name.casecmp(name.to_s).zero?
+      end
+
+      nil
+    end
+
+    def all(name)
+      @entities.select do |entity|
+        entity.name.casecmp(name.to_s).zero?
+      end
+    end
+
+    def assert?
+      @act == Utils::ACT_ASSERT
+    end
+
+    def command?
+      @act == Utils::ACT_COMMAND
+    end
+
+    def wh_query?
+      @act == Utils::ACT_WH_QUERY
+    end
+
+    def yn_query?
+      @act == Utils::ACT_YN_QUERY
+    end
+
+    def abbreviation?
+      !@type.index(Utils::TYPE_ABBREVIATION).nil?
+    end
+
+    def entity?
+      !@type.index(Utils::TYPE_ENTITY).nil?
+    end
+
+    def description?
+      !@type.index(Utils::TYPE_DESCRIPTION).nil?
+    end
+
+    def human?
+      !@type.index(Utils::TYPE_HUMAN).nil?
+    end
+
+    def location?
+      !@type.index(Utils::TYPE_LOCATION).nil?
+    end
+
+    def number?
+      !@type.index(Utils::TYPE_NUMBER).nil?
+    end
+
+    def vpositive?
+      @sentiment == Utils::SENTIMENT_VPOSITIVE
+    end
+
+    def positive?
+      @sentiment == Utils::SENTIMENT_POSITIVE
+    end
+
+    def neutral?
+      @sentiment == Utils::SENTIMENT_NEUTRAL
+    end
+
+    def negative?
+      @sentiment == Utils::SENTIMENT_NEGATIVE
+    end
+
+    def vnegative?
+      @sentiment == Utils::SENTIMENT_VNEGATIVE
+    end
+  end
+end

data/lib/sapcai/apis/request/request.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require_relative 'analyse'
+require_relative 'converse'
+
+module Sapcai
+  class Request
+    include Converse
+    include Analyse
+
+    attr_reader :token, :language
+
+    def initialize(token = nil, language = nil)
+      @token = token
+      @language = language
+    end
+  end
+end

data/lib/sapcai/apis/request/utils.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Sapcai
+  class Utils
+    # Endpoints
+    REQUEST_ENDPOINT = 'https://api.cai.tools.sap/v2/request/'.freeze
+    CONVERSE_ENDPOINT = 'https://api.cai.tools.sap/v2/converse/'.freeze
+
+    # Act constants
+    ACT_ASSERT = 'assert'.freeze
+    ACT_COMMAND = 'command'.freeze
+    ACT_WH_QUERY = 'wh-query'.freeze
+    ACT_YN_QUERY = 'yn-query'.freeze
+
+    # Type constants
+    TYPE_ABBREVIATION = 'abbr:'.freeze
+    TYPE_ENTITY = 'enty:'.freeze
+    TYPE_DESCRIPTION = 'desc:'.freeze
+    TYPE_HUMAN = 'hum:'.freeze
+    TYPE_LOCATION = 'loc:'.freeze
+    TYPE_NUMBER = 'num:'.freeze
+
+    # Sentiment constants
+    SENTIMENT_VPOSITIVE = 'vpositive'.freeze
+    SENTIMENT_POSITIVE = 'positive'.freeze
+    SENTIMENT_NEUTRAL = 'neutral'.freeze
+    SENTIMENT_NEGATIVE = 'negative'.freeze
+    SENTIMENT_VNEGATIVE = 'vnegative'.freeze
+  end
+end

data/lib/sapcai/utils.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Sapcai
+  class Utils
+    # Versioning
+    MAJOR = '4'.freeze
+    MINOR = '0'.freeze
+    PATCH = '0'.freeze
+    VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze
+
+    # Endpoints
+    TRAIN_ENDPOINT = 'https://api.cai.tools.sap/v2/'.freeze
+    CONNECT_ENDPOINT = 'https://api.cai.tools.sap/connect/v1/'.freeze
+    HOST_ENDPOINT = 'https://api.cai.tools.sap/host/v1/'.freeze
+    MONITOR_ENDPOINT = 'https://api.cai.tools.sap/monitor/v1/'.freeze
+    BUILD_ENDPOINT = 'https://api.cai.tools.sap/build/v1'.freeze
+  end
+end

data/recastai.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)
+
+require 'date'
+require 'lib/sapcai/utils'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'Sapcai'
+  spec.version               = Sapcai::Utils::VERSION
+  spec.date                  = Date.today
+  spec.summary               = 'SAP Conversational AI official SDK for Ruby'
+  spec.description           = 'SAP Conversational AI official SDK for Ruby. Allows you to make requests to your bots.'
+  spec.homepage              = 'https://github.com/SAPConversationalAI/SDK-ruby'
+  spec.license               = 'MIT'
+  spec.authors               = ['SAP CAI team']
+  spec.files                 = `git ls-files -z`.split("\x0").reject{ |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables           = ['sapcaicli']
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_dependency 'httparty', '~> 0.13'
+  spec.add_dependency 'httmultiparty', '~> 0.3'
+
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'webmock', '~> 1.24'
+  spec.add_development_dependency 'awesome_print', '~> 1.6'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: Sapcai
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- SAP CAI team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: SAP Conversational AI official SDK for Ruby. Allows you to make requests
+  to your bots.
+email: 
+executables:
+- sapcaicli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/sapcaicli
+- lib/sapcai.rb
+- lib/sapcai/apis/build/build.rb
+- lib/sapcai/apis/build/dialog_conversation.rb
+- lib/sapcai/apis/build/dialog_message.rb
+- lib/sapcai/apis/build/dialog_response.rb
+- lib/sapcai/apis/connect/connect.rb
+- lib/sapcai/apis/connect/message.rb
+- lib/sapcai/apis/connect/models/message.rb
+- lib/sapcai/apis/connect/utils.rb
+- lib/sapcai/apis/errors.rb
+- lib/sapcai/apis/request/analyse.rb
+- lib/sapcai/apis/request/converse.rb
+- lib/sapcai/apis/request/models/action.rb
+- lib/sapcai/apis/request/models/conversation.rb
+- lib/sapcai/apis/request/models/entity.rb
+- lib/sapcai/apis/request/models/intent.rb
+- lib/sapcai/apis/request/models/response.rb
+- lib/sapcai/apis/request/request.rb
+- lib/sapcai/apis/request/utils.rb
+- lib/sapcai/utils.rb
+- misc/.gitkeep
+- misc/logo-inline.png
+- misc/recast-ai-tokens.png
+- recastai.gemspec
+homepage: https://github.com/SAPConversationalAI/SDK-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: SAP Conversational AI official SDK for Ruby
+test_files: []