open_taobao 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in open_taobao.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ryan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# OpenTaobao
+
+Taobao Open Platform client for ruby. Rails3 is supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open_taobao'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_taobao
+
+Run generate to complete install:
+
+    $ rails g open_taobao:install
+
+this will create taobao.yml in your config/ directory.
+打开taobao.yml文件，设置你自己的`app_key`, `secret_key`, 淘宝客的`pid`
+
+## Usage
+
+调用`OpenTaobao.get`方法，传入相应参数：
+
+    hash = OpenTaobao.get(
+      :method => "taobao.itemcats.get",
+      :fields => "cid,parent_id,name,is_parent",
+      :parent_cid => 0
+    )
+
+返回内容将自动转化微hash格式。
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/generators/open_taobao/install_generator.rb

@@ -0,0 +1,11 @@
+module OpenTaobao
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def copy_yml_file
+        copy_file 'taobao.yml', "config/taobao.yml"
+      end
+    end
+  end
+end

data/lib/generators/templates/taobao.yml

@@ -0,0 +1,18 @@
+development:
+  app_key:    'test'
+  secret_key: 'test'
+  pid:        'test'
+  endpoint:   "http://gw.api.tbsandbox.com/router/rest"
+
+test:
+  app_key:    'test'
+  secret_key: 'test'
+  pid:        'test'
+  endpoint:   "http://gw.api.tbsandbox.com/router/rest"
+
+production:
+  app_key:    'YOUR-KEY'
+  secret_key: 'YOUR-KEY'
+  pid:        'YOUR-PID'
+  endpoint:   "http://gw.api.taobao.com/router/rest"
+

data/lib/open_taobao.rb

@@ -0,0 +1,3 @@
+require 'open_taobao/open_taobao'
+
+require 'open_taobao/railtie' if defined? Rails

data/lib/open_taobao/open_taobao.rb

@@ -0,0 +1,76 @@
+require 'active_support/core_ext'
+require 'digest'
+require 'yaml'
+require 'json'
+require 'patron'
+require 'open_taobao/version'
+
+module OpenTaobao
+  REQUEST_TIMEOUT = 10
+  API_VERSION = '2.0'
+  USER_AGENT = "open_taobao-v#{VERSION}"
+
+  class << self
+    attr_accessor :config, :session
+
+    def load(config_file)
+      @config = YAML.load_file(config_file)
+      @config = config[Rails.env] if defined? Rails
+      apply_settings
+    end
+
+    def apply_settings
+      ENV['TAOBAO_API_KEY']    = config['app_key']
+      ENV['TAOBAO_SECRET_KEY'] = config['secret_key']
+      ENV['TAOBAO_ENDPOINT']   = config['endpoint']
+      ENV['TAOBAOKE_PID']      = config['pid']
+
+      initialize_session
+    end
+
+    def initialize_session
+      @session = Patron::Session.new
+      #@session.base_url = config['endpoint']
+      @session.headers['User-Agent'] = USER_AGENT
+      @session.timeout = REQUEST_TIMEOUT
+    end
+
+    def sign(params)
+      Digest::MD5::hexdigest("#{config['secret_key']}#{sorted_option_string params}#{config['secret_key']}").upcase
+    end
+
+    def sorted_option_string(options)
+      options.map {|k, v| "#{k}#{v}" }.sort.join
+    end
+
+    def full_options(params)
+      {
+        :timestamp   => Time.now.strftime("%F %T"),
+        :v           => API_VERSION,
+        :format      => :json,
+        :sign_method => :md5,
+        :app_key     => config['app_key']
+      }.merge params
+    end
+
+    def query_string(params)
+      params = full_options params
+      params[:sign] = sign params
+      params.to_query
+    end
+
+    def url(params)
+      "%s?%s" % [config['endpoint'], query_string(params)]
+    end
+
+    def parse_result(data)
+      JSON.parse(data)
+    end
+
+    def get(params)
+      path = url(params)
+      parse_result session.get(path).body
+    end
+  end
+end
+

data/lib/open_taobao/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module OpenTaobao
+  class Railtie < Rails::Railtie
+    generators do
+      require 'generators/open_taobao/install_generator'
+    end
+
+    initializer 'load taobao.yml' do
+      config_file = Rails.root + 'config/taobao.yml'
+      OpenTaobao.load(config_file) if config_file.file?
+    end
+  end
+end

data/lib/open_taobao/version.rb

@@ -0,0 +1,3 @@
+module OpenTaobao
+  VERSION = "0.0.1"
+end

data/open_taobao.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/open_taobao/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["wongyouth"]
+  gem.email         = ["wongyouth@gmail.com"]
+  gem.description   = %q{淘宝开放平台ruby版，支持Rails3}
+  gem.summary       = %q{Open Taobao API for ruby}
+  gem.homepage      = "http://github.com/wongyouth/open_taobao"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "open_taobao"
+  gem.require_paths = ["lib"]
+  gem.version       = OpenTaobao::VERSION
+
+  gem.add_dependency "patron"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "autotest"
+end

data/spec/open_taobao_spec.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'tempfile'
+
+describe OpenTaobao do
+ ENDPOINT = "http://gw.api.tbsandbox.com/router/rest"
+
+  before(:each) do
+    @now = Time.parse('2012-10-29 23:30')
+    Time.stub(:now) { @now }
+  end
+
+  let(:config_file) do
+    file = Tempfile.new 'taobao'
+    File.open file.path, 'w+' do |f|
+      f.write <<-EOS.gsub(/^ +/, '')
+        app_key:    'test'
+        secret_key: 'test'
+        pid:        'test'
+        endpoint:   '#{ENDPOINT}'
+      EOS
+    end
+    file
+  end
+
+  # we only need to load config file here once for all test
+  it "should load config file" do
+    OpenTaobao.load(config_file.path)
+    OpenTaobao.config.should == {
+      'app_key'    => 'test',
+      'secret_key' => 'test',
+      'pid'        => 'test',
+      'endpoint'   => "http://gw.api.tbsandbox.com/router/rest"
+    }
+  end
+
+  it "should merge with default options" do
+    options = {:foo => 'foo', :bar => 'bar'}
+    OpenTaobao.full_options(options).should ==
+    {
+      :foo         => 'foo',
+      :bar         => 'bar',
+      :timestamp   => @now.strftime("%F %T"),
+      :v           => '2.0',
+      :format      => :json,
+      :sign_method => :md5,
+      :app_key     => 'test'
+    }
+  end
+
+  # ref: http://open.taobao.com/doc/detail.htm?spm=0.0.0.30.iamImZ&id=111
+  it "should return sorted options string" do
+    options = {
+      'timestamp'  => '2011-07-01 13:52:03',
+      'v'          => '2.0',
+      'app_key'    => 'test',
+      'method'     => 'taobao.user.get',
+      'sign_method'     => 'md5',
+      'format'     => 'xml',
+      'nick'       => '商家测试帐号17',
+      'fields'     => 'nick,location.state,location.city'
+    }
+    OpenTaobao.sorted_option_string(options).should == "app_keytestfieldsnick,location.state,location.cityformatxmlmethodtaobao.user.getnick商家测试帐号17sign_methodmd5timestamp2011-07-01 13:52:03v2.0"
+  end
+
+  # ref: http://open.taobao.com/doc/detail.htm?spm=0.0.0.30.iamImZ&id=111
+  it "should return signature" do
+    options = {
+      'timestamp'  => '2011-07-01 13:52:03',
+      'v'          => '2.0',
+      'app_key'    => 'test',
+      'method'     => 'taobao.user.get',
+      'sign_method'     => 'md5',
+      'format'     => 'xml',
+      'nick'       => '商家测试帐号17',
+      'fields'     => 'nick,location.state,location.city'
+    }
+    OpenTaobao.sign(options).should == '5029C3055D51555112B60B33000122D5'
+  end
+
+  it "should return query string for url" do
+    options = {
+      :timestamp  => '2011-07-01 13:52:03',
+      :method     => 'taobao.user.get',
+      :format     => 'xml',
+      :partner_id => 'top-apitools',
+      'nick'       => '商家测试帐号17',
+      'fields'     => 'nick,location.state,location.city'
+    }
+    OpenTaobao.query_string(options).should include("sign=")
+    OpenTaobao.query_string(options).should include("timestamp=")
+    OpenTaobao.query_string(options).should include("method=taobao.user.get")
+    OpenTaobao.query_string(options).should include("format=xml")
+    OpenTaobao.query_string(options).should include("partner_id=top-apitools")
+  end
+
+  it "should return url with endpoint" do
+    options = {
+      :timestamp  => '2011-07-01 13:52:03',
+      :method     => 'taobao.user.get',
+      :format     => 'xml',
+      :partner_id => 'top-apitools',
+      'nick'      => '商家测试帐号17',
+      'fields'    => 'nick,location.state,location.city'
+    }
+    OpenTaobao.url(options).should start_with(ENDPOINT)
+  end
+
+  it "should parse result data" do
+    data = '
+      "item_get_response": {
+          "item": {
+            "item_imgs": {
+              "item_img": [
+              ]
+            }
+          }
+      }
+    '
+
+    OpenTaobao.parse_result(data).should == {
+      "item_get_response" => {
+        'item' => {
+          "item_imgs" => { "item_img" => []}
+        }
+      }
+    }
+  end
+
+  it "should support get method" do
+    OpenTaobao.initialize_session
+    params = {
+      :method => "taobao.itemcats.get",
+      :fields => "cid,parent_id,name,is_parent",
+      :parent_cid => 0
+    }
+
+    OpenTaobao.get(params)['itemcats_get_response']['item_cats']['item_cat'].should be_a(Array)
+  end
+end
+
+# OpenTaobao.load(File.expand_path('../taobao.yml',__FILE__))
+# 
+# def pretty(json)
+#   puts JSON.pretty_generate(json)
+# end
+# 
+# params = {
+#   :method => "taobao.itemcats.get",
+#   :fields => "cid,parent_id,name,is_parent",
+#   :parent_cid => 0
+# }
+# 
+# pretty(OpenTaobao.get(params))
+# 
+# params = {
+#   :method => "taobao.taobaoke.items.get",
+#   :fields => "num_iid,title,nick,pic_url,price,click_url, commission,commission_num,volume",
+#   :cid => 30, # 男装
+#   :pid => OpenTaobao::PID
+# }
+# 
+# pretty(OpenTaobao.get(params))
+# 
+# params = {
+#   :method => "taobao.item.get",
+#   :fields => "prop_img.url,item_img.url,nick",
+#   :num_iid => 19276752117
+# }
+# 
+# pretty(OpenTaobao.get(params))
+# 

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require File.expand_path('../../lib/open_taobao.rb', __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: open_taobao
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- wongyouth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 淘宝开放平台ruby版，支持Rails3
+email:
+- wongyouth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/open_taobao/install_generator.rb
+- lib/generators/templates/taobao.yml
+- lib/open_taobao.rb
+- lib/open_taobao/open_taobao.rb
+- lib/open_taobao/railtie.rb
+- lib/open_taobao/version.rb
+- open_taobao.gemspec
+- spec/open_taobao_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wongyouth/open_taobao
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Open Taobao API for ruby
+test_files:
+- spec/open_taobao_spec.rb
+- spec/spec_helper.rb
+has_rdoc: