alexa_rubykit 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a95151aead793b4d6f509c8c5507bbef7f22528
-  data.tar.gz: fb349daf3f7a7d333d42ac33bf4be1cab78a81eb
+  metadata.gz: 82300a157ad72bda1af4da4ae9eebd461472bd96
+  data.tar.gz: 2973c59a6181e768dce7243292a2ae07c8d0aa52
 SHA512:
-  metadata.gz: f526deea3336eed5b3a333da266326331547f18f4887c33fb7240e856c0fa6478a2361802f7bc18b8420b74e6c4169781f6e3874e438004ee306a6d9097ad560
-  data.tar.gz: 03d2474089aa50cbea25df40d77d0d13ef2c504383a05fa8c3a0174aa22c96892acd199f39ec55c792d62be1c7361ff8e109c94d1fe41f526e05a8af48ecf1e9
+  metadata.gz: 468b2f0c87bc390ec889b006444d26df73e8d2dc675a8bf592b680f2b31e5be85ec738f8c3725c9aff9d165e3dedaf0c8ec7592ea2a266b6a6f274e4ba461bad
+  data.tar.gz: c1f7baf023b9b4af6f34c628de8cc1976e7da7efe47eabcedb079be7ba817c6d2c389518dbb5ec617f5010854934d3e80270daf9733ada407ed55a460f5db67f

data/Gemfile

@@ -1,9 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in alexa_rubykit.gemspec
-#gemspec
-
-gem "bundler", "~> 1.7"
-gem "rake", "~> 10.0"
-gem "sinatra", "~> 1.4"
-gem 'alexa_rubykit', "~> 0.0.7"
+gemspec

data/Gemfile.lock

@@ -1,14 +1,32 @@
-GEM
-  remote: https://rubygems.org/
+PATH
+  remote: .
   specs:
-    alexa_rubykit (0.0.6)
+    alexa_rubykit (0.0.9)
       bundler (~> 1.7)
       rake (~> 10.0)
       sinatra (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
     rack (1.6.0)
     rack-protection (1.5.3)
       rack
-    rake (10.3.2)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
     sinatra (1.4.6)
       rack (~> 1.4)
       rack-protection (~> 1.4)
@@ -19,7 +37,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  alexa_rubykit (~> 0.0.6)
-  bundler (~> 1.7)
-  rake (~> 10.0)
-  sinatra (~> 1.4)
+  alexa_rubykit!
+  rspec (~> 3.2.0)
+  rspec-mocks (~> 3.2.0)

data/README.md

@@ -1,10 +1,20 @@
 # AlexaRubykit
 
-This gem implements a quick back-end service for deploying applications for Amazon's Echo (Alexa), the gem,
-and samples are provided as-is and are in current development.
+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
+
+<a href="http://www.youtube.com/watch?feature=player_embedded&v=PwZf506UKHo" target="_blank"><img src="http://img.youtube.com/vi/PwZf506UKHo/0.jpg" 
+alt="Running a sample Rubykit Demo" width="240" height="180" border="5" /></a>
+
+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
@@ -21,16 +31,49 @@ Or install it yourself as:
 
 ## Usage
 
-For running the sample "say" application:
-* Configure your endpoint for SSL and load the certificate in the developer portal.
-* Execute alexa_rubyengine under the bin folder
-Sinatra will run in the background and serve a say command when it receives a LoginRequest command from
-the Alexa app.
+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.
 
 ## 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.
+
+
+
+# <a name="team-members"></a>Team Members
+* "Damian Finol" <damian.finol@gmail.com>

data/lib/alexa_rubykit.rb

@@ -1,6 +1,19 @@
 require 'alexa_rubykit/request'
+require 'alexa_rubykit/version'
+require 'alexa_rubykit/response'
+
 module AlexaRubykit
   def self.print_json(json)
     p json
   end
+
+  def self.print_version
+    p AlexaRubykit::VERSION
+  end
+
+  # Returns true if all the Alexa request objects are set.
+  def self.valid_alexa?(request_json)
+    !request_json.nil? || !request_json['session'].nil? ||
+        !request_json['version'].nil? || !request_json['request'].nil?
+  end
 end

data/lib/alexa_rubykit/request.rb

@@ -6,14 +6,15 @@ module AlexaRubykit
   class Request
     require 'json'
     require 'sinatra'
-    attr_accessor :version, :session_return, :response, :shouldEndSession
+    require 'alexa_rubykit'
+    attr_accessor :version, :session_return, :response, :shouldEndSession, :type
 
     @request = ''
     @type = ''
     def initialize(json_request)
-      halt 500 if json_request.nil?
+      halt 500 unless AlexaRubykit.valid_alexa?(json_request)
       @request = json_request
-      case @request['type']
+      case @request['request']['type']
         when /Launch/
           @type = 'LAUNCH'
         when /Intent/
@@ -24,32 +25,5 @@ module AlexaRubykit
           halt 500
       end
     end
-
-    # Builds a response.
-    # Takes the version, response and should_end_session variables and builds a JSON object.
-    def build_response
-      # Need to set all 3 parameters or the response is invalid
-      halt 500 if @version.nil? || @response.nil? || @shouldEndSession.nil?
-      response = Hash.new
-      response[:version] = @version
-      response[:sessionAttributes] = @session_return
-      response[:response] = @response
-      response.to_json
-    end
-
-    # Creates a outputspeech JSON object for responding with voice.
-    # Data type:
-    #"outputSpeech": {
-    #    "type": "string",
-    #    "text": "string"
-    #}
-    def say_response(speech)
-      output_speech = { :type => 'PlainText', :text => speech }
-      @response = { :outputSpeech => output_speech, :shouldEndSession => @shouldEndSession }
-    end
-
-    def add_session(session)
-      @session_return = { :new => false, :sessionId => session}
-    end
   end
 end

data/lib/alexa_rubykit/response.rb

@@ -0,0 +1,66 @@
+module AlexaRubykit
+  class Response
+    require 'json'
+    attr_accessor :version, :session, :response_object, :session_attributes, :speech, :response
+
+    # Every response needs a shouldendsession and a version attribute
+    # We initialize version to 1.0, use add_version to set your own.
+    def initialize(version = '1.0')
+      @session_attributes = Hash.new
+      @version = version
+    end
+
+    # Adds a key,value pair to the session object.
+    def add_session_attribute(key, value)
+      @session_attributes[key.to_sym] = value
+    end
+
+    def add_speech(speech_text)
+      @speech = { :type => 'PlainText', :text => speech_text }
+      @speech
+    end
+
+    # Adds a speech to the object, also returns a outputspeech object.
+    def say_response(speech, end_session = true)
+      output_speech = add_speech(speech)
+      { :outputSpeech => output_speech, :shouldEndSession => end_session }
+    end
+
+
+    # Creates a session object. We pretty much only use this in testing.
+    def build_session
+      # If it's empty assume user doesn't need session attributes.
+      @session_attributes = Hash.new if @session_attributes.nil?
+      @session = { :sessionAttributes => @session_attributes }
+      @session
+    end
+
+    # The response object (with outputspeech, cards and session end)
+    # Should rename this, but Amazon picked their names.
+    # The only mandatory field is end_session which we default to true.
+    def build_response_object(session_end = true)
+      @response = Hash.new
+      @response[:outputSpeech] = @speech unless @speech.nil?
+      # TODO: We need cards too
+      #response[:card] = @cards
+      @response[:shouldEndSession] = session_end
+      @response
+    end
+
+    # Builds a response.
+    # Takes the version, response and should_end_session variables and builds a JSON object.
+    def build_response
+      response_object = build_response_object
+      response = Hash.new
+      response[:version] = @version
+      response[:sessionAttributes] = @session_attributes unless @session_attributes.empty?
+      response[:response] = response_object
+      response.to_json
+    end
+
+    # TODO: Update this.
+    def to_s
+      "Version => #{@version}, SessionObj => #{@session}, Response => #{@response}"
+    end
+  end
+end

data/lib/alexa_rubykit/version.rb

@@ -1,3 +1,3 @@
 module AlexaRubykit
-  VERSION = '0.0.7'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alexa_rubykit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Damian Finol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,11 +52,38 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: Alexa Ruby Kit with examples
 email:
 - damian.finol@gmail.com
-executables:
-- alexa_rubyengine.rb
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,12 +92,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/alexa_rubyengine.rb
-- config.ru
 - lib/alexa_rubykit.rb
 - lib/alexa_rubykit/request.rb
+- lib/alexa_rubykit/response.rb
 - lib/alexa_rubykit/version.rb
-homepage: ''
+homepage: https://github.com/damianFC/alexa-rubykit
 licenses:
 - MIT
 metadata: {}

data/bin/alexa_rubyengine.rb

@@ -1,20 +0,0 @@
-# Alexa RubyEngine
-# This Engine receives and responds to Amazon Echo's (Alexa) JSON requests.
-require 'sinatra'
-require 'json'
-require 'alexa_rubykit'
-
-#enable :sessions
-post '/' do
-  content_type 'application/json'
-  # Check that it's a valid Alexa request
-  request_json = JSON.parse(request.body.read.to_s)
-  halt 500 if request_json['session'].nil? || request_json['version'].nil? || request_json['request'].nil?
-  #
-  request = AlexaRubykit::Request.new(request_json['request'])
-  request.version = '1.0'
-  request.add_session(request_json['session']['sessionId'])
-  request.shouldEndSession = true
-  request.say_response('Hello, this is a test')
-  request.build_response
-end

data/config.ru

@@ -1,2 +0,0 @@
-require './bin/alexa_rubyengine'
-run Sinatra::Application