ralyxa-lambda 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b587c2395aa13bbf2cec83953c02a902e87189b4918c9104fb252980889d13f0
+  data.tar.gz: 798c7e3541fe24bf097733257c6c10a61c76a5253ebb9f07b51d3159912aa5de
+SHA512:
+  metadata.gz: 3b0c06e79501105585eda22cfd8a87d82a88492a6af42879d27cfae1c1b712ac08cbddcbe2ddef93a9c48f82075ca33329d5382c704e9d224eb794954c68573b
+  data.tar.gz: c86ab796dbd4fd9f212376c938aa34659bcc46507b2846f9a7ab39bbe775eb630b7973e1fa62d00569ee41d498801c4de644bcf9e0dcff351639e935f785f916

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+coverage

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

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

data/.ruby-version

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

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - ruby-head
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+
+script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at s_morgan@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to Ralyxa
+
+1. Have tests.
+
+## The basic idea
+
+Ralyxa is in two parts: 
+
+1. The user-facing Ruby interface which looks a bit like Sinatra.
+2. The under-the-hood Ruby-to-JSON translator which directly references Alexa structures.
+
+This gives rise to some principles:
+
+1. The user-facing Ruby interface should try to provide thoughtful abstractions to the Alexa structures.
+2. The under-the-hood Ruby-to-JSON translator should contain objects which directly map onto Alexa structures.
+
+Some other principles:
+
+1. Keep the user-facing Ruby interface as simple as possible. Imagine a brand-new Ruby developer using this.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sam Morgan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,294 @@
+# 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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ralyxa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ralyxa
+
+## Usage
+
+### Getting Started
+
+First, you've gotta pass the request from Sinatra to Ralyxa. Add a single `POST` route to your Sinatra application, with the following:
+
+```ruby
+require 'sinatra'
+require 'ralyxa'
+
+post '/' do
+  Ralyxa::Skill.handle(request)
+end
+```
+
+Second, you've gotta define your intents. To define a new intent, create a directory called 'intents'. Inside there, create a `.rb` file:
+
+```ruby
+intent "IntentName" do
+  # Whatever logic you want to do
+  # fetching something for the response
+  # persisting something etc
+  # this is plain Ruby, so go wild
+
+  respond("This is what Alexa will say to the user")
+end
+```
+
+Third, define your Intent and Utterance on the Alexa Developer portal. You can then test your application in the Service Simulator (either by pushing the Sinatra app somewhere with HTTPS or, more easily, using ngrok to tunnel the application).
+
+### Being more pro
+
+##### `ask` and `tell`
+
+There are two kinds of responses you can send to Alexa: `ask`s and `tell`s. An `ask` should ask the user a question, and expect them to reply. A `tell` should end the conversation.
+
+When defining intents, you can use the `#ask` and `#tell` methods in place of `#respond` to keep the session open, or close it:
+
+```ruby
+intent "AskMoreQuestions" do
+  ask("What next?")
+end
+```
+
+```ruby
+intent "SayGoodbye" do
+  tell("Goodbye.")
+end
+```
+
+> A `tell` is basically a `#respond` with `end_session: true`. You can use that instead if you prefer.
+
+##### Reading and setting session attributes
+
+You can persist data to an Alexa session:
+
+```ruby
+intent "PersistThis" do
+  ask("Got it. What now?", session_attributes: { persist: "this" })
+end
+```
+
+And, subsequently, read it:
+
+```ruby
+intent "ReadFromSession" do
+  persisted_data = request.session_attribute("persist")
+  ask("You persisted: #{ persisted_data }")
+end
+```
+
+##### Playing audio with the `AudioPlayer` directive
+
+###### Play
+
+You can play an audio stream right away with:
+
+```ruby
+intent "PlayAudio" do
+  audio_player.play(
+    'https://s3.amazonaws.com/my-ssml-samples/Flourish.mp3',
+    'flourish-token',
+    speech: 'Playing Audio'
+  )
+end
+```
+
+###### Play Later (Enqueue)
+
+You can queue a song to play next with:
+
+```ruby
+intent "PlayAudioLater" do
+  audio_player.play_later(
+    'https://s3.amazonaws.com/my-ssml-samples/Flourish.mp3',
+    'flourish-token'
+  )
+end
+```
+
+###### Stop
+
+You can stop playing with:
+
+```ruby
+intent "StopAudio" do
+  audio_player.stop
+end
+```
+
+###### Clear Queued
+
+You can clear enqueued audio with:
+
+```ruby
+intent "ClearQueue" do
+  audio_player.clear_queue
+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
+
+If, for some reason, you want to end a session in some other way than with a `tell`, you can:
+
+```ruby
+intent "ConfuseTheUser" do
+  respond("This actually ends the session.", end_session: true)
+end
+```
+
+##### Starting over
+
+You can start conversations over, which clears the session attributes:
+
+```ruby
+intent "AMAZON.StartOverIntent" do
+  ask("Starting over. What next?", start_over: true)
+end
+```
+
+##### Using SSML
+
+You can use [Speech Synthesis Markup Language](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference) to directly control Alexa's pronunciation:
+
+```ruby
+intent "SpellOut" do
+  ask("<speak><say-as interpret-as='spell-out'>Hello World</say-as></speak>", ssml: true)
+end
+```
+
+##### Using Cards
+
+You can send cards to the Alexa app. Ralyxa will automatically figure out if you're trying to send a 'Simple' or 'Standard' card type:
+
+```ruby
+# Simple card
+intent "SendSimpleCard" do
+  simple_card = card("Hello World", "I'm alive!")
+  ask("What do you think of the Simple card I just sent?", card: simple_card)
+end
+
+# Standard card
+intent "SendStandardCard" do
+  standard_card = card("Hello World", "I'm alive!", "http://placehold.it/720x480", "http://placehold.it/1200x800")
+  
+  ask("What do you think of the Standard card I just sent?", card: standard_card)
+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?`.
+
+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.
+
+
+### I want to serve card images, audio stream etc. over HTTP not HTTPS
+
+In some special cases, you may be allowed to serve content over HTTP instead of HTTPS. To allow this within Ralyxa, you need to set the `require_secure_urls` configuration option to false.
+
+> **NOTE:** In order to use HTTP sources, you must be given special approval directly from Amazon. If you use HTTP sources without getting advanced approval, your skill will not work correctly.
+
+```ruby
+Ralyxa.configure do |config|
+  config.require_secure_urls = false
+end
+```
+
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sjmog/ralyxa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+The main areas of focus are:
+
+- Reprompts :construction:
+- Dialogue :construction:
+- Generators of built-in Intents e.g. `SessionEndedRequest`
+- Automation with the `AVS` command line tool
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+