alexa_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93ed501db9265d681f6b82b67eefff6879c60cdd
+  data.tar.gz: 62dcf0154f9e5dc67d091f45d0bff9ccef19ebfa
+SHA512:
+  metadata.gz: d771952eb751937874abe1f2143b0e3d029ebd19b0c058fd91e23fadc70f0bf61673ba2ed330ef7dee57fd2dd63202349cbfb925ffeb86b95697946b1a6668b2
+  data.tar.gz: '0082c8ee544e27754be23a0132e7ddeb42924840e19684182891d6094325bb56c1300624d418d876d2fbb9fc86279a4fd6e9bdb4facea0daa2cf73207b5ec703'

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.3.4'
+
+# Specify your gem's dependencies in alexa_rubykit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    alexa_ruby (0.0.0)
+      bundler (~> 1.7)
+      oj (~> 3.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    oj (3.0.10)
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  alexa_ruby!
+  rspec (~> 3.2, >= 3.2.0)
+  rspec-mocks (~> 3.2, >= 3.2.0)
+
+RUBY VERSION
+   ruby 2.3.4p301
+
+BUNDLED WITH
+   1.15.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Damian Finol
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,5 @@
+# AlexaRuby
+
+[![Build Status](https://travis-ci.org/mulev/alexa-ruby.svg?branch=master)](https://travis-ci.org/mulev/alexa-ruby)
+
+Originally forked from damianFC's AlexaRubykit, this gem implements a back-end service for interaction with Amazon Alexa API.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/lib/alexa_ruby/intent_request.rb

@@ -0,0 +1,60 @@
+module AlexaRuby
+  class IntentRequest < Request
+    attr_accessor :intent, :name, :slots
+
+    # We still don't know if all of the parameters in the request are required.
+    # Checking for the presence of intent on an IntentRequest.
+    def initialize(json_request)
+      super
+      @intent = json_request['request']['intent']
+      raise ArgumentError, 'Intent should exist on an IntentRequest' if @intent.nil?
+      @type = 'INTENT_REQUEST'
+      @name  = @intent['name']
+      @slots = @intent['slots']
+    end
+
+    # Takes a Hash object.
+    def add_hash_slots(slots)
+      raise ArgumentError, 'Slots can\'t be empty'
+      slots.each do |slot|
+        @slots[:slot[:name]] = Slot.new(slot[:name], slot[:value])
+      end
+      @slots
+    end
+
+    # Takes a JSON Object and symbolizes its keys.
+    def add_slots(slots)
+      slot_hash = AlexaRuby.transform_keys_to_symbols(value)
+      add_hash_slots(slot_hash)
+    end
+
+    # Adds a slot from a name and a value.
+    def add_slot(name, value)
+      slot = Slot.new(name, value)
+      @slots[:name] = slot
+      slot
+    end
+
+    # Outputs the Intent Name, request Id and slot information.
+    def to_s
+      "IntentRequest: #{name} requestID: #{request_id}  Slots: #{slots}"
+    end
+  end
+
+  # Class that encapsulates each slot.
+  class Slot
+    attr_accessor :name, :value
+
+    # Each slot has a name and a value.
+    def initialize(name, value)
+      raise ArgumentError, 'Need a name and a value' if name.nil? || value.nil?
+      @name = name
+      @value = value
+    end
+
+    # Outputs Slot name and value.
+    def to_s
+      "Slot Name: #{name}, Value: #{value}"
+    end
+  end
+end

data/lib/alexa_ruby/launch_request.rb

@@ -0,0 +1,15 @@
+module AlexaRuby
+  class LaunchRequest  < Request
+    # We still don't know if all of the parameters in the request are required.
+    # Checking for the presence of intent on an IntentRequest.
+    def initialize(json_request)
+      super
+      @type = 'LAUNCH_REQUEST'
+    end
+
+    # Outputs the launch requestID.
+    def to_s
+      "LaunchRequest requestID: #{request_id}"
+    end
+  end
+end

data/lib/alexa_ruby/request.rb

@@ -0,0 +1,47 @@
+module AlexaRuby
+# Echo can send 3 types of requests
+# - LaunchRequest: The start of the app.
+# - IntentRequest: The intent of the app.
+# - SessionEndedRequest: Session has ended.
+  class Request
+    require 'json'
+    require 'alexa_ruby/session'
+    attr_accessor :version, :type, :session, :json # global
+    attr_accessor :request_id, :locale # on request
+
+    def initialize(json_request)
+      @request_id = json_request['request']['requestId']
+      raise ArgumentError, 'Request ID should exist on all Requests' if @request_id.nil?
+      @version = json_request['version']
+      @locale = json_request['request']['locale']
+      @json   = json_request
+
+      # TODO: We probably need better session handling.
+      @session = AlexaRuby::Session.new(json_request['session'])
+    end
+  end
+
+  # Builds a new request for Alexa.
+  def self.build_request(json_request)
+    raise ArgumentError, 'Invalid Alexa Request.' unless AlexaRuby.valid_alexa?(json_request)
+    @request = nil
+    case json_request['request']['type']
+      when /Launch/
+        @request = LaunchRequest.new(json_request)
+      when /Intent/
+        @request = IntentRequest.new(json_request)
+      when /SessionEnded/
+        @request = SessionEndedRequest.new(json_request)
+      else
+        raise ArgumentError, 'Invalid Request Type.'
+    end
+    @request
+  end
+
+  # Take keys of hash and transform those to a symbols
+  def self.transform_keys_to_symbols(value)
+    return value if not value.is_a?(Hash)
+    hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = self.transform_keys_to_symbols(v); memo}
+    return hash
+  end
+end

data/lib/alexa_ruby/response/audio_player.rb

@@ -0,0 +1,33 @@
+module AlexaRuby
+  # AudioPlayer class encapsulates all Alexa audio player directives
+  class AudioPlayer
+    # Build an AudioPlayer.Play directive
+    #
+    # @param url [String] audio stream URL
+    # @param token [String] some token that represents the audio stream
+    # @param offset [Integer] the timestamp in the stream from which Alexa should begin playback
+    # @return [Hash] AudioPlayer.Play directive
+    def play_directive(url, token, offset)
+      {
+        type: 'AudioPlayer.Play',
+        playBehavior: 'REPLACE_ALL',
+        audioItem: {
+          stream: {
+            token: token,
+            url: url,
+            offsetInMilliseconds: offset
+          }
+        }
+      }
+    end
+
+    # Build AudioPlayer.Stop directive
+    #
+    # @return [Hash] AudioPlayer.Stop directive
+    def stop_directive
+      {
+        type: 'AudioPlayer.Stop'
+      }
+    end
+  end
+end

data/lib/alexa_ruby/response.rb

@@ -0,0 +1,130 @@
+module AlexaRuby
+  class Response
+    require 'json'
+    require 'alexa_ruby/response/audio_player'
+    attr_accessor :version, :session, :response_object, :session_attributes, :speech, :reprompt, :response, :card
+
+    # Every response needs a shouldendsession and a version attribute
+    # We initialize version to 1.0, use add_version to set your own.
+    def initialize(version = '1.0')
+      @session_attributes = Hash.new
+      @version = version
+      @directives = []
+    end
+
+    # Adds a key,value pair to the session object.
+    def add_session_attribute(key, value)
+      @session_attributes[key.to_sym] = value
+    end
+
+    def add_speech(speech_text, ssml = false)
+      if ssml
+        @speech = { :type => 'SSML', :ssml => check_ssml(speech_text) }
+      else
+        @speech = { :type => 'PlainText', :text => speech_text }
+      end
+      @speech
+    end
+
+    # Add a directive to start audio playback
+    def start_audio_playback(url, token = '', offset = 0)
+      player = AudioPlayer.new
+      @directives = [ player.play_directive(url, token, offset) ]
+    end
+
+    # Add directive to stop audio playback
+    def stop_audio_playback
+      player = AudioPlayer.new
+      @directives = [ player.stop_directive ]
+    end
+
+    def add_reprompt(speech_text, ssml = false)
+      if ssml
+        @reprompt = { "outputSpeech" => { :type => 'SSML', :ssml => check_ssml(speech_text) } }
+      else
+        @reprompt = { "outputSpeech" => { :type => 'PlainText', :text => speech_text } }
+      end
+      @reprompt
+    end
+
+    #
+    #"type": "string",
+    #    "title": "string",
+    #    "subtitle": "string",
+    #    "content": "string"
+    def add_card(type = nil, title = nil , subtitle = nil, content = nil)
+      # A Card must have a type which the default is Simple.
+      @card = Hash.new()
+      @card[:type] = type || 'Simple'
+      @card[:title] = title unless title.nil?
+      @card[:subtitle] = subtitle unless subtitle.nil?
+      @card[:content] = content unless content.nil?
+      @card
+    end
+
+    # The JSON Spec says order shouldn't matter.
+    def add_hash_card(card)
+      card[:type] = 'Simple' if card[:type].nil?
+      @card = card
+      @card
+    end
+
+    # Adds a speech to the object, also returns a outputspeech object.
+    def say_response(speech, end_session = true, ssml = false)
+      output_speech = add_speech(speech,ssml)
+      { :outputSpeech => output_speech, :shouldEndSession => end_session }
+    end
+
+    # Incorporates reprompt in the SDK 2015-05
+    def say_response_with_reprompt(speech, reprompt_speech, end_session = true, speech_ssml = false, reprompt_ssml = false)
+      output_speech = add_speech(speech,speech_ssml)
+      reprompt_speech = add_reprompt(reprompt_speech,reprompt_ssml)
+      { :outputSpeech => output_speech, :reprompt => reprompt_speech, :shouldEndSession => end_session }
+    end
+
+
+    # Creates a session object. We pretty much only use this in testing.
+    def build_session
+      # If it's empty assume user doesn't need session attributes.
+      @session_attributes = Hash.new if @session_attributes.nil?
+      @session = { :sessionAttributes => @session_attributes }
+      @session
+    end
+
+    # The response object (with outputspeech, cards and session end)
+    # Should rename this, but Amazon picked their names.
+    # The only mandatory field is end_session which we default to true.
+    def build_response_object(session_end = true)
+      @response = Hash.new
+      @response[:outputSpeech] = @speech unless @speech.nil?
+      @response[:directives] = @directives unless @directives.empty?
+      @response[:card] = @card unless @card.nil?
+      @response[:reprompt] = @reprompt unless session_end && @reprompt.nil?
+      @response[:shouldEndSession] = session_end
+      @response
+    end
+
+    # Builds a response.
+    # Takes the version, response and should_end_session variables and builds a JSON object.
+    def build_response(session_end = true)
+      response_object = build_response_object(session_end)
+      response = Hash.new
+      response[:version] = @version
+      response[:sessionAttributes] = @session_attributes unless @session_attributes.empty?
+      response[:response] = response_object
+      response.to_json
+    end
+
+    # Outputs the version, session object and the response object.
+    def to_s
+      "Version => #{@version}, SessionObj => #{@session}, Response => #{@response}"
+    end
+
+    private
+
+      def check_ssml(ssml_string)
+        ssml_string = ssml_string.strip[0..6] == "<speak>" ? ssml_string : "<speak>" + ssml_string
+        ssml_string.strip[-8..1] == "</speak>" ? ssml_string : ssml_string + "</speak>"
+      end
+  end
+end

data/lib/alexa_ruby/session.rb

@@ -0,0 +1,37 @@
+module AlexaRuby
+  # Handles the session object in request.
+  class Session
+    attr_accessor :new, :session_id, :attributes, :user
+    def initialize (session)
+      raise ArgumentError, 'Invalid Session' if session.nil? || session['new'].nil? || session['sessionId'].nil?
+      @new = session['new']
+      @session_id = session['sessionId']
+      session['attributes'].nil? ? @attributes = Hash.new  : @attributes = session['attributes']
+      @user = session['user']
+    end
+
+    # Returns whether this is a new session or not.
+    def new?
+      !!@new
+    end
+
+    # Returns true if a user is defined.
+    def user_defined?
+      !@user.nil? || !@user['userId'].nil?
+    end
+
+    # Returns the user_id.
+    def user_id
+      @user['userId'] if @user
+    end
+
+    def access_token
+      @user['accessToken'] if @user
+    end
+
+    # Check to see if attributes are present.
+    def has_attributes?
+      !@attributes.empty?
+    end
+  end
+end

data/lib/alexa_ruby/session_ended_request.rb

@@ -0,0 +1,20 @@
+# Session end request class.
+module AlexaRuby
+  class SessionEndedRequest < Request
+    attr_accessor :reason
+
+    # TODO: Validate the reason.
+    # We still don't know if all of the parameters in the request are required.
+    # Checking for the presence of intent on an IntentRequest.
+    def initialize(json_request)
+      super
+      @type = 'SESSION_ENDED_REQUEST'
+      @reason = json_request['request']['reason']
+    end
+
+    # Ouputs the request_id and the reason why.
+    def to_s
+      "Session Ended for requestID: #{request_id} with reason #{reason}"
+    end
+  end
+end

data/lib/alexa_ruby/version.rb

@@ -0,0 +1,3 @@
+module AlexaRuby
+  VERSION = '0.1.0'.freeze
+end

data/lib/alexa_ruby.rb

@@ -0,0 +1,24 @@
+require 'alexa_ruby/request'
+require 'alexa_ruby/version'
+require 'alexa_ruby/response'
+require 'alexa_ruby/intent_request'
+require 'alexa_ruby/launch_request'
+require 'alexa_ruby/session_ended_request'
+
+module AlexaRuby
+  # Prints a JSON object.
+  def self.print_json(json)
+    p json
+  end
+
+  # Prints the Gem version.
+  def self.print_version
+    p AlexaRuby::VERSION
+  end
+
+  # Returns true if all the Alexa request objects are set.
+  def self.valid_alexa?(request_json)
+    !request_json.nil? && !request_json['session'].nil? &&
+        !request_json['version'].nil? && !request_json['request'].nil?
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: alexa_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Mulev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Ruby toolkit for Amazon Alexa API
+email:
+- m.mulev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/alexa_ruby.rb
+- lib/alexa_ruby/intent_request.rb
+- lib/alexa_ruby/launch_request.rb
+- lib/alexa_ruby/request.rb
+- lib/alexa_ruby/response.rb
+- lib/alexa_ruby/response/audio_player.rb
+- lib/alexa_ruby/session.rb
+- lib/alexa_ruby/session_ended_request.rb
+- lib/alexa_ruby/version.rb
+homepage: https://github.com/mulev/alexa-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby toolkit for Amazon Alexa API
+test_files: []