azure_stt 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327424cc1662edd29b58e2aa1a47d71e28fc0a0039c6f86dcdfb869e4132c754
-  data.tar.gz: b00b94fdf99456649a00d1e2f0a1fc31753da6dde620599f6d84259a8e24f059
+  metadata.gz: 3d191b5213b76873a27c2484a4f0494bc11789125b84ed67d7612e64cec6ef88
+  data.tar.gz: e27715d790a7706a0af127c82c65873d537c387170a3214c47ecd1c5fcd84cfd
 SHA512:
-  metadata.gz: 1bdf8e794a70a14453a47d7bd55a0374aace466a39fb5c80115a7d2265b73a6cbfbd9ab5df706652ad4bde5c3c10aed8b577575a45e92a3b77d0d61f90c99aad
-  data.tar.gz: 6febf5be3e311092e1d6cf23746b9d22633607d6479bd2c9fd4b52ade015b833f8ef6f33d07b7307665ae0a6be00c34f6bd8e4bee4a4f1ff6c4abb7a63f5c055
+  metadata.gz: 42bddc1ae5e0b3316b04963d57ae7882553ac3f4382b7e76562bd4d7c63b3a940d025211d71e8b41f77d2657ed3d1eefe77a3517eea5b55c72cc63d6510d81e6
+  data.tar.gz: bec2619c932cc61581fcd0ce06885571e8718ed6e14ec36779d5c9937382d5b1c6a971cbf2df7c753f9dc48149802176b027c1fef08870b8cc85ddd0458d0464

data/.github/workflows/ci.yml

@@ -10,13 +10,16 @@ jobs:
   test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0', '2.7', '2.6']
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6
+          ruby-version: ${{ matrix.ruby-version }}
       - name: Install dependencies
         run: bundle install
       - name: Run tests

data/.gitignore

@@ -45,9 +45,9 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
 # .ruby-gemset
+Gemfile.lock
+.ruby-version
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/CHANGELOG.md

@@ -5,7 +5,22 @@ The format is based on [Keep a Changelog][Keep a Changelog] and this project adh
 
 ## [Unreleased]
 
----
+## [0.4.0] - 2023-05-10
+
+### Fixed
+
+- `get_transcriptions` using `skip` and `top` params
+
+### Modified
+
+- Messages given by Azure when 4** HTTP errors are detailed [#56](https://github.com/PerfectMemory/azure_stt/issues/56)
+- Use Speech to Text API v3.1 instead of v3.0 [#58](https://github.com/PerfectMemory/azure_stt/issues/58)
+
+## [0.3.0] - 2022-10-19
+
+### Modified
+
+- Compatibility with Ruby 3.1
 
 ## [Released]
 

data/Gemfile

@@ -3,10 +3,11 @@
 source 'https://rubygems.org'
 
 gem 'dry-struct', '~> 1'
-gem 'httparty', '~> 0.17'
+gem 'httparty', '~> 0.19'
 
 group :test do
-  gem 'bundler', '~> 1.17'
+  gem 'bundler', '~> 2'
+  gem 'debug'
   gem 'dotenv'
   gem 'factory_bot', '~> 6'
   gem 'faker', '~> 2'

data/README.md

@@ -5,7 +5,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/PerfectMemory/azure_stt/badge.svg)](https://coveralls.io/github/PerfectMemory/azure_stt)
 [![Maintainability](https://api.codeclimate.com/v1/badges/375190d3122da56a9fe1/maintainability)](https://codeclimate.com/github/PerfectMemory/azure_stt/maintainability)
 
-API Wrapper for the [Microsoft Azure Speech Services Speech-to-text REST API 3.0](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/rest-speech-to-text) (Cognitive Services).
+API Wrapper for the [Microsoft Azure Speech Services Speech-to-text REST API 3.1](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/rest-speech-to-text) (Cognitive Services).
 
 ## Installation
 
@@ -105,7 +105,7 @@ transcription = session.get_transcription('your_transcription_id')
 # # "wordLevelTimestampsEnabled"=>false, "channels"=>[0, 1],
 # # "punctuationMode"=>"DictatedAndAutomatic", "profanityFilterMode"=>"Masked",
 # # "duration"=>"PT5M18S"}
-# # links={"files"=>"https://uscentral.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/d35a802d-70ae-4358-a35d-b5faa0c75457/files"}
+# # links={"files"=>"https://uscentral.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/d35a802d-70ae-4358-a35d-b5faa0c75457/files"}
 # # last_action_date_time=#<Date: 2020-05-31 ((2459366j,0s,0n),+0s,2299161j)> created_date_time=#<Date: 2020-05-31 ((2459366j,0s,0n),+0s,2299161j)>
 # # status="Succeeded" locale="en-US" display_name="Transcription name" files=[]>
 

data/azure_stt.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['François Pouly']
   spec.email         = ['francois.pouly@perfect-memory.com']
 
-  spec.summary       = 'API Wrapper for the Microsoft Translator Text API 3.0'
-  spec.description   = 'API Wrapper for the Microsoft Translator Text API 3.0 (Cognitive Services)'
+  spec.summary       = 'API Wrapper for the Microsoft Translator Text API 3.1'
+  spec.description   = 'API Wrapper for the Microsoft Translator Text API 3.1 (Cognitive Services)'
   spec.homepage      = 'https://github.com/PerfectMemory/azure_stt'
   spec.license       = 'MIT'
 
@@ -26,4 +26,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6'
   spec.add_dependency 'dry-struct', '~> 1'
   spec.add_dependency 'httparty', '~> 0.17'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/docs/AzureSTT/Client.html

@@ -6,7 +6,7 @@
 <title>
   Class: AzureSTT::Client
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.34
   
 </title>
 
@@ -214,6 +214,30 @@
 <p>Create a transcription for a batch or a single file.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#delete_transcription-instance_method" title="#delete_transcription (instance method)">#<strong>delete_transcription</strong>(id)  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Delete a transcription with a given ID.</p>
+</div></span>
+  
 </li>
 
       
@@ -408,19 +432,19 @@
       <pre class="lines">
 
 
+19
 20
 21
 22
-23
-24</pre>
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>region:</span><span class='comma'>,</span> <span class='label'>subscription_key:</span><span class='rparen'>)</span>
   <span class='ivar'>@subscription_key</span> <span class='op'>=</span> <span class='id identifier rubyid_subscription_key'>subscription_key</span>
   <span class='ivar'>@region</span> <span class='op'>=</span> <span class='id identifier rubyid_region'>region</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_region'>region</span><span class='embexpr_end'>}</span><span class='tstring_content'>.api.cognitive.microsoft.com/speechtotext/v3.0</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_region'>region</span><span class='embexpr_end'>}</span><span class='tstring_content'>.api.cognitive.microsoft.com/speechtotext/v3.1</span><span class='tstring_end'>&quot;</span></span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -460,12 +484,12 @@
       <pre class="lines">
 
 
+11
 12
-13
-14</pre>
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_region'>region</span>
   <span class='ivar'>@region</span>
@@ -503,12 +527,12 @@
       <pre class="lines">
 
 
+11
 12
-13
-14</pre>
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_subscription_key'>subscription_key</span>
   <span class='ivar'>@subscription_key</span>
@@ -581,7 +605,7 @@
   <p class="tag_title">See Also:</p>
   <ul class="see">
     
-      <li><a href="https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription" target="_parent" title="https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription">https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription</a></li>
+      <li><a href="https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription" target="_parent" title="https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription">https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription</a></li>
     
   </ul>
 
@@ -591,17 +615,17 @@
       <pre class="lines">
 
 
+34
 35
 36
 37
 38
 39
 40
-41
-42</pre>
+41</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 35</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 34</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_create_transcription'>create_transcription</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
@@ -614,6 +638,91 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="delete_transcription-instance_method">
+  
+    #<strong>delete_transcription</strong>(id)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Delete a transcription with a given ID</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The id of the transcription in the API</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if the transcription had been deleted, raises an error else</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+84
+85
+86
+87
+88
+89</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 84</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_delete_transcription'>delete_transcription</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/transcriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_handle_response'>handle_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
+
+  <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -680,16 +789,16 @@
       <pre class="lines">
 
 
-100
-101
-102
-103
-104
-105
-106</pre>
+113
+114
+115
+116
+117
+118
+119</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 100</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 113</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get_file'>get_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file_url'>file_url</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_file_url'>file_url</span><span class='rparen'>)</span>
@@ -767,14 +876,14 @@
       <pre class="lines">
 
 
+50
 51
 52
 53
-54
-55</pre>
+54</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 51</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 50</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get_transcription'>get_transcription</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/transcriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -847,7 +956,7 @@
   <p class="tag_title">See Also:</p>
   <ul class="see">
     
-      <li><a href="https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles" target="_parent" title="https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles">https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles</a></li>
+      <li><a href="https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptionFiles" target="_parent" title="https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptionFiles">https://uscentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptionFiles</a></li>
     
   </ul>
 
@@ -857,14 +966,14 @@
       <pre class="lines">
 
 
-87
-88
-89
-90
-91</pre>
+100
+101
+102
+103
+104</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 87</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 100</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get_transcription_files'>get_transcription_files</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/transcriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
@@ -962,6 +1071,7 @@
       <pre class="lines">
 
 
+65
 66
 67
 68
@@ -971,11 +1081,10 @@
 72
 73
 74
-75
-76</pre>
+75</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 66</span>
+      <pre class="code"><span class="info file"># File 'lib/azure_stt/client.rb', line 65</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get_transcriptions'>get_transcriptions</span><span class='lparen'>(</span><span class='label'>skip:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>top:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
@@ -998,9 +1107,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/docs/AzureSTT/Configuration.html

@@ -6,7 +6,7 @@
 <title>
   Class: AzureSTT::Configuration
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.34
   
 </title>
 
@@ -272,9 +272,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>