ralyxa 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 356706a000592a8cf4cd64652ef2f61cf2f3f257
-  data.tar.gz: 3f7dbf9429193a8d2dcfbaa254a40fe1d6c80c19
+  metadata.gz: 2ba3b580559880302aba0c710a6d0e8f6b5acd21
+  data.tar.gz: c1b4afb09c6a7504f4abdd0e310996984724684a
 SHA512:
-  metadata.gz: f4460af9eecb7d2e4114b168c3d79f80cdccbec3a3e200e664588f7d9654b87353505aad2755955fe212cce8b38206aa93d1100b85f572cb6a28ddc0aeae3f5f
-  data.tar.gz: 0fdac2ee8f5e53bb5394b5bd06b290fafa0a95d265d74339ae90fd91aa38d21072eab9161318b2dd82766abb86b237fdb28bb1d48ec37dca4d7512866279ef48
+  metadata.gz: a14312a4070648259a5e690f5d818a14008fb7d229a61482a8d7c144e6fd1cbf68b6120674c676bf52e4b181fbaa35f21f41a9d515a1f358a226c98ac58ff481
+  data.tar.gz: 553d41cb7f590514db8ea25f5d9573fe4a64c02bd3eb02c0d45365525c22b59f4bbc736882aeeb7171c40d404c9a1bb85abd31b8ee09a073e8f8a0978a739f89

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.3.1
+script: bundle exec rspec spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ralyxa (1.4.0)
+    ralyxa (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
 # Ralyxa
 
+[![Build Status](https://travis-ci.org/sjmog/ralyxa.svg?branch=master)](https://travis-ci.org/sjmog/ralyxa)
+
 A Ruby framework for interacting with Amazon Alexa. Designed to work with Sinatra, although can be used with a few other web frameworks.
 
 An example application implementing the gem can be played with [here](https://github.com/sjmog/ralyxa_example).
@@ -165,6 +167,29 @@ end
 
 After completing authentication, the user's access token is available via `request.user_access_token`. You can check for its existence with `request.user_access_token_exists?`.
 
+If, for example, you wanted to require authorization for an intent called `SecretIntent`:
+
+```ruby
+intent "SecretIntent" do
+  return tell("Please authorize via the Alexa app", card: link_account_card) unless request.user_access_token_exists?
+  ask("Welcome to the secret zone. What's next?")
+end
+```
+
+## Ephemera
+
+> Alexa says there's a problem if I just fail to reply to a prompt!
+
+This is probably because your application is not handling the `SessionEndedRequest` intent. That's a built-in intent that kicks in after the user says 'exit', or nothing at all, in response to an ask. You'll probably see a warning in your server logs. To resolve it, implement the following intent:
+
+```ruby
+intent "SessionEndedRequest" do
+  respond
+end
+```
+
+> You can't actually respond to a `SessionEndedRequest`, but you might want to do some tidying in this action.
+
 ## 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.
@@ -175,10 +200,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sjmog/
 
 The main areas of focus are:
 
-- Account linking :construction:
 - Audio directives :construction:
 - Reprompts :construction:
-- Generators?
+- Generators of built-in Intents e.g. `SessionEndedRequest`
 
 ## License
 

data/lib/ralyxa/handler.rb

@@ -1,5 +1,5 @@
 require_relative './response_builder'
-require_relative './card'
+require_relative './response_entities/card'
 
 # Handler Base Class. Each Intent Handler inherits from this, and overwrites the #handle method.
 module Ralyxa
@@ -20,11 +20,11 @@ module Ralyxa
       respond(response_text, response_details.merge(end_session: true))
     end
 
-    def card(title, body, image_url = nil, card_class = Ralyxa::Card)
+    def card(title, body, image_url = nil, card_class = Ralyxa::ResponseEntities::Card)
       card_class.as_hash(title, body, image_url)
     end
 
-    def link_account_card(card_class = Ralyxa::Card)
+    def link_account_card(card_class = Ralyxa::ResponseEntities::Card)
       card_class.link_account
     end
 

data/lib/ralyxa/request_entities/request.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'forwardable'
+require_relative './user'
+
+module Ralyxa
+  module RequestEntities
+    class Request
+      extend Forwardable
+      INTENT_REQUEST_TYPE = "IntentRequest".freeze
+
+      def_delegator :@user, :id, :user_id
+      def_delegator :@user, :access_token, :user_access_token
+      def_delegator :@user, :access_token_exists?, :user_access_token_exists?
+
+      def initialize(original_request, user_class = Ralyxa::RequestEntities::User)
+        @request = JSON.parse(original_request.body.read)
+        @user = user_class.build(@request)
+      end
+
+      def 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"]
+      end
+
+      def new_session?
+        @request["session"]["new"]
+      end
+
+      def session_attribute(attribute_name)
+        @request["session"]["attributes"][attribute_name]
+      end
+
+      private
+
+      def intent_request?
+        @request["request"]["type"] == INTENT_REQUEST_TYPE
+      end
+    end
+  end
+end

data/lib/ralyxa/request_entities/user.rb

@@ -0,0 +1,23 @@
+module Ralyxa
+  module RequestEntities
+    class User
+      attr_reader :id, :access_token
+
+      def initialize(id:, access_token: nil)
+        @id = id
+        @access_token = access_token
+      end
+
+      def self.build(request)
+        new(
+          id: request.dig("session", "user", "userId"),
+          access_token: request.dig("session", "user", "accessToken")
+        )
+      end
+
+      def access_token_exists?
+        !!@access_token
+      end
+    end
+  end
+end

data/lib/ralyxa/response_builder.rb

@@ -1,6 +1,5 @@
 require 'json'
-require_relative './response'
-require_relative './output_speech'
+require_relative './response_entities/response'
 
 module Ralyxa
   class ResponseBuilder
@@ -10,7 +9,7 @@ module Ralyxa
       @options             = options
     end
 
-    def self.build(options = {}, response_class = Ralyxa::Response, output_speech_class = Ralyxa::OutputSpeech)
+    def self.build(options = {}, response_class = Ralyxa::ResponseEntities::Response, output_speech_class = Ralyxa::ResponseEntities::OutputSpeech)
       new(response_class, output_speech_class, options).build
     end
 

data/lib/ralyxa/response_entities/card.rb

@@ -0,0 +1,72 @@
+require_relative '../errors'
+
+module Ralyxa
+  module ResponseEntities
+    class Card
+      LINK_ACCOUNT_CARD_TYPE = "LinkAccount"
+      SIMPLE_CARD_TYPE       = "Simple"
+      STANDARD_CARD_TYPE     = "Standard"
+
+      def initialize(options)
+        @options = options
+      end
+
+      def self.as_hash(title, body, image_url = nil)
+        new(title: title, body: body, image_url: image_url).to_h
+      end
+
+      def self.link_account
+        new(link_account: true).to_h
+      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]
+        end
+      end
+
+      private
+
+      def set_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)
+        card[:title] = @options[:title]
+      end
+
+      def set_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
+        card[:image][:smallImageUrl] = @options[:image_url]
+        card[:image][:largeImageUrl] = @options[:image_url]
+      end
+
+      def link_account?
+        !!@options[:link_account]
+      end
+
+      def simple?
+        !@options[:image_url]
+      end
+
+      def standard?
+        !!@options[:image_url]
+      end
+
+      def secure?
+        URI.parse(@options[:image_url]).scheme == "https"
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/output_speech.rb

@@ -0,0 +1,35 @@
+module Ralyxa
+  module ResponseEntities
+    class OutputSpeech
+      DEFAULT_RESPONSE_TEXT = "Hello World"
+      DEFAULT_RESPONSE_SSML = "<speak>Hello World</speak>"
+
+      def initialize(speech, ssml)
+        @speech = speech
+        @ssml   = ssml
+      end
+
+      def to_h
+        Hash.new.tap do |output_speech|
+          @ssml ? set_ssml(output_speech) : set_plaintext(output_speech)
+        end
+      end
+
+      def self.as_hash(speech: nil, ssml: false)
+        new(speech, ssml).to_h
+      end
+
+      private
+
+      def set_ssml(output_speech)
+        output_speech[:type] = "SSML"
+        output_speech[:ssml] = (@speech || DEFAULT_RESPONSE_SSML)
+      end
+
+      def set_plaintext(output_speech)
+        output_speech[:type] = "PlainText"
+        output_speech[:text] = (@speech || DEFAULT_RESPONSE_TEXT)
+      end
+    end
+  end
+end

data/lib/ralyxa/response_entities/response.rb

@@ -0,0 +1,46 @@
+require_relative './output_speech'
+
+module Ralyxa
+  module ResponseEntities
+    class Response
+      def initialize(output_speech, session_attributes, end_session, start_over, card)
+        @output_speech      = output_speech
+        @session_attributes = session_attributes
+        @end_session        = end_session
+        @start_over         = start_over
+        @card               = card
+      end
+
+      def to_h
+        Hash.new.tap do |response|
+          set_version(response)
+          set_session_attributes(response)
+          set_response(response)
+        end
+      end
+
+      def self.as_hash(output_speech: Ralyxa::OutputSpeech.as_hash, session_attributes: {}, end_session: false, start_over: false, card: false)
+        new(output_speech, session_attributes, end_session, start_over, card).to_h
+      end
+
+      private
+      attr_reader :response
+
+      def set_version(response)
+        response[:version] = "1.0"
+      end
+
+      def set_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
+        response[:response][:outputSpeech] = @output_speech
+        response[:response][:card] = @card if @card
+        response[:response][:shouldEndSession] = @end_session
+      end
+    end
+  end
+end

data/lib/ralyxa/skill.rb

@@ -1,5 +1,4 @@
-require_relative './request'
-require_relative './response'
+require_relative './request_entities/request'
 require_relative './handler'
 
 # Routes an incoming request to the correct Handler.
@@ -23,7 +22,7 @@ module Ralyxa
         @@handlers[intent_name] = intent_handler
       end
 
-      def handle(request, alexa_request_wrapper = Ralyxa::Request)
+      def handle(request, alexa_request_wrapper = Ralyxa::RequestEntities::Request)
         new(alexa_request_wrapper.new(request)).handle
       end
 

data/lib/ralyxa/version.rb

@@ -1,3 +1,3 @@
 module Ralyxa
-  VERSION = "1.5.0"
+  VERSION = "1.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ralyxa
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Sam Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -71,16 +72,16 @@ files:
 - bin/console
 - bin/setup
 - lib/ralyxa.rb
-- lib/ralyxa/card.rb
 - lib/ralyxa/errors.rb
 - lib/ralyxa/handler.rb
-- lib/ralyxa/output_speech.rb
 - lib/ralyxa/register_intents.rb
-- lib/ralyxa/request.rb
-- lib/ralyxa/response.rb
+- lib/ralyxa/request_entities/request.rb
+- lib/ralyxa/request_entities/user.rb
 - lib/ralyxa/response_builder.rb
+- lib/ralyxa/response_entities/card.rb
+- lib/ralyxa/response_entities/output_speech.rb
+- lib/ralyxa/response_entities/response.rb
 - lib/ralyxa/skill.rb
-- lib/ralyxa/user.rb
 - lib/ralyxa/version.rb
 - pkg/ralyxa-1.0.0.gem
 - ralyxa.gemspec

data/lib/ralyxa/card.rb

@@ -1,70 +0,0 @@
-require_relative './errors'
-
-module Ralyxa
-  class Card
-    LINK_ACCOUNT_CARD_TYPE = "LinkAccount"
-    SIMPLE_CARD_TYPE       = "Simple"
-    STANDARD_CARD_TYPE     = "Standard"
-
-    def initialize(options)
-      @options = options
-    end
-
-    def self.as_hash(title, body, image_url = nil)
-      new(title: title, body: body, image_url: image_url).to_h
-    end
-
-    def self.link_account
-      new(link_account: true).to_h
-    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]
-      end
-    end
-
-    private
-
-    def set_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)
-      card[:title] = @options[:title]
-    end
-
-    def set_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
-      card[:image][:smallImageUrl] = @options[:image_url]
-      card[:image][:largeImageUrl] = @options[:image_url]
-    end
-
-    def link_account?
-      !!@options[:link_account]
-    end
-
-    def simple?
-      !@options[:image_url]
-    end
-
-    def standard?
-      !!@options[:image_url]
-    end
-
-    def secure?
-      URI.parse(@options[:image_url]).scheme == "https"
-    end
-  end
-end

data/lib/ralyxa/output_speech.rb

@@ -1,33 +0,0 @@
-module Ralyxa
-  class OutputSpeech
-    DEFAULT_RESPONSE_TEXT = "Hello World"
-    DEFAULT_RESPONSE_SSML = "<speak>Hello World</speak>"
-
-    def initialize(speech, ssml)
-      @speech = speech
-      @ssml   = ssml
-    end
-
-    def to_h
-      Hash.new.tap do |output_speech|
-        @ssml ? set_ssml(output_speech) : set_plaintext(output_speech)
-      end
-    end
-
-    def self.as_hash(speech: nil, ssml: false)
-      new(speech, ssml).to_h
-    end
-
-    private
-
-    def set_ssml(output_speech)
-      output_speech[:type] = "SSML"
-      output_speech[:ssml] = (@speech || DEFAULT_RESPONSE_SSML)
-    end
-
-    def set_plaintext(output_speech)
-      output_speech[:type] = "PlainText"
-      output_speech[:text] = (@speech || DEFAULT_RESPONSE_TEXT)
-    end
-  end
-end

data/lib/ralyxa/request.rb

@@ -1,42 +0,0 @@
-require 'json'
-require 'forwardable'
-require_relative './user'
-
-module Ralyxa
-  class Request
-    extend Forwardable
-    INTENT_REQUEST_TYPE = "IntentRequest".freeze
-
-    def_delegator :@user, :id, :user_id
-    def_delegator :@user, :access_token, :user_access_token
-    def_delegator :@user, :access_token_exists?, :user_access_token_exists?
-
-    def initialize(original_request, user_class = Ralyxa::User)
-      @request = JSON.parse(original_request.body.read)
-      @user = user_class.build(@request)
-    end
-
-    def 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"]
-    end
-
-    def new_session?
-      @request["session"]["new"]
-    end
-
-    def session_attribute(attribute_name)
-      @request["session"]["attributes"][attribute_name]
-    end
-
-    private
-
-    def intent_request?
-      @request["request"]["type"] == INTENT_REQUEST_TYPE
-    end
-  end
-end

data/lib/ralyxa/response.rb

@@ -1,44 +0,0 @@
-require_relative './output_speech'
-
-module Ralyxa
-  class Response
-    def initialize(output_speech, session_attributes, end_session, start_over, card)
-      @output_speech      = output_speech
-      @session_attributes = session_attributes
-      @end_session        = end_session
-      @start_over         = start_over
-      @card               = card
-    end
-
-    def to_h
-      Hash.new.tap do |response|
-        set_version(response)
-        set_session_attributes(response)
-        set_response(response)
-      end
-    end
-
-    def self.as_hash(output_speech: Ralyxa::OutputSpeech.as_hash, session_attributes: {}, end_session: false, start_over: false, card: false)
-      new(output_speech, session_attributes, end_session, start_over, card).to_h
-    end
-
-    private
-    attr_reader :response
-
-    def set_version(response)
-      response[:version] = "1.0"
-    end
-
-    def set_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
-      response[:response][:outputSpeech] = @output_speech
-      response[:response][:card] = @card if @card
-      response[:response][:shouldEndSession] = @end_session
-    end
-  end
-end

data/lib/ralyxa/user.rb

@@ -1,21 +0,0 @@
-module Ralyxa
-  class User
-    attr_reader :id, :access_token
-
-    def initialize(id:, access_token: nil)
-      @id = id
-      @access_token = access_token
-    end
-
-    def self.build(request)
-      new(
-        id: request.dig("session", "user", "userId"),
-        access_token: request.dig("session", "user", "accessToken")
-      )
-    end
-
-    def access_token_exists?
-      !!@access_token
-    end
-  end
-end