ssml_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6275634506fb3476e569a6b0cd789d8fc7a9462
+  data.tar.gz: c20cea303828a8d84c8764d40d482d2ad6be889f
+SHA512:
+  metadata.gz: 30af32c16859e824e531f197eee273de962af05093dcea91f94ae45e5040fa2a6e94dda0b9d5f0a361119380d008560862b5cec004097a67c51924272369a479
+  data.tar.gz: 5a1b4610510873be755789c0afb1b32e50f8e9787106f51106bcc56ffc0dc7d3e1fa89fde50f9d2ecd70224e8dd0869ba907c6af5e5460c6c7bb5a994e03c3fc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alexa_rubykit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Paul McMahon
+
+MIT License
+
+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,570 @@
+# SSML Builder (for Amazon Alexa)
+
+This gem implements a full suite of tools for working with SSML particularly with Amazon's Alexa. For full SSML documentation, please see:
+[Amazon SSML Reference](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference)
+
+## Installation
+
+### For Ruby Projects:
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssml_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ssml_builder
+
+## Usage
+
+This Gem provides methods to generate ssml strings using the core Builder module as well as providing an extension of the string class if that usage is preferred.
+
+### SsmlBuilder::Builder
+
+#### Basic Usage
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.say("Hello, how are you today?")
+ssml_builder.pause("1s")
+ssml_builder.p("This is a new paragraph.")
+
+ssml_buider.ssml
+# Output: "<speak>Hello, how are you today? <break time=\"1s\"/><p>This is a new paragraph.</p></speak>"
+```
+
+#### Available Commands
+
+* [say](#say)
+* [paragraph](#paragraph)
+* [p](#p)
+* [sentence](#sentence)
+* [rate](#rate)
+* [pitch](#pitch)
+* [volume](#volume)
+* [pause](#pause)
+* [break](#break)
+* [emphasis](#emphasis)
+* [audio](#audio)
+* [spell_out](#spell_out)
+* [characters](#characters)
+* [cardinal](#cardinal)
+* [number](#number)
+* [ordinal](#ordinal)
+* [digits](#digits)
+* [fraction](#fraction)
+* [unit](#unit)
+* [date](#date)
+* [time](#time)
+* [telephone](#telephone)
+* [phone](#phone)
+* [address](#address)
+* [interjection](#interjection)
+* [expletive](#expletive)
+* [sub](#sub)
+* [whisper](#whisper)
+* [amazon_verb](#amazon_verb)
+* [amazon_participle](#amazon_participle)
+* [amazon_noun](#amazon_noun)
+* [amazon_sense](#amazon_sense)
+* [phoneme](#phoneme)
+
+##### say
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.say("Hello, how are you today?")
+
+ssml_buider.ssml
+# Output: "<speak>Hello, how are you today?</speak>"
+```
+
+##### paragraph
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.paragraph("Hello, how are you today?")
+
+ssml_buider.ssml
+# Output: "<speak><p>Hello, how are you today?</p></speak>"
+```
+
+##### p
+
+Alias for [paragraph](#paragraph)
+
+##### sentence
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.sentence("Hello, how are you today?")
+
+ssml_buider.ssml
+# Output: "<speak><s>Hello, how are you today?</s></speak>"
+```
+
+##### rate
+
+parameters
+  - string
+  - rate
+    - optional, default: "medium"
+    - can be integer or string
+    - valid text inputs: "x-slow", "slow", "medium", "fast", "x-fast"
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.rate("Text",90)
+
+ssml_buider.ssml
+# Output: "<speak><prosody rate=\"90%\">Text</prosody></speak>"
+```
+
+##### pitch
+
+parameters
+  - string
+  - pitch
+    - optional, default: "medium"
+    - can be integer, float, or string
+    - minimum -33.3
+    - maximum 50
+    - valid text inputs: "x-low", "low", "medium", "high", "x-high"
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.pitch("Text",50)
+
+ssml_buider.ssml
+# Output: "<speak><prosody pitch=\"+50%\">Text</prosody></speak>"
+```
+
+##### volume
+
+parameters
+  - string
+  - volume
+    - optional, default: "medium"
+    - can be integer, float, or string
+    - maximum 4.08
+    - valid text inputs: "silent", "x-soft", "soft", "medium", "loud", "x-loud"
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.volume("Text",2.3)
+
+ssml_buider.ssml
+# Output: "<speak><prosody volume=\"+2.3dB\">Text</prosody></speak>"
+```
+
+##### pause
+
+parameters
+  - string
+    - optional, default: "medium"
+    - can be text time such as: "1s", "100ms", etc.
+    - valid text inputs: "none", "x-weak", "weak", "medium", "strong", "x-strong"
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.pause("1s")
+
+ssml_buider.ssml
+# Output: "<speak><break time=\"1s\"/></speak>"
+```
+
+##### break
+
+Alias for [pause](#pause)
+
+##### emphasis
+
+parameters
+  - string
+  - emphasis
+    - optional, default: "moderate"
+    - valid text inputs: "reduced", "moderate", "strong"
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.emphasis("Text","strong")
+
+ssml_buider.ssml
+# Output: "<speak><emphasis level=\"strong\">Text</emphasis></speak>"
+```
+
+##### audio
+
+parameters
+  - url
+    - [SSML Audio Guidelines](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#audio)
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.audio("http://s3.audio.file.com/audio.mp3")
+
+ssml_buider.ssml
+# Output: "<speak><audio src=\"http://s3.audio.file.com/audio.mp3\"/></speak>"
+```
+
+##### spell_out
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.spell_out("Spelling")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"spell-out\">Spelling</say-as></speak>"
+```
+
+##### characters
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.characters("Spelling")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"characters\">Spelling</say-as></speak>"
+```
+
+##### cardinal
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.cardinal("10")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"cardinal\">10</say-as></speak>"
+```
+
+##### number
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.number("10")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"number\">10</say-as></speak>"
+```
+
+##### ordinal
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.ordinal("10")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"ordinal\">10</say-as></speak>"
+```
+
+##### digits
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.digits("10")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"digits\">10</say-as></speak>"
+```
+
+##### fraction
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.fraction("3/20")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"fraction\">3/20</say-as></speak>"
+```
+
+##### unit
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.unit("10 meters")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"unit\">10meters</say-as></speak>"
+```
+
+##### date
+
+parameters
+  - year
+    - string or integer
+    - nil to leave out
+  - month
+    - string or integer
+    - nil to leave out
+  - day
+    - string or integer
+    - nil to leave out
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.date("2017",nil,10)
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"date\">2017??10</say-as></speak>"
+```
+
+##### time
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.time("2'")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"time\">2'</say-as></speak>"
+```
+
+##### telephone
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.telephone("1234567890")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"telephone\">1234567890</say-as></speak>"
+```
+
+##### phone
+
+Alias for [telephone](#telephone)
+
+##### address
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.address("342 W 1st St")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"address\">342 W 1st St</say-as></speak>"
+```
+
+##### interjection
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.interjection("Wow!")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"interjection\">Wow!</say-as></speak>"
+```
+
+##### expletive
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.expletive("Curse Word")
+
+ssml_buider.ssml
+# Output: "<speak><say-as interpret-as=\"expletive\">Curse Word</say-as></speak>"
+```
+
+##### sub
+
+parameters
+  - string
+  - alias
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.sub("Al","aluminum")
+
+ssml_buider.ssml
+# Output: "<speak><sub alias=\"aluminum\">Al</sub></speak>"
+```
+
+##### whisper
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.whisper("Be very quiet")
+
+ssml_buider.ssml
+# Output: "<speak><amazon:effect name=\"whispered\">Be very quiet</amazon:effect></speak>"
+```
+
+##### amazon_verb
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.amazon_verb("read")
+
+ssml_buider.ssml
+# Output: "<speak><w role=\"amazon:VB\">read</w></speak>"
+```
+
+##### amazon_participle
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.amazon_participle("read")
+
+ssml_buider.ssml
+# Output: "<speak><w role=\"amazon:VBD\">read</w></speak>"
+```
+
+##### amazon_noun
+
+parameters
+  - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.amazon_noun("bath")
+
+ssml_buider.ssml
+# Output: "<speak><w role=\"amazon:NN\">bath</w></speak>"
+```
+
+##### amazon_sense
+
+parameters
+  - string
+  - sense
+    - integer
+    - [Sense Documentation](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#w)
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.amazon_sense("bass",1)
+
+ssml_buider.ssml
+# Output: "<speak><w role=\"SENSE_1\">bass</w></speak>"
+```
+
+##### phoneme
+
+[Amazon Phoneme Documentation](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#phoneme)
+
+parameters
+  - string
+  - alphabet
+    - string
+  - ph
+    - string
+
+```ruby
+require 'ssml_builder'
+ssml_builder = SsmlBuilder::Builder.new
+ssml_builder.phoneme("pecan","ipa","pɪˈkɑːn")
+
+ssml_buider.ssml
+# Output: "<speak><phoneme alphabet=\"ipa\" ph=\"pɪˈkɑːn\">pecan</phoneme></speak>"
+```
+
+### String
+
+
+## Troubleshooting
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Please make sure to write specs for any new features!
+
+# Team Members
+- "Paul McMahon"
+  - Email: <colpan@sircolpaniusjackson.com> 
+  - Twitter: [@colpanius](https://twitter.com/colpanius)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ssml_builder.rb

@@ -0,0 +1,12 @@
+require 'ssml_builder/builder'
+require 'ssml_builder/version'
+require 'ssml_builder/core_extensions/string'
+
+module SsmlBuilder
+
+  # Prints the Gem version.
+  def self.print_version
+    p SsmlBuilder::VERSION
+  end
+  
+end

data/lib/ssml_builder/builder.rb

@@ -0,0 +1,216 @@
+module SsmlBuilder
+
+  class Builder
+    attr_reader :ssml_content
+
+    def initialize
+      @ssml_content = ""
+    end
+
+    def say(string)
+      space_precheck
+      @ssml_content += remove_characters(string)
+    end
+
+    def paragraph(string)
+      @ssml_content += "<p>" + remove_characters(string) + "</p>"
+    end
+
+    def p(string)
+      # ALIAS for paragraph
+      paragraph(string)
+    end
+
+    def sentence(string)
+      @ssml_content += "<s>" + remove_characters(string) + "</s>"
+    end
+
+    def rate(string,rate = "medium")
+      space_precheck
+      if !["x-slow", "slow", "medium", "fast", "x-fast"].include?(rate)
+        rate = (rate.to_i > 20 ? rate.to_i : 20).to_s + "%"
+      end
+      @ssml_content += "<prosody rate=\"" + rate + "\">" + remove_characters(string) + "</prosody>"
+    end
+
+    def pitch(string,pitch = "medium")
+      space_precheck
+      if !["x-low", "low", "medium", "high", "x-high"].include?(pitch)
+        pitch = pitch.to_f > -33.3 ? pitch.to_f : -33.3
+        pitch = (pitch.to_f < 50.0 ? pitch : 50.0)
+        pitch = pitch > 0 ? "+%g%" % ("%.2f" % pitch) : "%g%" % ("%.2f" % pitch)
+      end
+      @ssml_content += "<prosody pitch=\"" + pitch + "\">" + remove_characters(string) + "</prosody>"
+    end
+
+    def volume(string,volume = "medium")
+      space_precheck
+      if !["silent", "x-soft", "soft", "medium", "loud", "x-loud"].include?(volume)
+        volume = volume.to_f < 4.08 ? volume.to_f : 4.08
+        volume = volume > 0 ? "+%gdB" % ("%.2f" % volume) : "%gdB" % ("%.2f" % volume)
+      end
+      @ssml_content += "<prosody volume=\"" + volume + "\">" + remove_characters(string) + "</prosody>"
+    end
+
+    def prosody
+      # UNKOWN HOW I WANT TO USE
+    end
+
+    def pause(length = "medium")
+      space_precheck
+      if ["none", "x-weak", "weak", "medium", "strong", "x-strong"].include?(length.downcase)
+        @ssml_content += "<break strength=\"" + length.downcase + "\"/>"
+      else
+        @ssml_content += "<break time=\"" + length + "\"/>"
+      end
+    end
+
+    def break(length = "medium")
+      # ALIAS for pause
+      pause(length)
+    end
+
+    def emphasis(string,level = "moderate")
+      space_precheck
+      @ssml_content += "<emphasis level=\"" + level + "\">" + string + "</emphasis>"
+    end
+
+    def audio(url)
+      space_precheck
+      @ssml_content += "<audio src=\"" + url + "\"/>"
+    end
+
+    def spell_out(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"spell-out\">" + string + "</say-as>"
+    end
+
+    def characters(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"characters\">" + string + "</say-as>"
+    end
+
+    def cardinal(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"cardinal\">" + string + "</say-as>"
+    end
+
+    def number(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"number\">" + string + "</say-as>"
+    end
+
+    def ordinal(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"ordinal\">" + string + "</say-as>"
+    end
+
+    def digits(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"digits\">" + string + "</say-as>"
+    end
+
+    def fraction(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"fraction\">" + string + "</say-as>"
+    end
+
+    def unit(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"unit\">" + string.gsub(/ /,'') + "</say-as>"
+    end
+
+    def date(year = nil, month = nil, day = nil)
+      space_precheck
+      year = year.nil? ? "????" : year.to_s
+      month = month.nil? ? "??" : month.to_s.rjust(2, '0')
+      day = day.nil? ? "??" : day.to_s.rjust(2, '0')
+      @ssml_content += "<say-as interpret-as=\"date\">" + year + month + day + "</say-as>"
+    end
+
+    def time(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"time\">" + string + "</say-as>"
+    end
+
+    def telephone(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"telephone\">" + string + "</say-as>"
+    end
+
+    def phone(string)
+      # ALIAS of telephone
+      telephone(string)
+    end
+
+    def address(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"address\">" + string + "</say-as>"
+    end
+
+    def interjection(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"interjection\">" + string + "</say-as>"
+    end
+
+    def expletive(string)
+      space_precheck
+      @ssml_content += "<say-as interpret-as=\"expletive\">" + string + "</say-as>"
+    end
+
+    def sub(string,alias_str)
+      space_precheck
+      @ssml_content += "<sub alias=\"" + alias_str + "\">" + string + "</sub>"
+    end
+
+    def whisper(string)
+      if !string.nil? && !string.empty?
+        space_precheck
+        @ssml_content += "<amazon:effect name=\"whispered\">" + string + "</amazon:effect>"
+      end
+    end
+
+    def amazon_verb(string)
+      space_precheck
+      @ssml_content += "<w role=\"amazon:VB\">" + string + "</w>"
+    end
+
+    def amazon_participle(string)
+      space_precheck
+      @ssml_content += "<w role=\"amazon:VBD\">" + string + "</w>"
+    end
+
+    def amazon_noun(string)
+      space_precheck
+      @ssml_content += "<w role=\"amazon:NN\">" + string + "</w>"
+    end
+
+    def amazon_sense(string,sense = 1)
+      space_precheck
+      @ssml_content += "<w role=\"SENSE_" + sense.to_s + "\">" + string + "</w>"
+    end
+
+    def phoneme(string,alphabet = "ipa",ph = "")
+      space_precheck
+      @ssml_content += "<phoneme alphabet=\"" + alphabet + "\" ph=\"" + ph + "\">" + string + "</phoneme>"
+    end
+
+    def ssml
+      return "<speak>" + @ssml_content + "</speak>"
+    end
+
+    private
+
+      def remove_characters(string)
+        return string.gsub(/['"`]/,'')
+      end
+
+      def space_precheck
+        if !@ssml_content.empty? && @ssml_content[-1] != " "
+          @ssml_content += " "
+        end
+      end
+
+  end
+
+end

data/lib/ssml_builder/core_extensions/string.rb

@@ -0,0 +1,171 @@
+module SsmlBuilder::String
+
+  def ssml_say
+    return ssml_remove_special_characters(self)
+  end
+
+  def ssml_paragraph
+    return "<p>" + ssml_remove_special_characters(self) + "</p>"
+  end
+
+  def ssml_p
+    # ALIAS for paragraph
+    return self.ssml_paragraph
+  end
+
+  def ssml_sentence
+    return "<s>" + ssml_remove_special_characters(self) + "</s>"
+  end
+
+  def ssml_rate(rate = "medium")
+    if !["x-slow", "slow", "medium", "fast", "x-fast"].include?(rate)
+      rate = (rate.to_i > 20 ? rate.to_i : 20).to_s + "%"
+    end
+    return "<prosody rate=\"" + rate + "\">" + ssml_remove_special_characters(self) + "</prosody>"
+  end
+
+  def ssml_pitch(pitch = "medium")
+    if !["x-low", "low", "medium", "high", "x-high"].include?(pitch)
+      pitch = pitch.to_f > -33.3 ? pitch.to_f : -33.3
+      pitch = (pitch.to_f < 50.0 ? pitch : 50.0)
+      pitch = pitch > 0 ? "+%g%" % ("%.2f" % pitch) : "%g%" % ("%.2f" % pitch)
+    end
+    return "<prosody pitch=\"" + pitch + "\">" + ssml_remove_special_characters(self) + "</prosody>"
+  end
+
+  def ssml_volume(volume = "medium")
+    if !["silent", "x-soft", "soft", "medium", "loud", "x-loud"].include?(volume)
+      volume = volume.to_f < 4.08 ? volume.to_f : 4.08
+      volume = volume > 0 ? "+%gdB" % ("%.2f" % volume) : "%gdB" % ("%.2f" % volume)
+    end
+    return "<prosody volume=\"" + volume + "\">" + ssml_remove_special_characters(self) + "</prosody>"
+  end
+
+  def ssml_prosody
+    # UNKOWN HOW I WANT TO USE
+  end
+
+  def ssml_pause(length = "medium")
+    if ["none", "x-weak", "weak", "medium", "strong", "x-strong"].include?(length.downcase)
+      return "<break strength=\"" + length.downcase + "\"/>"
+    else
+      return "<break time=\"" + length + "\"/>"
+    end
+  end
+
+  def ssml_break(length = "medium")
+    # ALIAS for ssml_pause
+    return self.ssml_pause(length)
+  end
+
+  def ssml_emphasis(level = "moderate")
+    return "<emphasis level=\"" + level + "\">" + self + "</emphasis>"
+  end
+
+  def ssml_audio
+    return "<audio src=\"" + self + "\"/>"
+  end
+
+  def ssml_spell_out
+    return "<say-as interpret-as=\"spell-out\">" + self + "</say-as>"
+  end
+
+  def ssml_characters
+    return "<say-as interpret-as=\"characters\">" + self + "</say-as>"
+  end
+
+  def ssml_cardinal
+    return "<say-as interpret-as=\"cardinal\">" + self + "</say-as>"
+  end
+
+  def ssml_number
+    return "<say-as interpret-as=\"number\">" + self + "</say-as>"
+  end
+
+  def ssml_ordinal
+    return "<say-as interpret-as=\"ordinal\">" + self + "</say-as>"
+  end
+
+  def ssml_digits
+    return "<say-as interpret-as=\"digits\">" + self + "</say-as>"
+  end
+
+  def ssml_fraction
+    return "<say-as interpret-as=\"fraction\">" + self + "</say-as>"
+  end
+
+  def ssml_unit
+    return "<say-as interpret-as=\"unit\">" + self.gsub(/ /,'') + "</say-as>"
+  end
+
+  def ssml_date
+    return "<say-as interpret-as=\"date\">" + self + "</say-as>"
+  end
+
+  def ssml_time
+    return "<say-as interpret-as=\"time\">" + self + "</say-as>"
+  end
+
+  def ssml_telephone
+    return "<say-as interpret-as=\"telephone\">" + self + "</say-as>"
+  end
+
+  def ssml_phone
+    # ALIAS of telephone
+    return self.ssml_telephone
+  end
+
+  def ssml_address
+    return "<say-as interpret-as=\"address\">" + self + "</say-as>"
+  end
+
+  def ssml_interjection
+    return "<say-as interpret-as=\"interjection\">" + self + "</say-as>"
+  end
+
+  def ssml_expletive
+    return "<say-as interpret-as=\"expletive\">" + self + "</say-as>"
+  end
+
+  def ssml_sub(alias_str)
+    return "<sub alias=\"" + alias_str + "\">" + self + "</sub>"
+  end
+
+  def ssml_whisper
+    return "<amazon:effect name=\"whispered\">" + self + "</amazon:effect>"
+  end
+
+  def ssml_amazon_verb
+    return "<w role=\"amazon:VB\">" + self + "</w>"
+  end
+
+  def ssml_amazon_participle
+    return "<w role=\"amazon:VBD\">" + self + "</w>"
+  end
+
+  def ssml_amazon_noun
+    return "<w role=\"amazon:NN\">" + self + "</w>"
+  end
+
+  def ssml_amazon_sense(sense = 1)
+    return "<w role=\"SENSE_" + sense.to_s + "\">" + self + "</w>"
+  end
+
+  def ssml_phoneme(alphabet = "ipa",ph = "")
+    return "<phoneme alphabet=\"" + alphabet + "\" ph=\"" + ph + "\">" + self + "</phoneme>"
+  end
+
+  def to_ssml
+    return "<speak>" + self + "</speak>"
+  end
+
+  private
+
+    def ssml_remove_special_characters(string)
+      return string.gsub(/['"`]/,'')
+    end
+end
+
+class String
+  include SsmlBuilder::String
+end

data/lib/ssml_builder/version.rb

@@ -0,0 +1,3 @@
+module SsmlBuilder
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ssml_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul McMahon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Gem for building SSML messages for Amazon Alexa
+email:
+- colpan@sircolpaniusjackson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ssml_builder.rb
+- lib/ssml_builder/builder.rb
+- lib/ssml_builder/core_extensions/string.rb
+- lib/ssml_builder/version.rb
+homepage: https://github.com/colpan/ssml_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Gem for building SSML messages for Amazon Alexa
+test_files: []