taobao-top 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/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@taobao-top --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://ruby.taobao.org'
+
+# Specify your gem's dependencies in taobao-top.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 xixilive
+
+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,145 @@
+# Taobao::Top
+
+   A simple ruby implementation of Taobao TOP API [淘宝开放平台](http://open.taobao.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'taobao-top'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install taobao-top
+
+## Usage
+### Configuration
+
+For Rails, add following lines in 'config/initializers/taobao_top.rb':
+
+```ruby
+Taobao::TOP.sandbox = !Rails.env.production?
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE if Taobao::TOP.sandbox?
+```
+
+### Invoke a API method:
+```ruby
+require 'taobao/top'
+```
+
+Init a service instance by following lines:
+
+```ruby
+service = Taobao::TOP::Service.new(APP_KEY, APP_SECRET, :session => "SESSION")
+```
+
+Or
+
+```ruby
+service = Taobao::TOP::Service.new(APP_KEY, APP_SECRET) do |options|
+  options.session = "SESSION"
+  options.format = "json"
+  options.sign_method = "md5"
+end
+```
+
+then invoke a API method:
+
+```ruby
+response = service.get("taobao.users.get", :nick => "test")
+unless response.error?
+  user = response.body.user
+  p user.nick # => test
+else
+  p response.error.code
+  p response.error.msg
+  p response.error.sub_code
+  p response.error.sub_msg
+end
+```
+
+### Multipart content
+```ruby
+service = Taobao::TOP::Service.new(APP_KEY, APP_SECRET, :session => "SESSION")
+response = service.post("taobao.item.img.upload", :num_iid=>'1489161932', :image => File.open('example.jpg'))
+```
+
+### Integrate with OmniAuth
+```ruby
+require 'taobao/top-oauth' # includes TOP API and Oauth
+```
+
+and Rails initializer at config/initializers/omniauth.rb
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :taobao, TAOBAO_API_KEY, TAOBAO_API_SECRET
+end
+```
+
+and Append a line in routes.rb
+
+```ruby
+get '/auth/:provider/callback', to: 'sessions#create'
+```
+
+and Add following lines in your sessions_controller.rb to initialize a user's session
+
+```ruby
+def create
+  @user = User.find_or_create_from_auth_hash(request.env['omniauth.auth'])
+  session[:current_user] = @user
+  redirect_to '/'
+end
+```
+
+#### How to fetch a user's information from TOP API after 'token callback'
+
+By default, the 'taobao_user_role' option is nil in OmniAuth::Strategies::Taobao class, in this case, your will get a simple raw-info hash like this:
+
+```ruby
+{
+  "user_id": TAOBAO_USER_ID,
+  "nick": TAOBAO_USER_NICKNAME
+}
+```
+
+and you can get a user's information through a TOP API method named 'taobao.user.get' like this:
+
+```ruby
+OmniAuth::Strategies::Taobao.option :taobao_user_role, 'user'
+```
+
+and to use 'taobao.user.buyer.get' like this:
+
+```ruby
+OmniAuth::Strategies::Taobao.option :taobao_user_role, 'buyer'
+```
+
+and to use 'taobao.user.seller.get' like this:
+
+```ruby
+OmniAuth::Strategies::Taobao.option :taobao_user_role, 'seller'
+```
+
+NOTE: you should have avaliable TOP API permissions for above settings. visit [Taobao User API](http://open.taobao.com/doc/api_cat_detail.htm?spm=0.0.0.0.mfYwn5&cat_id=1&category_id=102) for more details.
+
+### SSL verify in Taobao sandbox environment:
+
+when you are using Oauth in the 'tbsandbox' env, you should skip verify SSL certification as following:
+
+```ruby
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE 
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/omniauth/strategies/taobao.rb

@@ -0,0 +1,59 @@
+require 'omniauth'
+require 'omniauth-oauth2'
+require 'taobao/top'
+
+module OmniAuth::Strategies
+  class Taobao < OmniAuth::Strategies::OAuth2
+    option :client_options, ::Taobao::TOP.gateways
+    option :taobao_user_role, nil
+
+    def request_phase
+      options[:state] ||= '1'
+      super
+    end
+
+    uid { raw_info['user_id'] }
+
+    info do
+      {
+        'name' => raw_info['nick'],
+        'image' => raw_info['avatar']
+      }
+    end
+
+    extra do
+      { :raw_info => raw_info }
+    end
+
+    def raw_info
+      @rawinfo ||= (!!options.taobao_user_role ? fetch_raw_info : fetch_raw_info_from_params)
+    end
+
+    private
+    def raw_info_method
+      ["taobao", "user", "#{options.taobao_user_role}", "get"].uniq.join(".")
+    end
+
+    def raw_info_fields
+      {
+        "buyer" => "user_id,nick,sex,avatar,buyer_credit,has_shop,vip_info",
+        "seller" => "user_id,nick,sex,avatar,seller_credit,type,has_shop,is_golden_seller,vip_info",
+        "user" => "user_id,nick,sex,avatar,email,buyer_credit,seller_credit,location,type,has_shop,vip_info"
+      }[options.taobao_user_role.to_s]
+    end
+
+    def fetch_raw_info
+      service = ::Taobao::TOP::Service.new(options.client_id, options.client_secret, :session => @access_token.token)
+      res = service.get(raw_info_method, :fields => raw_info_fields)
+      res.error? ? {} : res.body.user
+    end
+
+    def fetch_raw_info_from_params
+      attrs = [["user_id", "taobao_user_id"],["nick", "taobao_user_nick"]]
+      Hash[attrs.collect{|arr| [arr[0], @access_token[arr[1]]]}].select{|k,v| v != nil}
+    end
+
+  end
+end
+
+::OmniAuth.config.add_camelization 'taobao', 'Taobao'

data/lib/taobao/rails/engine.rb

@@ -0,0 +1,17 @@
+module Taobao
+  module Rails
+    class Engine < ::Rails::Engine
+
+      initializer "taobao.top" do |app|
+        
+        ::Taobao::TOP.sandbox = !::Rails.env.production?
+        ::OpenSSL::SSL::VERIFY_PEER = ::OpenSSL::SSL::VERIFY_NONE if ::Taobao::TOP.sandbox?
+
+        if defined?(::OmniAuth::Strategies::Taobao)
+          ::OmniAuth::Strategies::Taobao.option :client_options, ::Taobao::TOP.gateways
+        end
+      end
+
+    end
+  end
+end

data/lib/taobao/top-oauth.rb

@@ -0,0 +1,2 @@
+require 'taobao/top'
+require 'omniauth/strategies/taobao'

data/lib/taobao/top.rb

@@ -0,0 +1,33 @@
+lib = File.expand_path('../../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "taobao/top/version"
+require 'hashie'
+require 'active_support/core_ext'
+
+module Taobao
+  module TOP
+    mattr_accessor :sandbox
+    @@sandbox = false
+
+    def self.gateways
+      domain = self.sandbox? ? "tbsandbox" : "taobao"
+      {
+        :site => "http://gw.api.#{domain}.com/router/rest",
+        :authorize_url => "https://oauth.#{domain}.com/authorize",
+        :token_url => "https://oauth.#{domain}.com/token"
+      }
+    end
+
+    def self.sandbox?
+      !!self.sandbox
+    end
+
+    autoload :Options, 'taobao/top/service.rb'
+    autoload :Params, 'taobao/top/service.rb'
+    autoload :Service, 'taobao/top/service.rb'
+    autoload :Response, 'taobao/top/service.rb'
+  end
+end
+
+require 'taobao/rails/engine' if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3

data/lib/taobao/top/service.rb

@@ -0,0 +1,106 @@
+require 'digest/md5'
+require 'digest/hmac'
+require 'rest_client'
+
+module Taobao
+  module TOP
+    class Options < ::Hashie::Mash;
+      def self.default
+        self.new v: '2.0', sign_method: 'md5', format: 'json'
+      end
+    end
+
+    class Params < ::Hashie::Mash
+
+      attr_reader :signature
+
+      def sign! secret
+        str = self.select{|k,v| !multipart?(v) }.sort_by{|k,v| k.to_s }.collect{|i| i.join }.join
+        @signature = case self.sign_method.to_s.downcase
+        when 'md5' then Digest::MD5.hexdigest("#{secret}#{str}#{secret}").upcase
+        when 'hmac' then Digest::HMAC.hexdigest(str, secret, Digest::MD5).upcase
+        else ""
+        end
+        self.sign = @signature
+      end
+
+      private
+      def multipart? obj
+        obj.respond_to?(:path) && obj.respond_to?(:read)
+      end
+    end
+
+    class Response < ::Hashie::Mash
+      def self.from_json data
+        self.new ActiveSupport::JSON.decode(data)
+      end
+
+      def self.from_xml data
+        self.new Hash.from_xml(data)
+      end
+
+      def body
+        unless error?
+          self[self.keys.first]
+        end
+      end
+
+      def error?
+        self.error_response
+      end
+
+      def error
+        self.error_response if error?
+      end
+    end
+
+    class Service
+
+      attr_reader :options, :params, :response
+
+      def initialize *args, &block
+        @options = TOP::Options.default.dup.merge(args.extract_options!)
+        @app_key, @app_secret = args.slice!(0,2)
+        raise ArgumentError.new "app_key or app_secret missing!" unless @app_key && @app_secret
+        yield @options if block_given?
+      end
+
+      def get method, *args
+        invoke method, :get, *args
+      end
+
+      def post method, *args
+        invoke method, :post, *args
+      end
+
+      private
+      def prepare_params params
+        @params = TOP::Params.new params
+        @params.app_key = @app_key
+        @params.timestamp = Time.now.strftime('%Y-%m-%d %H:%M:%S')
+        @params.sign! @app_secret
+      end
+
+      def invoke method, http_method, *args
+        prepare_params @options.merge(args.extract_options!).merge(method: method)
+        begin
+          raw_response = case http_method
+          when :get then RestClient.get [TOP.gateways[:site], @params.to_query].join("?")
+          when :post then RestClient.post TOP.gateways[:site], @params
+          end
+          @response = case @params.format.to_s.downcase
+          when 'json'
+            TOP::Response.from_json(raw_response)
+          when 'xml'
+            TOP::Response.from_xml(raw_response)
+          else
+            raw_response
+          end
+        rescue Exception => e
+          RestClient.create_log("stderr") << e
+        end
+      end
+    end
+
+  end
+end

data/lib/taobao/top/version.rb

@@ -0,0 +1,5 @@
+module Taobao
+  module Top
+    VERSION = "0.0.1"
+  end
+end

data/taobao-top.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'taobao/top/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "taobao-top"
+  spec.version       = Taobao::Top::VERSION
+  spec.authors       = ["xixilive"]
+  spec.email         = ["xixilive@gmail.com"]
+  spec.description   = %q{a simple ruby implementation of TOP API}
+  spec.summary       = %q{a simple ruby implementation of TOP API}
+  spec.homepage      = "https://github.com/xixilive/taobao-top"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hashie", '~> 2.0'
+  spec.add_dependency "activesupport", ['>= 3.2','< 4']
+  spec.add_dependency "rest-client", "~> 1.6.0"
+  spec.add_dependency "omniauth", '~> 1.1'
+  spec.add_dependency "omniauth-oauth2", '~> 1.1'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: taobao-top
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- xixilive
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: a simple ruby implementation of TOP API
+email:
+- xixilive@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/strategies/taobao.rb
+- lib/taobao/rails/engine.rb
+- lib/taobao/top-oauth.rb
+- lib/taobao/top.rb
+- lib/taobao/top/service.rb
+- lib/taobao/top/version.rb
+- taobao-top.gemspec
+homepage: https://github.com/xixilive/taobao-top
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: a simple ruby implementation of TOP API
+test_files: []