RecastAI 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ae37ffab60dbf742c6a06a8c2411032b3e4ff4d
+  data.tar.gz: e92fa41890dee300927a64adeb8dab2119a31f78
+SHA512:
+  metadata.gz: 2ca79e4a0900c717570bf9e72c9db3d5da210246d9b5eb1d8e09d37002ff39aeefb602d7a20af1ac4b7eeff9459981e1c1cfd595ac1ef8108b5f2c8ff9a10881
+  data.tar.gz: 7341f41cecdfc328311f3bf27e78304b20dfa7241e1287406c603cd57f75799580a794b0a31f6a500c6d29412a355017b03cea6e4b488088e8d4ef9bd57cd998

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,12 @@
+Metrics/LineLength:
+  Max: 999
+Metrics/MethodLength:
+  Max: 999
+Style/Documentation:
+  Enabled: false
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+Style/RedundantSelf:
+  Enabled: false
+Style/WordArray:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    RecastAI (1.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.1.5)
+    hashdiff (0.3.0)
+    httmultiparty (0.3.16)
+      httparty (>= 0.7.3)
+      mimemagic
+      multipart-post
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    mimemagic (0.3.1)
+    multi_xml (0.5.5)
+    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.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    webmock (1.24.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RecastAI!
+  awesome_print (~> 1.6)
+  rspec (~> 3.4)
+  simplecov
+  webmock (~> 1.24)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 RecastAI
+
+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,190 @@
+# SDK-ruby
+
+Recast.AI official SDK in Ruby.
+
+
+## Synospis
+
+This gem is a pure Ruby interface to the [Recast.AI](https://recast.ai) API. It allows you to make requests to your bots.
+
+
+## Installation
+
+### Via Gemfile
+
+From [rubygems.org](https://rubygems.org/):
+
+```bash
+gem 'RecastAI'
+```
+
+From [github.com](https://github.com/):
+
+```bash
+gem 'RecastAI', github: 'RecastAI/SDK-ruby'
+```
+
+### Via Terminal
+
+From [rubygems.org](https://rubygems.org/):
+
+```bash
+gem install 'RecastAI'
+```
+
+From [github.com](https://github.com/):
+
+```bash
+git clone https://github.com/RecastAI/SDK-ruby
+gem build recastai.gemspec
+gem install RecastAI-*.gem
+```
+
+
+## Usage
+
+### Gem
+
+```ruby
+require 'RecastAI'
+
+client = RecastAI::Client.new(YOUR_TOKEN)
+response = client.text_request(YOUR_TEXT)
+
+if response.intent == YOUR_EXPECTED_INTENT
+  # Do your code...
+end
+```
+
+```ruby
+require 'RecastAI'
+
+client = RecastAI::Client.new(YOUR_TOKEN)
+response = client.file_request(File.new(File.join(File.dirname(__FILE__), YOUR_FILE)))
+
+if response.intent == YOUR_EXPECTED_INTENT
+  # Do your code...
+end
+```
+
+You can find more examples in the `misc/` folder.
+
+### CLI
+
+```bash
+./bin/text YOUR_TOKEN YOUR_TEXT
+# => Recast.AI's response
+```
+
+```bash
+./bin/file YOUR_TOKEN YOUR_VOICE_FILE
+# => Recast.AI's response
+```
+
+## Specs
+
+### Classes
+
+This gem contains 5 main classes, as follows:
+
+* RecastAI::Client is the client allowing you to make requests.
+* RecastAI::Response contains the response from [Recast.AI](https://recast.ai).
+* RecastAI::Sentence represents a sentence of the response.
+* RecastAI::Entity represents an entity found by Recast.AI in your user's input.
+* RecastAI::RecastError is the error thrown by the gem.
+
+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:
+
+* 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*
+
+### RecastAI::Response
+
+The Recast.AI Response is generated after a call with the two previous methods and contains the following methods:
+
+* raw(\*) *Returns the raw unparsed response*
+* source(\*) *Returns the source sentence Recast.AI processed*
+* intents(\*) *Returns all the matched intents*
+* intent(\*) *Returns the first matched intent*
+* sentences(\*) *Returns all the detected sentences*
+* sentence(\*) *Returns the first detected sentence*
+* get(name) *Returns the first entity matching -name-*
+* all(name) *Returns all the entities matching -name-*
+* version(\*) *Returns the version of the JSON*
+* timestamp(\*) *Returns the timestamp at the end of the processing*
+* status(\*) *Returns the status of the response*
+
+### RecastAI::Sentence
+
+The Recast.AI Sentence is generated by the Recast.AI Response initializer and provides the following methods:
+
+* source(\*) *Returns the source of the sentence*
+* type(\*) *Returns the type of the sentence*
+* action(\*) *Returns the action of the sentence*
+* agent(\*) *Returns the agent of the sentence*
+* polarity(\*) *Returns the polarity (negation or not) of the sentence*
+* entities(\*) *Returns all the entities detected in the sentence*
+
+### RecastAI::Entity
+
+The Recast.AI Entity is generated by the Recast.AI Sentence initializer and provides the following method:
+
+* name(\*) *Returns the name of the entity*
+* raw(\*) *Returns the raw text on which the entity was detected*
+
+In addition to this method, more attributes are generated depending of the nature of the entity, which can be one of the following:
+
+* hex(\*)
+* value(\*)
+* deg(\*)
+* formated(\*)
+* lng(\*)
+* lat(\*)
+* unit(\*)
+* code(\*)
+* person(\*)
+* number(\*)
+* gender(\*)
+* next(\*)
+* grain(\*)
+* order(\*)
+
+### RecastAI::RecastError
+
+The Recast.AI Error is thrown when receiving an non-200 response from Recast.AI, it implements the following methods:
+
+* message(\*) *Returns the message of the error*
+* code(\*) *Returns the error code*
+
+## More
+
+You can view the whole API reference at [man.recast.ai](https://man.recast.ai).
+
+
+## License
+
+Copyright (c) [2016] [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
+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/bin/file

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/recastai'
+
+raise 'You must provide a token for your sentence to be processed' unless ARGV.any? && !ARGV[0].nil?
+raise 'You must provide a voice file to be processed' unless ARGV.any? && !ARGV[1].nil?
+
+client   = RecastAI::Client.new(ARGV[0])
+response = client.file_request(ARGV[1])
+
+ap JSON.parse(response.raw)

data/bin/text

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/recastai'
+
+raise 'You must provide a token for your sentence to be processed' unless ARGV.any? && !ARGV[0].nil?
+raise 'You must provide a sentence to be processed' unless ARGV.any? && !ARGV[1].nil?
+
+client   = RecastAI::Client.new(ARGV[0])
+response = client.text_request(ARGV[1])
+
+ap JSON.parse(response.raw)

data/lib/recastai.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'httparty'
+require 'httmultiparty'
+require 'json'
+
+require 'recastai/utils'
+require 'recastai/errors'
+require 'recastai/client'
+require 'recastai/response'
+require 'recastai/sentence'
+require 'recastai/entity'
+
+require 'awesome_print'

data/lib/recastai/client.rb

@@ -0,0 +1,55 @@
+module RecastAI
+  class Client
+    attr_accessor :token
+
+    def initialize(token = nil)
+      @token = token
+    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', 400)) if token.nil?
+
+      response = HTTParty.post(Utils::API_ENDPOINT,
+                               body: { 'text' => text },
+                               headers: { 'Authorization' => "Token #{token}" }
+                              )
+      raise(RecastError.new(response.message, response.code)) 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', 400)) if token.nil?
+
+      response = HTTMultiParty.post(Utils::API_ENDPOINT,
+                                    body: { 'voice' => File.new(file) },
+                                    headers: { 'Authorization' => "Token #{token}" }
+                                   )
+      raise(RecastError.new(response.message, response.code)) if response.code != 200
+
+      Response.new(response.body)
+    end
+  end
+end

data/lib/recastai/entity.rb

@@ -0,0 +1,14 @@
+module RecastAI
+  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/recastai/errors.rb

@@ -0,0 +1,11 @@
+module RecastAI
+  class RecastError < StandardError
+    attr_reader :message
+    attr_reader :code
+
+    def initialize(message, code)
+      @message = message
+      @code    = code
+    end
+  end
+end

data/lib/recastai/response.rb

@@ -0,0 +1,81 @@
+module RecastAI
+  class Response
+    attr_reader :raw
+    attr_reader :source
+    attr_reader :intents
+    attr_reader :sentences
+    attr_reader :version
+    attr_reader :timestamp
+    attr_reader :status
+
+    def initialize(response)
+      @raw = response
+
+      response = JSON.parse(response)
+      response = response['results']
+
+      @source    = response['source']
+      @intents   = response['intents']
+      @sentences = response['sentences'].map{ |s| Sentence.new(s) }
+      @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 sentence provided there is one
+    #
+    # * *Args* :
+    # * *Returns* :
+    #   - A Sentence or nil
+    def sentence
+      @sentences.any? ? @sentences.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)
+      @sentences.each do |sentence|
+        sentence.entities.each do |entity|
+          return entity if entity.name.downcase == name.to_s.downcase
+        end
+      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 = nil)
+      entities = []
+
+      @sentences.each do |sentence|
+        sentence.entities.each do |entity|
+          entities << entity if entity.name.downcase == name.to_s.downcase
+        end
+      end
+
+      entities
+    end
+  end
+end

data/lib/recastai/sentence.rb

@@ -0,0 +1,19 @@
+module RecastAI
+  class Sentence
+    attr_reader :source
+    attr_reader :type
+    attr_reader :action
+    attr_reader :agent
+    attr_reader :polarity
+    attr_reader :entities
+
+    def initialize(sentence)
+      @source   = sentence['source']
+      @type     = sentence['type']
+      @action   = sentence['action']
+      @agent    = sentence['agent']
+      @polarity = sentence['polarity']
+      @entities = sentence['entities'].flat_map{ |n, e| e.map{ |ee| Entity.new(n, ee) } }
+    end
+  end
+end

data/lib/recastai/utils.rb

@@ -0,0 +1,13 @@
+module RecastAI
+  class Utils
+    # Versioning
+    MAJOR   = '1'.freeze
+    MINOR   = '0'.freeze
+    MICRO   = '0'.freeze
+    VERSION = "#{MAJOR}.#{MINOR}.#{MICRO}".freeze
+
+    # Endpoints
+    API_ENDPOINT = 'https://api.recast.ai/v1/request'.freeze
+    WS_ENDPOINT  = 'wss://api.recast.ai/v1/request'.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/recastai/utils'
+
+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.homepage         = 'https://github.com/RecastAI/SDK-ruby'
+  spec.license          = 'MIT'
+  spec.authors          = ['Paul Renvoisé']
+  spec.email            = 'paul.renvoise@recast.ai'
+  spec.files            = `git ls-files -z`.split("\x0").reject{ |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables      = ['text', 'file']
+  spec.require_paths    = ['lib']
+
+  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.11'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: RecastAI
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Renvoisé
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-02 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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Recast.AI official SDK in Ruby. Allows you to make requests to your bots.
+email: paul.renvoise@recast.ai
+executables:
+- text
+- file
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/file
+- bin/text
+- lib/recastai.rb
+- lib/recastai/client.rb
+- lib/recastai/entity.rb
+- lib/recastai/errors.rb
+- lib/recastai/response.rb
+- lib/recastai/sentence.rb
+- lib/recastai/utils.rb
+- misc/.gitkeep
+- recastai.gemspec
+homepage: https://github.com/RecastAI/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Recast.AI official SDK in Ruby
+test_files: []