ralyxa 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3802804f734d1955dd3b5e09e5b466304d5296bd
-  data.tar.gz: a85ebe34a857be6e437b7005569e9efa3f8d166a
+  metadata.gz: 6aa4014123fdf96c66aafea914bbf45fc005234d
+  data.tar.gz: 9f61bfe7853045176e0b1fe46d2cb525fd5d1077
 SHA512:
-  metadata.gz: 82c8bc2e1f457be53163bd95e2cae1c4b86f3a1c216bdffff70519f2f4f83bcfb2098b9c9764f005779549538d9fbbe14158d79fabe87536bbd27757af0d11d0
-  data.tar.gz: 0f5289e068b2ba14ad9e13ccf0159a6eea25382d4f455b177b08af203716a1af521b02f21d6be23744878b8729303b69cff264e1b3b1bd9321e9984c00615d4f
+  metadata.gz: 217f26ef4be39c6e7b80d1666e6d7a9fb5361aeb41e8419e8446a92819ae5b2bd5fb1a3a3ed6f62b17a13171a24d607a810f4847464481480e8680c3528ae1ac
+  data.tar.gz: 5e40b794bd024fb2c8b8306b23bf09a423930fd72f825810bf7616443d920ef5f2120aa2a966dc84376fe85df9bb9045fa0c05286ed7dec873dfb76d2ee7575c

data/Gemfile.lock

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

data/README.md

@@ -91,6 +91,16 @@ intent "ReadFromSession" do
 end
 ```
 
+##### Reading the session user
+
+You can read the session user's `userId` and `accessToken`, and check that the `accessToken` exists:
+
+```ruby
+request.user_id #=> returns the `userId` value from the request session
+request.user_access_token # => returns the `accessToken` value from the request session
+request.user_access_token_exists? # => true if the user has an access token, false if not
+```
+
 > Go check out the `Alexa::Request` object to see what else you can do with the `request`.
 
 ##### Ending sessions
@@ -143,6 +153,18 @@ end
 
 > Card images must be under 2MB and available at an SSL-enabled (HTTPS) endpoint.
 
+##### Account Linking
+
+You can ask Alexa to send a [`LinkAccount`](https://developer.amazon.com/blogs/post/Tx3CX1ETRZZ2NPC/Alexa-Account-Linking-5-Steps-to-Seamlessly-Link-Your-Alexa-Skill-with-Login-wit) card for the user to authenticate via OAuth:
+
+```ruby
+intent "SendAccountLinkingCard" do
+  tell("Please authorize via the Alexa app.", card: link_account_card)
+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?`.
+
 ## 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/lib/ralyxa/card.rb

@@ -2,57 +2,69 @@ require_relative './errors'
 
 module Ralyxa
   class Card
-    SIMPLE_CARD_TYPE   = "Simple"
-    STANDARD_CARD_TYPE = "Standard"
+    LINK_ACCOUNT_CARD_TYPE = "LinkAccount"
+    SIMPLE_CARD_TYPE       = "Simple"
+    STANDARD_CARD_TYPE     = "Standard"
 
-    def initialize(title, body, image_url)
-      @title     = title
-      @body      = body
-      @image_url = image_url
+    def initialize(options)
+      @options = options
     end
 
     def self.as_hash(title, body, image_url = nil)
-      new(title, body, image_url).to_h
+      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)
-        card[:title] = @title
-        set_body(card)
-        set_image(card) if @image_url
+        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)
-      card[:type] = SIMPLE_CARD_TYPE if simple?
-      card[:type] = STANDARD_CARD_TYPE if standard?
+      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] = @body if simple?
-      card[:text]    = @body if standard?
+      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: #{ @image_url }") unless secure?(@image_url)
+      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] = @image_url
-      card[:image][:largeImageUrl] = @image_url
+      card[:image][:smallImageUrl] = @options[:image_url]
+      card[:image][:largeImageUrl] = @options[:image_url]
+    end
+
+    def link_account?
+      !!@options[:link_account]
     end
 
     def simple?
-      !@image_url
+      !@options[:image_url]
     end
 
     def standard?
-      !!@image_url
+      !!@options[:image_url]
     end
 
-    def secure?(url)
-      URI.parse(url).scheme == "https"
+    def secure?
+      URI.parse(@options[:image_url]).scheme == "https"
     end
   end
 end

data/lib/ralyxa/handler.rb

@@ -24,6 +24,10 @@ module Ralyxa
       card_class.as_hash(title, body, image_url)
     end
 
+    def link_account_card(card_class = Ralyxa::Card)
+      card_class.link_account
+    end
+
     alias ask respond
 
     attr_reader :request

data/lib/ralyxa/request.rb

@@ -1,11 +1,19 @@
 require 'json'
+require 'forwardable'
+require_relative './user'
 
 module Ralyxa
   class Request
+    extend Forwardable
     INTENT_REQUEST_TYPE = "IntentRequest".freeze
 
-    def initialize(original_request)
+    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

data/lib/ralyxa/user.rb

@@ -0,0 +1,21 @@
+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

data/lib/ralyxa/version.rb

@@ -1,3 +1,3 @@
 module Ralyxa
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ralyxa
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Sam Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - lib/ralyxa/response.rb
 - lib/ralyxa/response_builder.rb
 - lib/ralyxa/skill.rb
+- lib/ralyxa/user.rb
 - lib/ralyxa/version.rb
 - pkg/ralyxa-1.0.0.gem
 - ralyxa.gemspec