azure_stt 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a84b9a4ebc166d7d641c3f2d438f586e211747200b8f16c55114be615d3fc95
-  data.tar.gz: cb621eb69dc8621e027ab73c0274bf65869ab91116e6da3660cef9a1e0606b6e
+  metadata.gz: 327424cc1662edd29b58e2aa1a47d71e28fc0a0039c6f86dcdfb869e4132c754
+  data.tar.gz: b00b94fdf99456649a00d1e2f0a1fc31753da6dde620599f6d84259a8e24f059
 SHA512:
-  metadata.gz: 31c95c98f624d649c42f4c151fe1f5e8136e44e45835882ea2d1df96e693666d20646a8d4f38516330f07991671bcd5af879fb4797a63befb07ece5ae1834ef2
-  data.tar.gz: 1b27f2a736e42bde420385da71d3c1a89e5112f8c05ac0cae83a4d2ed09c845f08d093e999226eb83268c0284955c40ddc98d27ea8c08c4a35a6dd3cca94cbbe
+  metadata.gz: 1bdf8e794a70a14453a47d7bd55a0374aace466a39fb5c80115a7d2265b73a6cbfbd9ab5df706652ad4bde5c3c10aed8b577575a45e92a3b77d0d61f90c99aad
+  data.tar.gz: 6febf5be3e311092e1d6cf23746b9d22633607d6479bd2c9fd4b52ade015b833f8ef6f33d07b7307665ae0a6be00c34f6bd8e4bee4a4f1ff6c4abb7a63f5c055

data/CHANGELOG.md

@@ -5,6 +5,22 @@ The format is based on [Keep a Changelog][Keep a Changelog] and this project adh
 
 ## [Unreleased]
 
+---
+
+## [Released]
+
+## [0.2.0] - 2021-07-01
+
+### Added
+
+* Delete a transcription
+
+## [0.1.1] - 2021-06-24
+
+### Fixed
+
+* dry-struct dependency in the gemspec
+
 ## [0.1.0] - 2021-06-24
 
 ### Added
@@ -15,14 +31,10 @@ The format is based on [Keep a Changelog][Keep a Changelog] and this project adh
 
 ---
 
-## [Released]
-
----
-
 <!-- Links -->
 [Keep a Changelog]: https://keepachangelog.com/
 [Semantic Versioning]: https://semver.org/
 
 <!-- Versions -->
 [Unreleased]: https://github.com/PerfectMemory/azure_stt/compare/next
-[Released]: https://github.com/PerfectMemory/azure_stt/releases
+[Released]: https://github.com/PerfectMemory/azure_stt/releases

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -24,7 +24,7 @@ GEM
       dry-configurable (~> 0.1, >= 0.1.3)
     dry-core (0.6.0)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
+    dry-inflector (0.2.1)
     dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
@@ -78,7 +78,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.17.0)
+    rubocop (1.18.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -92,8 +92,8 @@ GEM
     rubocop-performance (1.11.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.5.1)
-      rubocop
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     rubocop-rspec (2.4.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)

data/README.md

@@ -1,5 +1,6 @@
 # azure_stt
 
+[![Gem Version](https://badge.fury.io/rb/azure_stt.svg)](https://badge.fury.io/rb/azure_stt)
 [![CI](https://github.com/PerfectMemory/azure_stt/actions/workflows/ci.yml/badge.svg)](https://github.com/PerfectMemory/azure_stt/actions/workflows/ci.yml)
 [![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)
@@ -32,7 +33,7 @@ To be able to use the gem, you must have a subscription key.
 You can generate one on your Azure account.
 
 * If you don't have an Azure account, you can create one for free on [this page](https://azure.microsoft.com/en-us/free/).
-* Once logged on your [Azure portal](https://portal.azure.com/), subscribe to SpeechServices in Microsoft Cognitive Service.
+* Once logged on your [Azure portal](https://portal.azure.com/), subscribe to Speech in Microsoft Cognitive Services.
 * You will find two subscription keys available in 'RESOURCE MANAGEMENT > Keys' ('KEY 1' and 'KEY 2').
 
 ## Usage
@@ -61,7 +62,7 @@ Finally, the class `AzureSTT::Session` uses by the default the values from the c
 session = AzureSTT::Session.new(region: 'your_region', subscription_key: 'your_key')
 ```
 
-### start a transcription
+### Start a transcription
 
 ```ruby
 require 'azure_stt'
@@ -115,12 +116,61 @@ if transcription.succeeded?
 end
 ```
 
+### Delete a transcription
+
+```ruby
+require 'azure_stt'
+
+session = AzureSTT::Session.new
+
+transcription = session.delete_transcription('your_transcription_id')
+```
+
+The API doesn't seem to send 404 errors when the id is unknown, but always send a 204 response.
+So the `Session#delete_transcription` returns `true` even when the transcription didn't exist.
+
+### Starting a transcription, fetching the results and deleting the transcription
+
+```ruby
+require 'azure_stt'
+
+session = AzureSTT::Session.new
+
+properties = {
+  "diarizationEnabled" => false,
+  "wordLevelTimestampsEnabled" => false,
+  "punctuationMode" => "DictatedAndAutomatic",
+  "profanityFilterMode" => "Masked"
+}
+
+content_urls = [ 'https://path.com/audio.ogg' ]
+
+session = AzureSTT::Session.new
+
+transcription = session.create_transcription(
+  content_urls: content_urls,
+  properties: properties,
+  locale: 'en-US',
+  display_name: 'The name of the transcription')
+
+id = transcription.id
+
+while(!transcription.finished?) do
+  sleep(30)
+  transcription = session.get_transcription(id)
+end
+
+if(transcription.succeeded?)
+  puts transcription.results.first.text
+end
+
+session.delete_transcription(id)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/PerfectMemory/azure_stt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/azure_stt/client.rb

@@ -75,6 +75,20 @@ module AzureSTT
       results.parsed_response['values']
     end
 
+    #
+    # Delete a transcription with a given ID
+    #
+    # @param [String] id The id of the transcription in the API
+    #
+    # @return [Boolean] true if the transcription had been deleted, raises an error else
+    #
+    def delete_transcription(id)
+      response = self.class.delete("/transcriptions/#{id}", headers: headers)
+      handle_response(response)
+
+      true
+    end
+
     #
     # Get an array containing the files for a given transcription
     #

data/lib/azure_stt/session.rb

@@ -80,6 +80,21 @@ module AzureSTT
       end
     end
 
+    #
+    # 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
+    #
+    # @param [String] id The id of the transcription in the API
+    #
+    # @return [Boolean] true if the transcription had been deleted, raises
+    # an error else
+    #
+    def delete_transcription(id)
+      client.delete_transcription(id)
+    end
+
     private
 
     #

data/lib/azure_stt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure_stt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - François Pouly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct