onix2 1.0.0

data/lib/onix2/audience_range.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+module ONIX2
+  class AudienceRange
+    include Virtus.model
+
+    attribute :audience_range_qualifier, Integer
+    attribute :audience_range_precisions, Array[Integer]
+    attribute :audience_range_values, Array[Integer]
+
+    # TODO: element AudienceRange: validity error :
+    #   Element AudienceRange content does not follow the DTD, expecting
+    #   (AudienceRangeQualifier , AudienceRangePrecision , AudienceRangeValue ,
+    #   (AudienceRangePrecision , AudienceRangeValue)?),
+    #   got
+    #   (AudienceRangeQualifier AudienceRangePrecision AudienceRangePrecision
+    #   AudienceRangeValue AudienceRangeValue )
+
+    def to_xml
+      AudienceRangeRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      AudienceRangeRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class AudienceRangeRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :AudienceRange
+
+    property :audience_range_qualifier, as: "AudienceRangeQualifier", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    collection :audience_range_precisions, as: "AudienceRangePrecision", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    collection :audience_range_values, as: "AudienceRangeValue", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+  end
+end

data/lib/onix2/code_list_extractor.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+
+module ONIX2
+
+  # A utility class that processes the code list XSD from the ONIX spec and
+  # creates a set of TSV files. The generated files are used by this library
+  # to make hashes of the code lists available to users.
+  #
+  class CodeListExtractor
+
+    # Creates a new extractor. Expects the path to a copy of the code lists
+    # file from the spec (called ONIX_BookProduct_CodeLists.xsd on my system).
+    #
+    def initialize(filename)
+      raise ArgumentError, "#{filename} not found" unless File.file?(filename)
+
+      @filename = filename
+    end
+
+    # generate a set of TSV files in the given directory. Creates the directory
+    # if it doesn't exist and will overwrite existing files.
+    #
+    def run(dir)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+
+      each_list do |number, data|
+        #puts number
+        file = number.to_s.rjust(3, "0") + ".tsv"
+        path = File.join(dir, file)
+        File.open(path, "w") { |f| f.write data}
+      end
+    end
+
+    private
+
+    def data
+      @data ||= File.open(@filename) { |f| f.read }
+    end
+
+    def document
+      @document ||= Nokogiri::XML(data)
+      @document.remove_namespaces! if @document.namespaces.size > 0
+      @document
+    end
+
+    def each_list(&block)
+      document.xpath("//simpleType").each do |node|
+        list_name   = node.xpath("./@name").first.value
+        list_number = list_name[/List(\d+)/,1].to_i
+        if list_number > 0
+          yield list_number, list_data(list_number)
+        end
+      end
+    end
+
+    def list_data(num)
+      str   = ""
+      nodes = document.xpath("//simpleType[@name='List#{num}']/restriction/enumeration")
+      nodes.each do |node|
+        code  = node.xpath("./@value").first.value
+        desc  = node.xpath("./annotation/documentation").first.text
+        ldesc = node.xpath("./annotation/documentation").last.text
+        str += "#{code}\t#{desc}\t#{ldesc}\n"
+      end
+      str
+    end
+
+  end
+end

data/lib/onix2/contributor.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+module ONIX2
+  class Contributor
+    include Virtus.model
+
+    attribute :sequence_number, Integer
+    attribute :contributor_role
+    attribute :language_code
+    attribute :sequence_number_within_role, Integer
+    attribute :person_name
+    attribute :person_name_inverted
+    attribute :titles_before_names
+    attribute :names_before_key
+    attribute :prefix_to_key
+    attribute :key_names
+    attribute :names_after_key
+    attribute :suffix_to_key
+    attribute :letters_after_names
+    attribute :titles_after_names
+    attribute :corporate_name
+    attribute :biographical_note
+
+    def to_xml
+      ContributorRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      ContributorRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+class ContributorRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Contributor
+
+    property :sequence_number, as: "SequenceNumber"
+    property :contributor_role, as: "ContributorRole"
+    property :language_code, as: "LanguageCode"
+    property :sequence_number_within_role, as: "SequenceNumberWithinRole"
+    property :person_name, as: "PersonName"
+    property :person_name_inverted, as: "PersonNameInverted"
+    property :titles_before_names, as: "TitlesBeforeNames"
+    property :names_before_key, as: "NamesBeforeKey"
+    property :prefix_to_key, as: "PrefixToKey"
+    property :key_names, as: "KeyNames"
+    property :names_after_key, as: "NamesArterKey"
+    property :suffix_to_key, as: "SuffixToKey"
+    property :letters_after_names, as: "LettersAfterNames"
+    property :titles_after_names, as: "TitlesAfterNames"
+    property :corporate_name, as: "CorporateName"
+    property :biographical_note, as: "BiographicalNote"
+  end
+end

data/lib/onix2/discount_coded.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module ONIX2
+  class DiscountCoded
+    include Virtus.model
+
+    attribute :discount_code_type, Integer
+    attribute :discount_code_type_name
+    attribute :discount_code
+
+    def to_xml
+      DiscountCodedRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      DiscountCodedRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class DiscountCodedRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :DiscountCoded
+
+    property :discount_code_type, as: "DiscountCodeType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :discount_code_type_name, as: "DiscountCodeTypeName"
+    property :discount_code, as: "DiscountCode"
+  end
+end

data/lib/onix2/header.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+
+module ONIX2
+  class Header
+    include Virtus.model
+
+    attribute :from_ean_number
+    attribute :from_san
+    attribute :sender_identifiers, Array[ONIX2::SenderIdentifier]
+    attribute :from_company
+    attribute :from_person
+    attribute :from_email
+    attribute :to_ean_number
+    attribute :to_san
+    attribute :addressee_identifiers, Array[ONIX2::AddresseeIdentifier]
+    attribute :to_company
+    attribute :to_person
+    attribute :message_number
+    attribute :message_repeat, Integer
+    attribute :sent_date
+    attribute :message_note
+
+    # defaults
+    attribute :default_language_of_text
+    attribute :default_price_type_code, Integer
+    attribute :default_currency_code
+    attribute :default_linear_unit # deprecated in ONIX spec
+    attribute :default_weight_unit # deprecated in ONIX spec
+    attribute :default_class_of_trade
+
+    def to_xml
+      HeaderRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      HeaderRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class HeaderRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Header
+
+    property :from_ean_number, as: "FromEANNumber"
+    property :from_san, as: "FromSAN"
+    collection :sender_identifiers, as: "SenderIdentifier", extend: ONIX2::SenderIdentifierRepresenter, class: ONIX2::SenderIdentifier
+    property :from_company, as: "FromCompany"
+    property :from_person, as: "FromPerson"
+    property :from_email, as: "FromEmail"
+    property :to_ean_number, as: "ToEANNumber"
+    property :to_san, as: "ToSAN"
+    collection :addressee_identifiers, as: "AddresseeIdentifier", extend: ONIX2::AddresseeIdentifierRepresenter, class: ONIX2::AddresseeIdentifier
+    property :to_company, as: "ToCompany"
+    property :to_person, as: "ToPerson"
+    property :message_number, as: "MessageNumber"
+    property :message_repeat, as: "MessageRepeat"
+    property :sent_date, as: "SentDate", render_filter: ::ONIX2::Formatters::YYYYMMDD, parse_filter: ->(value, *context) { Date.parse(value) rescue nil }
+    property :message_note, as: "MessageNote"
+    property :default_language_of_text, as: "DefaultLanguageOfText"
+    property :default_price_type_code, as: "DefaultPriceTypeCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :default_currency_code, as: "DefaultCurrencyCode"
+    property :default_linear_unit, as: "DefaultLinearUnit"
+    property :default_weight_unit, as: "DefaultWeightUnit"
+    property :default_class_of_trade, as: "DefaultClassOfTrade"
+  end
+
+end

data/lib/onix2/imprint.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+module ONIX2
+  class Imprint
+    include Virtus.model
+
+    attribute :name_code_type, Integer
+    attribute :name_code_type_name
+    attribute :name_code_value
+    attribute :imprint_name
+
+    def to_xml
+      ImprintRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      ImprintRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class ImprintRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Imprint
+
+    property :name_code_type, as: "NameCodeType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :name_code_type_name, as: "NameCodeTypeName"
+    property :name_code_value, as: "NameCodeValue"
+    property :imprint_name, as: "ImprintName"
+  end
+end

data/lib/onix2/language.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module ONIX2
+  class Language
+    include Virtus.model
+
+    attribute :language_role, Integer
+    attribute :language_code
+    attribute :country_code
+
+    def to_xml
+      LanguageRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      LanguageRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class LanguageRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Language
+
+    property :language_role, as: "LanguageRole", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :language_code, as: "LanguageCode"
+    property :country_code, as: "CountryCode"
+  end
+end

data/lib/onix2/lists.rb

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+module ONIX2
+
+  # Builds hashes for all code lists in the ONIX spec.
+  #
+  # Use like so:
+  #
+  #   ONIX2::Lists.list(7)
+  #   => { "BB" => "Hardback", ... }
+  #
+  # There are also some constants for commonly used lists:
+  #
+  #   ONIX2::Lists::PRODUCT_FORM
+  #   => { "BB" => "Hardback", ... }
+  #
+  class Lists
+    include Singleton
+
+    # retrieve a hash with the specified code list
+    #
+    #  ONIX2::Lists.list(7)
+    #  => { "BB" => "Hardback", ... }
+    #
+    def self.list(number)
+      self.instance.list(number)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.audience_code
+      self.instance.list(28)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.contributor_role
+      self.instance.list(17)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.country_code
+      self.instance.list(91)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.language_code
+      self.instance.list(74)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.language_role
+      self.instance.list(22)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.notification_type
+      self.instance.list(1)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.product_availability
+      self.instance.list(65)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.product_form
+      self.instance.list(7)
+    end
+
+    # Shortcut to retrieve a common code list
+    #
+    def self.product_form_detail
+      self.instance.list(78)
+    end
+
+    # return a hash with the data for a single code list.
+    #
+    # number should be a fixnum specifying the list to retrieve
+    #
+    #  ONIX2::Lists.instance.list(7)
+    #  => { "BB" => "Hardback", ... }
+    #
+    def list(number)
+      cache[number] ||= build_hash(number)
+    end
+
+    private
+
+    def build_hash(number)
+      val = {}
+      data(number).each_line do |line|
+        code, desc, ldesc = *line.split("\t")
+        code = code.to_i if code.to_s.match(/\d+/)
+        val[code] = desc
+      end
+      val
+    end
+
+    def cache
+      @cache ||= {}
+    end
+
+    def path(number)
+      code_dir = File.dirname(__FILE__) + "/../../support/codes"
+      filename = number.to_s.rjust(3, "0") + ".tsv"
+      File.join(code_dir, filename)
+    end
+
+    def data(number)
+      File.open(path(number)) { |f| f.read }
+    end
+
+    public
+
+    # These are here for backwards compatability with the onix gem <= 0.8.3
+    AUDIENCE_CODE        = ONIX2::Lists.audience_code
+    CONTRIBUTOR_ROLE     = ONIX2::Lists.contributor_role
+    COUNTRY_CODE         = ONIX2::Lists.country_code
+    LANGUAGE_CODE        = ONIX2::Lists.language_code
+    LANGUAGE_ROLE        = ONIX2::Lists.language_role
+    NOTIFICATION_TYPE    = ONIX2::Lists.notification_type
+    PRODUCT_AVAILABILITY = ONIX2::Lists.product_availability
+    PRODUCT_FORM         = ONIX2::Lists.product_form
+    PRODUCT_FORM_DETAIL  = ONIX2::Lists.product_form_detail
+
+  end
+end