open_taobao 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0d2cd1f2224327805d2a53d744fa6a2e48bde17
+  data.tar.gz: 902d65b7f744defc6380de2ac0f66037a20d17c4
+SHA512:
+  metadata.gz: 281732d45349bbaf20424eb940c272d7494571d19f74605328e95dc37342040b4107c10e7d8868d30cb1136002f53aef10706d7c09f645502f2fedea8cc7873f
+  data.tar.gz: aefdde07064cc319103cf3203e371c233c8e142a3db835f800c6846a28aa3d0aaf0b137566531b1a67174000c61bbc4a96fc9d7a41f7416f8bf072226cd9303d

data/CHNAGELOG.md

@@ -0,0 +1,3 @@
+## 2013-05-12
+
+pid is not required in config file, but will be loaded to config for back compatibility.

data/README.md

@@ -3,12 +3,19 @@ OpenTaobao [![Build Status](https://secure.travis-ci.org/wongyouth/open_taobao.p
 
 Taobao Open Platform client for ruby. Rails3 is supported.
 
+## NOTICE
+
+`pid` is removed from config file, it's not required any more.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
     gem 'open_taobao'
-    gem 'patron' # add this line if you want to use [patron][] instead of Net::HTTP
+
+If you want to use [patron][] as http client instead of Net::HTTP, add line below to your Gemfile
+
+    gem 'patron'
 
 And then execute:
 
@@ -18,18 +25,20 @@ Or install it yourself as:
 
     $ gem install open_taobao
 
-Run generate to complete install:
+## Usage
 
-    $ rails g open_taobao:install
+### Rails with yaml file configured
 
-在你的`Rails`项目的`config`目录下会生成一个`taobao.yml`文件,
-打开taobao.yml文件，设置你自己的`app_key`, `secret_key`, 淘宝客的`pid`
+Run generator to generate config file:
 
-## Usage
+    $ rails g open_taobao:install
 
-### Rails with yaml file configured
+It will generate a `taobao.yml` file under your Rails' config dir.
+Open the file and configure it with your taobao info.
+
+Notice: `app_key`, `secret_key`, `endpoint` must be included in your YAML file, otherwise OpenTaobao.load will fail.
 
-调用`OpenTaobao.get`方法，传入相应参数：
+call `OpenTaobao.get`，with taobao parameters：
 
     hash = OpenTaobao.get(
       :method => "taobao.itemcats.get",
@@ -37,14 +46,13 @@ Run generate to complete install:
       :parent_cid => 0
     )
 
-返回内容将自动转化为hash格式。
+The return data will be converted to a Hash automatically.
 
 ### plain ruby
 
     OpenTaobao.config = {
       'app_key'    => 'test',
       'secret_key' => 'test',
-      'pid'        => 'test',
       'endpoint'   => "http://gw.api.tbsandbox.com/router/rest"
     }
 
@@ -56,6 +64,17 @@ Run generate to complete install:
       :parent_cid => 0
     )
 
+### get query string
+
+If you want the query string with some params just pass the params to OpenTaobao.url() the same as OpenTaobao.get().
+The query string will change every time your executed because timestamps changed.
+
+    OpenTaobao.url(
+      :method => "taobao.itemcats.get",
+      :fields => "cid,parent_id,name,is_parent",
+      :parent_cid => 0
+    )
+
 ## Contributing
 
 1. Fork it

data/lib/generators/templates/taobao.yml

@@ -1,18 +1,15 @@
 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/open_taobao.rb

@@ -34,7 +34,6 @@ module OpenTaobao
     #
     #   app_key:    "YOUR APP KEY"
     #   secret_key: "YOUR SECRET KEY"
-    #   pid:        "YOUR TAOBAOKE pid"
     #   endpoint:   "TAOBAO GATEWAY API URL"
     #
     def load(config_file)
@@ -55,7 +54,7 @@ module OpenTaobao
     # raise exception if config key missed in YAML file
     def check_config
       list = []
-      %w(app_key secret_key pid endpoint).map do |k|
+      %w(app_key secret_key endpoint).map do |k|
         list << k unless config.has_key? k
       end
 
@@ -74,7 +73,7 @@ module OpenTaobao
       ENV['TAOBAO_API_KEY']    = config['app_key']
       ENV['TAOBAO_SECRET_KEY'] = config['secret_key']
       ENV['TAOBAO_ENDPOINT']   = config['endpoint']
-      ENV['TAOBAOKE_PID']      = config['pid']
+      ENV['TAOBAOKE_PID']      = config['pid']  # for compatible with v0.0.3
     end
 
     # Initialize http sesison
@@ -91,7 +90,11 @@ module OpenTaobao
 
     # Return request signature with MD5 signature method
     def sign(params)
-      Digest::MD5::hexdigest("#{config['secret_key']}#{sorted_option_string params}#{config['secret_key']}").upcase
+      Digest::MD5::hexdigest(wrap_with_secret sorted_option_string(params)).upcase
+    end
+
+    def wrap_with_secret(s)
+      config['secret_key'] + s + config['secret_key']
     end
 
     # Return sorted request parameter by request key

data/lib/open_taobao/version.rb

@@ -1,3 +1,3 @@
 module OpenTaobao
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/open_taobao.gemspec

@@ -4,7 +4,7 @@ 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.description   = %q{淘宝开放平台ruby版，支持Rails3~}
   gem.summary       = %q{Open Taobao API for ruby}
   gem.homepage      = "http://github.com/wongyouth/open_taobao"
 

data/spec/open_taobao_spec.rb

@@ -5,45 +5,42 @@ 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.yml'
     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
 
+  before(:each) do
+    @now = Time.parse('2012-10-29 23:30')
+    Time.stub(:now) { @now }
+    OpenTaobao.load(config_file.path)
+  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 raise exception if config yaml does not include correct keys" do
     OpenTaobao.config = {
-      'app_key'    => 'test',
       'secret_key' => 'test',
       'endpoint'   => "http://gw.api.tbsandbox.com/router/rest"
     }
 
     expect {
       OpenTaobao.check_config
-    }.to raise_error('[pid] not included in your yaml file.')
+    }.to raise_error('[app_key] not included in your yaml file.')
   end
 
   it "should merge with default options" do

metadata

@@ -1,113 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: open_taobao
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - wongyouth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: json
   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: faraday
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   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
+description: 淘宝开放平台ruby版，支持Rails3~
 email:
 - wongyouth@gmail.com
 executables: []
@@ -117,6 +104,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHNAGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -132,33 +120,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/wongyouth/open_taobao
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1746376069650641682
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1746376069650641682
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Open Taobao API for ruby
 test_files:
 - spec/open_taobao_spec.rb