api-ai-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23133323a1d44a623c85d017620cae32a44e9ff2
-  data.tar.gz: 50614d55d052aef546b5aabcb94c51e95b01ad3e
+SHA256:
+  metadata.gz: 6ec8e00ec1d07a6c2271409f31628818773117741902d989484cfa4e61764af9
+  data.tar.gz: 43c83533d9479a782d56a50c4f4e4323c367ca7409a15c1765972ee55eb8dc88
 SHA512:
-  metadata.gz: 7b605200b1e15ae56ee73fe4052f47eeba29704da9f96945547f1782608fdb5fe93a3af9076e20d68bd491a56958e297c04ce0c4eb3de1ea85fe28e50aa378d9
-  data.tar.gz: 211cd510f08369b79d85bbf8bf0bb6c56e5a39310b2678844b931c36e874c84e51a1ca29eb41c0d1ad3d5a69f5484ea65898ef34b2f7b524c5f5da8e68792853
+  metadata.gz: 76b667a4e39af32b9ef5b1f7ef7b58d15acf2c7551073388e785908b94dd1402e1a4352a535811bd25707afb3d8f4e5cf37cd7c3c03155c79a280d142f4d1f9d
+  data.tar.gz: 923988dccb32dab43db2753bc10c592bfad156f239a6570c88a2e5af5c3d58230ad3253b705d95fe08213e5c7b398c88807aa710ecf198c46af9488246eeda8c

data/README.md

@@ -32,7 +32,7 @@ response_two = client.event_request 'MY_EVENT_WITH_DATA_TO_STORE', {:some_param
 
 ```
 
-**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.
+**text_request** method returns symbolized https://api.ai response. Structure of response can be found at https://docs.api.ai/docs/query#response.
 
 ## Advanced usage
 
@@ -48,11 +48,10 @@ ApiAiRuby::Client.new(
 )
 ```
 
-And you also can send additional data to server during request, use second parameter of **text_request** and **voice_request** methods to do that
+And you also can send additional data to server during request, use second parameter of **text_request** method to do that
 
 ```ruby
     response = client.text_request 'Hello', :contexts => ['firstContext'], :resetContexts => true
-    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
@@ -84,7 +83,7 @@ client.text_request 'call Mozart', entities: [
         ]
     }
 ]
-     
+
 ```
 
 Or with separate **create_user_entities_request** object with full CRUD support:
@@ -102,11 +101,11 @@ entries_unknown = [
     ApiAiRuby::Entry.new('Jane Doe', %w(Jane))
 ]
 
-entity_contacts = ApiAiRuby::Entity.new('contacts', [entries_composers])
+entity_contacts = ApiAiRuby::Entity.new('contacts', entries_composers)
 
 # let's go
 uer = client.create_user_entities_request
-uer.create(contacts) # or uer.create([entity1, entity2...])
+uer.create(entity_contacts) # or uer.create([entity1, entity2...])
 
 client.text_request 'call Mozart' # will work
 
@@ -117,7 +116,7 @@ client.text_request 'call John' # will work
 
 uer.retrieve('contacts') # will return current state of user entity
 uer.delete('contacts') # will remove user entities for given session    
-       
+
 ```
 ## Context
 Also SDK has full support of [contexts](https://docs.api.ai/docs/contexts) API.AI endpoint with special object, called ```contexts_request```
@@ -131,7 +130,7 @@ parameters = {
 }
 name = 'test_context'
 
-# you can create context using built-in model ApiAiRuby::Context 
+# you can create context using built-in model ApiAiRuby::Context
 test_context = ApiAiRuby::Context.new(name, lifespan, parameters)
 another_test_context = ApiAiRuby::Context.new('another_test_context')
 one_more_test_context = ApiAiRuby::Context.new('one_more_test_context', 4)
@@ -153,7 +152,7 @@ context_request.delete() # will remove all context in session
 
 ```
 
-#Timeouts
+# Timeouts
 **ApiAiRuby::Client** uses the [http gem](https://github.com/httprb/http) under the hood.  You can use ```timeout_options``` on the client to set these.
 ```ruby
 ApiAiRuby::Client.new(
@@ -169,31 +168,35 @@ ApiAiRuby::Client.new(
 Please see the [httprb wiki on timeouts](https://github.com/httprb/http/wiki/Timeouts) for more information.
 
 
-#Error handling
+# Error handling
 **ApiAiRuby::Client** currently able to raise two kind of errors: **ApiAiRuby::ClientError** (due to configuration mismatch) and **ApiAiRuby::RequestError** in case of something goes wrong during request. For both kind of errors you can get **error.message** (as usual) and **ApiAiRuby::RequestError** can additionally give you code of server error (you can get it with **error.code**)
 
 
-#Changelog
+# Changelog
+
+## 2.1.0
+### Breaking:
+- voice request removed
 
-##2.0.0
-###Breaking:
+## 2.0.0
+### Breaking:
 - http gem dependency updated to 2.0, it does no longer raise `Errno::ETIMEDOUT`. Thanks to @tak1n
 
-##1.3.0 
+## 1.3.0 
 
-###Non-breaking:
+### Non-breaking:
 - contexts endpoint support (https://docs.api.ai/docs/contexts)
 - better RDoc
 
-###Breaking:
+### Breaking:
 - ApiAiRuby::Client::user_entities_request renamed to ApiAiRuby::Client::create_user_entities_request
 - ApiAiRuby::Entity::addEntry renamed to ApiAiRuby::Entity::add_entry
 
-##Previous
+## Previous
 * 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
-* 1.1.4 - removed unused dependency and updated default API version 
+* 1.1.4 - removed unused dependency and updated default API version
 * 1.1.3 - fixed non-correctly serialized parameters in new contexts during query send process
 * 1.1.2 - fixed compatibility with ruby version less then 2.1.6

data/lib/api-ai-ruby.rb

@@ -5,7 +5,6 @@ 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/context'
 require 'api-ai-ruby/models/entry'
 require 'api-ai-ruby/models/entity'

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

@@ -77,19 +77,14 @@ module ApiAiRuby
       ApiAiRuby::EventRequest.new(self, options).perform
     end
 
-    # @deprecated
-    # @param file_stream [File]
-    # @param options [Object]
-    # @return [Array, Hash]
-    def voice_request(file_stream, options = {})
-      raise ApiAiRuby::ClientError.new('Credentials missing') if !credentials?
-      options[:file] = file_stream
-      ApiAiRuby::VoiceRequest.new(self, options).perform
+    # @return [ApiAiRuby::UserEntitiesRequest]
+    def create_user_entities_request
+      ApiAiRuby::UserEntitiesRequest.new(self)
     end
 
     # @return [ApiAiRuby::UserEntitiesRequest]
-    def create_user_entities_request
-      ApiAiRuby::UserEntitiesRequest.new(self);
+    def create_entities_request
+      ApiAiRuby::UserEntitiesRequest.new(self, {uri_path: 'entities'})
     end
 
     # @return [ApiAiRuby::ContextsRequest]
@@ -98,4 +93,4 @@ module ApiAiRuby
     end
 
   end
-end
+end

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

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

data/lib/api-ai-ruby/crud/user_entity_request.rb

@@ -4,8 +4,8 @@ module ApiAiRuby
     def initialize(client,  options = {})
       super client, options
       @headers['Content-Type'] = 'application/json; charset=UTF-8'
-      @crud_base_uri = client.api_base_url + 'userEntities'
-      @uri = @crud_base_uri
+      @crud_base_uri = client.api_base_url +
+        (options[:uri_path] ? options[:uri_path] : 'userEntities')
     end
 
     # @param argument [Array<ApiAiRuby::Entity, Hash>, ApiAiRuby::Entity, Hash]
@@ -16,9 +16,23 @@ module ApiAiRuby
       end
       @uri = @crud_base_uri
       @request_method = :post
-      @options[:entities] = argument.is_a?(Array) ? argument : [argument]
-      response = self.perform
-      @options.delete(:entities)
+
+      old_options = nil
+
+      begin
+        if argument.is_a?(ApiAiRuby::Entity)
+          old_options = @options
+          @options = argument
+        else
+          @options[:entities] = argument.is_a?(Array) ? argument : [argument]
+        end
+
+        response = self.perform
+
+        @options.delete(:entities) if @options.respond_to? :delete
+      rescue
+        @options = old_options || @options
+      end
       response
     end
 
@@ -46,6 +60,35 @@ module ApiAiRuby
       response
     end
 
+    def update_entries(name, entries)
+
+      raise ApiAiRuby::ClientError.new('Entity name required') if !name
+
+      @options = entries
+
+      @request_method = :put
+      @uri = @crud_base_uri + '/' + name + '/entries'
+      response = self.perform
+      @options.delete(:extend)
+      @options.delete(:name)
+      @options.delete(:entries)
+      response
+    end
+
+    def add_entries(name, entries)
+      raise ApiAiRuby::ClientError.new('Entity name required') if !name
+
+      @options = entries
+
+      @request_method = :post
+      @uri = @crud_base_uri + '/' + name + '/entries'
+      response = self.perform
+      @options.delete(:extend)
+      @options.delete(:name)
+      @options.delete(:entries)
+      response
+    end
+
     def delete(name)
       raise ApiAiRuby::ClientError.new('Entity name required') if !name
       @request_method = :delete
@@ -54,4 +97,4 @@ module ApiAiRuby
     end
 
   end
-end
+end

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

@@ -41,12 +41,6 @@ describe 'api' do
     expect {client.text_request}.to raise_error(ApiAiRuby::RequestError)
   end
 
-  it 'should send voiceData to API' do
-    expect(@client.voice_request(File.new(fixture_path + '/hello.wav'))[:result][:resolvedQuery]).to eq 'hello'
-    # asr was disabled for non-premium users
-    # expect {@client.voice_request(File.new(fixture_path + '/hello.wav'))}.to raise_error(ApiAiRuby::RequestError)
-  end
-
   it 'should correctly set contexts with parameters' do
     @client.text_request 'Hello', :resetContexts => true
     response = @client.text_request 'hello', contexts: [{ name: 'user', parameters: { first_name: 'Johnny' }}]

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

@@ -26,7 +26,6 @@ describe ApiAiRuby::Client do
 
     it 'raises error on request without credentials' do
       expect {subject.text_request '123'}.to raise_error(ApiAiRuby::ClientError)
-      expect {subject.voice_request '123'}.to raise_error(ApiAiRuby::ClientError)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-ai-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - api.ai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,7 +78,6 @@ files:
 - 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
 - lib/api-ai-ruby/request_error.rb
 - spec/api-ai-ruby/api_spec.rb
 - spec/api-ai-ruby/client_spec.rb
@@ -109,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: ruby SDK for https://api.ai
@@ -123,4 +122,3 @@ test_files:
 - spec/api-ai-ruby/voice_request_spec.rb
 - spec/fixtures/hello.wav
 - spec/helper.rb
-has_rdoc: 

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

@@ -1,23 +0,0 @@
-require 'json'
-
-module ApiAiRuby
-  class VoiceRequest < ApiAiRuby::RequestQuery
-
-
-    # @param client [ApiAiRuby::Client]
-    # @param options [Hash]
-    # @return [ApiAiRuby::VoiceRequest]
-    def initialize(client,  options = {})
-      options[:lang] = client.api_lang
-      super client, options
-      file = options.delete(:file)
-      options = {
-          :request => options.to_json,
-          :voiceData => HTTP::FormData::File.new(file, filename: File.basename(file))
-      }
-      @options = options
-      self
-    end
-
-  end
-end