alexa-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1885e37fc556e96fc1cc6d08e6643a2643e19bb9
+  data.tar.gz: ab032623d44c9c2fbdfa85f75d437ae17dcda44d
+SHA512:
+  metadata.gz: 0e86743175bfc943c911c35aa6d079475501ea3a8c3a02958fd749b2358b3445b6172a0bfd3fad58e075470e5bcaa668371caf709ec197a141c40d416019e8ec
+  data.tar.gz: 2eee6244d1f954b2b86e03af208a198e5051459857b1578a62ab1c1954c058c08a73798877622a91bc8495a659119db2e861f51563102ea4b94cb5f0888b4f75

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+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,165 @@
+# Alexa
+`alexa-rails` is a ruby gem which is a mountable rails engine that will add abilities to your Ruby on Rails application to handle Amazon alexa requests and responses.
+
+## Intallation/Usage
+
+Do the usual by adding the following to your Gemfile:
+
+```ruby
+gem install alexa-rails
+```
+
+### Migrations
+
+The gem provides migrations that are needed to use few features of the gem.
+For example: Saving or reading the user's skill usage count.
+To generate the migrations, run the following
+
+```ruby
+$ rails generate alexa:migrations
+$ rake db:migrate
+```
+
+### Configuration
+
+Set alexa skill IDs in environment config (ex: config/environments/development.rb).
+
+
+```ruby
+  # config/environments/development.rb
+
+  config.x.alexa.skill_ids = [
+    "amzn1.ask.skill.xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
+  ]
+```
+
+Mount the engine for routes handling in your routes
+
+```ruby
+  # config/routes.rb
+
+  Rails.application.routes.draw do
+    ...
+    mount Alexa::Engine, at: "/alexa"
+  end
+```
+
+### Request handling
+
+After the above steps, your application is ready to accept requests from Alexa
+servers at `/alexa/intent_handlers`.
+You will have to provide that in the HTTPS endpoint URL for your skill.
+
+To handle an intent, you will have to create an intent handler class.
+For example, if your intent is named `PlaceOrder`, you will have to create
+the following file under you `app/lib/intent_handlers` directory.
+
+```ruby
+module Alexa
+  module IntentHandlers
+    class PlaceOrder < Alexa::IntentHandlers::Base
+      def handle
+        ...
+      end
+    end
+  end
+end
+```
+
+All intent handlers should contain a `#handle` method that has required logic
+as to how to handle the intent request. For example, adding session variables,
+setting response to elicit slots, etc.
+
+Adding session variable:
+
+```ruby
+session.merge!(my_var: value)
+```
+
+#### Slot elicitations
+
+Depending on your conditions, you can set the reponse to elicit a specific
+slot and the respecitve views are used.
+
+```ruby
+response.elicit_slot!(:SlotName)
+```
+
+### Views
+
+The content for speech and display cards is not set in the intent handler
+classes.
+We follow rails convention and expect all response content for intents to be
+in their respective view files.
+
+Also, the views are context locale dependant.
+
+Given an intent named `PlaceOrder`, you view files would be
+
+  * SSML: `views/alexa/en_us/intent_handlers/place_order/speech.ssml.erb`
+  * Card: `views/alexa/en_us/intent_handlers/place_order/display.text.erb`
+
+In case of slot elicitations, follow a similar convention but make sure you
+name the `ssml` and `text` files with the same name as the slot that is being
+elicited. For example, in the `PlaceOrder` intent, the elicatation for `Address`
+slot would have the following views
+
+  * SSML: `views/alexa/en_us/intent_handlers/place_order/elicitations/address.ssml.erb`
+  * Card: `views/alexa/en_us/intent_handlers/place_order/elicitations/address.text.erb`
+
+#### SSML
+
+##### Re-prompts
+
+By default, there is no re-prompt SSML is added to the response.
+However, re-prompt SSML can be set in the ssml view of the intent response or
+a slot elicitation view with a `content_for :repromt_ssml` like this:
+
+```erb
+What is your address?
+
+<% content_for :repromt_ssml do %>
+  Where would you like the pizza to be delivered?
+<% end %>
+```
+
+#### Cards
+
+##### Type & Title
+
+By default, the card type is set to `Simple`.
+To change the card type and title, use the `content_for` blocks in the `text`
+view file for the response as follows:
+
+```erb
+<% content_for :card_type do %>
+  Simple
+<% end %>
+<% content_for :card_title do %>
+  Get your pizza
+<% end %>
+
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alexa'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install alexa
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Alexa'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/alexa_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/alexa .js
+//= link_directory ../stylesheets/alexa .css

data/app/assets/javascripts/alexa/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/alexa/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/alexa/application_controller.rb

@@ -0,0 +1,6 @@
+module Alexa
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+  end
+end

data/app/controllers/alexa/intent_handlers_controller.rb

@@ -0,0 +1,49 @@
+require_dependency "alexa/application_controller"
+
+module Alexa
+  class IntentHandlersController < ApplicationController
+    include Alexa::ContextHelper
+    include Alexa::RenderHelper
+    skip_before_action :verify_authenticity_token
+
+    def create
+      @resp = nil
+      if alexa_request.valid?
+        if alexa_request.intent_request?
+          case alexa_request.intent_name
+          when 'AMAZON.CancelIntent'
+            @resp = Alexa::IntentHandlers::GoodBye.new(alexa_context).handle
+          when 'AMAZON.StopIntent'
+            @resp = Alexa::IntentHandlers::GoodBye.new(alexa_context).handle
+          when 'AMAZON.HelpIntent'
+            @resp = Alexa::IntentHandlers::Help.new(alexa_context).handle
+          else
+            @resp = "Alexa::IntentHandlers::#{alexa_request.intent_name}"
+              .constantize
+              .new(alexa_context)
+              .handle
+          end
+        elsif alexa_request.launch_request?
+          @resp = Alexa::IntentHandlers::LaunchApp.new(alexa_context).handle
+        elsif alexa_request.session_ended_request?
+          @resp = Alexa::IntentHandlers::SessionEnd.new(alexa_context).handle
+        end
+      end
+
+      alexa_response = @resp
+      respond_for_alexa_with(alexa_response)
+    end
+
+    helper_method def intent
+      @resp.intent
+    end
+
+    helper_method def slots
+      intent.slots
+    end
+
+    helper_method def context
+      alexa_context
+    end
+  end
+end

data/app/helpers/alexa/application_helper.rb

@@ -0,0 +1,4 @@
+module Alexa
+  module ApplicationHelper
+  end
+end

data/app/helpers/alexa/context_helper.rb

@@ -0,0 +1,23 @@
+module Alexa
+  module ContextHelper
+    def alexa_response
+      @_alexa_response
+    end
+
+    def alexa_response=(resp)
+      @_alexa_response = resp
+    end
+
+    def context_alexa_user
+      alexa_context.user
+    end
+
+    def alexa_context
+      @_alexa_context ||= Alexa::Context.new(alexa_request)
+    end
+
+    def alexa_request
+      @_alexa_request ||= Alexa::Request.new(request)
+    end
+  end
+end

data/app/helpers/alexa/render_helper.rb

@@ -0,0 +1,24 @@
+module Alexa
+  module RenderHelper
+    def respond_for_alexa_with(alexa_response)
+      if alexa_response.nil?
+        render :not_found
+      else
+        # render json: alexa_response
+        if alexa_response.is_a?(Alexa::Responses::Delegate)
+          render json: alexa_response
+        else
+          render partial: 'alexa/response.json', locals: { response: alexa_response }
+        end
+      end
+    end
+
+    private
+
+    def render(*args)
+      options = args.extract_options!
+      options[:template] = "/app/views/"
+      super(*(args << options))
+    end
+  end
+end

data/app/jobs/alexa/application_job.rb

@@ -0,0 +1,4 @@
+module Alexa
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/alexa/application_mailer.rb

@@ -0,0 +1,6 @@
+module Alexa
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/alexa/application_record.rb

@@ -0,0 +1,5 @@
+module Alexa
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/alexa/usage.rb

@@ -0,0 +1,11 @@
+module Alexa
+  class Usage < ActiveRecord::Base
+    self.table_name = 'alexa_usages'
+    belongs_to :alexa_user
+
+    def increment_count!
+      self.count = self.count + 1
+      save!
+    end
+  end
+end

data/app/models/alexa/user.rb

@@ -0,0 +1,17 @@
+module Alexa
+  class User < ActiveRecord::Base
+    self.table_name = 'alexa_users'
+    has_many :usages, class_name: "Alexa::Usage", foreign_key: "alexa_user_id"
+
+    def update_usage(intent_name:)
+      usage = usages.where(intent_name: intent_name).first_or_initialize
+      usage.increment_count!
+    end
+
+    def usage_count_for(intent_name:)
+      usage = usages.where(intent_name: intent_name).first
+      return 0 if usage.nil?
+      usage.count
+    end
+  end
+end

data/app/views/alexa/_response.json.erb

@@ -0,0 +1,18 @@
+{
+  "version": "1.0",
+  "sessionAttributes": <%= raw (response.intent.session || {}).to_json %>,
+  "response": {
+    "directives": <%= raw response.directives.to_json %>,
+    "outputSpeech": <%= raw render(partial: 'alexa/output/ssml', locals: { response: response }) %>,
+    "card": <%= raw render(partial: 'alexa/output/card', locals: { response: response }) %>,
+    <% if content_for(:repromt_ssml).present? %>
+      "reprompt": {
+        "outputSpeech": {
+          "type": "SSML",
+          "ssml": <%= raw content_for(:repromt_ssml).strip.gsub(/\n/, "").to_json %>
+        }
+      },
+    <% end %>
+    "shouldEndSession": <%= response.end_session? %>
+  }
+}

data/app/views/alexa/output/_card.json.erb

@@ -0,0 +1,13 @@
+<% content = render(
+      file: response.partial_path(format: :text),
+      locals: { response: response }
+    ) %>
+<% card_type = (content_for(:card_type) || "Simple").strip %>
+
+<%= raw render(
+      partial: "alexa/output/cards/#{card_type.downcase}",
+      locals: {
+        response: response,
+        content: content
+      }
+    ) %>

data/app/views/alexa/output/_ssml.json.erb

@@ -0,0 +1,7 @@
+{
+  "type": "SSML",
+  "ssml": "<%= raw render(
+    file: response.partial_path(format: :ssml),
+    locals: { response: response }
+  ).gsub(/\n/, "").gsub(/\"/, '\"') %>"
+}

data/app/views/alexa/output/cards/_ask_for_permissions_consent.json.erb

@@ -0,0 +1,6 @@
+{
+  "type": "AskForPermissionsConsent",
+  "permissions":  [
+    "<%= content_for(:permissions_scope).strip %>"
+  ]
+}

data/app/views/alexa/output/cards/_simple.json.erb

@@ -0,0 +1,5 @@
+{
+  "type": "Simple",
+  "title":  "<%= (content_for(:card_title) || "Card Title").strip %>",
+  "content": <%= raw content.strip.to_json %>
+}

data/app/views/alexa/permission_consents/device_address.text.erb

@@ -0,0 +1,7 @@
+<% content_for :card_type do %>
+  ask_for_permissions_consent
+<% end %>
+
+<% content_for :permissions_scope do %>
+  read::alexa:device:all:address
+<% end %>

data/app/views/layouts/alexa/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Alexa</title>
+  <%= stylesheet_link_tag    "alexa/application", media: "all" %>
+  <%= javascript_include_tag "alexa/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Alexa::Engine.routes.draw do
+  resources :intent_handlers, only: [:create]
+end

data/lib/alexa/context.rb

@@ -0,0 +1,38 @@
+module Alexa
+  class Context
+    attr_accessor :request
+
+    def initialize(alexa_request)
+      @request = alexa_request
+    end
+
+    def user
+      @_user ||= Alexa::User.where(
+        amazon_id: request.user_id
+      ).first_or_create
+    end
+
+    def session
+      request.session
+    end
+
+    def locale
+      request.locale
+    end
+
+    def device
+      @_device ||= Alexa::Device.new(
+        attributes: request.params["context"]["System"]["device"],
+        context: self
+      )
+    end
+
+    def api_endpoint
+      request.params["context"]["System"]["apiEndpoint"]
+    end
+
+    def api_access_token
+      request.params["context"]["System"]["apiAccessToken"]
+    end
+  end
+end

data/lib/alexa/device.rb

@@ -0,0 +1,61 @@
+##
+# This class represents the +device+ part in the request.
+#
+module Alexa
+  class Device
+    attr_accessor :attributes
+    def initialize(attributes: {}, context:)
+      @attributes = attributes
+      @context = context
+    end
+
+    ##
+    # Return device id
+    def id
+      attributes["deviceId"]
+    end
+
+    def audio_supported?
+      attributes["supportedInterfaces"].keys.include?("AudioPlayer")
+    end
+
+    def video_supported?
+      attributes["supportedInterfaces"].keys.include?("VideoApp")
+    end
+
+    ##
+    # Return device location from amazon.
+    # Makes an API to amazon alexa's device location service and returns the
+    # location hash
+    def location
+      @_location ||= get_location
+    end
+
+    private
+
+    def get_location
+      url = "#{@context.api_endpoint}/v1/devices/#{id}/settings/address"
+      conn = Faraday.new(url: url) do |conn|
+        conn.options["open_timeout"] = 2
+        conn.options["timeout"] = 3
+        conn.adapter :net_http
+        conn.headers["Authorization"] = "Bearer #{@context.api_access_token}"
+      end
+      begin
+        resp = conn.get
+        if resp.status == 200
+          return JSON.parse(resp.body)
+        end
+      rescue Faraday::ConnectionFailed, JSON::ParserError => e
+        Raven.capture_exception(
+          e,
+          extra: {
+            deviceId: id,
+            apiEndPoint: @context.api_endpoint
+          }
+        )
+        return {}
+      end
+    end
+  end
+end

data/lib/alexa/engine.rb

@@ -0,0 +1,5 @@
+module Alexa
+  class Engine < ::Rails::Engine
+    isolate_namespace Alexa
+  end
+end