RecastAI 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d58d68e62629b591fffce5b9b25760cbf33df04
-  data.tar.gz: feeffc07cefdc2ac4330ac7c55a97c34f3739f95
+  metadata.gz: 8e0d9d38204152540d567fca3d5d666bc1074bff
+  data.tar.gz: 6c75863441add341d3832dc812ed281088d68da7
 SHA512:
-  metadata.gz: 0432fb7213212e053006db659ed72125dd4cfa0805c3bd6987e12a0b2941038a81e9ec664387afac90200622184fbaccda3a6ea727deef00438b66163456c6c3
-  data.tar.gz: b8e8ecacb4793e2ea3ea898a7a1ae3c27f8045878b6503fce23545d3d6f7e930e67b600376c424af1e73c529a93406292e4af755d5430be6a229ef06a86f374f
+  metadata.gz: fd45c6c44cfd34dd279b9a45399284c6085a61404b98e08b308b24220085510f5d60be5d5bf9de0969e3318c10719e29dd3876af0f9d73535c5ed8feab34ff83
+  data.tar.gz: 4c8f99a187d5db0885f10b1166602ce0e52a7d1142c00eb3c3fc8697e4b885d931fa5d171e2a5e6dc560aba8c3543b78eb07cfa5b5cd9917bec1fb0ea10b1c1f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RecastAI (2.0.0)
+    RecastAI (3.0.0)
       httmultiparty (~> 0.3)
       httparty (~> 0.13)
 
@@ -19,12 +19,11 @@ GEM
       httparty (>= 0.7.3)
       mimemagic
       multipart-post
-    httparty (0.13.7)
-      json (~> 1.8)
+    httparty (0.14.0)
       multi_xml (>= 0.5.2)
     json (1.8.3)
-    mimemagic (0.3.1)
-    multi_xml (0.5.5)
+    mimemagic (0.3.2)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
@@ -61,4 +60,4 @@ DEPENDENCIES
   webmock (~> 1.24)
 
 BUNDLED WITH
-   1.12.5
+   1.14.5

data/README.md

@@ -9,35 +9,35 @@ Recast.AI official SDK in Ruby
 ## Synospis
 
 This module is a wrapper around the [Recast.AI](https://recast.ai) API, and allows you to:
-* [build a bot](https://github.com/RecastAI/SDK-Ruby/wiki/Build-your-bot)
-* [analyze your text](https://github.com/RecastAI/SDK-Ruby/wiki/Analyse-text)
+* [Analyse your text](https://github.com/RecastAI/SDK-Ruby/wiki/01---Analyse-text)
+* [Manage a conversation](https://github.com/RecastAI/SDK-Ruby/wiki/02---Manage-conversation)
+* [Receive and send messages](https://github.com/RecastAI/SDK-Ruby/wiki/03---Receive-and-send-messages)
 
 ## Installation
 
+This gem supports ruby 2.3+.
+
 ```bash
-gem install 'RecastAI'
+gem install RecastAI
 ```
 
-## Documentation
-
-You can find the full documentation [here](https://github.com/RecastAI/SDK-Ruby/wiki).
+You can now use the sdk in your code.
 
-## Specs
+Using the entire SDK:
+```ruby
+require 'recastai'
 
-### Classes
+client = RecastAI.new('YOUR_TOKEN')
+```
 
-This module contains 7 classes, as follows:
+Extracting one single API:
+```ruby
+require 'recastai'
 
-* [Client](https://github.com/RecastAI/SDK-Ruby/wiki/Class-Client) is the client allowing you to make requests.
-* [Response](https://github.com/RecastAI/SDK-Ruby/wiki/Class-Response) wraps the response from a call to [Recast.AI](https://recast.ai) API with the text_request or file_request Client methods. 
-* [Conversation](https://github.com/RecastAI/SDK-Ruby/wiki/Class-Conversation) wraps the response from a call to [Recast.AI](https://recast.ai) API with the text_converse Client method.
-* [Action](https://github.com/RecastAI/SDK-Ruby/wiki/Class-Action) represents an action to do when using the text_converse method.
-* [Intent](https://github.com/RecastAI/SDK-Ruby/wiki/Class-Intent) represents an intent matched when using either the text_request, file_request or text_converse methods.
-* [Entity](https://github.com/RecastAI/SDK-Ruby/wiki/Class-Entity) represents an entity extracted from an input.
-* [RecastError](https://github.com/RecastAI/SDK-Ruby/wiki/Class-RecastError) is the error returned by the module.
+request = RecastAI::Request.new('YOUR_TOKEN')
+connect = RecastAI::Connect.new('YOUR_TOKEN')
+```
 
-Don't hesitate to dive into the code, it's commented ;)
-`
 ## More
 
 You can view the whole API reference at [man.recast.ai](https://man.recast.ai).
@@ -52,7 +52,7 @@ You can follow us on Twitter at [@recastai](https://twitter.com/recastai) for up
 
 ## License
 
-Copyright (c) [2016] [Recast.AI](https://recast.ai)
+Copyright (c) [2017] [Recast.AI](https://recast.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

data/lib/recastai.rb

@@ -2,15 +2,25 @@
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require 'json'
 require 'httparty'
 require 'httmultiparty'
-require 'json'
 
 require 'recastai/utils'
-require 'recastai/errors'
-require 'recastai/client'
-require 'recastai/response'
-require 'recastai/conversation'
-require 'recastai/action'
-require 'recastai/intent'
-require 'recastai/entity'
+require 'recastai/apis/connect/connect'
+require 'recastai/apis/request/request'
+
+module RecastAI
+  class Client
+    attr_reader :token, :language
+
+    def initialize(token = nil, language = nil)
+      [RecastAI::Request, RecastAI::Connect].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/recastai/apis/connect/connect.rb

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

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require_relative 'models/message'
+require_relative 'utils'
+
+module RecastAI
+  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 RecastError.new('Token is missing') if token.nil?
+
+      response = HTTParty.post(
+        "#{Utils::CONVERSATION_ENDPOINT}#{conversation_id}/messages",
+        body: { messages: payload },
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise RecastError.new(JSON.parse(response.body)['message']) if response.code != 201
+
+      response
+    end
+
+    def broadcast_message(payload, token: nil)
+      token ||= @token
+      raise RecastError.new('Token is missing') if token.nil?
+
+      response = HTTParty.post(
+        Utils::MESSAGE_ENDPOINT,
+        body: { messages: payload },
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise RecastError.new(JSON.parse(response.body)['message']) if response.code != 201
+
+      response
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module RecastAI
+  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/recastai/apis/connect/utils.rb

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

data/lib/recastai/{errors.rb → apis/errors.rb}

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
 module RecastAI
-  class RecastError < Exception
+  class RecastError < RuntimeError
   end
 end

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

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require_relative 'models/response'
+require_relative 'utils'
+require_relative '../errors'
+
+module RecastAI
+  module Analyse
+    def analyse_text(text, token: nil, language: nil)
+      token ||= @token
+      raise RecastError.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 RecastError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Response.new(response.body)
+    end
+
+    def analyse_file(file, token: nil, language: nil)
+      token ||= @token
+      raise RecastError.new('Token is missing') if token.nil?
+
+      language ||= @language
+
+      body = { voice: File.new(file) }
+      body[:language] = language unless language.nil?
+      response = HTTMultiParty.post(
+        Utils::REQUEST_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{token}" }
+      )
+      raise RecastError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Response.new(response.body)
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require_relative 'models/conversation'
+require_relative 'utils'
+require_relative '../errors'
+
+module RecastAI
+  module Converse
+    def converse_text(text, token: nil, language: nil, conversation_token: nil, memory: nil)
+      token ||= @token
+      raise RecastError.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 RecastError.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 RecastError.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 RecastError.new(JSON.parse(response.body)['message']) if response.code != 200
+
+      Conversation.new(response.body, token)
+    end
+  end
+end

data/lib/recastai/{action.rb → apis/request/models/action.rb}

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# This class builds an action used by RecastAI:::Conversation
 module RecastAI
   class Action
     attr_reader :slug

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

@@ -0,0 +1,105 @@
+# encoding: utf-8
+
+require_relative 'action'
+require_relative 'entity'
+require_relative 'intent'
+
+module RecastAI
+  class Conversation
+    attr_reader :raw, :uuid, :source, :replies, :action, :next_actions, :memory, :entities, :intents,
+                :conversation_token, :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) }
+      @memory             = response['memory'].reject { |_, e| e.nil? }.map{ |n, e| Entity.new(n, e) }
+      @entities           = response['entities'].flat_map{ |_, e| e.map{ |ee| Entity.new(n, ee) } }
+      @intents            = response['intents'].map{ |i| Intent.new(i) }
+      @conversation_token = response['conversation_token']
+      @language           = response['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 set_memory(memory)
+      body = { conversation_token: @conversation_token, memory: memory }
+      response = HTTParty.put(
+        Utils::CONVERSE_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{@token}" }
+      )
+      raise RecastError.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 RecastError.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 RecastError.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/recastai/{entity.rb → apis/request/models/entity.rb}

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# This class build an Entity used in RecastAI::Response and RecastAI::Conversation
 module RecastAI
   class Entity
     attr_reader :name
@@ -9,8 +7,6 @@ module RecastAI
     def initialize(name, data)
       @name = name
 
-      # For each pair key, value, set a instance variable
-      # and an attr_reader named k and returning v
       data.each_pair do |k, v|
         self.instance_variable_set("@#{k}", v)
         self.define_singleton_method(k.to_sym){ v }

data/lib/recastai/{intent.rb → apis/request/models/intent.rb}

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-##
-# This class builds an intent from RecastAI::Request and RecastAI::Conversation
 module RecastAI
   class Intent
     attr_reader :slug

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

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+require_relative 'intent'
+require_relative 'entity'
+require_relative '../utils'
+
+module RecastAI
+  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 :version
+    attr_reader :timestamp
+    attr_reader :status
+
+    def initialize(response)
+      @raw = response
+
+      response = JSON.parse(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']
+      @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/recastai/apis/request/request.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require_relative 'analyse'
+require_relative 'converse'
+
+module RecastAI
+  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/recastai/apis/request/utils.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module RecastAI
+  class Utils
+    # Endpoints
+    REQUEST_ENDPOINT = 'https://api.recast.ai/v2/request/'.freeze
+    CONVERSE_ENDPOINT = 'https://api.recast.ai/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/recastai/utils.rb

@@ -3,34 +3,15 @@
 module RecastAI
   class Utils
     # Versioning
-    MAJOR = '2'.freeze
-    MINOR = '1'.freeze
-    MICRO = '1'.freeze
+    MAJOR = '3'.freeze
+    MINOR = '0'.freeze
+    MICRO = '0'.freeze
     VERSION = "#{MAJOR}.#{MINOR}.#{MICRO}".freeze
 
     # Endpoints
-    REQUEST_ENDPOINT = 'https://api.recast.ai/v2/request'.freeze
-    CONVERSE_ENDPOINT = 'https://api.recast.ai/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
+    TRAIN_ENDPOINT = 'https://api.recast.ai/v2/'.freeze
+    CONNECT_ENDPOINT = 'https://api.recast.ai/connect/v1/'.freeze
+    HOST_ENDPOINT = 'https://api.recast.ai/host/v1/'.freeze
+    MONITOR_ENDPOINT = 'https://api.recast.ai/monitor/v1/'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RecastAI
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Paul Renvoisé
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -113,13 +113,20 @@ files:
 - bin/file
 - bin/text
 - lib/recastai.rb
-- lib/recastai/action.rb
-- lib/recastai/client.rb
-- lib/recastai/conversation.rb
-- lib/recastai/entity.rb
-- lib/recastai/errors.rb
-- lib/recastai/intent.rb
-- lib/recastai/response.rb
+- lib/recastai/apis/connect/connect.rb
+- lib/recastai/apis/connect/message.rb
+- lib/recastai/apis/connect/models/message.rb
+- lib/recastai/apis/connect/utils.rb
+- lib/recastai/apis/errors.rb
+- lib/recastai/apis/request/analyse.rb
+- lib/recastai/apis/request/converse.rb
+- lib/recastai/apis/request/models/action.rb
+- lib/recastai/apis/request/models/conversation.rb
+- lib/recastai/apis/request/models/entity.rb
+- lib/recastai/apis/request/models/intent.rb
+- lib/recastai/apis/request/models/response.rb
+- lib/recastai/apis/request/request.rb
+- lib/recastai/apis/request/utils.rb
 - lib/recastai/utils.rb
 - misc/.gitkeep
 - misc/logo-inline.png
@@ -145,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Recast.AI official SDK for Ruby

data/lib/recastai/client.rb

@@ -1,104 +0,0 @@
-# encoding: utf-8
-
-##
-# This class is the main entrypoint to Recast.AI
-# When using *_converse, a RecastAI::Conversation object is returned
-# When using *_request, a RecastAI::Response object is returned
-module RecastAI
-  class Client
-    attr_accessor :token
-    attr_accessor :language
-
-    def initialize(token = nil, language = nil)
-      @token = token
-      @language = language
-    end
-
-    ##
-    # Perform a text converse to Recast.AI
-    #
-    # * *Args* :
-    #   - +text+ - String, the text to process
-    #   - +options+ - Hash, request's options
-    # * *Returns* :
-    #   - An instance of Conversation
-    # * *Throws* :
-    #   - RecastError
-    def text_converse(text, options = {})
-      token = options[:token] || @token
-      raise(RecastError.new('Token is missing')) if token.nil?
-
-      language = options[:language] || @language
-
-      body = { text: text }
-      body[:language] = language unless language.nil?
-      body[:conversation_token] = options[:conversation_token] unless options[:conversation_token].nil?
-      body[:memory] = options[:memory] unless options[:memory].nil?
-
-      response = HTTParty.post(
-        Utils::CONVERSE_ENDPOINT,
-        body: body,
-        headers: { Authorization: "Token #{token}" }
-      )
-      raise(RecastError.new(response.message)) if response.code != 200
-
-      Conversation.new(response.body)
-    end
-
-    ##
-    # Perform a text request to Recast.AI
-    #
-    # * *Args* :
-    #   - +text+ - String, the text to process
-    #   - +options+ - Hash, request's options
-    # * *Returns* :
-    #   - An instance of Response
-    # * *Throws* :
-    #   - RecastError
-    def text_request(text, options = {})
-      token = options[:token] || @token
-      raise(RecastError.new('Token is missing')) if token.nil?
-
-      language = options[:language] || @language
-
-      body = { text: text }
-      body[:language] = language unless language.nil?
-      response = HTTParty.post(
-        Utils::REQUEST_ENDPOINT,
-        body: body,
-        headers: { Authorization: "Token #{token}" }
-      )
-      raise(RecastError.new(response.message)) if response.code != 200
-
-      Response.new(response.body)
-    end
-
-    ##
-    # Perform a voice file request to Recast.AI
-    #
-    # * *Args* :
-    #   - +file+ - String or File, the voice file to process
-    #   - +options+ - Hash, request's options
-    # * *Returns* :
-    #   - An instance of Response
-    # * *Throws* :
-    #   - RecastError
-    def file_request(file, options = {})
-      token = options[:token] || @token
-      raise(RecastError.new('Token is missing')) if token.nil?
-
-      language = options[:language] || @language
-
-      body = { voice: File.new(file) }
-      body[:language] = language unless language.nil?
-      response = HTTMultiParty.post(
-        Utils::REQUEST_ENDPOINT,
-        body: body,
-        headers: { Authorization: "Token #{token}" }
-      )
-      raise(RecastError.new(response.message)) if response.code != 200
-
-      Response.new(response.body)
-    end
-  end
-end

data/lib/recastai/conversation.rb

@@ -1,182 +0,0 @@
-# encoding: utf-8
-
-##
-# This class builds a conversation from *_converse
-module RecastAI
-  class Conversation
-    attr_reader :raw
-    attr_reader :uuid
-    attr_reader :source
-    attr_reader :replies
-    attr_reader :action
-    attr_reader :next_actions
-    attr_reader :memory
-    attr_reader :entities
-    attr_reader :intents
-    attr_reader :conversation_token
-    attr_reader :language
-    attr_reader :version
-    attr_reader :timestamp
-    attr_reader :status
-
-    def initialize(response)
-      @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) }
-      @memory             = response['memory'].select{ |n, 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']
-      @version            = response['version']
-      @timestamp          = response['timestamp']
-      @status             = response['status']
-    end
-
-    ##
-    # Returns the first reply provided there is one
-    #
-    # * *Args* :
-    # * *Returns* :
-    #   - A String or nil
-    def reply
-      @replies.any? ? @replies.first : nil
-    end
-
-    ##
-    # Returns the first next action provided there is one
-    #
-    # * *Args* :
-    # * *Returns* :
-    #   - An instance of Action or nil
-    def next_action
-      @next_actions.any? ? @next_actions.first : nil
-    end
-
-    ##
-    # Returns the replies joined with sep
-    #
-    # * *Args* :
-    #   - +sep+ - String, the separator (default: ' ')
-    # * *Returns* :
-    #   - A String or nil
-    def joined_replies(sep=' ')
-      @replies.join(sep)
-    end
-
-    ##
-    # Returns the first entity in the memory name matches the parameter
-    # If no name is provided, returns the full memory
-    #
-    # * *Args* :
-    #   - +key+ - String, the memory's field name
-    # * *Returns* :
-    #   - An instance of Entity or a Memory
-    def get_memory(key=nil)
-      return @memory if key.nil?
-
-      @memory.each do |entity|
-        return entity if entity.name.casecmp(key.to_s) == 0
-      end
-
-      nil
-    end
-
-    ##
-    # Returns the first intent provided there is one
-    #
-    # * *Args* :
-    # * *Returns* :
-    #   - A String or nil
-    def intent
-      @intents.any? ? @intents.first : nil
-    end
-
-    class << self
-      ##
-      # Merges the conversation memory with the one given
-      #
-      # * *Args* :
-      #   - +token+ - String, your request_token
-      #   - +conversation_token+ String, the token of the conversation whose memory will be updated
-      #   - +memory+ Hash, the memory you want to update with
-      # * *Returns* :
-      #   - An updated Memory
-      # * *Throws* :
-      #   - RecastError
-      def set_memory(token, conversation_token, memory)
-        body = { conversation_token: conversation_token, memory: memory }
-        response = HTTParty.put(
-          Utils::CONVERSE_ENDPOINT,
-          body: body,
-          headers: { Authorization: "Token #{token}" }
-        )
-        raise(RecastError.new(response.message)) if response.code != 200
-
-        response = JSON.parse(response.body)
-        response = response['results']
-        response['memory'].select{ |n, e| !e.nil? }.map{ |n, e| Entity.new(n, e) }
-      end
-
-      ##
-      # Reset the conversation memory fully or partially with the one given
-      #
-      # * *Args* :
-      #   - +token+ - String, your request_token
-      #   - +conversation_token+ String, the token of the conversation whose memory will be updated
-      #   - +memory+ Hash, the memory you want to update with
-      # * *Returns* :
-      #   - A fully or partially reset Memory
-      # * *Throws* :
-      #   - RecastError
-      def reset_memory(token, conversation_token, name=nil)
-        body = { conversation_token: conversation_token }
-        unless name.nil?
-          body[:memory] = { name => nil }
-        end
-        response = HTTParty.put(
-          Utils::CONVERSE_ENDPOINT,
-          body: body,
-          headers: { Authorization: "Token #{token}" }
-        )
-        raise(RecastError.new(response.message)) if response.code != 200
-
-        response = JSON.parse(response.body)
-        response = response['results']
-        response['memory'].select{ |n, e| !e.nil? }.map{ |n, e| Entity.new(n, e) }
-      end
-
-      ##
-      # Resets the conversation state by setting every memory field to nil,
-      # all actions to not done, and the last action to nil
-      #
-      # * *Args* :
-      #   - +token+ - String, your request_token
-      #   - +conversation_token+ - String, the token of the conversation to reset
-      # * *Returns* :
-      #   - A fully reset Memory
-      # * *Throws* :
-      #   - RecastError
-      def reset_conversation(token, conversation_token)
-        body = { conversation_token: conversation_token }
-        response = HTTParty.delete(
-          Utils::CONVERSE_ENDPOINT,
-          body: body,
-          headers: { Authorization: "Token #{token}" }
-        )
-        raise(RecastError.new(response.message)) if response.code != 200
-
-        response = JSON.parse(response.body)
-        response = response['results']
-        response['memory'].select{ |n, e| !e.nil? }.map{ |n, e| Entity.new(n, e) }
-      end
-    end
-  end
-end

data/lib/recastai/response.rb

@@ -1,227 +0,0 @@
-# encoding: utf-8
-
-##
-# This class builds a response from *_request
-module RecastAI
-  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 :version
-    attr_reader :timestamp
-    attr_reader :status
-
-    def initialize(response)
-      @raw = response
-
-      response = JSON.parse(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']
-      @version   = response['version']
-      @timestamp = response['timestamp']
-      @status    = response['status']
-    end
-
-    ##
-    # Returns the first intent provided there is one
-    #
-    # * *Args* :
-    # * *Returns* :
-    #   - A String or nil
-    def intent
-      @intents.any? ? @intents.first : nil
-    end
-
-    ##
-    # Returns the first entity whose name matches the parameter
-    #
-    # * *Args* :
-    #   - +name+ - String, the entity's name
-    # * *Returns* :
-    #   - An instance of Entity or nil
-    def get(name)
-      @entities.each do |entity|
-        return entity if entity.name.casecmp(name.to_s) == 0
-      end
-
-      nil
-    end
-
-    ##
-    # Returns all entities whose names matches the parameter
-    #
-    # * *Args* :
-    #   - +name+ - String, the entities' names
-    # * *Returns* :
-    #   - An array of instances of Entity or an empty array
-    def all(name)
-      @entities.select do |entity|
-        entity.name.casecmp(name.to_s) == 0
-      end
-    end
-
-    ##
-    # Return whether or not the act is an assertion
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def assert?
-      @act == Utils::ACT_ASSERT
-    end
-
-    ##
-    # Return whether or not the act is a command
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def command?
-      @act == Utils::ACT_COMMAND
-    end
-
-    ##
-    # Return whether or not the act is a wh-query
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def wh_query?
-      @act == Utils::ACT_WH_QUERY
-    end
-
-    ##
-    # Return whether or not the act is a yn-query
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def yn_query?
-      @act == Utils::ACT_YN_QUERY
-    end
-
-    ##
-    # Return whether or not the type is an abbreviation
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def abbreviation?
-      !@type.index(Utils::TYPE_ABBREVIATION).nil?
-    end
-
-    ##
-    # Return whether or not the type is an entity
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def entity?
-      !@type.index(Utils::TYPE_ENTITY).nil?
-    end
-
-    ##
-    # Return whether or not the type is a description
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def description?
-      !@type.index(Utils::TYPE_DESCRIPTION).nil?
-    end
-
-    ##
-    # Return whether or not the type is a human
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def human?
-      !@type.index(Utils::TYPE_HUMAN).nil?
-    end
-
-    ##
-    # Return whether or not the type is a location
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def location?
-      !@type.index(Utils::TYPE_LOCATION).nil?
-    end
-
-    ##
-    # Return whether or not the type is a number
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def number?
-      !@type.index(Utils::TYPE_NUMBER).nil?
-    end
-
-    ##
-    # Return whether or not the sentiment is very positive
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def vpositive?
-      @sentiment == Utils::SENTIMENT_VPOSITIVE
-    end
-
-    ##
-    # Return whether or not the sentiment is positive
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def positive?
-      @sentiment == Utils::SENTIMENT_POSITIVE
-    end
-
-    ##
-    # Return whether or not the sentiment is neutral
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def neutral?
-      @sentiment == Utils::SENTIMENT_NEUTRAL
-    end
-
-    ##
-    # Return whether or not the sentiment is negative
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def negative?
-      @sentiment == Utils::SENTIMENT_NEGATIVE
-    end
-
-    ##
-    # Return whether or not the sentiment is very negative
-    #
-    # + *Args* :
-    # + *Returns* :
-    #   - True or False
-    def vnegative?
-      @sentiment == Utils::SENTIMENT_VNEGATIVE
-    end
-  end
-end