alexa_toolbox 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 410e7ebcc29c183541f1c4d5ad5b13e898ca1263
-  data.tar.gz: 3507752cb6aa7791bf0c99db20fd00ceaf063e7a
+  metadata.gz: fd37cd19bb97de4723fc60c858e3b4c2a2af637b
+  data.tar.gz: de407de0f2d6409107f4319786fd06e6ba4a228f
 SHA512:
-  metadata.gz: a21accae38d9aad6543ace3ab03eddd6d327b88999aee89c87b8e3deeba4b5a32b7ab03de1413022ebe0da3cbb0631ff58d5bf9a10955ca39a9fa77ef6a6cbb8
-  data.tar.gz: 56918a9a6c88a5b562e5514b2e0b80dbbdc779ddc8c0869ef28696fbd9e5abda5e196c2889c17bafce50198bb64ed44ed21467d3a067f7d3bb60f211b7cbc488
+  metadata.gz: c822745695ce11cff21386472fd36cd1c8e1df50142cbab6b3f3bb0b0d59d553110e931d6ee0a23b39596e87cfe824621174e9d45fc21a4cfaaa2c6ce9d88ad6
+  data.tar.gz: 17eedcdcf1e1fe44289982706ec48b75ad1069c5338de63868a4dfffbb3982f39667c7eb047feb9d01177a90b4b1001578e4171f2cb55a1e4c23c52a01aa5319

data/Gemfile.lock

@@ -3,13 +3,11 @@ PATH
   specs:
     alexa_toolbox (1.0.0)
       bundler (~> 1.14)
-      deep_merge
       rake
 
 GEM
   remote: https://rubygems.org/
   specs:
-    deep_merge (1.1.1)
     diff-lcs (1.3)
     rake (12.0.0)
     rspec (3.6.0)

data/README.md

@@ -130,27 +130,218 @@ response.build_response
 ```ruby
 require 'alexa_toolbox'
 response = AlexaToolbox::Response.new
-# add_card(type,title,subtitle,content)
+# add_card(type,title,content)
 # or
-# add_hash_card({ :type => type, :title => title, :subtitle => subtitle, :content => content })
-response.add_card("PlainText","Card Title","Card Subtitle","This card should have some interesting content for your user.")
+# add_hash_card({ :type => type, :title => title, :content => content })
+response.add_card("PlainText","Card Title","This card should have some interesting content for your user.")
 response.build_response
 ```
 
-#### Will generate a valid outputspeech response in JSON format:
+## Full Documentation
 
-```JSON
-{
-    "version": "1.0",
-    "response": {
-        "outputSpeech": {
-            "type": "PlainText",
-            "text": "Ruby is running ready!"
-        },
-        "shouldEndSession": true
-    }
-}
+### Request
+
+##### Initialization:
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
 ```
+json_request should be a valid JSON request object.
+If you are using Ruby on Rails, this will be the params variable in your controller.
+While :application_id in the options hash is not required, part of Amazon Alexa security best practices is to compare request applicationId against your skill's application id. As such, I recommend this is set and you check validity (see below) before going further.
+If you don't know where to find your application id, you can get it here:
+[Get Your Application ID](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/handling-requests-sent-by-alexa#getting-the-application-id-for-a-skill)
+
+##### .valid?
+
+Check if the request is valid and intended for your application.
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+if request.valid?
+  # continue with your skill logic
+else
+  # return 500 as per Amazon Alexa Documentation
+end
+```
+
+##### .json
+
+JSON representation of the request. Use this if you are familiar with the Alexa request structure and rules and don't wish to use AlexToolbox's request handling.
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request_json = request.json
+
+request.json[:version]
+# "1.0"
+```
+
+##### .type
+
+Return the type of request being made.
+
+Possible Types:
+LaunchRequest
+IntentRequest
+SessionEndedRequest
+AudioPlayer
+System.ExceptionEncountered
+PlaybackController.NextCommandIssued
+
+For AudioPlayer requests, it will return as "AudioPlayer" and not the full request type.
+AudioPlayer requests will have an .audioplayer object
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.type
+# "IntentRequest"
+```
+
+##### .version
+
+Return the version of the request (always "1.0" currently)
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.version
+# "1.0"
+```
+
+##### .request_id
+
+Return the requestId of the request
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.request_id
+# "EdwRequestId.d2fb326f-337d-4ca9-b99b-c308d7cbf8dd"
+```
+
+##### .locale
+
+Return the locale of the request ("en-US","en-UK",etc.)
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.locale
+# "en-US"
+```
+
+##### .options
+
+Read the options set for the request (this will house your application_id)
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.options
+# { :application_id => 'SKILL_APP_ID' }
+```
+
+##### .session
+
+Access information on the session, view the session section for more information on the session object.
+Is not included in AudioPlayer requests.
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.session
+```
+
+##### .intent
+
+Access information on the intent, view the intent section for more information on the intent object.
+Is only included for requests with type "IntentRequest".
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.intent
+```
+
+##### .audioplayer
+
+Access information on the audioplayer, view the audioplayer section for more information on the audioplayer object.
+Is only included for requests with type "AudioPlayer".
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.audioplayer
+```
+
+##### .error
+
+Access information for errors.
+This is only included for requests with type "System.ExceptionEncountered" and "AudioPlayer".
+error has two keys, :type and :message.
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.error
+# { :type => "MEDIA_ERROR_INVALID_REQUEST", :message => "Alexa recognized the request as being malformed. E.g. bad request, unauthorized, forbidden, not found, etc." }
+```
+
+##### .cause
+
+Access information for error cause.
+This is only included for requests with type "System.ExceptionEncountered".
+cause has one keys, :requestId.
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.cause
+# { :requestId => "EdwRequestId.d2b326f-37d-4a9-b9b-c307cbf8d" }
+```
+
+##### .context
+
+Access context information for the request, not always provided and may be phased out for most request types.
+
+```ruby
+request = AlexaToolbox::Request.new(json_request, {
+  :application_id => 'SKILL_APP_ID'
+})
+request.context
+```
+
+
+### Session
+
+### Intent
+
+### Audioplayer
+
+### Context
+
+### Request
+
+### Address
+
 
 ## Troubleshooting
 

data/lib/alexa_toolbox/request.rb

@@ -6,7 +6,6 @@ module AlexaToolbox
   
   class Request
     require 'json'
-    require 'deep_merge'
     require 'alexa_toolbox/session'
     require 'alexa_toolbox/intent'
     require 'alexa_toolbox/audioplayer'
@@ -20,8 +19,7 @@ module AlexaToolbox
     end
 
     def initialize(json_request, options = {})
-      options = options.deep_merge(self.class.default_options)
-      @options = options
+      @options = options if options.key?(:application_id)
 
       @request_id = json_request[:request][:requestId]
       raise ArgumentError, 'Request ID not present' if @request_id.nil?

data/lib/alexa_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AlexaToolbox
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alexa_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Paul McMahon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-15 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: deep_merge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement