alexa_toolbox 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f39fcbc82cf476f7aa3ecb9284fcecee1b13e047
-  data.tar.gz: 9039baf8fe5a872cd60f39424d76da64dbfc382c
+  metadata.gz: d512122e81904260c84fa1820a5611561e70e32a
+  data.tar.gz: 2fdb9f22ad05544f87aa4afb014204ba117a108d
 SHA512:
-  metadata.gz: 8f87e7269bbbbf3dfdb6d1052f7cb400203125e737ab6e096bd63b877e44e980cb1c9fa90c22d306d5a03ccb61a487e96bac3a3da692fb60016bbf60c0ff2dcf
-  data.tar.gz: 5293fdbaeab9d5bf528f7eb9087c25fc0c7a2488aa056c16a2e5cdadd19abbfea8caae7f5b46a3f774d30878dec17661d2fc8d22d4a52844670997e7765b307d
+  metadata.gz: 7511ebd8464acf9d9c8eb6fbe0eda787262e04779547ecbce51d5fdf92baac367f734c8ef88de7812f9a6a77a55ba550b5da1bab46fe0a796643eb808338716a
+  data.tar.gz: 82b839225d71eff9e1803ec69c23a6a1c5af74cd311958cc9add80791e2ddc828c6d091ba178f41b016948929e8b1dae8e3c4ebc2e2f0b8ce18358f70dca2259

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alexa_toolbox (1.0.0)
+    alexa_toolbox (1.0.3)
       bundler (~> 1.14)
       rake
 

data/README.md

@@ -342,6 +342,63 @@ request.context
 
 ### Address
 
+### DisplayDirective
+
+You can display content on the new Echo Show using the predefined templates.
+[Amazon Official Documentation Reference](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/display-interface-reference)
+
+#### Examples
+
+##### BodyTemplate1 Example
+
+```ruby
+  response = AlexaToolbox::Response.new
+  display_directive = AlexaToolbox::DisplayDirective.new("BodyTemplate1","Winner")
+  display_directive.template.add_title("You won!")
+  display_directive.template.hide_back_button
+  display_directive.template.background_image.set_content_description("Description of image")
+  display_directive.template.background_image.add_source("https://placeholder.com/placeholder_image.jpg")
+  response.add_display_directive_object(display_directive)
+```
+
+##### BodyTemplate3 Example
+
+```ruby
+  response = AlexaToolbox::Response.new
+  display_directive = AlexaToolbox::DisplayDirective.new("BodyTemplate3","SampleCard_92347")
+  display_directive.template.add_title("Body Template Title Example")
+  display_directive.template.hide_back_button
+  display_directive.template.text_content.add_primary_text("Example of text content. This content contains <b>bold text</b>, <i>italics</i>, and <br/> line breaks.","RichText")
+  image = AlexaToolbox::DisplayDirectiveImage.new("Mount St. Helens landscape","https://example.com/resources/card-images/mount-saint-helen-small.png")
+  display_directive.template.add_image_object(image)
+  response.add_display_directive_object(display_directive)
+```
+
+##### ListTemplate2 Example
+
+```ruby
+  response = AlexaToolbox::Response.new
+
+  display_directive = AlexaToolbox::DisplayDirective.new("ListTemplate2","list_template_two")
+  display_directive.template.add_title("Pizzas")
+  display_directive.template.hide_back_button
+
+  list_text = AlexaToolbox::DisplayDirectiveTextContent.new
+  list_text.add_primary_text("<font size='7'>Supreme</font> <br/> Large Pan Pizza $17.00","RichText")
+  list_text.add_secondary_text("Secondary Text")
+  list_text.add_tertiary_text("")
+  list_image = AlexaToolbox::DisplayDirectiveImage.new("Supreme Large Pan Pizza","http://www.example.com/images/thumb/SupremePizza1.jpg")
+  display_directive.template.add_item_to_list("item_1",list_image,list_text)
+
+  list_text = AlexaToolbox::DisplayDirectiveTextContent.new
+  list_text.add_primary_text("<font size='7'>Meat Lovers</font> <br/> Large Pan Pizza $17.00","RichText")
+  list_image = AlexaToolbox::DisplayDirectiveImage.new("Meat Lovers Large Pan Pizza","http://www.example.com/images/thumb/MeatLoversPizza1.jpg")
+  display_directive.template.add_item_to_list("item_2",list_image,list_text)
+
+  response.add_display_directive_object(display_directive)
+```
+
+
 
 ## Troubleshooting
 

data/lib/alexa_toolbox/display_directive.rb

@@ -0,0 +1,27 @@
+module AlexaToolbox
+  # Handles creating display directives in responses.
+  # https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/display-interface-reference
+  class DisplayDirective
+    require 'json'
+    require 'alexa_toolbox/display_directive_template'
+
+    attr_accessor :type, :template
+
+    def initialize(template,token)
+      @type = "Display.RenderTemplate"
+      if ["BodyTemplate1","BodyTemplate2","BodyTemplate3","BodyTemplate6","ListTemplate1","ListTemplate2","ListTemplate3"].include?(template)
+        @template = AlexaToolbox::DisplayDirectiveTemplate.new(template,token)
+      else
+        raise ArgumentError, 'Invalid display template given. Valid options are: "BodyTemplate1","BodyTemplate2","BodyTemplate3","BodyTemplate6","ListTemplate1","ListTemplate2","ListTemplate3"'
+      end
+    end
+
+    def build_directive(json = true)
+      data_hash = {
+        "type": @type,
+        "template": @template.build
+      }
+      json ? JSON.parse(data_hash.to_json) : data_hash
+    end
+  end
+end

data/lib/alexa_toolbox/display_directive_image.rb

@@ -0,0 +1,78 @@
+module AlexaToolbox
+  # Handles creating display directives in responses.
+  class DisplayDirectiveImage
+    require 'json'
+
+    attr_accessor :content_description, :sources
+
+    def initialize(content_description = "", url = nil)
+      @content_description = content_description
+      @sources = []
+      if !url.nil?
+        self.add_xsmall_source(url)
+      end
+    end
+
+    def set_content_description(text)
+      @content_description = text
+    end
+
+    def add_source(url,size = "X_SMALL",widthPixels = nil,heightPixels = nil)
+      source = {
+        url: url,
+        size: size
+      }
+      source[:widthPixels] = widthPixels if !widthPixels.nil?
+      source[:heightPixels] = heightPixels if !heightPixels.nil?
+      @sources.push(source)
+    end
+
+    def add_xsmall_source(url)
+      @sources.push({
+        url: url,
+        size: "X_SMALL"
+      })
+    end
+
+    def add_small_source(url)
+      @sources.push({
+        url: url,
+        size: "SMALL"
+      })
+    end
+
+    def add_medium_source(url)
+      @sources.push({
+        url: url,
+        size: "MEDIUM"
+      })
+    end
+
+    def add_large_source(url)
+      @sources.push({
+        url: url,
+        size: "LARGE"
+      })
+    end
+
+    def add_xlarge_source(url)
+      @sources.push({
+        url: url,
+        size: "X_LARGE"
+      })
+    end
+
+    def valid?
+      @content_description.length > 0 && @sources.count > 0
+    end
+
+    def build
+      data_hash = {
+        contentDescription: @content_description,
+        sources: @sources
+      }
+      data_hash
+    end
+
+  end
+end

data/lib/alexa_toolbox/display_directive_template.rb

@@ -0,0 +1,66 @@
+module AlexaToolbox
+  # Handles creating display directives in responses.
+  class DisplayDirectiveTemplate
+    require 'json'
+    require 'alexa_toolbox/display_directive_image'
+    require 'alexa_toolbox/display_directive_text_content'
+
+    attr_accessor :type, :token, :back_button, :background_image, :title, :text_content, :list_items
+
+    def initialize(type,token,title = nil,back_button = "VISIBLE")
+      @type = type
+      @token = token
+      @back_button = back_button
+      @background_image = AlexaToolbox::DisplayDirectiveImage.new
+      @title = title
+      @text_content = AlexaToolbox::DisplayDirectiveTextContent.new
+      @list_items = []
+      @image = nil
+    end
+
+    def set_token(token)
+      @token = token
+    end
+
+    def hide_back_button
+      @back_button = "HIDDEN"
+    end
+
+    def show_back_button
+      @back_button = "VISIBLE"
+    end
+
+    def add_title(title)
+      @title = title
+    end
+
+    def add_image_object(image)
+      @image = image
+    end
+
+    def add_item_to_list(token,image,text_content)
+      @list_items.push({
+        token: token,
+        image: image.build,
+        textContent: text_content.build
+      })
+    end
+
+    def build
+      template = {
+        :type => @type,
+        :token => @token,
+        :backButton => @back_button
+      }
+      template[:backgroundImage] = @background_image.build if @background_image.valid?
+      template[:title] = @title if !@title.nil? && @title.length > 0
+      template[:textContent] = @text_content.build if @text_content.valid?
+      template[:image] = @image.build if !@image.nil? && ["ListTemplate1","ListTemplate2","ListTemplate3","BodyTemplate2","BodyTemplate3","BodyTemplate6"].include?(@type)
+      template[:listItems] = @list_items if !@list_items.empty?
+
+
+      template
+    end
+
+  end
+end

data/lib/alexa_toolbox/display_directive_text_content.rb

@@ -0,0 +1,58 @@
+module AlexaToolbox
+  # Handles creating display directives in responses.
+  class DisplayDirectiveTextContent
+    require 'json'
+
+    attr_accessor :text_content
+
+    def initialize
+      @text_content = {}
+    end
+
+    def add_text(slot,text,type = "PlainText")
+      if ["primary","tertiary","secondary"].include?(slot)
+        @text_content[slot + "Text"] = {
+          text: text,
+          type: type
+        }
+      elsif ["primaryText","secondaryText","tertiaryText"].include?(slot)
+        @text_content[slot] = {
+          text: text,
+          type: type
+        }
+      else
+        raise ArgumentError, 'Invalid text type given. Valid options are: "primary","tertiary","secondary","primaryText","secondaryText","tertiaryText"'
+      end
+    end
+
+    def add_primary_text(text,type = "PlainText")
+      @text_content["primaryText"] = {
+        text: text,
+        type: type
+      }
+    end
+
+    def add_secondary_text(text,type = "PlainText")
+      @text_content["secondaryText"] = {
+        text: text,
+        type: type
+      }
+    end
+
+    def add_tertiary_text(text,type = "PlainText")
+      @text_content["tertiaryText"] = {
+        text: text,
+        type: type
+      }
+    end
+
+    def valid?
+      @text_content != {}
+    end
+
+    def build
+      @text_content
+    end
+
+  end
+end

data/lib/alexa_toolbox/response.rb

@@ -50,6 +50,10 @@ module AlexaToolbox
     def add_ssml_reprompt(speech_text)
       @reprompt = { "outputSpeech" => { :type => 'SSML', :ssml => check_ssml(speech_text) } }
     end
+
+    def add_display_directive_object(display_directive)
+      @directives << display_directive.build_directive
+    end
     
     def add_audio_play_directive(url, play_behavior = '', token = '', expected_previous_token = '', offset = 0)
       directive = {

data/lib/alexa_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AlexaToolbox
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/alexa_toolbox.rb

@@ -2,6 +2,7 @@ require 'alexa_toolbox/request'
 require 'alexa_toolbox/version'
 require 'alexa_toolbox/response'
 require 'alexa_toolbox/address'
+require 'alexa_toolbox/display_directive'
 
 module AlexaToolbox
   # Prints a JSON object.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alexa_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Paul McMahon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,10 @@ files:
 - lib/alexa_toolbox/address.rb
 - lib/alexa_toolbox/audioplayer.rb
 - lib/alexa_toolbox/context.rb
+- lib/alexa_toolbox/display_directive.rb
+- lib/alexa_toolbox/display_directive_image.rb
+- lib/alexa_toolbox/display_directive_template.rb
+- lib/alexa_toolbox/display_directive_text_content.rb
 - lib/alexa_toolbox/intent.rb
 - lib/alexa_toolbox/request.rb
 - lib/alexa_toolbox/response.rb