RecastAI 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bd00fcd2dad601053a8585da753577bc188f3f9
-  data.tar.gz: 368ba31c7546a30b1cf1ec4b760b8eb990d9bbd0
+  metadata.gz: c8fc4edaf1b82d336f4b13e82dd68b45bacc60bd
+  data.tar.gz: 031d2d8409dc6abd4679cfa69b9c92199205bead
 SHA512:
-  metadata.gz: 6fb22be21192ea61ad0af2ff28ada4af1f2b1e098a13c2048cd03ab5c29781417cdd0376c234c34da11f994a67f5101e45cb26189141b89719b30938c723d609
-  data.tar.gz: d16ff53ae6e8085c88e20b63234dbb57ec30712f8c82769f42a542e78ce5a2609c6e8b80a009b8aada84f310b627c4230aafcfe7b1ba193af91df01687c0ca44
+  metadata.gz: 97f198079573ac33474efdc4bdfd4d0c287d30eca3d1f861ce598811bc89ea3bd86793debcf7ef63271841c854505659a7f38932accd01ae94a512abec5b4086
+  data.tar.gz: e26c419f1c4762c9fc446494ba7f9407ea1f769ce784bed6827c3ce2b534430e8312c29448c8132c2ca83d5636e62807ce9f843531336ec9c2bf15ce060ebb31

data/.rubocop.yml

@@ -10,3 +10,5 @@ Style/RedundantSelf:
   Enabled: false
 Style/WordArray:
   Enabled: false
+Style/RaiseArgs:
+    EnforcedStyle: compact

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RecastAI (1.0.1)
+    RecastAI (1.1.0)
       httmultiparty (~> 0.3)
       httparty (~> 0.13)
 

data/README.md

@@ -1,4 +1,8 @@
-# SDK-ruby
+# RecastAI - Ruby SDK
+
+[![Version](https://badge.fury.io/rb/RecastAI.svg)](https://badge.fury.io/rb/RecastAI)
+
+![logo](https://raw.githubusercontent.com/RecastAI/SDK-ruby/master/misc/logo-inline.png "Recast.AI")
 
 Recast.AI official SDK in Ruby.
 
@@ -8,6 +12,11 @@ Recast.AI official SDK in Ruby.
 This gem is a pure Ruby interface to the [Recast.AI](https://recast.ai) API. It allows you to make requests to your bots.
 
 
+## Requirements
+
+* Ruby 2.2+
+
+
 ## Installation
 
 ### Via Gemfile
@@ -48,7 +57,7 @@ gem install RecastAI-*.gem
 ```ruby
 require 'recastai'
 
-client = RecastAI::Client.new(YOUR_TOKEN)
+client = RecastAI::Client.new(YOUR_TOKEN, YOUR_LANGUAGE)
 response = client.text_request(YOUR_TEXT)
 #response = client.file_request(File.new(File.join(File.dirname(__FILE__), YOUR_FILE)))
 
@@ -57,8 +66,6 @@ if response.intent == YOUR_EXPECTED_INTENT
 end
 ```
 
-You can find more examples in the `misc/` folder.
-
 ### CLI
 
 ```bash
@@ -87,12 +94,44 @@ Don't hesitate to dive into the code, it's commented ;)
 
 ### RecastAI::Client
 
-The Recast.AI Client can be instanciated with a token and provides the two following methods:
+The Recast.AI Client can be instanciated with a token (optional) and a language (optional) and provides the two following methods:
 
 * text_request(text, options = {}) *Performs a text request*
 * file_request(file, options = {}) *Performs a voice file request*
 
-*Accepted options are :token, to override the default token provided at initialization*
+On each call to `text_request` or `file_request` your can override either your token or your language by passing a hash of options.
+
+If no language is provided in the request, Recast.AI does the following:
+
+* text_request: the language of the text is detected and is used for processing if your bot has expressions for it, else your bot's primary language is used for processing.
+* voice_request: your bot's primary language is used for processing as we do not provide language detection for speech.
+
+If a language is provided, Recast.AI does the following:
+
+* text_request: the language you've given is used for processing if your bot has expressions for it, else your bot's primary language is used.
+* voice_request: the language you've given is used for processing if your bot has expressions for it, else your bot's primary language is used
+
+*Accepted options are :token, :language, to override the defaults provided at initialization*
+
+```ruby
+require 'recastai'
+
+client = RecastAI::Client.new(YOUR_TOKEN, YOUR LANGUAGE)
+
+# Performs a text request on Recast.AI
+response = client.text_request(YOUR_TEXT, { token: YOUR_TOKEN, language: YOUR_LANGUAGE })
+
+if response.intent == YOUR_EXPECTED_INTENT
+  # Do your code...
+end
+
+# Performs a voice file request on Recast.AI
+response = client.file_request(File.new(File.join(File.dirname(__FILE__),YOUR_FILE)), { token: YOUR_TOKEN, language: YOUR_LANGUAGE })
+
+if response.intent == YOUR_EXPECTED_INTENT
+  # Do your code...
+end
+```
 
 ### RecastAI::Response
 
@@ -106,10 +145,26 @@ The Recast.AI Response is generated after a call with the two previous methods a
 * sentence(\*) *Returns the first detected sentence*
 * get(name) *Returns the first entity matching -name-*
 * all(name) *Returns all the entities matching -name-*
+* entities(\*) *Returns all the entities*
 * version(\*) *Returns the version of the JSON*
 * timestamp(\*) *Returns the timestamp at the end of the processing*
 * status(\*) *Returns the status of the response*
 
+```ruby
+response = client.text_request('Give me some recipes with potatoes. And cheese.')
+
+# Get the first sentence, aka 'Give me some recipes with potatoes'
+first_sentence = response.sentence
+
+# If the first intent matched 'recipe'...
+if response.intent == 'recipe'
+  # ...get all the entities matching 'ingredient'
+  ingredients = response.all('ingredient')
+
+  puts "The request has been filled at #{response.timestamp}"
+end
+```
+
 ### RecastAI::Sentence
 
 The Recast.AI Sentence is generated by the Recast.AI Response initializer and provides the following methods:
@@ -119,8 +174,20 @@ The Recast.AI Sentence is generated by the Recast.AI Response initializer and pr
 * action(\*) *Returns the action of the sentence*
 * agent(\*) *Returns the agent of the sentence*
 * polarity(\*) *Returns the polarity (negation or not) of the sentence*
+* get(name) *Returns the first entity matching -name-*
+* all(name) *Returns all the entities matching -name-*
 * entities(\*) *Returns all the entities detected in the sentence*
 
+```ruby
+response = client.text_request('Tell me a joke.')
+# Get the first sentence
+sentence = response.sentence
+
+if sentence.action == 'tell' && sentence.polarity == 'positive'
+  # Tell a joke...
+end
+```
+
 ### RecastAI::Entity
 
 The Recast.AI Entity is generated by the Recast.AI Sentence initializer and provides the following method:
@@ -145,17 +212,36 @@ In addition to this method, more attributes are generated depending of the natur
 * grain(\*)
 * order(\*)
 
+```ruby
+response = client.text_request('What can I cook with salmon ?')
+
+if response.intent == 'recipe'
+  # Get the ingredient
+  ingredient = response.get('ingredient')
+
+  puts "You asked me for a recipe with #{ingredient.value}"
+end
+
+```
+
 ### RecastAI::RecastError
 
 The Recast.AI Error is thrown when receiving an non-200 response from Recast.AI.
 
-As it inherits from ::Exception, it implements the default expection methods.
+As it inherits from ::Exception, it implements the default exception methods.
 
 ## More
 
 You can view the whole API reference at [man.recast.ai](https://man.recast.ai).
 
 
+## Author
+
+Paul Renvoisé, paul.renvoise@recast.ai, [@paulrenvoise](https://twitter.com/paulrenvoise)
+
+You can follow us on Twitter at [@recastai](https://twitter.com/recastai) for updates and releases.
+
+
 ## License
 
 Copyright (c) [2016] [Recast.AI](https://recast.ai)

data/lib/recastai/client.rb

@@ -2,8 +2,9 @@ module RecastAI
   class Client
     attr_accessor :token
 
-    def initialize(token = nil)
+    def initialize(token = nil, language = nil)
       @token = token
+      @language = language
     end
 
     ##
@@ -20,8 +21,12 @@ module RecastAI
       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::API_ENDPOINT,
-                               body: { 'text' => text },
+                               body: body,
                                headers: { 'Authorization' => "Token #{token}" }
                               )
       raise(RecastError.new(response.message)) if response.code != 200
@@ -43,8 +48,12 @@ module RecastAI
       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::API_ENDPOINT,
-                                    body: { 'voice' => File.new(file) },
+                                    body: body,
                                     headers: { 'Authorization' => "Token #{token}" }
                                    )
       raise(RecastError.new(response.message)) if response.code != 200

data/lib/recastai/response.rb

@@ -4,6 +4,7 @@ module RecastAI
     attr_reader :source
     attr_reader :intents
     attr_reader :sentences
+    attr_reader :language
     attr_reader :version
     attr_reader :timestamp
     attr_reader :status
@@ -17,6 +18,7 @@ module RecastAI
       @source    = response['source']
       @intents   = response['intents']
       @sentences = response['sentences'].map{ |s| Sentence.new(s) }
+      @language  = response['language']
       @version   = response['version']
       @timestamp = response['timestamp']
       @status    = response['status']
@@ -52,7 +54,7 @@ module RecastAI
     def get(name)
       @sentences.each do |sentence|
         sentence.entities.each do |entity|
-          return entity if entity.name.downcase == name.to_s.downcase
+          return entity if entity.name.casecmp(name.to_s) == 0
         end
       end
 
@@ -66,12 +68,29 @@ module RecastAI
     #   - +name+ - String, the entities' names
     # * *Returns* :
     #   - An array of instances of Entity or an empty array
-    def all(name = nil)
+    def all(name)
       entities = []
 
       @sentences.each do |sentence|
         sentence.entities.each do |entity|
-          entities << entity if entity.name.downcase == name.to_s.downcase
+          entities << entity if entity.name.casecmp(name.to_s) == 0
+        end
+      end
+
+      entities
+    end
+
+    ##
+    # Returns all entities
+    #
+    # * *Returns* :
+    #   - An array of instances of Entity or an empty array
+    def entities
+      entities = []
+
+      @sentences.each do |sentence|
+        sentence.entities.each do |entity|
+          entities << entity
         end
       end
 

data/lib/recastai/sentence.rb

@@ -15,5 +15,37 @@ module RecastAI
       @polarity = sentence['polarity']
       @entities = sentence['entities'].flat_map{ |n, e| e.map{ |ee| Entity.new(n, ee) } }
     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 = []
+
+      @entities.each do |entity|
+        entities << entity if entity.name.casecmp(name.to_s) == 0
+      end
+
+      entities
+    end
   end
 end

data/lib/recastai/utils.rb

@@ -2,8 +2,8 @@ module RecastAI
   class Utils
     # Versioning
     MAJOR   = '1'.freeze
-    MINOR   = '0'.freeze
-    MICRO   = '2'.freeze
+    MINOR   = '1'.freeze
+    MICRO   = '0'.freeze
     VERSION = "#{MAJOR}.#{MINOR}.#{MICRO}".freeze
 
     # Endpoints

data/recastai.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.name                  = 'RecastAI'
   spec.version               = RecastAI::Utils::VERSION
   spec.date                  = Date.today
-  spec.summary               = %q(Recast.AI official SDK in Ruby)
-  spec.description           = %q(Recast.AI official SDK in Ruby. Allows you to make requests to your bots.)
+  spec.summary               = %q(Recast.AI official SDK for Ruby)
+  spec.description           = %q(Recast.AI official SDK for Ruby. Allows you to make requests to your bots.)
   spec.homepage              = 'https://github.com/RecastAI/SDK-ruby'
   spec.license               = 'MIT'
   spec.authors               = ['Paul Renvoisé']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RecastAI
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Renvoisé
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: Recast.AI official SDK in Ruby. Allows you to make requests to your bots.
+description: Recast.AI official SDK for Ruby. Allows you to make requests to your
+  bots.
 email: paul.renvoise@recast.ai
 executables:
 - text
@@ -119,6 +120,7 @@ files:
 - lib/recastai/sentence.rb
 - lib/recastai/utils.rb
 - misc/.gitkeep
+- misc/logo-inline.png
 - recastai.gemspec
 homepage: https://github.com/RecastAI/SDK-ruby
 licenses:
@@ -143,5 +145,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Recast.AI official SDK in Ruby
+summary: Recast.AI official SDK for Ruby
 test_files: []