Merge pull request #32 from Oakes6/features/get-variations

add get variations operation
goark · Feb 3, 2024 · 401b112 · 401b112
2 parents ad74daa + 52a583a
commit 401b112
Show file tree

Hide file tree

Showing 7 changed files with 298 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -121,6 +121,54 @@ func main() {
     fmt.Println(res.String())
 }
 ```
+### Operation GetVariations
+
+```go
+package main
+
+import (
+    "context"
+    "fmt"
+
+    paapi5 "github.com/goark/pa-api"
+    "github.com/goark/pa-api/entity"
+    "github.com/goark/pa-api/query"
+)
+
+func main() {
+    //Create client
+    client := paapi5.New(
+        paapi5.WithMarketplace(paapi5.LocaleJapan),
+    ).CreateClient(
+        "mytag-20",
+        "AKIAIOSFODNN7EXAMPLE",
+        "1234567890",
+    )
+
+    //Make query
+    q := query.NewGetVariations(
+        client.Marketplace(),
+        client.PartnerTag(),
+        client.PartnerType(),
+    ).ASIN("B07YCM5K55").EnableImages().EnableItemInfo().EnableParentASIN()
+
+    //Request and response
+    body, err := client.RequestContext(context.Background(), q)
+    if err != nil {
+        fmt.Printf("%+v\n", err)
+        return
+    }
+    //io.Copy(os.Stdout, bytes.NewReader(body))
+
+    //Decode JSON
+    res, err := entity.DecodeResponse(body)
+    if err != nil {
+        fmt.Printf("%+v\n", err)
+        return
+    }
+    fmt.Println(res.String())
+}
+```
 
 ### Operation SearchItems
 
@@ -153,7 +201,7 @@ func main() {
         client.PartnerType(),
     ).Search(query.Keywords, "数学ガール").EnableImages().EnableItemInfo().EnableParentASIN()
 
-    //Requet and response
+    //Request and response
     body, err := client.RequestContext(context.Background(), q)
     if err != nil {
         fmt.Printf("%+v\n", err)
@@ -202,7 +250,7 @@ func main() {
         client.PartnerType(),
     ).BrowseNodeIds([]string{"3040", "3045"}).EnableBrowseNodes()
 
-    //Requet and response
+    //Request and response
     body, err := client.RequestContext(context.Background(), q)
     if err != nil {
         fmt.Printf("%+v\n", err)

diff --git a/query/getvariations.go b/query/getvariations.go
@@ -0,0 +1,89 @@
+package query
+
+import (
+	paapi5 "github.com/goark/pa-api"
+)
+
+// GetVariations type is embedded Query for GetVariations operation in PA-API v5
+type GetVariations struct {
+	Query
+}
+
+var _ paapi5.Query = (*GetVariations)(nil) //GetVariations is compatible with paapi5.Query interface
+
+// New creates new GetVariations instance
+func NewGetVariations(marketplace, partnerTag, partnerType string) *GetVariations {
+	q := &GetVariations{*(New(paapi5.GetVariations))}
+	q.Request(Marketplace, marketplace).Request(PartnerTag, partnerTag).Request(PartnerType, partnerType)
+	return q
+}
+
+var requestsOfGetVariations = []RequestFilter{
+	ASIN,
+	Condition,
+	CurrencyOfPreference,
+	LanguagesOfPreference,
+	Marketplace,
+	Merchant,
+	OfferCount,
+	PartnerTag,
+	PartnerType,
+}
+
+// RequestFilters adds RequestFilter to Query instance
+func (q *GetVariations) Request(request RequestFilter, value interface{}) *GetVariations {
+	if request.findIn(requestsOfGetVariations) {
+		q.With().RequestFilters(RequestMap{request: value})
+	}
+	return q
+}
+
+// ASIN sets ASIN in GetVariations instance
+func (q *GetVariations) ASIN(itm string) *GetVariations {
+	return q.Request(ASIN, itm)
+}
+
+// EnableBrowseNodeInfo sets the resource of BrowseNodeInfo
+func (q *GetVariations) EnableBrowseNodeInfo() *GetVariations {
+	q.With().BrowseNodeInfo()
+	return q
+}
+
+// EnableImages sets the resource of Images
+func (q *GetVariations) EnableImages() *GetVariations {
+	q.With().Images()
+	return q
+}
+
+// EnableItemInfo sets the resource of ItemInfo
+func (q *GetVariations) EnableItemInfo() *GetVariations {
+	q.With().ItemInfo()
+	return q
+}
+
+// EnableOffers sets the resource of Offers
+func (q *GetVariations) EnableOffers() *GetVariations {
+	q.With().Offers()
+	return q
+}
+
+// EnableVariationSummary sets the resource of VariationSummary
+func (q *GetVariations) EnableVariationSummary() *GetVariations {
+	q.With().VariationSummary()
+	return q
+}
+
+/* Copyright 2019 Spiegel and contributors
+ *
+ * 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.
+ */
diff --git a/query/getvariations_test.go b/query/getvariations_test.go
@@ -0,0 +1,113 @@
+package query
+
+import (
+	"testing"
+)
+
+func TestGetVariations(t *testing.T) {
+	testCases := []struct {
+		q   *GetVariations
+		str string
+	}{
+		{q: NewGetVariations("foo.bar", "mytag-20", "Associates"), str: `{"Operation":"GetVariations","Marketplace":"foo.bar","PartnerTag":"mytag-20","PartnerType":"Associates"}`},
+		{q: NewGetVariations("foo.bar", "mytag-20", "Associates").ASIN("4900900028"), str: `{"Operation":"GetVariations","ASIN":"4900900028","Marketplace":"foo.bar","PartnerTag":"mytag-20","PartnerType":"Associates"}`},
+	}
+	for _, tc := range testCases {
+		if str := tc.q.String(); str != tc.str {
+			t.Errorf("GetVariations.String() is \"%v\", want \"%v\"", str, tc.str)
+		}
+	}
+}
+
+func TestRequestFiltersInGetVariations(t *testing.T) {
+	testCases := []struct {
+		q   *GetVariations
+		str string
+	}{
+		{q: NewGetVariations("", "", ""), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Actor, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Artist, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(ASIN, "4900900028"), str: `{"Operation":"GetVariations","ASIN":"4900900028"}`},
+		{q: NewGetVariations("", "", "").Request(Availability, "Available"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Author, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Brand, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(BrowseNodeID, "123"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Condition, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Condition, "Any"), str: `{"Operation":"GetVariations","Condition":"Any"}`},
+		{q: NewGetVariations("", "", "").Request(Condition, "New"), str: `{"Operation":"GetVariations","Condition":"New"}`},
+		{q: NewGetVariations("", "", "").Request(Condition, "Used"), str: `{"Operation":"GetVariations","Condition":"Used"}`},
+		{q: NewGetVariations("", "", "").Request(Condition, "Collectible"), str: `{"Operation":"GetVariations","Condition":"Collectible"}`},
+		{q: NewGetVariations("", "", "").Request(Condition, "Refurbished"), str: `{"Operation":"GetVariations","Condition":"Refurbished"}`},
+		{q: NewGetVariations("", "", "").Request(CurrencyOfPreference, "foo"), str: `{"Operation":"GetVariations","CurrencyOfPreference":"foo"}`},
+		{q: NewGetVariations("", "", "").Request(DeliveryFlags, "AmazonGlobal"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(ItemIds, "4900900028"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(ItemIdType, "ASIN"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(ItemCount, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(ItemPage, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(ItemPage, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Keywords, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(BrowseNodeIds, "123"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(BrowseNodeIds, []string{"123", "456"}), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(LanguagesOfPreference, "foo"), str: `{"Operation":"GetVariations","LanguagesOfPreference":["foo"]}`},
+		{q: NewGetVariations("", "", "").Request(LanguagesOfPreference, []string{"foo", "bar"}), str: `{"Operation":"GetVariations","LanguagesOfPreference":["foo","bar"]}`},
+		{q: NewGetVariations("", "", "").Request(Marketplace, "foo.bar"), str: `{"Operation":"GetVariations","Marketplace":"foo.bar"}`},
+		{q: NewGetVariations("", "", "").Request(MaxPrice, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Merchant, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Merchant, "All"), str: `{"Operation":"GetVariations","Merchant":"All"}`},
+		{q: NewGetVariations("", "", "").Request(Merchant, "Amazon"), str: `{"Operation":"GetVariations","Merchant":"Amazon"}`},
+		{q: NewGetVariations("", "", "").Request(MinPrice, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(MinReviewsRating, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(MinSavingPercent, 1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(OfferCount, -1), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(OfferCount, 0), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(OfferCount, 1), str: `{"Operation":"GetVariations","OfferCount":1}`},
+		{q: NewGetVariations("", "", "").Request(OfferCount, 123), str: `{"Operation":"GetVariations","OfferCount":123}`},
+		{q: NewGetVariations("", "", "").Request(PartnerTag, "foo"), str: `{"Operation":"GetVariations","PartnerTag":"foo"}`},
+		{q: NewGetVariations("", "", "").Request(PartnerType, "foo"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(PartnerType, "Associates"), str: `{"Operation":"GetVariations","PartnerType":"Associates"}`},
+		{q: NewGetVariations("", "", "").Request(Properties, map[string]string{"foo": "bar"}), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(SearchIndex, "All"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(SortBy, "AvgCustomerReviews"), str: `{"Operation":"GetVariations"}`},
+		{q: NewGetVariations("", "", "").Request(Title, "foo"), str: `{"Operation":"GetVariations"}`},
+	}
+
+	for _, tc := range testCases {
+		if str := tc.q.String(); str != tc.str {
+			t.Errorf("GetVariations.String() is \"%v\", want \"%v\"", str, tc.str)
+		}
+	}
+}
+
+func TestResourcesInGetVariations(t *testing.T) {
+	testCases := []struct {
+		q   *GetVariations
+		str string
+	}{
+		{q: NewGetVariations("", "", "").EnableBrowseNodeInfo(), str: `{"Operation":"GetVariations","Resources":["BrowseNodeInfo.BrowseNodes","BrowseNodeInfo.BrowseNodes.Ancestor","BrowseNodeInfo.BrowseNodes.SalesRank","BrowseNodeInfo.WebsiteSalesRank"]}`},
+		{q: NewGetVariations("", "", "").EnableImages(), str: `{"Operation":"GetVariations","Resources":["Images.Primary.Small","Images.Primary.Medium","Images.Primary.Large","Images.Variants.Small","Images.Variants.Medium","Images.Variants.Large"]}`},
+		{q: NewGetVariations("", "", "").EnableItemInfo(), str: `{"Operation":"GetVariations","Resources":["ItemInfo.ByLineInfo","ItemInfo.ContentInfo","ItemInfo.ContentRating","ItemInfo.Classifications","ItemInfo.ExternalIds","ItemInfo.Features","ItemInfo.ManufactureInfo","ItemInfo.ProductInfo","ItemInfo.TechnicalInfo","ItemInfo.Title","ItemInfo.TradeInInfo"]}`},
+		{q: NewGetVariations("", "", "").EnableOffers(), str: `{"Operation":"GetVariations","Resources":["Offers.Listings.Availability.MaxOrderQuantity","Offers.Listings.Availability.Message","Offers.Listings.Availability.MinOrderQuantity","Offers.Listings.Availability.Type","Offers.Listings.Condition","Offers.Listings.Condition.SubCondition","Offers.Listings.DeliveryInfo.IsAmazonFulfilled","Offers.Listings.DeliveryInfo.IsFreeShippingEligible","Offers.Listings.DeliveryInfo.IsPrimeEligible","Offers.Listings.DeliveryInfo.ShippingCharges","Offers.Listings.IsBuyBoxWinner","Offers.Listings.LoyaltyPoints.Points","Offers.Listings.MerchantInfo","Offers.Listings.Price","Offers.Listings.ProgramEligibility.IsPrimeExclusive","Offers.Listings.ProgramEligibility.IsPrimePantry","Offers.Listings.Promotions","Offers.Listings.SavingBasis","Offers.Summaries.HighestPrice","Offers.Summaries.LowestPrice","Offers.Summaries.OfferCount"]}`},
+		{q: NewGetVariations("", "", "").EnableVariationSummary(), str: `{"Operation":"GetVariations","Resources":["VariationSummary.Price.HighestPrice","VariationSummary.Price.LowestPrice","VariationSummary.VariationDimension"]}`},
+	}
+
+	for _, tc := range testCases {
+		if str := tc.q.String(); str != tc.str {
+			t.Errorf("Query.String() is \"%v\", want \"%v\"", str, tc.str)
+		}
+	}
+}
+
+/* Copyright 2019-2022 Spiegel and contributors
+ *
+ * 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.
+ */