ebay4r 2.1

data/examples/get_categories.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# $Id: get_categories.rb,v 1.2 2006/01/16 09:52:56 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eBayAPI'
+
+#
+# Example of GetCategories call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true)
+
+# Call "GetCategories"
+resp = eBay.GetCategories(:DetailLevel => 'ReturnAll', # Return all available info
+                          :CategorySideID => 0,        # US site
+                          :LevelLimit => 1)            # Only 1 level deep
+
+# Report results
+
+puts "eBay Top Level Categories for US site (Cat. Version " + resp.categoryVersion + "):"
+puts ""
+
+resp.categoryArray.each do |cat|
+  puts "  Category Name : " + cat.categoryName
+  puts "  Category ID   : " + cat.categoryID
+  puts "  Category Level: " + cat.categoryLevel.to_s
+  puts "  Is Leaf?      : " + cat.leafCategory.to_s
+  puts "  Parent ID     : " + cat.categoryParentID.to_s
+  puts ""
+end

data/examples/get_categories2.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# $Id: get_categories2.rb,v 1.3 2006/01/16 09:54:08 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eBayAPI'
+
+#
+# Example of GetCategories call for eBay Motors
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true, :site_id => 100)
+
+# Call "GetCategories"
+resp = eBay.GetCategories(:DetailLevel => 'ReturnAll', # Return all available info
+                          :CategorySideID => 100,      # US eBay Motors Site 
+                          :LevelLimit => 2)            # 2 Levels Deep
+
+# Report results
+
+puts "eBay Motors Top Level Categories (Cat. Version " + resp.categoryVersion + "):"
+puts ""
+
+resp.categoryArray.each do |cat|
+  puts "  Category Name : " + cat.categoryName
+  puts "  Category ID   : " + cat.categoryID
+  puts "  Category Level: " + cat.categoryLevel.to_s
+  puts "  Is Leaf?      : " + cat.leafCategory.to_s
+  puts "  Parent ID     : " + cat.categoryParentID.to_s
+  puts ""
+end

data/examples/get_category_features.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# $Id: get_category_features.rb,v 1.1 2006/04/30 07:37:52 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eBayAPI'
+
+#
+# Example of GetCategoryFeatures call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true)
+
+# Call "GetCategoryFeatures"
+resp = eBay.GetCategoryFeatures(:DetailLevel => 'ReturnAll', # Return all available info
+                                :CategoryID  => '1',
+                                :FeatureID   => 'ListingDurations') # Tell us about listing durations
+
+# Report results
+
+durationHash = {}
+
+[resp.featureDefinitions.listingDurations.listingDuration].flatten.each do |ld|
+  durationHash[ld.xmlattr_durationSetID] = ld.duration
+end
+
+puts "Site wide defaults for listing durations given listing type:\n\n"
+
+[resp.siteDefaults.listingDuration].flatten.each do |duration|
+  puts duration.xmlattr_type # This is an example of how we read an XML attribute, just prepend "xmlattr_" to the name
+  [durationHash[duration.to_i]].flatten.each do |c|
+    puts "  " + c 
+  end
+end

data/examples/get_ebay_details.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# $Id: get_ebay_details.rb,v 1.1 2006/05/01 09:32:17 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eBayAPI'
+
+#
+# Example of GeteBayDetails call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true)
+
+# Call "GeteBayDetails"
+resp = eBay.GeteBayDetails(:DetailName => ['ShippingLocationDetails', 'ShippingServiceDetails'])
+
+# Report results
+
+if resp.respond_to? 'shippingLocationDetails'
+  puts "Seller Ship-To choices:\n\n"
+
+  [resp.shippingLocationDetails].flatten.each do |s|
+    puts s.shippingLocation + ": " + s.description
+  end
+
+  puts "\n"
+end
+
+if resp.respond_to? 'shippingServiceDetails'
+  puts "Shipping service codes:\n\n"
+
+  [resp.shippingServiceDetails].flatten.each do |s|
+    puts s.shippingService + ": " + s.description + " (" + s.shippingServiceID.to_s + ")"
+  end
+end

data/examples/get_feedback.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# $Id: get_feedback.rb,v 1.3 2006/01/25 08:38:42 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'eBayAPI'
+
+#
+# Example of GetFeedback call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true) 
+
+resp = eBay.GetFeedback # No arguments = current user, otherwise pass :UserID
+
+puts "Aggregate Feedback Score: #{resp.feedbackScore}"
+puts "Neutral Comment Count from Suspended Users: #{resp.feedbackSummary.neutralCommentCountFromSuspendedUsers}"
+puts "Unique Positive Feedbacks: #{resp.feedbackSummary.uniquePositiveFeedbackCount}"
+puts "Unique Negative Feedbacks: #{resp.feedbackSummary.uniqueNegativeFeedbackCount}"
+
+puts "Bid Retractions:"
+resp.feedbackSummary.bidRetractionFeedbackPeriodArray.each do |fb|
+  puts "  Last #{fb.periodInDays} Days: #{fb.count}"
+end
+
+puts "Positive Feedback:"
+resp.feedbackSummary.positiveFeedbackPeriodArray.each do |fb|
+  puts "  Last #{fb.periodInDays} Days: #{fb.count}"
+end
+
+puts "Negative Feedback:"
+resp.feedbackSummary.negativeFeedbackPeriodArray.each do |fb|
+  puts "  Last #{fb.periodInDays} Days: #{fb.count}"
+end
+
+puts "Neutral Feedback:"
+resp.feedbackSummary.neutralFeedbackPeriodArray.each do |fb|
+  puts "  Last #{fb.periodInDays} Days: #{fb.count}"
+end
+
+puts "Total Feedback:"
+resp.feedbackSummary.totalFeedbackPeriodArray.each do |fb|
+  puts "  Last #{fb.periodInDays} Days: #{fb.count}"
+end
+

data/examples/get_item.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# $Id: get_item.rb,v 1.6 2006/01/07 01:29:55 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'eBayAPI'
+
+load('myCredentials.rb')
+
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true)
+
+# Replace ItemID with some item you know exists
+resp = eBay.GetItem(:DetailLevel => 'ReturnAll', :ItemID => '110029878327', :IncludeWatchCount => 'true')
+
+puts "AutoPay: "  + resp.item.autoPay.to_s
+puts "Country: "  + resp.item.country
+puts "ItemID: "   + resp.item.itemID.to_s
+puts "Descr: "    + resp.item.description
+puts "Location: " + resp.item.location
+
+puts "Ship To Locations:"
+resp.item.shipToLocations.each { |loc| puts loc }
+
+# Many more fields are present, see eBay's SOAP API Guide or GetItemResponseType class in "../lib/eBay.rb"
+

data/examples/get_notification_preferences.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'eBayAPI'
+
+#
+# Example of GetNotificationPreferences call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true) 
+
+resp = eBay.GetNotificationPreferences(:PreferenceLevel => 'User')
+
+if resp.respond_to?('userDeliveryPreferenceArray') && resp.userDeliveryPreferenceArray
+  resp.userDeliveryPreferenceArray.each do |pref|
+    puts "Event Enable: " + pref.eventEnable
+    puts "Event Type: " + pref.eventType
+  end
+end
+
+begin
+  resp = eBay.GetNotificationPreferences(:PreferenceLevel => 'Application')
+  
+  if resp.respond_to?('applicationDeliveryPreferences')
+    [resp.applicationDeliveryPreferences].flatten.each do |pref|
+      puts "Alert Email: " + pref.alertEmail.to_s if pref.respond_to? 'alertEmail'
+      puts "Alert Enable: " + pref.alertEnable if pref.respond_to? 'alertEnable'
+      puts "Application Enable: " + pref.applicationEnable if pref.respond_to? 'applicationEnable'
+      puts "Application URL: " + pref.applicationURL.to_s if pref.respond_to? 'applicationURL'
+      puts "Device Type: " + pref.deviceType if pref.respond_to? 'deviceType'
+      puts "Notification Payload: " + pref.notificationPayloadType if pref.respond_to? 'notificationPayloadType'
+    end
+  end
+rescue EBay::Error::ApplicationError => boom
+  puts boom.message
+end
+
+begin
+  resp = eBay.GetNotificationPreferences(:PreferenceLevel => 'Event')
+  
+  if resp.respond_to?('eventProperty') && resp.eventProperty
+    [resp.eventProperty].flatten.each do |e|
+      puts "Event Type: " + e.eventType
+      puts "Name: " + e.name
+      puts "Value: " + e.value
+    end
+  end
+rescue EBay::Error::ApplicationError => boom
+  puts boom.message
+end
+
+# More fields are present, see eBay's SOAP API Guide
+#
+# If you add on to this example with more fields, please send it to
+# gdolley@ucla.edu so I can include it with the next release :)

data/examples/get_notifications_usage.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'eBayAPI'
+
+#
+# Example of GetNotificationsUsage call 
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true) 
+
+# Fill this in with a real item number to get more info about notifications
+item_no = '110029878327'
+
+if !item_no.empty?
+  resp = eBay.GetNotificationsUsage(:ItemID => item_no)
+
+  resp.notificationDetailsArray.each do |notif|
+    puts "Delivery Status: " + notif.deliveryStatus
+    puts "Delivery Time: " + notif.deliveryTime if notif.respond_to? 'deliveryTime'
+    puts "Delivery URL: " + notif.deliveryURL
+    puts "Error Message: " + notif.errorMessage
+    puts "Expiration Time: " + notif.expirationTime
+    puts "Next Retry Time: " + notif.nextRetryTime
+    puts "Retries: " + notif.retries if notif.respond_to?('retries') && notif.retries
+    # puts "Type: " + notif.type  # Mmmm... "type" is already a method of Object
+  end if resp.notificationDetailsArray.respond_to? 'notificationDetails'
+end
+
+resp = eBay.GetNotificationsUsage
+
+ns = resp.notificationStatistics
+
+puts "Current Counters: "
+puts "  Delivered: " + ns.deliveredCount.to_s
+puts "  Errors: " + ns.errorCount.to_s
+puts "  Expired: " + ns.expiredCount.to_s
+puts "  Queued New: " + ns.queuedNewCount.to_s
+puts "  Queued Pending: " + ns.queuedPendingCount.to_s
+
+# More fields are present, see eBay's SOAP API Guide
+#
+# If you add on to this example with more fields, please send it to
+# gdolley@ucla.edu so I can include it with the next release :)

data/examples/get_suggested_categories.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eBayAPI'
+
+#
+# Example of GetSuggestedCategories call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true) 
+
+# Call "GetSuggestedCategories"
+resp = eBay.GetSuggestedCategories(:Query => "stuff")
+
+# Report results
+
+if resp.categoryCount.to_i > 0
+  resp.suggestedCategoryArray.suggestedCategory.each do |cat|
+    puts "  Category ID   : " + cat.category.categoryID.to_s
+    puts "  Category Name : " + cat.category.categoryName + " (" + cat.percentItemFound.to_s + "%)"
+    puts ""
+  end
+else
+  puts "No suggested categories found."
+end

data/examples/hello_world.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# $Id: hello_world.rb,v 1.6 2005/12/27 01:13:46 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eBayAPI'
+
+#
+# Example of GeteBayOfficialTime call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true)
+
+# Call "GetEbayOfficialTime"
+resp = eBay.GeteBayOfficialTime
+
+# Report results
+puts "Hello, World!"
+puts "The eBay time is now: #{resp.timestamp}"
+
+# Wasn't that easy?!

data/examples/myCredentials.rb

@@ -0,0 +1,6 @@
+# Fill these in before running the examples:
+
+$appId     = 'CrystalC-4f75-4a31-a866-f776cfcb3005'
+$devId     = 'C4R717157S1331817A1Z3F3164C16F'
+$certId    = 'fa3a209c-590a-4f70-9b89-4641f1331e16'
+$authToken = "AgAAAA**AQAAAA**aAAAAA**VWVSVA**nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6AEmISiAZmEqA6dj6x9nY+seQ**szIAAA**AAMAAA**diarcjs51oQvvJPY3O3UNHqDDnBtesuTpEQSSAzANJFWwQRrM2f0bq85TwPGZ4+O+TkXPPfpmo9S+Y2HWg6kEklYQQLXP7wVvk66rr7qw8gai7tt5DnK8XWCe3w8xIX4mhXBM8wo+7iuWz1u4QusuWW2pdqw3CiLX/leLRvtr7ly8V2CaQgGJbAurrbEiUINVHdKDL3ge1Z+sdar5FW2qn9NCATXudsEt7uIkgSvX4iW5MC4Yrih7NwCq19uHNBlUG4vmJPUNHMwj/QLiq0gN83Rfz1v7vzGhxwEEYNy4wRq4OjkaMKzikmbU5RfCCaWk+mC/HlTJxI9fh40XfVIZQGmhy78dk9cL3HBq5EVINA58JKtkX+Umn4Yw3c92ctK1Evz2i50IGjyN3dmm8lTGsyBniib1QWySowaHfDC0Etim8adYvBli40KlbsNsAYcsMbMGa5Z/3mRhdIs6EStul2JKMNFCsNvh6Cs+w1D1nnhyYT6CMrM+XoIuJJ04coIOdUzDpqQXnuSyUoTobZTyBvh8IPuVFggXeo4OlxWX8Xeljtxe8FYoIemeQdWRhmjDbu2euZ8Fm7UK7sOZ2dXgTxnNAF2kbMKoxN30qMwD7MBUXg6EDvwuUjMuwjVjmsHNXa7kkQZwzbKwxE+I0dOnT1YgSoGhuwZ/rHv0/BL5qFULB6qvFArmcdwNdw38jSaWK+CDN7RNJBH1Ny7kzy5RJbFL0rc1vrkmunPSlocGsnmfA+MRfn6ztjXxjrxj3uq"

data/examples/revise_item.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# $Id: revise_item.rb,v 1.2 2006/01/07 07:34:27 garrydolley Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'eBayAPI'
+
+load('myCredentials.rb')
+
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true)
+
+# I want to revise Item #110029878327 -- replace this with an Item # that you know exists and is active
+item = EBay.Item(:ItemID => '110029878327', :Location => 'Brave New World', :Title => 'My new title')
+
+resp = eBay.ReviseItem(:DetailLevel => 'ReturnAll', :Item => item, 
+                       :ModifiedFields => [ {:Field => 'Item.Location', :ModifyType => 'Modify'},
+                                            {:Field => 'Item.Title',    :ModifyType => 'Modify'} ])
+                                            # Note :Field is case insensitive, so 'item.title' would work also
+
+puts "ItemID: "   + resp.itemID

data/examples/set_notification_preferences.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'eBayAPI'
+
+#
+# Example of SetNotificationPreferences call
+#
+
+# Put your credentials in this file
+load('myCredentials.rb')
+
+# Create new eBay caller object.  Omit last argument to use live platform.
+eBay = EBay::API.new($authToken, $devId, $appId, $certId, :sandbox => true) 
+
+resp = eBay.SetNotificationPreferences(:ApplicationDeliveryPreferences => EBay.ApplicationDeliveryPreferences({
+                                         :ApplicationEnable       => 'Enable',
+                                         :ApplicationURL          => 'http://www.xyz.com/my_script',
+                                         :NotificationPayloadType => 'eBLSchemaSOAP' }),
+                                       :UserDeliveryPreferenceArray => [ 
+                                         EBay.NotificationEnable( 
+                                           :EventEnable => 'Enable',
+                                           :EventType   => 'EndOfAuction'),
+                                         EBay.NotificationEnable( 
+                                           :EventEnable => 'Enable',
+                                           :EventType   => 'Feedback')
+                                         ]
+                                       )