yandex_speech_api 1.1.2

data/lib/yandex_speech/speaker.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+# frozen_string_literal: true
+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
+    end
+
+    ##
+    # Generates params for request.
+    #
+    # @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
+
+      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
+      }
+
+      return tmp
+    end
+
+    def generate_path # no-doc
+      dir_path = File.join ENV['HOME'], 'downloads'
+
+      Dir.mkdir(dir_path) unless Dir.exist?(dir_path)
+      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/lib/yandex_speech/speed.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+  class Speed
+    class << self
+
+      # @example #1
+      #   list[:slow]      # ==> 0.5
+      #
+      # @example #2
+      #   list[:wrong_key] # ==> nil
+      #
+      # @return [Hash]
+
+      def modes
+        {
+          :slowest  => 0.1,  # minimal allowed speed
+          :slow     => 0.5,
+          :standard => 1.0,  # default
+          :fast     => 1.5,
+          :fastest  => 3.0   # maximal allowed speed
+        }
+      end
+    end # class << self
+
+    # @return [Float]
+    #   In range [(0.1)..3.0]
+
+    attr_reader :value
+
+    def initialize(speed)
+      @value = if speed.is_a? Numeric
+                 speed.round 2
+               else
+                 Speed.modes[speed.downcase.to_sym]
+               end
+
+      raise SpeedModeNotAllowed, speed if @value.nil?
+      raise SpeedValueNotInRange, @value unless speed_in_valid_range? @value
+    end
+
+    private
+
+    def speed_in_valid_range?(number)
+      number.between? 0.1, 3
+    end
+
+    ##
+    # Raised when speed mode is unknown.
+
+    class SpeedModeNotAllowed < YandexSpeechError
+      def initialize(speed); super "Speed '#{speed}' not allowed for usage. To see list of allowed formats use Emotion#list." end; end
+
+    ##
+    # Raised when +speed+ param is not in [(0.1)..3] range.
+
+    class SpeedValueNotInRange < YandexSpeechError
+      def initialize(value); super "Speed value '#{value}' should be from [(0.1)..3] range" end; end
+  end # class Speed
+end # module YandexSpeechApi

data/lib/yandex_speech/voice.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module YandexSpeechApi
+
+  # @example Valid Usage
+  #   Voice.new('Oksana') # ==> instance of voice class
+  #
+  # @example Bad Usage
+  #   Voice.new(:bill)    # ==> VoiceNotAllowed exception
+
+  class Voice
+
+    ##
+    # List of allowed voices
+    #
+    # @return [Array<String>]
+
+    def self.list
+      %i(jane oksana alyss omazh zahar ermil)
+    end
+
+    # @return [Symbol]
+    #   possible values: :jane, :oksana, :alyss, :omazh, :zahar, :ermil
+
+    attr_reader :name
+
+    def initialize(voice)
+      @name = voice.downcase.to_sym
+      raise VoiceNotAllowed, voice unless voice_known? @name
+    end
+
+    private
+
+    def voice_known?(name)
+      Voice.list.include? name
+    end
+
+    ##
+    # Raised when unknown voice was selected.
+
+    class VoiceNotAllowed < YandexSpeechError
+      def initialize(voice)
+        super "Voice '#{voice}' not allowed for usage. To see list of allowed voices use Voice#list" end; end
+  end # class Voice
+end # module YandexSpeechApi

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'webmock/rspec'
+
+require_relative '../lib/yandex_speech'
+
+RSpec.configure do |config|
+  WebMock.disable_net_connect! allow_localhost: true
+
+  config.filter_run_excluding :disabled => true
+end
+
+SimpleCov.coverage_dir("spec/coverage")

data/spec/yandex_speech/connection_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module YandexSpeechApi
+  describe Connection do
+    context '#send' do
+      it 'raises an exception for fallen request' do
+        stub_request(:any, /https:\/\/tts.voicetech.yandex.net\/.*/)
+          .to_return status: 500, body: 'Body'
+
+        expect {described_class.send {}}
+          .to raise_exception described_class::ConnectionError
+      end
+
+      it 'returns response body for successful request' do
+        stub_request(:any, /https:\/\/tts.voicetech.yandex.net\/.*/)
+          .to_return status: 200, body: 'Body'
+
+        expect(described_class.send {}).to be_eql "Body"
+      end
+    end # context '#send'
+  end # describe Connection
+end # module YandexSpeechApi

data/spec/yandex_speech/emotion_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module YandexSpeechApi
+  describe Emotion do
+    context '#new' do
+      it 'raises an exception for unknown emotion' do
+        expect { described_class.new :some_random_emotion }
+          .to raise_exception described_class::EmotionNotAllowed
+      end
+
+      it 'creates object instance when emotion param is symbol' do
+        expect(described_class.new(:good))
+          .to be_instance_of Emotion
+      end
+
+      it 'creates object instance when emotion param is string' do
+        expect(described_class.new('GOOD'))
+          .to be_instance_of Emotion
+      end
+
+      it 'creates :good emotion without any exception' do
+        expect { described_class.new :good }.to_not raise_exception
+      end
+    end # context #new
+
+    context '#list' do
+      it 'shows list of allowed emotions' do
+        expect(described_class.list).to_not be_nil
+      end
+    end # context #list
+  end # describe Emotion
+end # module YandexSpeechApi

data/spec/yandex_speech/format_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module YandexSpeechApi
+  describe Format do
+    context '#new' do
+      it 'raises an exception for unknown format type' do
+        expect { described_class.new :some_random_format }
+          .to raise_exception described_class::FormatNotAllowed
+      end
+
+      it 'creates object instance when format param is symbol' do
+        expect(described_class.new(:wav))
+          .to be_instance_of Format
+      end
+
+      it 'creates object instance when format param is string' do
+        expect(described_class.new('Wav'))
+          .to be_instance_of Format
+      end
+    end # context #new
+
+    context '#list' do
+      it 'shows list of all possible formats' do
+        expect(described_class.list).to_not be_nil
+      end
+    end # context #list
+  end # describe Format
+end # module YandexSpeechApi

data/spec/yandex_speech/helpers_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module YandexSpeechApi
+  describe Helpers do
+    context '#recognize_operation_system' do
+
+      it "returns :windows for CONFIG['host_os'] == msys" do
+        stub_const 'RbConfig::CONFIG', {'host_os' => 'msys'}
+        expect(described_class.recognize_operation_system).to eql(:windows)
+      end
+
+      it "returns :mac_os for CONFIG['host_os'] == darwin" do
+        stub_const 'RbConfig::CONFIG', {'host_os' => 'darwin'}
+        expect(described_class.recognize_operation_system).to eql(:mac_os)
+      end
+    end # context '#recognize_operation_system'
+  end # describe Helpers
+end # module YandexSpeechApi

data/spec/yandex_speech/key_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module YandexSpeechApi
+  describe Key do
+    after :each do
+      described_class.instance_variable_set :@global_key, nil
+    end
+
+    context '#global_key=(other)' do
+      it 'raises an exception +other+ param is not present' do
+        key = described_class.new :unknown
+        expect { described_class.global_key = key }
+          .to raise_error Key::InvalidGlobalKey
+      end
+    end # context '#global_key=(other)'
+
+    context '#global_key' do
+      it 'returns +false+ when global key not set' do
+        expect(Key.global_key?).to be_falsey
+      end
+
+      it 'returns +true+ when global key set' do
+        described_class.global_key = 'Secret Key'
+        expect(Key.global_key?).to be_truthy
+      end
+    end # context '#global_key'
+
+    context '#get' do
+      it 'raises an exception for not defined (instance or global) key' do
+        key = described_class.new :unknown
+        expect { key.get }.to raise_error Key::KeyNotDefined
+      end
+
+      it 'not raises an exception when instance key defined' do
+        key = described_class.new 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'
+        expect { key.get }.to_not raise_error
+      end
+
+      it 'not raises an exception when global key defined' do
+        described_class.global_key = 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'
+        key = described_class.new :unknown
+        expect { key.get }.to_not raise_error
+      end
+
+      it 'not raises an exception for any key instance when global key defined' do
+        described_class.global_key = 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'
+
+        key = described_class.new :unknown
+        key2 = described_class.new 'test key'
+
+        expect { key.get }.to_not raise_error
+        expect { key2.get }.to_not raise_error
+      end
+    end # context #get
+  end # describe Key
+end # module YandexSpeechApi

data/spec/yandex_speech/language_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module YandexSpeechApi
+  describe Language do
+    context '#new' do
+      it 'raises an exception for unknown language' do
+        expect { described_class.new :wommi_lang }
+          .to raise_exception described_class::UnknownLanguageError
+      end
+
+      it 'creates object instance when +language+ param is symbol' do
+        expect{described_class.new(:ukrain)}.to_not raise_exception
+      end
+
+      it 'creates object instance when +language+ param is string' do
+        expect{described_class.new('Ukrain')}.to_not raise_exception
+      end
+    end # context #new
+
+    context '#allowed_languages' do
+      it 'shows list of all possible languages' do
+        expect(described_class.allowed_languages).to_not be_nil
+      end
+    end # context #allowed_languages
+
+    context '#code' do
+      it 'returns valid code for any class instance from #list' do
+        sample  = described_class.allowed_languages.sample
+
+        expect{described_class.new(sample)}.to_not raise_exception
+      end
+    end # context #code
+  end # describe Language
+end # module YandexSpeechApi

data/spec/yandex_speech/mp3_player/base_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module YandexSpeechApi
+module MP3_Player
+  describe Base do
+    context '#play' do
+      it 'raises an exception when file not found' do
+        expect{described_class.new.play('lalalala.')}
+          .to raise_exception described_class::FileNotFound
+      end
+
+      it 'raises an exception when file has wrong extension' do
+        expect_any_instance_of(described_class)
+          .to receive(:validate_file_presence).and_return nil
+
+        expect{described_class.new.play('lalalala.')}
+          .to raise_exception described_class::UnknownExtension
+      end
+    end # context '#play'
+  end # describe Linux_MP3_Player
+end # module MP3_Player
+end # module YandexSpeechApi