ralyxa 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba3b580559880302aba0c710a6d0e8f6b5acd21
-  data.tar.gz: c1b4afb09c6a7504f4abdd0e310996984724684a
+  metadata.gz: f1ff42c3c4d881414ba200d222731420250354dd
+  data.tar.gz: b20af2b9b31a38ca6840f931aadfac82042a167c
 SHA512:
-  metadata.gz: a14312a4070648259a5e690f5d818a14008fb7d229a61482a8d7c144e6fd1cbf68b6120674c676bf52e4b181fbaa35f21f41a9d515a1f358a226c98ac58ff481
-  data.tar.gz: 553d41cb7f590514db8ea25f5d9573fe4a64c02bd3eb02c0d45365525c22b59f4bbc736882aeeb7171c40d404c9a1bb85abd31b8ee09a073e8f8a0978a739f89
+  metadata.gz: e8df761d9ee6ac49298fe03fb29f9021115e68b06ba7865a07eb09d7514ff19140e4405f5657adfe582997c8f7ea8c1f32122f0eeb9da183d180818c1269f772
+  data.tar.gz: b2505f0529eaa5ab513ec79c140b45c6bc75d2e4745bd3d5d56fb03086dab90feb883bf469a78f9d7dd39e83db55131a681668a3fa8c232420d70bc67acf73f9

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Exclude:
+    - spec/**/*.rb
+  TargetRubyVersion: 2.3.1
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Documentation:
+    Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/README.md

@@ -190,6 +190,25 @@ end
 
 > You can't actually respond to a `SessionEndedRequest`, but you might want to do some tidying in this action.
 
+## Testing
+Part of Amazon's requirements for Alexa skills is that they have to ensure requests are sent from Amazon. This is done in a number of ways documented [here](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-a-web-service.html). This verification is built into Ralyxa and can cause issues when testing your skills with stubbed data.
+
+### Disabling verification
+Inside of your spec_helper files, include the following to disable verification:
+
+#### RSpec
+```ruby
+require 'ralyxa'
+
+RSpec.configure do |config|
+  config.before :each do
+    Ralyxa.configure do |config|
+      config.validate_requests = false
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests. You can also run `irb` for an interactive prompt that will allow you to experiment.

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ralyxa"
+require 'bundler/setup'
+require 'ralyxa'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "ralyxa"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/ralyxa/configuration.rb

@@ -0,0 +1,13 @@
+module Ralyxa
+  class Configuration
+    attr_accessor :validate_requests
+
+    def initialize
+      @validate_requests = true
+    end
+
+    def validate_requests?
+      validate_requests
+    end
+  end
+end

data/lib/ralyxa/errors.rb

@@ -1,2 +1,2 @@
 class UnsecureUrlError < StandardError
-end
+end

data/lib/ralyxa/handler.rb

@@ -12,11 +12,11 @@ module Ralyxa
       raise NotImplementedError
     end
 
-    def respond(response_text = "", response_details = {}, response_builder = Ralyxa::ResponseBuilder)
+    def respond(response_text = '', response_details = {}, response_builder = Ralyxa::ResponseBuilder)
       response_builder.build(response_details.merge(response_text: response_text))
     end
 
-    def tell(response_text = "", response_details = {})
+    def tell(response_text = '', response_details = {})
       respond(response_text, response_details.merge(end_session: true))
     end
 
@@ -33,4 +33,4 @@ module Ralyxa
     attr_reader :request
     private :request, :respond, :tell, :ask
   end
-end
+end

data/lib/ralyxa/register_intents.rb

@@ -2,7 +2,7 @@ require_relative './skill'
 
 module Ralyxa
   class RegisterIntents
-    DEFAULT_INTENTS_DIRECTORY = "./intents".freeze
+    DEFAULT_INTENTS_DIRECTORY = './intents'.freeze
 
     def initialize(intents_directory, alexa_skill_class)
       @intents_directory = intents_directory
@@ -22,22 +22,24 @@ module Ralyxa
     end
 
     private
+
     attr_reader :intents_directory, :alexa_skill_class
 
     def intent_declarations
       @intent_declarations ||=
-      Dir.glob("#{ intents_directory }/*.rb")
-        .map { |relative_path| File.expand_path(relative_path) }
-        .map { |intent_declaration_path| File.open(intent_declaration_path).read }
+        Dir.glob("#{intents_directory}/*.rb")
+           .map { |relative_path| File.expand_path(relative_path) }
+           .map { |intent_declaration_path| File.open(intent_declaration_path).read }
     end
 
-    NO_INTENT_DECLARATIONS_FOUND = <<~HEREDOC
-    \e[33m
-    WARNING: You haven't defined any intent declarations. 
+    heredoc = <<~HEREDOC
+      \e[33m
+      WARNING: You haven't defined any intent declarations.
 
-    Please define intent declarations inside a directory called 'intents', 
-    on the same directory level as the runfile for your server application.
-    \e[0m
+      Please define intent declarations inside a directory called 'intents',
+      on the same directory level as the runfile for your server application.
+      \e[0m
     HEREDOC
+    NO_INTENT_DECLARATIONS_FOUND = heredoc.freeze
   end
-end
+end

data/lib/ralyxa/request_entities/request.rb

@@ -1,12 +1,13 @@
 require 'json'
 require 'forwardable'
+require 'alexa_verifier'
 require_relative './user'
 
 module Ralyxa
   module RequestEntities
     class Request
       extend Forwardable
-      INTENT_REQUEST_TYPE = "IntentRequest".freeze
+      INTENT_REQUEST_TYPE = 'IntentRequest'.freeze
 
       def_delegator :@user, :id, :user_id
       def_delegator :@user, :access_token, :user_access_token
@@ -15,30 +16,36 @@ module Ralyxa
       def initialize(original_request, user_class = Ralyxa::RequestEntities::User)
         @request = JSON.parse(original_request.body.read)
         @user = user_class.build(@request)
+
+        validate_request(original_request) if Ralyxa.configuration.validate_requests?
       end
 
       def intent_name
-        return @request["request"]["type"] unless intent_request?
-        @request["request"]["intent"]["name"]
+        return @request['request']['type'] unless intent_request?
+        @request['request']['intent']['name']
       end
 
       def slot_value(slot_name)
-        @request["request"]["intent"]["slots"][slot_name]["value"]
+        @request['request']['intent']['slots'][slot_name]['value']
       end
 
       def new_session?
-        @request["session"]["new"]
+        @request['session']['new']
       end
 
       def session_attribute(attribute_name)
-        @request["session"]["attributes"][attribute_name]
+        @request['session']['attributes'][attribute_name]
       end
 
       private
 
       def intent_request?
-        @request["request"]["type"] == INTENT_REQUEST_TYPE
+        @request['request']['type'] == INTENT_REQUEST_TYPE
+      end
+
+      def validate_request(request)
+        AlexaVerifier.valid!(request)
       end
     end
   end
-end
+end

data/lib/ralyxa/request_entities/user.rb

@@ -10,14 +10,14 @@ module Ralyxa
 
       def self.build(request)
         new(
-          id: request.dig("session", "user", "userId"),
-          access_token: request.dig("session", "user", "accessToken")
+          id: request.dig('session', 'user', 'userId'),
+          access_token: request.dig('session', 'user', 'accessToken')
         )
       end
 
       def access_token_exists?
-        !!@access_token
+        !@access_token.nil?
       end
     end
   end
-end
+end

data/lib/ralyxa/response_builder.rb

@@ -36,9 +36,9 @@ module Ralyxa
 
     def output_speech
       output_speech_params = { speech: @options.delete(:response_text) }
-      output_speech_params.merge!(ssml: @options.delete(:ssml)) if @options[:ssml]
+      output_speech_params[:ssml] = @options.delete(:ssml) if @options[:ssml]
 
       @output_speech_class.as_hash(output_speech_params)
     end
   end
-end
+end

data/lib/ralyxa/response_entities/card.rb

@@ -3,9 +3,9 @@ require_relative '../errors'
 module Ralyxa
   module ResponseEntities
     class Card
-      LINK_ACCOUNT_CARD_TYPE = "LinkAccount"
-      SIMPLE_CARD_TYPE       = "Simple"
-      STANDARD_CARD_TYPE     = "Standard"
+      LINK_ACCOUNT_CARD_TYPE = 'LinkAccount'.freeze
+      SIMPLE_CARD_TYPE       = 'Simple'.freeze
+      STANDARD_CARD_TYPE     = 'Standard'.freeze
 
       def initialize(options)
         @options = options
@@ -20,40 +20,40 @@ module Ralyxa
       end
 
       def to_h
-        Hash.new.tap do |card|
-          set_type(card)
-          set_title(card) if @options[:title]
-          set_body(card)  if @options[:body]
-          set_image(card) if @options[:image_url]
+        {}.tap do |card|
+          add_type(card)
+          add_title(card) if @options[:title]
+          add_body(card)  if @options[:body]
+          add_image(card) if @options[:image_url]
         end
       end
 
       private
 
-      def set_type(card)
+      def add_type(card)
         return card[:type] = LINK_ACCOUNT_CARD_TYPE if link_account?
         card[:type]        = SIMPLE_CARD_TYPE       if simple?
         card[:type]        = STANDARD_CARD_TYPE     if standard?
       end
 
-      def set_title(card)
+      def add_title(card)
         card[:title] = @options[:title]
       end
 
-      def set_body(card)
+      def add_body(card)
         card[:content] = @options[:body] if simple?
         card[:text]    = @options[:body] if standard?
       end
 
-      def set_image(card)
-        raise UnsecureUrlError.new("Card images must be available at an SSL-enabled (HTTPS) endpoint. Your current image url is: #{ @options[:image_url] }") unless secure?
-        card[:image] = Hash.new
+      def add_image(card)
+        raise UnsecureUrlError, "Card images must be available at an SSL-enabled (HTTPS) endpoint. Your current image url is: #{@options[:image_url]}" unless secure?
+        card[:image] = {}
         card[:image][:smallImageUrl] = @options[:image_url]
         card[:image][:largeImageUrl] = @options[:image_url]
       end
 
       def link_account?
-        !!@options[:link_account]
+        !@options[:link_account].nil?
       end
 
       def simple?
@@ -61,12 +61,12 @@ module Ralyxa
       end
 
       def standard?
-        !!@options[:image_url]
+        !@options[:image_url].nil?
       end
 
       def secure?
-        URI.parse(@options[:image_url]).scheme == "https"
+        URI.parse(@options[:image_url]).scheme == 'https'
       end
     end
   end
-end
+end

data/lib/ralyxa/response_entities/output_speech.rb

@@ -1,8 +1,8 @@
 module Ralyxa
   module ResponseEntities
     class OutputSpeech
-      DEFAULT_RESPONSE_TEXT = "Hello World"
-      DEFAULT_RESPONSE_SSML = "<speak>Hello World</speak>"
+      DEFAULT_RESPONSE_TEXT = 'Hello World'.freeze
+      DEFAULT_RESPONSE_SSML = '<speak>Hello World</speak>'.freeze
 
       def initialize(speech, ssml)
         @speech = speech
@@ -10,8 +10,8 @@ module Ralyxa
       end
 
       def to_h
-        Hash.new.tap do |output_speech|
-          @ssml ? set_ssml(output_speech) : set_plaintext(output_speech)
+        {}.tap do |output_speech|
+          @ssml ? add_ssml(output_speech) : add_plaintext(output_speech)
         end
       end
 
@@ -21,15 +21,15 @@ module Ralyxa
 
       private
 
-      def set_ssml(output_speech)
-        output_speech[:type] = "SSML"
+      def add_ssml(output_speech)
+        output_speech[:type] = 'SSML'
         output_speech[:ssml] = (@speech || DEFAULT_RESPONSE_SSML)
       end
 
-      def set_plaintext(output_speech)
-        output_speech[:type] = "PlainText"
+      def add_plaintext(output_speech)
+        output_speech[:type] = 'PlainText'
         output_speech[:text] = (@speech || DEFAULT_RESPONSE_TEXT)
       end
     end
   end
-end
+end

data/lib/ralyxa/response_entities/response.rb

@@ -12,10 +12,10 @@ module Ralyxa
       end
 
       def to_h
-        Hash.new.tap do |response|
-          set_version(response)
-          set_session_attributes(response)
-          set_response(response)
+        {}.tap do |response|
+          add_version(response)
+          add_session_attributes(response)
+          add_response(response)
         end
       end
 
@@ -24,23 +24,24 @@ module Ralyxa
       end
 
       private
+
       attr_reader :response
 
-      def set_version(response)
-        response[:version] = "1.0"
+      def add_version(response)
+        response[:version] = '1.0'
       end
 
-      def set_session_attributes(response)
+      def add_session_attributes(response)
         return response[:sessionAttributes] = {} if @start_over
         response[:sessionAttributes] = @session_attributes unless @session_attributes.empty?
       end
 
-      def set_response(response)
-        response[:response] = Hash.new
+      def add_response(response)
+        response[:response] = {}
         response[:response][:outputSpeech] = @output_speech
         response[:response][:card] = @card if @card
         response[:response][:shouldEndSession] = @end_session
       end
     end
   end
-end
+end

data/lib/ralyxa/skill.rb

@@ -4,7 +4,7 @@ require_relative './handler'
 # Routes an incoming request to the correct Handler.
 module Ralyxa
   class Skill
-    @@handlers = {}
+    @handlers = {}
 
     def initialize(request)
       @request = request
@@ -19,7 +19,7 @@ module Ralyxa
       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
+        @handlers[intent_name] = intent_handler
       end
 
       def handle(request, alexa_request_wrapper = Ralyxa::RequestEntities::Request)
@@ -27,7 +27,7 @@ module Ralyxa
       end
 
       def handlers
-        @@handlers.dup
+        @handlers.dup
       end
     end
 
@@ -35,19 +35,19 @@ module Ralyxa
 
     def handler_not_found
       <<~HEREDOC
-      \e[33m
-      WARNING: An intent declaration for intent "#{ @request.intent_name }" was not found.
+        \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.
+        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:
+        You probably want something like:
 
-      intent "#{ @request.intent_name }" do
-        respond("Hello World!")
-      end
-      \e[0m
+        intent "#{@request.intent_name}" do
+          respond("Hello World!")
+        end
+        \e[0m
       HEREDOC
     end
   end
-end
+end

data/lib/ralyxa/version.rb

@@ -1,3 +1,3 @@
 module Ralyxa
-  VERSION = "1.5.2"
+  VERSION = '1.6.0'.freeze
 end

data/lib/ralyxa.rb

@@ -1,8 +1,36 @@
-require "ralyxa/version"
-require 'ralyxa/skill'
+require 'ralyxa/version'
+require 'ralyxa/configuration'
 require 'ralyxa/register_intents'
+require 'ralyxa/skill'
 
 module Ralyxa
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield configuration if block_given?
+    end
+
+    def method_missing(m, *args, &block)
+      if configuration.respond_to?(m)
+        configuration.send(m, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      configuration.respond_to?(m) || super
+    end
+
+    private
+
+    def setup_configuration
+      @configuration = Ralyxa::Configuration.new
+    end
+  end
+
+  setup_configuration
 end
 
-Ralyxa::RegisterIntents.run
+Ralyxa::RegisterIntents.run

data/ralyxa.gemspec

@@ -1,26 +1,31 @@
-# coding: utf-8
 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"
+  spec.name          = 'ralyxa'
   spec.version       = Ralyxa::VERSION
-  spec.authors       = ["Sam Morgan"]
-  spec.email         = ["samm@makersacademy.com"]
+  spec.authors       = ['Sam Morgan']
+  spec.email         = ['samm@makersacademy.com']
 
-  spec.summary       = %q{A Ruby framework for interacting with Amazon Alexa.}
-  spec.description   = %q{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.summary       = 'A Ruby framework for interacting with Amazon Alexa.'
+  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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.1'
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+
+  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'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ralyxa
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Sam Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2018-01-04 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
@@ -52,6 +66,48 @@ dependencies:
     - - "~>"
       - !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'
 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:
@@ -62,16 +118,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - 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
@@ -105,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A Ruby framework for interacting with Amazon Alexa.

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ralyxa (1.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    rake (10.5.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
-  bundler (~> 1.14)
-  rake (~> 10.0)
-  ralyxa!
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.14.6