walmart_open 0.0.6 → 0.0.7

data/README.md

@@ -70,32 +70,11 @@ res = client.search("ipod")
 
 # Lookup (by item id)
 item = client.lookup(15076191)
-#=> item is of class WalmartOpen::Item
-# when success: example of item
-# item.error? == false
-# item.id = "15076191"
-# item.name = "Apple iPod Touch 4th Generation 32GB with Bonus Accessory Kit"
-# item.price = "189.0"
-# item.upc = nil
-# item.category_node = "3944_96469_164001"
-# item.short_description = "The world's most popular portable gaming device ... "
-# item.long_description = "<br><b>Apple iPod touch 32GB (4th Gen) ..."
-# item.brand = nil
-# item.shipping_rate = 0.0
-# item.size = nil
-# item.color = "Black"
-# item.model_number = ?
-# item.url =  "http://www.walmart.com/ip/Apple-iPod-Touch-8GB-32GB-and-64GB-newest-model/15076191"
-# item.raw_attributes = {"itemId" => 15076191, .....}
-# item.large_image = "http://i.walmartimages.com/i/p/00/80/14/18/71/0080141871195_Color_Burgundy_SW_500X500.jpg"
-# item.thumbnail_image = "http://i.walmartimages.com/i/p/00/80/14/18/71/0080141871195_Color_Burgundy_SW_100X100.jpg"
-# item.medium_image = "http://i.walmartimages.com/i/p/00/80/14/18/71/0080141871195_Color_Burgundy_SW_180X180.jpg"
-
-# when fail: example of item
-# item.error? == true
-# item.error[:code] = 4002
-# item.error[:message] = "Invalid itemId"
-# item.raw_attributes = {"errors"=>[{"code"=>4002, "message"=>"Invalid itemId"}]}
+#=> item is of class WalmartOpen::Item, see WalmartOpen::Item section for detail
+# When item not found, an error of class WalmartOpen::ItemNotFoundError is thrown,
+  eg: {"errors"=>[{"code"=>4002, "message"=>"Invalid itemId"}]}
+  When walmart api is down, an error of class WalmartOpen::ServerError is thrown,
+  eg: {"errors"=>[{"code"=>504, "message"=>"Gateway Timeout"}]}
 
 # Taxonomy
 taxonomies = client.taxonomy
@@ -110,8 +89,7 @@ taxonomies = client.taxonomy
 # For :preorder case, you do not need to pass param category_id
 items = client.feed(:bestsellers, category_id)
 #=> Array
-# when success: example of WalmartOpen::Item items
-# items = [item, ... ]
+# when success: items is an array of WalmartOpen::Item items
 ```
 
 ### Making Commerce API Calls
@@ -168,6 +146,31 @@ res = client.order(order)
 # res.raw_attributes = {"errors"=>{"error"=>{"code"=>"10001", "message"=>"Invalid xml"}}}
 ```
 
+# WalmartOpen::Item
+# example of a WalmartOpen::Item item
+# item.id = "15076191"
+# item.name = "Apple iPod Touch 4th Generation 32GB with Bonus Accessory Kit"
+# item.price = "189.0"
+# item.upc = nil
+# item.category_node = "3944_96469_164001"
+# item.short_description = "The world's most popular portable gaming device ... "
+# item.long_description = "<br><b>Apple iPod touch 32GB (4th Gen) ..."
+# item.brand = nil
+# item.shipping_rate = 0.0
+# item.size = nil
+# item.color = "Black"
+# item.model_number = ?
+# item.url =  "http://www.walmart.com/ip/Apple-iPod-Touch-8GB-32GB-and-64GB-newest-model/15076191"
+# item.raw_attributes = {"itemId" => 15076191, .....}
+# item.large_image = "http://i.walmartimages.com/i/p/00/80/14/18/71/0080141871195_Color_Burgundy_SW_500X500.jpg"
+# item.thumbnail_image = "http://i.walmartimages.com/i/p/00/80/14/18/71/0080141871195_Color_Burgundy_SW_100X100.jpg"
+# item.medium_image = "http://i.walmartimages.com/i/p/00/80/14/18/71/0080141871195_Color_Burgundy_SW_180X180.jpg"
+
+# item.variants returns an array of product ids when a walmart product has
+  variants that user can choose, eg a different color or style. An example:
+# items.variants = [15076191, 15076192]
+# An empty array is returned when a product has no variants.
+
 ### Authentication failure
 In the case of authentication failure during an API call, a
 WalmartOpen::AuthenticationError exception will be raised

data/lib/walmart_open/item.rb

@@ -31,6 +31,10 @@ module WalmartOpen
       extract_known_attributes
     end
 
+    def variants
+      raw_attributes["variants"].to_a
+    end
+
     private
 
     def extract_known_attributes

data/lib/walmart_open/version.rb

@@ -1,3 +1,3 @@
 module WalmartOpen
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/walmart_open/item_spec.rb

@@ -36,7 +36,8 @@ describe WalmartOpen::Item do
       "clearance"               =>  false,
       "preOrder"                =>  false,
       "stock"                   =>  "Available",
-      "availableOnline"         =>  true
+      "availableOnline"         =>  true,
+      "variants"                =>  [10371356, 10371357]
     }
   end
 
@@ -49,4 +50,23 @@ describe WalmartOpen::Item do
       expect(item.raw_attributes).to eq(item_attrs)
     end
   end
+
+  context "#variants" do
+    context "when item has variants" do
+      it "returns a array with variants" do
+        item = WalmartOpen::Item.new(item_attrs)
+
+        expect(item.variants).to eq([10371356, 10371357])
+      end
+    end
+
+    context "when item has no variants" do
+      it "returns an empty array" do
+        item_attrs.delete("variants")
+        item = WalmartOpen::Item.new(item_attrs)
+
+        expect(item.variants).to eq([])
+      end
+    end
+  end
 end

data/spec/walmart_open/requests/lookup_spec.rb

@@ -41,7 +41,8 @@ describe WalmartOpen::Requests::Lookup do
           "clearance"               =>  false,
           "preOrder"                =>  false,
           "stock"                   =>  "Available",
-          "availableOnline"         =>  true
+          "availableOnline"         =>  true,
+          "variants"                =>  [10371356, 10371357]
       }
     end
 

metadata

@@ -2,7 +2,7 @@
 name: walmart_open
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ngan Pham
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty