ebayapi 0.9.0 → 0.9.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+# * Make Gem work with edge Rails
+# * Update to schema version 491
+# * Improve RDoc documentation
+# * Updated to eBay schema version 487
+# * Updated the README

data/README

@@ -0,0 +1,13 @@
+# == eBay API Client for Ruby
+#
+# * Simple and easy to use Ruby implementation.
+# * Ability to return a raw response for calls that return an extremely large response such as GetCategoriesRequest.
+# * Up-to-date with the eBay API version 487.
+# * Months of usage in a production environment.
+# * Support for Platform Notifications baked right in.
+# 
+# See the following article for details on how to get started:
+# http://www.codyfauser.com/articles/2006/11/22/ebay-api-client-for-ruby
+
+# For examples of many common tasks see the examples folder.
+

data/lib/ebay/api.rb

@@ -13,12 +13,13 @@ module Ebay #:nodoc:
     end
   end
 
+  # == Overview
   # Api is the main proxy class responsible for instantiating and invoking
   # the correct Ebay::Requests object for the method called. This is currently done
-  # using method_missing.  
-  # ebay = Ebay::Api.new
-  # response = ebay.get_ebay_official_time
-  # puts response.timestamp # => 2006-08-13T21:28:39.515Z
+  # using method_missing:  
+  #   ebay = Ebay::Api.new
+  #   response = ebay.get_ebay_official_time
+  #   puts response.timestamp # => 2006-08-13T21:28:39.515Z
   #
   # All Ebay API calls have a corresponding request and response object.
   # In the example above the request objects is 
@@ -38,23 +39,39 @@ module Ebay #:nodoc:
     # Make the default site US
     self.site_id = 0
   
+    # The URI that all requests are sent to. This depends on the current environment the Api
+    # is configured to use and will either be the Api#sandbox_url or the Api#production_url
     def self.service_uri
       URI.parse(using_sandbox? ? sandbox_url : production_url)
     end
 
+    # Are we currently routing requests to the eBay sandbox URL?
     def self.using_sandbox?
       use_sandbox
     end
 
+    # Are we currently routing requests to the eBay production URL?
     def self.using_production?
       !using_sandbox?
     end
 
-
+    # Simply yields the Ebay::Api class itself.  This makes configuration a bit nicer looking:
+    #
+    #  Ebay::Api.configure do |ebay|
+    #    ebay.auth_token = 'YOUR AUTH TOKEN HERE'
+    #    ebay.dev_id = 'YOUR DEVELOPER ID HERE'
+    #    ebay.app_id = 'YOUR APPLICATION ID HERE'
+    #    ebay.cert = 'YOUR CERTIFICATE HERE'
+    #
+    #  # The default environment is the production environment
+    #  # Override by setting use_sandbox to true
+    #    ebay.use_sandbox = true
+    #  end
     def self.configure
       yield self if block_given?
     end
 
+    # The schema version the API client is currently using
     def schema_version
       Ebay::Schema::VERSION.to_s
     end
@@ -75,6 +92,13 @@ module Ebay #:nodoc:
       self.class.auth_token
     end
 
+    # With no options, the default is to use the default site_id and the default
+    # auth_token configured on the Api class.
+    #   ebay = Ebay::Api.new
+    #
+    # However, another user's auth_token can be used and the site can be selected
+    # at the time of creation. Ex: Canada(Site 2) with another user's auth token.
+    #   ebay = Ebay::Api.new(:site_id => 2, :auth_token => 'TEST')
     def initialize(options = {})
       @format = options[:format] || :object
     end

data/lib/ebay/ebay.rb

@@ -1,3 +1,4 @@
+require 'ebay/initializer'
 require 'ebay/enumeration'
 require 'ebay/schema/version'
 
@@ -21,6 +22,5 @@ if File.exists?(File.dirname(__FILE__) + '/requests.rb') && File.exists?(File.di
 end
 
 require 'ebay/api'
-require 'ebay/initializer'
 require 'ebay/request'
 require 'ebay/notification'

data/lib/ebay/enumeration.rb

@@ -1,4 +1,4 @@
-module Enumeration
+module Enumeration #:nodoc:
   def each
     constants.each do |element|
       yield element

data/lib/ebay/initializer.rb

@@ -1,5 +1,5 @@
-module Ebay
-  module Initializer
+module Ebay #:nodoc:
+  module Initializer #:nodoc:
     def initialize(attributes = nil)
       super
       self.object_attributes = attributes

data/lib/ebay/notification.rb

@@ -2,10 +2,10 @@ require 'rexml/document'
 require 'digest/md5'
 
 module Ebay
-  class NotificationError < StandardError
+  class NotificationError < StandardError #:nodoc:
   end
 
-  class InvalidNotificationError < NotificationError
+  class InvalidNotificationError < NotificationError #:nodoc:
   end
 
   class Notification

data/lib/ebay/request/connection.rb

@@ -3,8 +3,8 @@ require 'date'
 require 'time'
 require 'uri'
 
-module Ebay
-  class ConnectionError < StandardError
+module Ebay #:nodoc:
+  class ConnectionError < StandardError #:nodoc:
     attr_reader :response
 
     def initialize(response, message = nil)
@@ -17,16 +17,16 @@ module Ebay
     end
   end
 
-  class ClientError < ConnectionError
+  class ClientError < ConnectionError #:nodoc:
   end
 
-  class ServerError < ConnectionError
+  class ServerError < ConnectionError #:nodoc:
   end
 
-  class ResourceNotFound < ClientError
+  class ResourceNotFound < ClientError #:nodoc:
   end
 
-  class Connection
+  class Connection #:nodoc:
     def initialize(site)
       @site = site
     end

data/lib/ebay/requests.rb

@@ -86,6 +86,8 @@ require 'ebay/requests/get_user'
 require 'ebay/requests/get_user_contact_details'
 require 'ebay/requests/get_user_disputes'
 require 'ebay/requests/get_user_preferences'
+require 'ebay/requests/get_vero_reason_code_details'
+require 'ebay/requests/get_vero_report_status'
 require 'ebay/requests/get_want_it_now_post'
 require 'ebay/requests/get_want_it_now_search_results'
 require 'ebay/requests/get_ebay_details'
@@ -118,6 +120,7 @@ require 'ebay/requests/set_user_notes'
 require 'ebay/requests/set_user_preferences'
 require 'ebay/requests/validate_challenge_input'
 require 'ebay/requests/validate_test_user_registration'
+require 'ebay/requests/vero_report_items'
 require 'ebay/requests/verify_add_item'
 require 'ebay/requests/verify_add_second_chance_item'
 require 'ebay/requests/abstract'

data/lib/ebay/requests/abstract.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/xml_requester_credentials'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class Abstract < Base
       include XML::Mapping
       include Initializer
@@ -14,10 +14,16 @@ module Ebay
       text_node :error_handling, 'ErrorHandling', :optional => true
       text_node :invocation_id, 'InvocationID', :optional => true
       text_node :warning_level, 'WarningLevel', :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.
+      # Reads the first detail level from the detail_levels Array.
       def detail_level
         @detail_levels.first
       end
       
+      # Overwrites the details_levels Array with a new Array containing only the 
+      # value passed in as an argument
       def detail_level=(value)
         @detail_levels = Array(value)
       end

data/lib/ebay/requests/add_dispute.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddDispute < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_dispute_response.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddDisputeResponse < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_item.rb

@@ -1,8 +1,8 @@
 require 'ebay/types/item'
 require 'ebay/types/external_product_id'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddItem < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_live_auction_item.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/item'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddLiveAuctionItem < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_member_message_aaq_to_partner.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/member_message'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddMemberMessageAAQToPartner < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_member_message_rtq.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/member_message'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddMemberMessageRTQ < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_member_messages_aaq_to_bidder.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/add_member_messages_aaq_to_bidder_request_container'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddMemberMessagesAAQToBidder < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_order.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/order'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddOrder < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_second_chance_item.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddSecondChanceItem < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_to_item_description.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddToItemDescription < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_to_watch_list.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddToWatchList < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/add_transaction_confirmation_item.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class AddTransactionConfirmationItem < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/approve_live_auction_bidders.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/bid_approval'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class ApproveLiveAuctionBidders < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/complete_sale.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/feedback_info'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class CompleteSale < Abstract
       include XML::Mapping
       include Initializer
@@ -11,6 +11,7 @@ module Ebay
       object_node :feedback_info, 'FeedbackInfo', :class => FeedbackInfo, :optional => true
       boolean_node :shipped, 'Shipped', 'true', 'false', :optional => true
       boolean_node :paid, 'Paid', 'true', 'false', :optional => true
+      text_node :listing_type, 'ListingType', :optional => true
     end
   end
 end

data/lib/ebay/requests/delete_my_messages.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class DeleteMyMessages < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/end_item.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class EndItem < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/fetch_token.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class FetchToken < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/get_account.rb

@@ -1,7 +1,7 @@
 require 'ebay/types/pagination'
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class GetAccount < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/get_ad_format_leads.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class GetAdFormatLeads < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/get_all_bidders.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class GetAllBidders < Abstract
       include XML::Mapping
       include Initializer

data/lib/ebay/requests/get_api_access_rules.rb

@@ -1,6 +1,6 @@
 
-module Ebay
-  module Requests
+module Ebay # :nodoc:
+  module Requests # :nodoc:
     class GetApiAccessRules < Abstract
       include XML::Mapping
       include Initializer