azure_stt 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a84b9a4ebc166d7d641c3f2d438f586e211747200b8f16c55114be615d3fc95
-  data.tar.gz: cb621eb69dc8621e027ab73c0274bf65869ab91116e6da3660cef9a1e0606b6e
+  metadata.gz: 71c2c80aa3d7493e1dd60052ac4e83a7e9351eb367c03202a0d0991120c7ebc4
+  data.tar.gz: 55dc37a5463f36425d37a9b5eb2a2416d00198628bdf5678e8761df7bf4ec7dc
 SHA512:
-  metadata.gz: 31c95c98f624d649c42f4c151fe1f5e8136e44e45835882ea2d1df96e693666d20646a8d4f38516330f07991671bcd5af879fb4797a63befb07ece5ae1834ef2
-  data.tar.gz: 1b27f2a736e42bde420385da71d3c1a89e5112f8c05ac0cae83a4d2ed09c845f08d093e999226eb83268c0284955c40ddc98d27ea8c08c4a35a6dd3cca94cbbe
+  metadata.gz: 40e10ff4e3fb07c4521b6fda6809853df234748442c41d8f8bd2535b75a8ff6c759377d90799daec02545f1586cba48aafd6641972029b832bd241afad6f8347
+  data.tar.gz: f6da9bea5a7becff8efcc2a953be8f6fc1b98ffeb7d77ecdab910aa8db1aa91ae2f5c4e61008b0c4269072c968ed7a7b721a4b7df675a8a5262ea0a09d5a1785

data/.github/workflows/ci.yml

@@ -10,13 +10,16 @@ jobs:
   test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['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,6 +5,28 @@ The format is based on [Keep a Changelog][Keep a Changelog] and this project adh
 
 ## [Unreleased]
 
+---
+
+## [0.3.0] - 2022-10-19
+
+### Modified
+
+- Compatibility with Ruby 3.1
+
+## [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 +37,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

@@ -3,10 +3,10 @@
 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 'dotenv'
   gem 'factory_bot', '~> 6'
   gem 'faker', '~> 2'

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/azure_stt.gemspec

@@ -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/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/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

@@ -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
@@ -80,6 +78,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.3.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.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - François Pouly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -45,14 +45,12 @@ 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
@@ -135,7 +133,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,7 +150,7 @@ 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

data/.github/dependabot.yml

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

data/Gemfile.lock

@@ -1,141 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    concurrent-ruby (1.1.9)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    docile (1.4.0)
-    dotenv (2.7.6)
-    dry-configurable (0.12.1)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.8.0)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.6.0)
-      concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.2.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-struct (1.4.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-types (~> 1.5)
-      ice_nine (~> 0.11)
-    dry-types (1.5.1)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.5, >= 0.5)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
-    factory_bot (6.2.0)
-      activesupport (>= 5.0.0)
-    faker (2.18.0)
-      i18n (>= 1.6, < 2)
-    hashdiff (1.0.1)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    minitest (5.14.4)
-    multi_xml (0.6.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-its (1.3.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.3)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.26)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  dotenv
-  dry-struct (~> 1)
-  factory_bot (~> 6)
-  faker (~> 2)
-  httparty (~> 0.17)
-  rake (~> 13.0)
-  rspec (~> 3)
-  rspec-its
-  rubocop
-  rubocop-performance
-  rubocop-rake
-  rubocop-rspec
-  simplecov
-  simplecov-lcov
-  webmock
-  yard
-
-BUNDLED WITH
-   1.17.3