alexa_ruby 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05efe37b6e97b7278bbfe995867983640c07b90d
-  data.tar.gz: '08e039b53252f7a87961e7d21cd02a45a2917c64'
+  metadata.gz: f0ecb9d2206ffa52620becb38d2979af5b2d382f
+  data.tar.gz: 99f7d15b8f7b672d7e0e3007bcefeb5129a018de
 SHA512:
-  metadata.gz: 75606a0692119854f7ed8492892b64be91e52554c6d271b0e8a4b3d04f545f254942b16e616144945bfccd0fba79fdd58f366a1df195e44352a49a724c67dab7
-  data.tar.gz: 632e697b97175adfe62a22a8b1978b9bae2027d6c69fb901d1c6de4f06e4dacd0557a7faa9ea80b28eb45316bc40508876d6148bf51ac985fc9d02be6cee0722
+  metadata.gz: ecdf130e009bb208852f1035451348a86d9b872da7536987a4bc3f82de36801e5438c1ed488c6af7b2b135595819cfe4ee593124cfa9268030cc0f1bd4bc8f3b
+  data.tar.gz: 0e451beda04f13e9b50e816f0090da713fdeca3e1b6ef26580dc41904b0d3a018510ea45ba80ca57ec2633f716eb27305933a2955f607eefe80e3c46ab3f49f9

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
-ruby '2.3.4'
 
 # Specify your gem's dependencies in alexa_rubykit.gemspec
 gemspec

data/Gemfile.lock

@@ -1,41 +1,44 @@
 PATH
   remote: .
   specs:
-    alexa_ruby (0.0.0)
-      bundler (~> 1.7)
+    alexa_ruby (0.2.0)
+      bundler (>= 1.6.9)
       oj (~> 3.0)
       rake
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
+    ansi (1.5.0)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    docile (1.1.5)
+    json (2.1.0)
+    minitest (5.10.2)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     oj (3.0.10)
     rake (12.0.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+    ruby-progressbar (1.8.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   alexa_ruby!
-  rspec (~> 3.2, >= 3.2.0)
-  rspec-mocks (~> 3.2, >= 3.2.0)
-
-RUBY VERSION
-   ruby 2.3.4p301
+  codeclimate-test-reporter (~> 1.0.0)
+  minitest (~> 5.10, >= 5.10.2)
+  minitest-reporters (~> 1.1, >= 1.1.14)
+  simplecov
 
 BUNDLED WITH
    1.15.0

data/README.md

@@ -2,8 +2,10 @@
 
 [![Gem Version](https://badge.fury.io/rb/alexa_ruby.svg)](https://badge.fury.io/rb/alexa_ruby)
 [![Build Status](https://travis-ci.org/mulev/alexa-ruby.svg?branch=master)](https://travis-ci.org/mulev/alexa-ruby)
+[![Code Climate](https://codeclimate.com/github/mulev/alexa-ruby/badges/gpa.svg)](https://codeclimate.com/github/mulev/alexa-ruby)
+[![Test Coverage](https://codeclimate.com/github/mulev/alexa-ruby/badges/coverage.svg)](https://codeclimate.com/github/mulev/alexa-ruby/coverage)
 
-Originally forked from [damianFC's AlexaRubykit](https://github.com/damianFC/alexa-rubykit), this gem implements a back-end service for interaction with Amazon Alexa API.
+Originally forked from [damianFC's AlexaRubykit](https://github.com/damianFC/alexa-rubykit), this gem implements a convenient back-end service for interaction with Amazon Alexa API.
 
 ## Installation
 
@@ -25,39 +27,49 @@ Or install it as a separate gem:
 $ gem install alexa_ruby
 ```
 
-## Usage
+## Docs
+
+|Resource|URL|
+|---|---|
+|Rubydoc|[http://www.rubydoc.info/gems/alexa_ruby](http://www.rubydoc.info/gems/alexa_ruby)|
+|Source|[https://github.com/mulev/alexa-ruby](https://github.com/mulev/alexa-ruby)|
+|Bugs|[https://github.com/mulev/alexa-ruby/issues](https://github.com/mulev/alexa-ruby/issues)|
 
-Gem provides methods to handle requests from Amazon Alexa skill and to sent it a proper response.
+## Usage
 
-You can quickly try it with that sample code:
+Gem provides a possibility to easily handle requests from Amazon Alexa service and build responses to given requests.
+Usage is as easy as:
 
 ```ruby
 require 'alexa_ruby'
 
-response = AlexaRuby::Response.new
-response.add_speech('Yay, ruby is running!')
-response.build_response
+alexa = AlexaRuby.new(request) # request is a HTTP request body
+alexa.response.tell!('Ruby is awesome!')
 ```
 
-It will generate valid outspeech JSON:
+This simple example will return a valid JSON with response to Amazon Alexa service request:
 
-```JSON
+```json
 {
   "version": "1.0",
+  "sessionAttributes": {},
   "response": {
+    "shouldEndSession": true,
     "outputSpeech": {
       "type": "PlainText",
-      "text": "Yay, ruby is running!"
-    },
-    "shouldEndSession": true
+      "text": "Ruby is awesome!"
+    }
   }
 }
+
 ```
 
+Gem can be used with any framework - Rails, Sinatra, Cuba, Roda, or any other that can handle HTTP requests and responses.
+
 ## Testing
 
-Run the tests using
+Run all tests with
 
 ```bash
-bundle exec rspec --color --format=documentation
+$ rake test
 ```

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new
+ENV['env'] = 'test'
+ENV['CODECLIMATE_REPO_TOKEN'] = '700b2d6bc97a4c5d504565407b412451e3d8fe2cf7967f57ca75c01ae7d92c16'
 
-task :default => [:spec]
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/alexa_ruby/alexa.rb

@@ -0,0 +1,52 @@
+module AlexaRuby
+  # Main processing class, parses request from Amazon Alexa and
+  # initialize new response object
+  class Alexa
+    attr_reader :request, :response
+
+    # Initialize new Alexa assistant
+    #
+    # @param request [Hash] request from Amazon Alexa web service
+    def initialize(request)
+      @req = request
+      invalid_request_exception if invalid_request?
+      @request = define_request
+      raise ArgumentError, 'Unknown type of Alexa request' if @request.nil?
+      @response = Response.new(@request.type, @request.version)
+    end
+
+    private
+
+    # Check if it is an invalid request
+    #
+    # @return [Boolean]
+    def invalid_request?
+      @req[:version].nil? || @req[:context].nil? || @req[:request].nil?
+    end
+
+    # Request structure isn't valid, raise exception
+    def invalid_request_exception
+      raise ArgumentError,
+            'Invalid request structure, ' \
+            'please, refer to the Amazon Alexa manual: ' \
+            'https://developer.amazon.com/public/solutions' \
+            '/alexa/alexa-skills-kit/docs/alexa-skills-kit-interface-reference'
+    end
+
+    # Initialize proper request object
+    #
+    # @return [Object] request object
+    def define_request
+      case @req[:request][:type]
+      when /Launch/
+        LaunchRequest.new(@req)
+      when /Intent/
+        IntentRequest.new(@req)
+      when /SessionEnded/
+        SessionEndedRequest.new(@req)
+      when /AudioPlayer/, /PlaybackController/
+        AudioPlayerRequest.new(@req)
+      end
+    end
+  end
+end

data/lib/alexa_ruby/request/audio_player_request.rb

@@ -1,50 +1,43 @@
 module AlexaRuby
-  # AudioPlayerRequest class implements Alexa "AudioPlayer" request type
-  class AudioPlayerRequest < Request
-    attr_accessor :playback_state, :playback_offset, :error_type,
-                  :error_message, :error_playback_token, :error_player_activity
+  # Alexa "AudioPlayer" and "PlaybackController" request type
+  class AudioPlayerRequest < BaseRequest
+    attr_reader :playback_state, :playback_offset, :error_type,
+                :error_message, :error_playback_token, :error_player_activity
 
     # Initialize new AudioPlayer request
     #
-    # @param json [Hash] valid JSON request from Amazon
-    def initialize(json)
+    # @param request [Hash] valid request from Amazon Alexa service
+    def initialize(request)
       @type = :audio_player
-      req = json[:request]
+      super
+      req = @req[:request]
       @playback_state = req[:type].gsub!('AudioPlayer.', '')
       @playback_offset = current_offset(req)
       define_error_params(req) if @playback_state == 'PlaybackFailed'
-      super
-    end
-
-    # Outputs the launch requestID
-    #
-    # @return [String] launch request ID
-    def to_s
-      "AudioPlayerRequest requestID: #{request_id}"
     end
 
     private
 
     # Get current playback offset from request
     #
-    # @param json [Hash] "request" part of json request from Amazon
+    # @param request [Hash] valid request from Amazon Alexa service
     # @return [Integer] playback offset in milliseconds at the moment of request
-    def current_offset(json)
+    def current_offset(request)
       if @playback_state == 'PlaybackFailed'
-        json[:currentPlaybackState][:offsetInMilliseconds]
+        request[:currentPlaybackState][:offsetInMilliseconds]
       else
-        json[:offsetInMilliseconds]
+        request[:offsetInMilliseconds]
       end
     end
 
     # Define all error parameters if an error occured during playback
     #
-    # @param json [Hash] "request" part of json request from Amazon
-    def define_error_params(json)
-      @error_type = json[:error][:type]
-      @error_message = json[:error][:message]
-      @error_playback_token = json[:currentPlaybackState][:token]
-      @error_player_activity = json[:currentPlaybackState][:playerActivity]
+    # @param request [Hash] valid request from Amazon Alexa service
+    def define_error_params(request)
+      @error_type = request[:error][:type]
+      @error_message = request[:error][:message]
+      @error_playback_token = request[:currentPlaybackState][:token]
+      @error_player_activity = request[:currentPlaybackState][:playerActivity]
     end
   end
 end

data/lib/alexa_ruby/request/base_request/context/device.rb

@@ -0,0 +1,28 @@
+module AlexaRuby
+  # User device parameters
+  class Device
+    attr_reader :id, :interfaces
+
+    # Initialize new device
+    #
+    # @param device [Hash] user device parameters
+    # @raise [ArgumentError] if device ID is nil
+    def initialize(device)
+      raise ArgumentError, 'Missing device ID' if device[:deviceId].nil?
+      @id = device[:deviceId]
+      load_interfaces(device[:supportedInterfaces])
+    end
+
+    private
+
+    # Load supported interfaces
+    #
+    # @param device [Hash] supported interfaces list
+    def load_interfaces(device)
+      @interfaces = []
+      device.each do |k, _|
+        @interfaces << k
+      end
+    end
+  end
+end

data/lib/alexa_ruby/request/base_request/context/user.rb

@@ -0,0 +1,28 @@
+module AlexaRuby
+  # Amazon Alexa user
+  class User
+    attr_reader :id, :access_token, :permissions_token
+
+    # Initialize new user
+    #
+    # @param user [Hash] user parameters
+    # @raise [ArgumentError] if user ID is nil
+    def initialize(user)
+      raise ArgumentError, 'Missing user ID' if user[:userId].nil?
+      @id = user[:userId]
+      @access_token = user[:accessToken] unless user[:accessToken].nil?
+      return if user[:permissions].nil?
+      @permissions_token = permissions(user[:permissions])
+    end
+
+    private
+
+    # Get user permissions token
+    #
+    # @param permissions [Hash] user permissions object
+    # @return [String] user permissions consent token
+    def permissions(permissions)
+      permissions[:consentToken] unless permissions[:consentToken].nil?
+    end
+  end
+end

data/lib/alexa_ruby/request/base_request/context.rb

@@ -0,0 +1,45 @@
+module AlexaRuby
+  # Amazon Alexa request context - application, user and device info
+  class Context
+    attr_reader :app_id, :user, :device, :api_endpoint
+
+    # Initialize new Context object
+    #
+    # @param context [Hash] request context parameters
+    # @raise [ArgumentError] if application ID, or user ID, or device ID are nil
+    def initialize(context)
+      @app_id = get_app_id(context[:System][:application])
+      raise ArgumentError, 'Missing application ID' unless @app_id
+
+      @user = load_user(context[:System][:user])
+      @device = load_device(context[:System][:device])
+      @api_endpoint = context[:System][:apiEndpoint]
+    end
+
+    private
+
+    # Get application ID
+    #
+    # @param app [Hash] application parameters
+    # @return [String] application ID
+    def get_app_id(app)
+      app[:applicationId] unless app[:applicationId].nil?
+    end
+
+    # Initialize user parameters
+    #
+    # @param params [Hash] user parameters
+    # @return [Object] new User object instance
+    def load_user(params)
+      User.new(params)
+    end
+
+    # Initialize user device parameters
+    #
+    # @param params [Hash] user device parameters
+    # @return [Object] new Device object instance
+    def load_device(params)
+      Device.new(params)
+    end
+  end
+end

data/lib/alexa_ruby/request/base_request/session.rb

@@ -0,0 +1,60 @@
+module AlexaRuby
+  # Amazon Alexa user session
+  class Session
+    attr_reader :id, :attributes, :end_reason, :error
+    attr_accessor :state
+
+    # Initialize new Session
+    #
+    # @param session [Hash] session parameters
+    # @raise [ArgumentError] if user session data is absent
+    def initialize(session)
+      @session = session
+      raise ArgumentError, 'Empty user session' if invalid_session?
+
+      @state = @session[:new] ? :new : :old
+      @id = @session[:sessionId]
+      @attributes = @session[:attributes] || {}
+    end
+
+    # Set session end reason
+    #
+    # @param reason [String] reason type from Amazon Alexa request
+    def end_reason=(reason)
+      @end_reason =
+        case reason
+        when 'USER_INITIATED'
+          :user_quit
+        when 'ERROR'
+          :processing_error
+        when 'EXCEEDED_MAX_REPROMPTS'
+          :user_idle
+        end
+    end
+
+    # Set error parameters
+    #
+    # @param err [Hash] error params
+    def error=(err)
+      @error = { message: err[:message] }
+      @error[:type] =
+        case err[:type]
+        when 'INVALID_RESPONSE'
+          :invalid_alexa_ruby_response
+        when 'DEVICE_COMMUNICATION_ERROR'
+          :device_error
+        when 'INTERNAL_ERROR'
+          :runtime_error
+        end
+    end
+
+    private
+
+    # Check if it is an invalid user session
+    #
+    # @return [Boolean]
+    def invalid_session?
+      @session.nil?
+    end
+  end
+end

data/lib/alexa_ruby/request/base_request.rb

@@ -0,0 +1,53 @@
+module AlexaRuby
+  # Amazon Alexa web service request
+  class BaseRequest
+    attr_reader :version, :type, :session, :context, :id, :timestamp, :locale
+
+    # Initialize new request object
+    #
+    # @param request [Hash] request from Amazon Alexa web service
+    def initialize(request)
+      @req = request
+      @version = @req[:version]
+      @session = parse_session unless @type == :audio_player
+      @context = parse_context
+      @id = nil
+      @timestamp = nil
+      @locale = nil
+      parse_base_params(@req[:request])
+    end
+
+    # Return JSON representation of given request
+    #
+    # @return [String] request json
+    def json
+      Oj.to_json(@req)
+    end
+
+    private
+
+    # Build session object
+    def parse_session
+      Session.new(@req[:session])
+    end
+
+    # Build a request context object
+    #
+    # @return [Object] new Context object instance
+    def parse_context
+      Context.new(@req[:context])
+    end
+
+    # Set request parameters
+    #
+    # @param req [Hash] request parameters
+    # @raise [ArgumentError] if missing ID or timestamp
+    def parse_base_params(req)
+      @id = req[:requestId] unless req[:requestId].nil?
+      raise ArgumentError, 'Missing request ID' unless @id
+      @timestamp = DateTime.parse(req[:timestamp]) unless req[:timestamp].nil?
+      raise ArgumentError, 'Missing request timestamp' unless @timestamp
+      @locale = req[:locale] unless req[:locale].nil?
+    end
+  end
+end

data/lib/alexa_ruby/request/intent_request/slot.rb

@@ -1,23 +1,40 @@
 module AlexaRuby
   # Class that encapsulates each slot
   class Slot
-    attr_accessor :name, :value
+    attr_accessor :name, :value, :confirmation_status
 
     # Initialize slot and define its name and value
     #
-    # @param name [String] slot name
-    # @param value [String] slot value
-    def initialize(name, value)
-      raise ArgumentError, 'Need a name and a value' if name.nil? || value.nil?
-      @name = name
-      @value = value
+    # @param slot [Hash] slot parameters
+    def initialize(slot)
+      @slot = slot
+      raise ArgumentError, 'Missing slot parameters' if invalid_slot?
+      @name = @slot[:name]
+      @value = @slot[:value]
+      @confirmation_status = define_confirmation_status
     end
 
-    # Outputs Slot name and value
+    private
+
+    # Check if it is a valid slot or not
+    #
+    # @return [Boolean]
+    def invalid_slot?
+      @slot[:name].nil? || @slot[:value].nil?
+    end
+
+    # Define user confirmation status
     #
-    # @return [String] Slot name and value
-    def to_s
-      "Slot Name: #{name}, Value: #{value}"
+    # @return [Symbol] current confirmation status
+    def define_confirmation_status
+      case @slot[:confirmationStatus]
+      when 'NONE'
+        :unknown
+      when 'CONFIRMED'
+        :confirmed
+      when 'DENIED'
+        :denied
+      end
     end
   end
 end

data/lib/alexa_ruby/request/intent_request.rb

@@ -1,61 +1,60 @@
-require 'alexa_ruby/request/intent_request/slot'
-
 module AlexaRuby
   # IntentRequest class implements Alexa "IntentRequest" request type
-  class IntentRequest < Request
-    attr_accessor :intent, :name, :slots
+  class IntentRequest < BaseRequest
+    attr_reader :intent_name, :dialog_state, :confirmation_status, :slots
 
     # Initialize new Intent request
     #
-    # @param json [JSON] valid JSON request from Amazon
-    def initialize(json)
-      @intent = json[:request][:intent]
-      if @intent.nil?
-        raise ArgumentError, 'Intent should exist on an IntentRequest'
-      end
-
+    # @param request [Hash] valid request from Amazon Alexa service
+    def initialize(request)
       @type = :intent
-      @name = @intent[:name]
-      @slots = @intent[:slots]
-
       super
-    end
-
-    # Takes a Hash object with slots and add it to slots node
-    #
-    # @param slots [Hash] hash with slots data
-    def add_hash_slots(slots)
-      raise ArgumentError, 'Slots can\'t be empty' if slots.nil?
-      slots.each do |slot|
-        @slots[:slot[:name]] = Slot.new(slot[:name], slot[:value])
+      if @req[:request][:intent].nil?
+        raise ArgumentError, 'Intent must be defined'
       end
-      @slots
+      @intent = @req[:request][:intent]
+      @dialog_state = define_dialog_state
+      @intent_name = @intent[:name]
+      @confirmation_status = define_confirmation_status
+      parse_slots unless @intent[:slots].nil?
     end
 
-    # Takes a JSON with slots and add it to slots node
+    private
+
+    # Define current dialog state
     #
-    # @param slots [JSON] json object with slots data
-    def add_slots(slots)
-      slot_hash = Oj.load(slots, symbol_keys: true)
-      add_hash_slots(slot_hash)
+    # @return [Symbol] current dialog state
+    def define_dialog_state
+      case @req[:request][:dialogState]
+      when 'STARTED'
+        :started
+      when 'IN_PROGRESS'
+        :in_progress
+      when 'COMPLETED'
+        :completed
+      end
     end
 
-    # Adds a slot from a name and a value
+    # Define user confirmation status
     #
-    # @param name [String] slot name
-    # @param value [String] slot value
-    # @return [Object] new slot object
-    def add_slot(name, value)
-      slot = Slot.new(name, value)
-      @slots[:name] = slot
-      slot
+    # @return [Symbol] current confirmation status
+    def define_confirmation_status
+      case @intent[:confirmationStatus]
+      when 'NONE'
+        :unknown
+      when 'CONFIRMED'
+        :confirmed
+      when 'DENIED'
+        :denied
+      end
     end
 
-    # Outputs the Intent Name, request Id and slot information
-    #
-    # @return [String] Intent Name, request Id and slot information
-    def to_s
-      "IntentRequest: #{name} requestID: #{request_id}  Slots: #{slots}"
+    # Parse slots and initialize each slot
+    def parse_slots
+      @slots = []
+      @intent[:slots].each do |_, v|
+        @slots << Slot.new(v)
+      end
     end
   end
 end