action_alexa 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c514b08431f184e8d48699e2b3c57feefd3a49bad60d5c83090e5c7cbaa57550
-  data.tar.gz: 3bd3273da9ea19973fbbef18ed5b709edb24022ae3b56f4f515f63817f9c430a
+  metadata.gz: 9394081d9ef3f322eadd652a0ba47086bdb9b53f31585cf4aebfc76b4fde4f42
+  data.tar.gz: 14e6da85a7e81e7fb57b141f8d085cad258a95f764894e91cf3ebc3606d46608
 SHA512:
-  metadata.gz: 771bc33d6c48de88a7e34c28698f538ac860f67b27e8390f7c722d92f431cfbbe8a2e5cd364c913f81cbd540cccc5f270423f44b1c5073464fe17dc3bd2459ee
-  data.tar.gz: aa0d5eed54594c373972e07d9b937d22a49c314287812141e108755bd9e1b3aa7dd8b2777492e54cf6f339217ad70101b2ee26117048027c85f72601717a3afb
+  metadata.gz: 301f74f40020662e3f161379f7063ca639ac845946f19831e12715340980b7b03d0b9e492116137d544841ec8b03f5266344002726aa0748764f69c8e0d8f535
+  data.tar.gz: 50cb237e7c8d5de3a45b35b361947ad36f58a4aab8ebaa3e6a966a44c9e32cde932025d59b27d0736e7e01df2debc4fd8e23b5230f09b3b319426c3bf85e440b

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+-I lib

data/.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    # spec files will have large nested blocks due to RSpec structure
+    - 'spec/**/*.rb'

data/.simplecov

@@ -0,0 +1,8 @@
+require 'simplecov-console'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::HTMLFormatter
+  ])
+end

data/Gemfile

@@ -4,3 +4,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
+

data/Rakefile

@@ -1,2 +1,14 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec against the spec directory'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+task :default => [:spec, :rubocop]

data/action_alexa.gemspec

@@ -25,4 +25,15 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  # Runtime Depend
+  spec.add_dependency 'railties', '~> 6.0', '>= 6.0.3.2'
+
+  # Development/Test Dependencies
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.87.0'
+  spec.add_development_dependency 'faker', '~> 2.13'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'simplecov-console', '~> 0.7.2'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
 end

data/lib/action_alexa.rb

@@ -1,6 +1,27 @@
-require "action_alexa/version"
+require 'active_support/inflector'
 
+require 'action_alexa/version'
+require 'action_alexa/intent/base'
+require 'action_alexa/intent/registry'
+require 'action_alexa/request_payload/request'
+require 'action_alexa/request_payload/session'
+require 'action_alexa/alexa_request'
+require 'action_alexa/response'
+require 'action_alexa/configuration'
+require 'action_alexa/exceptions'
+require 'action_alexa/skill'
+
+require 'action_alexa/railtie' if defined?(Rails)
+
+# Base
 module ActionAlexa
-  class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= ActionAlexa::Configuration.new
+
+    yield config if block_given?
+  end
 end

data/lib/action_alexa/alexa_request.rb

@@ -0,0 +1,19 @@
+require 'action_alexa/request_payload/session'
+require 'action_alexa/request_payload/request'
+
+module ActionAlexa
+  # ActionAlexa::AlexaRequest is a wrapper around the actual request hash sent
+  #   by the Alexa service. It provides utility accessor methods to extrapolate
+  #   the request structure from Alexa from the application code that consumes
+  #   this gem
+  class AlexaRequest
+    include ActionAlexa::RequestPayload::Session
+    include ActionAlexa::RequestPayload::Request
+
+    attr_reader :alexa_payload
+
+    def initialize(alexa_payload)
+      @alexa_payload = alexa_payload
+    end
+  end
+end

data/lib/action_alexa/configuration.rb

@@ -0,0 +1,51 @@
+module ActionAlexa
+  # Configuration class to support application code hooks within the ActionAlexa
+  # gem. Configurations below that do not have hooks should be set within the
+  # Rails initializers (app/config/initializers/*.rb). This class should be used
+  # as a singleton instance through the ActionAlexa module
+  class Configuration
+    attr_writer :root, :current_user_hook, :logger,
+                :default_intent_response_class
+
+    MISSING_CURRENT_USER_HOOK_ERROR =
+      'No block set for #current_user_hook to execute'.freeze
+    MISSING_DEFAULT_INTENT_ERROR =
+      'Default/Fallback Intent class not defined'.freeze
+
+    # Consumers can either pass a block into #current_user_hook or explicitly
+    #  create a lambda/proc and assign it via the writer #current_user_hook=
+    def current_user_hook(&block)
+      return @current_user_hook if current_user_hook?
+
+      if block_given?
+        @current_user_hook = block
+        return
+      end
+
+      raise ActionAlexa::MissingConfiguration, MISSING_CURRENT_USER_HOOK_ERROR
+    end
+
+    def current_user_hook?
+      !@current_user_hook.nil?
+    end
+
+    def root
+      @root ||= Rails.root
+    end
+
+    def logger
+      @logger ||= Rails.logger
+    end
+
+    # rubocop:disable Style/IfUnlessModifier - rubocop is having issues with
+    #   the code below but its fairly succicient, so disabling the check here
+    def default_intent_response_class
+      if @default_intent_response_class.nil?
+        raise ActionAlexa::MissingConfiguration, MISSING_DEFAULT_INTENT_ERROR
+      end
+
+      @default_intent_response_class
+    end
+    # rubocop:enable Style/IfUnlessModifier
+  end
+end

data/lib/action_alexa/exceptions.rb

@@ -0,0 +1,4 @@
+module ActionAlexa
+  class Error < StandardError; end
+  class MissingConfiguration < StandardError; end
+end

data/lib/action_alexa/intent/authorization.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+
+module ActionAlexa
+  module Intent
+    # Module to allow adding basic authorization flow to Intents
+    # This module interfaces between accessing the user profile from
+    # Amazon and provide a callback to pull the application user
+    # who matches the profile UUID provided by the Alexa service
+    module Authorization
+      AMAZON_API_URL = 'https://api.amazon.com/user/profile'.freeze
+
+      # Utility method that allows upstream Intent classes to map the Amazon
+      # user Alexa is calling as with the user account for your service.
+      # Common mapping is to match the UUID from the Alexa payload against a
+      # User object in your Users table
+      # This method will call fetch_user with the amazon user id from the
+      # request while fetch_user will execute any lambda passed into the
+      # Configuration current_user_hook to perform the look up
+      def current_user
+        @current_user ||= fetch_user_from_request
+      end
+
+      def fetch_user_from_request
+        fetch_user(profile['user_id'])
+      end
+
+      # Fetch the user object in your application that matches the user_id from
+      #   the amazon request. The implementation for the look up is configurable
+      #   by passing in a block to the Configuration.current_user_hook utilty
+      # The Configuration.current_user_hook method will be invoked with the
+      #   user_id from the Alexa payload
+      def fetch_user(user_id)
+        ActionAlexa.config.current_user_hook.call(user_id)
+      end
+
+      def fetch_amazon_user_profile(access_token)
+        uri = URI.parse(AMAZON_API_URL)
+        request = Net::HTTP::Get.new(uri.request_uri)
+        request['Authorization'] = 'bearer ' + access_token
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+        response = http.request(request)
+        JSON.parse(response.body)
+      end
+
+      def profile
+        @profile ||= fetch_amazon_user_profile(access_token)
+      end
+
+      def access_token
+        @access_token ||= alexa_payload.access_token
+      end
+    end
+  end
+end

data/lib/action_alexa/intent/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'action_alexa/intent/authorization'
+
+module ActionAlexa
+  module Intent
+    # Base Intent class which provides some basic sanity methods
+    #   for the Skill intents defined by the application
+    class Base
+      class << self; attr_accessor :name end
+
+      include ActionAlexa::Intent::Authorization
+
+      attr_reader :alexa_payload, :alexa_response
+
+      AMAZON_API_URL = 'https://api.amazon.com/user/profile'
+
+      def initialize(alexa_payload)
+        @alexa_payload = alexa_payload
+        @alexa_response = ActionAlexa::Response.new
+      end
+
+      def execute
+        raise 'Implement this method in your intent subclass'
+      end
+    end
+  end
+end

data/lib/action_alexa/intent/registry.rb

@@ -0,0 +1,35 @@
+module ActionAlexa
+  module Intent
+    # The registry will auto-discover and auto-load and intent files found
+    # within the intents folder (configurable). Default path to search is
+    # Rails.root/app/intents/*_intents.rb
+    # The classes loaded should inherit from ActionAlexa::Intent::Base
+    class Registry
+      def self.intents
+        @intents ||= {}
+      end
+
+      def self.register_intent(intent)
+        intents[intent] = intent.constantize
+      end
+
+      def self.find_intent(intent)
+        load_registry! if intents.empty?
+
+        intent_name = "#{intent}Intent"
+        intents[intent_name]
+      end
+
+      def self.load_registry!
+        intents_path = File.join(
+          ActionAlexa.config.root, 'app', 'intents', '*_intent.rb'
+        )
+        Dir.glob(intents_path).sort.each do |intent_file|
+          require intent_file
+          class_name = intent_file.split('/').last.gsub(/\.rb/, '')
+          register_intent(class_name.split('_').collect(&:capitalize).join)
+        end
+      end
+    end
+  end
+end

data/lib/action_alexa/railtie.rb

@@ -0,0 +1,4 @@
+module ActionAlexa
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/action_alexa/request_payload/request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ActionAlexa
+  module RequestPayload
+    # Request component of the JSON blob from the Alexa request TO the
+    # application. This module contains utility methods to access the attributes
+    module Request
+      def type
+        request_payload['type']
+      end
+
+      def intent_name
+        return type unless type == 'IntentRequest'
+
+        full_intent_name = request_payload['intent']['name']
+        full_intent_name.split(/\./).last.gsub(/Intent$/, '')
+      end
+
+      # For logging purposes when reaching out to Amazon
+      def request_id
+        request_payload['requestId']
+      end
+
+      def timestamp
+        request_payload['timestamp']
+      end
+
+      def locale
+        request_payload['locale']
+      end
+
+      def link_result_should_be_returned?
+        key = 'shouldLinkResultBeReturned'
+
+        request_payload.key?(key) && request_payload[key]
+      end
+
+      def slots?
+        !slots.nil?
+      end
+
+      def slot?(slot_type)
+        slots? && !slot(slot_type).nil?
+      end
+
+      def slot(slot_type)
+        return nil unless slots?
+
+        slots[slot_type]
+      end
+
+      def slots
+        request_payload['intent']['slots']
+      end
+
+      private
+
+      def request_payload
+        alexa_payload['request']
+      end
+    end
+  end
+end

data/lib/action_alexa/request_payload/session.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActionAlexa
+  module RequestPayload
+    # Session compontent of the JSON blob from the Alexa request TO the
+    # application. This module contains utility methods to access the attributes
+    module Session
+      def new?
+        session_payload.key?('new') && session_payload['new']
+      end
+
+      def session_id
+        session_payload['sessionId']
+      end
+
+      def application_id
+        session_payload['application']['applicationId']
+      end
+
+      def user_id
+        session_payload['user']['userId']
+      end
+
+      def user_access_token_present?
+        session_payload['user'].key?('accessToken')
+      end
+
+      def access_token
+        session_payload['user']['accessToken']
+      end
+
+      private
+
+      def session_payload
+        alexa_payload['session']
+      end
+    end
+  end
+end

data/lib/action_alexa/response.rb

@@ -0,0 +1,48 @@
+module ActionAlexa
+  # The return values from this class will go to the Alexa service and let the
+  # Alexa device announce the statements provided. There are hooks to onboard
+  # and send user cards to the end user accounts
+  class Response
+    VERSION = '1.0'.freeze
+
+    def initialize
+      @payload = default_payload
+    end
+
+    def say(message, overrides = {})
+      @payload[:response].merge!(
+        outputSpeech: {
+          type: 'PlainText',
+          text: message
+        },
+        shouldEndSession: overrides.fetch(:should_end_session, true)
+      )
+
+      with_link_account_card if link_account_card?(overrides)
+
+      @payload
+    end
+
+    def with_link_account_card
+      @payload[:response].merge!(
+        card: { type: 'LinkAccount' }
+      )
+
+      self
+    end
+
+    private
+
+    def link_account_card?(overrides)
+      overrides.key?(:link_account_card) && overrides[:link_account_card]
+    end
+
+    def default_payload
+      {
+        version: VERSION,
+        response: {},
+        sessionAttributes: {}
+      }
+    end
+  end
+end

data/lib/action_alexa/skill.rb

@@ -0,0 +1,62 @@
+require 'action_alexa/alexa_request'
+require 'action_alexa/intent/registry'
+
+module ActionAlexa
+  # Top level class that will:
+  #  1. Take in the Alexa request payload
+  #  2. Fetch the intent Alexa is attempting to run
+  #  3. Run the intent
+  #  4. Return the response to Alexa for the end user
+  # This class should be run within a Rails Controller to interface between
+  # Alexa calls to the web service and intent executions
+  class Skill
+    attr_reader :alexa_payload, :logger
+
+    MISSING_DEFAULT_INTENT_MESSAGE =
+      'There was an error talking to the service'.freeze
+
+    def initialize(alexa_payload)
+      @alexa_payload = ActionAlexa::AlexaRequest.new(alexa_payload)
+      @logger = ActionAlexa.config.logger
+    end
+
+    def self.execute(alexa_payload)
+      new(alexa_payload).execute_skill
+    end
+
+    def execute_skill
+      # Find the intent based on the registery intents
+      intent_class = ActionAlexa::Intent::Registry.find_intent(
+        alexa_payload.intent_name
+      )
+
+      return fallback_intent_response if intent_class.nil?
+
+      intent = intent_class.new(alexa_payload)
+
+      # Execute the intent and return the result back to Alexa
+      intent.execute
+    end
+
+    private
+
+    def fallback_intent_response
+      logger.error(
+        "Could not find the intent for #{alexa_payload.intent_name}"
+      )
+
+      begin
+        intent_class = ActionAlexa.config.default_intent_response_class
+        intent_class.new(alexa_payload).execute
+      rescue ActionAlexa::MissingConfiguration => e
+        logger.error(e.message)
+        default_intent_response
+      end
+    end
+
+    def default_intent_response
+      response = ActionAlexa::Response.new
+      response.say(MISSING_DEFAULT_INTENT_MESSAGE)
+    end
+  end
+end

data/lib/action_alexa/version.rb

@@ -1,3 +1,3 @@
 module ActionAlexa
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,15 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: action_alexa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Zshawn Syed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
-dependencies: []
+date: 2020-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.87.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.87.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 description: Gem that helps process Amazon Alexa Intents with Rails
 email:
 - zsyed91@gmail.com
@@ -18,6 +122,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
 - Gemfile
 - README.md
 - Rakefile
@@ -25,6 +132,17 @@ files:
 - bin/console
 - bin/setup
 - lib/action_alexa.rb
+- lib/action_alexa/alexa_request.rb
+- lib/action_alexa/configuration.rb
+- lib/action_alexa/exceptions.rb
+- lib/action_alexa/intent/authorization.rb
+- lib/action_alexa/intent/base.rb
+- lib/action_alexa/intent/registry.rb
+- lib/action_alexa/railtie.rb
+- lib/action_alexa/request_payload/request.rb
+- lib/action_alexa/request_payload/session.rb
+- lib/action_alexa/response.rb
+- lib/action_alexa/skill.rb
 - lib/action_alexa/version.rb
 homepage: https://github.com/zsyed91/action_alexa
 licenses: []