api-ai-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0c26a1fbd164ecd6dd0e2dc0f3b4f6b3786ff7c
-  data.tar.gz: bfe06cb9f86d69f0157a3779b6d464acd8cc5641
+  metadata.gz: 1fbef071683c7b7e9915319e38ae44faa162a040
+  data.tar.gz: a60d2a0684adebc1f8e8b2461cce2aff7c876e00
 SHA512:
-  metadata.gz: d7f1aa1be77d99141a6925257cedb478c791cf5fd894863cf57dd9357df015c3217c640054ac179a11f5d4cd16f71946cbc2791af4be6a56c96bec1e033bba90
-  data.tar.gz: a7e6803956b3ad09e637cf428f6c429e82cb148f38f18567e664088380a697c0568fe1229585d1f114d3eac55eb20f7bbbf1b671d2b2484ec812e0ab8fe45f2e
+  metadata.gz: e1d53a014ef3c8b82c41176a06358eee4ce4294aa1bc342a3175155de82fc810fd6fd0b8742aba7bba32214489c67459862c287db6f9b500b679eefa1e50dad3
+  data.tar.gz: e6b25282f16e842fe635be4cd1e07fee703753142ed1dc46f6cf9560e3be108d4e21ff673bd84466205fd4963c6b1cc43b02305413e872426a457b5b184e832f

data/README.md

@@ -7,12 +7,11 @@ A Ruby SDK to the https://api.ai natural language processing service.
 
 ## Basic Usage
 
-Just pass correct credentials to ApiAiRuby::Client constructor
+Just pass correct credentials to **ApiAiRuby::Client** constructor
 
 ```ruby
 client = ApiAiRuby::Client.new(
     :client_access_token => 'YOUR_ACCESS_TOKEN',
-    :subscription_key => 'YOUR_SUBSCRIPTION_KEY'
 )
 ```
 After that you can send text requests to the https://api.ai with command
@@ -52,15 +51,14 @@ Example answer:
 }
 ```
 
-voice_request and text_request methods returns symbolized https://api.ai response. Structure of response can be found here (https://docs.api.ai/docs/query#response)
+**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.
 
 ## Advanced usage
 
-During client instantination you can additionally set parameters like api url, request language and version (more info at https://docs.api.ai/docs/versioning, https://docs.api.ai/docs/languages)
+During client instantiating you can additionally set parameters like **api url**, request **language** and **version** (more info at https://docs.api.ai/docs/versioning, https://docs.api.ai/docs/languages)
 
 ```ruby
 ApiAiRuby::Client.new(
-    subscription_key: 'YOUR_SUBSCRIPTION_KEY',
     client_access_token: 'YOUR_ACCESS_TOKEN',
     api_lang: 'FR',
     api_base_url: 'http://example.com/v1/',
@@ -68,15 +66,16 @@ ApiAiRuby::Client.new(
 )
 ```
 
-And you also can send additional data to server during request, use second parameter of text_request and voice_request methods for that
+And you also can send additional data to server during request, use second parameter of **text_request** and **voice_request** methods to do that
 
 ```ruby
     response = client.text_request 'Hello', :contexts => ['firstContext'], :resetContexts => true
-    response = client.voice_request 'Hello', :timezone => "America/New_York"
+    response = client.voice_request file, :timezone => "America/New_York"
 ```
-More information about possible parameters cand be found at https://docs.api.ai/docs/query page
-
+More information about possible parameters can be found at https://docs.api.ai/docs/query page
 
+#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**)
 
 
 

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

@@ -35,7 +35,6 @@ module ApiAiRuby
     def credentials
       {
           client_access_token: client_access_token,
-          subscription_key: subscription_key
       }
     end
 

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

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

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

@@ -18,7 +18,6 @@ module ApiAiRuby
       @options = options
       @headers = {
           'Authorization': 'Bearer ' + client.client_access_token,
-          'ocp-apim-subscription-key': 'Bearer ' + client.client_access_token
       }
     end
 

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

@@ -1,7 +1,7 @@
 require 'helper'
 
 describe 'api' do
-  let (:client) { ApiAiRuby::Client.new(:client_access_token => '3485a96fb27744db83e78b8c4bc9e7b7', :subscription_key => 'cb9693af-85ce-4fbf-844a-5563722fc27f')}
+  let (:client) { ApiAiRuby::Client.new(:client_access_token => '3485a96fb27744db83e78b8c4bc9e7b7')}
 
   it 'should return response' do
     response = client.text_request 'Hello'
@@ -28,7 +28,7 @@ describe 'api' do
   end
 
   it 'should response with error on wrong credentials' do
-    client = ApiAiRuby::Client.new(subscription_key: 'SK', client_access_token: 'CS')
+    client = ApiAiRuby::Client.new(client_access_token: 'CS')
     expect {client.text_request}.to raise_error(ApiAiRuby::RequestError)
   end
 

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: api-ai-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - api.ai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-04-22 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
 - !ruby/object:Gem::Dependency
   name: http-form_data
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Plugin makes it easy to integrate your Ruby application with https://api.ai
@@ -74,7 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -105,17 +105,17 @@ 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.4.8
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: ruby SDK for https://api.ai