azure_stt 0.2.0 → 0.4.0

data/docs/method_list.html

@@ -94,13 +94,21 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="AzureSTT/Error.html#code-instance_method" title="AzureSTT::Error#code (method)">#code</a></span>
-      <small>AzureSTT::Error</small>
+      <span class='object_link'><a href="AzureSTT/ServiceError.html#code-instance_method" title="AzureSTT::ServiceError#code (method)">#code</a></span>
+      <small>AzureSTT::ServiceError</small>
     </div>
   </li>
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="AzureSTT/NetError.html#code-instance_method" title="AzureSTT::NetError#code (method)">#code</a></span>
+      <small>AzureSTT::NetError</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Result.html#combined_recognized_phrases-instance_method" title="AzureSTT::Models::Result#combined_recognized_phrases (method)">#combined_recognized_phrases</a></span>
       <small>AzureSTT::Models::Result</small>
@@ -108,7 +116,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Word.html#confidence-instance_method" title="AzureSTT::Models::Word#confidence (method)">#confidence</a></span>
       <small>AzureSTT::Models::Word</small>
@@ -116,7 +124,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Sentence.html#confidence-instance_method" title="AzureSTT::Models::Sentence#confidence (method)">#confidence</a></span>
       <small>AzureSTT::Models::Sentence</small>
@@ -124,7 +132,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT.html#configuration-class_method" title="AzureSTT.configuration (method)">configuration</a></span>
       <small>AzureSTT</small>
@@ -132,7 +140,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT.html#configure-class_method" title="AzureSTT.configure (method)">configure</a></span>
       <small>AzureSTT</small>
@@ -140,7 +148,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/File.html#content-instance_method" title="AzureSTT::Models::File#content (method)">#content</a></span>
       <small>AzureSTT::Models::File</small>
@@ -148,7 +156,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/File.html#content_url-instance_method" title="AzureSTT::Models::File#content_url (method)">#content_url</a></span>
       <small>AzureSTT::Models::File</small>
@@ -156,7 +164,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Client.html#create_transcription-instance_method" title="AzureSTT::Client#create_transcription (method)">#create_transcription</a></span>
       <small>AzureSTT::Client</small>
@@ -164,7 +172,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Session.html#create_transcription-instance_method" title="AzureSTT::Session#create_transcription (method)">#create_transcription</a></span>
       <small>AzureSTT::Session</small>
@@ -172,7 +180,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/File.html#created_date_time-instance_method" title="AzureSTT::Models::File#created_date_time (method)">#created_date_time</a></span>
       <small>AzureSTT::Models::File</small>
@@ -180,7 +188,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Transcription.html#created_date_time-instance_method" title="AzureSTT::Models::Transcription#created_date_time (method)">#created_date_time</a></span>
       <small>AzureSTT::Models::Transcription</small>
@@ -188,7 +196,23 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="AzureSTT/Client.html#delete_transcription-instance_method" title="AzureSTT::Client#delete_transcription (method)">#delete_transcription</a></span>
+      <small>AzureSTT::Client</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="AzureSTT/Session.html#delete_transcription-instance_method" title="AzureSTT::Session#delete_transcription (method)">#delete_transcription</a></span>
+      <small>AzureSTT::Session</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Report.html#details-instance_method" title="AzureSTT::Models::Report#details (method)">#details</a></span>
       <small>AzureSTT::Models::Report</small>
@@ -196,7 +220,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Transcription.html#display_name-instance_method" title="AzureSTT::Models::Transcription#display_name (method)">#display_name</a></span>
       <small>AzureSTT::Models::Transcription</small>
@@ -204,7 +228,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Word.html#duration-instance_method" title="AzureSTT::Models::Word#duration (method)">#duration</a></span>
       <small>AzureSTT::Models::Word</small>
@@ -212,7 +236,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Result.html#duration-instance_method" title="AzureSTT::Models::Result#duration (method)">#duration</a></span>
       <small>AzureSTT::Models::Result</small>
@@ -220,7 +244,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/RecognizedPhrase.html#duration-instance_method" title="AzureSTT::Models::RecognizedPhrase#duration (method)">#duration</a></span>
       <small>AzureSTT::Models::RecognizedPhrase</small>
@@ -228,7 +252,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Word.html#duration_in_ticks-instance_method" title="AzureSTT::Models::Word#duration_in_ticks (method)">#duration_in_ticks</a></span>
       <small>AzureSTT::Models::Word</small>
@@ -236,7 +260,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Result.html#duration_in_ticks-instance_method" title="AzureSTT::Models::Result#duration_in_ticks (method)">#duration_in_ticks</a></span>
       <small>AzureSTT::Models::Result</small>
@@ -244,7 +268,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/RecognizedPhrase.html#duration_in_ticks-instance_method" title="AzureSTT::Models::RecognizedPhrase#duration_in_ticks (method)">#duration_in_ticks</a></span>
       <small>AzureSTT::Models::RecognizedPhrase</small>
@@ -252,7 +276,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Transcription.html#failed%3F-instance_method" title="AzureSTT::Models::Transcription#failed? (method)">#failed?</a></span>
       <small>AzureSTT::Models::Transcription</small>
@@ -260,7 +284,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Report.html#failed_transcriptions_count-instance_method" title="AzureSTT::Models::Report#failed_transcriptions_count (method)">#failed_transcriptions_count</a></span>
       <small>AzureSTT::Models::Report</small>
@@ -268,7 +292,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Transcription.html#finished%3F-instance_method" title="AzureSTT::Models::Transcription#finished? (method)">#finished?</a></span>
       <small>AzureSTT::Models::Transcription</small>
@@ -276,7 +300,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Client.html#get_file-instance_method" title="AzureSTT::Client#get_file (method)">#get_file</a></span>
       <small>AzureSTT::Client</small>
@@ -284,7 +308,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Client.html#get_transcription-instance_method" title="AzureSTT::Client#get_transcription (method)">#get_transcription</a></span>
       <small>AzureSTT::Client</small>
@@ -292,7 +316,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Session.html#get_transcription-instance_method" title="AzureSTT::Session#get_transcription (method)">#get_transcription</a></span>
       <small>AzureSTT::Session</small>
@@ -300,7 +324,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Client.html#get_transcription_files-instance_method" title="AzureSTT::Client#get_transcription_files (method)">#get_transcription_files</a></span>
       <small>AzureSTT::Client</small>
@@ -308,7 +332,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Client.html#get_transcriptions-instance_method" title="AzureSTT::Client#get_transcriptions (method)">#get_transcriptions</a></span>
       <small>AzureSTT::Client</small>
@@ -316,7 +340,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Session.html#get_transcriptions-instance_method" title="AzureSTT::Session#get_transcriptions (method)">#get_transcriptions</a></span>
       <small>AzureSTT::Session</small>
@@ -324,7 +348,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Parsers/Base.html#hash-instance_method" title="AzureSTT::Parsers::Base#hash (method)">#hash</a></span>
       <small>AzureSTT::Parsers::Base</small>
@@ -332,7 +356,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/File.html#id-instance_method" title="AzureSTT::Models::File#id (method)">#id</a></span>
       <small>AzureSTT::Models::File</small>
@@ -340,7 +364,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Models/Transcription.html#id-instance_method" title="AzureSTT::Models::Transcription#id (method)">#id</a></span>
       <small>AzureSTT::Models::Transcription</small>
@@ -348,7 +372,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="AzureSTT/Client.html#initialize-instance_method" title="AzureSTT::Client#initialize (method)">#initialize</a></span>
       <small>AzureSTT::Client</small>
@@ -356,10 +380,18 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="AzureSTT/ServiceError.html#initialize-instance_method" title="AzureSTT::ServiceError#initialize (method)">#initialize</a></span>
+      <small>AzureSTT::ServiceError</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="AzureSTT/Error.html#initialize-instance_method" title="AzureSTT::Error#initialize (method)">#initialize</a></span>
-      <small>AzureSTT::Error</small>
+      <span class='object_link'><a href="AzureSTT/NetError.html#initialize-instance_method" title="AzureSTT::NetError#initialize (method)">#initialize</a></span>
+      <small>AzureSTT::NetError</small>
     </div>
   </li>
   

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.34
   
 </title>
 
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jun 24 14:16:27 2021 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.6.6).
+  Generated on Wed May 10 12:30:20 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-2.7.7).
 </div>
 
     </div>

data/lib/azure_stt/client.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'httparty'
-
 module AzureSTT
   #
   # Client class that uses HTTParty to communicate with the API
@@ -20,13 +19,13 @@ module AzureSTT
     def initialize(region:, subscription_key:)
       @subscription_key = subscription_key
       @region = region
-      self.class.base_uri "https://#{region}.api.cognitive.microsoft.com/speechtotext/v3.0"
+      self.class.base_uri "https://#{region}.api.cognitive.microsoft.com/speechtotext/v3.1"
     end
 
     #
     # Create a transcription for a batch or a single file.
     #
-    # @see https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription
+    # @see https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription
     #
     # @param [Hash] args
     #
@@ -92,7 +91,7 @@ module AzureSTT
     #
     # Get an array containing the files for a given transcription
     #
-    # @see https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles
+    # @see https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptionFiles
     #
     # @param [Integer] id The identifier of the transcription
     #
@@ -147,9 +146,10 @@ module AzureSTT
     #
     # @return [HTTParty::Response]
     #
-    def get(path, parameters = {})
+    def get(path, parameters = nil)
       options = {
-        headers: headers.merge(parameters)
+        headers: headers,
+        query: parameters
       }.compact
 
       response = self.class.get(path, options)
@@ -177,12 +177,13 @@ module AzureSTT
         if response.request.format == :json
           raise ServiceError.new(
             code: response.code,
-            message: response.response.message
+            message: response['code'] || response.message,
+            azure_message: response['message'] || response.dig('error', 'message')
           )
         else
           raise NetError.new(
             code: response.code,
-            message: response.response.message
+            message: response.message
           )
         end
       end

data/lib/azure_stt/errors.rb

@@ -4,22 +4,29 @@ module AzureSTT
   #
   # Top level error for AzureSTT specific errors
   #
-  class Error < StandardError
+  class Error < StandardError; end
+
+  #
+  # Error raised when there is an error 400
+  #
+  class ServiceError < Error
     attr_reader :code
 
-    def initialize(code:, message:)
+    def initialize(code:, message:, azure_message:)
       @code = code
-      super("#{message} (#{code})")
+      super("#{message} (#{code}): #{azure_message}")
     end
   end
 
-  #
-  # Error raised when there is an error 400
-  #
-  class ServiceError < Error; end
-
   #
   # Error raised when there is an error 500
   #
-  class NetError < Error; end
+  class NetError < Error
+    attr_reader :code
+
+    def initialize(code:, message:)
+      @code = code
+      super("#{message} (#{code})")
+    end
+  end
 end

data/lib/azure_stt/models/file.rb

@@ -5,7 +5,7 @@ module AzureSTT
     #
     # Model class to represent files in our models
     #
-    # @see https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console
+    # @see https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptionFiles/console
     #
     class File < Base
       #

data/lib/azure_stt/models/transcription.rb

@@ -123,7 +123,7 @@ module AzureSTT
       #
       # Get the report of a transcription from transcriptions/id/files route
       #
-      # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console
+      # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptionFiles/console
       #
       # @return [Models::Report]
       #

data/lib/azure_stt/parsers/combined_recognized_phrases.rb

@@ -1,4 +1,4 @@
-# frozen_String_literal: true
+# frozen_string_literal: true
 
 module AzureSTT
   module Parsers

data/lib/azure_stt/session.rb

@@ -25,7 +25,7 @@ module AzureSTT
     #
     # Create a transcription by calling the API.
     #
-    # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription
+    # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription
     #
     # @param [Array[String]] content_urls The urls of your files
     # @param [Hash] properties The properties you want to use for the
@@ -38,12 +38,10 @@ module AzureSTT
     #
     def create_transcription(content_urls:, properties:, locale:, display_name:)
       transcription_hash = client.create_transcription(
-        {
-          contentUrls: content_urls,
-          properties: properties,
-          locale: locale,
-          displayName: display_name
-        }
+        contentUrls: content_urls,
+        properties: properties,
+        locale: locale,
+        displayName: display_name
       )
       build_transcription_from_hash(transcription_hash)
     end
@@ -51,7 +49,7 @@ module AzureSTT
     #
     # Get a transcription identified by an id.
     #
-    # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscription
+    # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscription
     #
     # @param [String] id The identifier of the transcription
     #
@@ -65,7 +63,7 @@ module AzureSTT
     #
     # Get multiple transcriptions.
     #
-    # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptions
+    # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptions
     #
     # @param [Integer] skip Number of transcriptions that will be skipped (optional)
     # @param [Integer] top Number of transcriptions that will be included after skipping
@@ -84,7 +82,7 @@ module AzureSTT
     # Delete an API transcription with a given ID. The transcription will not
     # exist anymore in the API, therefore you won't be able to retrieve it.
     #
-    # @see https://westus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/DeleteTranscription
+    # @see https://westus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/DeleteTranscription
     #
     # @param [String] id The id of the transcription in the API
     #

data/lib/azure_stt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AzureStt
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

data/lib/azure_stt.rb

@@ -15,6 +15,6 @@ require_relative 'azure_stt/parsers'
 require_relative 'azure_stt/session'
 
 AzureSTT.configure do |config|
-  config.subscription_key = ENV['SUBSCRIPTION_KEY']
-  config.region = ENV['REGION']
+  config.subscription_key = ENV.fetch('SUBSCRIPTION_KEY', nil)
+  config.region = ENV.fetch('REGION', 'uscentral')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure_stt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - François Pouly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -38,29 +38,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-description: API Wrapper for the Microsoft Translator Text API 3.0 (Cognitive Services)
+description: API Wrapper for the Microsoft Translator Text API 3.1 (Cognitive Services)
 email:
 - francois.pouly@perfect-memory.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - azure_stt.gemspec
 - bin/console
 - bin/setup
-- docs/AzureBatchTranscription.html
-- docs/AzureBatchTranscription/Configuration.html
 - docs/AzureSTT.html
 - docs/AzureSTT/Client.html
 - docs/AzureSTT/Configuration.html
@@ -88,7 +84,6 @@ files:
 - docs/AzureSTT/Parsers/Word.html
 - docs/AzureSTT/ServiceError.html
 - docs/AzureSTT/Session.html
-- docs/AzureSTT/Transcription.html
 - docs/AzureSTT/Types.html
 - docs/AzureStt_.html
 - docs/_index.html
@@ -135,7 +130,8 @@ files:
 homepage: https://github.com/PerfectMemory/azure_stt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -151,8 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: API Wrapper for the Microsoft Translator Text API 3.0
+summary: API Wrapper for the Microsoft Translator Text API 3.1
 test_files: []

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: 'bundler'
-    directory: '/'
-    schedule:
-      interval: 'daily'