wit_ruby 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e040638ae931f07535588e9e1c12d684322fa5b9
-  data.tar.gz: bfaab5bddd0a95d47ee32f9f1aa63fddd8002b16
+  metadata.gz: f7a37eae422e375b443cde450d797b067ad85051
+  data.tar.gz: 01d091048c24291e389334f0c22836c0837ff94a
 SHA512:
-  metadata.gz: e8706451d4e2fcc63f27f31d0cd73289fe2e839797c6383df98944fb19d1e2150af17a0603fa6c78f36a0f74ed72c8ac8dc03c94de78553a3b0dec0879a718aa
-  data.tar.gz: 2ebc0aa165a14e8bbe3280669b202b0f67d945c44d04bc13d4d6667593f089cfa38b351db4a73a5d636bbbfe7dedfb7ee5fa9f83cc4a49f91bdfc48a189224d8
+  metadata.gz: 66036ce9176e0fb631094f784565acb5dc632f3d9c0900919f4080133f4aba580ca44608f41d4e2d927cafd55b769e7b6e977393ffa4f56ab225d5f180935573
+  data.tar.gz: 239caed49b27506a3147821a744563ca0bb0daa3996fbe57333385d2048ed174ec0f31de7858bbbf4a246a5f23421d4c388d2b39b5fca3d15398d03362d718ac

data/CHANGELOG.md

@@ -0,0 +1,119 @@
+# WitRuby Changelog
+All changes to this API wrapper will be documented in this file. This file follows the guidelines explained over at http://keepachangelog.com/.
+
+## 1.1.1 - 2014-06-30
+### Added
+- As the wrapper defaults to the newest Wit.AI API version, new additions make WitRuby compatible.
+- Added instance method, `entities`, for class Message that returns entities in result of a query
+- Added optional argument, index, for methods `confidence`, `entities`, `entity_names`, and `intent` that returns each value at the desired index. Defaults at 0 if no index is passed (this is in response to Wit returning more than one outcome).
+- Added ability to pass queries with spaces.
+- Default to RSpec 3.
+
+### Deprecated
+- New Wit.AI version deprecates some specific methods as results has been changed.
+
+### Removed
+- Nothing
+
+### Fixed
+- Due to the new version of the API, functionalities break in 1.1.0. This is fixed from the new additions.
+- Tests that fail due to defaulting to the newest RSpec (being RSpec 3). Now defaults to RSpec 3 and fixed accordingly.
+
+## 1.1.0 - 2014-06-15
+
+### Added
+- Implemented API call to send a specific sound file containing a message over to wit.ai (GET).
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Changed testing suites to use a general instance for testing over at wit.ai so all developers can get passing tests.
+
+## 1.0.1 - 2014-06-06
+
+### Added
+- Raise an error if a sent message has a length that is not between 0 to 256.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.
+
+## 1.0.0 - 2014-06-03
+
+### Added
+- Yay! 1.0.0 for no reason! (Kinda.)
+- Error checking to make sure input parameters to the session are correct.
+
+### Deprecated
+- Adding expressions does not use a given BodyJson parameter and instead, requires the use of just the name of the entity, value, and new expression.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.
+
+## 0.0.3 - 2014-05-21
+
+### Added
+- Implemented getting array of entities from instance (GET).
+- Implemented getting a specific entity from its name/id (GET).
+- Implemented creation of entities (POST).
+- Implemented the ability to update entities given the ID (PUT).
+- Implemented deletion of entities (DELETE).
+- Implemented addition of values (POST).
+- Implemented deletion of values (DELETE).
+- Implemented addition of expressions (POST).
+- Implemented deletion of expressions (DELETE).
+- New class definition for post / put calls assistance called BodyJson. Helps with JSON generation.
+
+### Deprecated
+- Changed required Ruby version from 1.8.7 to 1.9.3.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.
+
+## 0.0.2 - 2014-05-15
+
+### Added
+- Implemented API call to get specific information from a sent message from it's given ID (GET).
+- Intent specific API calls functional (GET).
+- Change results to be returned as specific objects that inherit from the original class Result. Message, Intent, Entity, Expression are the specific wrappers for results.
+- Changed description in gemspec.
+- Error check so that only specific results can be refreshed. Refreshable objects are ones that
+  are directly returned from session calls.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.
+
+## 0.0.1 - 2014-05-08
+
+### Added
+- Implemented connection with wit.ai API and sending a text message (GET).
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.

data/CONTRIBUTORS.md

@@ -0,0 +1,4 @@
+# WitRuby - Contributors
+I am a beginner developer so whoever has helped me build this gem will definitely be recognized! Listed below are the amazing others who have assisted in making me a better developer and creating this gem.
+
+- @PWehlin & @rohitahuja (Platform45)

data/README.md

@@ -6,7 +6,7 @@
 [![Coverage Status](https://coveralls.io/repos/gching/wit_ruby/badge.png?branch=master)](https://coveralls.io/r/gching/wit_ruby?branch=master)
 
 
-Provides a unofficial and (seemingly) pleasant Ruby API Wrapper for the Wit.AI API (Natural Language Interface) As of 1.0.0, most functionalities have been implemented. Go over to https://rubygems.org/gems/wit_ruby for more information.
+Provides an unofficial and (seemingly) pleasant Ruby API Wrapper for the Wit.AI API (Natural Language Interface) As of 1.0.0, most functionalities have been implemented. Go over to https://rubygems.org/gems/wit_ruby for more information.
 
 I want to first off mention big props to the Wit.AI team. They are the true wizards here in making this beauty and by no means did I contribute anything magical. Do go check them out at http://wit.ai/! THANK YOU Wit.AI!
 
@@ -97,6 +97,10 @@ To send a specific message, use the saved session to send a given string as a pa
 
     $ session.send_message("Your Message")
 
+To send a specific message sound file, pass over the path of the file as a parameter.
+
+    $ session.send_sound_message("Path to sound file")
+
 To get a specific messages information from the wit.ai, pass in the message's ID and use the method below.
 
     $ session.get_message("Message ID")
@@ -105,10 +109,12 @@ To get a specific messages information from the wit.ai, pass in the message's ID
 
 ```ruby
 message_results = session.send_message("Your Message")
-message_results.confidence # Returns the confidence of the message results.
-message_results.entity_names # Generates array of names of each entity in this message.
-message_results.intent # Returns the intent that this message corresponded to.
+message_results.confidence(index=0) # Returns the confidence of the message results at the specified index.
+message_results.entities(index=0) # Returns the entities of the message results at the specified index.
+message_results.entity_names(index=0) # Generates array of names of each entity in this message at the specified index.
+message_results.intent(index=0) # Returns the intent that this message corresponded to at the specified index.
 ```
+*Index is an optional argument of type integer that lets you select the outcome at the specified index. The default index is 0.*
 
 ### Intent
 
@@ -200,7 +206,7 @@ Same goes for the deletion of an expression.
 
 ## Contributing
 
-I am a beginner developer so do contribute or help as much as possible! I definitely need to learn a lot :). Whoever helps will also have there name put here below this line. Amazing!
+I am a beginner developer so do contribute or help as much as possible! I definitely need to learn a lot :). Whoever helps will also have there name put in [CONTRIBUTORS.md](CONTRIBUTORS.md)
 _________________________________
 
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'bundler/gem_tasks'
 # Default directory to look in is `/specs`
 # Run with `rake spec`
 RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ['--color', '--format=nested']
+  task.rspec_opts = ['--color', '--format=documentation']
 end
 
 task :default => :spec

data/lib/wit_ruby/rest/message.rb

@@ -10,23 +10,30 @@ module Wit
       ## Returns the confidence of the message results.
       ##
       ## @return [Float] confidence in the message for the intent.
-      def confidence
-        outcome["confidence"]
+      def confidence(index=0)
+        self.raw_data["outcomes"][index]["confidence"]
       end
 
       ## Returns the intent that this message corresponded to.
       ##
       ## @return [String] intent name that this message corrsponded to.
-      def intent
-        outcome["intent"]
+      def intent(index=0)
+        self.raw_data["outcomes"][index]["intent"]
+      end
+
+      ## Returns the entities that this message corresponded to.
+      ##
+      ## @return Hash of entities that this message corrsponded to.
+      def entities(index=0)
+        self.raw_data["outcomes"][index]["entities"]
       end
 
       ## Generates Array of the names of each entity in this message.
       ##
       ## @return [Array] names of each entity
-      def entity_names
+      def entity_names(index=0)
         entity_arr = Array.new
-        outcome["entities"].each_key do |key|
+        self.raw_data["outcomes"][index]["entities"].each_key do |key|
           entity_arr << key
         end
         return entity_arr
@@ -40,8 +47,8 @@ module Wit
       ## @param possible_key [Symbol] possible method or key in the hash or entity.
       ## @return [Class] depending on the given results in the data.
       def method_missing(possible_key, *args, &block)
-        if @rawdata["outcome"]["entities"].has_key?(possible_key.to_s)
-          entity_value = @rawdata["outcome"]["entities"][possible_key.to_s]
+        if @rawdata["outcomes"][0]["entities"].has_key?(possible_key.to_s)
+          entity_value = @rawdata["outcomes"][0]["entities"][possible_key.to_s]
           entity_value.class == Hash ? Entity.new(entity_value) : EntityArray.new(entity_value)
         else
           super

data/lib/wit_ruby/rest/result.rb

@@ -104,7 +104,7 @@ module Wit
       ## @return [Array] entities in this current result object.
       def setup_entities
         ## Get the current entities hash
-        entities_raw = @rawdata["entities"] || @rawdata["outcome"]["entities"]
+        entities_raw = @rawdata["entities"] || @rawdata["outcomes"]["entities"]
         ## Set the intance variable to be an array containing these entities.
         ## If its empty, then set the instance variable to nil
         unless entities_raw.empty?

data/lib/wit_ruby/rest/session.rb

@@ -25,6 +25,8 @@ module Wit
         if length <= 0 || length > 256
           raise NotCorrectSchema.new("The given message, \"#{message}\" is either too short or too long. Message length needs to be between 0 and 256.")
         end
+        # Replace spaces with "%20" for usage in URL
+        message.gsub!(" ", "%20")
         ## Recieve unwrapped results
         results = @client.get("/message?q=#{message}")
         return return_with_class(Wit::REST::Message, results)
@@ -61,7 +63,6 @@ module Wit
       ## @todo Notify Wit.ai as there documentation does not include the stats parameter
       def get_message(message_id)
         results = @client.get("/messages/#{message_id}")
-
         return return_with_class(Wit::REST::Message, results)
       end
 

data/lib/wit_ruby/version.rb

@@ -1,3 +1,3 @@
 module Wit
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/spec_helper.rb

@@ -11,19 +11,31 @@ require 'timeout'
 
 #VCR config
 VCR.configure do |c|
-  c.cassette_library_dir = 'spec/fixtures/wit_cassettes'
-  c.hook_into :webmock
-  allow_next_request_at = nil
-  filters = [:real?, lambda { |r| URI(r.uri).host == 'api.wit.ai' }]
 
-  c.after_http_request(*filters) do |request, response|
-    allow_next_request_at = Time.now + 1
-  end
+  ## Used to see if were in the Travis CI environment.
+  ## Kinda dirty as were expecting ENV["TRAVIS"] is not declared.
+  ## We could use ENV["TRAVIS_WIT_TOKEN"], but that is the same dirtiness as
+  ## we assume one does not have it.
+  ## If it is the Travis CI environment, turn off VCR entirely and ignore cassettes.
+
+  if ENV["TRAVIS"] == true
+    puts("[WitRuby] Currently in Travis CI environment, VCR turned off.")
+    VCR.turn_off!(:ignore_cassettes => true)
+  else
+    puts("[WitRuby] Not in Travis CI environment, VCR on and recording cassettes.")
+    c.cassette_library_dir = 'spec/fixtures/wit_cassettes'
+    c.hook_into :webmock
+    allow_next_request_at = nil
+    filters = [:real?, lambda { |r| URI(r.uri).host == 'api.wit.ai' }]
 
-  c.before_http_request(*filters) do |request|
-    if allow_next_request_at && Time.now < allow_next_request_at
-      sleep(allow_next_request_at - Time.now)
+    c.after_http_request(*filters) do |request, response|
+      allow_next_request_at = Time.now + 1
     end
-  end
 
+    c.before_http_request(*filters) do |request|
+      if allow_next_request_at && Time.now < allow_next_request_at
+        sleep(allow_next_request_at - Time.now)
+      end
+    end
+  end
 end

data/spec/wit_ruby/rest/client_spec.rb

@@ -23,7 +23,7 @@ describe Wit::REST::Client do
     @client = Wit::REST::Client.new(token: rand_auth)
     @conn = @client.instance_variable_get("@conn")
     expect(@conn.address).to  eql("api.wit.ai")
-    expect(@conn.use_ssl?).to be_true
+    expect(@conn.use_ssl?).to be_truthy
 
   end
 
@@ -41,7 +41,7 @@ describe Wit::REST::Client do
     @conn = @client.instance_variable_get("@conn")
     expect(@conn.address).to eql(new_host)
     expect(@conn.port).to eql(new_port)
-    expect(@conn.proxy?).to be_true
+    expect(@conn.proxy?).to be_truthy
     expect(@conn.proxy_address).to eql(new_proxy)
     expect(@conn.proxy_port).to eql(new_proxy_port)
     expect(@conn.open_timeout).to eql(new_timeout)
@@ -52,7 +52,7 @@ describe Wit::REST::Client do
 
   it "should setup a session parameter to properly wrap API with commands" do
     @client = Wit::REST::Client.new(token: rand_auth)
-    expect(@client.instance_variable_get("@session")).to be_true
+    expect(@client.instance_variable_get("@session")).to be_truthy
   end
 
 

data/spec/wit_ruby/rest/message_spec.rb

@@ -5,37 +5,35 @@
 require 'spec_helper'
 
 describe Wit::REST::Message do
-  let(:json) {%({
-  "msg_id": "ba0fcf60-44d3-4499-877e-c8d65c239730",
-  "msg_body": "how many people between Tuesday and Friday",
-  "outcome": {
-    "intent": "query_metrics",
-    "entities": {
-      "metric": {
-        "value": "metric_visitors",
-        "body": "people",
-        "metadata": "{'code' : 324}"
+  let(:json) {%(
+
+  {
+    "msg_id" : "c20ad081-2cb9-4c63-8dd6-6667409514fa",
+    "outcomes" : [ {
+      "_text" : "how many people between Tuesday and Friday",
+      "intent" : "query_metrics",
+      "entities" : {
+        "metric" : [ {
+          "metadata" : "{'code' : 324}",
+          "value" : "metric_visitor"
+        } ],
+        "datetime" : [ {
+          "value" : {
+            "from" : "2014-06-24T00:00:00.000+02:00",
+            "to" : "2014-06-25T00:00:00.000+02:00"
+          }
+        }, {
+          "value" : {
+            "from" : "2014-06-27T00:00:00.000+02:00",
+            "to" : "2014-06-28T00:00:00.000+02:00"
+          }
+        } ]
       },
-      "datetime": [
-        {
-          "value": {
-            "from": "2013-10-21T00:00:00.000Z",
-            "to": "2013-10-22T00:00:00.000Z"
-          },
-          "body": "Tuesday"
-        },
-        {
-          "value": {
-            "from": "2013-10-24T00:00:00.000Z",
-            "to": "2013-10-25T00:00:00.000Z"
-          },
-          "body": "Friday"
-        }
-      ]
-    },
-    "confidence": 0.979
+      "confidence" : 0.986
+    } ]
   }
-  })}
+
+  )}
   let(:rand_path) {"rand_path"}
   let(:rand_body) {"rand_body"}
   let(:rest_code) {"get"}
@@ -43,15 +41,15 @@ describe Wit::REST::Message do
 
 
   it "should have the following parameters, confidence and intent and entities" do
-    expect(message_results.confidence).to eql(0.979)
+    expect(message_results.confidence).to eql(0.986)
     expect(message_results.intent).to eql("query_metrics")
-    expect(message_results.metric.class).to eql(Wit::REST::Entity)
+    expect(message_results.metric.class).to eql(Wit::REST::EntityArray)
     expect(message_results.datetime.class).to eql(Wit::REST::EntityArray)
   end
 
   it "should have the right values in the entities" do
-    expect(message_results.metric.value).to eql("metric_visitors")
-    expect(message_results.datetime[0].body).to eql("Tuesday")
+    expect(message_results.metric[0].value).to eql("metric_visitor")
+    expect(message_results.datetime[0].value["from"]).to eql("2014-06-24T00:00:00.000+02:00")
   end
 
   it "should be able to return back an array of strings of the names of each entity" do

data/spec/wit_ruby/rest/result_spec.rb

@@ -38,14 +38,14 @@ describe Wit::REST::Result do
   end
 
   it "should be refereshable if rest parameters and path/body are given and not if it isn't given" do
-    expect(result.refreshable?).to be_true
-    expect(not_refresh_result.refreshable?).to be_false
+    expect(result.refreshable?).to be_truthy
+    expect(not_refresh_result.refreshable?).to be_falsey
   end
 
   it "should have an empty method to check if the data is empty and return true if it is" do
-    expect(result.empty?).to be_false
-    expect(empty_hash.empty?).to be_true
-    expect(empty_array.empty?).to be_true
+    expect(result.empty?).to be_falsey
+    expect(empty_hash.empty?).to be_truthy
+    expect(empty_array.empty?).to be_truthy
   end
 
 end

data/spec/wit_ruby/rest/session_spec.rb

@@ -181,7 +181,7 @@ describe Wit::REST::Session do
 
       it "should get back the same message and have the same has as the sent message results" do
         expect(@resulting_message.msg_id).to eql(sent_message_id)
-        expect(@resulting_message.msg_body).to eql(sent_message_result.msg_body)
+        expect(@resulting_message.outcomes[0]["_text"]).to eql(sent_message_result.outcomes[0]["_text"])
       end
     end
   end

data/wit_ruby.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
   spec.add_development_dependency "rspec-nc"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wit_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Gavin Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +202,8 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
+- CONTRIBUTORS.md
 - Gemfile
 - Guardfile
 - LICENSE.txt

data/CHANGELOG

@@ -1,32 +0,0 @@
-== 1.0.1
-* Added fix to raise an error if a sent message has a length that is not between 0 to 256.
-
-== 1.0.0
-* Yay! 1.0.0 for no reason! (Kinda.)
-* Added error checking to make sure input parameters to the session are correct.
-* Changed adding expression to not use the given BodyJson and instead, requires the use of just the name of the entity, value, and new expression.
-
-== 0.0.3
-* Implemented getting array of entities from instance (GET).
-* Implemented getting a specific entity from its name/id (GET).
-* Implemented creation of entities (POST).
-* Implemented the ability to update entities given the ID (PUT).
-* Implemented deletion of entities (DELETE).
-* Implemented addition of values (POST).
-* Implemented deletion of values (DELETE).
-* Implemented addition of expressions (POST).
-* Implemented deletion of expressions (DELETE).
-* Changed required Ruby version from 1.8.7 to 1.9.3
-* Added new class definition for post / put calls assistance. Helps with JSON generation.
-
-== 0.0.2
-* Implemented API call to get specific information from a sent message from it's given ID (GET).
-* Intent specific API calls functional (GET).
-* Changed description in gemspec.
-* Change results to be returned as specific objects that inherit from the original class Result.
-  Message, Intent, Entity, Expression are the specific wrappers for results.
-* Made error check so that only specific results can be refreshed. Refreshable objects are ones that
-  are directly returned from session calls.
-
-== 0.0.1
-* Implemented connection with wit.ai API and sending a text message (GET).