taobaorb 0.8.2 → 0.8.3

data/lib/taobao/base.rb

@@ -14,18 +14,12 @@ module Taobao
   end
   
   def self.api_request(options)
-    options[:app_key]    = @public_key
-    options[:format]     = :json
-    options[:v]          = API_VERSION
-    options[:timestamp]  = Date.new.strftime('%Y-%m-%d %H:%M:%S')
-    options[:sign_method] = :md5
-    options[:sign] = self.create_signature(options)
-    
     uri = URI(PRODUCTION_URL)
-    response = Net::HTTP.post_form(uri, options)
-    JSON.parse response.body, {symbolize_names: true}
+    response = Net::HTTP.post_form uri, self.append_required_options(options)
+    parse_to_hash response
   end
   
+  private
   def self.create_signature(options)
     values_str = options.sort.inject('') do |str, item|
       str + item.first.to_s + item.last.to_s
@@ -34,4 +28,21 @@ module Taobao
     Digest::MD5.hexdigest(str).upcase
   end
   
+  def self.append_required_options(options)
+    options.merge!({
+      app_key:     @public_key,
+      format:      :json,
+      v:           API_VERSION,
+      timestamp:   Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+      sign_method: :md5
+    })
+    options[:sign] = self.create_signature(options)
+    options
+  end
+  
+  def self.parse_to_hash(response)
+    result = JSON.parse response.body, {symbolize_names: true}
+    raise Taobao::ApiError.new(result) if result.key? :error_response
+    result
+  end
 end

data/lib/taobao/category.rb

@@ -39,7 +39,7 @@ class Taobao::Category
     begin
       result[:itemcats_get_response][:item_cats][:item_cat]
     rescue NoMethodError
-      raise Taobao::ApiError, 'Incorrect category ID'
+      raise Taobao::IncorrectCategoryId, 'Incorrect category ID'
     end
   end
   

data/lib/taobao/exceptions/api_error.rb

@@ -0,0 +1,9 @@
+class Taobao::ApiError < StandardError
+  def initialize(response)
+    @msg = response[:error_response][:msg]
+  end
+  
+  def to_s
+    @msg
+  end
+end

data/lib/taobao/exceptions/incorrect_category_id.rb

@@ -0,0 +1,2 @@
+class Taobao::IncorrectCategoryId < StandardError
+end

data/lib/taobao/product.rb

@@ -9,42 +9,44 @@ class Taobao::Product
     :approve_status, :postage_id, :product_id, :auction_point,
     :property_alias, :item_img, :prop_img, :sku, :video, :outer_id,
     :is_virtual]
-  
+
   attr_reader *BASIC_PROPERTIES
   alias :id :num_iid
-  
+
   def initialize(product_properties)
     @all_properties_fetched = false
-    
+    @properties = []
+
     if Hash === product_properties
       hash_to_object(product_properties)
     else
-      @id = product_properties.to_s
+      @num_iid = product_properties.to_s
       fetch_full_data
     end
   end
-  
+
   def method_missing(method_name, *args, &block)
-      unless OTHER_PROPERTIES.include? method_name
-        super
-      else
-        fetch_full_data unless @all_properties_fetched
-        self.instance_variable_get "@#{method_name}"
-      end
+    unless @properties.include? method_name
+      super
+    else
+      fetch_full_data unless @all_properties_fetched
+      self.instance_variable_get "@#{method_name}"
+    end
   end
-  
+
   private
   def hash_to_object(hash)
     hash.each do |k, v|
       self.instance_variable_set "@#{k}", v
+      @properties.push k unless @properties.include? k
     end
   end
-  
+
   def fetch_full_data
     fields = (BASIC_PROPERTIES + OTHER_PROPERTIES).join ','
-    params = {method: 'taobao.item.get', fields: fields, num_iid: @id}
+    params = {method: 'taobao.item.get', fields: fields, num_iid: id}
     result = Taobao.api_request(params)
     hash_to_object(result[:item_get_response][:item])
     @all_properties_fetched = true
   end
-end
+end

data/lib/taobao/product_list.rb

@@ -11,7 +11,7 @@ class Taobao::ProductList
   end
   
   def total_count
-    products unless @total_count
+    memoize_api_result
     @total_count
   end
   
@@ -34,8 +34,7 @@ class Taobao::ProductList
   end
   
   def method_missing(method_name, *args, &block)
-    m = /^order_by_(?<field>.+)$/.match(method_name)
-    if m
+    if (m = /^order_by_(?<field>.+)$/.match method_name)
       order_by m[:field]
     else
       super
@@ -48,21 +47,40 @@ class Taobao::ProductList
   
   private
   def products
-    return @products if @products
-    fields = [:num_iid, :title, :nick, :pic_url, :cid, :price, :type,
-      :delist_time, :post_fee, :score, :volume].join ','
-    params = {method: 'taobao.items.get', fields: fields}
-    result = Taobao.api_request(params.merge(@opts))
+    memoize_api_result
+    @products
+  end
+  
+  def memoize_api_result
+    return if @products
+    response = items_get_request
+    @total_count = retrieve_total_count(response)
+    @products = retrieve_products(response)
+  end
+  
+  def retrieve_total_count(response)
+    response[:items_get_response][:total_results].to_i
+  end
+  
+  def retrieve_products(response)
     begin
-      @total_count = result[:items_get_response][:total_results]
-      @products = []
-      result[:items_get_response][:items][:item].each do |product|
-        @products << Taobao::Product.new(product)
-      end
+      products = response[:items_get_response][:items][:item]
+      get_products_as_objects(products)
     rescue NoMethodError
-      @total_count = 0
-      @products = []
+      []
+    end
+  end
+  
+  def get_products_as_objects(products)
+    products.map do |product|
+      Taobao::Product.new(product)
     end
   end
   
+  def items_get_request
+    fields = [:num_iid, :title, :nick, :pic_url, :cid, :price, :type,
+      :delist_time, :post_fee, :score, :volume].join ','
+    params = {method: 'taobao.items.get', fields: fields}
+    Taobao.api_request(params.merge(@opts))
+  end
 end

data/lib/taobaorb.rb

@@ -1,5 +1,6 @@
 require 'taobao/base'
-require 'taobao/exceptions'
+require 'taobao/exceptions/api_error'
+require 'taobao/exceptions/incorrect_category_id'
 require 'taobao/category'
 require 'taobao/product'
 require 'taobao/product_list'

data/spec/fixtures/error.json

@@ -0,0 +1 @@
+{"error_response":{"code":41,"msg":"Invalid arguments:cid"}}

data/spec/fixtures/product_wo_property_alias.json

@@ -0,0 +1 @@
+{"item_get_response":{"item":{"approve_status":"onsale","auction_point":5,"cid":50003678,"delist_time":"2012-06-06 03:29:16","desc":"<p><a href=\"http:\/\/item.taobao.com\/meal_detail.htm?meal_id=7728185\" target=\"_blank\"><img alt=\"\" src=\"http:\/\/img02.taobaocdn.com\/imgextra\/i2\/721217425\/T2_TXmXa8NXXXXXXXX_!!721217425.jpg\"><\/a><\/p><p style=\"text-align: left;\"><span style=\"line-height: 36.0px;font-size: 24.0px;\"><a href=\"http:\/\/tuancums.dian.taobao.com\/\" target=\"_blank\"><\/a><\/span><\/p><p style=\"text-align: left;\"><span style=\"font-size: 24.0px;\"><\/span><\/p><table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"750\" height=\"340\"><tr><td><span style=\"font-size: 24.0px;\"><a href=\"http:\/\/detail.tmall.com\/item.htm?id=15788895590\" target=\"_blank\"><img border=\"0\" alt=\"\" src=\"http:\/\/img03.taobaocdn.com\/imgextra\/i3\/721217425\/T20eNLXohcXXXXXXXX_!!721217425.jpg\" width=\"245\" height=\"340\"><\/a><\/span><\/td><td><span style=\"font-size: 24.0px;\"><a href=\"http:\/\/detail.tmall.com\/item.htm?id=15536427295\" target=\"_blank\"><img border=\"0\" alt=\"\" src=\"http:\/\/img01.taobaocdn.com\/imgextra\/i1\/721217425\/T2VDlFXXxNXXXXXXXX_!!721217425.jpg\" width=\"253\" height=\"340\"><\/a><\/span><\/td><td><span style=\"font-size: 24.0px;\"><a href=\"http:\/\/detail.tmall.com\/item.htm?id=12827936202\" target=\"_blank\"><img border=\"0\" alt=\"\" src=\"http:\/\/img04.taobaocdn.com\/imgextra\/i4\/721217425\/T2ZS4FXXhNXXXXXXXX_!!721217425.jpg\" width=\"252\" height=\"340\"><\/a><\/span><\/td><\/tr><\/table><p>&nbsp;<\/p><p style=\"text-align: center;\"><span style=\"font-size: 24.0px;\">回馈顾客，<span style=\"color: #ff0000;\">买3送同款1支<\/span>，多买多送！限1000套哦<\/span><\/p><p style=\"text-align: center;\"><span style=\"font-size: 24.0px;\"><a title=\"\" href=\"http:\/\/detail.tmall.com\/item.htm?id=10970032560\" target=\"_blank\"><\/a><\/span><\/p><p style=\"text-align: center;\"><span style=\"font-size: 24.0px;\"><span style=\"color: #ff0000;\">五色随机发货<\/span><\/span><\/p><p style=\"text-align: center;\"><span style=\"font-size: 24.0px;\"><span style=\"color: #ff0000;\"><span style=\"line-height: 36.0px;font-size: 24.0px;\"><a href=\"http:\/\/yingyong.taobao.com\/show.htm?app_id=209002&source=vip\" target=\"_blank\"><\/a><a href=\"http:\/\/tuancums.dian.taobao.com\/\" target=\"_blank\"><\/a><span style=\"color: #000000;\">注：新疆、西藏、内蒙古、甘肃、宁夏、青海(2套以上包邮) 不包邮如需要购买请联系客服补差价不补不发货哦。<a target=\"_self\"><\/a><a target=\"_blank\"><\/a><a target=\"_blank\"><\/a><\/span><\/span><\/span><\/span><\/p><table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"750\" height=\"560\"><tr><td><span style=\"font-size: 24.0px;\"><span><a href=\"http:\/\/item.taobao.com\/meal_detail.htm?meal_id=7702622\" target=\"_blank\"><img border=\"0\" alt=\"\" src=\"http:\/\/img02.taobaocdn.com\/imgextra\/i2\/721217425\/T2_AFmXa8NXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"169\"><\/a><\/span><\/span><\/td><\/tr><tr><td><span style=\"font-size: 24.0px;\"><span><a href=\"http:\/\/item.taobao.com\/meal_detail.htm?meal_id=7702625\" target=\"_blank\"><img border=\"0\" alt=\"\" src=\"http:\/\/img01.taobaocdn.com\/imgextra\/i1\/721217425\/T2zUFsXm0MXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"120\"><\/a><\/span><\/span><\/td><\/tr><tr><td><span style=\"font-size: 24.0px;\"><span><a href=\"http:\/\/detail.taobao.com\/meal_detail.htm?meal_id=7757745\" target=\"_blank\"><img style=\"margin: 0.0px;width: 750.0px;float: none;height: 113.0px;\" alt=\"\" src=\"http:\/\/img03.taobaocdn.com\/imgextra\/i3\/721217425\/T2tlFvXldMXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"113\"><\/a><\/span><\/span><\/td><\/tr><tr><td><span style=\"font-size: 24.0px;\"><span><a href=\"http:\/\/item.taobao.com\/meal_detail.htm?meal_id=7717656\" target=\"_blank\"><img style=\"margin: 0.0px;width: 750.0px;float: none;height: 158.0px;\" border=\"0\" alt=\"\" src=\"http:\/\/img03.taobaocdn.com\/imgextra\/i3\/721217425\/T2tbJqXbFNXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"158\"><\/a><\/span><\/span><\/td><\/tr><\/table><table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"750\"><tr><td><img alt=\"\" src=\"http:\/\/img03.taobaocdn.com\/imgextra\/i3\/721217425\/T2ksKuXkhaXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"1015\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img03.taobaocdn.com\/imgextra\/i3\/721217425\/T2SsSuXgFaXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"1157\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img04.taobaocdn.com\/imgextra\/i4\/721217425\/T2XZ1uXeBaXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"1495\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img02.taobaocdn.com\/imgextra\/i2\/721217425\/T2Ec5uXcFaXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"1054\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img04.taobaocdn.com\/imgextra\/i4\/721217425\/T2QcSuXgRaXXXXXXXX_!!721217425.gif\" width=\"750\" height=\"182\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img04.taobaocdn.com\/imgextra\/i4\/721217425\/T2f0auXataXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"900\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img04.taobaocdn.com\/imgextra\/i4\/721217425\/T27JauXXpaXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"630\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img03.taobaocdn.com\/imgextra\/i3\/721217425\/T2otiuXnFXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"673\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img02.taobaocdn.com\/imgextra\/i2\/721217425\/T2gtmuXmpXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"694\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img01.taobaocdn.com\/imgextra\/i1\/721217425\/T2mdquXkNXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"706\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img02.taobaocdn.com\/imgextra\/i2\/721217425\/T2c0uuXjBXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"598\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img01.taobaocdn.com\/imgextra\/i1\/721217425\/T2qtyuXhNXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"1014\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img01.taobaocdn.com\/imgextra\/i1\/721217425\/T2NdCuXfNXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"1027\"><\/td><\/tr><tr><td><img alt=\"\" src=\"http:\/\/img01.taobaocdn.com\/imgextra\/i1\/721217425\/T2bdGuXfdXXXXXXXXX_!!721217425.jpg\" width=\"750\" height=\"736\"><\/td><\/tr><\/table><p>&nbsp;<\/p>","detail_url":"http:\/\/item.taobao.com\/item.htm?id=14468433043&spm=2014.12129701.0.0","ems_fee":"0.00","express_fee":"0.00","freight_payer":"seller","has_discount":true,"has_invoice":true,"has_showcase":true,"has_warranty":false,"input_pids":"20000","input_str":"Zobo\/正牌","is_virtual":false,"item_imgs":{"item_img":[{"id":0,"position":0,"url":"http:\/\/img01.taobaocdn.com\/bao\/uploaded\/i1\/T1l62cXd8jXXX54OQU_015232.jpg"},{"id":3530250392,"position":1,"url":"http:\/\/img02.taobaocdn.com\/bao\/uploaded\/i2\/T1SbeyXm4WXXb1IA7Z_033254.jpg"},{"id":3530250393,"position":2,"url":"http:\/\/img02.taobaocdn.com\/bao\/uploaded\/i2\/721217425\/T2mFhEXbVNXXXXXXXX_!!721217425.jpg"},{"id":3530250394,"position":3,"url":"http:\/\/img03.taobaocdn.com\/bao\/uploaded\/i3\/T10.9MXlFuXXb6MMna_090902.jpg"},{"id":5039400011,"position":4,"url":"http:\/\/img03.taobaocdn.com\/bao\/uploaded\/i3\/721217425\/T2eNNTXlFcXXXXXXXX_!!721217425.jpg"}]},"list_time":"2012-05-30 03:29:16","location":{"city":"杭州","state":"浙江"},"modified":"2012-06-06 00:35:53","nick":"zobo正牌旗舰店","num":90178,"num_iid":14468433043,"outer_id":"ZB-053","pic_url":"http:\/\/img01.taobaocdn.com\/bao\/uploaded\/i1\/T1l62cXd8jXXX54OQU_015232.jpg","post_fee":"0.00","postage_id":0,"price":"33.00","property_alias":"","props":"21441:41654;20000:3301703;21440:41650","seller_cids":",488348906,371772612,478675766,","stuff_status":"new","title":"ZOBO正牌 烟嘴 过滤烟嘴 正品 双重循环型烟嘴 可清洗 过滤嘴包邮","type":"fixed","valid_thru":7}}}

data/spec/rspec/category_spec.rb

@@ -29,7 +29,7 @@ describe Taobao::Category do
       Taobao.stub(:api_request).with(args).and_return(fixture)
       category = Taobao::Category.new(-20)
       lambda {category.name}
-        .should raise_error Taobao::ApiError, 'Incorrect category ID'
+        .should raise_error Taobao::IncorrectCategoryId, 'Incorrect category ID'
     end
   end
 

data/spec/rspec/taobao_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
+Response = Struct.new('Responce', :body)
+
 describe Taobao do
   describe 'set the public API key' do
     it 'should have rw access' do
@@ -13,14 +15,21 @@ describe Taobao do
       Taobao.method_defined?(:private_key).should == false
     end
   end
-  describe 'api_request' do
+  describe 'API request' do
     it 'should always return a Hash object' do
-      Response = Struct.new('Responce', :body)
-      fixture = Response.new(open('./spec/fixtures/category.json').read)
+      fixture = Response.new('category.json'.str_fixture)
       Net::HTTP.stub(:post_form).and_return(fixture)
       result = Taobao.api_request(method: 'taobao.itemcats.get',
         fields: 'cid,parent_cid,name,is_parent', cids: 0)
       result.class.should == Hash
     end
   end
+  describe 'failed API request' do
+    it 'should throws an exception' do
+      fixture = Response.new('error.json'.str_fixture)
+      Net::HTTP.stub(:post_form).and_return(fixture)
+      lambda { Taobao.api_request({}) }
+        .should raise_error Taobao::ApiError, 'Invalid arguments:cid'
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,10 @@ end
 require 'taobaorb'
 
 class String
+  def str_fixture
+    open("spec/fixtures/#{self}").read
+  end
+  
   def json_fixture
     contents = open("spec/fixtures/#{self}").read
     JSON.parse contents, {symbolize_names: true}

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: taobaorb
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
 - m16a1
+- yesmeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000 Z
+date: 2012-07-15 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for the Taobao API
 email: a741su@gmail.com
@@ -19,18 +20,21 @@ extra_rdoc_files: []
 files:
 - lib/taobao/base.rb
 - lib/taobao/category.rb
-- lib/taobao/exceptions.rb
+- lib/taobao/exceptions/api_error.rb
+- lib/taobao/exceptions/incorrect_category_id.rb
 - lib/taobao/product.rb
 - lib/taobao/product_list.rb
 - lib/taobao/search.rb
 - lib/taobaorb.rb
 - spec/fixtures/category.json
 - spec/fixtures/category_properties.json
+- spec/fixtures/error.json
 - spec/fixtures/incorrect_category.json
 - spec/fixtures/items.json
 - spec/fixtures/items_page15.json
 - spec/fixtures/no_items.json
 - spec/fixtures/product.json
+- spec/fixtures/product_wo_property_alias.json
 - spec/fixtures/search.json
 - spec/fixtures/subcategories.json
 - spec/fixtures/top_category_properties.json
@@ -60,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Taobao API

data/lib/taobao/exceptions.rb

@@ -1,2 +0,0 @@
-class Taobao::ApiError < StandardError
-end