yandex_speech_api 1.1.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 503bb8b1169230590382c2bed35232e8c8b0ad8c
-  data.tar.gz: b4e5a11c0494ff5b43a3831a44427d7a0b75d26a
+  metadata.gz: 4803f68de7df8f2a7e56b0d066856deef1ee102e
+  data.tar.gz: 258e60515cd83dca48d9bc20312c45e43e600d57
 SHA512:
-  metadata.gz: 08aedbd6436613262ce70410b9c5b9f0b476dd6a6dd1758f9531a7064518d5827854832c7e9afe8a2cbd1a82f66c5bd436a888377c03ad7ce3a574f2179e5c4a
-  data.tar.gz: caecae0b89060595daf24261389e533f67712b48a976da40067d58e11688212ce70a95d42f6208eb3738757e6fd2bfb74d342352a416e0a017fe25d783c54b73
+  metadata.gz: 7225076cb91d407f43ca9e6dd21032c521cedc5524bbace603804343260d6628f6757e58db9e5c8b56942b8c7c8e920ced52442911b0caeac3afe1b2888a53db
+  data.tar.gz: 3df6e6b517c3ef5b45226b2ededb5af7dee29d7cf72896adcf9febc14b711a8b1ce23f3ce6324ac1d35ed4568b4cc55b98b287b05e7e294cce9a6ced175eae0a

data/Gemfile

@@ -11,6 +11,11 @@ group :development do
   gem 'rspec',                          '~> 3.5.0'
 end
 
+group :guard do
+  gem 'rb-readline',                    '~> 0.5.3', require: false
+  gem 'guard-rspec',                    '~> 4.7.3', require: false
+end
+
 group :test do
   gem 'coveralls', require: false
 end

data/README.md

@@ -1,101 +1,55 @@
-# 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 достаточно указать ключ:_
+# 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?branch=master)](https://coveralls.io/github/Medvedu/Yandex-Speech-API?branch=master)
+  
+## Description
+  Converts English, Ukrain, Russian or Turkey text to speech. Solution based on Yandex SpeechKit Cloud technology.
+  
+## About Key
+  
+  Before usage you need to get an api key.
+  Official site: https://developer.tech.yandex.ru (look for SpeechKit Cloud key)
+
+## Usage
 
 ```ruby
-key = File.open('secret key/key').readline.strip
-
-speaker = YandexSpeechApi::Speaker.init key: key, language: 'russian'
-speaker.save_to_file "Не будите спящего кота."
+  require 'yandex_speech'
+  
+  key = File.open('secret key/key').readline.strip
+  
+  speaker = YandexSpeechApi::Speaker.new 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
+```ruby 
+  YandexSpeechApi.key = File.open('secret key/key').readline.strip
+  
+  message = "Don't trouble trouble until trouble troubles you"
+  speaker = YandexSpeechApi::Speaker.new voice: :zahar, speed: 1.1
+  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'
+  key = File.open('secret key/key').readline.strip
+  message = 'one two three. one two three. one two three four.'
+  
+  speaker = YandexSpeechApi::Speaker.new do |s|
+    s.key      = key
+    s.voice    = :jane
+    s.language = :english
+    s.emotion  = :good
+  end
+  
+  speaker.say message
 ```
+  
+## Notes
 
-### Пример 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 или выше
+2000 symbols per request.
 
-### Linux-специфичные зависимости:
+## Dependencies
 
+* Ruby 2.0.0 or higher. 
 * mpg123
 
-## Лицензия
+## License
 
-Данный код распространяется под лицензией MIT, подробнее смотрите [LICENSE](./LICENSE). Остальные права принадлежат их владельцам.
+Released under the MIT License. See the [LICENSE](./LICENSE) file for further details.

data/lib/yandex_speech.rb

@@ -10,32 +10,31 @@
 # @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.
+
+  # Speaker is a class that convert English, Ukrain, Russian or Turkey text to
+  # speech. Solution based on Yandex SpeechKit Cloud technology.
   #
   # @example Basic usage
   #   key = File.open('secret key/key').readline.strip
   #
-  #   speaker = YandexSpeechApi::Speaker.init key: key, language: 'russian'
-  #   speaker.save_to_file "Не будите спящего кота."
+  #   speaker = YandexSpeechApi::Speaker.new 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 })
+  #   message = "Don't trouble trouble until trouble troubles you"
+  #   speaker = YandexSpeechApi::Speaker.new voice: :zahar, speed: 1.1
   #   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|
+  #   speaker = YandexSpeechApi::Speaker.new do |s|
   #     s.key      = key
   #     s.voice    = :jane
   #     s.language = :english
-  #     s.speed    = :slow
   #     s.emotion  = :good
   #   end
   #   speaker.say message
@@ -43,63 +42,48 @@ module YandexSpeechApi
   # 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.
-  #
+  # You can get the key from official site:
+  #   https://developer.tech.yandex.ru (SpeechKit Cloud key)
+
+  class << self
+    ##
+    # Authorization key, overrides Speaker.key when used. Optional.
+    #
+    # @return [String, NilClass]
+
+    attr_accessor :key
+  end # class << self
+
   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
+    include Setters
+
+    # @return [String, NilClass]
+
+    def key
+      YandexSpeechApi.key || @key
+    end
 
     ##
-    # Determines dictor speech speed.
+    # Dictor speech speed.
     #
-    # @return [Speed]
+    # @return [Float]
+    #   Any from those - (0.1)..3
 
     attr_reader :speed
 
     ##
     # Preferred dictor voice.
     #
-    # @return [Voice]
+    # @return [Symbol]
+    #  Any from those: :jane, :oksana, :alyss, :omazh, :zahar, :ermil
 
     attr_reader :voice
 
     ##
     # How emotional dictor should speak.
     #
-    # @return [Emotion]
+    # @return [String]
+    #  Any from those: "good", "evil", "neutral"
 
     attr_reader :emotion
 
@@ -108,9 +92,10 @@ module YandexSpeechApi
     #
     #   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)
+    #   recommend to select correct language for text)
     #
-    # @return [Language]
+    # @return [String]
+    #   Any from those: "russian", "english", "ukrain", "turkey"
 
     attr_reader :language
 
@@ -120,72 +105,30 @@ module YandexSpeechApi
     #   Do not use +:wav+ format for large texts. Result audio file will be
     #   too big, and service truncates resulted file.
     #
-    # @return [Format]
+    # @return [Symbol]
+    #  Any from those: "mp3", "wav", "opus"
 
     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
+    # @param [Proc] callback
+    #   Used to set object attributes through {do...end} block.
     #
-    # @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
+    # @return [YandexSpeechApi::Speaker]
+
+    def initialize(settings = {}, &callback)
+      yield self if block_given?
+
+      self.key = settings[:key]
+
+      self.voice    ||= settings[:voice]    || "jane"
+      self.speed    ||= settings[:speed]    || 1.0
+      self.emotion  ||= settings[:emotion]  || "good"
+      self.language ||= settings[:language] || "english"
+      self.format   ||= settings[:format]   || "mp3"
     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
+    # Speaks the text
     #
     # @param [String] text
     #   Something that should been said.
@@ -194,16 +137,9 @@ module YandexSpeechApi
     #   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
+      self.format = :mp3
+      row_data = request text
+      Sounds.play row_data
 
       return nil
     end
@@ -211,19 +147,10 @@ module YandexSpeechApi
     ##
     # 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).
+    # @param [String] path_to_file (Dir.pwd)
     #
     # @return [String]
     #   Absolute path to created file.
@@ -231,23 +158,11 @@ module YandexSpeechApi
     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 }
+      row_data = request text
+      absolute_path = "#{File.expand_path(path_to_file)}.#{format}"
+      File.open(absolute_path, 'w') { |f| f.write row_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