open_taobao 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - rbx-18mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 ryan
+Copyright (c) 2012 Wang Yongzhi
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,4 +1,5 @@
-# OpenTaobao
+OpenTaobao [![Build Status](https://secure.travis-ci.org/wongyouth/open_taobao.png?branch=master)](https://travis-ci.org/wongyouth/open_taobao)
+==========
 
 Taobao Open Platform client for ruby. Rails3 is supported.
 
@@ -7,6 +8,7 @@ Taobao Open Platform client for ruby. Rails3 is supported.
 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
 
 And then execute:
 
@@ -25,6 +27,8 @@ Run generate to complete install:
 
 ## Usage
 
+### Rails with yaml file configured
+
 调用`OpenTaobao.get`方法，传入相应参数：
 
     hash = OpenTaobao.get(
@@ -35,6 +39,23 @@ Run generate to complete install:
 
 返回内容将自动转化为hash格式。
 
+### plain ruby
+
+    OpenTaobao.config = {
+      'app_key'    => 'test',
+      'secret_key' => 'test',
+      'pid'        => 'test',
+      'endpoint'   => "http://gw.api.tbsandbox.com/router/rest"
+    }
+
+    OpenTaobao.initialize_session
+
+    hash = OpenTaobao.get(
+      :method => "taobao.itemcats.get",
+      :fields => "cid,parent_id,name,is_parent",
+      :parent_cid => 0
+    )
+
 ## Contributing
 
 1. Fork it
@@ -42,3 +63,5 @@ Run generate to complete install:
 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
+
+[patron]: https://github.com/toland/patron

data/lib/open_taobao/open_taobao.rb

@@ -1,9 +1,25 @@
-require 'active_support/core_ext'
-require 'digest'
-require 'yaml'
-require 'json'
-require 'patron'
-require 'open_taobao/version'
+#--
+# Copyright (c) 2012 Wang Yongzhi
+#
+# 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.
+#++
 
 module OpenTaobao
   REQUEST_TIMEOUT = 10
@@ -13,36 +29,89 @@ module OpenTaobao
   class << self
     attr_accessor :config, :session
 
+    # Load a yml config, and initialize http session
+    # yml config file content should be:
+    #
+    #   app_key:    "YOUR APP KEY"
+    #   secret_key: "YOUR SECRET KEY"
+    #   pid:        "YOUR TAOBAOKE pid"
+    #   endpoint:   "TAOBAO GATEWAY API URL"
+    #
     def load(config_file)
       @config = YAML.load_file(config_file)
       @config = config[Rails.env] if defined? Rails
-      apply_settings
+      check_config_and_export_to_env
+      initialize_session
+    end
+
+    # check config and export all setting to ENV
+    def check_config_and_export_to_env
+      check_config
+      export_config_to_env
+    end
+
+    # check config
+    #
+    # raise exception if config key missed in YAML file
+    def check_config
+      list = []
+      %w(app_key secret_key pid endpoint).map do |k|
+        list << k unless config.has_key? k
+      end
+
+      raise "[#{list.join(', ')}] not included in your yaml file." unless list.empty?
     end
 
-    def apply_settings
+    # setting ENV variables from config
+    #
+    # ENV variables:
+    # 
+    #   TAOBAO_API_KEY    -> config['app_key']
+    #   TAOBAO_SECRET_KEY -> config['secret_key']
+    #   TAOBAO_ENDPOINT   -> config['endpoint']
+    #   TAOBAOKE_PID      -> config['pid']
+    def export_config_to_env
       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
 
+    # Initialize http sesison
     def initialize_session
-      @session = Patron::Session.new
-      #@session.base_url = config['endpoint']
-      @session.headers['User-Agent'] = USER_AGENT
-      @session.timeout = REQUEST_TIMEOUT
+      @session = Faraday.new :url => config['endpoint'] do |builder|
+        begin
+          require 'patron'
+          builder.adapter :patron
+        rescue LoadError
+          builder.adapter :net_http
+        end
+      end
     end
 
+    # Return request signature with MD5 signature method
     def sign(params)
       Digest::MD5::hexdigest("#{config['secret_key']}#{sorted_option_string params}#{config['secret_key']}").upcase
     end
 
+    # Return sorted request parameter by request key
     def sorted_option_string(options)
       options.map {|k, v| "#{k}#{v}" }.sort.join
     end
 
+    # Merge custom parameters with TAOBAO system parameters.
+    #
+    # System paramters below will be merged. 
+    #
+    #   timestamp
+    #   v
+    #   format
+    #   sign_method
+    #   app_key
+    #
+    # Current Taobao API Version is '2.0'.
+    # <tt>format</tt> should be json.
+    # Only <tt>sign_method</tt> MD5 is supported so far.
     def full_options(params)
       {
         :timestamp   => Time.now.strftime("%F %T"),
@@ -53,22 +122,26 @@ module OpenTaobao
       }.merge params
     end
 
+    # Retrun query string with signature.
     def query_string(params)
       params = full_options params
       params[:sign] = sign params
-      params.to_query
+      "?" + params.to_query
     end
 
+    # Return full url with signature.
     def url(params)
-      "%s?%s" % [config['endpoint'], query_string(params)]
+      "%s%s" % [config['endpoint'], query_string(params)]
     end
 
+    # Return a parsed JSON object.
     def parse_result(data)
       JSON.parse(data)
     end
 
+    # Return response in JSON format
     def get(params)
-      path = url(params)
+      path = query_string(params)
       parse_result session.get(path).body
     end
   end

data/lib/open_taobao/version.rb

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

data/lib/open_taobao.rb

@@ -1,3 +1,10 @@
+require 'active_support/core_ext/object'
+require 'digest'
+require 'faraday'
+require 'json'
+require 'open_taobao/version'
+require 'yaml'
+
 require 'open_taobao/open_taobao'
 
 require 'open_taobao/railtie' if defined? Rails

data/open_taobao.gemspec

@@ -15,7 +15,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = OpenTaobao::VERSION
 
-  gem.add_dependency "patron"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "json"
+  gem.add_dependency "faraday"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "autotest"
+  gem.add_development_dependency "rake"
 end

data/spec/open_taobao_spec.rb

@@ -11,7 +11,7 @@ describe OpenTaobao do
   end
 
   let(:config_file) do
-    file = Tempfile.new 'taobao'
+    file = Tempfile.new 'taobao.yml'
     File.open file.path, 'w+' do |f|
       f.write <<-EOS.gsub(/^ +/, '')
         app_key:    'test'
@@ -34,6 +34,18 @@ describe OpenTaobao do
     }
   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.')
+  end
+
   it "should merge with default options" do
     options = {:foo => 'foo', :bar => 'bar'}
     OpenTaobao.full_options(options).should ==

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_taobao
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: patron
+  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:
@@ -59,6 +91,22 @@ dependencies:
     - - ! '>='
       - !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
 email:
 - wongyouth@gmail.com
@@ -68,6 +116,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -93,19 +142,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !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.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Open Taobao API for ruby
 test_files:
 - spec/open_taobao_spec.rb
 - spec/spec_helper.rb
-has_rdoc: