taobaorb 0.9.0 → 0.9.1

data/lib/generators/taobao/config/config_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/named_base'
+
+module Taobao
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates a taobaorb configuration file at config/taobaorb.yml"
+      source_root File.dirname(__FILE__)
+      def copy_config
+        copy_file 'taobaorb.yml', 'config/taobaorb.yml'
+      end
+    end
+  end
+end

data/lib/generators/taobao/config/taobaorb.yml

@@ -0,0 +1,7 @@
+development: &default
+  public_key: put your public key here
+  private_key: and private key here
+test:
+  <<: *default
+production:
+  <<: *default

data/lib/rails/taobao-railtie.rb

@@ -0,0 +1,17 @@
+require 'rails/railtie'
+
+module Taobao
+  class Railtie < ::Rails::Railtie
+    initializer 'set API keys' do
+      begin
+        config = YAML.load_file(Rails.root.join('config', 'taobaorb.yml'))[Rails.env]
+        Taobao.public_key = config['public_key']
+        Taobao.private_key = config['private_key']
+        p Taobao.public_key
+      rescue Errno::ENOENT
+        puts 'Taobao config not found.'
+        puts 'To generate one run: rails g taobao:config'
+      end
+    end
+  end
+end

data/lib/taobao/base.rb

@@ -13,6 +13,10 @@ module Taobao
     attr_writer   :private_key
   end
 
+  # Performs API calls to Taobao
+  #
+  # @param options [Hash]
+  # @return [Hash] API request result
   def self.api_request(options)
     uri = URI(PRODUCTION_URL)
     response = Net::HTTP.post_form uri, self.append_required_options(options)

data/lib/taobao/category.rb

@@ -1,22 +1,33 @@
 class Taobao::Category
+  include Taobao::Util
   attr_reader :id
 
+  # @param category_id [Integer]
   def initialize(category_id)
     @id = category_id.to_i
   end
 
+  # @return [String]
   def name
     @name ||= category_request(cids: @id).first[:name]
   end
 
+  # @return [Array<Taobao::Category>]
   def subcategories
-    @subcategories ||= category_request(parent_cid: @id)
+    return @subcategories if @subcategories
+    @subcategories = category_request(parent_cid: @id).map do |cat|
+      category = self.class.new cat[:id]
+      category.to_object(cat)
+      category
+    end
   end
 
+  # @return [Taobao::PropertyList]
   def properties
     @properties ||= Taobao::PropertyList.new(cid: @id)
   end
 
+  # @return [Taobao::ProductList]
   def products
     @products ||= Taobao::ProductList.new(cid: @id)
   end

data/lib/taobao/property.rb

@@ -2,6 +2,7 @@ class Taobao::Property
   attr_reader :multi, :must, :name, :pid, :values
   include Taobao::Util
 
+  # @param response [Hash]
   def initialize(response)
     @response = response
     to_object response

data/lib/taobao/search.rb

@@ -1,4 +1,7 @@
 module Taobao
+  # Search products by name
+  # @param query [String]
+  # @return [Taobao::ProductList] list of found products
   def self.search(query)
     ProductList.new(q: query)
   end

data/lib/taobao/user.rb

@@ -2,58 +2,73 @@ require 'date'
 
 class Taobao::User
 
+  # Retrive user info by nickname
+  # @param nickname [String]
   def initialize(nickname)
     @nick = nickname
   end
 
+  # @return [Integer]
   def good_purchases_count
     cached_response[:buyer_credit][:good_num].to_i
   end
 
+  # @return [Integer]
   def buyer_level
     cached_response[:buyer_credit][:level].to_i
   end
 
+  # @return [Integer]
   def buyer_score
     cached_response[:buyer_credit][:score].to_i
   end
 
+  # @return [Integer]
   def total_purchases_count
     cached_response[:buyer_credit][:total_num].to_i
   end
 
+  # @return [Integer]
   def good_sales_count
     cached_response[:seller_credit][:good_num].to_i
   end
 
+  # @return [Integer]
   def seller_level
     cached_response[:seller_credit][:level].to_i
   end
 
+  # @return [Integer]
   def seller_score
     cached_response[:seller_credit][:score].to_i
   end
 
+  # @return [Integer]
   def total_sales_count
     cached_response[:seller_credit][:total_num].to_i
   end
 
+  # @return [DateTime]
   def registration_date
     DateTime.parse cached_response[:created]
   end
 
+  # @return [DateTime]
   def last_visit
     DateTime.parse cached_response[:last_visit]
   end
 
+  # @return [String]
   def city
     cached_response[:location][:city]
   end
 
+  # @return [String]
   def state
     cached_response[:location][:state]
   end
 
+  # @return [Symbol]
   def sex
     if cached_response.has_key? :sex
       return :male if cached_response[:sex] == 'm'
@@ -62,14 +77,17 @@ class Taobao::User
     :unknown
   end
 
+  # @return [String]
   def type
     cached_response[:type]
   end
 
+  # @return [String]
   def uid
     cached_response[:uid]
   end
 
+  # @return [Integer]
   def id
     cached_response[:user_id].to_i
   end

data/lib/taobao/version.rb

@@ -0,0 +1,3 @@
+module Taobao
+  VERSION = '0.9.1'
+end

data/lib/taobaorb.rb

@@ -14,3 +14,5 @@ require 'taobao/user'
 require 'taobao/abstract_list'
 require 'taobao/product_list'
 require 'taobao/property_list'
+
+require 'rails/taobao-railtie' if defined?(Rails)

data/spec/rspec/category_spec.rb

@@ -2,23 +2,25 @@
 require 'spec_helper'
 
 describe Taobao::Category do
-
-  it 'should have name' do
-    category = Taobao::Category.new(28)
-    category.id.should  == 28
-
-    fixture = 'category.json'.json_fixture
-    args = {
-      method: 'taobao.itemcats.get',
-      fields: 'cid,parent_cid,name,is_parent',
-      cids: 28
-    }
-    Taobao.stub(:api_request).with(args).and_return(fixture)
-    category.name.should == 'ZIPPO/瑞士军刀/眼镜'
+  describe '#id' do
+    it 'should returns ID of the category' do
+      category = Taobao::Category.new(28)
+      category.id.should  == 28
+    end
   end
-
-  describe 'with incorrect id' do
-    it 'should throws an exception' do
+  describe '#name' do
+    it 'should returns the name of the category' do
+      category = Taobao::Category.new(28)
+      fixture = 'category.json'.json_fixture
+      args = {
+        method: 'taobao.itemcats.get',
+        fields: 'cid,parent_cid,name,is_parent',
+        cids: 28
+      }
+      Taobao.stub(:api_request).with(args).and_return(fixture)
+      category.name.should == 'ZIPPO/瑞士军刀/眼镜'
+    end
+    it 'should throws an exception if the category ID is incorrect' do
       fixture = 'incorrect_category.json'.json_fixture
       args = {
         method: 'taobao.itemcats.get',
@@ -33,30 +35,33 @@ describe Taobao::Category do
     end
   end
 
-  describe 'subcategories' do
-    it 'top level category should contains a few subcategories' do
-      category = Taobao::Category.new(28)
-
-      fixture = 'subcategories.json'.json_fixture
-      args = {
-        method: 'taobao.itemcats.get',
-        fields: 'cid,parent_cid,name,is_parent',
-        parent_cid: 28
-      }
+  describe '#subcategories' do
+    category = Taobao::Category.new(28)
+    fixture = 'subcategories.json'.json_fixture
+    args = {
+      method: 'taobao.itemcats.get',
+      fields: 'cid,parent_cid,name,is_parent',
+      parent_cid: 28
+    }
+    it 'should returns subcategories if they are exists' do
       Taobao.stub(:api_request).with(args).and_return(fixture)
       category.subcategories.should have_at_least(1).subcategory
     end
+    it 'each subcategory should be an object of Taobao::Category class' do
+      Taobao.stub(:api_request).with(args).and_return(fixture)
+      category.subcategories[0].should be_a_kind_of(Taobao::Category)
+    end
   end
 
-  describe 'properties' do
-    it 'should return empty array for top level category' do
+  describe '#properties' do
+    it 'should return a PropertyList object' do
       category = Taobao::Category.new(0)
-     category.properties.should be_a_kind_of(Taobao::PropertyList)
+      category.properties.should be_a_kind_of(Taobao::PropertyList)
     end
   end
 
-  describe 'products' do
-    it 'should return ProductList object' do
+  describe '#products' do
+    it 'should return a ProductList object' do
       category = Taobao::Category.new(28)
       category.products.should be_a_kind_of(Taobao::ProductList)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taobaorb
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-08-25 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for the Taobao API
 email: a741su@gmail.com
@@ -17,6 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/taobao/config/config_generator.rb
+- lib/generators/taobao/config/taobaorb.yml
+- lib/rails/taobao-railtie.rb
 - lib/taobao/abstract_list.rb
 - lib/taobao/base.rb
 - lib/taobao/category.rb
@@ -30,6 +33,7 @@ files:
 - lib/taobao/search.rb
 - lib/taobao/user.rb
 - lib/taobao/util.rb
+- lib/taobao/version.rb
 - lib/taobaorb.rb
 - spec/fixtures/absent_user.json
 - spec/fixtures/category.json
@@ -69,12 +73,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1557645060868365656
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1557645060868365656
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -82,3 +92,4 @@ signing_key:
 specification_version: 3
 summary: Ruby wrapper for the Taobao API
 test_files: []
+has_rdoc: