api-ai-ruby 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 522e5912efc69543bb84c18c85e7be17a3858640
-  data.tar.gz: bae85fbe0f16379fef9ceeb70a0b2035a85f26d8
+  metadata.gz: 730482838f5570e11f15f9dc035bd1660dcc9ee6
+  data.tar.gz: 50f4c68548a98f9055f01e8196f5bb1cea2931ef
 SHA512:
-  metadata.gz: 33292054e5c042f63fa248b53bedd68d2d009e1eeb16d79aae63cf798829f9aeb500b031189a530887c2be37c7827867269270630866a56f7eba1f4cff823628
-  data.tar.gz: 1358d1cf73154909c6be7e903828e349fd9bad9342b010344ce92f0d2c825672dd6c867bb4edb86c1a9e23ceff665cc3f043f5dedd4b74ba74020f90a2ae2777
+  metadata.gz: ec864af3471a6f93aa1bb898e7fc29ed341b4dfb4828da406beb2570538bcd3f21b71755fdd3eb66822bda1a1e5baac3ae6e6ba866a24957eeee16903504f238
+  data.tar.gz: 9d1548277b2bb7a98b5f11bb789f91d80d050bfa3d9b7dad7fd29da6a63c87d2a48d3833648c594358124b623185cee0e87d5a0e68d2546c7cc2bc1d2dc9a53c

data/README.md

@@ -22,35 +22,14 @@ After that you can send text requests to the https://api.ai with command
 response = client.text_request 'hello!'
 ```
 
-And voice requests with file stream
+Or try to invocate intent via defined '[event](https://docs.api.ai/docs/concept-events)':
 
 ```ruby
-file = File.new 'hello.wav'
-response = client.voice_request(file)
-```
 
-Example answer:
-```
-{
-  :id        => "6daf5ab7-276c-43ad-a32d-bf6831918492",
-  :timestamp => "2015-12-22T08:42:15.785Z",
-  :result    => {
-    :source        => "agent",
-    :resolvedQuery => "Hello",
-    :speech        => "Hi! How are you?",
-    :action        => "greeting",
-    :parameters    => {},
-    :contexts      => [],
-    :metadata      => {
-      :intentId   => "a5d685ab-1f19-46b0-9478-69f794553668",
-      :intentName => "hello"
-    }
-  },
-  :status    => {
-    :code      => 200,
-    :errorType => "success"
-  }
-}
+response_zero = client.event_request 'MY_CUSTOM_EVENT_NAME';
+response_one = client.event_request 'MY_EVENT_WITH_DATA_TO_STORE', {:param1 => 'value'}
+response_two = client.event_request 'MY_EVENT_WITH_DATA_TO_STORE', {:some_param => 'some_value'}, :resetContexts => true
+
 ```
 
 **voice_request** and **text_request** methods returns symbolized https://api.ai response. Structure of response can be found at https://docs.api.ai/docs/query#response.
@@ -73,7 +52,7 @@ And you also can send additional data to server during request, use second param
 
 ```ruby
     response = client.text_request 'Hello', :contexts => ['firstContext'], :resetContexts => true
-    response = client.voice_request file, :timezone => "America/New_York"
+    response = client.voice_request file, :timezone => 'America/New_York'
 ```
 
 More information about possible parameters can be found at https://docs.api.ai/docs/query page
@@ -162,6 +141,7 @@ Please see the [httprb wiki on timeouts](https://github.com/httprb/http/wiki/Tim
 
 #Changelog
 
+* 1.2.3 - events support
 * 1.2.2 - added configurable timeouts for requests (thanks [bramski](https://github.com/bramski))
 * 1.2.1 - fixed UTF-8 in text-requests
 * 1.2.0 - added configurable session_id and full userEntities support

data/lib/api-ai-ruby.rb

@@ -4,8 +4,8 @@ require 'api-ai-ruby/request_error'
 require 'api-ai-ruby/client_error'
 require 'api-ai-ruby/request/request_query'
 require 'api-ai-ruby/request/text_request'
+require 'api-ai-ruby/request/event_request'
 require 'api-ai-ruby/request/voice_request'
 require 'api-ai-ruby/models/entry'
 require 'api-ai-ruby/models/entity'
 require 'api-ai-ruby/crud/user_entity_request'
-

data/lib/api-ai-ruby/client.rb

@@ -2,11 +2,10 @@ require 'securerandom'
 
 module ApiAiRuby
   class Client
-    attr_accessor :client_access_token, :subscription_key, :timeout_options
+    attr_accessor :client_access_token, :timeout_options
     attr_writer :user_agent, :api_version, :api_lang, :api_base_url, :api_session_id
 
     # Initializes a new Client object
-    #
     # @param options [Hash]
     # @return [ApiAiRuby::Client]
     def initialize(options = {})
@@ -60,25 +59,26 @@ module ApiAiRuby
       ApiAiRuby::TextRequest.new(self, options).perform
     end
 
+    # @param eventName [String]
+    # @param data [Object]
+    # @param options [Object]
+    def event_request (eventName = '', data = {}, options = {})
+      raise ApiAiRuby::ClientError.new('Credentials missing') if !credentials?
+      options[:event] = {
+          name: eventName,
+          data: data
+      }
+      ApiAiRuby::EventRequest.new(self, options).perform
+    end
+
     def voice_request(file_stream, options = {})
       raise ApiAiRuby::ClientError.new('Credentials missing') if !credentials?
       options[:file] = file_stream
       ApiAiRuby::VoiceRequest.new(self, options).perform
     end
 
-    # @param entity_name [String]
-    # @param entries [ApiAiRuby:Entry[]]
-    # @param options [Hash]
-
-    def user_entities_request #entity_name, entries, options = {}
+    def user_entities_request
       ApiAiRuby::UserEntitiesRequest.new(self);
-      # raise ApiAiRuby::ClientError.new('Entity name required') if entity_name.nil?
-      # raise ApiAiRuby::ClientError.new('Entity entries array required') if !entries.nil? && entries.is_a?(Array)
-      # raise ApiAiRuby::ClientError.new('Entity name required') if !(options.has_key?(:entries) && options[:entries].is_a?(Array))
-      # options[:name] = entity_name
-      # options[:entries] = entries
-      # options[:extend] = options[:extend] || false
-      # ApiAiRuby::UserEntitiesRequest.new(self, options).perform
     end
 
   end

data/lib/api-ai-ruby/constants.rb

@@ -1,6 +1,6 @@
 module ApiAiRuby
   class Constants
-    VERSION = '1.2.2'
+    VERSION = '1.2.3'
     DEFAULT_BASE_URL = 'https://api.api.ai/v1/'
     DEFAULT_API_VERSION = '20150910'
     DEFAULT_CLIENT_LANG = 'en'

data/lib/api-ai-ruby/request/event_request.rb

@@ -0,0 +1,13 @@
+module ApiAiRuby
+  class EventRequest < ApiAiRuby::RequestQuery
+
+    # @param client [ApiAiRuby::Client]
+    # @param options [Hash]
+    # @return [ApiAiRuby::EventRequest]
+    def initialize (client, options={})
+      options[:lang] = client.api_lang
+      super client, options
+      @headers['Content-Type'] = 'application/json; charset=UTF-8'
+    end
+  end
+end

data/lib/api-ai-ruby/request/request_query.rb

@@ -7,7 +7,7 @@ module ApiAiRuby
 
     # @param client [ApiAiRuby::Client]
     # @param options [Hash]
-    # @return [ApiAiRuby::TextRequest]
+    # @return [ApiAiRuby::RequestQuery]
 
     def initialize(client, options = {})
       @client = client

data/spec/api-ai-ruby/api_spec.rb

@@ -104,5 +104,15 @@ describe 'api' do
       @uer.delete('dwarfs')
       expect{@uer.retrieve('dwarfs')}.to raise_error(ApiAiRuby::RequestError)
     end
+
+    #
+    # commented until test agent update
+    #
+    # it 'should invoke event' do
+    # response = @client.event_request 'WELCOME'
+    # expect(response[:result][:action]).to eq 'input.welcome'
+    # puts(response)
+    # end
+
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: api-ai-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - api.ai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.4
 description: Plugin makes it easy to integrate your Ruby application with https://api.ai
@@ -60,7 +60,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -73,6 +73,7 @@ files:
 - lib/api-ai-ruby/crud/user_entity_request.rb
 - lib/api-ai-ruby/models/entity.rb
 - lib/api-ai-ruby/models/entry.rb
+- lib/api-ai-ruby/request/event_request.rb
 - lib/api-ai-ruby/request/request_query.rb
 - lib/api-ai-ruby/request/text_request.rb
 - lib/api-ai-ruby/request/voice_request.rb
@@ -95,17 +96,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ruby SDK for https://api.ai
@@ -118,4 +119,3 @@ test_files:
 - spec/api-ai-ruby/voice_request_spec.rb
 - spec/fixtures/hello.wav
 - spec/helper.rb
-has_rdoc: