yandex_speech_api 1.1.2 → 1.4.0

data/lib/yandex_speech/connection.rb

@@ -2,51 +2,33 @@
 # 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
+    # @param [Hash] params
+    #
+    # @exception ConnectionError
+    #   Raised when responce is not successful.
+    #
+    # @return [String]
+    #   Response as binary data.
+
+    def self.send(**params)
+      uri = URI.parse(ENDPOINT_OFFICIAL)
+      uri.query = URI.encode_www_form params
+      response = Net::HTTP.get_response uri
+
+      unless response.is_a? Net::HTTPSuccess
+        raise ConnectionError.new(response.code, response.message)
       end
 
-      private
-
-      ##
-      # YandexAPI endpoint.
+      return response.body
+    end
 
-      URL = "https://tts.voicetech.yandex.net/generate"
-    end # class << self
+    ENDPOINT_OFFICIAL     = "https://tts.voicetech.yandex.net/generate"
+    #ENDPOINT_NON_OFFICIAL = "https://tts.voicetech.yandex.net/tts?&platform=web&application=translate"
 
-    ##
-    # Raised when connection failed.
+    private_constant :ENDPOINT_OFFICIAL
 
-    class ConnectionError < YandexSpeechError
+    class ConnectionError < StandardError
       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/project_structure.rb

@@ -2,29 +2,17 @@
 # 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)
+  def self.req(**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)
+  end; private_class_method :req
 
-  load files: %w(helpers mp3_player key language format voice emotion speed connection speaker)
+  req files: %w(setters sounds connection speaker)
 end # module YandexSpeechApi

data/lib/yandex_speech/setters.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  module Setters
+
+    def voice=(new_voice)
+      voice = new_voice.to_s.downcase
+      unless allowed_voices.include? voice
+        raise ArgumentError, "Unexpected voice: #{new_voice}"
+      end
+      @voice = voice
+    end
+
+    def speed=(new_speed)
+      unless allowed_range.cover? new_speed
+        raise ArgumentError, "Incorrect speech speed value: #{new_speed}"
+      end
+      @speed = new_speed.round(2)
+    end
+
+    def emotion=(new_emotion)
+      emotion = new_emotion.to_s.downcase
+      unless allowed_emotions.include? emotion
+        raise ArgumentError, "Unexpected emotion: #{new_emotion}"
+      end
+
+      @emotion = emotion
+    end
+
+    def language=(new_language)
+      @language = allowed_languages[new_language.to_s.downcase]
+
+      unless language
+        raise ArgumentError, "Unexpected language: #{new_language}"
+      end
+    end
+
+    def format=(new_format)
+      format = new_format.to_s.downcase
+      unless allowed_formats.include? format
+        raise ArgumentError, "Unknown parameter: #{new_format}"
+      end
+
+      @format = format
+    end
+
+    def key=(new_key)
+      @key = new_key.to_s if new_key
+    end
+
+    private
+
+    def allowed_emotions
+      %w(evil good neutral)
+    end
+
+    def allowed_voices
+      %w(jane oksana alyss omazh zahar ermil)
+    end
+
+    def allowed_languages
+      {
+        "english" => 'en-US',
+        "russian" => 'ru‑RU',
+        "turkey"  => 'tr-TR',
+        "ukrain"  => 'uk-UK'
+      }
+    end
+
+    def allowed_formats
+      %w(mp3 wav opus)
+    end
+
+    def allowed_range
+      0.1..3
+    end
+  end # module Validations
+end # module YandexSpeechApi

data/lib/yandex_speech/sounds.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  module Sounds
+
+    # @param [String] srs
+
+    def self.play(srs)
+      file = Tempfile.new 'yandex_speech_temp_file.mp3'
+      file << srs
+      file.close
+
+      case operation_system
+      when :linux
+        exec "mpg123 -q '#{file.path}'"
+      when :mac_os
+        exec "afplay '#{file.path}'"
+      end
+
+      file.unlink
+    end
+
+    # @return [Symbol]
+
+    def self.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; private_class_method :operation_system
+  end # module Sounds
+end # module YandexSpeechApi

data/lib/yandex_speech/speaker.rb

@@ -4,49 +4,21 @@ module YandexSpeechApi
   class Speaker
     private
 
-    #
-    # @param [Proc] callback
-    #   Used to set object attributes throw {do...end} block.
-    #
-    # @example Block syntax
-    #   key = 'Your secret key'
-    #   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
-    #
-    # @return [Speaker]
-
-    def initialize(settings, &callback)
-      yield self if block_given?
-
-      @key      ||= Key.new      settings[:key]       || :unknown
-      @voice    ||= Voice.new    settings[:voice]     || :jane
-      @speed    ||= Speed.new    settings[:speed]     || :standard
-      @emotion  ||= Emotion.new  settings[:emotion]   || :neutral
-      @language ||= Language.new settings[:language]  || :english
-      @format   ||= Format.new   settings[:format]    || :mp3
-    end
-
-    ##
-    # Prepares and sends request on Yandex Servers.
-    #
     # @param [String] text
     #   Something that should been said.
-    # @param [Hash] params
-    #   Overrides object settings (only for this request)
     #
     # @return [String]
 
-    def request(text, params = {})
-      tmp_params = generate_params_for_request text, params
-      Connection.send tmp_params
+    def request(text)
+      params = generate_params text
+
+      response = if key
+                   Connection.send params
+                 else
+                   raise StandardError, "Request cannot been completed without key."
+                 end
+
+      return response
     end
 
     ##
@@ -54,50 +26,37 @@ module YandexSpeechApi
     #
     # @param [String] text
     #
-    # @param [Hash] params ({})
-    # @option params [Format]   :format   (nil).
-    # @option params [Language] :language (nil).
-    # @option params [Voice]    :voice    (nil).
-    # @option params [Key]      :key      (nil).
-    # @option params [Emotion]  :emotion  (nil).
-    # @option params [Speed]    :speed    (nil).
-    #
     # @exception TextTooBig
     #   Raised when param +text+ too big (>2000 symbols)
     #
     # @return [Hash]
 
-    def generate_params_for_request(text, params = {})
-      tmp_text = text.dup.encode(Encoding::UTF_8, invalid: :replace,
-                                 undef: :replace, replace: '')
-      raise TextTooBig if tmp_text.length > 2000
+    def generate_params(text)
+      txt = text.dup.encode(Encoding::UTF_8, invalid: :replace,
+                            undef: :replace, replace: '')
+
+      if txt.length > 2000
+        raise TextTooBig, 'Text too big. Only 2000 symbols per request are allowed.'
+      end
 
       tmp = {
-        text:    tmp_text,
-        format:  params[:format]   ? params[:format].type   : format.type,
-        lang:    params[:language] ? params[:language].code : language.code,
-        speaker: params[:voice]    ? params[:voice].name    : voice.name,
-        key:     params[:key]      ? params[:key].get       : key.get,
-        emotion: params[:emotion]  ? params[:emotion].type  : emotion.type,
-        speed:   params[:speed]    ? params[:speed].value   : speed.value
+        text:    txt,
+        format:  format,
+        lang:    language,
+        speaker: voice,
+        key:     key,
+        emotion: emotion,
+        speed:   speed
       }
 
       return tmp
     end
 
-    def generate_path # no-doc
-      dir_path = File.join ENV['HOME'], 'downloads'
-
-      Dir.mkdir(dir_path) unless Dir.exist?(dir_path)
+    def generate_path
+      dir_path = Dir.pwd
       filename = "yandex_speech_audio_#{Time.now.strftime "%Y-%m-%d_%H-%M-%S"}"
 
       return File.join(dir_path, filename)
     end
-
-    ##
-    # Raised when user tries to #say too big text.
-
-    class TextTooBig < YandexSpeechError
-      def initialize; super 'Text message length limited by 2000 symbols per request' end; end
   end # class Speaker
 end # module YandexSpeechApi

data/spec/yandex_speech/mp3_player/base_spec.rb

@@ -2,10 +2,9 @@
 
 require 'spec_helper'
 
-
 module YandexSpeechApi
 module MP3_Player
-  describe Base do
+  describe Base do # no-doc
     context '#play' do
       it 'raises an exception when file not found' do
         expect{described_class.new.play('lalalala.')}

data/spec/yandex_speech_spec.rb

@@ -19,9 +19,10 @@ module YandexSpeechApi
                                         .each(&:unlink)
       end
 
+
       context "Speaker#save_to_file" do
         it 'saves audio-file' do
-          speaker = Speaker.init key: "xxxxx-xxxxx-xxxxx-xxxxx"
+          speaker = Speaker.new key: "xxxxx-xxxxx-xxxxx-xxxxx"
 
           path = speaker.save_to_file("Не будите спящего кота.",
                                       "spec/tmp/not_today")
@@ -30,9 +31,9 @@ module YandexSpeechApi
         end
 
         it 'works fine when global key is set' do
-          Key.global_key = "xxxxx-xxxxx-xxxxx-xxxxx"
+          described_class.key = "xxxxx-xxxxx-xxxxx-xxxxx"
 
-          bobby = Speaker.init
+          bobby = Speaker.new
           path_to_bob_file =
             bobby.save_to_file "Не будите спящего кота.", "spec/tmp/bobby"
 
@@ -43,57 +44,38 @@ module YandexSpeechApi
           expect_any_instance_of(Speaker).to receive(:generate_path)
             .and_return(File.join(TEMP_PATH, "bobby.mp3"))
 
-          bobby = Speaker.init(key: "xxxx")
+          bobby = Speaker.new(key: "xxxx")
           path_to_bob_file = bobby.save_to_file "Не будите спящего кота."
 
           expect(File.exist?(path_to_bob_file)).to be_truthy
         end
 
         it 'sets correct params for object when block syntax is used' do
-          jane = Speaker.init do |j|
+          jane = Speaker.new do |j|
             j.voice    = :jane
             j.language = :english
-            j.speed    = :slow
+            j.speed    = 1.2
             j.emotion  = :good
             j.format   = :opus
           end
 
-          expect(jane.voice.name).to    be_eql :jane
-          expect(jane.language.code).to be_eql 'en-US'
-          expect(jane.speed.value).to   be_eql 0.5
-          expect(jane.emotion.type).to  be_eql :good
-          expect(jane.format.type).to   be_eql :opus
+          expect(jane.voice).to    be_eql "jane"
+          expect(jane.language).to be_eql 'en-US'
+          expect(jane.speed).to    be_eql 1.2
+          expect(jane.emotion).to  be_eql "good"
+          expect(jane.format).to   be_eql "opus"
         end
 
         it 'sets correct params for object when hash syntax is used' do
-          jane = Speaker.init(voice: :jane, language: :english,
-                              speed: :slow, emotion: :good)
-
-          expect(jane.voice.name).to    be_eql :jane
-          expect(jane.language.code).to be_eql 'en-US'
-          expect(jane.speed.value).to   be_eql 0.5
-          expect(jane.emotion.type).to  be_eql :good
-        end
-      end # context "Speaker#save_to_file"
-
-      # ----------------------------------------------------
-
-      context "Speaker#say" do
-        it 'calls mp3 player' do
-          expect_any_instance_of(MP3_Player::Base).to receive(:play)
-
-          speaker = Speaker.init key: "xxxxx-xxxxx-xxxxx-xxxxx"
-          speaker.say("Не будите спящего кота.")
-        end
-
-        it 'raises an exception when text too long' do
-          speaker = Speaker.init key: "xxxxx-xxxxx-xxxxx-xxxxx"
-          phrase = 'some phrase' * 5000
+          jane = Speaker.new(voice: :jane, language: :english,
+                             speed: 1.2, emotion: :good)
 
-          expect{ speaker.say phrase }.to raise_exception Speaker::TextTooBig
+          expect(jane.voice).to    be_eql "jane"
+          expect(jane.language).to be_eql 'en-US'
+          expect(jane.speed).to    be_eql 1.2
+          expect(jane.emotion).to  be_eql "good"
         end
       end # context "Speaker#save_to_file"
-    end # context "Going to be tested with successful Net:HTTP requests"
 
     # ----------------------------------------------------
 
@@ -102,11 +84,12 @@ module YandexSpeechApi
         stub_request(:get, /https:\/\/tts.voicetech.yandex.net\/.*/)
           .to_return status: 400, body: "Unreachable body"
 
-          bobby = Speaker.init key: "xxxxx-xxxxx-xxxxx-xxxxx"
+          bobby = Speaker.new key: "xxxxx-xxxxx-xxxxx-xxxxx"
 
           expect{bobby.say "313"}
             .to raise_exception Connection::ConnectionError
         end
-    end # context "Going to be tested with failed Net:HTTP requests"
+      end # context "Going to be tested with failed Net:HTTP requests"
+    end # context
   end # describe YandexSpeechApi
 end # module YandexSpeechApi