ebayapi 0.10.2 → 0.11.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+# * Remove dependency of project on ActiveSupport and update Rakefile for release 0.11.0
+# * Remove dependency on ActiveSupport from TimeNode
+# * Update to eBay XML Schema Version 531
+# * Fix the money node to add the item amount as a float in dollars
+# * Update to eBay XML Schema Version 529
+# * Update to eBay XML Schema Version 517
+# * Update the end_item example to include the ending reason
 # * Update the Rakefile to include the examples, set version 0.10.2
 # * Update to eBay XML Schema Version 513
 # * Ensure that nil values aren't used as headers in the HTTP request

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "0.10.2"
+PKG_VERSION = "0.11.0"
 PKG_NAME = "ebayapi"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
@@ -17,78 +17,80 @@ PKG_FILES = FileList[
 response_dir = File.join(File.dirname(__FILE__), 'test', 'fixtures', 'responses')
 
 desc "Default: Run all the unit tests"
-task :default => [ :test ]
-
-desc 'Run all unit tests.'
-Rake::TestTask.new do |t|
-  t.libs << "test"
-	t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+task :default => [ 'test:units' ]
+
+namespace :test do
+  desc 'Run all unit tests.'
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+  	t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+  
+  desc 'Run all unit tests.'
+  Rake::TestTask.new(:mapping) do |t|
+    t.libs << "test"
+  	t.pattern = 'test/mapping/**/*_test.rb'
+    t.verbose = true
+  end
 end
 
 desc "Delete tar.gz / zip / rdoc"
 task :cleanup => [ :clobber_package, :clobber_rdoc ]
 
-desc 'Get the latest version of the eBay XML schema'
-task :update_schema do
-  puts 'Updating the eBay schema'
+namespace :schema do
+  desc 'Get the latest version of the eBay XML schema'
+  task :update do
+    puts 'Updating the eBay schema'
   
-  folder = File.dirname(__FILE__) + "/lib/ebay/schema"
-  url = 'http://developer.ebay.com/webservices/latest/ebaySvc.xsd'
+    folder = File.dirname(__FILE__) + "/lib/ebay/schema"
+    url = 'http://developer.ebay.com/webservices/latest/ebaySvc.xsd'
 
-  cd folder do
-    rm_f 'ebaySvc.xsd'
-    system("wget #{url}")
+    cd folder do
+      rm_f 'ebaySvc.xsd'
+      system("wget #{url}")
+    end
   end
-end
+  
+  desc "Update the schema version"
+  task :update_version do
+    schema = File.dirname(__FILE__) + '/lib/ebay/schema/ebaySvc.xsd'
+    # Update the schema version string
+    version = File.open(schema) do |f|
+      version_string = f.gets
+      version_string.match(/Version (\d+)/)
+      $1
+    end
 
-desc "Remove the generated Ruby classes"
-task :clean_classes do
-  folder = File.dirname(__FILE__) + '/lib/ebay'
-  folders = %w( responses requests types )
-  cd folder do
-    rm_rf 'requests.rb'
-    rm_rf 'responses.rb'
-    rm_rf 'types.rb'
-    folders.each do |f|
-      cd f do
-        rm_rf '*.rb'
-      end
+    version_file_path = File.dirname(__FILE__) + "/lib/ebay/schema/version.rb"
+    version_file = File.read(version_file_path)
+    version_file.gsub!(/VERSION = \d+/, "VERSION = #{version}")
+    File.open(version_file_path, 'w') do |f|
+      f.puts version_file
     end
   end
-end 
-
-desc "Generate Ruby classes from the schema and updates the schema version"
-task :generate_classes_with_version => [:generate_classes, :update_schema_version]
-
-desc "Generate Ruby classes from the schema file"
-task :generate_classes => :clean_classes do
-  require 'ebay'
-  require 'ebay/schema/mapper'
-  %w(requests responses types).each do |dir|
-    folder = File.dirname(__FILE__) + "/lib/ebay/#{dir}"
-    Dir.mkdir(folder) unless File.directory?(folder)
-  end
-  schema = File.dirname(__FILE__) + '/lib/ebay/schema/ebaySvc.xsd'
-  data = File.read(schema)
-  Ebay::Schema::XSD2eBay.run(data, File.dirname(__FILE__) + '/lib/ebay')
+  
 end
 
-desc "Update the schema version"
-task :update_schema_version do
-  schema = File.dirname(__FILE__) + '/lib/ebay/schema/ebaySvc.xsd'
-  # Update the schema version string
-  version = File.open(schema) do |f|
-    version_string = f.gets
-    version_string.match(/Version (\d+)/)
-    $1
-  end
-
-  version_file_path = File.dirname(__FILE__) + "/lib/ebay/schema/version.rb"
-  version_file = File.read(version_file_path)
-  version_file.gsub!(/VERSION = \d+/, "VERSION = #{version}")
-  File.open(version_file_path, 'w') do |f|
-    f.puts version_file
+namespace :classes do
+  desc "Remove the generated Ruby classes"
+  task :cleanup do
+    FileList[
+      "lib/ebay/requests.rb", "lib/ebay/responses.rb", "lib/ebay/types.rb", "lib/ebay/requests/*.rb", "lib/ebay/responses/*.rb", "lib/ebay/types/*.rb"
+    ].each{|f| rm_rf f }
+  end 
+  
+  desc "Generate Ruby classes from the schema file and updates the schema version"
+  task :generate => [:cleanup, 'schema:update_version'] do
+    require 'ebay'
+    require 'ebay/schema/mapper'
+    %w(requests responses types).each do |dir|
+      folder = File.dirname(__FILE__) + "/lib/ebay/#{dir}"
+      Dir.mkdir(folder) unless File.directory?(folder)
+    end
+    schema = File.dirname(__FILE__) + '/lib/ebay/schema/ebaySvc.xsd'
+    data = File.read(schema)
+    Ebay::Schema::XSD2eBay.run(data, File.dirname(__FILE__) + '/lib/ebay')
   end
 end
 
@@ -113,7 +115,6 @@ spec = Gem::Specification.new do |s|
   s.email = "codyfauser@gmail.com"
   s.homepage = "http://ebayapi.rubyforge.org"
   s.add_dependency('xml-mapping', '>= 0.8.1')
-  s.add_dependency('activesupport', '>= 1.3.1')
   s.add_dependency('money', '>= 1.7.1')
 end
 

data/examples/end_item.rb

@@ -5,11 +5,13 @@ $:.unshift File.join(File.dirname(__FILE__),'..', 'lib')
 require 'ebay'
 require 'config'
 
+include Ebay::Types
+
 ebay = Ebay::Api.new
 
 begin
   # End the item as passed in as the first argument
-  response = ebay.end_item(:item_id => ARGV.first)
+  response = ebay.end_item(:item_id => ARGV.first, :ending_reason => EndReasonCode::LostOrBroken)
   puts "Successfully ended item #{ARGV.first}"
 rescue Ebay::RequestError => e
   e.errors.each do |error|

data/lib/ebay.rb

@@ -1,12 +1,5 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-begin
-  require 'active_support'
-rescue LoadError
-  require 'rubygems'
-  require 'active_support'
-end
-
 begin
   require 'xml/mapping'
 rescue LoadError

data/lib/ebay/api_methods.rb

@@ -225,14 +225,6 @@ module Ebay
     def get_category2_cs(params = {})
       commit(Ebay::Requests::GetCategory2CS, params)
     end
-    # Builds Ebay::Requests#GetCategory2FinanceOffer
-    #
-    # Returns Ebay::Responses#GetCategory2FinanceOffer
-    #
-    # Official Documentation for GetCategory2FinanceOffer[http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/io_GetCategory2FinanceOffer.html]
-    def get_category2_finance_offer(params = {})
-      commit(Ebay::Requests::GetCategory2FinanceOffer, params)
-    end
     # Builds Ebay::Requests#GetCategoryFeatures
     #
     # Returns Ebay::Responses#GetCategoryFeatures
@@ -257,6 +249,14 @@ module Ebay
     def get_category_mappings(params = {})
       commit(Ebay::Requests::GetCategoryMappings, params)
     end
+    # Builds Ebay::Requests#GetCategorySpecifics
+    #
+    # Returns Ebay::Responses#GetCategorySpecifics
+    #
+    # Official Documentation for GetCategorySpecifics[http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/io_GetCategorySpecifics.html]
+    def get_category_specifics(params = {})
+      commit(Ebay::Requests::GetCategorySpecifics, params)
+    end
     # Builds Ebay::Requests#GetChallengeToken
     #
     # Returns Ebay::Responses#GetChallengeToken
@@ -313,14 +313,6 @@ module Ebay
     def get_feedback(params = {})
       commit(Ebay::Requests::GetFeedback, params)
     end
-    # Builds Ebay::Requests#GetFinanceOffers
-    #
-    # Returns Ebay::Responses#GetFinanceOffers
-    #
-    # Official Documentation for GetFinanceOffers[http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/io_GetFinanceOffers.html]
-    def get_finance_offers(params = {})
-      commit(Ebay::Requests::GetFinanceOffers, params)
-    end
     # Builds Ebay::Requests#GetHighBidders
     #
     # Returns Ebay::Responses#GetHighBidders
@@ -921,14 +913,6 @@ module Ebay
     def set_picture_manager_details(params = {})
       commit(Ebay::Requests::SetPictureManagerDetails, params)
     end
-    # Builds Ebay::Requests#SetPromotionRules
-    #
-    # Returns Ebay::Responses#SetPromotionRules
-    #
-    # Official Documentation for SetPromotionRules[http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/io_SetPromotionRules.html]
-    def set_promotion_rules(params = {})
-      commit(Ebay::Requests::SetPromotionRules, params)
-    end
     # Builds Ebay::Requests#SetPromotionalSale
     #
     # Returns Ebay::Responses#SetPromotionalSale

data/lib/ebay/inflections.rb

@@ -1,3 +1,4 @@
+# Based on code from ActiveSupport
 module Ebay
   module Inflections
     UPCASE_TOKENS = /(Id$|Cs|Xsl|Url|Rtq|Aaq)/

data/lib/ebay/requests.rb

@@ -27,10 +27,10 @@ require 'ebay/requests/get_bidder_list'
 require 'ebay/requests/get_cart'
 require 'ebay/requests/get_categories'
 require 'ebay/requests/get_category2_cs'
-require 'ebay/requests/get_category2_finance_offer'
 require 'ebay/requests/get_category_features'
 require 'ebay/requests/get_category_listings'
 require 'ebay/requests/get_category_mappings'
+require 'ebay/requests/get_category_specifics'
 require 'ebay/requests/get_challenge_token'
 require 'ebay/requests/get_charities'
 require 'ebay/requests/get_contextual_keywords'
@@ -38,7 +38,6 @@ require 'ebay/requests/get_cross_promotions'
 require 'ebay/requests/get_description_templates'
 require 'ebay/requests/get_dispute'
 require 'ebay/requests/get_feedback'
-require 'ebay/requests/get_finance_offers'
 require 'ebay/requests/get_high_bidders'
 require 'ebay/requests/get_item'
 require 'ebay/requests/get_item_recommendations'
@@ -114,7 +113,6 @@ require 'ebay/requests/set_cart'
 require 'ebay/requests/set_message_preferences'
 require 'ebay/requests/set_notification_preferences'
 require 'ebay/requests/set_picture_manager_details'
-require 'ebay/requests/set_promotion_rules'
 require 'ebay/requests/set_promotional_sale'
 require 'ebay/requests/set_promotional_sale_listings'
 require 'ebay/requests/set_return_url'

data/lib/ebay/requests/abstract.rb

@@ -1,4 +1,5 @@
 require 'ebay/types/xml_requester_credentials'
+require 'ebay/types/bot_block_request'
 
 module Ebay # :nodoc:
   module Requests # :nodoc:
@@ -7,10 +8,12 @@ module Ebay # :nodoc:
     #  text_node :error_language, 'ErrorLanguage', :optional => true
     #  text_node :message_id, 'MessageID', :optional => true
     #  text_node :version, 'Version', :optional => true
+    #  text_node :end_user_ip, 'EndUserIP', :optional => true
     #  object_node :requester_credentials, 'RequesterCredentials', :class => XMLRequesterCredentials, :optional => true
     #  text_node :error_handling, 'ErrorHandling', :optional => true
     #  text_node :invocation_id, 'InvocationID', :optional => true
     #  text_node :warning_level, 'WarningLevel', :optional => true
+    #  object_node :bot_block, 'BotBlock', :class => BotBlockRequest, :optional => true
     class Abstract < Base
       include XML::Mapping
       include Initializer
@@ -19,10 +22,12 @@ module Ebay # :nodoc:
       text_node :error_language, 'ErrorLanguage', :optional => true
       text_node :message_id, 'MessageID', :optional => true
       text_node :version, 'Version', :optional => true
+      text_node :end_user_ip, 'EndUserIP', :optional => true
       object_node :requester_credentials, 'RequesterCredentials', :class => XMLRequesterCredentials, :optional => true
       text_node :error_handling, 'ErrorHandling', :optional => true
       text_node :invocation_id, 'InvocationID', :optional => true
       text_node :warning_level, 'WarningLevel', :optional => true
+      object_node :bot_block, 'BotBlock', :class => BotBlockRequest, :optional => true
       # eBay specifies the detail level as a collection.  The usual case is to use
       # only a single detail level, so it is more appropriate to add an accessor for 
       # the normal case.

data/lib/ebay/requests/fetch_token.rb

@@ -3,11 +3,13 @@ module Ebay # :nodoc:
   module Requests # :nodoc:
     # == Attributes
     #  text_node :secret_id, 'SecretID', :optional => true
+    #  boolean_node :include_rest_token, 'IncludeRESTToken', 'true', 'false', :optional => true
     class FetchToken < Abstract
       include XML::Mapping
       include Initializer
       root_element_name 'FetchTokenRequest'
       text_node :secret_id, 'SecretID', :optional => true
+      boolean_node :include_rest_token, 'IncludeRESTToken', 'true', 'false', :optional => true
     end
   end
 end

data/lib/ebay/requests/get_category_specifics.rb

@@ -0,0 +1,23 @@
+
+module Ebay # :nodoc:
+  module Requests # :nodoc:
+    # == Attributes
+    #  text_node :category_id, 'CategoryID', :optional => true
+    #  time_node :last_update_time, 'LastUpdateTime', :optional => true
+    #  numeric_node :max_names, 'MaxNames', :optional => true
+    #  numeric_node :max_values_per_name, 'MaxValuesPerName', :optional => true
+    #  text_node :name, 'Name', :optional => true
+    class GetCategorySpecifics < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'GetCategorySpecificsRequest'
+      text_node :category_id, 'CategoryID', :optional => true
+      time_node :last_update_time, 'LastUpdateTime', :optional => true
+      numeric_node :max_names, 'MaxNames', :optional => true
+      numeric_node :max_values_per_name, 'MaxValuesPerName', :optional => true
+      text_node :name, 'Name', :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/get_item.rb

@@ -6,6 +6,7 @@ module Ebay # :nodoc:
     #  boolean_node :include_express_requirements, 'IncludeExpressRequirements', 'true', 'false', :optional => true
     #  boolean_node :include_watch_count, 'IncludeWatchCount', 'true', 'false', :optional => true
     #  boolean_node :include_cross_promotion, 'IncludeCrossPromotion', 'true', 'false', :optional => true
+    #  boolean_node :include_item_specifics, 'IncludeItemSpecifics', 'true', 'false', :optional => true
     class GetItem < Abstract
       include XML::Mapping
       include Initializer
@@ -14,6 +15,7 @@ module Ebay # :nodoc:
       boolean_node :include_express_requirements, 'IncludeExpressRequirements', 'true', 'false', :optional => true
       boolean_node :include_watch_count, 'IncludeWatchCount', 'true', 'false', :optional => true
       boolean_node :include_cross_promotion, 'IncludeCrossPromotion', 'true', 'false', :optional => true
+      boolean_node :include_item_specifics, 'IncludeItemSpecifics', 'true', 'false', :optional => true
     end
   end
 end

data/lib/ebay/requests/get_item_transactions.rb

@@ -10,6 +10,7 @@ module Ebay # :nodoc:
     #  object_node :pagination, 'Pagination', :class => Pagination, :optional => true
     #  boolean_node :include_final_value_fee, 'IncludeFinalValueFee', 'true', 'false', :optional => true
     #  boolean_node :include_containing_order, 'IncludeContainingOrder', 'true', 'false', :optional => true
+    #  text_node :platform, 'Platform', :optional => true
     class GetItemTransactions < Abstract
       include XML::Mapping
       include Initializer
@@ -21,6 +22,7 @@ module Ebay # :nodoc:
       object_node :pagination, 'Pagination', :class => Pagination, :optional => true
       boolean_node :include_final_value_fee, 'IncludeFinalValueFee', 'true', 'false', :optional => true
       boolean_node :include_containing_order, 'IncludeContainingOrder', 'true', 'false', :optional => true
+      text_node :platform, 'Platform', :optional => true
     end
   end
 end

data/lib/ebay/requests/get_order_transactions.rb

@@ -5,12 +5,14 @@ module Ebay # :nodoc:
     # == Attributes
     #  array_node :item_transaction_ids, 'ItemTransactionIDArray', 'ItemTransactionID', :class => ItemTransactionID, :default_value => []
     #  value_array_node :order_ids, 'OrderIDArray', 'OrderID', :default_value => []
+    #  text_node :platform, 'Platform', :optional => true
     class GetOrderTransactions < Abstract
       include XML::Mapping
       include Initializer
       root_element_name 'GetOrderTransactionsRequest'
       array_node :item_transaction_ids, 'ItemTransactionIDArray', 'ItemTransactionID', :class => ItemTransactionID, :default_value => []
       value_array_node :order_ids, 'OrderIDArray', 'OrderID', :default_value => []
+      text_node :platform, 'Platform', :optional => true
     end
   end
 end

data/lib/ebay/requests/get_seller_transactions.rb

@@ -9,6 +9,7 @@ module Ebay # :nodoc:
     #  boolean_node :include_final_value_fee, 'IncludeFinalValueFee', 'true', 'false', :optional => true
     #  boolean_node :include_containing_order, 'IncludeContainingOrder', 'true', 'false', :optional => true
     #  value_array_node :skus, 'SKUArray', 'SKU', :default_value => []
+    #  text_node :platform, 'Platform', :optional => true
     class GetSellerTransactions < Abstract
       include XML::Mapping
       include Initializer
@@ -19,6 +20,7 @@ module Ebay # :nodoc:
       boolean_node :include_final_value_fee, 'IncludeFinalValueFee', 'true', 'false', :optional => true
       boolean_node :include_containing_order, 'IncludeContainingOrder', 'true', 'false', :optional => true
       value_array_node :skus, 'SKUArray', 'SKU', :default_value => []
+      text_node :platform, 'Platform', :optional => true
     end
   end
 end

data/lib/ebay/requests/get_store.rb

@@ -5,6 +5,7 @@ module Ebay # :nodoc:
     #  boolean_node :category_structure_only, 'CategoryStructureOnly', 'true', 'false', :optional => true
     #  numeric_node :root_category_id, 'RootCategoryID', :optional => true
     #  numeric_node :level_limit, 'LevelLimit', :optional => true
+    #  text_node :user_id, 'UserID', :optional => true
     class GetStore < Abstract
       include XML::Mapping
       include Initializer
@@ -12,6 +13,7 @@ module Ebay # :nodoc:
       boolean_node :category_structure_only, 'CategoryStructureOnly', 'true', 'false', :optional => true
       numeric_node :root_category_id, 'RootCategoryID', :optional => true
       numeric_node :level_limit, 'LevelLimit', :optional => true
+      text_node :user_id, 'UserID', :optional => true
     end
   end
 end

data/lib/ebay/requests/place_offer.rb

@@ -1,4 +1,5 @@
 require 'ebay/types/offer'
+require 'ebay/types/affiliate_tracking_details'
 
 module Ebay # :nodoc:
   module Requests # :nodoc:
@@ -6,6 +7,7 @@ module Ebay # :nodoc:
     #  object_node :offer, 'Offer', :class => Offer, :optional => true
     #  text_node :item_id, 'ItemID', :optional => true
     #  boolean_node :block_on_warning, 'BlockOnWarning', 'true', 'false', :optional => true
+    #  object_node :affiliate_tracking_details, 'AffiliateTrackingDetails', :class => AffiliateTrackingDetails, :optional => true
     class PlaceOffer < Abstract
       include XML::Mapping
       include Initializer
@@ -13,6 +15,7 @@ module Ebay # :nodoc:
       object_node :offer, 'Offer', :class => Offer, :optional => true
       text_node :item_id, 'ItemID', :optional => true
       boolean_node :block_on_warning, 'BlockOnWarning', 'true', 'false', :optional => true
+      object_node :affiliate_tracking_details, 'AffiliateTrackingDetails', :class => AffiliateTrackingDetails, :optional => true
     end
   end
 end