clova-speech 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5df3bd56f3d5eac180fd191333d75172f4044e6b758b0f04538c8aa15c2e8082
+  data.tar.gz: 0ab2b3ba5d794293edeafcabe8eaedb8a082c786f6ab5243faccaf2f044af1d0
+SHA512:
+  metadata.gz: 3ad9d85dc5d8683fc42546a89ea3502b17ac58e37f9c98212b353b08286711c6bbad0ce3987e28b1c48bae129b0d6fdb0619f2084c5255bf5bee36b573309cd0
+  data.tar.gz: 46c0498da965b546003f57b58297d3eaed6478c05a559361473ec90b398f5c2b5d4ab9a4dbeeaabd3ecd8d941afe916151eb9583378f787f50d9b98a490b5b7e

data/README.md

@@ -0,0 +1,24 @@
+# Clova-Speech
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clova-speech' 
+```
+
+And then execute:
+
+$ bundle
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+

data/lib/clova.rb

@@ -0,0 +1,14 @@
+require 'clova/version'
+require 'clova/config'
+require 'clova/request'
+require 'clova/response'
+require 'clova/event_request'
+require 'clova/intent_request'
+require 'clova/output_speech'
+require 'clova/validator'
+require 'clova/session'
+require 'clova/launch_request'
+require 'clova/session_ended_request'
+require 'clova/client'
+require 'clova/skill'
+require 'json'

data/lib/clova/client.rb

@@ -0,0 +1,43 @@
+module Clova
+  class Client
+
+    attr_accessor :config
+
+    def initialize
+      @config = Config.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def build_response(raw_request)
+      request = self.build_request(raw_request)
+      skill = config.skill_class.new(request)
+      skill.call
+    end
+
+    #raw_request: the HTTPRequest that is recieved, including headers, body, before deserialization
+    def build_request(raw_request)
+      validator = Clova::Validator.new(app_id: config.application_id)
+      validator.validate(raw_request)
+
+      raw_request.body.rewind #allows for the request to be read a second time
+      request = JSON.parse(raw_request.body.read.to_s, :symbolize_names => true)
+      type = request[:request].fetch(:type)
+
+      case type
+      when 'IntentRequest'
+        IntentRequest.new(request)
+      when 'EventRequest'
+        EventRequest.new(request)
+      when 'LaunchRequest'
+        LaunchRequest.new(request)
+      when 'SessionEndedRequest'
+        SessionEndedRequest.new(request)
+      else
+        raise "Request Invalid (no matching type)"
+      end
+    end
+  end
+end

data/lib/clova/config.rb

@@ -0,0 +1,10 @@
+module Clova
+  class Config
+    attr_accessor :application_id, :skill_class
+
+    def initialize
+      @application_id = nil
+      @skill_class = nil
+    end
+  end
+end

data/lib/clova/event_request.rb

@@ -0,0 +1,14 @@
+module Clova
+  class EventRequest < Request
+    attr_reader :namespace, :name, :payload, :event, :type
+    def initialize(session:, context:, request:, version:)
+      super
+      @event = request[:event]
+      @namespace = @event[:namespace]
+      @name = @event[:name]
+      @payload = @event[:payload]
+
+      @type = 'EventRequest'
+    end
+  end
+end

data/lib/clova/intent_request.rb

@@ -0,0 +1,19 @@
+module Clova
+  class IntentRequest < Request
+    attr_accessor :name, :slots, :intent, :type
+    def initialize(session:, context:, request:, version:)
+      super
+      @intent = request[:intent]
+      @name = @intent[:name]
+      @slots = @intent[:slots]
+
+      @type = 'IntentRequest'
+    end
+
+    def find_slot_value_by(slot_name)
+      name = slot_name
+      name = name.to_sym if name.is_a?(String)
+      @slots[name][:value]
+    end
+  end
+end

data/lib/clova/launch_request.rb

@@ -0,0 +1,9 @@
+module Clova
+  class LaunchRequest < Request
+    attr_reader :type
+    def initialize(session:, context:, request:, version:)
+      super
+      @type = 'LaunchRequest'
+    end
+  end
+end

data/lib/clova/output_speech.rb

@@ -0,0 +1,66 @@
+module Clova
+  class OutputSpeech
+    def initialize
+      @lang = 'ja'
+      @speech_info_objects = []
+    end
+
+    def as_json
+      {type: type, values: values}
+    end
+
+    def empty?
+      @speech_info_objects.empty?
+    end
+
+    def add_speech(value:, type:'PlainText', language: @lang)
+      case type
+      when 'PlainText'
+        lang = language
+      when 'URL'
+        lang = ''
+      end
+      @speech_info_objects << SpeechInfoObject.new(lang: lang, value:value, type:type)
+    end
+
+    def simple_speech?
+      @speech_info_objects.one?
+    end
+
+    def speech_list?
+      !simple_speech?
+    end
+
+    def type
+      case
+      when simple_speech? then 'SimpleSpeech'
+      when speech_list? then 'SpeechList'
+      else
+        raise 'Type not found'
+      end
+    end
+
+    def values
+      case
+      when simple_speech?
+        @speech_info_objects.first.as_json
+      when speech_list?
+        @speech_info_objects.map(&:as_json)
+      end
+    end
+
+    class SpeechInfoObject
+      attr_accessor :type, :lang, :value
+
+      def initialize(lang:, value:, type:)
+        @lang = lang
+        @type = type
+        @value = value
+      end
+
+      def as_json
+        {type: type, lang: lang, value: value}
+      end
+    end
+  end
+end

data/lib/clova/request.rb

@@ -0,0 +1,15 @@
+module Clova
+  class Request
+    attr_reader :session, :context, :version
+
+    def initialize(session:, context:, request:, version:)
+      @context = context
+      @session = Session.new(session)
+      @version = version
+    end
+
+    def session_attributes
+      @session.session_attributes
+    end
+  end
+end

data/lib/clova/response.rb

@@ -0,0 +1,55 @@
+module Clova
+  class Response
+    attr_accessor :type, :output_speech, :session_attributes, :should_end_session, :version, :card, :directives, :reprompt_speech, :default_language
+
+    def initialize
+      @default_language = 'ja'
+      @version = Clova::VERSION
+      @output_speech = OutputSpeech.new
+      @session_attributes = {}
+      @directives = []
+      @should_end_session = false
+      @card = {}
+      @reprompt_speech = OutputSpeech.new
+    end
+
+    def as_json
+      {
+          version: version,
+          sessionAttributes: session_attributes,
+          response: response
+      }
+    end
+
+    def add_session_attribute(key:, value:)
+      @session_attributes[key] = value
+    end
+
+    #type either is 'PlainText' or 'URL'
+    def add_speech(value, type:'PlainText', language: @default_language)
+      @output_speech.add_speech(value: value, type: type, language: language)
+    end
+
+    def add_reprompt(value, type: 'PlainText')
+      @reprompt_speech.add_speech(value: value, type: type)
+    end
+
+    def add_session_attribute(key:, value:)
+      @session_attributes[key] = value
+    end
+
+    def response
+      hash = {
+          outputSpeech: output_speech.as_json,
+          card: card,
+          directives: directives,
+          shouldEndSession: should_end_session
+      }
+
+      if !@reprompt_speech.empty?
+        hash[:reprompt] = {outputSpeech: reprompt_speech.as_json}
+      end
+      hash
+    end
+  end
+end

data/lib/clova/session.rb

@@ -0,0 +1,22 @@
+module Clova
+  class Session
+    attr_accessor :new, :session_attributes, :session_id, :user
+
+    def initialize(new:, sessionAttributes:, sessionId:, user:)
+      @new = new #boolean
+      @session_attributes = sessionAttributes #key-value pair object, stores data from previous ClovaResponse' session_attributes
+      @session_id = sessionId #String
+      @user = User.new(user)
+    end
+
+
+    class User
+      attr_accessor :user_id, :access_token
+
+      def initialize(userId:, accessToken:nil)
+        @user_id = userId
+        @access_token = accessToken
+      end
+    end
+  end
+end

data/lib/clova/session_ended_request.rb

@@ -0,0 +1,10 @@
+module Clova
+  class SessionEndedRequest < Request
+     attr_accessor :type
+
+    def initialize(session:, context:, request:, version:)
+      super
+      @type = 'SessionEndedRequest'
+    end
+  end
+end

data/lib/clova/skill.rb

@@ -0,0 +1,25 @@
+module Clova
+  class Skill
+    attr_accessor :request, :response
+    def initialize(request)
+      @request = request
+      @response = response
+    end
+
+    def call
+      case request.type
+      when 'LaunchRequest' then launch_request
+      when 'IntentRequest' then intent_request
+      when 'EventRequest' then event_request
+      when 'SessionEndedRequest' then session_ended_request
+      end
+      @response.as_json.to_json
+    end
+
+    private
+
+    def response
+      @response ||= Clova::Response.new
+    end
+  end
+end

data/lib/clova/validator.rb

@@ -0,0 +1,56 @@
+require 'openssl'
+require 'base64'
+
+# Each request contains an application_id, which mirrors the extension_id the developer
+# sets on the Clova development portal. Every request is also signed using RSA encryption
+
+module Clova
+  class Validator
+    attr_accessor :app_id
+
+    # raw_request: is the body of the incoming request, in the form of String
+    # request_sign: is the signature, found in the header of the request under "SignatureCEK"
+    def initialize(app_id:)
+      @app_id = app_id
+    end
+
+    def validate(raw_request)
+      request_body_str = raw_request.body.read
+      request_sign = raw_request.env["HTTP_SIGNATURECEK"]
+
+      sign_result = valid_signature?(request_body_str, request_sign)
+      app_id_result = valid_app_id?(request_body_str)
+
+      raise 'Bad Request: invalid signature' unless sign_result
+      raise 'Bad Request: invalid application id' unless app_id_result
+
+      sign_result && app_id_result
+    end
+
+    def valid_signature?(request_body_str, request_sign)
+      key = OpenSSL::PKey::RSA.new clova_public_key
+      key.public_key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(request_sign), request_body_str)
+    end
+
+    def valid_app_id?(request_body_str)
+      request = JSON.parse(request_body_str)
+      request_app_id = request['context']['System']['application']['applicationId']
+      app_id == request_app_id
+    end
+
+    private
+    def clova_public_key
+      <<~PEM.chomp
+        -----BEGIN PUBLIC KEY-----
+        MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwiMvQNKD/WQcX9KiWNMb
+        nSR+dJYTWL6TmqqwWFia69TyiobVIfGfxFSefxYyMTcFznoGCpg8aOCAkMxUH58N
+        0/UtWWvfq0U5FQN9McE3zP+rVL3Qul9fbC2mxvazxpv5KT7HEp780Yew777cVPUv
+        3+I73z2t0EHnkwMesmpUA/2Rp8fW8vZE4jfiTRm5vSVmW9F37GC5TEhPwaiIkIin
+        KCrH0rXbfe3jNWR7qKOvVDytcWgRHJqRUuWhwJuAnuuqLvqTyAawqEslhKZ5t+1Z
+        0GN8b2zMENSuixa1M9K0ZKUw3unzHpvgBlYmXRGPTSuq/EaGYWyckYz8CBq5Lz2Q
+        UwIDAQAB
+        -----END PUBLIC KEY-----
+      PEM
+    end
+  end
+end

data/lib/clova/version.rb

@@ -0,0 +1,3 @@
+module Clova
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: clova-speech
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isaiah Bush
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Clova API - SDK of the LINE Clova Smart Speaker API for Ruby. Developed
+  as part of an internship at LINE Corp
+email:
+- itbush@cs.stanford.com, itbush2016@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/clova.rb
+- lib/clova/client.rb
+- lib/clova/config.rb
+- lib/clova/event_request.rb
+- lib/clova/intent_request.rb
+- lib/clova/launch_request.rb
+- lib/clova/output_speech.rb
+- lib/clova/request.rb
+- lib/clova/response.rb
+- lib/clova/session.rb
+- lib/clova/session_ended_request.rb
+- lib/clova/skill.rb
+- lib/clova/validator.rb
+- lib/clova/version.rb
+homepage: https://github.com/itbush/clova-speech
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: SDK of the LINE Clova Smart Speaker
+test_files: []