lib/.DS_Store lib/top4r/.DS_Store lib/top4r/client/shipping.rb lib/top4r/client/suite.rb lib/top4r/client/trade.rb lib/top4r/client/user.rb lib/top4r/console.rb lib/top4r/ext.rb lib/top4r/ext/stdlib.rb lib/top4r/model/shipping.rb lib/top4r/model/suite.rb lib/top4r/model/trade.rb lib/top4r/model/user.rb pkg/top4r-0.0.1.gem pkg/top4r-0.0.1.tgz pkg/top4r-0.0.1.zip pkg/top4r-0.0.1/CHANGES pkg/top4r-0.0.1/MIT-LICENSE pkg/top4r-0.0.1/README pkg/top4r-0.0.1/TODO pkg/top4r-0.0.1/lib/top4r.rb pkg/top4r-0.0.1/lib/top4r/client.rb pkg/top4r-0.0.1/lib/top4r/client/base.rb pkg/top4r-0.0.1/lib/top4r/client/shipping.rb pkg/top4r-0.0.1/lib/top4r/client/suite.rb pkg/top4r-0.0.1/lib/top4r/client/trade.rb pkg/top4r-0.0.1/lib/top4r/client/user.rb pkg/top4r-0.0.1/lib/top4r/config.rb pkg/top4r-0.0.1/lib/top4r/console.rb pkg/top4r-0.0.1/lib/top4r/core.rb pkg/top4r-0.0.1/lib/top4r/ext.rb pkg/top4r-0.0.1/lib/top4r/ext/stdlib.rb pkg/top4r-0.0.1/lib/top4r/meta.rb pkg/top4r-0.0.1/lib/top4r/model.rb pkg/top4r-0.0.1/lib/top4r/model/shipping.rb pkg/top4r-0.0.1/lib/top4r/model/suite.rb pkg/top4r-0.0.1/lib/top4r/model/trade.rb pkg/top4r-0.0.1/lib/top4r/model/user.rb pkg/top4r-0.0.1/lib/top4r/version.rb @@ -1,15 +1,26 @@ $:.unshift(File.dirname(__FILE__)) -require 'rubygems' +module Top4R; end -module TOP4R; end +def require_local(suffix) + require(File.expand_path(File.join(File.dirname(__FILE__), suffix))) +end -# External requires -require('yaml') +require 'digest/md5' +require 'net/http' +require 'net/https' +require 'uri' +require 'cgi' +require 'json' +require 'yaml' +require 'iconv' +require 'activesupport' -require 'top4r/version.rb' -require 'top4r/meta.rb' -require 'top4r/core.rb' -require 'top4r/model.rb' -require 'top4r/config.rb' -require 'top4r/client.rb' \ No newline at end of file +require_local('top4r/ext') +require_local('top4r/version') +require_local('top4r/meta') +require_local('top4r/core') +require_local('top4r/model') +require_local('top4r/config') +require_local('top4r/client') +require_local('top4r/console') \ No newline at end of file lib/top4r.rb @@ -1,12 +1,23 @@ -# client.rb contains the classes, methods and extends <tt>TOP4R</tt> -# features to define client calls to the TOP REST API. -# -# See: -# * <tt>TOP4R::Client</tt> - -# Used to query or post to the TOP REST API to simplify code. -class TOP4R::Client - include TOP4R::ClassUtilMixin +class Top4R::Client + include Top4R::ClassUtilMixin + + @@no_login_required_methods = { + :user => { + :info => 'taobao.user.get', + :multi_info => 'taobao.users.get' + }, + :trade => {}, + :area => { + :list => 'taobao.areas.get' + }, + :logistic_company => { + :list => 'taobao.logisticcompanies.get' + } + } end -require 'top4r/client/base' \ No newline at end of file +require 'top4r/client/base' +require 'top4r/client/user' +require 'top4r/client/shipping' +require 'top4r/client/trade' +require 'top4r/client/suite' \ No newline at end of file lib/top4r/client.rb @@ -1,11 +1,135 @@ -class TOP4R::Client +class Top4R::Client alias :old_inspect :inspect - + attr_accessor :total_results + attr_reader :login + def inspect s = old_inspect - s.gsub!(/@password=".*?"/, '@password="XXXX"') + s.gsub!(/@app_secret=".*?"/, '@app_secret="XXXX"') + end + + def init + total_results = 0 + if @parameters and @session + @parameters = Base64.decode64(@parameters).split('&').inject({}) do |hsh, i| kv = i.split('='); hsh[kv[0]] = kv[1]; hsh end + @login = user(@parameters['visitor_nick']) + # puts "login: #{@login.inspect}" + end end protected + attr_accessor :app_key, :app_secret, :parameters, :session + + def login_required(model, method) + return if logged_in? + raise Top4R::LoginRequiredError.new({:model => model, :method => method}) + end + + def http_connect(body=nil, &block) + require_block(block_given?) + connection = create_http_connection + connection.start do |connection| + request = yield connection if block_given? + # puts "conn: #{connection.inspect}" + # puts "request: #{request.inspect}" + response = connection.request(request, body) + puts "response: #{response.body}" + handle_rest_response(response) + response + end + end + + # "Blesses" model object with client information + def bless_model(model) + model.bless(self) if model + end + + def bless_models(list) + return bless_model(list) if list.respond_to?(:client=) + list.collect { |model| bless_model(model) } if list.respond_to?(:collect) + end + + private + @@http_header = nil + def valid_method(method, methods, model, force_login = false) + login_required(model, method) if (@@no_login_required_methods[model].is_a?(Hash) and !@@no_login_required_methods[model].keys.member?(method)) or force_login + raise ArgumentError, "Invalid #{model} method: #{method}" unless methods.keys.member?(method) + end + + def raise_rest_error(response, uri = nil) + map = JSON.parse(response.body) + raise Top4R::RESTError.new(:code => response.code, + :message => response.message, + :error => map["error_rsp"], + :uri => uri) + end + + def handle_rest_response(response, uri = nil) + unless response.is_a?(Net::HTTPSuccess) + raise_rest_error(response, uri) + end + + map = JSON.parse(response.body) + raise Top4R::RESTError.new(:code => map["error_rsp"]["code"], + :message => map["error_rsp"]["msg"], + :error => map["error_rsp"], + :uri => uri) if map["error_rsp"].is_a?(Hash) + end + + def create_http_connection + protocol, host, port = (@@config.env == :production ? @@config.protocol : @@config.test_protocol), (@@config.env == :production ? @@config.host : @@config.test_host), (@@config.env == :production ? @@config.port : @@config.test_port) + conn = Net::HTTP.new(host, port, + @@config.proxy_host, @@config.proxy_port, + @@config.proxy_user, @@config.proxy_pass) + if protocol == :ssl + conn.use_ssl = true + conn.verify_mode = OpenSSL::SSL::VERIFY_NONE + end + conn + end + + def http_header + # can cache this in class variable since all "variables" used to + # create the contents of the HTTP header are determined by other + # class variables that are not designed to change after instantiation. + @@http_header ||= { + 'User-Agent' => "Top4R v#{Top4R::Version.to_version} [#{@@config.user_agent}]", + 'Accept' => 'text/x-json', + 'X-TOP-Client' => @@config.application_name, + 'X-TOP-Client-Version' => @@config.application_version, + 'X-TOP-Client-URL' => @@config.application_url, + } + @@http_header + end + + def append_top_params(params) + params = params.merge({ + :session => @session, + :timestamp => Time.now.strftime("%Y-%m-%d %H:%M:%S"), + :format => "#{@@config.format}", + :app_key => @app_key, + :v => "1.0" + }) + params = params.merge({ + :sign => Digest::MD5.hexdigest(params.sort {|a,b| "#{a[0]}"<=>"#{b[0]}"}.flatten.unshift(@app_secret).join).upcase + }) + end + + def create_http_get_request(method, params = {}) + uri = @@config.env == :production ? @@config.rest_uri : @@config.test_rest_uri + params = append_top_params(params.merge({:method => method})) + path = (params.size > 0) ? "#{uri}?#{params.to_http_str}" : uri + puts "path: #{path}" + Net::HTTP::Get.new(path, http_header) + end + + def create_http_post_request(uri) + Net::HTTP::Post.new(uri, http_header) + end + + def create_http_delete_request(uri, params = {}) + path = (params.size > 0) ? "#{uri}?#{params.to_http_str}" : uri + Net::HTTP::Delete.new(path, http_header) + end end \ No newline at end of file lib/top4r/client/base.rb @@ -1,13 +1,29 @@ -# config.rb contains classes, methods and extends existing TOP4R classes -# to provide easy configuration facilities. - -module TOP4R +module Top4R + # A rails like config object class Config include ClassUtilMixin @@ATTRIBUTES = [ - :host, - :user_agent, - :app_key + :env, + :host, + :rest_uri, + :port, + :protocol, + :test_host, + :test_rest_uri, + :test_port, + :test_protocol, + :proxy_host, + :proxy_port, + :proxy_user, + :proxy_pass, + :format, + :application_name, + :application_key, + :application_secret, + :application_version, + :application_url, + :user_agent, + :source ] attr_accessor *@@ATTRIBUTES @@ -20,23 +36,39 @@ module TOP4R end true end - end + end # Config class class Client @@defaults = { - :host => 'http://gw.sandbox.taobao.com/router/rest', - :user_agent => "TOP4R", - :app_key => "12000224" + :env => :test, + :host => 'gw.api.taobao.com', + :rest_uri => '/router/rest', + :port => 80, + :protocol => :http, + :test_host => 'gw.sandbox.taobao.com', + :test_rest_uri => '/router/rest', + :test_port => 80, + :test_protocol => :http, + :proxy_host => nil, + :proxy_port => nil, + :format => :json, + :application_name => 'Top4R', + :application_key => '12000224', + :application_secret => '2f26cb1a99570aa72daee12a1db88e63', + :application_version => Top4R::Version.to_version, + :application_url => 'http://top4r.nowa.me', + :user_agent => 'default', + :source => 'top4r' } - @@config = TOP4R::Config.new(@@defaults) + @@config = Top4R::Config.new(@@defaults) - # TOP4R::Client class methods + # Top4R::Client class methods class << self - # Yields to given <tt>block</tt> to configure the TOP4R API. + # Yields to given <tt>block</tt> to configure the Twitter4R API. def configure(&block) raise ArgumentError, "Block must be provided to configure" unless block_given? yield @@config end # configure end # class << self end # Client class -end # TOP4R module \ No newline at end of file +end \ No newline at end of file lib/top4r/config.rb @@ -1,91 +1,57 @@ -# The TOP4R API provides a nicer Ruby object API to work with -# instead of coding around the open.taobao.com API. - -# Module to encapsule the TOP4R API. -module TOP4R - # Mixin module for classes that need to have a constructor similar to - # Rails' models, where a <tt>Hash</tt> is provided to set attributes - # appropriately. - # - # To define a class that uses this mixin, use the following code: - # class FilmActor - # include ClassUtilMixin - # end +module Top4R + # Core module ClassUtilMixin module ClassMethods end - # Instance methods defined for <tt>TOP4R::ModelMixin</tt> module. module InstanceMethods - # Constructor/initializer that takes a hash of parameters that - # will initialize *members* or instance attributes to the - # values given. For example, - # - # class FilmActor - # include TOP4R::ClassUtilMixin - # attr_accessor :name - # end - # - # class Production - # include TOP4R::ClassUtilMixin - # attr_accessor :title, :year, :actors - # end - # - # # Favorite actress... - # jodhi = FilmActor.new(:name => "Jodhi May") - # jodhi.name # => "Jodhi May" - # - # # Favorite actor... - # robert = FilmActor.new(:name => "Robert Lindsay") - # robert.name # => "Robert Lindsay" - # - # # Jane is also an excellent pick...gotta love her accent! - # jane = FilmActor.new(name => "Jane Horrocks") - # jane.name # => "Jane Horrocks" - # - # # Witty BBC series... - # mrs_pritchard = Production.new(:title => "The Amazing Mrs. Pritchard", - # :year => 2005, - # :actors => [jodhi, jane]) - # mrs_pritchard.title # => "The Amazing Mrs. Pritchard" - # mrs_pritchard.year # => 2005 - # mrs_pritchard.actors # => [#<FilmActor:0xb79d6bbc @name="Jodhi May">, - # <FilmActor:0xb79d319c @name="Jane Horrocks">] - # # Any Ros Pritchard's out there to save us from the Tony Blair - # # and Gordon Brown *New Labour* debacle? You've got my vote! - # - # jericho = Production.new(:title => "Jericho", - # :year => 2005, - # :actors => [robert]) - # jericho.title # => "Jericho" - # jericho.year # => 2005 - # jericho.actors # => [#<FilmActor:0xc95d3eec @name="Robert Lindsay">] - # - # Assuming class <tt>FilmActor</tt> includes - # <tt>TOP4R::ClassUtilMixin</tt> in the class definition - # and has an attribute of <tt>name</tt>, then that instance - # attribute will be set to "Jodhi May" for the <tt>actress</tt> - # object during object initialization (aka construction for - # you Java heads). def initialize(params = {}) + others = {} params.each do |key,val| - self.send("#{key}=", val) if self.respond_to? key + if self.respond_to? key + self.send("#{key}=", val) + else + others[key] = val + end end + self.send("#{:other_attrs}=", others) if self.respond_to? :other_attrs and others.size > 0 self.send(:init) if self.respond_to? :init end protected - # Helper method to provide an easy and terse way to require - # a block is provided to a method. def require_block(block_given) raise ArgumentError, "Must provide a block" unless block_given end end - def self.included(base) - base.extend ClassMethods - base.send :include, InstanceMethods + def self.included(receiver) + receiver.extend ClassMethods + receiver.send :include, InstanceMethods + end + end # ClassUtilMixin module + + class RESTError < RuntimeError + include ClassUtilMixin + @@ATTRIBUTES = [:code, :message, :uri, :error] + attr_accessor *@@ATTRIBUTES + + # Returns string in following format: + # "HTTP #{@code}: #{@message} at #{@uri}" + # For example, + # "HTTP 404: Resource Not Found at /i_am_crap.json" + def to_s + "HTTP #{@code}: #{@message} at #{@uri}" + end + end # RESTError + + class LoginRequiredError < RuntimeError + include ClassUtilMixin + @@ATTRIBUTES = [:model, :method] + attr_accessor *@@ATTRIBUTES + + def to_s + "#{@method} method at model #{@model} requires you to be logged in first" end - end + end # LoginRequiredError end \ No newline at end of file lib/top4r/core.rb @@ -1,14 +1,14 @@ -# meta.rb contains <tt>TOP4R::Meta</tt> and related classes that -# help define the metadata of the <tt>TOP4R</tt> project. +# meta.rb contains <tt>Twitter::Meta</tt> and related classes that +# help define the metadata of the <tt>Twitter4R</tt> project. -require 'rubygems' -require 'erb' +require('rubygems') +require('erb') -class TOP4R::Meta #:nodoc: +class Top4R::Meta #:nodoc: attr_accessor :root_dir attr_reader :gem_spec, :project_files, :spec_files - # Initializer for TOP4R::Meta class. Takes <tt>root_dir</tt> as parameter. + # Initializer for Twitter::Meta class. Takes <tt>root_dir</tt> as parameter. def initialize(root_dir) @root_dir = root_dir end @@ -38,7 +38,7 @@ class TOP4R::Meta #:nodoc: @spec_files end - # Returns RubyGem specification for TOP4R project + # Returns RubyGem specification for Twitter4R project def gem_spec @gem_spec ||= Gem::Specification.new do |spec| self.spec_info.each do |key, val| lib/top4r/meta.rb @@ -1,27 +1,39 @@ -# Define TOP4R model module - -module TOP4R - # Mixin module for model classes. Includes generic class methods. - # - # To create a new model that includes this mixin's features simply: - # class NewModel - # include TOP4R::ModelMixin - # end - # - # This mixin module automatically includes <tt>TOP4R::ClassUtilMixin</tt> - # features. - # The contract for models to use this mixin correctly is that the class - # including this mixin must provide an class method named <tt>attributes</tt> - # that will return an Array of attribute symbols that will be checked - # in #eql? override method. The following would be sufficient: - # def self.attributes; @@ATTRIBUTES; end +module Top4R module ModelMixin module ClassMethods + def default_public_fields; []; end + + def default_private_fields; []; end + + # Unmarshal object singular or plural array of model objects + # from JSON serialization. Currently JSON is only supported. + def unmarshal(raw) + # input = JSON.parse(raw) + input = raw + # puts "\ninput: #{input.inspect}" + def unmarshal_model(hash) + mine = self.new(hash) + # puts "\n mine: #{mine.inspect}" + mine.unmarshal_other_attrs if mine.respond_to? :unmarshal_other_attrs + mine + end + return unmarshal_model(input) if input.is_a?(Hash) # singular case + result = [] + input.each do |hash| + model = unmarshal_model(hash) if hash.is_a?(Hash) + result << model + end if input.is_a?(Array) + result # plural case + end + def fields + (self.default_public_fields + self.default_private_fields).uniq.join(',') + end end module InstanceMethods attr_accessor :client + # Equality method override of Object#eql? default. # # Relies on the class using this mixin to provide a <tt>attributes</tt> @@ -40,27 +52,60 @@ module TOP4R true end + # Returns integer representation of model object instance. + # + # For example, + # product = Top4R::Product.new(:id => 234343) + # product.to_i #=> 234343 + def to_i + @id + end + + # Returns hash representation of model object instance. + # + # For example, + # u = Top4R::User.new(:id => 2342342, :screen_name => 'tony_blair_is_the_devil') + # u.to_hash #=> {:id => 2342342, :screen_name => 'tony_blair_is_the_devil'} + # + # This method also requires that the class method <tt>attributes</tt> be + # defined to return an Array of attributes for the class. + def to_hash + attrs = self.class.attributes + result = {} + attrs.each do |att| + value = self.send(att) + value = value.to_hash if value.respond_to?(:to_hash) + result[att] = value if value + end + result + end + # "Blesses" model object. - # + # # Should be overridden by model class if special behavior is expected - # + # # Expected to return blessed object (usually <tt>self</tt>) def bless(client) self.basic_bless(client) end protected - # Basic "blessing" of model object + # Basic "blessing" of model object def basic_bless(client) self.client = client self end end - def self.included(base) - base.extend ClassMethods - base.send :include, TOP4R::ClassUtilMixin - base.send :include, InstanceMethods + def self.included(receiver) + receiver.extend ClassMethods + receiver.send :include, Top4R::ClassUtilMixin + receiver.send :include, InstanceMethods end - end -end \ No newline at end of file + end # ModelMixin module +end + +require 'top4r/model/user' +require 'top4r/model/shipping' +require 'top4r/model/trade' +require 'top4r/model/suite' \ No newline at end of file lib/top4r/model.rb @@ -1,19 +1,17 @@ -# version.rb contains <tt>TOP4R::Version</tt> that provides helper -# methods related to versioning of the <tt>TOP4R</tt> project. - -module TOP4R::Version #:nodoc: +module Top4R::Version MAJOR = 0 - MINOR = 1 - REVISION = 0 + MINOR = 0 + REVISION = 1 + class << self # Returns X.Y.Z formatted version string def to_version "#{MAJOR}.#{MINOR}.#{REVISION}" end - + # Returns X-Y-Z formatted version name def to_name "#{MAJOR}_#{MINOR}_#{REVISION}" end end -end +end \ No newline at end of file lib/top4r/version.rb @@ -1,7 +1,7 @@ <% require('pathname') %> spec: name: top4r - version: <%= TOP4R::Version.to_version %> + version: <%= Top4R::Version.to_version %> summary: TOP4R is a library that can help you build plugin for TaoBao.com quickly in pure Ruby. require_path: lib has_rdoc: true pkg-info.yml @@ -1,6 +1,6 @@ require 'rake/gempackagetask' -meta = TOP4R::Meta.new(ROOT_DIR) +meta = Top4R::Meta.new(ROOT_DIR) namespace :package do desc "Create Gem Packages" Rake::GemPackageTask.new(meta.gem_spec) do |pkg| tasks/pkg.rake @@ -1,7 +1,7 @@ -# Generated: Tue Jun 30 14:24:37 UTC 2009 +# Generated: Tue Sep 22 03:19:47 UTC 2009 Gem::Specification.new do |s| s.name = "top4r" - s.version = "0.1.0" + s.version = "0.0.1" s.platform = Gem::Platform::RUBY s.has_rdoc = true s.extra_rdoc_files = ["README","CHANGES","TODO","MIT-LICENSE",] @@ -12,7 +12,7 @@ Gem::Specification.new do |s| s.rubyforge_project = "top4r" s.add_dependency("json", ">=1.1.1") # s.require_path = "lib" - s.files = ["lib/top4r/meta.rb","lib/top4r/model.rb","lib/top4r/version.rb","lib/top4r.rb",] + s.files = ["lib/top4r/client/base.rb","lib/top4r/client/shipping.rb","lib/top4r/client/suite.rb","lib/top4r/client/trade.rb","lib/top4r/client/user.rb","lib/top4r/client.rb","lib/top4r/config.rb","lib/top4r/console.rb","lib/top4r/core.rb","lib/top4r/ext/stdlib.rb","lib/top4r/ext.rb","lib/top4r/meta.rb","lib/top4r/model/shipping.rb","lib/top4r/model/suite.rb","lib/top4r/model/trade.rb","lib/top4r/model/user.rb","lib/top4r/model.rb","lib/top4r/version.rb","lib/top4r.rb",] s.bindir = 'bin' s.executables = ['top4rsh'] end top4r.gemspec ba7d635675f1e91de14b2b500a0169741b271f87 nowa nowazhu@gmail.com http://github.com/nowa/top4r/commit/fc01dab86624c1f1515d7f6b25a40ca0cac2b574 fc01dab86624c1f1515d7f6b25a40ca0cac2b574 2009-09-21T20:21:25-07:00 2009-09-21T20:21:25-07:00 0.0.1 885e2765ef7cb3be894e277cb48c938984d4a21d nowa nowazhu@gmail.com