alexa_generator 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4805b19d31381011f755d8270dc535a64bb75879
-  data.tar.gz: c0360ca35a27e1c95432681ba41c670c361e3606
+  metadata.gz: 5e8ba24c9e6ca19a170be8d4e925ac95e89511e2
+  data.tar.gz: 48408c740b0ec858c3159824f2ea190a9ff487df
 SHA512:
-  metadata.gz: 3a760ba8c02c4f78922b4e42e4f93b6795c5f4b7a0d506b6ac67231df366194b1ba0320f4dd17e6089ff13dd58994ed089aee42f9834013acb6f66683c35b67a
-  data.tar.gz: b50e3df34f7742573f1c2c49cacbe96aa96a54f358d56dc4098ae8991f0d6284ad389bfcb347fad5e88c61aa43038e2286153b1b2221384200fae7bb37c301eb
+  metadata.gz: 7048fadeedc9213ce2f34823c7a12257ea7092b32a3b1b691f175ea6d5cd374b927cff87907811871e75260c8066390fa83c9acf96283f2caee05edfeca53d7d
+  data.tar.gz: 4f94f8409c5e413a44f71b5ba2d1b5a6386bf4c8622c1b32d83b566a501f6779180ca947075980b0a88d8ac5b30eb2b6a35d68766f1331c6575a2c994f5cf3bb

data/lib/alexa_generator/{alexa_syntax_error.rb → errors.rb}

@@ -1,4 +1,7 @@
 module AlexaGenerator
   class AlexaSyntaxError < StandardError
   end
+  
+  class InvalidIntentError < StandardError
+  end
 end

data/lib/alexa_generator/intent.rb

@@ -3,6 +3,31 @@ require 'alexa_generator/sample_utterance_template'
 
 module AlexaGenerator
   class Intent
+
+    module AmazonIntentType
+      VALUES = [
+        CANCEL =      :"AMAZON.CancelIntent",
+        HELP =        :"AMAZON.HelpIntent",
+        LOOP_OFF =    :"AMAZON.LoopOffIntent",
+        LOOP_ON  =    :"AMAZON.LoopOnIntent",
+        NEXT =        :"AMAZON.NextIntent",
+        NO =          :"AMAZON.NoIntent",
+        PAUSE =       :"AMAZON.PauseIntent",
+        PREVIOUS =    :"AMAZON.PreviousIntent",
+        REPEAT =      :"AMAZON.RepeatIntent",
+        RESUME =      :"AMAZON.ResumeIntent",
+        SHUFFLE_OFF = :"AMAZON.ShuffleOffIntent",
+        SHUFFLE_ON =  :"AMAZON.ShuffleOnIntent",
+        START_OVER =  :"AMAZON.StartOverIntent",
+        STOP =        :"AMAZON.StopIntent",
+        YES =         :"AMAZON.YesIntent"
+      ]
+      
+      def self.amazon_intent?(val)
+        VALUES.include?(val.to_sym)
+      end
+    end
+
     attr_reader :name, :slots
 
     class Builder
@@ -16,6 +41,11 @@ module AlexaGenerator
       end
 
       def add_slot(name, type, &block)
+        if AmazonIntentType.amazon_intent?(@name)
+          raise AlexaGenerator::InvalidIntentError,
+            "Amazon intents don't support slots. Tried to add a slot to intent of type: #{type}"
+        end
+        
         builder = Slot.build(name, type, &block)
 
         slot_bindings = builder.bindings.map { |x| SlotBinding.new(name, x) }
@@ -41,10 +71,14 @@ module AlexaGenerator
       @name = name
       @slots = slots
     end
+    
+    def amazon_intent?
+      AmazonIntentType.amazon_intent?(@name)
+    end
 
     def self.build(name, &block)
       builder = Builder.new(name)
-      block.call(builder)
+      block.call(builder) if block
       builder
     end
   end

data/lib/alexa_generator/interaction_model.rb

@@ -45,29 +45,35 @@ module AlexaGenerator
     end
 
     def intent_schema
-      {
-          intents: @intents.values.map do |intent|
-            {
-                intent: intent.name,
-                slots: intent.slots.map do |slot|
-                  {
-                      name: slot.name,
-                      type: slot.type
-                  }
-                end
-            }
-          end
-      }
+      intents = []
+      
+      @intents.values.each do |intent|
+        slots = []
+        
+        intent.slots.each do |slot|
+          slots << {name: slot.name, type: slot.type}
+        end
+        
+        intents << {intent: intent.name, slots: slots}
+      end
+      
+      { intents: intents }
     end
 
     def sample_utterances(intent_name)
       templates = @utterance_templates[intent_name] || []
+      slot_types = collect_slot_types
       utterances = Set.new
 
       templates.each do |template|
         # Consider only the slots that are referenced in this template
         relevant_slots = template.referenced_slots
 
+        # Amazon wants only the LITERAL ones
+        relevant_slots.select! do |s| 
+          AlexaGenerator::Slot::SlotType.literal?(slot_types[s.to_sym]) 
+        end
+
         # Compute all possible value bindings for the relevant slots
         slot_values = relevant_slots.
             # Extract value bindings for each slot
@@ -106,6 +112,16 @@ module AlexaGenerator
       end
     end
 
+    def collect_slot_types
+      out = {}
+      @intents.values.each do |intent|
+        intent.slots.map do |slot|
+          out[slot.name.to_sym] = slot.type.to_s
+        end
+      end
+      out
+    end
+
     def self.build(&block)
       builder = Builder.new
       block.call(builder)

data/lib/alexa_generator/slot.rb

@@ -1,11 +1,15 @@
 module AlexaGenerator
   class Slot
     module SlotType
-      LITERAL = :LITERAL
-      NUMBER = :NUMBER
-      DATE = :DATE
-      TIME = :TIME
-      DURATION = :DURATION
+      LITERAL = :"AMAZON.LITERAL"
+      NUMBER = :"AMAZON.NUMBER"
+      DATE = :"AMAZON.DATE"
+      TIME = :"AMAZON.TIME"
+      DURATION = :"AMAZON.DURATION"
+      
+      def self.literal?(value)
+        [:LITERAL, LITERAL].include?(value.to_sym)
+      end
     end
 
     class Builder

data/lib/alexa_generator/version.rb

@@ -1,3 +1,3 @@
 module AlexaGenerator
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/alexa_generator.rb

@@ -1,3 +1,3 @@
 require 'alexa_generator/interaction_model'
-require 'alexa_generator/alexa_syntax_error'
+require 'alexa_generator/errors'
 require 'alexa_generator/version'

data/spec/alexa_generator/intent_spec.rb

@@ -33,5 +33,13 @@ describe AlexaGenerator::Slot do
       expect(intent.slots.count).to eq(1)
       expect(intent.slots.first.name).to eq(:SlotOne)
     end
+    
+    it 'should whine when trying to add a slot to an Amazon intent' do
+      AlexaGenerator::Intent.build(AlexaGenerator::Intent::AmazonIntentType::CANCEL) do |intent|
+        expect {
+          intent.add_slot(:SlotOne, AlexaGenerator::Slot::SlotType::LITERAL)
+        }.to raise_error(AlexaGenerator::InvalidIntentError)
+      end
+    end
   end
 end

data/spec/alexa_generator/interaction_model_spec.rb

@@ -43,6 +43,56 @@ describe AlexaGenerator::InteractionModel do
                                          })
     end
 
+    it 'should allow built in intents' do
+      iface = AlexaGenerator::InteractionModel.build do |iface|
+        iface.add_intent(AlexaGenerator::Intent::AmazonIntentType::CANCEL)
+      end
+
+      expect(iface).to be_an_instance_of(AlexaGenerator::InteractionModel)
+      expect(iface.intent_schema).to eq(
+                                         {
+                                             intents: [
+                                                 {
+                                                     intent: :"AMAZON.CancelIntent",
+                                                     slots: []
+                                                 }
+                                             ]
+                                         })
+    end
+
+    it 'should combine custom and built in intents' do
+      iface = AlexaGenerator::InteractionModel.build do |iface|
+        iface.add_intent(AlexaGenerator::Intent::AmazonIntentType::CANCEL)
+        iface.add_intent(:IntentOne) do |intent|
+         intent.add_slot(:SlotOne, AlexaGenerator::Slot::SlotType::LITERAL) do |slot|
+            slot.add_binding('value1')
+          end
+
+          intent.add_utterance_template('test {SlotOne} test')
+        end
+      end
+
+      expect(iface).to be_an_instance_of(AlexaGenerator::InteractionModel)
+      expect(iface.intent_schema).to eq(
+                                         {
+                                             intents: [
+                                                 {
+                                                     intent: :"AMAZON.CancelIntent",
+                                                     slots: []
+                                                 },
+                                                 {
+                                                     intent: :IntentOne,
+                                                     slots: [
+                                                         {
+                                                             name: :SlotOne,
+                                                             type: AlexaGenerator::Slot::SlotType::LITERAL
+                                                         }
+                                                     ]
+                                                 }
+                                             ]
+                                         })
+    end
+
     it 'should produce bound utterances' do
       iface = AlexaGenerator::InteractionModel.build do |iface|
         iface.add_intent(:MyIntent) do |intent|
@@ -67,15 +117,10 @@ describe AlexaGenerator::InteractionModel do
 
       actual = iface.sample_utterances(:MyIntent)
 
-      expect(actual.count).to eq(8)
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {one|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {two|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {one|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {two|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {one|SlotTwo} at {6 a.m.|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {two|SlotTwo} at {6 a.m.|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {one|SlotTwo} at {6 a.m.|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {two|SlotTwo} at {6 a.m.|SlotThree}')
+      # only the literal ones get examples
+      expect(actual.count).to eq(2)
+      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {SlotTwo} at {SlotThree}')
+      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {SlotTwo} at {SlotThree}')
     end
   end
 
@@ -144,15 +189,10 @@ describe AlexaGenerator::InteractionModel do
     it 'should produce bound utterances' do
       actual = AlexaGenerator::InteractionModel.new(intents, utterance_templates, slot_bindings).sample_utterances(:MyIntent)
 
-      expect(actual.count).to eq(8)
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {one|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {two|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {one|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {two|SlotTwo} at {noon|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {one|SlotTwo} at {6 a.m.|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {two|SlotTwo} at {6 a.m.|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {one|SlotTwo} at {6 a.m.|SlotThree}')
-      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {two|SlotTwo} at {6 a.m.|SlotThree}')
+      # only the literal ones get examples
+      expect(actual.count).to eq(2)
+      expect(actual).to include('MyIntent Alexa, please {fix my motorcycle|SlotOne} {SlotTwo} at {SlotThree}')
+      expect(actual).to include('MyIntent Alexa, please {make me a sandwich|SlotOne} {SlotTwo} at {SlotThree}')
     end
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: alexa_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -44,14 +44,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - alexa_generator.gemspec
 - lib/alexa_generator.rb
-- lib/alexa_generator/alexa_syntax_error.rb
+- lib/alexa_generator/errors.rb
 - lib/alexa_generator/intent.rb
 - lib/alexa_generator/intent_schema.rb
 - lib/alexa_generator/interaction_model.rb
@@ -73,17 +73,17 @@ 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.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Generates voice interfaces for Alexa apps based on templates.