yandex_speech_api 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 503bb8b1169230590382c2bed35232e8c8b0ad8c
+  data.tar.gz: b4e5a11c0494ff5b43a3831a44427d7a0b75d26a
+SHA512:
+  metadata.gz: 08aedbd6436613262ce70410b9c5b9f0b476dd6a6dd1758f9531a7064518d5827854832c7e9afe8a2cbd1a82f66c5bd436a888377c03ad7ce3a574f2179e5c4a
+  data.tar.gz: caecae0b89060595daf24261389e533f67712b48a976da40067d58e11688212ce70a95d42f6208eb3738757e6fd2bfb74d342352a416e0a017fe25d783c54b73

data/Gemfile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gemspec
+
+group :development do
+  gem 'webmock',                        '~> 2.3.1'
+  gem 'rspec',                          '~> 3.5.0'
+end
+
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) <2016> Kuzichev Michael
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# YandexSpeechApi [![Gem Version](https://badge.fury.io/rb/yandex_speech_api.svg)](https://badge.fury.io/rb/yandex_speech_api) [![Build Status](https://travis-ci.org/Medvedu/Yandex-Speech-API.svg?branch=master)](https://travis-ci.org/Medvedu/Yandex-Speech-API) [![Code Climate](https://codeclimate.com/github/Medvedu/Yandex-Speech-API/badges/gpa.svg)](https://codeclimate.com/github/Medvedu/Yandex-Speech-API) [![Inline docs](http://inch-ci.org/github/Medvedu/Yandex-Speech-API.svg?branch=master)](http://inch-ci.org/github/Medvedu/Yandex-Speech-API) [![Coverage Status](https://coveralls.io/repos/github/Medvedu/Yandex-Speech-API/badge.svg)](https://coveralls.io/github/Medvedu/Yandex-Speech-API)
+
+## Описание
+
+Wrapper для синтезатора речи, основанного на технологиях Yandex SpeechKit Cloud API.  Предоставляет собой интерфейс для перевода машинного текста (на русском,  английском, украинском или турецком язык) в речь. Может использоваться как для прямого  воспроизведения текста, так и для записи речи в файл.
+
+## Установка
+
+1. Перед использованием необходимо получить ключ разработчика. Подробнее на официальном сайте: https://tech.yandex.ru/speechkit/cloud
+2. Добавьте yandex_speech_api в Gemfile.
+3. bundle install 
+4. Добавьте в проект:
+
+```ruby
+  # ...
+  require 'yandex_speech'  
+  # ... 
+````
+
+Воспроизведение звука поддерживается для UNIX-подобных операционных систем (Mac + Linux). 
+
+### Примеры использования
+
+### Пример 1
+
+_Для начала работы с api достаточно указать ключ:_
+
+```ruby
+key = File.open('secret key/key').readline.strip
+
+speaker = YandexSpeechApi::Speaker.init key: key, language: 'russian'
+speaker.save_to_file "Не будите спящего кота."
+```
+
+### Пример 2
+
+_Когда это неоходимо, конструктор позволяет переписывать параметры по умолчанию, например, так можно выбрать язык:_
+
+```ruby
+YandexSpeechApi::Key.global_key = File.open('secret key/key').readline.strip
+
+message = "Don't trouble trouble until trouble troubles you"
+speaker = YandexSpeechApi::Speaker.init(voice: :zahar, speed: 0.23)
+speaker.say message
+```
+
+Обратите внимание, передавать key каждый раз нет никакой необходимости. Достаточно один раз установить YandexSpeechApi::Key.global_key.  
+
+### Пример 3
+
+_Также поддерживаются геттеры и сеттеры:_
+
+```ruby
+key = File.open('secret key/key').readline.strip
+
+message = "Як поїдеш в об'їзд, то будеш і на обід, а як навпростець, то увечері."
+
+speaker = YandexSpeechApi::Speaker.init
+speaker.key      = key
+speaker.voice    = 'Alyss'
+speaker.language = 'Ukrain'
+speaker.speed    = 1.2
+speaker.emotion  = 'good'
+speaker.save_to_file message, '~/downloads/sound'
+```
+
+### Пример 4
+
+_И, наконец, установка параметров через блок:_
+
+```ruby
+key = File.open('secret key/key').readline.strip
+message = "one two three. one two three. one two three four."
+
+speaker = YandexSpeechApi::Speaker.init do |s|
+  s.key      = key
+  s.voice    = :jane
+  s.language = :english
+  s.speed    = :slow
+  s.emotion  = :good
+end
+
+speaker.say message
+```
+
+## Примечания
+
+1. За один запрос озвучивается текст, длинной до 2000 знаков.
+2. Выбирая язык, учтите: вы ограничены его фонетикой, так, например, английский переводчик не умеет озвучивать русские тексты и т.п. (На самом деле это не совсем точно — хотя официальная документация и не рекомендует выставлять некорректные пары язык-текст, в то же время, _русский_ переводчик фактически может воспроизводить английские тексты)
+
+## Зависимости
+
+* Ruby 2.0.0 или выше
+
+### Linux-специфичные зависимости:
+
+* mpg123
+
+## Лицензия
+
+Данный код распространяется под лицензией MIT, подробнее смотрите [LICENSE](./LICENSE). Остальные права принадлежат их владельцам.

data/lib/yandex_speech.rb

@@ -0,0 +1,253 @@
+# encoding: utf-8
+# frozen_string_literal: true
+#
+# Wrapper for Yandex Speech API (https://tech.yandex.ru/speechkit).
+#
+# @see https://github.com/Medvedu/Yandex-Speech-API
+# @see README.md
+#
+# @author Kuzichev Michael
+# @license MIT
+module YandexSpeechApi
+  require_relative 'yandex_speech/project_structure'
+  #
+  # Speaker a class that convert English, Ukrain, Russian or Turkey text to
+  # speech. Solution based on Yandex SpeechKit technology.
+  #
+  # @example Basic usage
+  #   key = File.open('secret key/key').readline.strip
+  #
+  #   speaker = YandexSpeechApi::Speaker.init key: key, language: 'russian'
+  #   speaker.save_to_file "Не будите спящего кота."
+  #
+  # @example Hash syntax
+  #   key = File.open('secret key/key').readline.strip
+  #   message = "Don't trouble trouble until trouble troubles you"
+  #
+  #   speaker = YandexSpeechApi::Speaker.init({ key: key, language: 'english', voice: :zahar, speed: 0.23 })
+  #   speaker.say message
+  #
+  # @example Block syntax
+  #   key = File.open('secret key/key').readline.strip
+  #   message = "one two three. one two three. one two three four."
+  #
+  #   speaker = YandexSpeechApi::Speaker.init do |s|
+  #     s.key      = key
+  #     s.voice    = :jane
+  #     s.language = :english
+  #     s.speed    = :slow
+  #     s.emotion  = :good
+  #   end
+  #   speaker.say message
+  #
+  # Before usage you need to get an api key. It is free for non-commercial
+  # purposes (at least for now).
+  #
+  # You can get this key from official site: https://tech.yandex.ru/speechkit
+  #
+  # Note: Yandex provide many services throw this site. Your need exactly
+  # +Yandex SpeechKit Cloud+ key. Other keys will not work!
+  #
+  # Do not share this key to third party.
+  #
+  class Speaker
+    class << self
+      ##
+      # Creates +Speaker+ instance.
+      #
+      # @param [Proc] callback
+      #   Used to set object state throw {do ... end} block.
+      #
+      # @param [HASH] settings
+      #   Overrides default settings.
+      # @option settings [Symbol] :speed (:standard)
+      #   @see Speaker#speed for details.
+      # @option settings [Symbol] :voice (:alyss)
+      #   @see Speaker#voice for details.
+      # @option settings [Symbol] :emotion (:neutral)
+      #   @see Speaker#emotion for details.
+      # @option settings [Symbol] :language (:english)
+      #   @see Speaker#language for details.
+      # @option settings [Symbol] :format (:mp3)
+      #   @see Speaker#format for details.
+      # @option settings [Symbol] :key (:unknown)
+      #   @see Speaker#key for details.
+      #
+      # @return [YandexSpeech]
+
+      def init(settings = {}, &callback)
+        new settings, &callback
+      end
+    end # class << self
+
+    private_class_method :new
+
+    ##
+    # Determines dictor speech speed.
+    #
+    # @return [Speed]
+
+    attr_reader :speed
+
+    ##
+    # Preferred dictor voice.
+    #
+    # @return [Voice]
+
+    attr_reader :voice
+
+    ##
+    # How emotional dictor should speak.
+    #
+    # @return [Emotion]
+
+    attr_reader :emotion
+
+    ##
+    # Speaker language.
+    #
+    #   Speaker with +russian+ language can't translate, or even synthesize
+    #   +english+ text (actually it can, but official documentation strongly
+    #   recommend to select right language for incoming text)
+    #
+    # @return [Language]
+
+    attr_reader :language
+
+    ##
+    # How remote server should decode audio data for us.
+    #
+    #   Do not use +:wav+ format for large texts. Result audio file will be
+    #   too big, and service truncates resulted file.
+    #
+    # @return [Format]
+
+    attr_reader :format
+
+    ##
+    # Defines setters for +@voice+, +@language+,+@format+, +@emotion+,
+    # +@speed+, +@key+ attributes.
+    #
+    # @setter #speed=(other)
+    #   @param [Symbol, Integer, Float] other
+    #     Expecting values are
+    #       :slowest, :slow, :standard, :fast, :fastest
+    #       or any Integer/Float from (0.1)..3 range.
+    #
+    # @setter #voice=(other)
+    #   @param [Symbol] other
+    #     Expecting values are
+    #       :jane, :oksana, :alyss, :omazh, :zahar, :ermil
+    #
+    # @setter #emotion=(other)
+    #   @param [Symbol] other
+    #     Expecting values are
+    #       :good, :evil, :neutral
+    #
+    # @setter #language=(other)
+    #   @param [Symbol] other
+    #     Expecting values are
+    #       :russian, :english, :ukrain, :turkey
+    #
+    # @setter #format=(other)
+    #   @param [Symbol] other
+    #     Expecting values are
+    #       :mp3, :wav, :opus
+    #
+    # @setter #key=(new_key)
+    #   @param [String] new_key
+
+    %i(voice language format emotion speed key).each do |symbol|
+      define_method "#{symbol}=" do |other|
+        method_name = __method__.to_s.chop
+        klass = YandexSpeechApi.const_get method_name.capitalize
+        variable =
+          if other.is_a? klass
+            other
+          else
+            klass.new(other)
+          end
+        instance_variable_set "@#{method_name}", variable
+      end
+    end
+
+    ##
+    # Speeches text.
+    #
+    # @example #Say usage
+    #   key = File.open('secret key/key').readline.strip
+    #   message = "one two three. one two three. one two three four."
+    #
+    #   speaker = YandexSpeechApi::Speaker.init do |s|
+    #     s.key      = key
+    #     s.voice    = :jane
+    #     s.language = :english
+    #     s.speed    = :slow
+    #     s.emotion  = :good
+    #   end
+    #   speaker.say message
+    #
+    # @param [String] text
+    #   Something that should been said.
+    #
+    # @return [NilClass]
+    #   You hear the sound.
+
+    def say(text)
+      format = Format.new :mp3
+      binary_data = request text, format: format
+
+      file = Tempfile.new ['yandex_speech_temp_file', ".#{format.type}"]
+      file.write binary_data
+
+      player = MP3_Player.init
+      player.play file.path
+
+      file.close(true) if file
+
+      return nil
+    end
+
+    ##
+    # Saves synthesized voice to audio-file.
+    #
+    # If +path_to_file+ is empty it saves audio-file to '~/downloads'
+    #
+    # @example #save_to_file usage
+    #   key = File.open('secret key/key').readline.strip
+    #
+    #   speaker = YandexSpeechApi::Speaker.init key: key, language: 'russian'
+    #   speaker.save_to_file "Не будите спящего кота.", 'let_cat_sleep'
+    #
+    # @param [String] text
+    #   Something that should been said.
+    #
+    # @param [String] path_to_file ('~/downloads')
+    #   Path to new file (without file extension).
+    #
+    # @return [String]
+    #   Absolute path to created file.
+
+    def save_to_file(text, path_to_file = '')
+      path_to_file = generate_path if path_to_file.empty?
+
+      binary_data = request text
+      absolute_path = "#{File.expand_path(path_to_file)}.#{format.type}"
+      File.open(absolute_path, 'w') { |f| f.write binary_data }
+
+      return absolute_path
+    end
+
+    private
+
+    ##
+    # Yandex Speech ApiKey.
+    #
+    # Key is not something that should be shared with any other class. Setter
+    # method is public anyway.
+    #
+    # @return [Key]
+
+    attr_reader :key
+  end # class Speaker
+end # module YandexSpeechApi

data/lib/yandex_speech/connection.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  module Connection # no-doc
+    class << self
+
+      ##
+      # Sends :get request.
+      #
+      # @param [Hash] params
+      # @option params [String] :text
+      # @option params [Symbol] :format
+      # @option params [String] :lang
+      # @option params [String] :speaker
+      # @option params [Symbol] :emotion
+      # @option params [Float]  :speed
+      # @option params [String, Symbol] :key
+      #
+      # @exception ConnectionError
+      #   Raised when responce is not successful.
+      #
+      # @return [String]
+      #   Binary data.
+
+      def send(**params)
+        uri = URI.parse URL
+        uri.query = URI.encode_www_form params
+        response = Net::HTTP.get_response uri
+
+        case response
+        when Net::HTTPSuccess
+          return response.body
+        else
+          raise ConnectionError.new response.code, response.message
+        end
+      end
+
+      private
+
+      ##
+      # YandexAPI endpoint.
+
+      URL = "https://tts.voicetech.yandex.net/generate"
+    end # class << self
+
+    ##
+    # Raised when connection failed.
+
+    class ConnectionError < YandexSpeechError
+      def initialize(code, message); super "Connection refused by remote server. Error code: '#{code}', Exception message: '#{message}'." end; end
+  end # module Connection
+end # module YandexSpeechApi

data/lib/yandex_speech/emotion.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  class Emotion
+
+    ##
+    # List of allowed emotions
+    #
+    # @return [Array<String>]
+
+    def self.list
+      %i(evil good neutral)
+    end
+
+    #
+    # @return [Symbol]
+    #   possible values: :evil, :good or :neutral
+
+    attr_reader :type
+
+    def initialize(emotion)
+      @type = emotion.downcase.to_sym
+
+      raise EmotionNotAllowed, emotion unless emotion_known? @type
+    end
+
+    private
+
+    def emotion_known?(emotion)
+      Emotion.list.include? emotion
+    end
+
+    ##
+    # Raised when unknown emotion has been selected.
+
+    class EmotionNotAllowed < YandexSpeechError
+      def initialize(emotion); super "Emotion '#{emotion}' not allowed for usage. To see list of allowed emotions use Emotion#list" end; end
+  end # class Emotion
+end # module YandexSpeechApi