Merge pull request #46 from GoogleCloudPlatform/speech

remi Taylor · web-flow · commit 532c029bc1a3 · 2016-09-01T10:31:55.000-07:00
Ruby samples for Google Cloud Speech API
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -24,7 +24,13 @@
 # http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint
 
 AllCops:
+  # Allow Ruby 2 features, eg. named parameters
   TargetRubyVersion: 2.1
+  Exclude:
+    # ignore generated protobuf files
+    - "**/*_pb.rb"
+    # ignore any code in 'generated' directories
+    - "*/generated/**/*.rb"
 
 # Prefer double quotes for consistency (regardless of interpolation)
 Style/StringLiterals:
diff --git a/.travis.yml b/.travis.yml
@@ -35,6 +35,7 @@ env:
   - TEST_DIR=bigquery
   - TEST_DIR=datastore
   - TEST_DIR=logging
+  - TEST_DIR=speech
   - TEST_DIR=translate
   - TEST_DIR=language
   - TEST_DIR=appengine/endpoints
diff --git a/speech/.rspec b/speech/.rspec
@@ -0,0 +1 @@
+--tty --color --format documentation --order random
diff --git a/speech/Gemfile b/speech/Gemfile
@@ -0,0 +1,23 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+source "https://rubygems.org"
+
+gem "google-api-client"
+
+group :test do
+  gem "rake"
+  gem "rubocop"
+  gem "rspec"
+end
diff --git a/speech/Gemfile.lock b/speech/Gemfile.lock
@@ -0,0 +1,86 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.9.13)
+      addressable (~> 2.3)
+      googleauth (~> 0.5)
+      httpclient (~> 2.7)
+      hurley (~> 0.1)
+      memoist (~> 0.11)
+      mime-types (>= 1.6)
+      representable (~> 2.3.0)
+      retriable (~> 2.0)
+    googleauth (0.5.1)
+      faraday (~> 0.9)
+      jwt (~> 1.4)
+      logging (~> 2.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (~> 0.9)
+      signet (~> 0.7)
+    httpclient (2.8.2.3)
+    hurley (0.2)
+    jwt (1.5.4)
+    little-plugger (1.1.4)
+    logging (2.1.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    memoist (0.15.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    os (0.9.6)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    representable (2.3.0)
+      uber (~> 0.0.7)
+    retriable (2.1.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    signet (0.7.3)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (~> 1.5)
+      multi_json (~> 1.10)
+    uber (0.0.15)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  google-api-client
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.12.5
diff --git a/speech/README.md b/speech/README.md
@@ -0,0 +1,32 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Speech API Ruby Samples
+
+[Sign up for the Alpha](https://services.google.com/fb/forms/speech-api-alpha/).
+
+The [Cloud Speech API](https://cloud.google.com/speech/) enables easy
+integration of Google speech recognition technologies into developer applications.
+
+## Run sample
+
+To run the sample, first install dependencies:
+
+    bundle install
+
+Run the sample:
+
+    bundle exec ruby speech_samples.rb
+
+Usage:
+
+    Usage: ruby speech_samples.rb <command> [arguments]
+
+    Commands:
+      recognize               <audio-file.raw>
+      async_recognize         <audio-file.raw>
+      async_recognize_results <operation name>
+
+Examples:
+
+    $ bundle exec ruby speech_samples.rb recognize audio_files/audio.raw
+    Text: how old is the Brooklyn Bridge
diff --git a/speech/Rakefile b/speech/Rakefile
@@ -0,0 +1,21 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: :spec
diff --git a/speech/audio_files/audio.flac b/speech/audio_files/audio.flac
diff --git a/speech/audio_files/audio.raw b/speech/audio_files/audio.raw
diff --git a/speech/audio_files/audio2.raw b/speech/audio_files/audio2.raw
diff --git a/speech/audio_files/quit.raw b/speech/audio_files/quit.raw
diff --git a/speech/spec/speech_samples_spec.rb b/speech/spec/speech_samples_spec.rb
@@ -0,0 +1,72 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in write, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "../speech_samples"
+require "rspec"
+
+RSpec.describe "Google Cloud Speech API samples" do
+
+  before do
+    # Path to RAW audio file with sample rate of 16000 using LINEAR16 encoding
+    @audio_file_path = File.expand_path "../audio_files/audio.raw", __dir__
+
+    # Expected transcript of spoken English recorded in the audio.raw file
+    @audio_file_transcript = "how old is the Brooklyn Bridge"
+  end
+
+  # Capture and return STDOUT output by block
+  def capture &block
+    real_stdout = $stdout
+    $stdout = StringIO.new
+    block.call
+    @captured_output = $stdout.string
+  ensure
+    $stdout = real_stdout
+  end
+  attr_reader :captured_output
+
+  example "transcribe audio file" do
+    expect {
+      transcript_from_audio_file audio_file_path: @audio_file_path
+    }.to output("Text: #{@audio_file_transcript}\n").to_stdout
+  end
+
+  example "begin async operation to transcribe audio file" do
+    expect {
+      begin_async_operation audio_file_path: @audio_file_path
+    }.to output(/Operation identifier: \d+/).to_stdout
+  end
+
+  example "get results of async operation to transcribe audio file" do
+    capture do
+      begin_async_operation audio_file_path: @audio_file_path
+    end
+
+    name = captured_output.match(/Operation identifier: (\d+)/).captures.first
+
+    # TODO: Remove use of `sleep` and Update to use wait_until with timeout
+    sleep 1
+
+    capture { get_async_operation_results operation_name: name }
+
+    unless captured_output.include? "Operation complete: true"
+      sleep 5
+      capture { get_async_operation_results operation_name: name }
+    end
+
+    expect(captured_output).to include "Operation complete: true"
+    expect(captured_output).to include "Text: #{@audio_file_transcript}"
+  end
+
+end
diff --git a/speech/speech_samples.rb b/speech/speech_samples.rb
@@ -0,0 +1,111 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in write, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Required to load locally generated Cloud Speech API client
+# TODO remove once Cloud Speech API client is released in google-api-client gem
+$LOAD_PATH.unshift File.expand_path("generated", __dir__)
+
+def initialize_speech_client
+  # [START initialize_speech_client]
+  require "google/apis/speech_v1beta1"
+
+  speech_service = Google::Apis::SpeechV1beta1::CloudSpeechAPIService.new
+
+  speech_service.authorization = Google::Auth.get_application_default(
+    %[ https://www.googleapis.com/auth/cloud-platform ]
+  )
+  # [END initialize_speech_client]
+
+  speech_service
+end
+
+def transcript_from_audio_file audio_file_path:
+  speech_service = initialize_speech_client
+
+  # [START transcript_from_audio_file]
+  # audio_file_path = "Path to local audio file"
+
+  request        = Google::Apis::SpeechV1beta1::SyncRecognizeRequest.new
+  request.audio  = { content: File.read(audio_file_path) }
+  request.config = { encoding: "LINEAR16", sample_rate: 16000 }
+
+  response = speech_service.sync_recognize_speech request
+
+  if response.results
+    response.results.each do |recognize_result|
+      recognize_result.alternatives.each do |alternative_hypothesis|
+        puts "Text: #{alternative_hypothesis.transcript}"
+      end
+    end
+  end
+  # [END transcript_from_audio_file]
+end
+
+def begin_async_operation audio_file_path:
+  speech_service = initialize_speech_client
+
+  # [START begin_async_operation]
+  # audio_file_path = "Path to local audio file"
+
+  request        = Google::Apis::SpeechV1beta1::AsyncRecognizeRequest.new
+  request.audio  = { content: File.read(audio_file_path) }
+  request.config = { encoding: "LINEAR16", sample_rate: 16000 }
+
+  operation = speech_service.async_recognize_speech request
+
+  puts "Operation identifier: #{operation.name}"
+  # [END begin_async_operation]
+end
+
+def get_async_operation_results operation_name:
+  speech_service = initialize_speech_client
+
+  # [START get_async_operation_results]
+  # operation_name = "Name of operation returned from #async_recognize_speech"
+
+  operation = speech_service.get_operation operation_name
+
+  puts "Operation complete: #{operation.done?}"
+
+  if operation.done?
+    operation.response["results"].each do |recognize_result|
+      recognize_result["alternatives"].each do |alternative_hypothesis|
+        puts "Text: #{alternative_hypothesis['transcript']}"
+      end
+    end
+  end
+  # [END get_async_operation_results]
+end
+
+if __FILE__ == $PROGRAM_NAME
+  command = ARGV.shift
+
+  case command
+  when "recognize"
+    transcript_from_audio_file audio_file_path: ARGV.first
+  when "async_recognize"
+    begin_async_operation audio_file_path: ARGV.first
+  when "async_recognize_results"
+    get_async_operation_results operation_name: ARGV.first
+  else
+    puts <<-usage
+Usage: ruby speech_samples.rb <command> [arguments]
+
+Commands:
+  recognize               <audio-file.raw>
+  async_recognize         <audio-file.raw>
+  async_recognize_results <operation name>
+    usage
+  end
+end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+--tty --color --format documentation --order random`