ralyxa-lambda 1.8.0

data/lib/ralyxa/response_entities/directives/audio.rb

@@ -0,0 +1,11 @@
+require_relative './audio/audio_item'
+require_relative './audio/stream'
+
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      module Audio
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/directives/audio/audio_item.rb

@@ -0,0 +1,23 @@
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      module Audio
+        class AudioItem
+          def initialize(stream)
+            @stream = stream
+          end
+
+          def to_h
+            {}.tap do |audio_item|
+              audio_item['stream'] = @stream.to_h
+            end
+          end
+
+          def self.as_hash(stream)
+            new(stream).to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/directives/audio/stream.rb

@@ -0,0 +1,37 @@
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      module Audio
+        class Stream
+          def initialize(url, token, offset_in_milliseconds = 0, expected_previous_token = nil)
+            raise Ralyxa::UnsecureUrlError, "Audio streams must be served from at an SSL-enabled (HTTPS) endpoint. Your current stream url is: #{url}" unless secure?(url)
+
+            @url                     = url
+            @token                   = token
+            @offset_in_milliseconds  = offset_in_milliseconds
+            @expected_previous_token = expected_previous_token
+          end
+
+          def to_h
+            {}.tap do |stream|
+              stream['url']                   = @url
+              stream['token']                 = @token
+              stream['offsetInMilliseconds']  = @offset_in_milliseconds
+              stream['expectedPreviousToken'] = @expected_previous_token if @expected_previous_token
+            end
+          end
+
+          def self.as_hash(url, token, offset_in_milliseconds = 0, expected_previous_token = nil)
+            new(url, token, offset_in_milliseconds, expected_previous_token).to_h
+          end
+
+          private
+
+          def secure?(url)
+            URI.parse(url).scheme == 'https' || !Ralyxa.require_secure_urls?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/directives/audio_player.rb

@@ -0,0 +1,46 @@
+require_relative './audio_player/clear_queue'
+require_relative './audio_player/play'
+require_relative './audio_player/stop'
+
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      class AudioPlayer
+        class << self
+          def play(url, token, speech: nil, card: nil, offset_in_milliseconds: 0, expected_previous_token: nil, behaviour: Ralyxa::ResponseEntities::Directives::AudioPlayer::Play::REPLACE_ALL, audio_player_class: Ralyxa::ResponseEntities::Directives::AudioPlayer::Play, response_builder: Ralyxa::ResponseBuilder)
+            directive = audio_player_class.as_hash(Ralyxa::ResponseEntities::Directives::Audio::Stream.new(url, token, offset_in_milliseconds, expected_previous_token), behaviour)
+
+            response_builder.build(build_options(directive, speech, card))
+          end
+
+          def play_later(url, token, speech: nil, card: nil, offset_in_milliseconds: 0, expected_previous_token: nil, behaviour: Ralyxa::ResponseEntities::Directives::AudioPlayer::Play::REPLACE_ENQUEUED, audio_player_class: Ralyxa::ResponseEntities::Directives::AudioPlayer::Play, response_builder: Ralyxa::ResponseBuilder)
+            play(url, token, speech: speech, card: card, offset_in_milliseconds: offset_in_milliseconds, expected_previous_token: expected_previous_token, behaviour: behaviour, audio_player_class: audio_player_class, response_builder: response_builder)
+          end
+
+          def stop(speech: nil, card: nil, audio_player_class: Ralyxa::ResponseEntities::Directives::AudioPlayer::Stop, response_builder: Ralyxa::ResponseBuilder)
+            directive = audio_player_class.as_hash
+
+            response_builder.build(build_options(directive, speech, card))
+          end
+
+          def clear_queue(speech: nil, card: nil, behaviour: Ralyxa::ResponseEntities::Directives::AudioPlayer::ClearQueue::CLEAR_ALL, audio_player_class: Ralyxa::ResponseEntities::Directives::AudioPlayer::ClearQueue, response_builder: Ralyxa::ResponseBuilder)
+            directive = audio_player_class.as_hash(behaviour)
+
+            response_builder.build(build_options(directive, speech, card))
+          end
+
+          private
+
+          def build_options(directive, speech, card)
+            {}.tap do |option|
+              option[:directives] = [directive]
+              option[:end_session] = false
+              option[:response_text] = speech if speech
+              option[:card] = card if card
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/directives/audio_player/clear_queue.rb

@@ -0,0 +1,27 @@
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      class AudioPlayer
+        class ClearQueue
+          CLEAR_ENQUEUED = 'CLEAR_ENQUEUED'.freeze
+          CLEAR_ALL = 'CLEAR_ALL'.freeze
+
+          def initialize(behaviour = Ralyxa::ResponseEntities::Directives::AudioPlayer::ClearQueue::CLEAR_ENQUEUED)
+            @behaviour = behaviour
+          end
+
+          def to_h
+            {}.tap do |audio_player|
+              audio_player['type'] = 'AudioPlayer.ClearQueue'
+              audio_player['clearBehavior'] = @behaviour
+            end
+          end
+
+          def self.as_hash(behaviour = Ralyxa::ResponseEntities::Directives::AudioPlayer::ClearQueue::CLEAR_ENQUEUED)
+            new(behaviour).to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/directives/audio_player/play.rb

@@ -0,0 +1,32 @@
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      class AudioPlayer
+        class Play
+          CLEAR_ENQUEUE    = 'CLEAR_ENQUEUE'.freeze
+          ENQUEUE          = 'ENQUEUE'.freeze
+          REPLACE_ALL      = 'REPLACE_ALL'.freeze
+          REPLACE_ENQUEUED = 'REPLACE_ENQUEUED'.freeze
+
+          def initialize(stream, behaviour = Ralyxa::ResponseEntities::Directives::AudioPlayer::Play::REPLACE_ALL)
+            @stream    = stream
+            @behaviour = behaviour
+          end
+
+          def to_h
+            {}.tap do |audio_player|
+              audio_player['type'] = 'AudioPlayer.Play'
+              audio_player['playBehavior'] = @behaviour
+
+              audio_player['audioItem'] = Ralyxa::ResponseEntities::Directives::Audio::AudioItem.new(@stream).to_h
+            end
+          end
+
+          def self.as_hash(stream, behaviour = nil)
+            new(stream, behaviour).to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/directives/audio_player/stop.rb

@@ -0,0 +1,19 @@
+module Ralyxa
+  module ResponseEntities
+    module Directives
+      class AudioPlayer
+        class Stop
+          def to_h
+            {}.tap do |audio_player|
+              audio_player['type'] = 'AudioPlayer.Stop'
+            end
+          end
+
+          def self.as_hash
+            new.to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/output_speech.rb

@@ -0,0 +1,35 @@
+module Ralyxa
+  module ResponseEntities
+    class OutputSpeech
+      DEFAULT_RESPONSE_TEXT = 'Hello World'.freeze
+      DEFAULT_RESPONSE_SSML = '<speak>Hello World</speak>'.freeze
+
+      def initialize(speech, ssml)
+        @speech = speech
+        @ssml   = ssml
+      end
+
+      def to_h
+        {}.tap do |output_speech|
+          @ssml ? add_ssml(output_speech) : add_plaintext(output_speech)
+        end
+      end
+
+      def self.as_hash(speech: nil, ssml: false)
+        new(speech, ssml).to_h
+      end
+
+      private
+
+      def add_ssml(output_speech)
+        output_speech[:type] = 'SSML'
+        output_speech[:ssml] = (@speech || DEFAULT_RESPONSE_SSML)
+      end
+
+      def add_plaintext(output_speech)
+        output_speech[:type] = 'PlainText'
+        output_speech[:text] = (@speech || DEFAULT_RESPONSE_TEXT)
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/reprompt.rb

@@ -0,0 +1,20 @@
+module Ralyxa
+  module ResponseEntities
+    class Reprompt
+      def initialize(reprompt_speech, reprompt_ssml)
+        @reprompt_speech = reprompt_speech
+        @reprompt_ssml   = reprompt_ssml
+      end
+
+      def to_h
+        {}.tap do |reprompt|
+          reprompt[:outputSpeech] = Ralyxa::ResponseEntities::OutputSpeech.as_hash(speech: @reprompt_speech, ssml: @reprompt_ssml)
+        end
+      end
+
+      def self.as_hash(reprompt_speech: nil, reprompt_ssml: false)
+        new(reprompt_speech, reprompt_ssml).to_h
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/response.rb

@@ -0,0 +1,54 @@
+require_relative './output_speech'
+require_relative './reprompt'
+require_relative './directives'
+
+module Ralyxa
+  module ResponseEntities
+    class Response
+      def initialize(output_speech, reprompt, session_attributes, end_session, start_over, card, directives)
+        @output_speech      = output_speech
+        @reprompt           = reprompt
+        @session_attributes = session_attributes
+        @end_session        = end_session
+        @start_over         = start_over
+        @card               = card
+        @directives         = directives
+      end
+
+      def to_h
+        {}.tap do |response|
+          add_version(response)
+          add_session_attributes(response)
+          add_response(response)
+        end
+      end
+
+      def self.as_hash(output_speech: false, reprompt: false, session_attributes: {}, end_session: false, start_over: false, card: false, directives: false)
+        new(output_speech, reprompt, session_attributes, end_session, start_over, card, directives).to_h
+      end
+
+      private
+
+      attr_reader :response
+
+      def add_version(response)
+        response[:version] = '1.0'
+      end
+
+      def add_session_attributes(response)
+        return response[:sessionAttributes] = {} if @start_over
+        response[:sessionAttributes] = @session_attributes unless @session_attributes.empty?
+      end
+
+      def add_response(response)
+        response[:response] = {}.tap do |response_object|
+          response_object[:outputSpeech]     = @output_speech if @output_speech
+          response_object[:reprompt]         = @reprompt      if @reprompt
+          response_object[:card]             = @card          if @card
+          response_object[:directives]       = @directives    if @directives
+          response_object[:shouldEndSession] = @end_session
+        end
+      end
+    end
+  end
+end

data/lib/ralyxa/skill.rb

@@ -0,0 +1,53 @@
+require_relative './request_entities/request'
+require_relative './handler'
+
+# Routes an incoming request to the correct Handler.
+module Ralyxa
+  class Skill
+    @handlers = {}
+
+    def initialize(request)
+      @request = request
+    end
+
+    def handle
+      handler = self.class.handlers[@request.intent_name]
+      handler ? handler.new(@request).handle : warn(handler_not_found)
+    end
+
+    class << self
+      def intent(intent_name, handler_base_class = Ralyxa::Handler, &intent_block)
+        intent_handler = Class.new(handler_base_class)
+        intent_handler.send(:define_method, :handle, &intent_block)
+        @handlers[intent_name] = intent_handler
+      end
+
+      def handle(request, alexa_request_wrapper = Ralyxa::RequestEntities::Request)
+        new(alexa_request_wrapper.new(request)).handle
+      end
+
+      def handlers
+        @handlers.dup
+      end
+    end
+
+    private
+
+    def handler_not_found
+      <<~HEREDOC
+        \e[33m
+        WARNING: An intent declaration for intent "#{@request.intent_name}" was not found.
+
+        To define it, add an intent declaration inside a directory called 'intents',
+        on the same directory level as the runfile for your server application.
+
+        You probably want something like:
+
+        intent "#{@request.intent_name}" do
+          respond("Hello World!")
+        end
+        \e[0m
+      HEREDOC
+    end
+  end
+end

data/lib/ralyxa/version.rb

@@ -0,0 +1,3 @@
+module Ralyxa
+  VERSION = '1.8.0'.freeze
+end

data/ralyxa.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ralyxa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ralyxa-lambda'
+  spec.version       = Ralyxa::VERSION
+  spec.authors       = ['Sam Morgan']
+  spec.email         = ['samm@makersacademy.com']
+
+  spec.summary       = 'A Ruby framework for interacting with Amazon Alexa and lambda support'
+  spec.description   = 'A Ruby framework for interacting with Amazon Alexa. Designed to work with Sinatra, although can be used with a few other web frameworks.'
+  spec.homepage      = 'https://github.com/sjmog/ralyxa'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.1'
+
+  spec.add_dependency 'alexa_verifier', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_development_dependency 'vcr',     '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: ralyxa-lambda
+version: !ruby/object:Gem::Version
+  version: 1.8.0
+platform: ruby
+authors:
+- Sam Morgan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alexa_verifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: A Ruby framework for interacting with Amazon Alexa. Designed to work
+  with Sinatra, although can be used with a few other web frameworks.
+email:
+- samm@makersacademy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".tool-versions"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ralyxa.rb
+- lib/ralyxa/configuration.rb
+- lib/ralyxa/errors.rb
+- lib/ralyxa/handler.rb
+- lib/ralyxa/register_intents.rb
+- lib/ralyxa/request_entities/request.rb
+- lib/ralyxa/request_entities/user.rb
+- lib/ralyxa/response_builder.rb
+- lib/ralyxa/response_entities/card.rb
+- lib/ralyxa/response_entities/directives.rb
+- lib/ralyxa/response_entities/directives/audio.rb
+- lib/ralyxa/response_entities/directives/audio/audio_item.rb
+- lib/ralyxa/response_entities/directives/audio/stream.rb
+- lib/ralyxa/response_entities/directives/audio_player.rb
+- lib/ralyxa/response_entities/directives/audio_player/clear_queue.rb
+- lib/ralyxa/response_entities/directives/audio_player/play.rb
+- lib/ralyxa/response_entities/directives/audio_player/stop.rb
+- lib/ralyxa/response_entities/output_speech.rb
+- lib/ralyxa/response_entities/reprompt.rb
+- lib/ralyxa/response_entities/response.rb
+- lib/ralyxa/skill.rb
+- lib/ralyxa/version.rb
+- pkg/ralyxa-1.0.0.gem
+- ralyxa.gemspec
+homepage: https://github.com/sjmog/ralyxa
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby framework for interacting with Amazon Alexa and lambda support
+test_files: []