elibri_onix 0.1.23 → 0.2.0

data/lib/elibri_onix/onix_3_0/onix_message.rb

@@ -3,16 +3,8 @@ module Elibri
   module ONIX
     module Release_3_0
 
-      class ONIXMessage
-        include ROXML
-        #include Inspector
-
-        xml_name 'ONIXMessage'
-        xml_accessor :release, :from => "@release"
-        xml_accessor :elibri_dialect, :from => "elibri:Dialect"
-
-        xml_accessor :products, :as => [Product]
-        xml_accessor :header, :as => Header
+      class ONIXMessage        
+        attr_accessor :release, :elibri_dialect, :products, :header, :to_xml
 
         ATTRIBUTES = [
           :release, :elibri_dialect, :header
@@ -21,28 +13,20 @@ module Elibri
         RELATIONS = [
           :products
         ]
-
+        
         def self.from_xml(data, *initialization_args)
-          xml = XML::Node.from(data)
-
-          new(*initialization_args).tap do |inst|
-            inst.roxml_references = roxml_attrs.map {|attr| attr.to_ref(inst) }
+          Kernel.warn "[DEPRECATION] `from_xml` is deprecated. Please use `new` instead."
+          self.new(data, *initialization_args)
+        end
 
-            inst.roxml_references.each do |ref|
-              value = ref.value_in(xml)
-              if ref.is_a? ROXML::XMLObjectRef
-                Array(value).each do |obj|
-                  obj.instance_variable_set(:@elibri_dialect, inst.elibri_dialect)
-                end  
-              end
-              inst.respond_to?(ref.opts.setter) \
-                ? inst.send(ref.opts.setter, value) \
-                : inst.instance_variable_set(ref.opts.instance_variable_name, value)
-            end
-            inst.send(:after_parse) if inst.respond_to?(:after_parse, true)
-          end
-        rescue ArgumentError => e
-          raise e, e.message + " for class #{self}"
+        def initialize(data, *initialization_args)
+          @to_xml = data.to_s
+          xml = Nokogiri::XML(data) unless xml.is_a?(Nokogiri::XML::Document)
+          onix_message = xml.children.first
+          @release = onix_message['release']
+          @elibri_dialect = onix_message.at_xpath('elibri:Dialect').try(:text)
+          @header = Header.new(onix_message.at_xpath('xmlns:Header')) if onix_message.at_xpath('xmlns:Header')
+          @products = onix_message.xpath('xmlns:Product').map { |product_node| Product.new(product_node) }
         end
 
 

data/lib/elibri_onix/onix_3_0/price.rb

@@ -7,10 +7,6 @@ module Elibri
     module Release_3_0
 
       class Price
-        include ROXML
-        include Inspector
-
-        xml_name 'Price'
         
         ATTRIBUTES = [
           :type, :minimum_order_quantity, :amount, :currency_code, :printed_on_product,
@@ -18,25 +14,31 @@ module Elibri
         ]
         
         RELATIONS = []
-
-        xml_accessor :type, :from => 'PriceType', :as => Fixnum
-        xml_accessor :minimum_order_quantity, :from => 'MinimumOrderQuantity', :as => Fixnum
-        xml_accessor :amount, :from => 'PriceAmount', :as => BigDecimal
-        xml_accessor :currency_code, :from => 'CurrencyCode'
-        xml_accessor :printed_on_product, :from => 'PrintedOnProduct', :as => Fixnum
-        xml_accessor :position_on_product, :from => 'PositionOnProduct', :as => Fixnum
-
-        xml_accessor :tax_type, :in => 'Tax', :from => 'TaxType', :as => Fixnum
-        xml_accessor :tax_rate_percent, :in => 'Tax', :from => 'TaxRatePercent', :as => BigDecimal
-
+        
+        attr_accessor :type, :minimum_order_quantity, :amount, :currency_code, :printed_on_product,
+          :position_on_product, :tax_type, :tax_rate_percent, :to_xml
+
+        def initialize(data)
+          @to_xml = data.to_s
+          @type = data.at_xpath('xmlns:PriceType').try(:text).try(:to_i)
+          @minimum_order_quantity = data.at_xpath('xmlns:MinimumOrderQuantity').try(:text).try(:to_i)
+          @amount = BigDecimal.new(data.at_xpath('xmlns:PriceAmount').try(:text))
+          @currency_code = data.at_xpath('xmlns:CurrencyCode').try(:text)
+          @printed_on_product = data.at_xpath('xmlns:PrintedOnProduct').try(:text).try(:to_i)
+          @position_on_product = data.at_xpath('xmlns:PositionOnProduct').try(:text).try(:to_i)
+          if data.at_xpath('xmlns:Tax')
+            @tax_type = data.at_xpath('xmlns:Tax').at_xpath('xmlns:TaxType').try(:text).try(:to_i)
+            @tax_rate_percent = BigDecimal.new(data.at_xpath('xmlns:Tax').at_xpath('xmlns:TaxRatePercent').try(:text)) if data.at_xpath('xmlns:Tax').at_xpath('xmlns:TaxRatePercent')
+          end
+        end
 
         def printed_on_product?
-          printed_on_product == 2
+          @printed_on_product == 2
         end
 
 
         def vat
-          tax_type == 1 ? tax_rate_percent : nil
+          @tax_type == 1 ? @tax_rate_percent : nil
         end
 
       end

data/lib/elibri_onix/onix_3_0/product.rb

@@ -30,31 +30,99 @@ module Elibri
           :ghostwriters, :scenarists, :originators, :illustrators, :photographers, :author_of_prefaces, :drawers,
           :cover_designers, :inked_or_colored_bys, :editors, :revisors, :translators, :editor_in_chiefs, :read_bys
         ]
-               
-        
-        include ROXML
-
-        
 
         attr_accessor :elibri_dialect, :height, :width, :thickness, :weight, :ean, :isbn13, :number_of_pages, :duration, 
                       :file_size, :publisher_name, :publisher_id, :imprint_name, :current_state, :reading_age_from, :reading_age_to, 
                       :table_of_contents, :description, :reviews, :excerpts, :series, :title, :subtitle, :collection_title,
                       :collection_part, :full_title, :original_title, :trade_title, :short_description,
                       :elibri_product_category1_id, :elibri_product_category2_id, :preview_exists
-
-
-        xml_name 'Product'
-        xml_accessor :record_reference, :from => 'RecordReference'
-        xml_accessor :notification_type, :from => 'NotificationType'
-        xml_accessor :deletion_text, :from => 'DeletionText'
-
-        # Load attributes specific for dialect 3.0.1
-        xml_accessor :cover_type_from_3_0_1, :from => 'elibri:CoverType'
-        xml_accessor :cover_price_from_3_0_1, :from => 'elibri:CoverPrice', :as => BigDecimal
-        xml_accessor :vat_from_3_0_1, :from => 'elibri:Vat', :as => Fixnum
-        xml_accessor :pkwiu_from_3_0_1, :from => 'elibri:PKWiU'
-        xml_accessor :preview_exists_from_3_0_1, :from => "elibri:preview_exists"
-
+                      
+          
+                      #from xml_accessor
+        attr_accessor :record_reference, :notification_type, :deletion_text
+        
+                      # Load attributes specific for dialect 3.0.1
+        attr_accessor :cover_type_from_3_0_1, :cover_price_from_3_0_1, :vat_from_3_0_1, :pkwiu_from_3_0_1, :preview_exists_from_3_0_1,
+                      :product_composition, :product_form, :measures, :title_details, :collections, :contributors, :no_contributor,
+                      :languages, :extents, :subjects, :audience_ranges, :edition_statement, :number_of_illustrations, :text_contents,
+                      :supporting_resources, :imprint, :publisher, :publishing_status, :publishing_date, :sales_restrictions,
+                      :identifiers, :related_products, :supply_details, :to_xml
+
+
+        def initialize(data)
+          @to_xml = data.to_s
+          #initialize variables that need to be array
+          ##descriptive_details
+          @text_contents = []
+          @supporting_resources = []
+          ##collateral_details
+          @measures = []
+          @title_details = []
+          @collections = []
+          @contributors = []
+          @languages = []
+          @extents = []
+          @subjects = []
+          @audience_ranges = []
+          ##publishing_details
+          @sales_restrictions = []
+          
+          #moving to parsing attributes
+          
+          @elibri_dialect = data.at_xpath('//elibri:Dialect').try(:text)
+          @record_reference = data.at_xpath('xmlns:RecordReference').try(:text)
+          @notification_type = data.at_xpath('xmlns:NotificationType').try(:text)
+          @deletion_text = data.at_xpath('xmlns:DeletionText').try(:text)
+          @cover_type_from_3_0_1 = data.at_xpath('elibri:CoverType').try(:text)
+          @cover_price_from_3_0_1 = BigDecimal.new(data.at_xpath('elibri:CoverPrice').try(:text)) if data.at_xpath('elibri:CoverPrice')
+          @vat_from_3_0_1 = data.at_xpath('elibri:Vat').try(:text).try(:to_i)
+          @pkwiu_from_3_0_1 = data.at_xpath('elibri:PKWiU').try(:text)
+          @preview_exists_from_3_0_1 = data.at_xpath('elibri:preview_exists').try(:text)
+          @identifiers = data.xpath('xmlns:ProductIdentifier').map { |ident_data| ProductIdentifier.new(ident_data) }
+          begin
+            @related_products = data.at_xpath('xmlns:RelatedMaterial').xpath('xmlns:RelatedProduct').map { |related_data| RelatedProduct.new(related_data) }
+          rescue
+            @related_products = []
+          end
+          begin
+            @supply_details = data.at_xpath('xmlns:ProductSupply').xpath('xmlns:SupplyDetail').map { |supply_data| SupplyDetail.new(supply_data) }
+          rescue
+            @supply_details = []
+          end
+          descriptive_details_setup(data.at_xpath('xmlns:DescriptiveDetail')) if data.at_xpath('xmlns:DescriptiveDetail')
+          collateral_details_setup(data.at_xpath('xmlns:CollateralDetail')) if data.at_xpath('xmlns:CollateralDetail')
+          publishing_details_setup(data.at_xpath('xmlns:PublishingDetail')) if data.at_xpath('xmlns:PublishingDetail')
+          after_parse
+        end
+        
+        def descriptive_details_setup(data)
+          @product_composition = data.at_xpath('xmlns:ProductComposition').try(:text)
+          @product_form = data.at_xpath('xmlns:ProductForm').try(:text)
+          @measures =  data.xpath('xmlns:Measure').map { |measure_data| Measure.new(measure_data) }
+          @title_details = data.xpath('xmlns:TitleDetail').map { |title_data| TitleDetail.new(title_data) }
+          @collections = data.xpath('xmlns:Collection').map { |collection_data| Collection.new(collection_data) }
+          @contributors = data.xpath('xmlns:Contributor').map { |contributor_data| Contributor.new(contributor_data) }
+          @no_contributor = data.at_xpath('xmlns:NoContributor').try(:text)
+          @languages = data.xpath('xmlns:Language').map { |language_data| Language.new(language_data) }
+          @extents = data.xpath('xmlns:Extent').map { |extent_data| Extent.new(extent_data) }
+          @subjects = data.xpath('xmlns:Subject').map { |subject_data| Subject.new(subject_data) }
+          @audience_ranges = data.xpath('xmlns:AudienceRange').map { |audience_data| AudienceRange.new(audience_data) }
+          @edition_statement = data.at_xpath('xmlns:EditionStatement').try(:text)
+          @number_of_illustrations = data.at_xpath('xmlns:NumberOfIllustrations').try(:text).try(:to_i)
+        end
+        
+        def collateral_details_setup(data)
+          @text_contents = data.xpath('xmlns:TextContent').map { |text_detail| TextContent.new(text_detail) }
+          @supporting_resources = data.xpath('xmlns:SupportingResource').map { |supporting_data| SupportingResource.new(supporting_data) }
+        end
+        
+        def publishing_details_setup(data)
+          @imprint = Imprint.new(data.at_xpath('xmlns:Imprint')) if data.at_xpath('xmlns:Imprint')
+          @publisher = Publisher.new(data.at_xpath('xmlns:Publisher')) if data.at_xpath('xmlns:Publisher')
+          @publishing_status = data.at_xpath('xmlns:PublishingStatus').try(:text)
+          @publishing_date = PublishingDate.new(data.at_xpath('xmlns:PublishingDate')) if data.at_xpath('xmlns:PublishingDate')
+          @sales_restrictions = data.xpath('xmlns:SalesRestriction').map { |restriction_data| SalesRestriction.new(restriction_data) }      
+        end
 
         # Attributes in namespace elibri:* are specific for dialect >= 3.0.1.
         # If dialect is less than 3.0.1, returns nil.
@@ -70,53 +138,26 @@ module Elibri
           EVAL_END
         end  
 
-        xml_accessor :identifiers, :as => [ProductIdentifier]
-        xml_accessor :related_products, :as => [RelatedProduct], :in => 'RelatedMaterial'
-        xml_accessor :supply_details, :as => [SupplyDetail], :in => 'ProductSupply'
-
-        xml_accessor :product_composition, :in => 'DescriptiveDetail', :from => 'ProductComposition'
-        xml_accessor :product_form, :in => 'DescriptiveDetail', :from => 'ProductForm'
-        xml_accessor :measures, :in => 'DescriptiveDetail', :as => [Measure]
-        xml_accessor :title_details, :in => 'DescriptiveDetail', :as => [TitleDetail]
-        xml_accessor :collections, :in => 'DescriptiveDetail', :as => [Collection]
-        xml_accessor :contributors, :in => 'DescriptiveDetail', :as => [Contributor]
-        xml_accessor :no_contributor, :in => 'DescriptiveDetail', :from => 'NoContributor'
-        xml_accessor :languages, :in => 'DescriptiveDetail', :as => [Language]
-        xml_accessor :extents, :in => 'DescriptiveDetail', :as => [Extent]
-        xml_accessor :subjects, :in => 'DescriptiveDetail', :as => [Subject]
-        xml_accessor :audience_ranges, :in => 'DescriptiveDetail', :as => [AudienceRange]
-        xml_accessor :edition_statement, :in => 'DescriptiveDetail', :from => 'EditionStatement'
-        xml_accessor :number_of_illustrations, :in => 'DescriptiveDetail', :from => 'NumberOfIllustrations', :as => Fixnum
-
-        xml_accessor :text_contents, :in => 'CollateralDetail', :as => [TextContent]
-        xml_accessor :supporting_resources, :in => 'CollateralDetail', :as => [SupportingResource]
-
-        xml_accessor :imprint, :in => 'PublishingDetail', :as => Imprint
-        xml_accessor :publisher, :in => 'PublishingDetail', :as => Publisher
-        xml_accessor :publishing_status, :in => 'PublishingDetail', :from => 'PublishingStatus'
-        xml_accessor :publishing_date, :in => 'PublishingDetail', :as => PublishingDate
-        xml_accessor :sales_restrictions, :in => 'PublishingDetail', :as => [SalesRestriction]
-
         def sales_restrictions?
-          sales_restrictions.size > 0
+          @sales_restrictions.size > 0
         end
 
         def no_contributor?
-          no_contributor == ""
+          @no_contributor == ""
         end
 
         def unnamed_persons?
-          contributors.size == 1 && contributors[0].unnamed_persons.present?
+          @contributors.size == 1 && contributors[0].unnamed_persons.present?
         end
 
         def authors
-          unnamed_persons? ? ["praca zbiorowa"] : contributors.find_all { |c| c.role_name == "author" }.map(&:person_name)
+          unnamed_persons? ? ["praca zbiorowa"] : @contributors.find_all { |c| c.role_name == "author" }.map(&:person_name)
         end
 
         [:ghostwriter, :scenarist, :originator, :illustrator, :photographer, :author_of_preface, :drawer, :cover_designer, 
          :inked_or_colored_by, :editor, :revisor, :translator, :editor_in_chief, :read_by].each do |role|
           define_method "#{role}s" do
-            contributors.find_all { |c| c.role_name == role.to_s }.map(&:person_name)
+            @contributors.find_all { |c| c.role_name == role.to_s }.map(&:person_name)
           end
         end
 
@@ -131,11 +172,11 @@ module Elibri
         end
 
         def front_cover
-          supporting_resources.find { |resource| resource.content_type_name == "front_cover" }
+          @supporting_resources.find { |resource| resource.content_type_name == "front_cover" }
         end
 
         def series_names
-          series.map { |series| series[0] }
+          @series.map { |series| series[0] }
         end
 
         def premiere
@@ -143,7 +184,7 @@ module Elibri
         end
  
         def proprietary_identifiers 
-          identifiers.find_all { |i| i.identifier_type == "proprietary" }.inject({}) { |res, ident| res[ident.type_name] = ident.value; res }
+          @identifiers.find_all { |i| i.identifier_type == "proprietary" }.inject({}) { |res, ident| res[ident.type_name] = ident.value; res }
         end
 
         #I don't want to see roxml_references in output - it's faar to big output
@@ -186,7 +227,7 @@ module Elibri
 private
 
         def find_title(code)
-          title_details.find {|title_detail| title_detail.type == code}
+          @title_details.find {|title_detail| title_detail.type == code}
         end
 
         def after_parse
@@ -194,23 +235,23 @@ private
             instance_variable_set("@#{mn}", measures.find { |m| m.type_name == mn }.try(:measurement))
           end
 
-          @ean = identifiers.find { |identifier| identifier.identifier_type == "ean" }.try(:value)
-          @isbn13 = identifiers.find { |identifier| identifier.identifier_type == "isbn13" }.try(:value)
-          @number_of_pages = extents.find {|extent| extent.type_name == "page_count" }.try(:value)
-          @duration = extents.find {|extent| extent.type_name == "duration" }.try(:value)
-          @file_size = extents.find {|extent| extent.type_name == "file_size" }.try(:value)
-          @publisher_name = publisher.name if publisher
-          @publisher_id = publisher.id if publisher
-          @imprint_name = imprint.name if imprint
-
-          @reading_age_from = audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "03")}.try(:value)
-          @reading_age_to = audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "04")}.try(:value)
-          @table_of_contents = text_contents.find { |t| t.type_name == "table_of_contents" }
-          @description = text_contents.find { |t| t.type_name == "main_description" }
-          @short_description = text_contents.find { |t| t.type_name == "short_description" }
-          @reviews = text_contents.find_all { |t| t.type_name == "review" }
-          @excerpts = text_contents.find_all { |t| t.type_name == "excerpt" }
-          @series = collections.map { |c| [c.title_detail.elements[0].title,  c.title_detail.elements[0].part_number] }
+          @ean = @identifiers.find { |identifier| identifier.identifier_type == "ean" }.try(:value)
+
+          @number_of_pages = @extents.find {|extent| extent.type_name == "page_count" }.try(:value)
+          @duration = @extents.find {|extent| extent.type_name == "duration" }.try(:value)
+          @file_size = @extents.find {|extent| extent.type_name == "file_size" }.try(:value)
+          @publisher_name = @publisher.name if publisher
+          @publisher_id = @publisher.eid if publisher
+          @imprint_name = @imprint.name if imprint
+          @isbn13 = @identifiers.find { |identifier| identifier.identifier_type == "isbn13" }.try(:value)
+          @reading_age_from = @audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "03")}.try(:value)
+          @reading_age_to = @audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "04")}.try(:value)
+          @table_of_contents = @text_contents.find { |t| t.type_name == "table_of_contents" }
+          @description = @text_contents.find { |t| t.type_name == "main_description" }
+          @short_description = @text_contents.find { |t| t.type_name == "short_description" }
+          @reviews = @text_contents.find_all { |t| t.type_name == "review" }
+          @excerpts = @text_contents.find_all { |t| t.type_name == "excerpt" }
+          @series = @collections.map { |c| [c.title_detail.elements[0].title,  c.title_detail.elements[0].part_number] }
           distinctive_title = find_title(Elibri::ONIX::Dict::Release_3_0::TitleType::DISTINCTIVE_TITLE)
           if distinctive_title
             @title = distinctive_title.product_level.try(:title)
@@ -230,17 +271,17 @@ private
         end
 
         def compute_state!
-          if notification_type == "01"
+          if @notification_type == "01"
             @current_state = :announced
-          elsif notification_type == "02"
+          elsif @notification_type == "02"
             @current_state = :preorder
           else
-            if publishing_status == "04"
+            if @publishing_status == "04"
               @current_state = :published
-            elsif publishing_status == "07"
+            elsif @publishing_status == "07"
               @current_state = :out_of_print
             else
-              raise "cannot determine the state of the product #{record_reference}"
+              raise "cannot determine the state of the product #{@record_reference}"
             end
           end
         end

data/lib/elibri_onix/onix_3_0/product_identifier.rb

@@ -4,13 +4,8 @@ module Elibri
     module Release_3_0
 
       class ProductIdentifier
-        include ROXML
-        include Inspector
 
-        xml_name 'ProductIdentifier'
-        xml_accessor :type, :from => 'ProductIDType'
-        xml_accessor :type_name, :from => 'IDTypeName'
-        xml_accessor :value, :from => 'IDValue'
+        attr_accessor :type, :type_name, :value, :to_xml
         
         ATTRIBUTES = [
           :type, :type_name, :value, :identifier_type
@@ -19,9 +14,16 @@ module Elibri
         RELATIONS = [
           :inspect_include_fields
         ]
+        
+        def initialize(data)
+          @to_xml = data.to_s
+          @type = data.at_xpath('xmlns:ProductIDType').try(:text)
+          @type_name = data.at_xpath('xmlns:IDTypeName').try(:text)
+          @value = data.at_xpath('xmlns:IDValue').try(:text)
+        end
 
         def identifier_type
-          Elibri::ONIX::Dict::Release_3_0::ProductIDType.find_by_onix_code(type).const_name.downcase
+          Elibri::ONIX::Dict::Release_3_0::ProductIDType.find_by_onix_code(@type).const_name.downcase
         end
 
         def inspect_include_fields

data/lib/elibri_onix/onix_3_0/publisher.rb

@@ -6,21 +6,31 @@ module Elibri
     module Release_3_0
 
       class Publisher
-        include ROXML
-        include Inspector
-
-        xml_name 'Publisher'
         
         ATTRIBUTES = [
-          :role, :name, :id
+          :role, :name, :eid
         ]
         
         RELATIONS = []
 
-        #występuje w tej chwili tylko 01 - główny wydawca
-        xml_accessor :role, :from => 'PublishingRole'
-        xml_accessor :name, :from => 'PublisherName'
-        xml_accessor :id,   :from => 'IDValue', :in => 'PublisherIdentifier', :as => Fixnum
+        #role występuje w tej chwili tylko 01 - główny wydawca
+
+        attr_accessor :role, :name, :eid, :to_xml
+        
+        def initialize(data)
+          @to_xml = data.to_s
+          @role = data.at_xpath('xmlns:PublishingRole').try(:text)
+          @name = data.at_xpath('xmlns:PublisherName').try(:text)
+          if data.at_xpath('xmlns:PublisherIdentifier')
+            @eid = data.at_xpath('xmlns:PublisherIdentifier').at_xpath('xmlns:IDValue').try(:text).try(:to_i)
+          end
+        end
+        
+        def id
+          Kernel.warn "[DEPRECATION] `id` is deprecated. Please use `eid` instead."
+          @eid
+        end
+        
       end
 
     end