walmart_open 0.0.4 → 0.0.5

data/README.md

@@ -104,6 +104,14 @@ taxonomies = client.taxonomy
 # taxonomies.categories = {"id"=>"5438", "name"=>"Apparel", "path"=>"Apparel", "children"=>[{"id"=>"5438_426265",
   "name"=>"Accessories", "path"=>"Apparel/Accessories", "children"=>[{"id"=>"5438_426265_1043621",
   "name"=>"Bandanas", "path"=>"Apparel/Accessories/Bandanas"}, ...]]}
+
+# Search special feeds (by feed type, category id)
+# Feed type can be :preorder, :bestsellers, :rollback, :clearance, :specialbuy
+# For :preorder case, you do not need to pass param category_id
+items = client.feed(:bestsellers, category_id)
+#=> Array
+# when success: example of items
+# items = [{"itemId"=>22257971 ...}, ... ]
 ```
 
 ### Making Commerce API Calls

data/lib/walmart_open/client.rb

@@ -5,6 +5,7 @@ require "walmart_open/requests/lookup"
 require "walmart_open/requests/taxonomy"
 require "walmart_open/requests/token"
 require "walmart_open/requests/place_order"
+require "walmart_open/requests/feed"
 
 module WalmartOpen
   class Client
@@ -31,6 +32,12 @@ module WalmartOpen
       connection.request(Requests::Taxonomy.new)
     end
 
+    def feed(type, category_id = nil)
+      params = {}
+      params[:category_id] = category_id if category_id
+      connection.request(Requests::Feed.new(type, params))
+    end
+
     def order(order_info)
       authenticate!
 

data/lib/walmart_open/errors.rb

@@ -2,6 +2,9 @@ module WalmartOpen
   class WalmartOpenError < ::StandardError
   end
 
+  class ServerError < WalmartOpenError
+  end
+
   class AuthenticationError < WalmartOpenError
   end
 
@@ -10,4 +13,4 @@ module WalmartOpen
 
   class OrderError < WalmartOpenError
   end
-end
+end

data/lib/walmart_open/request.rb

@@ -41,7 +41,7 @@ module WalmartOpen
 
     def verify_response(response)
       unless response.success?
-        raise WalmartOpen::AuthenticationError, response.parsed_response.inspect
+        raise WalmartOpen::ServerError, response.parsed_response.inspect
       end
     end
 

data/lib/walmart_open/requests/feed.rb

@@ -0,0 +1,35 @@
+require "walmart_open/product_request"
+
+module WalmartOpen
+  module Requests
+    class Feed < ProductRequest
+      TYPES = [
+        :preorder,
+        :bestsellers,
+        :rollback,
+        :clearance,
+        :specialbuy
+      ]
+      CATEGORY_REQUIRED_TYPES = TYPES - [:preorder]
+
+      def initialize(type, params = {})
+        unless TYPES.include?(type)
+          raise ArgumentError, "Invalid feed type #{type}"
+        end
+
+        if !params[:category_id] && CATEGORY_REQUIRED_TYPES.include?(type)
+          raise ArgumentError, "Category id param is required for the #{type} feed"
+        end
+
+        self.path = "feeds/#{type.to_s}"
+        self.params = params
+      end
+
+      private
+
+      def parse_response(response)
+        response.parsed_response["items"]
+      end
+    end
+  end
+end

data/lib/walmart_open/version.rb

@@ -1,3 +1,3 @@
 module WalmartOpen
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/walmart_open/client_spec.rb

@@ -2,7 +2,11 @@ require "spec_helper"
 require "walmart_open/client"
 require "walmart_open/config"
 require "walmart_open/requests/search"
-require "walmart_open/order"
+require "walmart_open/requests/lookup"
+require "walmart_open/requests/taxonomy"
+require "walmart_open/requests/token"
+require "walmart_open/requests/place_order"
+require "walmart_open/requests/feed"
 
 describe WalmartOpen::Client do
   context ".new" do
@@ -74,6 +78,20 @@ describe WalmartOpen::Client do
     end
   end
 
+  context "#feed" do
+    it "delegates the request and returns the response" do
+      client = WalmartOpen::Client.new
+      request = double
+      type = double
+      category_id = double
+
+      expect(WalmartOpen::Requests::Feed).to receive(:new).with(type, { category_id: category_id }).and_return(request)
+      expect(client.connection).to receive(:request).with(request)
+
+      client.feed(type, category_id)
+    end
+  end
+
   context "#order" do
     it "delegates the request and returns the response" do
       client = WalmartOpen::Client.new

data/spec/walmart_open/request_spec.rb

@@ -59,7 +59,7 @@ describe WalmartOpen::Request do
         it "raises an error" do
           expect {
             request.submit(client)
-          }.to raise_error(WalmartOpen::AuthenticationError)
+          }.to raise_error(WalmartOpen::ServerError)
         end
       end
     end

data/spec/walmart_open/requests/feed_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+require "walmart_open/requests/feed"
+require "walmart_open/client"
+require "walmart_open/errors"
+
+describe WalmartOpen::Requests::Feed do
+  let(:client) { WalmartOpen::Client.new }
+  let(:success_response) { double(success?: true) }
+  let(:fail_response) { double(success?: false) }
+  let(:feed_attrs) do
+    {
+      "items" => [{
+                    "id" => "5438",
+                    "name" => "Apparel",
+                    "path" => "Apparel",
+                  }]
+    }
+  end
+  let(:feed_type) { double(:type) }
+
+  context ".new" do
+
+    context "when feed type is valid" do
+      before do
+        allow(WalmartOpen::Requests::Feed::TYPES).to receive(:include?).with(feed_type).and_return(true)
+      end
+
+      context "when feed type requires category_id" do
+        before do
+          allow(WalmartOpen::Requests::Feed::CATEGORY_REQUIRED_TYPES).to receive(:include?).with(feed_type).and_return(true)
+        end
+
+        context "when category_id is provided" do
+          it "does not raise error" do
+            expect {
+              WalmartOpen::Requests::Feed.new(feed_type, { category_id: 1 })
+            }.not_to raise_error
+          end
+        end
+
+        context "when category_id is not provided" do
+          it "does not raise error" do
+            expect {
+              WalmartOpen::Requests::Feed.new(feed_type)
+            }.to raise_error(ArgumentError)
+          end
+        end
+      end
+
+      context "when feed type does not require category_id" do
+        before do
+          allow(WalmartOpen::Requests::Feed::CATEGORY_REQUIRED_TYPES).to receive(:include?).with(feed_type).and_return(false)
+        end
+
+        context "when category_id is provided" do
+          it "does not raise error" do
+            expect {
+              WalmartOpen::Requests::Feed.new(feed_type, { category_id: 1 })
+            }.not_to raise_error
+          end
+        end
+
+        context "when category_id is not provided" do
+          it "does not raise error" do
+            expect {
+              WalmartOpen::Requests::Feed.new(feed_type)
+            }.not_to raise_error
+          end
+        end
+      end
+    end
+
+    context "when feed type is not valid" do
+      before do
+        allow(WalmartOpen::Requests::Feed::TYPES).to receive(:include?).with(feed_type).and_return(false)
+      end
+
+      it "raises error" do
+        expect {
+          WalmartOpen::Requests::Feed.new(feed_type, { category_id: 1 })
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  context "#submit" do
+    let(:feed_request) { WalmartOpen::Requests::Feed.new(feed_type, { category_id: 1 }) }
+
+    before do
+      allow(WalmartOpen::Requests::Feed::TYPES).to receive(:include?).with(feed_type).and_return(true)
+      allow(WalmartOpen::Requests::Feed::CATEGORY_REQUIRED_TYPES).to receive(:include?).with(feed_type).and_return(true)
+    end
+
+    context "when response is success" do
+      before do
+        allow(success_response).to receive(:parsed_response).and_return(feed_attrs)
+        allow(HTTParty).to receive(:get).and_return(success_response)
+      end
+
+      it "succeeds" do
+        results = feed_request.submit(client)
+
+        expect(results).to eq(feed_attrs["items"])
+      end
+    end
+
+    context "when response is not success" do
+      before do
+        allow(HTTParty).to receive(:get).and_return(fail_response)
+        allow(fail_response).to receive(:parsed_response).and_return({
+          "errors" => [{
+            "code" => 403,
+            "message" => "Account Inactive"
+          }]
+        })
+      end
+
+      it "raises authentication error" do
+        expect {
+          feed_request.submit(client)
+        }.to raise_error(WalmartOpen::ServerError)
+      end
+    end
+  end
+end

data/spec/walmart_open/requests/lookup_spec.rb

@@ -83,7 +83,7 @@ describe WalmartOpen::Requests::Lookup do
         it "raises authentication error" do
           expect {
             lookup_req.submit(client)
-          }.to raise_error(WalmartOpen::AuthenticationError)
+          }.to raise_error(WalmartOpen::ServerError)
         end
       end
     end

data/spec/walmart_open/requests/place_order_spec.rb

@@ -143,7 +143,7 @@ describe WalmartOpen::Requests::PlaceOrder do
         it "raises authentication error" do
           expect {
             order_req.submit(client)
-          }.to raise_error(WalmartOpen::AuthenticationError)
+          }.to raise_error(WalmartOpen::ServerError)
         end
       end
     end

data/spec/walmart_open/requests/search_spec.rb

@@ -79,7 +79,7 @@ describe WalmartOpen::Requests::Search do
       it "raises authentication error" do
         expect {
           search_req.submit(client)
-        }.to raise_error(WalmartOpen::AuthenticationError)
+        }.to raise_error(WalmartOpen::ServerError)
       end
     end
   end

data/spec/walmart_open/requests/taxonomy_spec.rb

@@ -63,7 +63,7 @@ describe WalmartOpen::Requests::Taxonomy do
       it "raises authentication error" do
         expect{
           taxonomy_req.submit(client)
-        }.to raise_error(WalmartOpen::AuthenticationError)
+        }.to raise_error(WalmartOpen::ServerError)
       end
     end
   end

data/spec/walmart_open/requests/token_spec.rb

@@ -42,7 +42,7 @@ describe WalmartOpen::Requests::Token do
       it "get authentication error" do
         expect{
           token_req.submit(client)
-        }.to raise_error(WalmartOpen::AuthenticationError)
+        }.to raise_error(WalmartOpen::ServerError)
       end
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: walmart_open
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ngan Pham
@@ -10,135 +10,135 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
-  type: :runtime
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: builder
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  type: :runtime
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :development
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
-  type: :development
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: debugger
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :development
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: timecop
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
-  type: :development
+    none: false
   prerelease: false
 - !ruby/object:Gem::Dependency
   name: webmock
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.16.0
-  requirement: !ruby/object:Gem::Requirement
+        version: 1.17.0
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.16.0
-  type: :development
+        version: 1.17.0
+    none: false
   prerelease: false
 description: Ruby implementation for Walmart Open API.
 email:
@@ -162,6 +162,7 @@ files:
 - lib/walmart_open/ordered_item.rb
 - lib/walmart_open/product_request.rb
 - lib/walmart_open/request.rb
+- lib/walmart_open/requests/feed.rb
 - lib/walmart_open/requests/lookup.rb
 - lib/walmart_open/requests/place_order.rb
 - lib/walmart_open/requests/search.rb
@@ -181,6 +182,7 @@ files:
 - spec/walmart_open/order_results_spec.rb
 - spec/walmart_open/order_spec.rb
 - spec/walmart_open/request_spec.rb
+- spec/walmart_open/requests/feed_spec.rb
 - spec/walmart_open/requests/lookup_spec.rb
 - spec/walmart_open/requests/place_order_spec.rb
 - spec/walmart_open/requests/search_spec.rb
@@ -199,20 +201,26 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -1902360168796527980
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -1902360168796527980
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby implementation for Walmart Open API
@@ -227,6 +235,7 @@ test_files:
 - spec/walmart_open/order_results_spec.rb
 - spec/walmart_open/order_spec.rb
 - spec/walmart_open/request_spec.rb
+- spec/walmart_open/requests/feed_spec.rb
 - spec/walmart_open/requests/lookup_spec.rb
 - spec/walmart_open/requests/place_order_spec.rb
 - spec/walmart_open/requests/search_spec.rb