ebayapi 0.9.0

data/lib/ebay/api.rb

@@ -0,0 +1,179 @@
+require 'uri'
+require 'zlib'
+require 'stringio'
+
+module Ebay #:nodoc:
+  class EbayError < StandardError #:nodoc:
+  end
+
+  class RequestError < EbayError #:nodoc:
+    attr_reader :errors
+    def initialize(errors)
+      @errors = errors
+    end
+  end
+
+  # 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
+  #
+  # All Ebay API calls have a corresponding request and response object.
+  # In the example above the request objects is 
+  # Ebay::Requests::GeteBayOfficialTime and the response object is
+  # Ebay::Responses::GeteBayOfficialTime
+  class Api
+    include Ebay::Types
+    XmlNs = 'urn:ebay:apis:eBLBaseComponents'
+    
+    cattr_accessor :use_sandbox, :sandbox_url, :production_url, :site_id
+    cattr_accessor :dev_id, :app_id, :cert, :auth_token
+    
+    self.sandbox_url = 'https://api.sandbox.ebay.com/ws/api.dll'
+    self.production_url = 'https://api.ebay.com/ws/api.dll'
+    self.use_sandbox = false
+
+    # Make the default site US
+    self.site_id = 0
+  
+    def self.service_uri
+      URI.parse(using_sandbox? ? sandbox_url : production_url)
+    end
+
+    def self.using_sandbox?
+      use_sandbox
+    end
+
+    def self.using_production?
+      !using_sandbox?
+    end
+
+
+    def self.configure
+      yield self if block_given?
+    end
+
+    def schema_version
+      Ebay::Schema::VERSION.to_s
+    end
+
+    def service_uri
+      self.class.service_uri
+    end
+    
+    def app_id
+      self.class.app_id
+    end
+
+    def cert
+      self.class.cert
+    end
+
+    def auth_token
+      self.class.auth_token
+    end
+
+    def initialize(options = {})
+      @format = options[:format] || :object
+    end
+
+    private
+    def method_missing(method_id, *args, &block)
+      args = args.first || {}
+
+      method_args = { :site_id => site_id,
+                      :auth_token => auth_token,
+                      :format => @format
+                    }.update(args)
+
+      invoke_request(method_id.to_s, method_args, &block)
+    end
+
+    def invoke_request(name, args)
+      format = args.delete(:format)
+      site_id = args.delete(:site_id)
+      request = build_request(name.ebay_camelize, args)
+     
+      yield request if block_given? 
+      
+      raw_response = connection.post( service_uri.path, 
+                                      build_body(request), 
+                                      build_headers(request.call_name, site_id)
+                                    )
+      
+      parse decompress(raw_response), format
+      
+    end
+
+    def build_request(name, args)
+      request_class = Ebay::Requests.const_get(name)
+      request_class.new(args)
+    end
+
+    def build_headers(call_name, site_id)
+      {
+        'X-EBAY-API-COMPATIBILITY-LEVEL' => schema_version,
+        '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-SITEID' => site_id.to_s,
+        'Content-Type' => 'text/xml',
+        'Accept-Encoding' => 'gzip'
+      }
+    end
+
+    def build_body(request)
+      result = REXML::Document.new
+      result << REXML::XMLDecl.new('1.0', 'UTF-8')
+      result << request.save_to_xml
+      result.root.add_namespace XmlNs
+      result.to_s
+    end
+
+    def connection(refresh = false)
+      @connection = Connection.new(service_uri) if refresh || @connection.nil?
+      @connection
+    end
+
+    def decompress(response)
+      content = case response['Content-Encoding']
+      when 'gzip'
+        gzr = Zlib::GzipReader.new(StringIO.new(response.body))
+        decoded = gzr.read
+        gzr.close
+        decoded
+      else
+        response.body
+      end
+    end
+
+    def parse(content, format)
+      case format
+      when :object
+        xml = REXML::Document.new(content)
+        # Fixes the wrong case of API returned by eBay
+        fix_root_element_name(xml)
+        result = XML::Mapping.load_object_from_xml(xml.root)
+        case result.ack
+        when AckCode::Failure, AckCode::PartialFailure
+          raise RequestError.new(result.errors)
+        end
+      when :raw
+        result = content
+      else
+        raise ArgumentError, "Unknown response format '#{format}' requested"
+      end
+      result
+    end
+
+    def fix_root_element_name(xml)
+      if xml.root.name =~ /API/
+        xml.root.name = xml.root.name.gsub(/API/, 'Api')
+      end
+    end
+  end
+end

data/lib/ebay/ebay.rb

@@ -0,0 +1,26 @@
+require 'ebay/enumeration'
+require 'ebay/schema/version'
+
+# Remove the broken unpluralization of 'ies' words
+Inflector.inflections.plurals.delete_if{|inflection| inflection.first == /([^aeiouy]|qu)ies$/i }
+
+# Fix circular dependency
+module Ebay
+  module Types
+    class Transaction; end
+    class Order; end
+  end
+end
+
+if File.exists?(File.dirname(__FILE__) + '/requests.rb') && File.exists?(File.dirname(__FILE__) + '/responses.rb')
+  require 'ebay/request/base'
+  require 'ebay/response/base'
+  require 'ebay/requests'
+  require 'ebay/responses'
+  require 'ebay/types'
+end
+
+require 'ebay/api'
+require 'ebay/initializer'
+require 'ebay/request'
+require 'ebay/notification'

data/lib/ebay/enumeration.rb

@@ -0,0 +1,7 @@
+module Enumeration
+  def each
+    constants.each do |element|
+      yield element
+    end
+  end
+end

data/lib/ebay/initializer.rb

@@ -0,0 +1,19 @@
+module Ebay
+  module Initializer
+    def initialize(attributes = nil)
+      super
+      self.object_attributes = attributes
+      yield self if block_given? 
+    end
+
+    def object_attributes=(new_attributes)
+      return if new_attributes.nil?
+      attributes = new_attributes.dup
+      attributes.stringify_keys!
+
+      attributes.each do |k, v|
+        send(k + "=", v)
+      end
+    end
+  end
+end

data/lib/ebay/notification.rb

@@ -0,0 +1,109 @@
+require 'rexml/document'
+require 'digest/md5'
+
+module Ebay
+  class NotificationError < StandardError
+  end
+
+  class InvalidNotificationError < NotificationError
+  end
+
+  class Notification
+    def initialize(post_data)
+      @raw_data = post_data
+      parse
+    end
+    
+    def valid?
+      signature == generated_signature
+    end
+
+    def body
+      @body ||= parse_body
+    end
+
+    def signature
+      @signature ||= parse_signature
+    end
+
+    def timestamp
+      @timestamp ||= parse_timestamp
+    end
+
+    def document
+      @document ||= load_document
+    end
+
+    def xml_body
+      @xml_body ||= parse_xml_body
+    end
+
+    def event_name
+      @event_name ||= parse_event_name
+    end
+
+    private
+    def dev_id
+      Api.dev_id
+    end
+
+    def app_id
+      Api.app_id
+    end
+
+    def cert
+      Api.cert
+    end
+    
+    def parse
+      parse_xml_body
+    end
+    
+    def generated_signature
+      @generated_signature ||= generate_signature
+    end
+    
+    def load_response_class(method_id)
+      load_response_class(xml.root.name)
+      XML::Mapping.load_object_from_xml(xml.root)
+    end
+
+    def load_document
+      result = REXML::Document.new(@raw_data).root
+      raise InvalidNotificationError, "The notification is empty" if result.nil?
+      result
+    end
+
+    def parse_timestamp
+      timestamp_node = REXML::XPath.first(document, "//Timestamp")
+      raise InvalidNotificationError, "Notification timestamp is missing" if timestamp_node.nil?
+      timestamp_node.text
+    end
+    
+    def parse_event_name
+      event_name_node = REXML::XPath.first(document, "//NotificationEventName")
+      raise InvalidNotificationError, "Notification event name is missing" if event_name_node.nil?
+      event_name_node.text
+    end
+
+    def parse_signature
+      signature_node = REXML::XPath.first(document, "//ebl:NotificationSignature")
+      raise InvalidNotificationError, "Notification signature is missing" if signature_node.nil?
+      signature_node.text
+    end
+
+    def parse_xml_body
+      soap_body = REXML::XPath.first(document, '//soapenv:Body')
+      raise InvalidNotificationError, "Soap body is invalid" if soap_body.nil? || soap_body.elements.size < 1
+      soap_body.elements[1]
+    end
+
+    def parse_body
+      XML::Mapping.load_object_from_xml(xml_body)
+    end
+
+    def generate_signature
+      Base64.encode64(Digest::MD5.digest(timestamp + dev_id + app_id + cert)).chomp
+    end
+  end  
+end

data/lib/ebay/request/base.rb

@@ -0,0 +1,18 @@
+require 'ebay/types/xml_requester_credentials'
+
+module Ebay
+  module Requests
+    class Base
+      include Ebay::Types
+      attr_accessor :auth_token
+
+      def call_name
+        self.class.to_s.split('::').last.gsub(/Request$/, '')
+      end
+
+      def requester_credentials
+        @requester_credentials ||= XMLRequesterCredentials.new(:ebay_auth_token => auth_token)
+      end
+    end
+  end
+end

data/lib/ebay/request/connection.rb

@@ -0,0 +1,66 @@
+require 'net/https'
+require 'date'
+require 'time'
+require 'uri'
+
+module Ebay
+  class ConnectionError < StandardError
+    attr_reader :response
+
+    def initialize(response, message = nil)
+      @response = response
+      @message  = message
+    end
+
+    def to_s
+      "Failed with #{response.code}"
+    end
+  end
+
+  class ClientError < ConnectionError
+  end
+
+  class ServerError < ConnectionError
+  end
+
+  class ResourceNotFound < ClientError
+  end
+
+  class Connection
+    def initialize(site)
+      @site = site
+    end
+
+    def post(path, body, headers)
+      request(:post, path, body, headers)
+    end
+
+    private
+    def request(method, *arguments)
+      response = http.send(method, *arguments)
+
+      case response.code.to_i
+      when 200...300
+        response
+      when 404
+        raise(ResourceNotFound.new(response))
+      when 400...500
+        raise(ClientError.new(response))
+      when 500...600
+        raise(ServerError.new(response))
+      else
+        raise(ConnectionError.new(response, "Unknown response code: #{response.code}"))
+      end
+    end
+
+    def http
+      unless @http
+        @http             = Net::HTTP.new(@site.host, @site.port)
+        @http.use_ssl     = @site.is_a?(URI::HTTPS)
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @http.use_ssl
+      end
+
+      @http
+    end
+  end
+end

data/lib/ebay/request.rb

@@ -0,0 +1 @@
+require 'ebay/request/connection'

data/lib/ebay/requests/abstract.rb

@@ -0,0 +1,28 @@
+require 'ebay/types/xml_requester_credentials'
+
+module Ebay
+  module Requests
+    class Abstract < Base
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AbstractRequest'
+      value_array_node :detail_levels, 'DetailLevel', :default_value => []
+      text_node :error_language, 'ErrorLanguage', :optional => true
+      text_node :message_id, 'MessageID', :optional => true
+      text_node :version, 'Version', :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
+      def detail_level
+        @detail_levels.first
+      end
+      
+      def detail_level=(value)
+        @detail_levels = Array(value)
+      end
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_dispute.rb

@@ -0,0 +1,16 @@
+
+module Ebay
+  module Requests
+    class AddDispute < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddDisputeRequest'
+      text_node :dispute_explanation, 'DisputeExplanation', :optional => true
+      text_node :dispute_reason, 'DisputeReason', :optional => true
+      text_node :item_id, 'ItemID', :optional => true
+      text_node :transaction_id, 'TransactionID', :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_dispute_response.rb

@@ -0,0 +1,18 @@
+
+module Ebay
+  module Requests
+    class AddDisputeResponse < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddDisputeResponseRequest'
+      text_node :dispute_id, 'DisputeID', :optional => true
+      text_node :message_text, 'MessageText', :optional => true
+      text_node :dispute_activity, 'DisputeActivity', :optional => true
+      text_node :shipping_carrier_used, 'ShippingCarrierUsed', :optional => true
+      text_node :shipment_track_number, 'ShipmentTrackNumber', :optional => true
+      time_node :shipping_time, 'ShippingTime', :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_item.rb

@@ -0,0 +1,16 @@
+require 'ebay/types/item'
+require 'ebay/types/external_product_id'
+
+module Ebay
+  module Requests
+    class AddItem < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddItemRequest'
+      object_node :item, 'Item', :class => Item, :optional => true
+      object_node :external_product_id, 'ExternalProductID', :class => ExternalProductID, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_live_auction_item.rb

@@ -0,0 +1,14 @@
+require 'ebay/types/item'
+
+module Ebay
+  module Requests
+    class AddLiveAuctionItem < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddLiveAuctionItemRequest'
+      object_node :item, 'Item', :class => Item, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_member_message.rb

@@ -0,0 +1,15 @@
+require 'ebay/types/member_message'
+
+module Ebay
+  module Requests
+    class AddMemberMessage < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddMemberMessageRequest'
+      text_node :item_id, 'ItemID', :optional => true
+      object_node :member_message, 'MemberMessage', :class => MemberMessage, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_member_message_aaq_to_partner.rb

@@ -0,0 +1,15 @@
+require 'ebay/types/member_message'
+
+module Ebay
+  module Requests
+    class AddMemberMessageAAQToPartner < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddMemberMessageAAQToPartnerRequest'
+      text_node :item_id, 'ItemID', :optional => true
+      object_node :member_message, 'MemberMessage', :class => MemberMessage, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_member_message_rtq.rb

@@ -0,0 +1,15 @@
+require 'ebay/types/member_message'
+
+module Ebay
+  module Requests
+    class AddMemberMessageRTQ < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddMemberMessageRTQRequest'
+      text_node :item_id, 'ItemID', :optional => true
+      object_node :member_message, 'MemberMessage', :class => MemberMessage, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_member_messages_aaq_to_bidder.rb

@@ -0,0 +1,14 @@
+require 'ebay/types/add_member_messages_aaq_to_bidder_request_container'
+
+module Ebay
+  module Requests
+    class AddMemberMessagesAAQToBidder < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddMemberMessagesAAQToBidderRequest'
+      array_node :add_member_messages_aaq_to_bidder_request_containers, 'AddMemberMessagesAAQToBidderRequestContainer', :class => AddMemberMessagesAAQToBidderRequestContainer, :default_value => []
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_order.rb

@@ -0,0 +1,14 @@
+require 'ebay/types/order'
+
+module Ebay
+  module Requests
+    class AddOrder < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddOrderRequest'
+      object_node :order, 'Order', :class => Order, :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_second_chance_item.rb

@@ -0,0 +1,19 @@
+
+module Ebay
+  module Requests
+    class AddSecondChanceItem < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddSecondChanceItemRequest'
+      text_node :recipient_bidder_user_id, 'RecipientBidderUserID', :optional => true
+      money_node :buy_it_now_price, 'BuyItNowPrice', :optional => true
+      boolean_node :copy_email_to_seller, 'CopyEmailToSeller', 'true', 'false'
+      text_node :duration, 'Duration', :optional => true
+      text_node :item_id, 'ItemID', :optional => true
+      text_node :site, 'Site', :optional => true
+      text_node :seller_message, 'SellerMessage', :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_to_item_description.rb

@@ -0,0 +1,14 @@
+
+module Ebay
+  module Requests
+    class AddToItemDescription < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddToItemDescriptionRequest'
+      text_node :item_id, 'ItemID', :optional => true
+      text_node :description, 'Description', :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_to_watch_list.rb

@@ -0,0 +1,13 @@
+
+module Ebay
+  module Requests
+    class AddToWatchList < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddToWatchListRequest'
+      value_array_node :item_ids, 'ItemID', :default_value => []
+    end
+  end
+end
+
+

data/lib/ebay/requests/add_transaction_confirmation_item.rb

@@ -0,0 +1,20 @@
+
+module Ebay
+  module Requests
+    class AddTransactionConfirmationItem < Abstract
+      include XML::Mapping
+      include Initializer
+      root_element_name 'AddTransactionConfirmationItemRequest'
+      text_node :recipient_user_id, 'RecipientUserID'
+      text_node :verify_eligibility_only, 'VerifyEligibilityOnly'
+      text_node :recipient_postal_code, 'RecipientPostalCode'
+      text_node :recipient_relation_type, 'RecipientRelationType'
+      money_node :negotiated_price, 'NegotiatedPrice'
+      text_node :listing_duration, 'ListingDuration'
+      text_node :item_id, 'ItemID'
+      text_node :comments, 'Comments'
+    end
+  end
+end
+
+