alexa-rails 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe84c01c500b20b605df841f3223b47fb2d2d0caa4b42ec2f4106defdc6d0098
-  data.tar.gz: a3d781d08f0df84165ec47a26db26a285c40a5918932dee673d848f924dc36d9
+  metadata.gz: d03309523af0c0f06a2dafb3591955407d52e00cd7f9760525e52b38349e7dc8
+  data.tar.gz: 7d10169cac5df98db050a0095cbac14d051ab8e68e23059a7b4f2e7988d15a62
 SHA512:
-  metadata.gz: fda2ea136306cfcdd4a4abc4a567062173da26b21598928c5ad5a07c1e307af3c8667f06a0a419db4e4a600f63d3de470b1ed43970ae5a3b3da6255087d5e60e
-  data.tar.gz: 296c90180fe93257c458acd12f6d532392645d893f7d2a38466dc575916646299bc14a1ce95bdff42eccd39b0c8a48ec3db9f3b7db443f6277b3214608846563
+  metadata.gz: cd6f5a97942b6bdf85bd308f009456bff0b876b9bb34a6bc6fdffe7ca4abbd0dcca32a9d18cfee92a53b7a3d45371410f2685a66cb7c054e33f2734cded96374
+  data.tar.gz: 337b0cb337acc5ecac5d2baaad60a5b48c3b0ae132881eb9fc64bd82c5ddef896953df1d1402982a560ad4dadb0c4414a96834aa83540a6493eca01f61a8360a

data/README.md

@@ -65,7 +65,7 @@ module Alexa
     class PlaceOrder < Alexa::IntentHandlers::Base
       def handle
         ...
-        response # intent handlers should always return the +response+ object 
+        response # intent handlers should always return the +response+ object
       end
     end
   end
@@ -74,7 +74,7 @@ end
 
 All intent handlers should contain a `#handle` method that has required logic
 as to how to handle the intent request. For example, adding session variables,
-setting response to elicit slots, delegate etc. 
+setting response to elicit slots, delegate etc.
 
 **Note**: `#handle` method should always return the `response` object.
 `response` object in available in the scope of `#handle`.
@@ -100,12 +100,12 @@ slot and the respecitve views are used.
 response.elicit_slot!(:SlotName)
 ```
 
-#### Delete response
+#### Delegate response
 
 `#handle` is expected to return an instance of `Alexa::Response` or its subclasses.
-In normal cases, the `response` object is returned. 
-In cases where the slots elicitation is delegated to alexa, an instance of 
-`Alexa::Responses::Delegate` has to be returned. 
+In normal cases, the `response` object is returned.
+In cases where the slots elicitation is delegated to alexa, an instance of
+`Alexa::Responses::Delegate` has to be returned.
 
 ```ruby
   def handle
@@ -116,17 +116,17 @@ In cases where the slots elicitation is delegated to alexa, an instance of
 
 ### Views
 
-The content for speech and display cards is not set in the intent handler
+The content for SSML and display cards is not set in the intent handler
 classes.
 We follow rails convention and expect all response content for intents to be
-in their respective view files.
+in their respective `default` view files.
 
 Also, the views are context locale dependant.
 
 Given an intent named `PlaceOrder`, you view files would be
 
-  * SSML: `views/alexa/en_us/intent_handlers/place_order/speech.ssml.erb`
-  * Card: `views/alexa/en_us/intent_handlers/place_order/display.text.erb`
+  * SSML: `views/alexa/en_us/intent_handlers/place_order/default.ssml.erb`
+  * Card: `views/alexa/en_us/intent_handlers/place_order/default.text.erb`
 
 In case of slot elicitations, follow a similar convention but make sure you
 name the `ssml` and `text` files with the same name as the slot that is being
@@ -136,6 +136,25 @@ slot would have the following views
   * SSML: `views/alexa/en_us/intent_handlers/place_order/elicitations/address.ssml.erb`
   * Card: `views/alexa/en_us/intent_handlers/place_order/elicitations/address.text.erb`
 
+##### Render custom template instead of default
+
+If you wish to force the `response` object to take contents from a different
+template file instead of `default.*.erb`, pass the custom filename with
+`Alexa::Response#with(template: )`.
+
+For example: Instead of `default`, if you wish to render the contents of
+`no_results.ssml.erb` and `no_results.text.erb`, return the response by forcing
+the template with the following:
+
+```ruby
+  def handle
+    ...
+    return response.with(template: :no_results)
+  end
+```
+and make sure you add your contents in the `no_results.*.erb` files in your
+intent handlers' views' directory.
+
 #### SSML
 
 ##### Re-prompts
@@ -170,11 +189,30 @@ view file for the response as follows:
 
 ```
 
+##### Permission cards
+
+To render a permission card. Use `ask_for_permissions_consent` as the `card_type`
+and provide the scope in `permissions_scope` content_for block.
+Following is an example for Device address permission card.
+
+```erb
+<% content_for :card_type do %>
+  ask_for_permissions_consent
+<% end %>
+
+<% content_for :permissions_scope do %>
+  read::alexa:device:all:address
+<% end %>
+```
+
+*Note*: The permission card should not have any other content other than the
+content for `card_type` and `permissions_scope`.
+
 ## Handling Amazon's Built-in Intents / Other request types
 
 Requests for Amazon's built-in intents and other request types
-are also handled with intent handlers. 
-Below is the mapping for every request type and respective 
+are also handled with intent handlers.
+Below is the mapping for every request type and respective
 intent handler classes.
 These intent handlers are not included in the gem as they are a
 but specific to the application.

data/lib/alexa/intent_handlers/base.rb

@@ -58,11 +58,6 @@ module Alexa
         @_usage_count ||= context.user.usage_count_for(intent_name: request.intent_name)
       end
 
-      def show_device_address_permission_consent_card?
-        @_show_device_address_permission_consent_card == true
-      end
-
-
       protected
 
       def has_all_slots?
@@ -126,14 +121,6 @@ module Alexa
         }
       end
 
-      def show_device_address_permission_consent_card!
-        @_show_device_address_permission_consent_card = true
-      end
-
-      def device_address_permission_consent_response
-        @_device_address_permission_consent_response ||= Alexa::Responses::PermissionConsents::DeviceAddress.new(intent: self)
-      end
-
       def delegate_response
         @_delegate_response ||= Alexa::Responses::Delegate.new
       end

data/lib/alexa/response.rb

@@ -8,6 +8,12 @@ module Alexa
       @slots_to_not_render_elicitation = []
     end
 
+    def with(template: )
+      # TODO make this return a new object instead of self.
+      @force_template_filename = template
+      self
+    end
+
     # Marks a slot for elicitation.
     #
     # Options:
@@ -30,9 +36,13 @@ module Alexa
         slot_to_elicit = elicit_directives.first[:slotToElicit]
       end
 
-      template_path = "alexa/#{intent.context.locale}/intent_handlers/"\
+      template_path = "alexa/#{intent.context.locale.downcase}/intent_handlers/"\
         "#{intent.class.name.demodulize.underscore}"
 
+      if filename.nil? && @force_template_filename.present?
+        filename = @force_template_filename
+      end
+
       if filename.present?
         if format == :ssml
           "#{template_path}/#{filename}.ssml.erb"
@@ -40,12 +50,6 @@ module Alexa
           "#{template_path}/#{filename}.text.erb"
         end
       else
-        if intent.show_device_address_permission_consent_card? && format == :text
-          return Alexa::Responses::PermissionConsents::DeviceAddress.new(
-            intent: intent
-          ).partial_path(format: :text)
-        end
-
         if slot_to_elicit.present? && !@slots_to_not_render_elicitation.include?(slot_to_elicit)
           if format == :ssml
             "#{template_path}/elicitations/#{slot_to_elicit.underscore}.ssml.erb"
@@ -54,9 +58,9 @@ module Alexa
           end
         else
           if format == :ssml
-            "#{template_path}/speech.ssml.erb"
+            "#{template_path}/default.ssml.erb"
           else
-            "#{template_path}/display.text.erb"
+            "#{template_path}/default.text.erb"
           end
         end
       end

data/lib/alexa/responses/bye.rb

@@ -8,7 +8,7 @@ module Alexa
       end
 
       def partial_path(format: :ssml)
-        template_path = "alexa/#{intent.context.locale}/intent_handlers/"\
+        template_path = "alexa/#{intent.context.locale.downcase}/intent_handlers/"\
           "#{intent.class.name.demodulize.underscore}"
 
         if format == :ssml

data/lib/alexa/responses/permission_consents/device_address.rb

@@ -10,7 +10,7 @@ module Alexa
 
         def partial_path(format: :ssml)
           if format == :ssml
-            "alexa/#{intent.context.locale}/intent_handlers/"\
+            "alexa/#{intent.context.locale.downcase}/intent_handlers/"\
               "#{intent.class.name.demodulize.underscore}"\
               "/permission_consents/"\
               "device_address.ssml.erb"

data/lib/alexa/version.rb

@@ -1,3 +1,3 @@
 module Alexa
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alexa-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Sri Vishnu Totakura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails