RubyGems - azure_stt - Versions diffs - 0.1.0 - Mend

azure_stt 0.1.0

Files changed (89) hide show

checksums.yaml +7 -0
data/.github/dependabot.yml +6 -0
data/.github/workflows/ci.yml +33 -0
data/.gitignore +56 -0
data/.rubocop.yml +22 -0
data/CHANGELOG.md +28 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Gemfile +24 -0
data/Gemfile.lock +141 -0
data/LICENSE +21 -0
data/README.md +129 -0
data/Rakefile +27 -0
data/azure_stt.gemspec +29 -0
data/bin/console +15 -0
data/bin/setup +8 -0
data/docs/AzureBatchTranscription.html +301 -0
data/docs/AzureBatchTranscription/Configuration.html +212 -0
data/docs/AzureSTT.html +305 -0
data/docs/AzureSTT/Client.html +1008 -0
data/docs/AzureSTT/Configuration.html +282 -0
data/docs/AzureSTT/Error.html +305 -0
data/docs/AzureSTT/Models.html +135 -0
data/docs/AzureSTT/Models/Base.html +139 -0
data/docs/AzureSTT/Models/CombinedRecognizedPhrases.html +538 -0
data/docs/AzureSTT/Models/File.html +794 -0
data/docs/AzureSTT/Models/RecognizedPhrase.html +769 -0
data/docs/AzureSTT/Models/Report.html +384 -0
data/docs/AzureSTT/Models/Result.html +796 -0
data/docs/AzureSTT/Models/Sentence.html +615 -0
data/docs/AzureSTT/Models/Transcription.html +1415 -0
data/docs/AzureSTT/Models/Word.html +615 -0
data/docs/AzureSTT/NetError.html +159 -0
data/docs/AzureSTT/Parsers.html +128 -0
data/docs/AzureSTT/Parsers/Base.html +404 -0
data/docs/AzureSTT/Parsers/CombinedRecognizedPhrases.html +156 -0
data/docs/AzureSTT/Parsers/File.html +156 -0
data/docs/AzureSTT/Parsers/RecognizedPhrase.html +156 -0
data/docs/AzureSTT/Parsers/Report.html +156 -0
data/docs/AzureSTT/Parsers/Result.html +156 -0
data/docs/AzureSTT/Parsers/Sentence.html +156 -0
data/docs/AzureSTT/Parsers/Transcription.html +156 -0
data/docs/AzureSTT/Parsers/Word.html +156 -0
data/docs/AzureSTT/ServiceError.html +159 -0
data/docs/AzureSTT/Session.html +767 -0
data/docs/AzureSTT/Transcription.html +635 -0
data/docs/AzureSTT/Types.html +116 -0
data/docs/AzureStt_.html +121 -0
data/docs/_index.html +392 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +497 -0
data/docs/file.README.html +201 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +201 -0
data/docs/js/app.js +314 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +707 -0
data/docs/top-level-namespace.html +110 -0
data/env.sample +2 -0
data/lib/azure_stt.rb +20 -0
data/lib/azure_stt/client.rb +189 -0
data/lib/azure_stt/configuration.rb +28 -0
data/lib/azure_stt/errors.rb +25 -0
data/lib/azure_stt/models.rb +30 -0
data/lib/azure_stt/models/base.rb +27 -0
data/lib/azure_stt/models/combined_recognized_phrases.rb +48 -0
data/lib/azure_stt/models/file.rb +72 -0
data/lib/azure_stt/models/recognized_phrase.rb +70 -0
data/lib/azure_stt/models/report.rb +31 -0
data/lib/azure_stt/models/result.rb +76 -0
data/lib/azure_stt/models/sentence.rb +53 -0
data/lib/azure_stt/models/transcription.rb +185 -0
data/lib/azure_stt/models/word.rb +54 -0
data/lib/azure_stt/parsers.rb +19 -0
data/lib/azure_stt/parsers/base.rb +42 -0
data/lib/azure_stt/parsers/combined_recognized_phrases.rb +28 -0
data/lib/azure_stt/parsers/file.rb +28 -0
data/lib/azure_stt/parsers/recognized_phrase.rb +45 -0
data/lib/azure_stt/parsers/report.rb +25 -0
data/lib/azure_stt/parsers/result.rb +56 -0
data/lib/azure_stt/parsers/sentence.rb +45 -0
data/lib/azure_stt/parsers/transcription.rb +34 -0
data/lib/azure_stt/parsers/word.rb +28 -0
data/lib/azure_stt/session.rb +100 -0
data/lib/azure_stt/version.rb +5 -0
metadata +158 -0

data/docs/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.26
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span>, <span class='object_link'><a href="AzureStt_.html" title="AzureStt (module)">AzureStt</a></span>
+</p>
+</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).
+</div>
+    </div>
+  </body>
+</html>

data/env.sample ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ REGION=centralus
2	+ SUBSCRIPTION_KEY=k3ah8ztrc4ojeh98r05zh7v6x9w62lqp

data/lib/azure_stt.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+#
+# Top level module for AzureSTT
+#
+module AzureSTT
+end
+require_relative 'azure_stt/version'
+require_relative 'azure_stt/configuration'
+require_relative 'azure_stt/errors'
+require_relative 'azure_stt/client'
+require_relative 'azure_stt/models'
+require_relative 'azure_stt/parsers'
+require_relative 'azure_stt/session'
+AzureSTT.configure do |config|
+  config.subscription_key = ENV['SUBSCRIPTION_KEY']
+  config.region = ENV['REGION']
+end

data/lib/azure_stt/client.rb ADDED Viewed

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+require 'httparty'
+module AzureSTT
+  #
+  # Client class that uses HTTParty to communicate with the API
+  #
+  class Client
+    include HTTParty
+    attr_reader :region, :subscription_key
+    #
+    # Initialize the client
+    #
+    # @param [String] subscription_key Cognitive Services API Key
+    # @param [String] region The region of your resources
+    #
+    def initialize(region:, subscription_key:)
+      @subscription_key = subscription_key
+      @region = region
+      self.class.base_uri "https://#{region}.api.cognitive.microsoft.com/speechtotext/v3.0"
+    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
+    #
+    # @param [Hash] args
+    #
+    # @return [Hash] The JSON body response, parsed by HTTParty
+    #
+    def create_transcription(**args)
+      results = post(
+        '/transcriptions',
+        args.to_json
+      )
+      results.parsed_response
+    end
+    #
+    # Get a transcription by giving it's id
+    #
+    # @param [String] id The identifier of the transcription
+    #
+    # @return [Hash] The JSON body response, parsed by HTTParty
+    #
+    def get_transcription(id)
+      results = get("/transcriptions/#{id}")
+      results.parsed_response
+    end
+    #
+    # Get an Array of all the transcriptions
+    #
+    # @param [Integer] skip Number of transcriptions that will be skipped (optional)
+    # @param [Integer] top Number of transcriptions that will be included (optional)
+    #
+    # @return [Array[Hash]] Array of all the transcriptions. The transcriptions
+    # are Hashes parsed by HTTParty.
+    #
+    def get_transcriptions(skip: nil, top: nil)
+      results = get(
+        '/transcriptions',
+        {
+          skip: skip,
+          top: top
+        }.compact
+      )
+      results.parsed_response['values']
+    end
+    #
+    # 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
+    #
+    # @param [Integer] id The identifier of the transcription
+    #
+    # @return [Array[Hash]] Array of the files of a transcription
+    #
+    def get_transcription_files(id)
+      results = get("/transcriptions/#{id}/files")
+      results.parsed_response['values']
+    end
+    #
+    # Read a JSON file and parse it.
+    #
+    # @param [String] file_url The url of the content
+    #
+    # @return [Hash] the file parsed
+    #
+    def get_file(file_url)
+      response = self.class.get(file_url)
+      results = handle_response(response)
+      results.parsed_response
+    end
+    private
+    #
+    # Make a post request by giving a path and a body
+    #
+    # @param [String] path the path, which is added to the base_uri
+    # @param [String] body the body of the request
+    #
+    # @return [HTTParty::Response]
+    #
+    def post(path, body)
+      options = {
+        headers: headers,
+        body: body
+      }
+      response = self.class.post(path, options)
+      handle_response(response)
+    end
+    #
+    # Make a get request to the API.
+    #
+    # @param [String] path the path, which is added to the base_uri
+    # @param [Hash] parameters The parameters you want to add to the headers (empty by default)
+    #
+    # @return [HTTParty::Response]
+    #
+    def get(path, parameters = {})
+      options = {
+        headers: headers.merge(parameters)
+      }.compact
+      response = self.class.get(path, options)
+      handle_response(response)
+    end
+    #
+    # Handle the HTTParty::Response. If an error occured, an exception will be
+    # raised.
+    #
+    # @param [HTTParty] response The response received from the API
+    #
+    # @return [<Type>] <description>
+    #
+    # @raise [ServiceError] if an error occured from the API, for instance if
+    # subscription_key is invalid.
+    #
+    # @raise [NetError] if the server has not been reached
+    #
+    def handle_response(response)
+      case response.code
+      when 200..299
+        response
+      else
+        if response.request.format == :json
+          raise ServiceError.new(
+            code: response.code,
+            message: response.response.message
+          )
+        else
+          raise NetError.new(
+            code: response.code,
+            message: response.response.message
+          )
+        end
+      end
+    end
+    #
+    # The header needed to make a request
+    #
+    # @return [Hash]
+    #
+    def headers
+      {
+        'Ocp-Apim-Subscription-Key' => subscription_key,
+        'Content-Type' => 'application/json'
+      }
+    end
+  end
+end

data/lib/azure_stt/configuration.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module AzureSTT
+  #
+  # Configurator pattern to be able to change the subscription key. By default
+  # the key is in a .env file
+  #
+  class Configuration
+    attr_accessor :subscription_key, :region
+  end
+  #
+  # Get the configuration for AzureSTT
+  #
+  # @return [Configuration]
+  #
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  #
+  # Modify the configuration
+  #
+  def self.configure
+    yield configuration
+    @client = nil
+  end
+end

data/lib/azure_stt/errors.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module AzureSTT
+  #
+  # Top level error for AzureSTT specific errors
+  #
+  class Error < StandardError
+    attr_reader :code
+    def initialize(code:, message:)
+      @code = code
+      super("#{message} (#{code})")
+    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
+end

data/lib/azure_stt/models.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'dry-struct'
+module AzureSTT
+  #
+  # Module for the models. Those models use dry-struct.
+  #
+  # @see https://dry-rb.org/gems/dry-struct/
+  #
+  module Models
+  end
+  #
+  # Include Dry.Types()
+  #
+  module Types
+    include Dry.Types()
+  end
+end
+require_relative 'models/base'
+require_relative 'models/file'
+require_relative 'models/report'
+require_relative 'models/combined_recognized_phrases'
+require_relative 'models/word'
+require_relative 'models/sentence'
+require_relative 'models/recognized_phrase'
+require_relative 'models/result'
+require_relative 'models/transcription'

data/lib/azure_stt/models/base.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module AzureSTT
+  module Models
+    #
+    # Base class for the models
+    #
+    class Base < Dry::Struct
+      # throw an error when unknown keys provided
+      schema schema.strict
+      # convert string keys to symbols
+      transform_keys(&:to_sym)
+      # resolve default types on nil
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
+    end
+  end
+end

data/lib/azure_stt/models/combined_recognized_phrases.rb ADDED Viewed

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module AzureSTT
+  module Models
+    #
+    # Model class for the combinedRecognizedPhrases field in the results of
+    # the transcriptions
+    #
+    class CombinedRecognizedPhrases < Base
+      #
+      # The channel of the combination. The API supports only two channels, so
+      # it is 0 or 1
+      #
+      # @!attribute [r] channel
+      #   @return [Types::Coercible::Integer]
+      attribute :channel, Types::Coercible::Integer
+      #
+      # The lexical field
+      #
+      # @!attribute [r] lexical
+      #   @return [Types::Coercible::String]
+      attribute :lexical, Types::Coercible::String
+      #
+      # The itn field
+      #
+      # @!attribute [r] itn
+      #   @return [Types::Coercible::String]
+      attribute :itn, Types::Coercible::String
+      #
+      # The maskedITN field
+      #
+      # @!attribute [r] masked_itn
+      #   @return [Types::Coercible::String]
+      attribute :masked_itn, Types::Coercible::String
+      #
+      # The display field. Displays the text with the format you specified in
+      # the paramters of the transcription.
+      #
+      # @!attribute [r] transcript
+      #   @return [Types::Coercible::String]
+      attribute :transcript, Types::Coercible::String
+    end
+  end
+end