onix 0.4.0

data/CHANGELOG

@@ -0,0 +1,30 @@
+v0.4.0 (28th October 2008)
+- Major rework: now based on ROXML instead of xml-mapping
+  - Mostly API Compatible
+  - StreamReader and StreamWriter renamed to Reader and Writer
+  - ROXML is based on libxml, so things should be significantly faster
+
+v0.2.7 (Unreleased)
+- Add line breaks after each product
+
+v0.2.5 (Unreleased)
+- Make PublishingStatus a two_digit_node
+
+v0.2.4 (Unreleased)
+- Initialise the media files array of a new product correctly
+
+v0.2.3 (Unreleased)
+- Switch a few more fields over to TwoDigitNodes
+- Make the product availability field accessible from APAProduct
+
+v0.2.2 (Unreleased)
+- Add a new nodetype (DateNode) for YYYYMMDD fields
+
+v0.2.1 (Unreleased)
+- Add a new nodetype (TwoDigitNode) for two digit codes
+
+v0.2.0 (16th July 2008)
+- Add support for reading and storing subject codes (BIC, BISAC, etc)
+
+v0.1.0 (12th June 2008)
+- Initial Release

data/README.rdoc

@@ -0,0 +1,30 @@
+== ONIX
+
+The ONIX standard is a somewhat verbose XML format that is rapidly becoming the
+industry standard for electronic data sharing in the book and publishing
+industries.
+
+This library provides a slim layer over the format and simplifies both reading
+and writing ONIX files in your ruby applications.
+
+== Installation
+
+    gem install onix
+
+== Usage
+
+See files in the examples directory to get started quickly. For further reading
+view the comments to the following classes:
+
+* ONIX::Reader - For reading ONIX files
+* ONIX::Writer - For writing ONIX files
+
+== Contributing
+
+All suggestions and patches welcome, preferably via a git repository I can pull from.
+
+== Further Reading
+
+- The source: (http://github.com/yob/onix/tree/master)[http://github.com/yob/onix/tree/master]
+- Rubyforge project: (http://rubyforge.org/projects/rbook/)[http://rubyforge.org/projects/rbook/]
+- The official specs (http://www.editeur.org/onix.html)[http://www.editeur.org/onix.html]

data/TODO

@@ -0,0 +1,14 @@
+- finish adding support for all tags in a Product record
+  - contributor still needs some obscure tags added
+- add a new node type for dates that should be in the form YYYYMMDD
+- allow symbols to be used instead of numeric codes
+  - contribution type, id type, etc
+- validations
+  - hard stuff from the spec
+    - 2 digit numbers, 8 digit dates, char limits on text fields
+  - code lists
+    - only values in code lists allowed in relevant fields
+  - regional requirements
+    - titlepage minimum set of tags
+    - APA (if different to titlepage)
+- documentation

data/lib/onix.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+
+# ensure we load the correct gem versions
+gem 'yob-roxml', '2.1.1'
+gem 'andand'
+
+# and now load the actual gems
+require 'roxml'
+require 'andand'
+
+# custom xml-mapping node types
+require File.join(File.dirname(__FILE__), "onix", "etext_type")
+require File.join(File.dirname(__FILE__), "onix", "integer_type")
+require File.join(File.dirname(__FILE__), "onix", "two_digit_type")
+require File.join(File.dirname(__FILE__), "onix", "date_type")
+
+# core files
+# - ordering is important, classes need to be defined before any
+#   other class can use them
+require File.join(File.dirname(__FILE__), "onix", "sender_identifier")
+require File.join(File.dirname(__FILE__), "onix", "addressee_identifier")
+require File.join(File.dirname(__FILE__), "onix", "header")
+require File.join(File.dirname(__FILE__), "onix", "product_identifier")
+require File.join(File.dirname(__FILE__), "onix", "title")
+require File.join(File.dirname(__FILE__), "onix", "website")
+require File.join(File.dirname(__FILE__), "onix", "contributor")
+require File.join(File.dirname(__FILE__), "onix", "subject")
+require File.join(File.dirname(__FILE__), "onix", "other_text")
+require File.join(File.dirname(__FILE__), "onix", "media_file")
+require File.join(File.dirname(__FILE__), "onix", "imprint")
+require File.join(File.dirname(__FILE__), "onix", "publisher")
+require File.join(File.dirname(__FILE__), "onix", "sales_restriction")
+require File.join(File.dirname(__FILE__), "onix", "stock")
+require File.join(File.dirname(__FILE__), "onix", "price")
+require File.join(File.dirname(__FILE__), "onix", "supply_detail")
+require File.join(File.dirname(__FILE__), "onix", "product")
+require File.join(File.dirname(__FILE__), "onix", "reader")
+require File.join(File.dirname(__FILE__), "onix", "writer")
+
+# lists
+require File.join(File.dirname(__FILE__), "onix", "lists", "product_form")
+require File.join(File.dirname(__FILE__), "onix", "lists", "product_availability")
+
+# product wrappers
+require File.join(File.dirname(__FILE__), "onix", "simple_product")
+require File.join(File.dirname(__FILE__), "onix", "apa_product")
+
+module ONIX
+  module Version #:nodoc:
+    Major = 0
+    Minor = 4
+    Tiny  = 0
+
+    String = [Major, Minor, Tiny].join('.')
+  end
+
+end

data/lib/onix/addressee_identifier.rb

@@ -0,0 +1,9 @@
+module ONIX
+  class AddresseeIdentifier
+    include ROXML
+
+    xml_accessor :addressee_id_type, :twodigit, :from => "AddresseeIDType"
+    xml_accessor :id_type_name,      :from => "IDTypeName"
+    xml_accessor :id_value,          :from => "IDValue"
+  end
+end

data/lib/onix/apa_product.rb

@@ -0,0 +1,534 @@
+module ONIX
+  class APAProduct < SimpleProduct
+
+    delegate :record_reference, :record_reference=
+    delegate :notification_type, :notification_type=
+    delegate :product_form, :product_form=
+    delegate :series, :series=
+    delegate :edition, :edition=
+    delegate :number_of_pages, :number_of_pages=
+    delegate :bic_main_subject, :bic_main_subject=
+    delegate :publishing_status, :publishing_status=
+    delegate :publication_date, :publication_date=
+
+    # retrieve the current EAN
+    def ean
+      identifier(3).andand.id_value
+    end
+
+    # set a new EAN
+    def ean=(isbn)
+      identifier_set(3, isbn)
+    end
+
+    # retrieve the proprietary ID
+    def proprietary_id
+      identifier(1).andand.id_value
+    end
+
+    # set a new proprietary ID
+    def proprietary_id=(isbn)
+      identifier_set(1, isbn)
+    end
+
+    # retrieve the current ISBN 10
+    def isbn10
+      identifier(2).andand.id_value
+    end
+
+    # set a new ISBN 10
+    def isbn10=(isbn)
+      identifier_set(2, isbn)
+    end
+
+    # retrieve the current ISBN 13
+    def isbn13
+      identifier(15).andand.id_value
+    end
+
+    # set a new ISBN 13
+    def isbn13=(isbn)
+      identifier_set(15, isbn)
+    end
+
+    # retrieve the current title
+    def title
+      composite = product.titles.first
+      if composite.nil?
+        nil
+      else
+        composite.title_text || composite.title_without_prefix
+      end
+    end
+
+    # set a new title
+    def title=(str)
+      composite = product.titles.first
+      if composite.nil?
+        composite =  ONIX::Title.new
+        composite.title_type = 1
+        product.titles << composite
+      end
+      composite.title_text = str
+    end
+
+    # retrieve the current subtitle
+    def subtitle
+      composite = product.titles.first
+      if composite.nil?
+        nil
+      else
+        composite.subtitle
+      end
+    end
+
+    # set a new subtitle
+    def subtitle=(str)
+      composite = product.titles.first
+      if composite.nil?
+        composite =  ONIX::Title.new
+        composite.title_type = 1
+        product.titles << composite
+      end
+      composite.subtitle = str
+    end
+
+    # retrieve the current publisher website for this particular product
+    def publisher_website
+      website(2).andand.website_link
+    end
+
+    # set a new publisher website for this particular product
+    def publisher_website=(str)
+      website_set(2, str)
+    end
+
+    # retrieve the current supplier website for this particular product
+    def supplier_website
+      website(12).andand.website_link
+    end
+
+    # set a new supplier website for this particular product
+    def supplier_website=(str)
+      website_set(12, str)
+    end
+
+    # retrieve an array of all contributors
+    def contributors
+      product.contributors.collect { |contrib| contrib.person_name_inverted || contrib.person_name}
+    end
+
+    # set a new contributor to this product
+    # str should be the contributors name inverted (Healy, James)
+    def add_contributor(str, role = "A01")
+      contrib = ::ONIX::Contributor.new
+      contrib.sequence_number = product.contributors.size + 1
+      contrib.contributor_role = role
+      contrib.person_name_inverted = str
+      product.contributors << contrib
+    end
+
+    # return an array of BIC subjects for this title
+    # could be version 1 or version 2, most ONIX files don't
+    # specifiy
+    def bic_subjects
+      subjects = product.subjects.select { |sub| sub.subject_scheme_id.to_i == 12 }
+      subjects.collect { |sub| sub.subject_code}
+    end
+
+    # add a BIC subject code to the product
+    def add_bic_subject(code)
+      add_subject code, "12"
+    end
+
+    # return an array of BISAC subjects for this title
+    def bisac_subjects
+      subjects = product.subjects.select { |sub| sub.subject_scheme_id.to_i == 10 }
+      subjects.collect { |sub| sub.subject_code}
+    end
+
+    # add a BISAC subject code to the product
+    def add_bisac_subject(code)
+      add_subject code, "10"
+    end
+
+    # retrieve the url to the product cover image
+    def cover_url
+      media_file(4).andand.media_file_link
+    end
+
+    # set the url to the product cover image
+    def cover_url=(url)
+      media_file_set(4,url)
+    end
+
+    # retrieve the url to the high quality product cover image
+    def cover_url_hq
+      media_file(6).andand.media_file_link
+    end
+
+    # set the url to the high quality product cover image
+    def cover_url_hq=(url)
+      media_file_set(6,url)
+    end
+
+    # retrieve the url to the product thumbnail
+    def thumbnail_url
+      media_file(7).andand.media_file_link
+    end
+
+    # set the url to the product cover image
+    def thumbnail_url=(url)
+      media_file_set(7,url)
+    end
+
+    # retrieve the main description
+    def main_description
+      other_text(1).andand.text
+    end
+
+    # set the main description
+    def main_description=(t)
+      other_text_set(1,t)
+    end
+
+    # retrieve the short description
+    def short_description
+      other_text(2).andand.text
+    end
+
+    # set the short description
+    def short_description=(t)
+      other_text_set(2,t)
+    end
+
+    # retrieve the long description
+    def long_description
+      other_text(3).andand.text
+    end
+
+    # set the long description
+    def long_description=(t)
+      other_text_set(3,t)
+    end
+
+    # retrieve the imprint
+    def imprint
+      composite = product.imprints.first
+      composite ? composite.imprint_name : nil
+    end
+
+    # set a new imprint
+    def imprint=(str)
+      composite = product.imprints.first
+      if composite.nil?
+        composite =  ONIX::Imprint.new
+        product.imprints << composite
+      end
+      composite.imprint_name = str
+    end
+
+    # retrieve the publisher
+    def publisher
+      publisher_get(1).andand.publisher_name
+    end
+
+    # set a new publisher
+    def publisher=(str)
+      publisher_set(1, str)
+    end
+
+    # retrieve the sales restriction type
+    def sales_restriction_type
+      composite = product.sales_restrictions.first
+      composite.nil? ? nil : composite.imprint_name
+    end
+
+    # set a new sales restriction type
+    def sales_restriction_type=(type)
+      composite = product.sales_restrictions.first
+      if composite.nil?
+        composite =  ONIX::SalesRestriction.new
+        product.sales_restrictions << composite
+      end
+      composite.sales_restriction_type = type
+    end
+
+    # retrieve the supplier name
+    def supplier_name
+      composite = product.supplier_details.first
+      composite.nil? ? nil : composite.supplier_name
+    end
+
+    # set a new supplier name
+    def supplier_name=(str)
+      composite = find_or_create_supply_detail
+      composite.supplier_name = str
+    end
+
+    # retrieve the supplier phone number
+    def supplier_phone
+      composite = product.supplier_details.first
+      composite.nil? ? nil : composite.telephone_number
+    end
+
+    # set a new supplier phone number
+    def supplier_phone=(str)
+      composite = find_or_create_supply_detail
+      composite.telephone_number = str
+    end
+
+    # retrieve the supplier fax number
+    def supplier_fax
+      composite = product.supplier_details.first
+      composite.nil? ? nil : composite.fax_number
+    end
+
+    # set a new supplier fax number
+    def supplier_fax=(str)
+      composite = find_or_create_supply_detail
+      composite.fax_number = str
+    end
+
+    # retrieve the supplier email address
+    def supplier_email
+      composite = product.supplier_details.first
+      composite.nil? ? nil : composite.email_address
+    end
+
+    # set a new supplier email address
+    def supplier_email=(str)
+      composite = find_or_create_supply_detail
+      composite.email_address = str
+    end
+
+    # retrieve the supply country code
+    def supply_country
+      composite = product.supplier_details.first
+      composite.nil? ? nil : composite.supply_to_country
+    end
+
+    # set a new supply country code
+    def supply_country=(str)
+      composite = find_or_create_supply_detail
+      composite.supply_to_country = str
+    end
+
+    # retrieve the product availability code
+    def product_availability
+      composite = product.supplier_details.first
+      composite.nil? ? nil : composite.product_availability
+    end
+
+    # set a new product availability
+    def product_availability=(num)
+      composite = find_or_create_supply_detail
+      composite.product_availability = num
+    end
+
+    # retrieve the number in stock
+    def on_hand
+      supply = find_or_create_supply_detail
+      composite = supply.stock.first
+      if composite.nil?
+        composite = ONIX::Stock.new
+        supply.stock << composite
+      end
+      composite.on_hand
+    end
+
+    # set a new in stock quantity
+    def on_hand=(num)
+      supply = find_or_create_supply_detail
+      composite = supply.stock.first
+      if composite.nil?
+        composite = ONIX::Stock.new
+        supply.stock << composite
+      end
+      composite.on_hand = num
+    end
+
+    # retrieve the number on order
+    def on_order
+      supply = find_or_create_supply_detail
+      composite = supply.stock.first
+      if composite.nil?
+        composite = ONIX::Stock.new
+        supply.stock << composite
+      end
+      composite.on_order
+    end
+
+    # set a new on order quantity
+    def on_order=(num)
+      supply = find_or_create_supply_detail
+      composite = supply.stock.first
+      if composite.nil?
+        composite = ONIX::Stock.new
+        supply.stock << composite
+      end
+      composite.on_order = num
+    end
+
+    # retrieve the rrp excluding any sales tax
+    def rrp_exc_sales_tax
+      price_get(1).andand.price_amount
+    end
+
+    # set the rrp excluding any sales tax
+    def rrp_exc_sales_tax=(num)
+      price_set(1, num)
+    end
+
+    # retrieve the rrp including any sales tax
+    def rrp_inc_sales_tax
+      price_get(2).andand.price_amount
+    end
+
+    # set the rrp including any sales tax
+    def rrp_inc_sales_tax=(num)
+      price_set(2, num)
+    end
+
+    private
+
+    # add a new subject to this product
+    # str should be the subject code
+    # type should be the code for the subject scheme you're using. See ONIX codelist 27.
+    # 12 is BIC
+    def add_subject(str, type = "12")
+      subject = ::ONIX::Subject.new
+      subject.subject_scheme_id = type.to_i
+      subject.subject_code = str
+      product.subjects << subject
+    end
+
+    def find_or_create_supply_detail
+      composite = product.supply_details.first
+      if composite.nil?
+        composite =  ONIX::SupplyDetail.new
+        product.supply_details << composite
+      end
+      composite
+    end
+
+    # retrieve the value of a particular ID
+    def identifier(type)
+      product.product_identifiers.find { |id| id.product_id_type == type }
+    end
+
+    # set the value of a particular ID
+    def identifier_set(type, value)
+      isbn_id = identifier(type)
+
+      # create a new isbn record if we need to
+      if isbn_id.nil?
+        isbn_id = ONIX::ProductIdentifier.new
+        isbn_id.product_id_type = type
+        product.product_identifiers << isbn_id
+      end
+
+      isbn_id.id_value = value
+    end
+
+    # retrieve the value of a particular media file
+    def media_file(type)
+      product.media_files.find { |m| m.media_file_type_code == type }
+    end
+
+    # set the value of a particular ID
+    def media_file_set(type, value)
+      media = media_file(type)
+
+      # create a new isbn record if we need to
+      if media.nil?
+        media = ONIX::MediaFile.new
+        media.media_file_type_code = type
+        product.media_files << media
+      end
+
+      # store the new value
+      media.media_file_link = value.to_s
+    end
+
+    # retrieve the value of a particular price
+    def price_get(type)
+      supply = find_or_create_supply_detail
+      supply.prices.find { |p| p.price_type_code == type }
+    end
+
+    # set the value of a particular price
+    def price_set(type, num)
+      p = price_get(type)
+
+      # create a new isbn record if we need to
+      if p.nil?
+        supply = find_or_create_supply_detail
+        p = ONIX::Price.new
+        p.price_type_code = type
+        supply.prices << p
+      end
+
+      # store the new value
+      p.price_amount = num
+    end
+
+    # retrieve the value of a particular publisher
+    def publisher_get(type)
+      product.publishers.find { |pub| pub.publishing_role == type }
+    end
+
+    # set the value of a particular ID
+    def publisher_set(type, value)
+      pub = publisher_get(type)
+
+      # create a new isbn record if we need to
+      if pub.nil?
+        pub = ONIX::Publisher.new
+        pub.publishing_role = type
+        product.publishers << pub
+      end
+
+      # store the new value
+      pub.publisher_name = value.to_s
+    end
+
+    # retrieve the value of a particular other text value
+    def other_text(type)
+      product.text.find { |t| t.text_type_code == type }
+    end
+
+    # set the value of a particular other text value
+    def other_text_set(type, value)
+      text = other_text(type)
+
+      if text.nil?
+        text = ONIX::OtherText.new
+        text.text_type_code = type
+        self.text << text
+      end
+
+      # store the new value
+      text.text = value.to_s
+    end
+
+    # retrieve the value of a particular website
+    def website(type)
+      product.websites.find { |site| site.website_role == type }
+    end
+
+    # set the value of a particular website
+    def website_set(type, value)
+      site = website(type)
+
+      # create a new website record if we need to
+      if site.nil?
+        site = ONIX::Website.new
+        site.website_role = type
+        product.websites << site
+      end
+
+      site.website_link = value.to_s
+    end
+  end
+end