yandex_speech_api 1.1.2

data/lib/yandex_speech/format.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  class Format
+
+    ##
+    # List of allowed formats
+    #
+    # @return [Array<String>]
+
+    def self.list
+      %i(mp3 wav opus)
+    end
+
+    # @return [Symbol]
+    #   possible values: :mp3, :wav or :opus
+
+    attr_reader :type
+
+    def initialize(format)
+      @type = format.downcase.to_sym
+
+      raise FormatNotAllowed, format unless format_known? @type
+    end
+
+    private
+
+    def format_known?(format)
+      Format.list.include? format
+    end
+
+    ##
+    # Raised when unknown format has been selected.
+
+    class FormatNotAllowed < YandexSpeechError
+      def initialize(format); super "Format '#{format}' not allowed for usage. To see list of allowed formats use Format#list" end; end
+  end # class Format
+end # module YandexSpeechApi

data/lib/yandex_speech/helpers.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  module Helpers
+
+    ##
+    # From what OS we launched?
+    #
+    # @example #1
+    #   recognize_operation_system # ==> :linux
+    #
+    # @example #2
+    #   recognize_operation_system # ==> :unknown
+    #
+    # @return [Symbol]
+    #   OS name
+
+    def self.recognize_operation_system
+      case RbConfig::CONFIG['host_os']
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        :windows
+      when /darwin|mac os/
+        :mac_os
+      when /linux/
+        :linux
+      else
+        :unknown
+      end
+    end
+
+    ##
+    # Searches pathname for executable +cmd+.
+    #
+    # @return [Pathname, NilClass]
+    #   Returns +Pathname+ if +cmd+ is present and executable.
+    #   If search unsuccessful it returns +nil+.
+
+    def self.find_executable(cmd)
+      possible_extensions = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        possible_extensions.each do |extension|
+          exe = Pathname.new(File.join(path, "#{cmd}#{extension}"))
+
+          return exe if exe.executable? && exe.file?
+        end
+      end
+
+      return nil # search unsuccessful
+    end
+  end # module Helpers
+end # module YandexSpeechApi

data/lib/yandex_speech/key.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  class Key
+    class << self
+
+      ##
+      # Sets global key.
+      #
+      # @param [Key, Symbol] new_key
+      #
+      # @exception InvalidGlobalKey
+      #   raised when +new_key+ param have unexpected class.
+
+      def global_key=(new_key)
+        key_tmp = new_key.is_a?(Key) ? new_key : Key.new(new_key)
+        raise InvalidGlobalKey, key_tmp unless key_tmp.present?
+        @global_key = key_tmp
+      end
+
+      ##
+      # @return [TrueClass, FalseClass]
+      #   True if global key set, otherwise returns false.
+
+      def global_key?
+        !!global_key
+      end
+
+      private
+
+      ##
+      # @return [Key, nil]
+
+      def global_key
+        @global_key
+      end
+    end # class << self
+
+    def initialize(key)
+      @instance_key = key
+    end
+
+    ##
+    # Returns an key.
+    #
+    # @exception KeyNotDefined
+    #   raised if both +instance key+ and +global key_ are not present
+    #
+    # @return [Key]
+
+    def get
+      if present?
+        return instance_key
+      elsif default?
+        return default.get
+      else
+        raise KeyNotDefined
+      end
+    end
+
+    ##
+    # Key present?
+    #
+    # @return [TrueClass, FalseClass]
+    #   returns +false+ if key is +:unknown+, otherwise - +true+.
+
+    def present?
+      !(instance_key == :unknown)
+    end
+
+    private
+
+    # @return [Symbol, String]
+    #   possible values: :unknown or some string
+
+    attr_reader :instance_key
+
+    ##
+    # @return [TrueClass, FalseClass]
+    #   @see Key#global_key?
+
+    def default?
+      Key.global_key?
+    end
+
+    ##
+    # @return [Key, nil]
+    #   see Key#global_key
+
+    def default
+      Key.instance_variable_get :@global_key
+    end
+
+    ##
+    # Raised when user tries to call #say method without key.
+
+    class KeyNotDefined < YandexSpeechError
+      def initialize; super "WARNING! You initialized Speaker class without key! It means you can not use YandexSpeechApi service. You can get your key there: https://tech.yandex.ru/speechkit" end; end
+
+    ##
+    # Raised when global key going to be set with default values.
+
+    class InvalidGlobalKey < YandexSpeechError
+      def initialize(key); super "Global key '#{key}' can not been nil or :unknown" end; end
+  end # class Key
+end # module YandexSpeechApi

data/lib/yandex_speech/language.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  class Language # no-doc
+
+    ##
+    # List of allowed languages
+    #
+    # @return [Array<Classes>]
+
+    def self.allowed_languages
+      @cached_list ||= Array(codes.keys)
+    end
+
+    def self.codes # no-doc
+      {
+        english: 'en-US',
+        russian: 'ru‑RU',
+        turkey:  'tr-TR',
+        ukrain:  'uk-UK',
+      }
+    end
+
+    # @return [Symbol]
+
+    attr_reader :language
+
+    # @return [String]
+
+    def code
+      @code ||= Language.codes[@language]
+    end
+
+    ##
+    # Creates new object instance.
+    #
+    # @param [String] language
+    #   Selected language.
+    #
+    # @exception UnknownLanguageError
+    #   Raised when language is unknown
+    #
+    # @return [Language]
+
+    def initialize(language)
+      @language = language.downcase.to_sym
+
+      unless Language.allowed_languages.include? @language
+        raise UnknownLanguageError, @language
+      end
+    end
+
+    ##
+    # Raised when unknown language has been selected.
+
+    class UnknownLanguageError < YandexSpeechError
+      def initialize(lang); super "Unknown language selected: '#{lang}'. See Language#allowed_languages for list of allowed languages" end; end
+  end # class Language
+end # module YandexSpeechApi

data/lib/yandex_speech/mp3_player.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  module MP3_Player
+
+    ##
+    # Creates MP3 player instance. Depends from OS.
+    #
+    # @exception UnknownOsError
+    #   raised when OS unknown.
+    #
+    # @return [Linux_MP3_Player, Mac_MP3_Player]
+
+    def self.init
+      @player ||=
+        case Helpers::recognize_operation_system
+        when :linux
+          Linux_MP3_Player.new
+        when :mac_os
+          Mac_MP3_Player.new
+        else
+          raise UnknownOs
+        end
+    end
+
+    ##
+    # Raised when MP3_Player#init can not recognize what operation system is
+    # used.
+
+    class UnknownOs < YandexSpeechError
+      def initialize; super "#{self.class}#recognize_operation_system cannot recognize your operation system!"; end; end
+  end # module Player
+end # module YandexSpeechApi

data/lib/yandex_speech/mp3_player/base.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+module MP3_Player
+  class Base # no-doc
+
+    ##
+    # Plays sound
+
+    def play(filename)
+      @filename = Pathname.new filename
+      validate_file_presence
+      validate_mp3_format
+      validate_requirements
+      play_mp3
+    end
+
+    private
+
+    attr_reader :filename # no-doc
+
+    ##
+    # no-doc
+
+    def validate_file_presence
+      raise FileNotFound, filename unless @filename.file?
+    end
+
+    ##
+    # Raises an exception if +filename+ without '.mp3' extension
+
+    def validate_mp3_format
+      unless File.extname(filename).casecmp('.mp3').zero?
+        raise UnknownExtension, filename
+      end
+    end
+
+    ##
+    # Play mp3
+    #
+    # @exception NotImplementedError
+    #   raised if #play_mp3 was called, but not overridden in any MP3_Player child
+
+    def play_mp3
+      raise NotImplementedError, "Abstract class called"
+    end
+
+    ##
+    # Validates OS requirements. Abstract
+    #
+    # @exception NotImplementedError
+    #   raised if #validate_requirements was called, but not overridden in any MP3_Player child
+
+    def validate_requirements
+      raise NotImplementedError, "Abstract class called"
+    end
+
+    ##
+    # Raised when +filename+ has wrong (not mp3) extension. Used to give
+    # minimal protection against files with unknown format.
+
+    class UnknownExtension < YandexSpeechError
+      def initialize(filename); super "Mp3 player can work only with files with '.mp3' extension. Please change extension for #{filename} if you sure that format is correct!'" end; end
+
+    ##
+    # Raised when file not found
+
+    class FileNotFound < YandexSpeechError
+      def initialize(file); super "File #{file} not found!" end; end
+ end # class Base
+end # module MP3_Player
+end # module YandexSpeechApi

data/lib/yandex_speech/mp3_player/linux_mp3_player.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+module MP3_Player
+  class Linux_MP3_Player < MP3_Player::Base # no-doc
+    private
+
+    # @return [String]
+    #   Path to +mpg123+ application
+
+    attr_reader :path_to_executable
+
+    ##
+    # Check requirements.
+    #
+    # @exception ApplicationNotInstalled
+    #   Raised if +mpg123+ not found.
+
+    def validate_requirements
+      @path_to_executable = Helpers::find_executable 'mpg123'
+
+      if path_to_executable.nil?
+        raise ApplicationNotInstalled , 'mpq123'
+      end
+    end
+
+    ##
+    # no-doc
+
+    def play_mp3
+      `#{path_to_executable} -q '#{filename}'`
+    end
+
+    ##
+    # Raised when necessary linux program not found.
+
+    class ApplicationNotInstalled < YandexSpeechError
+      def initialize(name); super "Program '#{name}' not found!" end; end
+    end # class Linux_MP3_Player
+end # module MP3_Player
+end # module YandexSpeechApi

data/lib/yandex_speech/mp3_player/mac_mp3_player.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+module MP3_Player
+  class Mac_MP3_Player < MP3_Player::Base
+
+    ##
+    # no-doc
+
+    def validate_requirements
+      nil
+    end
+
+    ##
+    # no-doc
+
+    def play_mp3
+      `afplay '#{filename}'`
+    end
+  end # class Mac_MP3_Player
+end # module MP3_Player
+end # module YandexSpeechApi

data/lib/yandex_speech/project_structure.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  # dependencies from core lib
+  require 'rbconfig'
+  require 'uri'
+  require 'net/http'
+
+  ##
+  # Core class for all exceptions that can be raised in YandexSpeechApi lib..
+
+  class YandexSpeechError < StandardError; end
+
+  # project structure
+
+  ##
+  # loads *.rb files in requested order
+
+  def self.load(**params)
+    params[:files].each do |f|
+      require File.join(__dir__, params[:folder].to_s, f)
+    end
+  end
+  private_class_method :load
+
+  load folder: 'mp3_player',
+       files:  %w(base mac_mp3_player linux_mp3_player)
+
+  load files: %w(helpers mp3_player key language format voice emotion speed connection speaker)
+end # module YandexSpeechApi