Merge pull request #4 from skumaravelayutham/master

skumaravelayutham · web-flow · commit 2754f1af342b · 2018-10-26T16:47:14.000-07:00
Fixed with correct format of marketplace header: EBAY_US instead of EBAY-US
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,14 @@ Change log for Feed SDK which helps to download and filter the item feed files.
 
 * 1.0.0.beta-RELEASE
 * [1.0.1.beta-RELEASE](#1.0.1.beta-RELEASE)
+* [1.0.2.beta-RELEASE](#1.0.2.beta-RELEASE)
+
+# 1.0.2.beta-RELEASE (2018/10/26)
+[Full Changelog](https://github.com/eBay/FeedSDK/compare/1.0.1.beta-RELEASE...1.0.2.beta-RELEASE)
+
+Enhancement Requests:
+* Updated the documentation with correct marketplace header format - [\#1](https://github.com/eBay/FeedSDK/issues/2)
+
 
 # 1.0.1.beta-RELEASE (2018/10/10)
 [Full Changelog](https://github.com/eBay/FeedSDK/compare/1.0.0.beta-RELEASE...1.0.1.beta-RELEASE)
@@ -17,3 +25,4 @@ Bug Fixes:
 Enhancement Requests:
 * Added filter support for different environments - [\#1](https://github.com/eBay/FeedSDK/issues/1)
 
+
diff --git a/README.md b/README.md
@@ -77,13 +77,13 @@ The SDK abstracts the complexity involved in calculating the request header '__r
 To download a feed file which is -
 * __bootstrap__ : (feed_scope = ALL_ACTIVE)
 * __L1 category 1__ : (category_id = 1)
-* __marketplace US__ : (X-EBAY-C-MARKETPLACE-ID: EBAY-US)
+* __marketplace US__ : (X-EBAY-C-MARKETPLACE-ID: EBAY_US)
 
 ```
 FeedRequest.FeedRequestBuilder builder = new FeedRequestBuilder();
 builder.feedScope("ALL_ACTIVE")
 	.categoryId("1")
- 	.siteId("EBAY-US")
+ 	.siteId("EBAY_US")
 	.token(<TOKEN>)
 	.type(FeedTypeEnum.ITEM);
 
@@ -248,7 +248,7 @@ usage: Feed SDK CLI
  -scope <arg>                      the feed scope. Available scopes are
                                    ALL_ACTIVE or NEWLY_LISTED
  -mkt <arg>                        the marketplace id for which feed is
-                                   being request. For example - EBAY-US
+                                   being request. For example - EBAY_US
  -token <arg>                      the oauth token for the consumer. Omit
                                    the word 'Bearer'
  -c2f <arg>                        list of l2 categories which are used to
@@ -286,12 +286,12 @@ For example, to use the command line options to download, unzip and filter feed
 
 Using token
 ```
-java -jar feed-sdk-1.0.0.beta-RELEASE-uber.jar -dt 20180701 -c1 1281 -scope ALL_ACTIVE -lf 46310 177789 -mkt EBAY-US -c3f 177792 116381 -pricelf 2 -priceuf 100 -locf US CN -token xxx
+java -jar feed-sdk-1.0.0.beta-RELEASE-uber.jar -dt 20180701 -c1 1281 -scope ALL_ACTIVE -lf 46310 177789 -mkt EBAY_US -c3f 177792 116381 -pricelf 2 -priceuf 100 -locf US CN -token xxx
 ```
 
 Using credentials file
 ```
-java -jar feed-sdk-1.0.0.beta-RELEASE-uber.jar -dt 20180801 -c1 11700 -scope ALL_ACTIVE -mkt EBAY-US -pricelf 2 -priceuf 100 -locf US CN -cl <absolute path of credentials file>
+java -jar feed-sdk-1.0.0.beta-RELEASE-uber.jar -dt 20180801 -c1 11700 -scope ALL_ACTIVE -mkt EBAY_US -pricelf 2 -priceuf 100 -locf US CN -cl <absolute path of credentials file>
 ```
 
 ### Using config file driven approach
@@ -306,7 +306,7 @@ The structure of the config file
 	"requests": [{
 		"feedRequest": {
 			"categoryId": "1",
-			"marketplaceId": "EBAY-US",
+			"marketplaceId": "EBAY_US",
 			"date": "20180708",
 			"feedScope": "ALL_ACTIVE",
 			"type": "ITEM"
diff --git a/pom.xml b/pom.xml
@@ -20,7 +20,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.ebay.api</groupId>
 	<artifactId>feed-sdk</artifactId>
-	<version>1.0.1.beta-RELEASE</version>
+	<version>1.0.2.beta-RELEASE</version>
 	<packaging>jar</packaging>
 	<name>${project.groupId}:${project.artifactId}</name>
 	<description>eBay Feed SDK helps in downloading and filtering feed files</description>
diff --git a/src/main/java/com/ebay/feed/api/FeedImpl.java b/src/main/java/com/ebay/feed/api/FeedImpl.java
@@ -316,7 +316,7 @@ private GetFeedResponse invoker(Request.Builder requestBuilder, Path path, boole
 
   /**
    * <p>
-   * Since date is optional param for getting bootstrap feed, filePath will have null value(item_bootstrap-11116-null-EBAY-US.gz)
+   * Since date is optional param for getting bootstrap feed, filePath will have null value(item_bootstrap-11116-null-EBAY_US.gz)
    * This method helps to rename the null value with LastModified api response header
    * </p>
    * @param originalFilePath
diff --git a/src/main/java/com/ebay/feed/api/Taxonomy.java b/src/main/java/com/ebay/feed/api/Taxonomy.java
@@ -23,7 +23,7 @@
  * Taxonomy interface which consists of the following capabilities
  * <ul>
  * <li>
- * <b>getCategoryTreeId</b> - Get the category tree id for the marketplace. For EBAY-US, it returns 0
+ * <b>getCategoryTreeId</b> - Get the category tree id for the marketplace. For EBAY_US, it returns 0
  * </li>
  * <li>
  * <b>loadLeafCategories</b> - Creates a map between level two categories to leaf categories,
@@ -45,7 +45,7 @@ public interface Taxonomy {
    * </p>
    * 
    * @param token OAUth token
-   * @param marketplaceId A string representing the marketplace : EBAY-US
+   * @param marketplaceId A string representing the marketplace : EBAY_US
    * @return string The category tree id for the marketplace
    */
   public String getCategoryTreeId(String token, String marketplaceId);
diff --git a/src/main/java/com/ebay/feed/api/TaxonomyImpl.java b/src/main/java/com/ebay/feed/api/TaxonomyImpl.java
@@ -37,7 +37,7 @@
  * Taxonomy implementation which consists of the following capabilities
  * <ul>
  * <li>
- * <b>getCategoryTreeId</b> - Get the category tree id for the marketplace. For EBAY-US, it returns
+ * <b>getCategoryTreeId</b> - Get the category tree id for the marketplace. For EBAY_US, it returns
  * 0</li>
  * <li>
  * <b>loadLeafCategories</b> - Creates a map between level two categories to leaf categories, and
diff --git a/src/main/java/com/ebay/feed/cli/FeedCli.java b/src/main/java/com/ebay/feed/cli/FeedCli.java
@@ -77,7 +77,7 @@ public static void main(String[] args) throws Exception {
 
     // marketplace
     options.addOption("mkt", true,
-        "the marketplace id for which feed is being request. For example - EBAY-US");
+        "the marketplace id for which feed is being request. For example - EBAY_US");
 
     // token
     options.addOption("token", true, "the oauth token for the consumer. Omit the word 'Bearer'");
diff --git a/src/main/java/com/ebay/feed/example/CombiningFilters.java b/src/main/java/com/ebay/feed/example/CombiningFilters.java
@@ -58,7 +58,7 @@ public class CombiningFilters {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180805";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
   
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterByEnv.java b/src/main/java/com/ebay/feed/example/FilterByEnv.java
@@ -43,7 +43,7 @@ public class FilterByEnv {
 
 
   // oauth token
-  static String TOKEN = Constants.TOKEN_BEARER_PREFIX + "v^1.1#i^1#^...";
+  static String TOKEN = Constants.TOKEN_BEARER_PREFIX + "v^1.1#i^1#p^1#r^0#I...";
 
   // init feed
   static Feed feed = new FeedImpl();
@@ -53,7 +53,7 @@ public class FilterByEnv {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20181005";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
   
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterByEpids.java b/src/main/java/com/ebay/feed/example/FilterByEpids.java
@@ -55,7 +55,7 @@ public class FilterByEpids {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180805";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
 
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterByGtins.java b/src/main/java/com/ebay/feed/example/FilterByGtins.java
@@ -36,7 +36,7 @@
 public class FilterByGtins {
 
   // oauth token
-  static String token = Constants.TOKEN_BEARER_PREFIX + "v^1.1#i^1#f^0#I...";
+  static String token = Constants.TOKEN_BEARER_PREFIX + "v^1.1#i^1#f^0#...";
 
   // init feed
   static Feed feed = new FeedImpl();
@@ -49,7 +49,7 @@ public static void main(String[] args) {
     // set input file
     // absolute path to the unzipped file
     filterRequest
-        .setInputFilePath("item_bootstrap-1281-20180708-EBAY-US");
+        .setInputFilePath("item_bootstrap-1281-20180708-EBAY_US");
 
     Response response = feed.filter(filterRequest);
     System.out.println("Filter status = " + response.getStatusCode());
diff --git a/src/main/java/com/ebay/feed/example/FilterByItemIds.java b/src/main/java/com/ebay/feed/example/FilterByItemIds.java
@@ -47,7 +47,7 @@ public class FilterByItemIds {
   // oauth token - Bearer xxx
   static String token =
       Constants.TOKEN_BEARER_PREFIX
-          + "v^1.1#i^1#f^0#I^...";
+          + "v^1.1#i^1#f...";
 
   // init feed
   static Feed feed = new FeedImpl();
@@ -57,7 +57,7 @@ public class FilterByItemIds {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180805";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
 
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterByItemLocation.java b/src/main/java/com/ebay/feed/example/FilterByItemLocation.java
@@ -43,7 +43,7 @@
 public class FilterByItemLocation {
 
   // oauth token - Bearer xxx
-  static String token = Constants.TOKEN_BEARER_PREFIX + "v^1.1#i^1#p^1#r^0#f^0#I^3#t^H4sIAAAAAAAAAOVYbWwURRju9QsPbFFQIKXquQg/bHZvdq93t7f2Tq+0hIv9gpaLQCrO7s62a+92153dtgcYa0kJ/hAS0YCipEQSxWhEoQawGsV/xoAa9ZeAGlOrIoGYKNE/zt4d5VoJHPSITbxccpmZd9553vd53vk4MFDuvn/ryq1/VrhmFQ8PgIFil4udA9zlZTWVJcVVZUUgx8A1PHDfQOlgyXgdhsmEIaxG2NA1jDz9yYSGhXRnmLJNTdAhVrGgwSTCgiUJ7dHmJoFjgGCYuqVLeoLyxBrClKhAPytJQOZhkIWwlvRql3x26GHKJyqiiDjEhWSe9wdFMo6xjWIatqBmhSkOsDzNAvLt4IDA+gWWY3y+wDrKE0cmVnWNmDCAiqThCum5Zg7Wq0OFGCPTIk6oSCy6or01GmtobOmo8+b4imTz0G5By8aTW8t1GXniMGGjqy+D09ZCuy1JCGPKG8msMNmpEL0E5gbgZ1It+TguWMtynJ8TEeILksoVupmE1tVxOD2qTCtpUwFplmqlrpVRkg3xcSRZ2VYLcRFr8Dg/q2yYUBUVmWGqsT66NtrWRkUwQlY37LFp3GMnoQl76bbVDbTCBTgkI8DSIq/IQRAIZhfKeMumecpKy3VNVp2kYU+LbtUjghpNzQ3IyQ0xatVazahiOYhy7bhLOeT4dQ6pGRZtq1tzeEVJkghPunltBiZmW5apiraFJjxMHUinKExBw1BlaupgWotZ+fTjMNVtWYbg9fb19TF9PkY3u7wcAKz3keamdqkbJSFFbJ1az9ir155Aq+lQJERmYlWwUgbB0k+0SgBoXVSECwV5LpTN+2RYkam9/+rIidk7uSIKVSG8ovj9tUHABURZgTwqRIVEsiL1OjiQCFM0EWgPsowElBAtEZ3ZSWSqsuDzK5yPVxAtB0IKXRtSFFr0ywGaVRACCImiFOL/T4WSr9TbJd1AbXpClVIFEXzBxO4z5TZoWqk2EyUJC/Um1GQk5yv+K8aKnVhvXpROrd9IpI4PTJxAQ2UciTOSnvTqkOxtTteGNGpPPkZe0U4xXTbCFkEhk+Ml70kq0QhDKkXOf0qmDkkA06IkahixZNK2oJhAscJsuf/RdnvF8FRyIZlRMRE2M7SqcuYmwaS5ZXCvxJgI67ZJLlFMq3Owdug9SCPblGXqiQQy4+y0iZ5h/F7nbj4JNKn1r/KOvXDXiZmkbSmhEgltmGmRTYfV/OsaWjMratbvC3GA87PctOJanua0I3Uzj8kbCW+ljq38D//ruPl6J7/DI0XpDzvoGgGDrnfIUx54wVJ2Cbi3vGRNacmtVZiclIwKFQarXRp5XpqI6UEpA6pmcblrffXBAxtyXv7DnWDRxNvfXcLOyfkjAFRfHilj5y6sYHkWsIBc7AiH68CSy6Ol7ILSO3a994ltzP/068C+LZtLvj31V/Wzi7eAigkjl6usqHTQVXTmO/fhRW8pCysH7x6Jf1C9beSH50+vXtMzNuI5c6hj64s130f7Ws/owxc6qfXBl491PbasZmB0fXR2fMz929m7dnY/M++JB2Jvtwx8jpU/4q3PbRkzXl/2YNMvJ88+WrHiQnWi6WLtS76wJu+v07fze+0n6wPuxl0n3+zqferp8dsu9guHfhw9+0p0XJ1V+mHl7k2Hzjcf2H7y2E/fHB2qPH5hz99LX/W/wSy751yykoZH4ieOz97ov3Pc+/EXh49s3HfLa71DTXUHX4jvXriqedO2xv3vD1V9dBp0ujd/dhR4/Ds7R/euvf33msU/fznWeP6hsqEFe+Y9/GsLmv/u3N4Tq04dPcdsrxrFO5oXZej7B0TNR6yTEQAA";
+  static String token = Constants.TOKEN_BEARER_PREFIX + "v^1.1#i^1#p^1#..";
 
   // init feed
   static Feed feed = new FeedImpl();
@@ -53,7 +53,7 @@ public class FilterByItemLocation {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180708";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
   
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterByLeafCategories.java b/src/main/java/com/ebay/feed/example/FilterByLeafCategories.java
@@ -53,7 +53,7 @@ public class FilterByLeafCategories {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180805";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
 
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterByLevelThreeCategory.java b/src/main/java/com/ebay/feed/example/FilterByLevelThreeCategory.java
@@ -69,7 +69,7 @@ public class FilterByLevelThreeCategory {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180708";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
 
   // init taxonomy
   static Taxonomy taxonomy = new TaxonomyImpl();
diff --git a/src/main/java/com/ebay/feed/example/FilterByPrice.java b/src/main/java/com/ebay/feed/example/FilterByPrice.java
@@ -52,7 +52,7 @@ public class FilterByPrice {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180708";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
   
   public static void main(String[] args) {
 
diff --git a/src/main/java/com/ebay/feed/example/FilterBySellerUserNames.java b/src/main/java/com/ebay/feed/example/FilterBySellerUserNames.java
@@ -57,7 +57,7 @@ public class FilterBySellerUserNames {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180708";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
 
 
   public static void main(String[] args) {
diff --git a/src/main/java/com/ebay/feed/example/UsingCredentialFile.java b/src/main/java/com/ebay/feed/example/UsingCredentialFile.java
@@ -54,7 +54,7 @@ public class UsingCredentialFile {
   // TODO : Check if the date is within 14 days, before making the call
   private static final String DATE = "20180708";
   private static final String SCOPE = "ALL_ACTIVE";
-  private static final String MKT = "EBAY-US";
+  private static final String MKT = "EBAY_US";
 
   public static void main(String[] args) throws Exception {
 
diff --git a/src/main/java/com/ebay/feed/model/feed/operation/feed/FeedRequest.java b/src/main/java/com/ebay/feed/model/feed/operation/feed/FeedRequest.java
@@ -23,7 +23,7 @@
   Request parameters for invoking feed API <br>
   <ul>
   <li><b>categoryId</b> - The level one category id of the feed file</li>
-  <li><b>marketplaceId</b> - The marketplace id for the feed file Eg EBAY-US</li>
+  <li><b>marketplaceId</b> - The marketplace id for the feed file Eg EBAY_US</li>
   <li><b>date</b> - The date parameter for the feed file. Optional for bootstrap feed files</li>
   <li><b>feedScope</b> - Scope of the feed file - ALL_ACTIVE or NEWLY_LISTED</li>
   <li><b>token</b> - OAuth token</li>
diff --git a/src/test/java/com/ebay/feed/util/FeedUtilTest.java b/src/test/java/com/ebay/feed/util/FeedUtilTest.java
@@ -56,7 +56,7 @@ public void generateRequestTest() {
     builder.feedScope("ALL_ACTIVE");
     builder.date("20180101");
     builder.token(Constants.TOKEN_BEARER_PREFIX + "v1...");
-    builder.siteId("EBAY-US");
+    builder.siteId("EBAY_US");
 
     feedUtil.generateRequest(builder.build(), requestBuilder);
 
@@ -70,26 +70,26 @@ public void generateRequestTest() {
   @Test
   public void generateFileNameTest() {
 
-    String expectedFileName = "item_daily-1-20180101-EBAY-US.gz";
+    String expectedFileName = "item_daily-1-20180101-EBAY_US.gz";
     FeedRequest.FeedRequestBuilder builder = new FeedRequestBuilder();
     builder.type(FeedTypeEnum.ITEM);
     builder.categoryId("1");
     builder.feedScope("NEWLY_LISTED");
     builder.date("20180101");
-    builder.siteId("EBAY-US");
+    builder.siteId("EBAY_US");
     Assert.assertEquals(expectedFileName, feedUtil.generateFileName(builder.build()));
   }
 
   @Test
   public void generateFileNameBootstrapTest() {
 
-    String expectedFileName = "item_bootstrap-1-20180101-EBAY-US.gz";
+    String expectedFileName = "item_bootstrap-1-20180101-EBAY_US.gz";
     FeedRequest.FeedRequestBuilder builder = new FeedRequestBuilder();
     builder.type(FeedTypeEnum.ITEM);
     builder.categoryId("1");
     builder.feedScope("ALL_ACTIVE");
     builder.date("20180101");
-    builder.siteId("EBAY-US");
+    builder.siteId("EBAY_US");
     Assert.assertEquals(expectedFileName, feedUtil.generateFileName(builder.build()));
   }
   
diff --git a/src/test/java/com/ebay/feed/validator/FeedValidatorTest.java b/src/test/java/com/ebay/feed/validator/FeedValidatorTest.java
@@ -86,7 +86,7 @@ public void isValidFilterRequestValidLevelNTest() {
     filterRequest.setLevelThreeCategories(levelThreeCats);
 
     filterRequest.setToken(Constants.TOKEN_BEARER_PREFIX + "v1...");
-    filterRequest.setMarketplace("EBAY-US");
+    filterRequest.setMarketplace("EBAY_US");
     filterRequest.setLevelOneCategory("1");
 
     Assert.assertTrue(feedValidator.isValidFilterRequest(filterRequest));
