net.kebernet.skillz.format.ConstantBundle.java Source code

Introduction

Here is the source code for net.kebernet.skillz.format.ConstantBundle.java

Source

/*
 *    Copyright (c) 2016 Robert Cooper
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package net.kebernet.skillz.format;

import com.amazon.speech.speechlet.Session;
import com.amazon.speech.speechlet.SpeechletRequest;
import com.amazon.speech.ui.OutputSpeech;
import com.google.common.io.CharStreams;
import net.kebernet.skillz.builder.PlainTextOutputBuilder;
import net.kebernet.skillz.builder.SsmlOutputBuilder;

import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.ResourceBundle;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * This is a Bundle that just reads from files and doesn't transform them in any way.
 * 
 * <p>
 * You can create a <code>ConstantBundle</code> to return simple constant responses from your Skill. This is
 * useful for help text and the like.
 * The bundle will look for <code>[resourcePath].[languageCode].[format]</code> on the classpath
 * (<code>resourcePath</code> should likely start with a "/" since it will be loaded relative to the
 * <code>MustacheBundle</code> classpath).
 * </p>
 * <p>
 * If the given language code doesn't exist, it will look for a template without a language. Format can
 * be <code>ssml</code>, <code>txt</code>, or <code>card</code>. Card will always be used to format your card content. If
 * <code>ssml</code> is present, it will be used to format an <code>SsmlSpeechOutput</code>. If that is not present,
 * the <code>txt</code> template will be used to create a <code>PlainTextSpeechOutput</code> response.
 * </p>
 */
@SuppressWarnings("unused")
public class ConstantBundle implements Bundle {
    private static final Logger LOGGER = Logger.getLogger(ResourceBundle.class.getCanonicalName());
    private final String bundleName;
    private String ssml;
    private String txt;
    private String card;

    /**
     * Creates a new bundle based on the classpath resource "bundleName" and the given language code.
     * @param bundleName A classpath prefix, starting with "/" to your template fiels
     * @param languageCode The language code to check for.
     */
    @SuppressWarnings("WeakerAccess")
    public ConstantBundle(String bundleName, String languageCode) {
        this.bundleName = bundleName;
        this.ssml = readFromResource(bundleName, languageCode, "ssml");
        this.txt = readFromResource(bundleName, languageCode, "txt");
        this.card = readFromResource(bundleName, languageCode, "card");
    }

    private static String readFromResource(String resourceBaseName, String languageCode, String fileType) {
        URL url = null;
        try {
            url = ConstantBundle.class.getResource(resourceBaseName + "." + languageCode + "." + fileType);
            url = url == null ? ConstantBundle.class.getResource(resourceBaseName + "." + fileType) : url;
            if (url != null) {
                return CharStreams.toString(new InputStreamReader(url.openStream(), "utf-8"));
            }

        } catch (IOException e) {
            LOGGER.log(Level.WARNING, "Failed to parse " + url.toExternalForm(), e);
        }
        return null;
    }

    @Override
    public OutputSpeech createOutputSpeech(Object response, SpeechletRequest request, Session session) {
        return ssml != null ? SsmlOutputBuilder.withSsml(ssml).withId("urn:ssml:" + this.bundleName).build()
                : PlainTextOutputBuilder.withText(txt).withId("urn:txt:" + this.bundleName).build();
    }

    @Override
    public String createCardContent(Object response, SpeechletRequest request, Session session) {
        return card;
    }
}