ebayapi-awt 0.13.0

data/CHANGELOG

@@ -0,0 +1,47 @@
+* Still return the stylesheet in XslFile even when the regex doesn't match
+* Update to schema version 653
+* Update to schema version 637
+* Rename examples/config.rb to examples/config.template.rb [Bernd Ustorf]
+
+== Version 0.12.0 (July 5, 2009)
+
+* Update for release 0.12.0
+* Update to schema version 607
+* Update to schema version 603
+* Remove support for deprecated calls requiring the username and password
+* Make the add_item example more fully featured
+* Lock onto Money v1.7.1 as Money v2.0.0 has an issue with == and non-money objects. Add a test to detect the condition
+* Update to schema version 591
+* Support SetReturnURL GetReturnURL GetRuName FetchToken that require a username and password
+* Don't cache the HTTP connection
+* Update schema to version 569
+* Remove requirement of flexmock
+* 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
+* Update to eBay XML Schema Version 511
+* Tweak modification to xsl stylesheets
+* Add an example for get_search_results with pagination
+* Release 0.10.0
+* Update the documentation for better navigation.  Provide links to official documentation. Don't use method_missing anymore
+* Add eBay documentation from the schema into the RDoc.  Generate method calls for all API calls so they are documented
+* Update to Schema version 503
+* Remove unused code.  Remove dependency on Active Support for regular usage. Don't extend built in String and Hash types.
+* Update to schema version 501.  Beware, all deprecated calls have been removed
+* Release 0.9.4
+* Fix get_product_finder_xsl.  eBay returns the wrong case of XSL in the response element
+* Release 0.9.3
+* Actually use the auth_token, call super on method_missing when the API call isn't found
+* Fix overriding the default site_id and auth_token when constructing the Api
+* Make Gem work with edge Rails
+* Update to schema version 491
+* Improve RDoc documentation
+* Updated to eBay schema version 487
+* Updated the README

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    ebayapi-awt (0.13.0)
+      money (~> 1.7.1)
+      xml-mapping (~> 0.8.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.14)
+    libxml-ruby (2.3.3)
+    money (1.7.1)
+    rake (0.9.2.2)
+    xml-mapping (0.8.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 2.3)
+  ebayapi-awt!
+  libxml-ruby (~> 2.1)
+  rake

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cody Fauser
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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 591
+# * 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/Rakefile

@@ -0,0 +1,122 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubygems/package_task'
+require 'rake/contrib/rubyforgepublisher'
+require 'xml'
+
+response_dir = File.join(File.dirname(__FILE__), 'test', 'fixtures', 'responses')
+
+desc "Default: Run all the unit tests"
+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 ]
+
+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'
+
+    cd folder do
+      rm_f 'ebaySvc.xsd'
+      system("wget #{url}")
+    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
+    
+    File.read(schema) =~ /Version (\d+)/m
+    if version = $1
+      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
+    else
+      raise "Unable to parse the version from the schema"
+    end
+  end
+  
+end
+
+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 'bundler/setup'
+    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
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "eBayAPI Ruby client for the eBay unified schema XML API"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main=README'
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('lib/ebay/schema')
+  rdoc.rdoc_files.exclude('lib/support')
+}
+
+desc "Release the gems and docs to RubyForge"
+task :release => [ :publish, :upload ]
+
+desc "Publish the release files to RubyForge."
+task :publish => [ :package ] do
+  require 'rubyforge'
+  
+  packages = %w( gem tgz zip ).collect{ |ext| "pkg/#{Ebay::PKG_NAME}-#{Ebay::VERSION}.#{ext}" }
+  
+  rubyforge = RubyForge.new
+  rubyforge.login
+  rubyforge.add_release(Ebay::PKG_NAME, Ebay::PKG_NAME, "REL #{Ebay::VERSION}", *packages)
+end
+
+desc 'Upload RDoc to RubyForge'
+task :upload => :rdoc do
+  user = "cfauser@rubyforge.org" 
+  project = '/var/www/gforge-projects/ebayapi'
+  local_dir = 'doc'
+  pub = Rake::SshDirPublisher.new user, project, local_dir
+  pub.upload
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'ebay'
+

data/lib/ebay.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+begin
+  require 'xml/mapping'
+rescue LoadError
+  require 'rubygems'
+  require 'xml/mapping'
+end
+
+begin
+  require 'money'
+rescue LoadError
+  require 'rubygems'
+  require 'money'
+end
+
+# Include the extra string and hash extensions particular to ebay
+require 'support/cattr_accessor'
+
+# Include the additional XML::Mapping node types
+require 'support/xml_mapping'
+
+# Include the main program file
+require 'ebay/ebay'

data/lib/ebay/api.rb

@@ -0,0 +1,203 @@
+require 'uri'
+require 'zlib'
+require 'stringio'
+require 'ebay/request/connection'
+require 'ebay/api_methods'
+
+module Ebay #:nodoc:
+  class EbayError < StandardError #:nodoc:
+  end
+
+  class RequestError < EbayError #:nodoc:
+    attr_reader :errors
+    def initialize(errors)
+      @errors = errors
+    end
+  end
+
+  # == Overview
+  # Api is the main proxy class responsible for instantiating and invoking
+  # the correct Ebay::Requests object for the method called. 
+  # All of the available method calls are included from the module Ebay::ApiMethods
+  #   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
+  #
+  # == Official Input / Output Reference
+  # The official input / output reference provided by eBay is a good way to get familiar
+  # with the API calls.
+  #
+  # http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/index.html
+  class Api
+    include Inflections
+    include ApiMethods
+    XmlNs = 'urn:ebay:apis:eBLBaseComponents'
+    
+    cattr_accessor :use_sandbox, :sandbox_url, :production_url, :site_id
+    cattr_accessor :dev_id, :app_id, :cert, :auth_token
+    cattr_accessor :username, :password
+    attr_reader :auth_token, :site_id
+    
+    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
+  
+    # 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
+
+    def service_uri
+      self.class.service_uri
+    end
+    
+    def app_id
+      self.class.app_id
+    end
+
+    def cert
+      self.class.cert
+    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
+      @auth_token = options[:auth_token] || self.class.auth_token
+      @site_id = options[:site_id] || self.class.site_id
+    end
+  
+    private
+    def commit(request_class, params)
+      format = params.delete(:format) || @format
+      
+      params[:username] = username
+      params[:password] = password
+      params[:auth_token] = auth_token
+      
+      request = request_class.new(params)
+      yield request if block_given?
+      invoke(request, format)
+    end
+    
+    def invoke(request, format)
+      response = connection.post( service_uri.path, 
+                                  build_body(request), 
+                                  build_headers(request.call_name)
+                                )
+      
+      parse decompress(response), format
+    end
+
+    def build_headers(call_name)
+      {
+        '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.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'
+      }
+    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 Ebay::Types::AckCode::Failure, Ebay::Types::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)
+      # Fix upper cased API in response
+      xml.root.name = xml.root.name.gsub(/API/, 'Api')
+      
+      # Fix lowercased Xsl in response document
+      xml.root.name = xml.root.name.gsub(/XslResponse$/, 'XSLResponse')
+    end
+  end
+end