ebayapi 0.9.0

data/lib/ebay/schema/mapper/ebay_schema_importer.rb

@@ -0,0 +1,108 @@
+module Ebay
+  module Schema
+    class ApiSchemaImporter
+      include RubyClassGeneratorHelper
+
+      attr_reader :complex_types, :simple_types
+
+      Ignores = [ 'RecipientRelationCodeType' ]
+      
+      def initialize(schema)
+        @elements = schema.collect_elements
+        @elements.uniq!
+        @attributes = schema.collect_attributes
+        @attributes.uniq!
+        # Only want the simple types that have an enumeration (codes)
+        @simple_types = schema.collect_simpletypes
+        @simple_types.uniq!
+        
+        @code_types = @simple_types.reject{ |e| e.restriction.enumeration.empty? || Ignores.include?(e.name.name) }
+
+        @complex_types = schema.collect_complextypes
+        @complex_types.uniq!
+        @fault_types = nil
+        if schema.respond_to?(:collect_faulttypes)
+          @fault_types = schema.collect_faulttypes
+        end
+
+        @unused_files = []
+      end
+      
+      def export_classes(base_dir)
+        @base_dir = base_dir
+        write_classes
+      end
+      
+      def write_classes
+        
+        complex_classes = @complex_types.collect do |type|
+          puts "Generating class for #{type.name.name}"
+          RubyClassGenerator.new(type, @simple_types, @complex_types)
+        end
+        
+        simple_classes = @code_types.collect do |type|
+          puts "Generating simple type class for #{type.name.name}"
+          RubyClassGenerator.new(type, @simple_types, @complex_types)
+        end
+       
+        
+        write_requires_files(complex_classes)
+        write_class_files(complex_classes) 
+
+        write_class_files(simple_classes) 
+        write_requires_file('types', simple_classes)
+        remove_unused_files
+      end
+      
+      private
+      def write_class_files(classes)
+        classes.each do |klass|
+          write_class(klass)
+        end
+      end
+      
+      def write_requires_files(classes)
+        requests = classes.select{|c| c.request?}
+        responses = classes.select{|c| c.response?}
+        types = classes.select{|c| c.type?}
+      
+        write_requires_file('requests', requests, true) 
+        write_requires_file('responses', requests, true) 
+      end
+      
+      def write_requires_file(name, classes, add_abstract = false)
+        prefix = "ebay/#{name}"
+        File.open("#{@base_dir}/#{name}.rb", 'w') do |file|
+          file.puts require_statement("#{prefix}/abstract") if add_abstract
+          file.puts classes.inject(''){|memo, c| memo << require_statement("#{prefix}/#{c.name.gsub(/(Request|Response)$/, '').ebay_underscore}")}
+        end
+      end
+      
+      def write_class(klass)
+        File.open(generate_filename(klass.name, klass.module_name, klass.type? && !klass.abstract?), "w") do |file|
+          file.puts klass.to_s
+          @unused_files.concat(klass.ignored_classes.collect{|c| generate_filename(c, 'types', true)})
+        end
+      end
+    
+      def generate_filename(name, module_name, simple)
+        name = name.gsub(/Type$/,'')
+        name.gsub!(/(Response|Request)$/, '') unless simple
+        
+        "#{@base_dir}/#{module_name.downcase}/#{name.ebay_underscore}.rb"
+      end
+
+      def remove_unused_files
+        @unused_files.uniq!.each do |file|
+          if File.exists?(file)
+            puts "Removing #{file}"
+            File.delete(file)
+          end
+        end 
+      end
+    end
+  end
+end
+
+
+

data/lib/ebay/schema/mapper/enumeration.rb

@@ -0,0 +1,30 @@
+module Ebay
+  module Schema
+    class Enumeration
+      attr_accessor :codes
+      def initialize(codes = [])
+        codes.delete('CustomCode')
+        @codes = codes
+      end
+      
+      def to_s
+        <<-END
+CODES = #{@codes.inspect}
+
+
+class << self
+  def codes
+    CODES
+  end
+        
+  CODES.each do |code|
+    define_method(code.ebay_underscore) do
+      new(code)
+    end
+  end
+end
+        END
+      end
+    end
+  end
+end

data/lib/ebay/schema/mapper/enumeration_validation.rb

@@ -0,0 +1,17 @@
+module Ebay
+  module Schema
+    class EnumerationValidation
+      def to_s
+        <<-END
+def valid?
+  CODES.include?(@code)
+end
+
+def self.valid?(code)
+  CODES.include?(code)
+end
+        END
+      end
+    end
+  end
+end

data/lib/ebay/schema/mapper/node.rb

@@ -0,0 +1,153 @@
+module Ebay
+  module Schema
+    class Node
+      class_inheritable_accessor :override_type
+        
+      attr_accessor :name, :min, :max
+      def initialize(name, attributes = {})
+        @name = name
+        @type = attributes[:type]
+        @min = attributes[:min] || "1"
+        @max = attributes[:max] || "1"
+        @field = attributes[:field]
+        @child = attributes[:child]
+      end
+
+      def optional?
+        @min == "0"
+      end
+      
+      def accessor_name
+        name = @name.ebay_underscore
+        if name =~ /_array$/
+          name.gsub!(/_array$/, '')
+          Inflector.pluralize(name)
+        else
+          name
+        end
+      end
+
+      def xml_mapping_node_type
+        override_type || Inflector.demodulize(self.class.to_s).underscore
+      end
+
+      def declaration
+        "#{xml_mapping_node_type} :#{accessor_name}"
+      end
+      
+      private
+      def clean_class_name(name)
+        trim_namespace(name.gsub(/Type$/, '')).camelize
+      end
+
+      def trim_name(type)
+        type.gsub(/Type$/,'')
+      end
+
+      def trim_namespace(name)
+        name.gsub(/^.*:/,'')
+      end
+    end
+
+    class TextNode < Node
+      def to_s
+        result = "#{declaration}, "
+        result << (@field.nil? ? "'#{@name}'" : "'#{@field}'")
+        result << ', :optional => true' if optional?
+        if @name == 'Type'
+          result += <<-ENDMETHOD
+
+def type
+  @type
+end
+          ENDMETHOD
+        end
+        result
+      end
+    end
+    
+    class CdataNode < TextNode
+    end
+    
+    class BooleanNode < Node
+      def to_s
+        result = "#{declaration}, '#{@name}', 'true', 'false'"
+        result << ', :optional => true' if @min == '0'
+        result
+      end
+    end
+
+    class NumericNode < Node
+      def to_s
+        result = "#{declaration}, "
+        result << (@field.nil? ? "'#{@name}'" : "'#{@field}'")
+        result << ', :optional => true' if optional?
+        result
+      end
+    end
+
+    class DateTimeNode < TextNode
+      self.override_type = 'time_node'
+    end
+    
+    class ValueArrayNode < Node
+      def to_s
+        result = "#{declaration.pluralize}, '#{@name}', "
+        result << "'#{@child}', " if @child
+        result << ":default_value => []"
+			end
+    end
+
+    class ArrayNode < Node
+      def class_name
+        clean_class_name(@type)
+      end
+			
+      def to_s
+        result = "#{declaration.pluralize}, '#{@name}', "
+        result << "'#{@child}', " if @child
+        result << ":class => #{class_name}, :default_value => []"
+			end
+    end
+    
+    class MoneyNode < Node
+      def to_s
+        result = "#{declaration}, '#{@name}'"
+        result << ', :optional => true' if @min == '0'
+        result
+      end
+    end
+    
+    class ValueNode < Node
+      def class_name
+        clean_class_name(@type)
+      end
+      
+      def to_s
+        result = "#{declaration}, '#{@name}', :class => #{class_name}"
+        result << ', :optional => true' if @min == '0'
+        result
+      end
+    end
+
+    class ObjectNode < Node
+      def class_name
+        clean_class_name(@type)
+      end
+      
+      def to_s
+        result = "#{declaration}, '#{@name}', :class => #{class_name}"
+        result << ', :optional => true' if @min == '0'
+        if @name == 'Type'
+          result += <<-ENDMETHOD
+
+def type
+  @type.code
+end
+          ENDMETHOD
+        end
+        result
+      end
+    end
+  end
+end

data/lib/ebay/schema/mapper/parser.rb

@@ -0,0 +1,16 @@
+require 'xsd/qname'
+require 'xsd/ns'
+require 'xsd/charset'
+require 'xsd/datatypes'
+require 'xsd/xmlparser'
+require 'wsdl/xmlSchema/parser'
+
+module Ebay
+  module Schema
+    class Parser
+      def self.parse(string_or_readable)
+        WSDL::XMLSchema::Parser.new.parse(string_or_readable)
+      end
+    end
+  end
+end

data/lib/ebay/schema/mapper/ruby_class_generator.rb

@@ -0,0 +1,273 @@
+module Ebay
+  module Schema
+    class RubyClassGenerator
+      include RubyClassGeneratorHelper
+      BuiltInTypes = ['string', 'anyURI', 'int', 'float', 'long', 'dateTime', 'boolean', 'token', 'decimal', 'duration', 'double']
+
+      attr_reader :ignored_classes
+
+      def initialize(type, simple_types, complex_types)
+        @indent = 2
+        @type = type
+        @simple_types, @complex_types = simple_types, complex_types
+        @ignored_classes = []
+        find_base
+      end
+
+      def simple_content?
+        @type.simplecontent
+      end
+
+      def simple?
+        @type.is_a?(WSDL::XMLSchema::SimpleType)
+      end
+
+      def complex?
+        @type.is_a?(WSDL::XMLSchema::ComplexType)
+      end
+
+      def to_s
+        @class_def ||= generate_class
+      end
+
+      def generate_class
+        
+        template = simple? ? 'value' : 'base'
+        base = ClassTemplate.new(template).load
+       
+        customization = ClassTemplate.new(name.ebay_underscore)
+        customization.load if customization.exists?
+       
+        if request? || response?
+          class_name = name.ebay_camelize.gsub(/(Request|Response)$/, '')
+        else
+          class_name = name.ebay_camelize
+        end
+
+        element_name = name.ebay_camelize
+        
+          
+        class_def = ClassDefinition.new(class_name, element_name, module_name, base_class)
+        nodes = generate_nodes
+
+        class_def.nodes.concat nodes
+        
+        class_def.customization = customization.render(class_def) if customization.exists?
+        
+        base.render(class_def)
+      end
+
+      def name
+        @name ||= trim_type(@type.name.name)
+      end
+
+      def base_class
+        if abstract_request? || abstract_response?
+          'Base'
+        else
+          trim_type(@base.name.name) unless @base.nil?
+        end
+      end
+
+      def type?
+        !(derived_request? || derived_response?)
+      end
+
+      def abstract?
+        abstract_request? || abstract_response?
+      end
+
+      def abstract_request?
+        name == 'AbstractRequest'
+      end
+
+      def abstract_response?
+        name == 'AbstractResponse'
+      end
+
+      def module_name
+        if request?
+          'Requests'
+        elsif response?
+          'Responses'
+        else
+          'Types'
+        end
+      end
+
+      def request?
+        abstract_request? || derived_request?
+      end
+      
+      def response?
+        abstract_response? || derived_response?
+      end
+
+      def derived_request?
+        base_class == 'AbstractRequest'
+      end
+      
+      def derived_response?
+        base_class == 'AbstractResponse'
+      end
+        
+
+      private
+      def select_template
+        # First try and load a template for the class
+        template = ClassTemplate.new(name.ebay_underscore)
+        if !template.exists?
+          template = ClassTemplate.new('ebay_class')
+        end
+        template.load
+      end
+
+      def find_base
+        type = @type.complexcontent.extension.base
+        @base = @complex_types.find_name(type.name) unless type.nil?
+      rescue NoMethodError
+      end
+
+      def non_inherited_elements
+        return @type.elements if @base.nil?
+
+        @type.elements.reject do |e|
+          @base.find_element(e.name)
+        end
+      end
+
+      def generate_nodes
+        if simple?
+          enumeration = @type.restriction.enumeration
+          if enumeration.any?
+            @type.restriction.enumeration.select{|c| c != 'CustomCode'}
+          end
+        elsif simple_content?
+          content = @type.simplecontent
+          result = []
+          result << build_node_for_built_in_type(trim_type(name), content.extension.base.name, :field => '', :min => '0')
+
+          result.concat(content.attributes.collect do |a|
+            TextNode.new(trim_code_type(a.type.name), :field => "@#{a.name.name}", :min => '0')
+          end)
+          result
+        else
+          result = nodes_for_complex_elements
+          result.concat nodes_for_complex_attributes
+        end
+      end
+
+      def nodes_for_complex_elements
+        begin
+          non_inherited_elements.collect do |e|
+            node_for(e)
+          end.flatten
+        rescue NoMethodError
+          # Hack for when the type doesn't respond to elements
+          @type.complexcontent.content.content.elements.collect do |e|
+            node_for(e)
+          end.flatten
+        end
+      end
+
+      def nodes_for_complex_attributes
+        @type.attributes.collect do |a|
+          build_node_for_built_in_type(trim_code_type(a.name.name), a.type.name, :field => "@#{a.name.name}", :min => '0')
+        end
+      end
+
+      def generate_require_statements
+        result = ''
+        result << @nodes.inject('') do |memo, node|
+          if node.respond_to?(:class_name)
+            memo << require_statement(node.class_name.ebay_underscore)
+          else
+            memo
+          end
+        end
+
+        result << "\n"
+      end
+
+      def node_for(element)
+        name = element.name.name
+        type = element.type.name
+        min = element.minoccurs || "1"
+        max = element.maxoccurs || "1"
+
+        options = { :type => type,
+          :min => min,
+          :max => max
+        }
+
+        if BuiltInTypes.include?(type)
+          build_node_for_built_in_type(name, type, options)
+        else
+          build_node_for_complex_type(name, type, options)
+        end
+      end
+
+      def build_node_for_built_in_type(name, type, options)
+        case type
+        when 'string'
+          if self.name == 'Item' && name == 'Description'
+            CdataNode.new(name, options)
+          else
+            TextNode.new(name, options)
+          end
+        when 'anyURI', 'token', 'duration'
+          TextNode.new(name, options)
+        when 'int', 'float', 'long', 'decimal', 'double'
+          NumericNode.new(name, options)
+        when 'dateTime'
+          DateTimeNode.new(name, options)
+        when 'boolean'
+          BooleanNode.new(name, options)
+        end
+      end
+
+      def build_node_for_complex_type(name, type, options)
+        min, max = options[:min], options[:max]
+        simple_type = @simple_types.find_name(type)
+
+        case max
+        when "1"
+          if simple_type
+            TextNode.new(name, options)
+          elsif element = @complex_types.find_name(type)
+            if element.elements.size == 1 && element.elements[0].maxoccurs == "unbounded"
+              # Found a container!
+              child = element.elements[0]
+
+              ignored = %w( MemberMessage BidApproval )
+              
+              unless BuiltInTypes.include?(child.type.name)
+                @ignored_classes << name unless ignored.include?(name)
+                options[:type] = child.type.name
+                options[:child] = child.name.name
+              end
+
+              if simple_type = @simple_types.find_name(child.type.name)
+                ValueArrayNode.new(name, options)
+              else
+                ArrayNode.new(name, options)
+              end
+            else
+              if type == 'AmountType'
+                MoneyNode.new(name, options)
+              else
+                ObjectNode.new(name, options)
+              end
+            end
+          end
+        else
+          if simple_type
+            ValueArrayNode.new(name, options)
+          else
+            ArrayNode.new(name, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ebay/schema/mapper/ruby_class_generator_helper.rb

@@ -0,0 +1,52 @@
+module Ebay
+  module Schema
+    module RubyClassGeneratorHelper
+      private
+      def trim_type(type)
+        type.gsub(/Type$/, '')
+      end
+
+      def trim_code_type(type)
+        type.gsub(/CodeType$/, '')
+      end
+
+      def require_statement(library_name)
+        "require '#{library_name}'\n"
+      end
+
+      def include_module(module_name)
+        "include #{module_name}\n"
+      end
+
+      def define_module(name)
+        result = ''
+        result << "module #{name}\n"
+        result << indent("#{yield}\n")
+        result << "end"
+      end
+
+      def define_class(name, superclass)
+  #      result = ''
+        result = "class #{trim_type(name).ebay_camelize}"
+        result << " < #{trim_type(superclass)}" unless superclass.nil?
+ #       case name
+ #       when /RequestType$/
+ #         result << " < AbstractRequest"
+ #       when /ResponseType$/
+ #         result << " < AbstractResponse"
+ #       end
+
+        result << "\n"
+        result << indent("#{yield}\n")
+        result << "end"
+      end
+
+      def indent(text)
+ass #{trim_type(name).ebay_camelize}"
+text.collect{|line| ' ' * @indent + line}.join('')
+      end
+    end
+  end
+end
+
+

data/lib/ebay/schema/mapper/schema.rb

@@ -0,0 +1,15 @@
+require 'mapper/parser'
+require 'mapper/enumeration'
+require 'mapper/enumeration_validation'
+require 'mapper/node'
+require 'mapper/ruby_class_generator_helper'
+require 'mapper/ruby_class_generator'
+require 'mapper/ebay_schema_importer'
+require 'mapper/xsd2ebay'
+
+module Ebay
+  module Schema
+    Namespace = 'urn:ebay:apis:eBLBaseComponents'
+  end
+end
+

data/lib/ebay/schema/mapper/templates/abstract_request.erb

@@ -0,0 +1,7 @@
+def detail_level
+  @detail_levels.first
+end
+
+def detail_level=(value)
+  @detail_levels = Array(value)
+end

data/lib/ebay/schema/mapper/templates/application_delivery_preferences.erb

@@ -0,0 +1,7 @@
+def application_enabled?
+  @application_enable == 'Enable'
+end
+
+def alerts_enabled?
+  @alert_enable == 'Enable'
+end

data/lib/ebay/schema/mapper/templates/base.erb

@@ -0,0 +1,21 @@
+<% for req in requires -%>
+<%= "require 'ebay/types/#{req}'" %>
+<% end -%>
+
+module Ebay
+  module <%= module_name %>
+    class <%= class_definition %>
+      include XML::Mapping
+      include Initializer
+      root_element_name '<%= element_name %>'
+<% for node in nodes -%>
+      <%= node.to_s %>
+<% end -%>
+<% for line in customization -%>
+      <%= line.chomp %>
+<% end -%>
+    end
+  end
+end
+
+