ebayapi 0.10.1 → 0.10.2

data/examples/get_notifications_usage.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'ebay'
+require 'config'
+
+ebay = Ebay::Api.new
+
+begin
+  response = ebay.get_notifications_usage
+
+  puts "Notifications Usage Counts"
+  puts "--------------------------"
+  puts "Delivered: #{response.notification_statistics.delivered_count}"
+  puts "Expired: #{response.notification_statistics.expired_count}"
+  puts "Queued Pending: #{response.notification_statistics.queued_pending_count}"
+  puts "Queued New: #{response.notification_statistics.queued_new_count}"
+  puts "Error: #{response.notification_statistics.error_count}"
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end

data/examples/get_product_finder_xsl.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'ebay'
+require 'config'
+require 'rexml/document'
+
+ebay = Ebay::Api.new
+
+begin
+  response = ebay.get_product_finder_xsl(:detail_level => 'ReturnAll')
+
+  # There is currently only one stylesheet, but eBay may add more in the future
+  file = response.xsl_files.first
+  puts "Downloaded version #{file.file_version}"
+
+  # Save the downloaded file
+  puts "Saving file to: #{file.file_name}"
+  File.open(file.file_name, 'w') do |f|
+    f.puts file.file_content
+  end
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end
+

data/examples/get_search_results.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__),'..', 'lib')
+
+require 'ebay'
+require 'config'
+
+include Ebay::Types
+
+ebay = Ebay::Api.new
+
+begin
+  
+  # Uncomment the following to add list 13 products to the sandbox
+  # Wait 2 - 3 minutes for the items to be indexed by eBay for searching
+  #1.upto(13) do |i|
+  #  item = Item.new( :primary_category => Category.new(:category_id => 57882),
+  #                 :title => "Ruby eBay API Test Listing #{i}",
+  #                 :description => 'Welcome!',
+  #                 :location => 'Ottawa, On',
+  #                 :start_price => Money.new(1200, 'USD'),
+  #                 :quantity => 1,
+  #                 :listing_duration => 'Days_7',
+  #                 :country => 'US',
+  #                 :currency => 'USD',
+  #                 :payment_methods => ['VisaMC', 'PersonalCheck']
+  #               )
+  #  ebay.add_item(:item => item)
+  #end
+  
+  current_page = 1
+  
+  begin
+    response = ebay.get_search_results(
+      :query => 'ruby', 
+      :pagination => Pagination.new(:entries_per_page => 5, :page_number => current_page)
+    )
+    
+    puts "Page #{response.page_number} of #{response.pagination_result.total_number_of_pages}"
+    response.search_result_items.each do |r|
+      puts r.item.title
+    end
+    
+    current_page += 1
+  end while response.has_more_items
+  
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end

data/examples/get_user.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__),'..', 'lib')
+
+require 'ebay'
+require 'config'
+
+ebay = Ebay::Api.new
+
+begin
+  # Get details about the user passed in as the first argument
+  # You must include an :item_id if you wish to retrieve the user's email address.
+  # You must also be in a transactional relationship with a user to get their
+  # email address
+  response = ebay.get_user(:user_id => ARGV.shift)
+  user = response.user
+  puts "The user's feedback score is: #{user.feedback_score}"
+  puts "The user is registered in #{user.site}"
+  puts "The user is new? #{user.new_user}"
+  puts "The user is in good standing with eBay? #{user.ebay_good_standing}"
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end
+

data/examples/mark_my_messages_message_as_read.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'ebay'
+require 'config'
+
+ebay = Ebay::Api.new
+begin
+  # Mark all message id's as passed in on the command line as read
+  response = ebay.revise_my_messages(
+    :message_ids => ARGV,
+    :read => true
+  # You can also specify a folder to move the messages to
+  #  :folder_id => 2
+  )
+  puts "Successfully marked the messages as read"
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end

data/examples/revise_item.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'ebay'
+require 'config'
+
+ebay = Ebay::Api.new
+
+# Revise the item identified by the item_id passed in on the command line
+item = Ebay::Types::Item.new(
+  :item_id => ARGV.first, 
+  :description => 'Revised Body'
+)
+
+begin
+  response = ebay.revise_item(:item => item)
+  puts "Successfully revised item: #{response.item_id}"
+  puts "Item start time: #{response.start_time}"
+  puts "Item end time: #{response.end_time}"
+
+  # Display any additional fees
+  fees = response.fees.select{|f| !f.fee.zero? }
+
+  if fees.any?
+    puts "Incurred additional fees:"
+    fees.each do |f|
+      puts "  #{f.name}: #{f.fee.format(:with_currency)}"
+    end
+  end
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end

data/examples/set_notification_preferences.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__),'..', 'lib')
+
+require 'ebay'
+require 'config'
+
+ebay = Ebay::Api.new
+
+# Set the 'Disable' to 'Enable' to enable the notifications
+preferences = Ebay::Types::ApplicationDeliveryPreferences.new( 
+  :application_url => 'http://example.com/notify', 
+  :application_enable => 'Disable', 
+  :alert_enable => 'Disable' 
+)
+
+# Disable eBay Platform Notifications at the application level
+begin
+  response = ebay.set_notification_preferences(
+    :application_delivery_preferences => preferences
+  )
+  puts "Successfully disabled application platform notifications: #{response.success?}"
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end

data/examples/verify_add_item.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__),'..', 'lib')
+
+require 'ebay'
+require 'config'
+
+# This is the same as add_item, but doesn't actually list the item
+ebay = Ebay::Api.new
+
+item = Ebay::Types::Item.new(
+  :primary_category => Ebay::Types::Category.new(:category_id => 57882),
+  :title => 'Ruby eBay API Test Listing',
+  :description => 'Welcome!',
+  :location => 'Ottawa, On',
+  :start_price => Money.new(1200, 'USD'),
+  :quantity => 1,
+  :listing_duration => 'Days_7',
+  :country => 'US',
+  :currency => 'USD',
+  :payment_methods => ['VisaMC', 'PersonalCheck']
+)
+
+begin
+  response = ebay.verify_add_item(:item => item)               
+  puts "Verifying item"
+
+  puts "Item ID: #{response.item_id}"
+  puts "Fee summary: "
+  response.fees.select{|f| !f.fee.zero? }.each do |f|
+    puts "  #{f.name}: #{f.fee.format(:with_currency)}"
+  end
+rescue Ebay::RequestError => e
+  e.errors.each do |error|
+    puts error.long_message
+  end
+end

data/lib/ebay/api.rb

@@ -132,12 +132,12 @@ module Ebay #:nodoc:
 
     def build_headers(call_name)
       {
-        'X-EBAY-API-COMPATIBILITY-LEVEL' => schema_version,
+        'X-EBAY-API-COMPATIBILITY-LEVEL' => schema_version.to_s,
         'X-EBAY-API-SESSION-CERTIFICATE' => "#{dev_id};#{app_id};#{cert}",
-        'X-EBAY-API-DEV-NAME' => dev_id,
-        'X-EBAY-API-APP-NAME' => app_id,
-        'X-EBAY-API-CERT-NAME' => cert,
-        'X-EBAY-API-CALL-NAME' => call_name,
+        'X-EBAY-API-DEV-NAME' => dev_id.to_s,
+        'X-EBAY-API-APP-NAME' => app_id.to_s,
+        'X-EBAY-API-CERT-NAME' => cert.to_s,
+        'X-EBAY-API-CALL-NAME' => call_name.to_s,
         'X-EBAY-API-SITEID' => site_id.to_s,
         'Content-Type' => 'text/xml',
         'Accept-Encoding' => 'gzip'

data/lib/ebay/api_methods.rb

@@ -1017,6 +1017,14 @@ module Ebay
     def set_user_preferences(params = {})
       commit(Ebay::Requests::SetUserPreferences, params)
     end
+    # Builds Ebay::Requests#UploadSiteHostedPictures
+    #
+    # Returns Ebay::Responses#UploadSiteHostedPictures
+    #
+    # Official Documentation for UploadSiteHostedPictures[http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/io_UploadSiteHostedPictures.html]
+    def upload_site_hosted_pictures(params = {})
+      commit(Ebay::Requests::UploadSiteHostedPictures, params)
+    end
     # Builds Ebay::Requests#ValidateChallengeInput
     #
     # Returns Ebay::Responses#ValidateChallengeInput

data/lib/ebay/requests.rb

@@ -126,6 +126,7 @@ require 'ebay/requests/set_store_preferences'
 require 'ebay/requests/set_tax_table'
 require 'ebay/requests/set_user_notes'
 require 'ebay/requests/set_user_preferences'
+require 'ebay/requests/upload_site_hosted_pictures'
 require 'ebay/requests/validate_challenge_input'
 require 'ebay/requests/validate_test_user_registration'
 require 'ebay/requests/vero_report_items'

data/lib/ebay/requests/get_category_listings.rb

@@ -1,6 +1,7 @@
 require 'ebay/types/pagination'
 require 'ebay/types/search_location'
 require 'ebay/types/proximity_search'
+require 'ebay/types/group'
 
 module Ebay # :nodoc:
   module Requests # :nodoc:
@@ -22,6 +23,7 @@ module Ebay # :nodoc:
     #  boolean_node :include_feedback, 'IncludeFeedback', 'true', 'false', :optional => true
     #  text_node :local_search_postal_code, 'LocalSearchPostalCode', :optional => true
     #  numeric_node :max_related_search_keywords, 'MaxRelatedSearchKeywords', :optional => true
+    #  object_node :group, 'Group', :class => Group, :optional => true
     class GetCategoryListings < Abstract
       include XML::Mapping
       include Initializer
@@ -43,6 +45,7 @@ module Ebay # :nodoc:
       boolean_node :include_feedback, 'IncludeFeedback', 'true', 'false', :optional => true
       text_node :local_search_postal_code, 'LocalSearchPostalCode', :optional => true
       numeric_node :max_related_search_keywords, 'MaxRelatedSearchKeywords', :optional => true
+      object_node :group, 'Group', :class => Group, :optional => true
     end
   end
 end

data/lib/ebay/requests/get_my_ebay_buying.rb

@@ -1,5 +1,6 @@
 require 'ebay/types/item_list_customization'
 require 'ebay/types/my_ebay_selection'
+require 'ebay/types/bid_assistant_list'
 
 module Ebay # :nodoc:
   module Requests # :nodoc:
@@ -12,6 +13,7 @@ module Ebay # :nodoc:
     #  object_node :favorite_searches, 'FavoriteSearches', :class => MyeBaySelection, :optional => true
     #  object_node :favorite_sellers, 'FavoriteSellers', :class => MyeBaySelection, :optional => true
     #  object_node :second_chance_offer, 'SecondChanceOffer', :class => MyeBaySelection, :optional => true
+    #  object_node :bid_assistant_list, 'BidAssistantList', :class => BidAssistantList, :optional => true
     class GetMyeBayBuying < Abstract
       include XML::Mapping
       include Initializer
@@ -24,6 +26,7 @@ module Ebay # :nodoc:
       object_node :favorite_searches, 'FavoriteSearches', :class => MyeBaySelection, :optional => true
       object_node :favorite_sellers, 'FavoriteSellers', :class => MyeBaySelection, :optional => true
       object_node :second_chance_offer, 'SecondChanceOffer', :class => MyeBaySelection, :optional => true
+      object_node :bid_assistant_list, 'BidAssistantList', :class => BidAssistantList, :optional => true
     end
   end
 end

data/lib/ebay/requests/get_search_results.rb

@@ -8,6 +8,9 @@ require 'ebay/types/search_request'
 require 'ebay/types/external_product_id'
 require 'ebay/types/request_categories'
 require 'ebay/types/affiliate_tracking_details'
+require 'ebay/types/bid_range'
+require 'ebay/types/ticket_details'
+require 'ebay/types/group'
 
 module Ebay # :nodoc:
   module Requests # :nodoc:
@@ -50,6 +53,10 @@ module Ebay # :nodoc:
     #  text_node :local_search_postal_code, 'LocalSearchPostalCode', :optional => true
     #  numeric_node :max_related_search_keywords, 'MaxRelatedSearchKeywords', :optional => true
     #  object_node :affiliate_tracking_details, 'AffiliateTrackingDetails', :class => AffiliateTrackingDetails, :optional => true
+    #  object_node :bid_range, 'BidRange', :class => BidRange, :optional => true
+    #  text_node :item_condition, 'ItemCondition', :optional => true
+    #  object_node :ticket_finder, 'TicketFinder', :class => TicketDetails, :optional => true
+    #  object_node :group, 'Group', :class => Group, :optional => true
     class GetSearchResults < Abstract
       include XML::Mapping
       include Initializer
@@ -92,6 +99,10 @@ module Ebay # :nodoc:
       text_node :local_search_postal_code, 'LocalSearchPostalCode', :optional => true
       numeric_node :max_related_search_keywords, 'MaxRelatedSearchKeywords', :optional => true
       object_node :affiliate_tracking_details, 'AffiliateTrackingDetails', :class => AffiliateTrackingDetails, :optional => true
+      object_node :bid_range, 'BidRange', :class => BidRange, :optional => true
+      text_node :item_condition, 'ItemCondition', :optional => true
+      object_node :ticket_finder, 'TicketFinder', :class => TicketDetails, :optional => true
+      object_node :group, 'Group', :class => Group, :optional => true
     end
   end
 end

data/lib/ebay/requests/set_shipping_discount_profiles.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/flat_shipping_discount'
 require 'ebay/types/calculated_shipping_discount'
 require 'ebay/types/calculated_handling_discount'
-require 'ebay/types/promotional_shipping_discount'
+require 'ebay/types/promotional_shipping_discount_details'
 require 'ebay/types/shipping_insurance'
 
 module Ebay # :nodoc:
@@ -13,7 +13,7 @@ module Ebay # :nodoc:
     #  object_node :flat_shipping_discount, 'FlatShippingDiscount', :class => FlatShippingDiscount, :optional => true
     #  object_node :calculated_shipping_discount, 'CalculatedShippingDiscount', :class => CalculatedShippingDiscount, :optional => true
     #  object_node :calculated_handling_discount, 'CalculatedHandlingDiscount', :class => CalculatedHandlingDiscount, :optional => true
-    #  object_node :promotional_shipping_discount, 'PromotionalShippingDiscount', :class => PromotionalShippingDiscount, :optional => true
+    #  object_node :promotional_shipping_discount_details, 'PromotionalShippingDiscountDetails', :class => PromotionalShippingDiscountDetails, :optional => true
     #  object_node :shipping_insurance, 'ShippingInsurance', :class => ShippingInsurance, :optional => true
     #  object_node :international_shipping_insurance, 'InternationalShippingInsurance', :class => ShippingInsurance, :optional => true
     class SetShippingDiscountProfiles < Abstract
@@ -26,7 +26,7 @@ module Ebay # :nodoc:
       object_node :flat_shipping_discount, 'FlatShippingDiscount', :class => FlatShippingDiscount, :optional => true
       object_node :calculated_shipping_discount, 'CalculatedShippingDiscount', :class => CalculatedShippingDiscount, :optional => true
       object_node :calculated_handling_discount, 'CalculatedHandlingDiscount', :class => CalculatedHandlingDiscount, :optional => true
-      object_node :promotional_shipping_discount, 'PromotionalShippingDiscount', :class => PromotionalShippingDiscount, :optional => true
+      object_node :promotional_shipping_discount_details, 'PromotionalShippingDiscountDetails', :class => PromotionalShippingDiscountDetails, :optional => true
       object_node :shipping_insurance, 'ShippingInsurance', :class => ShippingInsurance, :optional => true
       object_node :international_shipping_insurance, 'InternationalShippingInsurance', :class => ShippingInsurance, :optional => true
     end

data/lib/ebay/requests/upload_site_hosted_pictures.rb

@@ -0,0 +1,22 @@
+require 'ebay/types/base64_binary'
+
+module Ebay # :nodoc:
+  module Requests # :nodoc:
+    # == Attributes
+    #  text_node :picture_name, 'PictureName', :optional => true
+    #  numeric_node :picture_system_version, 'PictureSystemVersion', :optional => true
+    #  text_node :picture_set, 'PictureSet', :optional => true
+    #  object_node :picture_data, 'PictureData', :class => Base64Binary, :optional => true
+    class UploadSiteHostedPictures < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'UploadSiteHostedPicturesRequest'
+      text_node :picture_name, 'PictureName', :optional => true
+      numeric_node :picture_system_version, 'PictureSystemVersion', :optional => true
+      text_node :picture_set, 'PictureSet', :optional => true
+      object_node :picture_data, 'PictureData', :class => Base64Binary, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/responses.rb

@@ -126,6 +126,7 @@ require 'ebay/responses/set_store_preferences'
 require 'ebay/responses/set_tax_table'
 require 'ebay/responses/set_user_notes'
 require 'ebay/responses/set_user_preferences'
+require 'ebay/responses/upload_site_hosted_pictures'
 require 'ebay/responses/validate_challenge_input'
 require 'ebay/responses/validate_test_user_registration'
 require 'ebay/responses/vero_report_items'

data/lib/ebay/responses/get_my_ebay_buying.rb

@@ -4,6 +4,7 @@ require 'ebay/types/paginated_order_transaction_array'
 require 'ebay/types/my_ebay_favorite_search_list'
 require 'ebay/types/my_ebay_favorite_seller_list'
 require 'ebay/types/item'
+require 'ebay/types/bid_group'
 
 module Ebay # :nodoc:
   module Responses # :nodoc:
@@ -17,6 +18,7 @@ module Ebay # :nodoc:
     #  object_node :favorite_searches, 'FavoriteSearches', :class => MyeBayFavoriteSearchList, :optional => true
     #  object_node :favorite_sellers, 'FavoriteSellers', :class => MyeBayFavoriteSellerList, :optional => true
     #  array_node :second_chance_offers, 'SecondChanceOffer', :class => Item, :default_value => []
+    #  array_node :bid_assistant_lists, 'BidAssistantList', 'BidGroup', :class => BidGroup, :default_value => []
     class GetMyeBayBuying < Abstract
       include XML::Mapping
       include Initializer
@@ -30,6 +32,7 @@ module Ebay # :nodoc:
       object_node :favorite_searches, 'FavoriteSearches', :class => MyeBayFavoriteSearchList, :optional => true
       object_node :favorite_sellers, 'FavoriteSellers', :class => MyeBayFavoriteSellerList, :optional => true
       array_node :second_chance_offers, 'SecondChanceOffer', :class => Item, :default_value => []
+      array_node :bid_assistant_lists, 'BidAssistantList', 'BidGroup', :class => BidGroup, :default_value => []
     end
   end
 end