att_speech 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+gem "faraday", ">= 0.8.1"
+gem "celluloid", ">= 0.11.1"
+gem "hashie", ">=1.2.0"
+gem "activesupport"
+
+group :development do
+  gem "rspec", ">= 2.8.0"
+  gem "yard", ">= 0.7"
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "simplecov", ">= 0"
+  gem "fakeweb"
+end

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2012 Jason Goecke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# att_speech
+
+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
+
+```
+gem install att_speech
+```
+
+## Usage
+
+```ruby
+require 'att_speech'
+
+api_key    = 'foo'
+secret_key = 'bar'
+
+att_speech = ATTSpeech.new(api_key, secret_key)
+
+# Block 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">>
+
+# Non-blocking operation with a future, if you have a longer file that requires more processing time
+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">>
+```
+
+## Copyright
+
+Copyright (c) 2012 Jason Goecke. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  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.email = "jason@goecke.net"
+  gem.authors = ["Jason Goecke"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/att_speech.rb

@@ -0,0 +1,9 @@
+%w{
+	json
+	faraday
+	hashie
+	celluloid
+	active_support/core_ext/string/inflections
+	att_speech/version
+	att_speech/att_speech
+}.each { |lib| require lib }

data/lib/att_speech/att_speech.rb

@@ -0,0 +1,121 @@
+class ATTSpeech
+	include Celluloid
+	Celluloid.logger = nil
+	
+	attr_reader :api_key, :secret_key, :access_token, :refresh_token
+	
+	##
+	# Creates an ATTSpeech object
+	#
+	# @param [String] api_key
+	# @param [String] secret_key
+	# @param [String] base_url
+	#
+	# @return [Object] an instance of ATTSpeech
+	def initialize(api_key, secret_key, base_url='https://api.att.com')
+		@api_key 		   = api_key
+		@secret_key    = secret_key
+		@base_url      = base_url
+		@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
+	#
+	# @return [Hash] the resulting response from the AT&T Speech API
+	def speech_to_text(file_contents, type='audio/wav', speech_context='Generic')
+		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'
+									                          
+			process_response(response)
+		rescue => e
+			raise RuntimeError, e.to_s
+		end
+	end
+	
+	private
+	
+	##
+	# Creates the Faraday connection object
+	def create_connection
+		@connection = Faraday.new(:url => @base_url) 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
+	
+	##
+	# 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

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

data/spec/att_speech_spec.rb

@@ -0,0 +1,51 @@
+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'], 
+                       :body   => '{"access_token":"5678","refresh_token":"wxyz"}')
+  
+  FakeWeb.register_uri(:post, 
+                       "https://api.att.com/rest/1/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' }
+  
+  it "should create an ATTSpeech object" do
+    att_speech.class.should eql ATTSpeech
+  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'
+  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
+    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
+    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
+    end
+      
+    it "should allow us to user 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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fakeweb'
+require 'att_speech'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: att_speech
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Goecke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library for consuming the AT&T Speech API for speech to text.
+email: jason@goecke.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- VERSION
+- lib/att_speech.rb
+- lib/att_speech/version.rb
+- lib/att_speech/att_speech.rb
+- spec/att_speech_spec.rb
+- spec/spec_helper.rb
+- README.md
+homepage: http://github.com/jsgoecke/att_speech
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+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.
+test_files: []
+has_rdoc: