Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/damianFC/alexa-rubykit
Amazon Echo Alexa's App Kit Ruby Implementation
https://github.com/damianFC/alexa-rubykit
alexa amazon-echo iot ruby speechtotext
Last synced: 3 months ago
JSON representation
Amazon Echo Alexa's App Kit Ruby Implementation
- Host: GitHub
- URL: https://github.com/damianFC/alexa-rubykit
- Owner: damianFC
- License: mit
- Created: 2015-04-16T20:13:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-15T13:24:29.000Z (over 4 years ago)
- Last Synced: 2024-08-02T20:38:06.697Z (4 months ago)
- Topics: alexa, amazon-echo, iot, ruby, speechtotext
- Language: Ruby
- Homepage:
- Size: 859 KB
- Stars: 157
- Watchers: 18
- Forks: 56
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# AlexaRubykit
[](http://badge.fury.io/rb/alexa_rubykit)[](https://travis-ci.org/damianFC/alexa-rubykit)[](https://travis-ci.org/damianFC/alexa-rubykit)[](http://inch-ci.org/github/damianFC/alexa-rubykit)
This gem implements a quick back-end service for deploying applications for Amazon's Echo (Alexa).
## Installation
### Sample Application
For a sample application video tutorial, check
Samples are provided by the alexa_rubyengine project: https://github.com/damianFC/alexa_rubyengine
### For Ruby Projects:
Add this line to your application's Gemfile:
```ruby
gem 'alexa_rubykit'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install alexa_rubykit
## Usage
This Gem provides methods to create and handle request and response objects to be used in your container of choice.
Sample usage:
```ruby
require 'alexa_rubykit'
response = AlexaRubykit::Response.new
response.add_speech('Ruby is running ready!')
response.build_response
```
Will generate a valid outputspeech response in JSON format:
```JSON
{
"version": "1.0",
"response": {
"outputSpeech": {
"type": "PlainText",
"text": "Ruby is running ready!"
},
"shouldEndSession": true
}
}
```
## Troubleshooting
There are two sources of troubleshooting information: the Amazon Echo app/website and the EBS logs that you can get from
the management console.
- "Error in SSL handshake" : Make sure your used the FQDN when you generated the SSL and it's also the active SSL in EBS.
- "Error communicating with the application" : Query the EBS logs from the management console and create an issue on GitHub.
## Testing
Run the tests using
```bash
bundle exec rake
```
## Contributing
1. Decide to work on the "dev" (unstable) branch or "master" (stable)
1. Fork it ( https://github.com/[my-github-username]/alexa_rubykit/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
All development is done in the "dev" branch before being merged to master. Applications can use the developer
environment by adding the following line to their Gemfile:
```ruby
gem 'alexa_rubykit', :git => 'https://github.com/damianFC/alexa-rubykit.git', :branch => 'dev'
```
To use the stable/master branch, rename 'dev' to 'master' or remove :branch all together.