att_speech 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.2
+    - 1.9.3
+# script: bundle exec rspec spec

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 gem "faraday", ">= 0.8.1"
-gem "celluloid", ">= 0.11.1"
-gem "hashie", ">=1.2.0"
+gem "celluloid", ">= 0.11.1", "< 0.14.0"
+gem "hashie", ">= 1.2.0"
 gem "activesupport"
 
 group :development do

data/Gemfile.lock

@@ -0,0 +1,58 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    celluloid (0.13.0)
+      timers (>= 1.0.0)
+    diff-lcs (1.2.4)
+    fakeweb (1.3.0)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    hashie (2.0.4)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    json (1.7.7-java)
+    multi_json (1.7.3)
+    multipart-post (1.2.0)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    timers (1.1.0)
+    yard (0.8.6.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (>= 1.0.0)
+  celluloid (>= 0.11.1, < 0.14.0)
+  fakeweb
+  faraday (>= 0.8.1)
+  hashie (>= 1.2.0)
+  jeweler (>= 1.8.4)
+  rdoc (>= 3.12)
+  rspec (>= 2.8.0)
+  simplecov
+  yard (>= 0.7)

data/README.md

@@ -2,7 +2,7 @@
 
 ![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).
+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](https://developer.att.com/developer/basicTemplate.jsp?passedItemId=13100102&api=Speech&version=3).
 
 ## Installation
 
@@ -15,8 +15,9 @@ gem install att_speech
 ```ruby
 require 'att_speech'
 
-att_speech = ATTSpeech.new({ :api_key    => ENV['ATT_SPEECH_KEY'], 
-                             :secret_key => ENV['ATT_SPEECH_SECRET'] })
+att_speech = ATTSpeech.new({ :api_key    => ENV['ATT_SPEECH_KEY'],
+                             :secret_key => ENV['ATT_SPEECH_SECRET'],
+                             :scope      => 'SPEECH' }) })
 
 # Read the audio file contents
 file_contents = File.read(File.expand_path(File.dirname(File.dirname(__FILE__))) + "/bostonSeltics.wav")
@@ -30,15 +31,39 @@ future = att_speech.future(:speech_to_text, file_contents, type='audio/wav')
 p future.value
 
 # 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 
+# 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
 sleep 2
 att_speech.speech_to_text!(file_contents) { |transcription| p transcription }
 sleep 5
+
+
+def write_wav_file(audio_bytes)
+  file_name = "ret_audio-#{Time.now.strftime('%Y%m%d-%H%M%S')}.wav"
+  full_file_name = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'examples', file_name))
+  audio_file = File.open(full_file_name, "w")
+  audio_file << audio_bytes
+  audio_file.close
+end
+
+att_text = ATTSpeech.new({ :api_key    => ENV['ATT_SPEECH_KEY'],
+                           :secret_key => ENV['ATT_SPEECH_SECRET'],
+                           :scope      => 'TTS' })
+
+# Read the text file contents
+tfp = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'examples', 'helloWorld.txt'))
+txt_contents = File.read(tfp)
+
+audio = att_text.text_to_speech(txt_contents)
+write_wav_file(audio)
+
+# Non-blocking operation with a future, if you have a longer file that requires more processing time
+sleep 2
+future = att_text.future(:text_to_speech, "This is a hello world.", type='text/plain')
+write_wav_file(future.value)
 ```
 
 ## Copyright
 
-Copyright (c) 2012 Jason Goecke. See LICENSE.txt for further details.
-
+Copyright (c) 2013 Jason Goecke. See LICENSE.txt for further details.

data/Rakefile

@@ -17,10 +17,10 @@ Jeweler::Tasks.new do |gem|
   gem.name = "att_speech"
   gem.homepage = "http://github.com/jsgoecke/att_speech"
   gem.license = "MIT"
-  gem.summary = %Q{TODO: one-line summary of your gem}
-  gem.description = %Q{TODO: longer description of your gem}
+  gem.summary = %Q{A Ruby library for consuming the AT&T Speech API https://developer.att.com/developer/forward.jsp?passedItemId=12500023 for speech->text, and text->speech.}
+  gem.description = %Q{A Ruby library for consuming v3 of the AT&T Speech API for speech->text, and text->speech. Takes in either .wav or specific other audio files, and returns a text string of the spoken words. Can also take in either a text string or .txt file and returns a string of bytes from which a .wav file can be created of the spoken text.}
   gem.email = "jason@goecke.net"
-  gem.authors = ["Jason Goecke"]
+  gem.authors = ["Jason Goecke, Peter Wilson"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/att_speech.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "att_speech"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Goecke, Peter Wilson"]
+  s.date = "2013-05-09"
+  s.description = "A Ruby library for consuming v3 of the AT&T Speech API for speech->text, and text->speech. Takes in either .wav or specific other audio files, and returns a text string of the spoken words. Can also take in either a text string or .txt file and returns a string of bytes from which a .wav file can be created of the spoken text."
+  s.email = "jason@goecke.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "att_speech.gemspec",
+    "examples/bostonSeltics.wav",
+    "examples/example.rb",
+    "examples/helloWorld.txt",
+    "lib/att_speech.rb",
+    "lib/att_speech/att_speech.rb",
+    "lib/att_speech/version.rb",
+    "spec/att_speech_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/jsgoecke/att_speech"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A Ruby library for consuming the AT&T Speech API https://developer.att.com/developer/forward.jsp?passedItemId=12500023 for speech->text, and text->speech."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>, [">= 0.8.1"])
+      s.add_runtime_dependency(%q<celluloid>, ["< 0.14.0", ">= 0.11.1"])
+      s.add_runtime_dependency(%q<hashie>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.7"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0.8.1"])
+      s.add_dependency(%q<celluloid>, ["< 0.14.0", ">= 0.11.1"])
+      s.add_dependency(%q<hashie>, [">= 1.2.0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_dependency(%q<yard>, [">= 0.7"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0.8.1"])
+    s.add_dependency(%q<celluloid>, ["< 0.14.0", ">= 0.11.1"])
+    s.add_dependency(%q<hashie>, [">= 1.2.0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.8.0"])
+    s.add_dependency(%q<yard>, [">= 0.7"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end
+

data/examples/example.rb

@@ -0,0 +1,53 @@
+$LOAD_PATH << './lib'
+
+lp = File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'att_speech.rb')
+require lp
+
+att_speech = ATTSpeech.new({ :api_key    => ENV['ATT_SPEECH_KEY'],
+                             :secret_key => ENV['ATT_SPEECH_SECRET'],
+                             :scope      => 'SPEECH' })
+
+# Read the audio file contents
+fp = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'examples', 'bostonSeltics.wav'))
+file_contents = File.read(fp)
+
+# Blocking operation
+p att_speech.speech_to_text(file_contents, type='audio/wav')
+
+# Non-blocking operation with a future, if you have a longer file that requires more processing time
+sleep 2
+future = att_speech.future(:speech_to_text, file_contents, type='audio/wav')
+p future.value
+
+# 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
+sleep 2
+att_speech.speech_to_text!(file_contents) { |transcription| p transcription }
+sleep 5
+
+
+def write_wav_file(audio_bytes)
+  file_name = "ret_audio-#{Time.now.strftime('%Y%m%d-%H%M%S')}.wav"
+  full_file_name = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'examples', file_name))
+  audio_file = File.open(full_file_name, "w")
+  audio_file << audio_bytes
+  audio_file.close
+end
+
+att_text = ATTSpeech.new({ :api_key    => ENV['ATT_SPEECH_KEY'],
+                           :secret_key => ENV['ATT_SPEECH_SECRET'],
+                           :scope      => 'TTS' })
+
+# Read the text file contents
+tfp = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'examples', 'helloWorld.txt'))
+txt_contents = File.read(tfp)
+
+audio = att_text.text_to_speech(txt_contents)
+write_wav_file(audio)
+
+# Non-blocking operation with a future, if you have a longer file that requires more processing time
+sleep 2
+future = att_text.future(:text_to_speech, "This is a hello world.", type='text/plain')
+write_wav_file(future.value)

data/examples/helloWorld.txt

@@ -0,0 +1 @@
+Hello World!

data/lib/att_speech/att_speech.rb

@@ -1,157 +1,192 @@
 class ATTSpeech
-	include Celluloid
-	Celluloid.logger = nil
-	
-	attr_reader :api_key, :secret_key, :access_token, :refresh_token, :base_url, :ssl_verify
-	
-	##
-	# Creates an ATTSpeech object
-	#
-	# @overload initialize(args)
-	#   @param [Hash] args the options to intantiate with
-	#   @option args [String] :api_key the AT&T Speech API Key
-	#   @option args [String] :secret_key the AT&T Speech API Secret Key
-	#   @option args [String] :base_url the url for the AT&T Speech API, default is 'https://api.att.com'
-	#   @option args [Boolean] :ssl_verify determines if the peer Cert is verified for SSL, default is true
-	# @overload initialize(api_key, secret_key, base_url='https://api.att.com')
-	#   @param [String] api_key the AT&T Speech API Key
-	#   @param [String] secret_key the AT&T Speech API Secret Key
-	#   @param [String] base_url, the url for the AT&T Speech API, default is 'https://api.att.com'
-	#   @param [Boolean] ssl_verify determines if the peer Cert is verified for SSL, default is true
-	#
-	# @return [Object] an instance of ATTSpeech
-	def initialize(*args)
-		raise ArgumentError, "Requres at least the api_key and secret_key when instatiating" if args.size == 0
-		
-		base_url   = 'https://api.att.com'
-		
-		if args.size == 1 && args[0].instance_of?(Hash)
-			@api_key    = args[0][:api_key]
-			@secret_key = args[0][:secret_key]
-			@base_url   = args[0][:base_url]   || base_url
-			set_ssl_verify args[0][:ssl_verify]
-		else
-			@api_key 		= args[0]
-			@secret_key = args[1]
-			@base_url   = args[2] || base_url
-			set_ssl_verify args[3]
-		end			
-		
-		@grant_type    = 'client_credentials'
-		@scope         = 'SPEECH'
-		@access_token  = ''
-		@refresh_token = ''
-		
-		create_connection
-		get_tokens
-		
-		self
-	end
-	
-	##
-	# Allows you to send a file and return the speech to text result
-	# @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', &block)
-		resource = "/rest/1/SpeechToText"
-		
-		if type == "application/octet-stream"
-			type = "audio/amr"
-		end
-		
-		begin
-			response = @connection.post resource, file_contents, 
-						 			                          :Authorization             => "Bearer #{@access_token}", 
-									                          :Content_Transfer_Encoding => 'chunked', 
-									                          :X_SpeechContext           => speech_context, 
-									                          :Content_Type              => type, 
-									                          :Accept                    => 'application/json'
-									                          
-			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
-		@connection = Faraday.new(:url => @base_url, :ssl => { :verify => @ssl_verify }) do |faraday|
-			faraday.headers['Accept'] = 'application/json'
-			faraday.adapter           Faraday.default_adapter
-		end
-	end
-	
-	##
-	# Obtains the session tokens
-	def get_tokens
-		resource = "/oauth/access_token"
-		
-		begin
-			response = @connection.post resource do |request|
-				request.params['client_id']     = @api_key
-				request.params['client_secret'] = @secret_key
-				request.params['grant_type']    = @grant_type
-				request.params['scope']         = @scope
-			end
-			
-			result = process_response(response)
-			
-			if result[:access_token].nil? || result[:refresh_token].nil?
-				raise RuntimeError, "Unable to complete oauth: #{response[:error]}"
-			else                
-				@access_token  = result[:access_token]
-				@refresh_token = result[:refresh_token]
-			end
-		rescue => e
-			raise RuntimeError, e.to_s
-		end
-	end
-	
-	##
-	# Process the JSON returned into a Hashie::Mash and making it more Ruby friendly
-	# 
-	# @param [String] reponse json
-	#
-	# @return [Object] a Hashie::Mash object
-	def process_response(response)
-		Hashie::Mash.new(underscore_hash(JSON.parse(response.body)))
-	end
-	
-	##
-	# Sets the ssl_verify option
-	#
-	# @param [Boolean] ssl_verify the variable to set
-	def set_ssl_verify(ssl_verify)
-		if ssl_verify == false
-			@ssl_verify =  false
-		else
-			@ssl_verify = true
-		end
-	end
-	
-	##
-	# Decamelizes the keys in a hash to be more Ruby friendly
-	#
-	# @param [Hash] hash to be decamelized
-	# 
-	# @return [Hash] the hash with the keys decamalized
-	def underscore_hash(hash)
-		hash.inject({}) do |underscored, (key, value)|
-			value = underscore_hash(value) if value.is_a?(Hash)
-			if value.is_a?(Array)
-				value = underscore_hash(value[0]) if value[0].is_a?(Hash)
-			end
-			underscored[key.underscore] = value
-			underscored
-		end
-	end
-end
+  include Celluloid
+  Celluloid.logger = nil
+
+  attr_reader :api_key, :secret_key, :access_token, :refresh_token, :base_url, :ssl_verify, :scope
+
+  ##
+  # Creates an ATTSpeech object
+  #
+  # @overload initialize(args)
+  #   @param [Hash] args the options to intantiate with
+  #   @option args [String] :api_key the AT&T Speech API Key
+  #   @option args [String] :secret_key the AT&T Speech API Secret Key
+  #   @option args [String] :scope the Authorization Scope for the AT&T Speech API
+  #   @option args [String] :base_url the url for the AT&T Speech API, default is 'https://api.att.com'
+  #   @option args [Boolean] :ssl_verify determines if the peer Cert is verified for SSL, default is true
+  # @overload initialize(api_key, secret_key, base_url='https://api.att.com')
+  #   @param [String] api_key the AT&T Speech API Key
+  #   @param [String] secret_key the AT&T Speech API Secret Key
+  #   @param [String] scope the Authorization Scope for the AT&T Speech API
+  #   @param [String] base_url the url for the AT&T Speech API, default is 'https://api.att.com'
+  #   @param [Boolean] ssl_verify determines if the peer Cert is verified for SSL, default is true
+  #
+  # @return [Object] an instance of ATTSpeech
+  def initialize(*args)
+    raise ArgumentError, "Requires at least the api_key, secret_key, and scope when instatiating" if args.size == 0
+
+    base_url   = 'https://api.att.com'
+
+    if args.size == 1 && args[0].instance_of?(Hash)
+      @api_key    = args[0][:api_key]
+      @secret_key = args[0][:secret_key]
+      @scope      = args[0][:scope]
+      @base_url   = args[0][:base_url]   || base_url
+      set_ssl_verify args[0][:ssl_verify]
+    else
+      @api_key    = args[0]
+      @secret_key = args[1]
+      @scope      = args[2]
+      @base_url   = args[3] || base_url
+      set_ssl_verify args[4]
+    end
+
+    raise ArgumentError, "scope must be either 'SPEECH' or 'TTS'" unless (@scope == 'SPEECH') || (@scope == 'TTS')
+
+    @grant_type    = 'client_credentials'
+    @access_token  = ''
+    @refresh_token = ''
+
+    if @scope == 'SPEECH'
+      create_connection 'application/json'
+    else
+      create_connection 'audio/x-wav'
+    end
+
+    get_tokens
+
+    Actor.current
+  end
+
+  ##
+  # Allows you to send a file and return the speech to text result
+  # @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 BusinessSearch, Gaming, Generic, QuestionAndAnswer, SMS, SocialMedia, TV, VoiceMail, WebSearch
+  # @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', &block)
+    resource = "/speech/v3/speechToText"
+
+    if type == "application/octet-stream"
+      type = "audio/amr"
+    end
+
+    begin
+      response = @connection.post( resource,
+                                   file_contents,
+                                   :Authorization             => "Bearer #{@access_token}",
+                                   :Content_Transfer_Encoding => 'chunked',
+                                   :X_SpeechContext           => speech_context,
+                                   :Content_Type              => type,
+                                   :Accept                    => 'application/json' )
+
+      result = process_response(response)
+      block.call result if block_given?
+      result
+    rescue => e
+      raise RuntimeError, e.to_s
+    end
+  end
+
+
+  ##
+  # Allows you to send a string or plain text file and return the text to speech result
+  # @param [String] string or file_contents to be processed
+  # @param [String] type of file or object to be processed, may be text/plain, or application/ssml+xml
+  #
+  # @return [String] the bytes of the resulting response from the AT&T Speech API
+  def text_to_speech(file_contents, type='text/plain')
+    resource = "/speech/v3/textToSpeech"
+
+    begin
+      response = @connection.post( resource,
+                                   file_contents,
+                                   :Authorization => "Bearer #{@access_token}",
+                                   :Content_Type  => type,
+                                   :Accept        => 'audio/x-wav' )
+
+      response.body
+    rescue => e
+      raise RuntimeError, e.to_s
+    end
+  end
+
+
+  private
+
+  ##
+  # Creates the Faraday connection object
+  def create_connection(accept_type='application/json')
+    @connection = Faraday.new(:url => @base_url, :ssl => { :verify => @ssl_verify }) do |faraday|
+      faraday.headers['Accept'] = accept_type
+      faraday.adapter           Faraday.default_adapter
+    end
+  end
+
+  ##
+  # Obtains the session tokens
+  def get_tokens
+    resource = "/oauth/access_token"
+
+    begin
+      response = @connection.post resource do |request|
+        request.params['client_id']     = @api_key
+        request.params['client_secret'] = @secret_key
+        request.params['grant_type']    = @grant_type
+        request.params['scope']         = @scope
+      end
+
+      result = process_response(response)
+
+      if result[:access_token].nil? || result[:refresh_token].nil?
+        raise RuntimeError, "Unable to complete oauth: #{response[:error]}"
+      else
+        @access_token  = result[:access_token]
+        @refresh_token = result[:refresh_token]
+      end
+    rescue => e
+      raise RuntimeError, e.to_s
+    end
+  end
+
+  ##
+  # Process the JSON returned into a Hashie::Mash and making it more Ruby friendly
+  #
+  # @param [String] reponse json
+  #
+  # @return [Object] a Hashie::Mash object
+  def process_response(response)
+    Hashie::Mash.new(underscore_hash(JSON.parse(response.body)))
+  end
+
+  ##
+  # Sets the ssl_verify option
+  #
+  # @param [Boolean] ssl_verify the variable to set
+  def set_ssl_verify(ssl_verify)
+    if ssl_verify == false
+      @ssl_verify =  false
+    else
+      @ssl_verify = true
+    end
+  end
+
+  ##
+  # Decamelizes the keys in a hash to be more Ruby friendly
+  #
+  # @param [Hash] hash to be decamelized
+  #
+  # @return [Hash] the hash with the keys decamalized
+  def underscore_hash(hash)
+    hash.inject({}) do |underscored, (key, value)|
+      value = underscore_hash(value) if value.is_a?(Hash)
+      if value.is_a?(Array)
+        value = underscore_hash(value[0]) if value[0].is_a?(Hash)
+      end
+      underscored[key.underscore] = value
+      underscored
+    end
+  end
+end

data/lib/att_speech/version.rb

@@ -1,3 +1,3 @@
 class ATTSpeech
-	VERSION = "0.0.3"
-end
+  VERSION = "0.0.4"
+end

data/spec/att_speech_spec.rb

@@ -2,106 +2,125 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "AttSpeech" do
   FakeWeb.allow_net_connect = false
-  
-  FakeWeb.register_uri(:post, 
-                       "https://api.att.com/oauth/access_token?client_id=1234&client_secret=abcd&grant_type=client_credentials&scope=SPEECH", 
-                       :status => ['200', 'OK'], 
+
+  FakeWeb.register_uri(:post,
+                       "https://api.att.com/oauth/access_token?client_id=1234&client_secret=abcd&grant_type=client_credentials&scope=SPEECH",
+                       :status => ['200', 'OK'],
                        :body   => '{"access_token":"5678","refresh_token":"wxyz"}')
-  
-  FakeWeb.register_uri(:post, 
-                       "http://foobar.com/oauth/access_token?client_id=1234&client_secret=abcd&grant_type=client_credentials&scope=SPEECH", 
-                       :status => ['200', 'OK'], 
+
+  FakeWeb.register_uri(:post,
+                       "http://foobar.com/oauth/access_token?client_id=1234&client_secret=abcd&grant_type=client_credentials&scope=SPEECH",
+                       :status => ['200', 'OK'],
                        :body   => '{"access_token":"5678","refresh_token":"wxyz"}')
-  
-  FakeWeb.register_uri(:post, 
-                       "https://api.att.com/rest/1/SpeechToText", 
-                       :status => ['200', 'OK'], 
+
+  FakeWeb.register_uri(:post,
+                       "https://api.att.com/speech/v3/speechToText",
+                       :status => ['200', 'OK'],
                        :body   => "{\"Recognition\":{\"ResponseId\":\"2b0bdcf4301f5c4aba57e2765b59bcbe\",\"NBest\":[{\"WordScores\":[1,1],\"Confidence\":1,\"Grade\":\"accept\",\"ResultText\":\"Boston celtics.\",\"Words\":[\"Boston\",\"celtics.\"],\"LanguageId\":\"en-us\",\"Hypothesis\":\"Boston celtics.\"}]}}")
-  
-  let(:att_speech)      { att_speech = ATTSpeech.new '1234', 'abcd' }
+
+  let(:att_speech)      { att_speech = ATTSpeech.new('1234', 'abcd', 'SPEECH') }
   let(:att_speech_hash) { att_speech = ATTSpeech.new({ :api_key    => '1234',
-                                                       :secret_key => 'abcd' })}
-  
+                                                       :secret_key => 'abcd',
+                                                       :scope      => 'SPEECH' })}
+
+
   describe 'initializing' do
     it "should raise an error of no parameters passed when creating object" do
       begin
         ATTSpeech.new
       rescue => e
-        e.to_s.should eql "Requres at least the api_key and secret_key when instatiating"
+        e.to_s.should eql "Requires at least the api_key, secret_key, and scope when instatiating"
+      end
+    end
+
+    it "shoud raise an error of wrong scope when creating object without scope" do
+      begin
+        ATTSpeech.new('1234', 'abcd')
+      rescue => e
+        e.to_s.should eql "scope must be either 'SPEECH' or 'TTS'"
+      end
+    end
+
+    it "shoud raise an error of wrong scope when creating object with misspelled scope" do
+      begin
+        ATTSpeech.new('1234', 'abcd', 'misspelled scope')
+      rescue => e
+        e.to_s.should eql "scope must be either 'SPEECH' or 'TTS'"
       end
     end
-    
+
     it "should create an ATTSpeech object" do
       att_speech.class.should eql ATTSpeech
       att_speech_hash.class.should eql ATTSpeech
     end
-    
+
     it 'should set the url to something different' do
-      as = ATTSpeech.new('1234', 'abcd', 'http://foobar.com', false)
+      as = ATTSpeech.new('1234', 'abcd', 'SPEECH', 'http://foobar.com', false)
       as.base_url.should   == 'http://foobar.com'
       as.ssl_verify.should == false
-      
+
       as = ATTSpeech.new({ :api_key    => '1234',
                            :secret_key => 'abcd',
+                           :scope      => 'SPEECH',
                            :base_url   => 'http://foobar.com',
                            :ssl_verify => false })
       as.base_url.should   == 'http://foobar.com'
       as.ssl_verify.should == false
     end
-  
+
     it "should set the access_token and refresh_token" do
       att_speech.access_token.should  eql '5678'
       att_speech.refresh_token.should eql 'wxyz'
       att_speech.base_url.should      == 'https://api.att.com'
       att_speech.ssl_verify.should    == true
-      
+
       att_speech_hash.access_token.should  eql '5678'
       att_speech_hash.refresh_token.should eql 'wxyz'
       att_speech_hash.base_url.should      == 'https://api.att.com'
       att_speech_hash.ssl_verify.should    == true
     end
   end
-  
+
   describe 'blocking call' do
     it "should return a Hashie::Mash object when processing an audio file" do
       result = att_speech.speech_to_text 'spec/spec_helper.rb'
       result.instance_of?(Hashie::Mash).should eql true
-      
+
       result = att_speech_hash.speech_to_text 'spec/spec_helper.rb'
       result.instance_of?(Hashie::Mash).should eql true
     end
-    
+
     it "should attempt to process an audio file" do
       result = att_speech.speech_to_text 'spec/spec_helper.rb'
       result[:recognition][:response_id].should eql '2b0bdcf4301f5c4aba57e2765b59bcbe'
       result[:recognition][:n_best][:confidence].should eql 1
-      
+
       result = att_speech_hash.speech_to_text 'spec/spec_helper.rb'
       result[:recognition][:response_id].should eql '2b0bdcf4301f5c4aba57e2765b59bcbe'
       result[:recognition][:n_best][:confidence].should eql 1
     end
   end
-  
+
   describe 'non-blocking call' do
     it "should return a Celluloid::Future object when processing an audio file" do
       future = att_speech.future(:speech_to_text, 'spec/spec_helper.rb')
       future.instance_of?(Celluloid::Future).should eql true
-      
+
       future = att_speech_hash.future(:speech_to_text, 'spec/spec_helper.rb')
       future.instance_of?(Celluloid::Future).should eql true
     end
-      
+
     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
-      
+
       future = att_speech_hash.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
@@ -109,7 +128,7 @@ describe "AttSpeech" do
       sleep 0.5
       result[:recognition][:response_id].should eql '2b0bdcf4301f5c4aba57e2765b59bcbe'
       result[:recognition][:n_best][:confidence].should eql 1
-      
+
       result = nil
       att_speech_hash.speech_to_text!('spec/spec_helper.rb') { |transcription| result = transcription }
       sleep 0.5

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: att_speech
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
-- Jason Goecke
+- Jason Goecke, Peter Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2013-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -32,6 +32,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 0.14.0
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.11.1
@@ -40,6 +43,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 0.14.0
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.11.1
@@ -187,7 +193,11 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby library for consuming the AT&T Speech API for speech to text.
+description: A Ruby library for consuming v3 of the AT&T Speech API for speech->text,
+  and text->speech. Takes in either .wav or specific other audio files, and returns
+  a text string of the spoken words. Can also take in either a text string or .txt
+  file and returns a string of bytes from which a .wav file can be created of the
+  spoken text.
 email: jason@goecke.net
 executables: []
 extensions: []
@@ -197,16 +207,22 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- .travis.yml
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- README.md
 - Rakefile
 - VERSION
+- att_speech.gemspec
+- examples/bostonSeltics.wav
+- examples/example.rb
+- examples/helloWorld.txt
 - lib/att_speech.rb
-- lib/att_speech/version.rb
 - lib/att_speech/att_speech.rb
+- lib/att_speech/version.rb
 - spec/att_speech_spec.rb
 - spec/spec_helper.rb
-- README.md
 homepage: http://github.com/jsgoecke/att_speech
 licenses:
 - MIT
@@ -228,10 +244,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A Ruby library for consuming the AT&T Speech API https://developer.att.com/developer/apiDetailPage.jsp?passedItemId=10700023
-  for speech to text.
+summary: A Ruby library for consuming the AT&T Speech API https://developer.att.com/developer/forward.jsp?passedItemId=12500023
+  for speech->text, and text->speech.
 test_files: []
-has_rdoc: