alexa-rails 0.1.1

data/lib/alexa/intent_handlers/base.rb

@@ -0,0 +1,158 @@
+module Alexa
+  module IntentHandlers
+    class Base
+      class << self
+        def inherited(subclass)
+          subclass.instance_variable_set("@_required_slot_names", _required_slot_names.clone)
+        end
+
+        # Lets you set +required_slot_names+ per subclass
+        #
+        # class IntentHandlers::NewIntent < IntentHandlers::Base
+        #   required_slot_names :Function, :CareerLevel
+        # end
+        #
+        # handler = IntentHandlers::NewIntent.new
+        # handler.required_slot_names   # => [:Function, :CareerLevel]
+
+        def _required_slot_names
+          @_required_slot_names ||= []
+        end
+
+        def required_slot_names(*names)
+          @_required_slot_names = names.map(&:to_s)
+        end
+      end
+
+      attr_accessor :context
+
+      def initialize(alexa_context)
+        @context = alexa_context
+      end
+
+      def request
+        context.request
+      end
+
+      def handle
+        raise "Override .handle"
+      end
+
+      def session
+        request.session
+      end
+
+      def response
+        @_response ||= Alexa::Response.new(intent: self)
+      end
+
+      def say_welcome?
+        @say_welcome == true
+      end
+
+      def slots
+        request.slots
+      end
+
+      def intent_usage_count
+        @_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?
+        empty_slots.empty?
+      end
+
+      def has_required_slots?
+        non_empty_slot_names = non_empty_slots.map { |_, s| s.name }
+        (required_slot_names - non_empty_slot_names).empty?
+      end
+
+      def empty_slots
+        @_empty_slots ||= slots.select { |name, slot| slot.value.nil? }
+      end
+
+      def non_empty_slots
+        @_non_empty_slots ||= slots.select { |name, slot| !slot.value.nil? }
+      end
+
+      def unmatched_slots
+        @_unmatched_slots ||= slots.select { |_, slot| slot.bad_match? }
+      end
+
+      def required_slot_names
+        self.class._required_slot_names
+      end
+
+      def intent_confirmed?
+        # TODO: Move this to Alexa::Request
+        request.params["request"]["intent"]["confirmationStatus"] == "CONFIRMED"
+      end
+
+      def intent_denied?
+        # TODO: Move this to Alexa::Request
+        request.params["request"]["intent"]["confirmationStatus"] == "DENIED"
+      end
+
+      def dialog_complete?
+        dialog_state == "COMPLETED"
+      end
+
+      def has_unmatched_slots?
+        unmatched_slots.any?
+      end
+
+      def dialog_state
+        request.dialog_state
+      end
+
+      def sorry_response
+        {
+          "version": "1.0",
+          sessionAttributes: session,
+          "response": {
+            "outputSpeech": {
+              "type": "PlainText",
+              "ssml": "Sorry! Looks like I couldn't process your request, may be try something else?"
+            },
+            "shouldEndSession": false
+          }
+        }
+      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
+
+      def bye_response
+        @_bye_response ||= Alexa::Responses::Bye.new(intent: self)
+      end
+
+      def say_welcome!
+        @say_welcome = true
+      end
+
+      def video_supported?
+        context.device.video_supported?
+      end
+
+      def audio_supported?
+        context.device.audio_supported?
+      end
+    end
+  end
+end

data/lib/alexa/request.rb

@@ -0,0 +1,97 @@
+module Alexa
+  class Request
+    attr_accessor :body, :params
+
+    def initialize(request)
+      @req = request
+      @body = request.body
+      @params = if request.body.size > 0
+                  request.body.rewind
+                  JSON.parse(request.body.read).with_indifferent_access
+                else
+                  {}
+                 end
+    end
+
+    def application_id
+      session.application_id
+    end
+
+    def user_id
+      session.user_id
+    end
+
+    def type
+      params["request"]["type"]
+    end
+
+    def intent_request?
+      type == "IntentRequest"
+    end
+
+    def launch_request?
+      type == "LaunchRequest"
+    end
+
+    def session_ended_request?
+      type == "SessionEndedRequest"
+    end
+
+    def help_request?
+      intent_request? && intent_name == "AMAZON.HelpIntent"
+    end
+
+    def cancel_request?
+      intent_request? && intent_name == "AMAZON.CancelIntent"
+    end
+
+    def session
+      @_session ||= Alexa::Session.new(params["session"].dup)
+    end
+
+    def slots
+      @_slots ||= begin
+                    if intent_request?
+                      return [] if help_request?
+                      return [] if cancel_request?
+
+                      params["request"]["intent"]["slots"]
+                        .inject(HashWithIndifferentAccess.new) do |hash, slot|
+                        name = slot[0]
+                        data = slot[1]
+                        hash[name] = Alexa::Slot.new(data)
+                        hash
+                      end
+                    else
+                      []
+                    end
+                  end
+    end
+
+    def dialog_state
+      params["request"]["dialogState"]
+    end
+
+    def valid?
+      Rails.configuration.x.alexa.skill_ids.include?(application_id)
+    end
+
+    def intent_name
+      return nil if !intent_request?
+      params["request"]["intent"]["name"]
+    end
+
+    def locale
+      request_locale = params["request"]["locale"]
+      case params["request"]["locale"]
+      when "en-US", "en-GB", "en-IN", 'en-CA'
+        # this is to match pjpp locale codes
+        params["request"]["locale"].gsub("-", "_").downcase
+      when "de-DE"
+        "de"
+      else
+        "en_gb"
+      end
+    end
+  end
+end

data/lib/alexa/response.rb

@@ -0,0 +1,85 @@
+module Alexa
+  class Response
+    attr_accessor :intent, :directives
+
+    def initialize(intent:, directives: [])
+      @intent = intent
+      @directives = directives
+      @slots_to_not_render_elicitation = []
+    end
+
+    # Marks a slot for elicitation.
+    #
+    # Options:
+    #  - skip_render: Lets you skip the rendering of the elicited slot's view.
+    #                 Helpful when you have the elication text already in the
+    #                 response and don't wanna override it.
+    def elicit_slot!(slot_to_elicit, skip_render: false)
+      directives << {
+        type: "Dialog.ElicitSlot",
+        slotToElicit: slot_to_elicit
+      }
+
+      if skip_render
+        @slots_to_not_render_elicitation << slot_to_elicit
+      end
+    end
+
+    def partial_path(format: :ssml, filename: nil)
+      if elicit_directives.any?
+        slot_to_elicit = elicit_directives.first[:slotToElicit]
+      end
+
+      template_path = "alexa/#{intent.context.locale}/intent_handlers/"\
+        "#{intent.class.name.demodulize.underscore}"
+
+      if filename.present?
+        if format == :ssml
+          "#{template_path}/#{filename}.ssml.erb"
+        else
+          "#{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"
+          else
+            "#{template_path}/elicitations/#{slot_to_elicit.underscore}.text.erb"
+          end
+        else
+          if format == :ssml
+            "#{template_path}/speech.ssml.erb"
+          else
+            "#{template_path}/display.text.erb"
+          end
+        end
+      end
+    end
+
+    def elicit_directives
+      return [] if directives.empty?
+      directives.select { |directive| directive[:type] == "Dialog.ElicitSlot" }
+    end
+
+    def keep_listening!
+      @keep_listening = true
+      self
+    end
+
+    def keep_listening?
+      @keep_listening == true
+    end
+
+    def end_session?
+      return false if keep_listening?
+      return false if elicit_directives.any?
+      return true
+    end
+  end
+end

data/lib/alexa/responses/bye.rb

@@ -0,0 +1,26 @@
+module Alexa
+  module Responses
+    class Bye < Alexa::Response
+      attr_accessor :intent, :directives
+
+      def initialize(intent:, directives: [])
+        @intent = intent
+      end
+
+      def partial_path(format: :ssml)
+        template_path = "alexa/#{intent.context.locale}/intent_handlers/"\
+          "#{intent.class.name.demodulize.underscore}"
+
+        if format == :ssml
+          "#{template_path}/bye.ssml.erb"
+        else
+          "#{template_path}/bye.text.erb"
+        end
+      end
+
+      def end_session?
+        true
+      end
+    end
+  end
+end

data/lib/alexa/responses/delegate.rb

@@ -0,0 +1,18 @@
+module Alexa
+  module Responses
+    class Delegate
+      def as_json(options={})
+        {
+          "version": "1.0",
+          "response": {
+            "directives": [
+              {
+                "type": "Dialog.Delegate"
+              }
+            ]
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Alexa
+  module Responses
+    module PermissionConsents
+      class DeviceAddress < Alexa::Response
+        attr_accessor :intent, :directives
+
+        def initialize(intent:, directives: [])
+          @intent = intent
+        end
+
+        def partial_path(format: :ssml)
+          if format == :ssml
+            "alexa/#{intent.context.locale}/intent_handlers/"\
+              "#{intent.class.name.demodulize.underscore}"\
+              "/permission_consents/"\
+              "device_address.ssml.erb"
+          else
+            "alexa/permission_consents/device_address.text.erb"
+          end
+        end
+
+        def end_session?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/alexa/session.rb

@@ -0,0 +1,35 @@
+module Alexa
+  class Session < HashWithIndifferentAccess
+    def initialize(session={})
+      @variables = session
+      super(session["attributes"])
+    end
+
+    def elicitation_count_for(slot_name)
+      self["elicitations"] ||= {}
+      if self["elicitations"][slot_name].present?
+        return self["elicitations"][slot_name]["count"]
+      end
+      return 0
+    end
+
+    def increment_elicitation_count!(slot_name)
+      count = elicitation_count_for(slot_name)
+      self["elicitations"].merge!(
+        "#{slot_name}": { count: count + 1 }
+      )
+    end
+
+    def new?
+      @variables["new"] == true
+    end
+
+    def application_id
+      @variables["application"]["applicationId"]
+    end
+
+    def user_id
+      @variables["user"]["userId"]
+    end
+  end
+end

data/lib/alexa/slot.rb

@@ -0,0 +1,50 @@
+module Alexa
+  class Slot
+    attr_accessor :name, :value
+
+    def initialize(attributes={})
+      @name = attributes['name']
+      @value = attributes['value']
+      @resolutions = attributes['resolutions']
+    end
+
+    def matched_value
+      if matched?
+        resolution["values"].first["value"]["name"]
+      end
+    end
+
+    def matched_id
+      if matched?
+        resolution["values"].first["value"]["id"]
+      end
+    end
+
+    def matched?
+      return false if !has_resolutions?
+      resolution["status"]["code"] == "ER_SUCCESS_MATCH"
+    end
+
+    def bad_match?
+      return false if !has_resolutions?
+      resolution["status"]["code"] == "ER_SUCCESS_NO_MATCH"
+    end
+
+    def has_resolutions?
+      @resolutions.present?
+    end
+
+    def resolution
+      return nil if !has_resolutions?
+      @resolutions["resolutionsPerAuthority"].first
+    end
+
+    def as_json(options={})
+      h = { name: name }
+      # add other attributes only if they are present
+      h.merge!(value: value) if value.present?
+      h.merge!(resolutions: @resolutions) if @resolutions.present?
+      h
+    end
+  end
+end

data/lib/alexa/version.rb

@@ -0,0 +1,3 @@
+module Alexa
+  VERSION = '0.1.1'
+end

data/lib/alexa-rails.rb

@@ -0,0 +1,19 @@
+require "alexa/engine"
+require 'alexa/context'
+require 'alexa/device'
+require 'alexa/request'
+require 'alexa/response'
+require 'alexa/session'
+require 'alexa/slot'
+require 'alexa/version'
+require 'alexa/responses/bye'
+require 'alexa/responses/delegate'
+require 'alexa/responses/permission_consents/device_address'
+require 'alexa/intent_handlers/base'
+require_relative '../app/models/alexa/user'
+require_relative '../app/models/alexa/usage'
+
+
+module Alexa
+  # Your code goes here...
+end

data/lib/generators/alexa/migrations_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Alexa
+  module Generators
+    class MigrationsGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations for Alexa"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "create_alexa_users.rb", "db/migrate/create_alexa_users.rb"
+        migration_template "create_alexa_usages.rb", "db/migrate/create_alexa_usages.rb"
+      end
+    end
+  end
+end

data/lib/generators/alexa/templates/create_alexa_usages.rb

@@ -0,0 +1,13 @@
+class CreateAlexaUsages < ActiveRecord::Migration[4.2]
+  def up
+    create_table :alexa_usages do |t|
+      t.references :alexa_user, foreign_key: true
+      t.string :intent_name
+      t.integer :count, default: 0
+    end
+  end
+
+  def down
+    drop_table :alexa_usages
+  end
+end

data/lib/generators/alexa/templates/create_alexa_users.rb

@@ -0,0 +1,13 @@
+class CreateAlexaUsers < ActiveRecord::Migration[4.2]
+  def up
+    create_table :alexa_users do |t|
+      t.string :amazon_id
+    end
+    add_index :alexa_users, :amazon_id
+  end
+
+  def down
+    remove_index :alexa_users, :amazon_id
+    drop_table :alexa_users
+  end
+end

data/lib/tasks/alexa_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :alexa do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: alexa-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sri Vishnu Totakura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: The gem adds additional capabilities to your rails app to serve as a
+  backend for your Alexa skill by providing routing, controllers, views and structure
+  to easily develop and maintain skills' backend
+email:
+- srivishnu@totakura.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/alexa_manifest.js
+- app/assets/javascripts/alexa/application.js
+- app/assets/stylesheets/alexa/application.css
+- app/controllers/alexa/application_controller.rb
+- app/controllers/alexa/intent_handlers_controller.rb
+- app/helpers/alexa/application_helper.rb
+- app/helpers/alexa/context_helper.rb
+- app/helpers/alexa/render_helper.rb
+- app/jobs/alexa/application_job.rb
+- app/mailers/alexa/application_mailer.rb
+- app/models/alexa/application_record.rb
+- app/models/alexa/usage.rb
+- app/models/alexa/user.rb
+- app/views/alexa/_response.json.erb
+- app/views/alexa/output/_card.json.erb
+- app/views/alexa/output/_ssml.json.erb
+- app/views/alexa/output/cards/_ask_for_permissions_consent.json.erb
+- app/views/alexa/output/cards/_simple.json.erb
+- app/views/alexa/permission_consents/device_address.text.erb
+- app/views/layouts/alexa/application.html.erb
+- config/routes.rb
+- lib/alexa-rails.rb
+- lib/alexa/context.rb
+- lib/alexa/device.rb
+- lib/alexa/engine.rb
+- lib/alexa/intent_handlers/base.rb
+- lib/alexa/request.rb
+- lib/alexa/response.rb
+- lib/alexa/responses/bye.rb
+- lib/alexa/responses/delegate.rb
+- lib/alexa/responses/permission_consents/device_address.rb
+- lib/alexa/session.rb
+- lib/alexa/slot.rb
+- lib/alexa/version.rb
+- lib/generators/alexa/migrations_generator.rb
+- lib/generators/alexa/templates/create_alexa_usages.rb
+- lib/generators/alexa/templates/create_alexa_users.rb
+- lib/tasks/alexa_tasks.rake
+homepage: https://github.com/tsrivishnu/alexa-rails
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Serve Alexa skills with your rails app as backend
+test_files: []