luis 0.1.0.pre.alpha1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20b89c0201f2815959c4bc71542c32504ff338fe
-  data.tar.gz: 8e32841762775a9c9f282524a36e301e9efa4da8
+  metadata.gz: 6030d5eed1e23c08ede610bf535cc646547c9052
+  data.tar.gz: 30c2f208a3e38c1dcecb58857178cbfd0a9df25a
 SHA512:
-  metadata.gz: 31332d6ef01a60e03a9d84b87e211266723d58379bf700dddd3a509e3c43a307506ca4243704976eb56554c8f884ec09f3a519ad1fd7efc0bf1e77d11f91ed51
-  data.tar.gz: ed93283d7e347d373881e1f493b126b73875300a9e70d3cd7bfe970463b5a23c031fbe068846d68998cfc972ca1cfb7188feefc0d2585de519f6078e6d7232c3
+  metadata.gz: ab9c0a510d98b53df9e10d9c5a8f7c7c910b6bb6dee220f73ff248ba1ea33c8bece29d988992767733d69054666144bc6bb4ba40623fd5b1a17cf87b18bbbf7a
+  data.tar.gz: 0b3c4df3c5a59a6c327d0c81bef5769ec8d574c1f96304d68443d19aafec0c743beba8bce6cbf7ca228287d5dc92e1dfeddbb4744c05d683bd9a050f6360c245

data/lib/luis.rb

@@ -1,5 +1,6 @@
 require 'luis/version'
 require 'httparty'
+# Luis Module
 module Luis
   autoload :Base, 'luis/base'
   autoload :Result, 'luis/result'
@@ -15,15 +16,29 @@ module Luis
   end
   API_URL = 'https://api.projectoxford.ai/luis/v1/application/preview'.freeze
 
-  def self.query(query)
-    response = get(API_URL, query: { 'id' => id, 'subscription-key' => subscription_key, 'q' => query })
+  # Query method for the luis
+  #
+  # @param [String,#read] query text
+  # @param [Luis::Result] Luis result object
+  def self.query(query, context_id = nil)
+    options = default_options
+    options['q'] = query
+    options['contextId'] = context_id if context_id
+    response = get(API_URL, query: options)
     Result.new JSON.parse(response.body)
   end
 
+  # Configure luis credentials and settings
+  #
+  # @param [options] contains list of options to set
   def self.configure(options = {})
     options.each do |key, value|
       instance_variable_set("@#{key}", value)
     end
     yield(self) if block_given?
   end
+
+  def self.default_options
+    { 'id' => id, 'subscription-key' => subscription_key }
+  end
 end

data/lib/luis/action.rb

@@ -1,7 +1,9 @@
 module Luis
+  # Luis action class
   class Action < Base
     attr_accessor :triggered, :name, :parameters
 
+    # @return [Array]  parameters in the action
     def parameters
       @parameters.map { |parameter| Parameter.new parameter }
     end

data/lib/luis/base.rb

@@ -1,5 +1,9 @@
 module Luis
+  # Baseclass for luis objects
   class Base
+    # Constructor to set options specified as instance variables
+    #
+    # @param [Hash] options hash
     def initialize(options = {})
       options.each do |key, value|
         instance_variable_set("@#{key}", value)

data/lib/luis/composite_entity.rb

@@ -0,0 +1,12 @@
+module Luis
+  # Luis composite entity class
+  #
+  class CompositeEntity < Base
+    attr_accessor :parentType, :value, :children
+
+    # @return [Array] list of child entities
+    def children
+      @children.map { |child| CompositeEntityChild.new child }
+    end
+  end
+end

data/lib/luis/composite_entity_child.rb

@@ -0,0 +1,6 @@
+module Luis
+  # Luis composite entry child class
+  class CompositeEntityChild < Base
+    attr_accessor :type, :value
+  end
+end

data/lib/luis/dialog.rb

@@ -1,13 +1,22 @@
 module Luis
+  # Luis dialog class
   class Dialog < Base
-    attr_accessor :prompt, :parameterName, :parameterType, :contentId, :status
+    attr_accessor :prompt, :parameterName, :parameterType, :contextId, :status
 
+    # @return whether the dialog is finished
     def finished?
       status == 'Finished'
     end
 
+    # @return whether the dialog is question
     def question?
       status == 'Question'
     end
+
+    # Reply to dialog
+    # @param reply message
+    def reply(query)
+      Luis.query(query, contextId)
+    end
   end
 end

data/lib/luis/entity.rb

@@ -1,4 +1,5 @@
 module Luis
+  # Luis entity class
   class Entity < Base
     attr_accessor :entity, :type, :startIndex, :endIndex, :score
   end

data/lib/luis/intent.rb

@@ -1,7 +1,10 @@
 module Luis
+  # Luis intent class
   class Intent < Base
     attr_accessor :intent, :score, :actions
 
+    # Action list of the intent
+    # @return [Array] list of actions
     def actions
       @actions.map { |action| Action.new action }
     end

data/lib/luis/parameter.rb

@@ -1,4 +1,5 @@
 module Luis
+  # Luis Parameter class
   class Parameter < Base
     attr_accessor :name, :required, :value
   end

data/lib/luis/result.rb

@@ -1,27 +1,40 @@
 module Luis
+  # Luis result class
   class Result < Base
     attr_accessor :query, :intents, :entities, :dialog, :top_scoring_indent
 
+    # Intent with maximum score
+    # @return intent with maximum score
     def top_scoring_intent
       @topScoringIndent ||= @intents.first
     end
 
+    # List of intents
     def intents
       (@intents ||= [@topScoringIntent]).map do |intent|
         Intent.new intent
       end
     end
 
+    # Dialog object
     def dialog
       Dialog.new @dialog
     end
 
+    # List of entities
     def entities
       @entities.map { |entity| Entity.new entity }
     end
 
+    # Weather dialog is waiting for a response
     def awaiting_dialog_response?
-      dialog && (dialog['status'] == 'Question')
+      dialog && dialog.question?
+    end
+
+    # Reply to dialog is dialog is waiting for a response
+    def reply(query)
+      return false unless awaiting_dialog_response?
+      dialog.reply(query)
     end
   end
 end

data/lib/luis/version.rb

@@ -1,3 +1,3 @@
 module Luis
-  VERSION = '0.1.0-alpha1'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luis
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha1
+  version: 0.1.0
 platform: ruby
 authors:
 - Aboobacker MK
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,8 +86,8 @@ files:
 - lib/luis.rb
 - lib/luis/action.rb
 - lib/luis/base.rb
-- lib/luis/combosite_entity_child.rb
 - lib/luis/composite_entity.rb
+- lib/luis/composite_entity_child.rb
 - lib/luis/dialog.rb
 - lib/luis/entity.rb
 - lib/luis/intent.rb
@@ -110,9 +110,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.6