com.freenow.apis.phrase.tasks.PhraseAppSyncTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phrase-java-client Show documentation
This projects contains of services to handle the translations from [PhraseApp API v2](http://docs.phraseapp.com/api/v2/). It's supposed to expose Phrase translations as POJO or as File within the java world.
There is a newer version: 3.0.0
Show newest version
package com.freenow.apis.phrase.tasks;

import com.google.common.base.Joiner;
import com.google.common.base.Preconditions;
import com.google.common.collect.Collections2;
import com.freenow.apis.phrase.api.format.Format;
import com.freenow.apis.phrase.api.locale.PhraseLocaleAPI;
import com.freenow.apis.phrase.api.localedownload.PhraseLocaleDownloadAPI;
import com.freenow.apis.phrase.domainobject.locale.PhraseBranch;
import com.freenow.apis.phrase.domainobject.locale.PhraseLocale;
import com.freenow.apis.phrase.domainobject.locale.PhraseProject;
import com.freenow.apis.phrase.exception.PhraseAppApiException;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.freenow.apis.phrase.api.localedownload.PhraseLocaleDownloadAPI.DEFAULT_FILE_FORMAT;
import static com.freenow.apis.phrase.api.localedownload.PhraseLocaleDownloadAPI.DEFAULT_BRANCH;

public class PhraseAppSyncTask implements Runnable
{
    private static final Logger LOG = LoggerFactory.getLogger(PhraseAppSyncTask.class);

    // init
    private final List projectIds;
    private final List branches;
    private final PhraseLocaleAPI localeAPI;
    private final PhraseLocaleDownloadAPI localeDownloadAPI;
    private final FileService fileService;

    // data
    private List phraseProjects;

    // logging
    private final String projectIdString;
    private final String branchesString;

    //
    private Format format = DEFAULT_FILE_FORMAT;



    public PhraseAppSyncTask(final String authToken, final String projectId)
    {
        // TODO - support for more projectIds but we need to think about how we want to save the message files
        projectIds = Collections.singletonList(projectId);
        branches = Arrays.asList(DEFAULT_BRANCH);
        localeAPI = new PhraseLocaleAPI(authToken);
        localeDownloadAPI = new PhraseLocaleDownloadAPI(authToken);
        projectIdString = Joiner.on(",").join(projectIds);
        branchesString = Joiner.on(",").join(branches);
        fileService = new FileService();
        LOG.debug("Initialized PhraseAppSyncTask with following projectIds: " + projectIdString + " and branches: " + branchesString);
    }

    /*
      authToken -
      projectId -
      scheme - http or https
      host - host of api
    */
    public PhraseAppSyncTask(final String authToken, final String projectId, final String scheme, final String host)
    {
        this(authToken, projectId, Arrays.asList(DEFAULT_BRANCH), scheme, host);
    }

    public PhraseAppSyncTask(final String authToken, final String projectId, final List branches, final String scheme, final String host)
    {
        projectIds = Collections.singletonList(projectId);
        this.branches = branches;
        localeAPI = new PhraseLocaleAPI(authToken, scheme, host);
        localeDownloadAPI = new PhraseLocaleDownloadAPI(authToken, scheme, host);
        projectIdString = Joiner.on(",").join(projectIds);
        branchesString = Joiner.on(",").join(branches);
        fileService = new FileService();
        LOG.debug("Initialized PhraseAppSyncTask with following projectIds: " + projectIdString + " and branches: " + branchesString);
    }

    public PhraseAppSyncTask(final String authToken, final String projectId, PhraseLocaleAPI localeApi, PhraseLocaleDownloadAPI localeDownloadAPI, FileService fileService)
    {
        this(authToken, projectId, Arrays.asList(DEFAULT_BRANCH), localeApi, localeDownloadAPI, fileService);
    }

    public PhraseAppSyncTask(final String authToken, final String projectId, final List branches, PhraseLocaleAPI localeApi, PhraseLocaleDownloadAPI localeDownloadAPI,
        FileService fileService)
    {
        Preconditions.checkNotNull(authToken);
        Preconditions.checkNotNull(projectId);
        this.branches = branches;
        this.projectIds = Collections.singletonList(projectId);
        this.localeAPI = localeApi;
        this.localeDownloadAPI = localeDownloadAPI;
        this.projectIdString = Joiner.on(",").join(projectIds);
        branchesString = Joiner.on(",").join(branches);
        this.fileService = fileService;
        LOG.debug("Initialized PhraseAppSyncTask with following projectIds: " + projectIdString + " and branches: " + branchesString);
    }


    List getPhraseProjects()
    {
        return phraseProjects;
    }


    @Override
    public void run()
    {
        try
        {
            LOG.info("START Update Messages in messagesPath: " + fileService.getGeneratedResourcesFoldername());

            checkAndGetPhraseLocales();

            projectIds.stream()
                .forEach(projectId -> branches.stream()
                    .forEach(branch -> updateBranchLocales(projectId, branch)));

            LOG.info("FINISHED Update Messages");
        }
        catch (final PhraseAppApiException e)
        {
            LOG.error("Error due execution Phrase API ", e);
            throw new RuntimeException(e);
        }
        catch (final Exception e)
        {
            LOG.error("Error due running the PhraseAppSyncTask", e);
            throw new RuntimeException(e);
        }
    }

    private void updateBranchLocales(final String projectId, final String branch)
    {
        final List locales = getLocales(projectId, branch);

        if (locales != null)
        {
            for (final PhraseLocale locale : locales)
            {
                updateLocale(projectId, branch, locale);
            }
        }
    }


    private void updateLocale(String projectId, String branch, PhraseLocale locale)
    {
        try
        {
            byte[] translationByteArray = localeDownloadAPI.downloadLocale(projectId, branch, locale.getId(), format);
            if (translationByteArray == null || translationByteArray.length == 0)
            {
                LOG.warn("Could not receive any data from PhraseAppApi for locale: {}. Please check configuration in PhraseApp!", locale);
                translationByteArray = "no.data.received=true".getBytes();
            }
            fileService.saveToFile(projectId, branch, translationByteArray, locale.getCode().replace('-', '_'));
        }
        catch (Exception e)
        {
            LOG.error("Error updating locale {}", locale, e);
        }
    }

    private List getLocales (final String projectId, final String branch)
    {
        final Collection phraseProjects =
            Collections2.filter(getPhraseProjects(), phraseProject -> Objects.requireNonNull(phraseProject).getProjectId().equals(projectId));

        if (phraseProjects.isEmpty())
        {
            LOG.warn("No locales found for projectId: " + projectId);
            return null;
        }
        final PhraseProject phraseProject = phraseProjects.iterator().next();

        final Collection phraseBranches =
            Collections2.filter(phraseProject.getBranches(), phraseBranch -> Objects.requireNonNull(phraseBranch).getBranchName().equals(branch));

        if (phraseBranches.isEmpty())
        {
            LOG.warn("No branches found for projectId: " + projectId);
            return null;
        }

        final PhraseBranch phraseBranch = phraseBranches.iterator().next();
        return phraseBranch.getLocales();
    }


    private void checkAndGetPhraseLocales()
    {
        if (phraseProjects == null)
        {
            initLocales();
        }
    }

    private void initLocales()
    {
        LOG.debug("Start: Initialize all locales for projectIds: " + projectIdString + " and branches: " + branchesString);
        phraseProjects = localeAPI.listLocales(projectIds, branches);
        LOG.trace("Locales are successfully retreived: " + Joiner.on(",").join(phraseProjects));
        LOG.debug("End: Initialize all locales for projectIds: " + projectIdString + " and branches: " + branchesString);
    }


    public void setGeneratedResourcesFoldername(final String generatedResourcesFoldername)
    {
        fileService.setGeneratedResourcesFoldername(generatedResourcesFoldername);
    }


    public void setMessagesFoldername(final String messagesFoldername)
    {
        fileService.setMessagesFoldername(messagesFoldername);
    }


    public void setMessageFilePostfix(final String messageFilePostfix)
    {
        fileService.setMessageFilePostfix(messageFilePostfix);
    }


    public void setMessageFilePrefix(final String messageFilePrefix)
    {
        fileService.setMessageFilePrefix(messageFilePrefix);
    }


    public void setFormat(Format format)
    {
        this.format = format;
    }
}