att_speech 0.0.2 → 0.0.3

data/README.md

@@ -15,26 +15,27 @@ gem install att_speech
 ```ruby
 require 'att_speech'
 
-api_key    = 'foo'
-secret_key = 'bar'
+att_speech = ATTSpeech.new({ :api_key    => ENV['ATT_SPEECH_KEY'], 
+                             :secret_key => ENV['ATT_SPEECH_SECRET'] })
 
-att_speech = ATTSpeech.new(api_key, secret_key)
+# Read the audio file contents
+file_contents = File.read(File.expand_path(File.dirname(File.dirname(__FILE__))) + "/bostonSeltics.wav")
 
 # 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">>
+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
-future = att_speech.future(:speech_to_text, 'bostinSeltics.wav', type='audio/wav')
+sleep 2
+future = att_speech.future(:speech_to_text, file_contents, 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">>
+# datastore
+sleep 2
+att_speech.speech_to_text!(file_contents) { |transcription| p transcription }
+sleep 5
 ```
 
 ## Copyright

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/att_speech/att_speech.rb

@@ -2,21 +2,41 @@ class ATTSpeech
 	include Celluloid
 	Celluloid.logger = nil
 	
-	attr_reader :api_key, :secret_key, :access_token, :refresh_token
+	attr_reader :api_key, :secret_key, :access_token, :refresh_token, :base_url, :ssl_verify
 	
 	##
 	# Creates an ATTSpeech object
 	#
-	# @param [String] api_key
-	# @param [String] secret_key
-	# @param [String] base_url
+	# @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(api_key, secret_key, base_url='https://api.att.com')
-		@signaled      = false
-		@api_key 		   = api_key
-		@secret_key    = secret_key
-		@base_url      = base_url
+	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  = ''
@@ -64,7 +84,7 @@ class ATTSpeech
 	##
 	# Creates the Faraday connection object
 	def create_connection
-		@connection = Faraday.new(:url => @base_url) do |faraday|
+		@connection = Faraday.new(:url => @base_url, :ssl => { :verify => @ssl_verify }) do |faraday|
 			faraday.headers['Accept'] = 'application/json'
 			faraday.adapter           Faraday.default_adapter
 		end
@@ -106,6 +126,18 @@ class ATTSpeech
 		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
 	#

data/lib/att_speech/version.rb

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

data/spec/att_speech_spec.rb

@@ -2,37 +2,83 @@ 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, 
+                       "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'], 
                        :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' }
+  let(:att_speech_hash) { att_speech = ATTSpeech.new({ :api_key    => '1234',
+                                                       :secret_key => 'abcd' })}
   
-  it "should create an ATTSpeech object" do
-    att_speech.class.should eql ATTSpeech
-  end
+  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"
+      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.base_url.should   == 'http://foobar.com'
+      as.ssl_verify.should == false
+      
+      as = ATTSpeech.new({ :api_key    => '1234',
+                           :secret_key => 'abcd',
+                           :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'
+    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
   
@@ -40,12 +86,19 @@ describe "AttSpeech" 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
   
@@ -56,6 +109,12 @@ 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
+      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.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: