SLDSS-5181 support for retrievalType param as part of a file/get

request.

Author: jones-smartling

…dk/artifacts/smartling-api-sdk-0.7.0.zip …dk/artifacts/smartling-api-sdk-0.8.0.zipapi-sdk/artifacts/smartling-api-sdk-0.7.0.zip renamed to api-sdk/artifacts/smartling-api-sdk-0.8.0.zip api-sdk/artifacts/smartling-api-sdk-0.7.0.zip renamed to api-sdk/artifacts/smartling-api-sdk-0.8.0.zip

@@ -4,7 +4,7 @@
 
     <groupId>smartling</groupId>
     <artifactId>smartling-api-sdk</artifactId>
-    <version>0.7.0</version>
+    <version>0.8.0</version>
     <packaging>jar</packaging>
 
     <build>

api-sdk/pom.xml

@@ -47,11 +47,11 @@ public interface FileApiClientAdapter
      *
      * @param fileUri the identifier of the file
      * @param locale the locale to retrieve the translation for, or null to request the original file.
-     * @param includePendingTranslations include pending translations in the returned file contents.
+     * @param retrievalType flag indicating the type of file retrieval being requested. Can be null.
      * @return {@link StringResponse} the contents of the requested file along with the encoding of the file.
      * @throws FileApiException if an exception has occurred or non success is returned from the Smartling Translation API.
      */
-    StringResponse getFile(String fileUri, String locale, boolean includePendingTranslations) throws FileApiException;
+    StringResponse getFile(String fileUri, String locale, RetrievalType retrievalType) throws FileApiException;
 
     /**
      * Get the listing of translated files for the specified locale.

api-sdk/src/main/java/com/smartling/api/sdk/file/FileApiClientAdapter.java

@@ -27,7 +27,7 @@
 import static com.smartling.api.sdk.file.FileApiParams.TIMESTAMP_AFTER;
 import static com.smartling.api.sdk.file.FileApiParams.TIMESTAMP_BEFORE;
 import static com.smartling.api.sdk.file.FileApiParams.URI_MASK;
-import static com.smartling.api.sdk.file.FileApiParams.INCLUDE_PENDING_TRANSLATIONS;
+import static com.smartling.api.sdk.file.FileApiParams.RETRIEVAL_TYPE;
 
 import com.google.gson.Gson;
 import com.google.gson.reflect.TypeToken;
@@ -130,10 +130,10 @@ public FileApiClientAdapterImpl(String baseApiUrl, String apiKey, String project
         this.projectId = projectId;
     }
 
-    public StringResponse getFile(String fileUri, String locale, boolean includePendingTranslations) throws FileApiException
+    public StringResponse getFile(String fileUri, String locale, RetrievalType retrievalType) throws FileApiException
     {
         String params = buildParamsQuery(new BasicNameValuePair(FILE_URI, fileUri), new BasicNameValuePair(LOCALE, locale),
-                                         new BasicNameValuePair(INCLUDE_PENDING_TRANSLATIONS, Boolean.valueOf(includePendingTranslations).toString()));
+                                         new BasicNameValuePair(RETRIEVAL_TYPE, null == retrievalType ? null : retrievalType.name()));
         HttpGet getRequest = createHttpGetRequest(GET_FILE_API_URL, params);
         StringResponse response = executeHttpcall(getRequest);
 

api-sdk/src/main/java/com/smartling/api/sdk/file/FileApiClientAdapterImpl.java

@@ -33,5 +33,5 @@ public class FileApiParams
     public static final String CONDITIONS                   = "conditions";
     public static final String ORDERBY                      = "orderBy";
     public static final String FILE                         = "file";
-    public static final String INCLUDE_PENDING_TRANSLATIONS = "includePendingTranslations";
+    public static final String RETRIEVAL_TYPE               = "retrievalType";
 }

api-sdk/src/main/java/com/smartling/api/sdk/file/FileApiParams.java

@@ -0,0 +1,8 @@
+package com.smartling.api.sdk.file;
+
+public enum RetrievalType
+{
+    PUBLISHED,
+    PENDING,
+    PSEUDO;
+}

api-sdk/src/main/java/com/smartling/api/sdk/file/RetrievalType.java

@@ -65,7 +65,7 @@ protected static File retrieve(String[] args) throws FileApiException, IOExcepti
 
         File file = new File(retrieveFileParams.getPathToFile());
         FileApiClientAdapter smartlingFAPI = new FileApiClientAdapterImpl(retrieveFileParams.isProductionMode(), retrieveFileParams.getApiKey(), retrieveFileParams.getProjectId());
-        StringResponse response = smartlingFAPI.getFile(file.getName(), retrieveFileParams.getLocale(), false);
+        StringResponse response = smartlingFAPI.getFile(file.getName(), retrieveFileParams.getLocale(), null);
 
         File translatedFile = new File(getTranslatedFilePath(file, retrieveFileParams.getLocale(), retrieveFileParams.getPathToStoreFile()));
         FileUtils.writeStringToFile(translatedFile, response.getContents(), response.getEncoding());

api-sdk/src/main/java/com/smartling/api/sdk/file/commandline/RetrieveFile.java

@@ -65,7 +65,7 @@ public void testFileActions() throws FileApiException, IOException
         FileApiTestHelper.validateSuccessUpload(uploadFileResponse);
 
         // /file/get
-        StringResponse fileContents = fileApiClientAdapter.getFile(fileUri, null, false);
+        StringResponse fileContents = fileApiClientAdapter.getFile(fileUri, null, null);
         assertEquals(FileUtils.readFileToString(fileForUpload), fileContents.getContents());
 
         // /file/list

api-sdk/src/test/java/com/smartling/api/sdk/file/FileApiClientAdapterTest.java

@@ -47,7 +47,7 @@ public static void main(String args[]) throws FileApiException
         System.out.println(fileStatusResponse);
 
         // get the file back, including any translations that have been published.
-        StringResponse translatedContent = smartlingFAPI.getFile(getFileUri(file), LOCALE, false);
+        StringResponse translatedContent = smartlingFAPI.getFile(getFileUri(file), LOCALE, RetrievalType.PUBLISHED);
         System.out.println(translatedContent.getContents());
     }