alexa_ruby 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c64a178ea35c5280218a441dcc9993679965990c
-  data.tar.gz: aaf9815ad8f4fcd99e9a9f623aeb973eb9ffdbdd
+  metadata.gz: dd7bd13bd046d4f22c745be4e01c7bafe6970e72
+  data.tar.gz: 125194d8fff5eae293104ab729ca1a8f014a9a59
 SHA512:
-  metadata.gz: ff171ca1e709b0fde16930e42a9e49f08b5d788eda174de7ea727356b5e82d0a958646d6dbb825b2bf8fb3c33694ecb10d4e9dcc423b06ad1b6a0c040660f928
-  data.tar.gz: fadf34ec57b1d7aaf6a4b0c9ce9f2cec734a02769c49378e3f58fd2bd00d41a716e8991ca657d7d99092552d81680a0ee10d12b6d6f4c8e31dbfb9f77779f2ba
+  metadata.gz: acb690cb6c31f1ce5a721f122fbedad6f513cb3e4f326a23b3882881d623fce35e1f1fc2f360d22306937fe02437b8a1d7ce2179362476cf2b51cd20ec4ecacb
+  data.tar.gz: ad3c6b4b4cb8bd191e55354b51c26e983d6c60601a57d5af705776b2a85b435a0247d72582a4ab5948593bf041fec649a44008508b0785b294b5e7c2fb9170d2

data/CHANGELOG

@@ -0,0 +1,4 @@
+[1.2.0]
+- Add support of ENQUEUE type in AudioPlayer directive
+- Add support of AudioPlayer.ClearQueue directive
+- Minor refactoring

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alexa_ruby (1.0.4)
+    alexa_ruby (1.2.0)
       bundler (>= 1.6.9)
       oj (~> 3.0)
       rake

data/README.md

@@ -172,14 +172,48 @@ alexa.response.add_card(card)
 
 #### Add audio player directive
 
-Supported directives - AudioPlayer.Play and AudioPlayer.Stop.  
-To start playback call:
+Supported directives:
+
+ - AudioPlayer.Play
+ - AudioPlayer.ClearQueue
+ - AudioPlayer.Stop
+
+To start the whole new playback call:
 
 ```ruby
 params = { url: 'https://my-site.com/my-stream', token: 'test', offset: 0 }
 alexa.response.add_audio_player_directive(:start, params)
 ```
 
+To enqueue new audio file call:
+
+```ruby
+params = { url: 'https://my-site.com/my-stream', token: 'test', offset: 0, play_behavior: :enqueue }
+alexa.response.add_audio_player_directive(:start, params)
+```
+
+To replace all previously enqueued audio files call:
+
+```ruby
+params = { url: 'https://my-site.com/my-stream', token: 'test', offset: 0, play_behavior: :replace_enqueued }
+alexa.response.add_audio_player_directive(:start, params)
+```
+
+To clear all:
+
+```ruby
+alexa.response.add_audio_player_directive(:clear)
+```
+
+To clear only enqueued tracks and keep the playing one:
+
+```ruby
+alexa.response.add_audio_player_directive(
+  :clear,
+  clear_behavior: :clear_queue
+)
+```
+
 To stop playback call:
 
 ```ruby

data/lib/alexa_ruby/response/audio_player.rb

@@ -4,45 +4,78 @@ module AlexaRuby
     # Build an AudioPlayer.Play directive
     #
     # @param params [Hash] optional request parameters:
+    #   behavior [Symbol] playback behavior
     #   url [String] streaming URL
     #   token [String] streaming service token
+    #   previous_token [String] previous played audio token
     #   offset [Integer] playback offset
     # @return [Hash] AudioPlayer.Play directive
     # @raise [ArgumentError] if audio URL isn't valid
-    def play_directive(params)
-      url = params[:url]
-      if invalid_url?(url)
+    def play(params)
+      @opts = params
+      if invalid_url?(@opts[:url])
         raise ArgumentError, 'Audio URL must be a valid ' \
                               'SSL-enabled (HTTPS) endpoint'
       end
-      token = token(params[:token])
-      offset = params[:offset] || 0
-      build_directive('AudioPlayer.Play', url, token, offset)
+      play_directive
     end
 
     # Build AudioPlayer.Stop directive
     #
     # @return [Hash] AudioPlayer.Stop directive
-    def stop_directive
-      build_directive('AudioPlayer.Stop')
+    def stop
+      { type: 'AudioPlayer.Stop' }
+    end
+
+    # Build AudioPlayer.ClearQueue directive
+    #
+    # @param behavior [Symbol] clearing behavior
+    # @return [Hash] AudioPlayer.ClearQueue directive
+    def clear_queue(behavior = :clear_all)
+      clear_behavior =
+        case behavior
+        when :clear_all
+          'CLEAR_ALL'
+        when :clear_queue
+          'CLEAR_ENQUEUED'
+        else
+          'CLEAR_ALL'
+        end
+      { type: 'AudioPlayer.ClearQueue', clearBehavior: clear_behavior }
     end
 
     private
 
-    # Set play directive parameters
+    # Define playback behavior
+    #
+    # @param behavior [Symbol] playback behavior
+    # @return [String] Amazon behavior type
+    def playback_behavior(behavior)
+      case behavior
+      when :replace_all
+        'REPLACE_ALL'
+      when :enqueue
+        'ENQUEUE'
+      when :replace_enqueued
+        'REPLACE_ENQUEUED'
+      else
+        'REPLACE_ALL'
+      end
+    end
+
+    # Build play directive
     #
-    # @param type [String] directive type, can be Play or Stop
-    # @param url [String] streaming service URL
-    # @param token [String] streaming service token
-    # @param offset [Integer] playback offset
-    def build_directive(type, url = nil, token = nil, offset = nil)
-      directive = { type: type }
-      return directive if type == 'AudioPlayer.Stop'
-      directive[:playBehavior] = 'REPLACE_ALL'
-      directive[:audioItem] = { stream: {} }
-      directive[:audioItem][:stream][:url] = url
-      directive[:audioItem][:stream][:token] = token
-      directive[:audioItem][:stream][:offsetInMilliseconds] = offset
+    # @return [Hash] ready to use AudioPlayer.Play directive
+    def play_directive
+      directive = { type: 'AudioPlayer.Play' }
+      directive[:playBehavior] = playback_behavior(@opts[:play_behavior])
+      directive[:audioItem] = { stream: { url: @opts[:url] } }
+      stream = directive[:audioItem][:stream]
+      stream[:token] = token(@opts[:token])
+      stream[:offsetInMilliseconds] = @opts[:offset] || 0
+      if @opts[:behavior] == :enqueue
+        stream[:expectedPreviousToken] = @opts[:previous_token]
+      end
       directive
     end
 

data/lib/alexa_ruby/response/response.rb

@@ -22,12 +22,7 @@ module AlexaRuby
     # @raise [ArgumentError] if session key is already added and
     #   rewrite is set to false
     def add_session_attribute(key, value, rewrite = false)
-      unless rewrite
-        if @resp[:sessionAttributes].key?(key)
-          raise ArgumentError, 'Duplicate session attributes not allowed'
-        end
-      end
-      @resp[:sessionAttributes][key] = value
+      session_attribute(key, value, rewrite)
     end
 
     # Add pack of session attributes and overwrite all existing ones
@@ -75,14 +70,16 @@ module AlexaRuby
     #   url [String] streaming URL
     #   token [String] streaming service token
     #   offset [Integer] playback offset
+    #   replace_all [Boolean] true if stream must replace all previous
     def add_audio_player_directive(directive, params = {})
-      player = AudioPlayer.new
       @resp[:response][:directives] = [
         case directive.to_sym
         when :start
-          player.play_directive(params)
+          AudioPlayer.new.play(params)
         when :stop
-          player.stop_directive
+          AudioPlayer.new.stop
+        when :clear
+          AudioPlayer.new.clear_queue(params[:clear_behavior])
         end
       ]
     end
@@ -153,18 +150,34 @@ module AlexaRuby
 
     private
 
+    # Add one session attribute
+    #
+    # @param key [String] atrribute key
+    # @param value [String] attribute value
+    # @param rewrite [Boolean] rewrite if key already exists?
+    # @raise [ArgumentError] if session key is already added and
+    #   rewrite is set to false
+    def session_attribute(key, value, rewrite = false)
+      unless rewrite
+        if @resp[:sessionAttributes].key?(key)
+          raise ArgumentError, 'Duplicate session attributes not allowed'
+        end
+      end
+      @resp[:sessionAttributes][key] = value
+    end
+
     # Add pack of session attributes.
     # By default all existing session attributes would be overwritten
     #
     # @param attributes [Hash] pack of session attributes
     # @param merge [Boolean] merge attributes with existing ones?
     def session_attributes(attributes, merge)
-      if merge
-        attributes.each { |k, v| add_session_attribute(k, v, true) }
-      else
+      rewrite = true
+      unless merge
         @resp[:sessionAttributes] = {}
-        attributes.each { |k, v| add_session_attribute(k, v, false) }
+        rewrite = false
       end
+      attributes.each { |k, v| session_attribute(k, v, rewrite) }
     end
 
     # Build speech object
@@ -173,13 +186,8 @@ module AlexaRuby
     # @param ssml [Boolean] is it an SSML speech or not
     # @return [Hash] speech object
     def build_speech(speech, ssml)
-      obj = {}
-      obj[:type] = ssml ? 'SSML' : 'PlainText'
-      if ssml
-        obj[:ssml] = fix_ssml(speech)
-      else
-        obj[:text] = speech
-      end
+      obj = { type: ssml ? 'SSML' : 'PlainText' }
+      ssml ? obj[:ssml] = fix_ssml(speech) : obj[:text] = speech
       obj
     end
 

data/lib/alexa_ruby/version.rb

@@ -1,3 +1,3 @@
 module AlexaRuby
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alexa_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Mulev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for Amazon Alexa API