att_speech 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,7 @@
 # att_speech
 
+![Build Status](https://secure.travis-ci.org/jsgoecke/att_speech.png)
+
 A Ruby library for consuming the AT&T [Speech API](https://developer.att.com/developer/apiDetailPage.jsp?passedItemId=10700023) for speech to text. API details may be found [here](http://developer.att.com/developer/apiDetailPage.jsp?passedItemId=10900039).
 
 ## Installation
@@ -18,7 +20,7 @@ secret_key = 'bar'
 
 att_speech = ATTSpeech.new(api_key, secret_key)
 
-# Block operation
+# Blocking operation
 p att_speech.speech_to_text('bostonSeltics.wav', type='audio/wav')
 #<Hashie::Mash recognition=#<Hashie::Mash n_best=#<Hashie::Mash confidence=1 grade="accept" hypothesis="Boston celtics." language_id="en-us" result_text="Boston celtics." word_scores=[1, 1] words=["Boston", "celtics."]> response_id="452d848c6d1a4be3f2bc987e5201ae38">>
 
@@ -26,6 +28,13 @@ p att_speech.speech_to_text('bostonSeltics.wav', type='audio/wav')
 future = att_speech.future(:speech_to_text, 'bostinSeltics.wav', type='audio/wav')
 p future.value
 #<Hashie::Mash recognition=#<Hashie::Mash n_best=#<Hashie::Mash confidence=1 grade="accept" hypothesis="Boston celtics." language_id="en-us" result_text="Boston celtics." word_scores=[1, 1] words=["Boston", "celtics."]> response_id="452d848c6d1a4be3f2bc987e5201ae38">>
+
+# Non-blocking operation that will call a block when the transcrption is returned
+# Note: Remember, this is a concurrent operation so don't pass self and avoid mutable objects in the block 
+# from the calling context, better to have discreet actions contained in the block, such as inserting in a 
+# datastore or POSTing to a REST webservice as a callback
+att_speech.speech_to_text!('spec/spec_helper.rb') { |transcription| p transcription }
+#<Hashie::Mash recognition=#<Hashie::Mash n_best=#<Hashie::Mash confidence=1 grade="accept" hypothesis="Boston celtics." language_id="en-us" result_text="Boston celtics." word_scores=[1, 1] words=["Boston", "celtics."]> response_id="452d848c6d1a4be3f2bc987e5201ae38">>
 ```
 
 ## Copyright

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/att_speech/att_speech.rb

@@ -13,6 +13,7 @@ class ATTSpeech
 	#
 	# @return [Object] an instance of ATTSpeech
 	def initialize(api_key, secret_key, base_url='https://api.att.com')
+		@signaled      = false
 		@api_key 		   = api_key
 		@secret_key    = secret_key
 		@base_url      = base_url
@@ -32,9 +33,10 @@ class ATTSpeech
 	# @param [String] file_contents to be processed
 	# @param [String] type of file to be processed, may be audio/wav, application/octet-stream or audio/amr
 	# @param [String] speech_context to use to evaluate the audio Generic, UVerseEPG, BusinessSearch, Websearch, SMS, Voicemail,  QuestionAndAnswer
+	# @param [Block] block to be called when the transcription completes
 	#
 	# @return [Hash] the resulting response from the AT&T Speech API
-	def speech_to_text(file_contents, type='audio/wav', speech_context='Generic')
+	def speech_to_text(file_contents, type='audio/wav', speech_context='Generic', &block)
 		resource = "/rest/1/SpeechToText"
 		
 		if type == "application/octet-stream"
@@ -49,14 +51,16 @@ class ATTSpeech
 									                          :Content_Type              => type, 
 									                          :Accept                    => 'application/json'
 									                          
-			process_response(response)
+			result = process_response(response)
+			block.call result if block_given?
+			result
 		rescue => e
 			raise RuntimeError, e.to_s
 		end
 	end
 	
 	private
-	
+		
 	##
 	# Creates the Faraday connection object
 	def create_connection

data/lib/att_speech/version.rb

@@ -1,3 +1,3 @@
 class ATTSpeech
-	VERSION = "0.0.1"
+	VERSION = "0.0.2"
 end

data/spec/att_speech_spec.rb

@@ -42,10 +42,20 @@ describe "AttSpeech" do
       future.instance_of?(Celluloid::Future).should eql true
     end
       
-    it "should allow us to user a future to process an audio file" do
+    it "should allow us to use a future to process an audio file" do
       future = att_speech.future(:speech_to_text, 'spec/spec_helper.rb')
       future.value[:recognition][:response_id].should eql '2b0bdcf4301f5c4aba57e2765b59bcbe'
       future.value[:recognition][:n_best][:confidence].should eql 1
     end
   end
+  
+  describe 'non-blocking call with a block' do
+    it "should allow us to use a future to process an audio file and pass a block" do
+      result = nil
+      att_speech.speech_to_text!('spec/spec_helper.rb') { |transcription| result = transcription }
+      sleep 0.5
+      result[:recognition][:response_id].should eql '2b0bdcf4301f5c4aba57e2765b59bcbe'
+      result[:recognition][:n_best][:confidence].should eql 1
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: att_speech
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: