walmart_open 0.0.8 → 0.1.0

data/README.md

@@ -6,15 +6,6 @@
 
 To use the Products API, you must register for a Walmart Open account and obtain an API key. You can also API calls from their [interacive API tool](https://developer.walmartlabs.com/io-docs).  For documentation can be found here: https://developer.walmartlabs.com/docs.
 
-## Commerce API
-
-As of right now, the Commerce API is [only available to select partners](https://developer.walmartlabs.com/forum/read/162059).  Once you've established a relationship with them, you will need the following to access the Commerce API:
-- API Key
-- API Secret
-- Generated Private/Public Key for message signing. You will need to give them your public key before proceeding.
-- A billing record id; Provided to you by Walmart when you give them your public key.
-- A [walmart.com](http://www.walmart.com) account that is connected to your Walmart Open account.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -42,16 +33,7 @@ client = WalmartOpen::Client.new do |config|
   # This value defaults to 5.
   config.product_calls_per_second = 4
 
-  ## Commerce API
-  config.commerce_api_key = "7XQLSmhqTXJHQ5xdGG7ZUh8d"
-  config.commerce_api_secret = "Mm5BX4c7QC"
-  config.commerce_private_key = File.read("/path/to/your/private/key/file")
-
-  # This value defaults to 2.
-  config.commerce_calls_per_second = 1
-
   # Set this to true for development mode.
-  # This mainly applies to the Commerce API; orders will not actually be placed.
   config.debug = true
 end
 ```
@@ -92,89 +74,6 @@ items = client.feed(:bestsellers, category_id)
 # when success: items is an array of WalmartOpen::Item items
 ```
 
-### Making Commerce API Calls
-```ruby
-# Placing an Order
-order = WalmartOpen::Order.new(billing_id: 1, partner_order_id: "38",
-                               partner_order_time: "16:15:47",
-                               first_name: "James", last_name: "Fong",
-                               street1: "200 Blossom Ln",
-                               street2: "100 Flynn Avenue",
-                               city: "Mountain View",
-                               state: "CA", zipcode: "94043", country: "USA")
-# required fields:
-# billing_id: long, first_name: string, street1: string, city: string,
-  state: string, zipcode: string, country: string, phone: string
-# optional fields:
-# last_name: string
-# partner_order_time: string in format of HH:MM:SS, default to Time.now
-# partner_order_id: string, default to "Order-#{HASH_OF_RAND_AND_ORDER_TIME}"
-
-# add_item method 1, add_item(item_id, quantity = 1, item_price = nil, shipping_price = nil )
-order.add_item(10371356)
-order.add_item(25174174)
-
-# add_item method 2, add_item(item, quantity = 1)
-order.add_item(client.lookup(10371356))
-order.add_item(client.lookup(25174174))
-
-# order.valid? == true
-
-res = client.order(order)
-#=> OrderResults
-# when order succeeds, we see res as example below
-# res.error? = true
-# res.order_id = "2677911409503"
-# res.partner_order_id = "13"
-# res.items = [ ordered_item, ...]
-# res.total =  "237.96"  # sum of ordered_item.price for all ordered_items
-# res.sales_tax = "20.82"
-# res.surcharge = "0.0"
-# res.raw_attributes = {"response"=>{"orderId"=>"2677914395453", "partnerOrderId"=>"41", "items"=>{"item"=>{"itemId"=>"10371356", "quantity"=>"1", "itemPrice"=>"22.97"}}, "total"=>"29.95", "itemTotal"=>"22.97", "shipping"=>"4.97", "salesTax"=>"2.01", "surcharge"=>"0.00"}}
-
-# Note that order_item have class OrderedItem. As an example
-# ordered_item.id = 25174174
-# ordered_item.quantity = 1
-# ordered_item.price = 214.99
-# ordered_item.raw_attributes = {"itemId"=>"25174174", "quantity"=>"1", "itemPrice"=>"214.99"}
-
-# when order fails, we see res as below
-# res.error? == true
-# res.error = {:code=>"10001", :message=>"Invalid xml"}
-# res.error[:code] = "10001"
-# res.error[:message] = "Invalid xml"
-# 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
-
 ## Contributing
 
 1. Fork it

data/lib/walmart_open/client.rb

@@ -3,15 +3,12 @@ require "walmart_open/connection_manager"
 require "walmart_open/requests/search"
 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
     attr_reader :connection
     attr_reader :config
-    attr_reader :auth_token
 
     def initialize(config_attrs = {})
       @config = Config.new(config_attrs)
@@ -37,19 +34,5 @@ module WalmartOpen
       params[:category_id] = category_id if category_id
       connection.request(Requests::Feed.new(type, params))
     end
-
-    def order(order_info)
-      authenticate!
-
-      connection.request(Requests::PlaceOrder.new(order_info))
-    end
-
-    private
-
-    def authenticate!
-      if !@auth_token || @auth_token.expired?
-        @auth_token = connection.request(Requests::Token.new)
-      end
-    end
   end
 end

data/lib/walmart_open/config.rb

@@ -6,14 +6,7 @@ module WalmartOpen
                   :product_domain,
                   :product_version,
                   :product_api_key,
-                  :product_calls_per_second,
-                  :commerce_domain,
-                  :commerce_version,
-                  :commerce_api_key,
-                  :commerce_api_secret,
-                  :commerce_private_key,
-                  :commerce_private_key_password,
-                  :commerce_calls_per_second
+                  :product_calls_per_second
 
     def initialize(options = {})
       # Default to production mode.
@@ -24,18 +17,9 @@ module WalmartOpen
       self.product_version   = "v1"
       self.product_calls_per_second = 5
 
-      # Set some defaults for Commerce API.
-      self.commerce_domain  = "api.walmartlabs.com"
-      self.commerce_version = "v1"
-      self.commerce_calls_per_second = 2
-
       options.each do |key, value|
         public_send("#{key}=", value)
       end
     end
-
-    def private_key
-      @private_key ||= OpenSSL::PKey.read(commerce_private_key, commerce_private_key_password)
-    end
   end
 end

data/lib/walmart_open/connection_manager.rb

@@ -2,7 +2,7 @@ module WalmartOpen
   class ConnectionManager
     def initialize(client)
       @client = client
-      @calls = {}
+      @calls = []
     end
 
     def request(request_obj)
@@ -14,14 +14,12 @@ module WalmartOpen
     private
 
     def throttle(request_obj)
-      type = request_type(request_obj)
-      @calls[type] ||= []
-      calls = @calls[type]
+      calls = @calls
 
       now = Time.now
       calls.delete_if { |time| now.to_f - time.to_f >= 1 }
 
-      if calls.size >= calls_per_second(type)
+      if calls.size >= calls_per_second
         sleep((calls.first + 1) - now)
       end
 
@@ -32,16 +30,8 @@ module WalmartOpen
       ret_val
     end
 
-    def request_type(request_obj)
-      case request_obj
-        when ProductRequest  then :product
-        when CommerceRequest then :commerce
-        else raise "Unknown request type"
-      end
-    end
-
-    def calls_per_second(type)
-      @client.config.public_send("#{type}_calls_per_second")
+    def calls_per_second
+      @client.config.public_send("product_calls_per_second")
     end
   end
 end

data/lib/walmart_open/errors.rb

@@ -5,12 +5,6 @@ module WalmartOpen
   class ServerError < WalmartOpenError
   end
 
-  class AuthenticationError < WalmartOpenError
-  end
-
   class ItemNotFoundError < WalmartOpenError
   end
-
-  class OrderError < WalmartOpenError
-  end
 end

data/lib/walmart_open/request.rb

@@ -4,7 +4,7 @@ require "walmart_open/errors"
 
 module WalmartOpen
   class Request
-    attr_reader :path, :params
+    attr_accessor :path, :params
 
     def submit(client)
       raise "@path must be specified" unless path
@@ -16,22 +16,29 @@ module WalmartOpen
 
     private
 
-    attr_writer :path, :params
-
     def request_method
       :get
     end
 
     def build_url(client)
-      raise NotImplementedError, "build_url must be implemented by subclass"
+      url = "https://#{client.config.product_domain}"
+      url << "/#{client.config.product_version}"
+      url << "/#{path}"
+      url << params_to_query_string(build_params(client))
     end
 
     def build_params(client)
-      # noop
+      {
+        format: "json",
+        api_key: client.config.product_api_key
+      }.merge(params || {})
     end
 
+    # Walmart API unofficially supports HTTPS so we rather hit that instead of
+    # HTTP. However, their SSL certificate is unverifiable so we have to tell
+    # HTTParty not to verify (otherwise it will complain).
     def request_options(client)
-      {}
+      { verify: false }
     end
 
     # Subclasses can override this method to return a different response.

data/lib/walmart_open/requests/feed.rb

@@ -1,8 +1,8 @@
-require "walmart_open/product_request"
+require "walmart_open/request"
 
 module WalmartOpen
   module Requests
-    class Feed < ProductRequest
+    class Feed < Request
       TYPES = [
         :preorder,
         :bestsellers,

data/lib/walmart_open/requests/lookup.rb

@@ -1,10 +1,10 @@
-require "walmart_open/product_request"
+require "walmart_open/request"
 require "walmart_open/item"
 require "walmart_open/errors"
 
 module WalmartOpen
   module Requests
-    class Lookup < ProductRequest
+    class Lookup < Request
       def initialize(item_id, params = {})
         self.path = "items/#{item_id}"
         self.params = params

data/lib/walmart_open/requests/search.rb

@@ -1,9 +1,9 @@
-require "walmart_open/product_request"
+require "walmart_open/request"
 require "walmart_open/search_results"
 
 module WalmartOpen
   module Requests
-    class Search < ProductRequest
+    class Search < Request
       def initialize(query, params = {})
         self.path = "search"
         self.params = params.merge(query: query)

data/lib/walmart_open/requests/taxonomy.rb

@@ -1,8 +1,8 @@
-require "walmart_open/product_request"
+require "walmart_open/request"
 
 module WalmartOpen
   module Requests
-    class Taxonomy < ProductRequest
+    class Taxonomy < Request
       def initialize
         self.path = "taxonomy"
       end

data/lib/walmart_open/version.rb

@@ -1,3 +1,3 @@
 module WalmartOpen
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/spec/walmart_open/client_spec.rb

@@ -4,8 +4,6 @@ require "walmart_open/config"
 require "walmart_open/requests/search"
 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
@@ -91,20 +89,4 @@ describe WalmartOpen::Client do
       client.feed(type, category_id)
     end
   end
-
-  context "#order" do
-    it "delegates the request and returns the response" do
-      client = WalmartOpen::Client.new
-      request = double
-      order_info = double
-      auth_token = double
-
-      expect(WalmartOpen::Requests::PlaceOrder).to receive(:new).and_return(request)
-      expect(WalmartOpen::Requests::Token).to receive(:new).and_return(auth_token)
-      expect(client.connection).to receive(:request).with(auth_token).and_return(auth_token)
-      expect(client.connection).to receive(:request).with(request)
-
-      client.order(order_info)
-    end
-  end
 end

data/spec/walmart_open/config_spec.rb

@@ -11,25 +11,18 @@ describe WalmartOpen::Config do
       expect(config.debug).to be(false)
       expect(config.product_domain).to eq("walmartlabs.api.mashery.com")
       expect(config.product_version).to eq("v1")
-      expect(config.commerce_domain).to eq("api.walmartlabs.com")
-      expect(config.commerce_version).to eq("v1")
       expect(config.product_calls_per_second).to be(5)
-      expect(config.commerce_calls_per_second).to be(2)
     end
 
     it "allows setting configs" do
       config = WalmartOpen::Config.new({debug: true, product_domain: "test",
-                commerce_domain: "test", product_version: "test",
-                commerce_version: "test", product_calls_per_second: 1,
-                commerce_calls_per_second: 1})
+                product_version: "test", product_calls_per_second: 1,
+              })
 
       expect(config.debug).to be(true)
       expect(config.product_domain).to eq("test")
       expect(config.product_version).to eq("test")
-      expect(config.commerce_domain).to eq("test")
-      expect(config.commerce_version).to eq("test")
       expect(config.product_calls_per_second).to be(1)
-      expect(config.commerce_calls_per_second).to be(1)
     end
   end
 end

data/spec/walmart_open/connection_manager_spec.rb

@@ -1,15 +1,14 @@
 require "spec_helper"
 require "walmart_open/connection_manager"
 require "walmart_open/client"
-require "walmart_open/product_request"
+require "walmart_open/request"
 require "timecop"
 
 describe WalmartOpen::ConnectionManager do
   context "#request" do
     let(:client) do
       WalmartOpen::Client.new(
-        product_calls_per_second: 1,
-        commerce_calls_per_second: 1
+        product_calls_per_second: 1
       )
     end
 
@@ -44,13 +43,7 @@ describe WalmartOpen::ConnectionManager do
     end
 
     context "when product request" do
-      let(:request) { WalmartOpen::ProductRequest.new }
-
-      include_examples "a request"
-    end
-
-    context "when commerce request" do
-      let(:request) { WalmartOpen::CommerceRequest.new }
+      let(:request) { WalmartOpen::Request.new }
 
       include_examples "a request"
     end

metadata

@@ -2,7 +2,7 @@
 name: walmart_open
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -148,49 +148,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/walmart_open/auth_token.rb
 - lib/walmart_open/client.rb
-- lib/walmart_open/commerce_request.rb
 - lib/walmart_open/config.rb
 - lib/walmart_open/connection_manager.rb
 - lib/walmart_open/errors.rb
 - lib/walmart_open/item.rb
-- lib/walmart_open/order.rb
-- lib/walmart_open/order_item.rb
-- lib/walmart_open/order_results.rb
-- lib/walmart_open/order_xml_builder.rb
-- 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
 - lib/walmart_open/requests/taxonomy.rb
-- lib/walmart_open/requests/token.rb
 - lib/walmart_open/search_results.rb
-- lib/walmart_open/shipping_address.rb
 - lib/walmart_open/stock_string.rb
 - lib/walmart_open/version.rb
 - lib/walmart_open.rb
 - spec/spec_helper.rb
-- spec/walmart_open/auth_token_spec.rb
 - spec/walmart_open/client_spec.rb
 - spec/walmart_open/config_spec.rb
 - spec/walmart_open/connection_manager_spec.rb
 - spec/walmart_open/item_spec.rb
-- spec/walmart_open/order_item_spec.rb
-- 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
 - spec/walmart_open/requests/taxonomy_spec.rb
-- spec/walmart_open/requests/token_spec.rb
 - spec/walmart_open/search_results_spec.rb
-- spec/walmart_open/shipping_address_spec.rb
 - spec/walmart_open/stock_string_spec.rb
 - LICENSE.txt
 - Rakefile
@@ -222,21 +204,14 @@ specification_version: 3
 summary: Ruby implementation for Walmart Open API
 test_files:
 - spec/spec_helper.rb
-- spec/walmart_open/auth_token_spec.rb
 - spec/walmart_open/client_spec.rb
 - spec/walmart_open/config_spec.rb
 - spec/walmart_open/connection_manager_spec.rb
 - spec/walmart_open/item_spec.rb
-- spec/walmart_open/order_item_spec.rb
-- 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
 - spec/walmart_open/requests/taxonomy_spec.rb
-- spec/walmart_open/requests/token_spec.rb
 - spec/walmart_open/search_results_spec.rb
-- spec/walmart_open/shipping_address_spec.rb
 - spec/walmart_open/stock_string_spec.rb