editx 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.1.0 (23rd March 2009)
+- Initial Release

data/README.markdown

@@ -0,0 +1,33 @@
+## EDItX
+
+The EDItX standard specifies a collection of XML schemas for Electronic
+Document Interchange between trading partners in the publishing industry.
+
+This library provides a slim layer of the formats and simplifies both reading a
+nd writing of EDItX files in your ruby applications.
+
+## Installation
+
+    gem install editx
+
+## Usage
+
+See the comments for each root message type for detailed usage info.
+
+* EDItX::Order - For working with EDItX Trade Order messages
+
+## Licensing
+
+This library is distributed under the terms of the MIT License. See the included file for
+more detail.
+
+## Contributing
+
+All suggestions and patches welcome, preferably via a git repository I can pull from.
+To be honest, I'm not really expecting any, this is a niche library.
+
+## Further Reading
+
+- The source: [http://github.com/yob/editx/tree/master](http://github.com/yob/editx/tree/master)
+- Rubyforge project: [http://rubyforge.org/projects/rbook/](http://rubyforge.org/projects/rbook/)
+- The official specs [http://www.editeur.org/editx/editx.html](http://www.editeur.org/editx/editx.html)

data/lib/editx.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'bigdecimal'
+
+# ensure we load the correct gem versions
+gem 'roxml', '2.5.2'
+gem 'andand'
+
+# and now load the actual gems
+require 'roxml'
+require 'andand'
+
+module EDItX
+  module Version #:nodoc:
+    Major = 0
+    Minor = 1
+    Tiny  = 0
+
+    String = [Major, Minor, Tiny].join('.')
+  end
+
+  class Formatters
+    def self.decimal
+      lambda do |val|
+        if val.kind_of?(BigDecimal)
+          val.to_s("F")
+        else
+          val.to_s
+        end
+      end
+    end
+
+    def self.yyyymmdd
+      lambda do |val|
+        if val.nil? || !val.respond_to?(:strftime)
+          nil
+        else
+          val.strftime("%Y%m%d")
+        end
+      end
+    end
+
+    def self.two_digit
+      lambda do |val|
+        if val.nil?
+          nil
+        elsif val < 10
+          "0#{val}"
+        elsif val > 99
+          val.to_s[-2,2]
+        else
+          val.to_s
+        end
+      end
+    end
+  end
+end
+
+# silence some warnings from ROXML
+unless ROXML.const_defined?("SILENCE_XML_NAME_WARNING")
+  ROXML::SILENCE_XML_NAME_WARNING = true
+end
+
+# core files
+# - ordering is important, classes need to be defined before any
+#   other class can use them
+require File.join(File.dirname(__FILE__), "editx", "order", "reference_coded")
+require File.join(File.dirname(__FILE__), "editx", "order", "date_coded")
+require File.join(File.dirname(__FILE__), "editx", "order", "party")
+require File.join(File.dirname(__FILE__), "editx", "order", "product_id")
+require File.join(File.dirname(__FILE__), "editx", "order", "order_item_qualifier_coded")
+require File.join(File.dirname(__FILE__), "editx", "order", "price")
+require File.join(File.dirname(__FILE__), "editx", "order", "discount_part")
+require File.join(File.dirname(__FILE__), "editx", "order", "discount_detail")
+require File.join(File.dirname(__FILE__), "editx", "order", "returns_condition_coded")
+require File.join(File.dirname(__FILE__), "editx", "order", "returns_conditions")
+require File.join(File.dirname(__FILE__), "editx", "order", "message")
+require File.join(File.dirname(__FILE__), "editx", "order", "item_detail")
+require File.join(File.dirname(__FILE__), "editx", "order")

data/lib/editx/order.rb

@@ -0,0 +1,116 @@
+require 'tempfile'
+
+module EDItX
+  # A abstraction for creating and generating EDItX Trade Order messages
+  #
+  # == Generating a new order
+  #
+  # The fundamentals are fairly simple. You create a new Order object, set various 
+  # attributes on it, then add 1 or more ItemDetail objects - 1 for each item you
+  # would like to order.
+  #
+  #   msg = EDItX::Order.new
+  #   msg.order_number = self.id
+  #   msg.issue_date_time = self.created_at
+  #   msg.fill_terms_code = "FillPartBackorderRemainderShipAsAvailable"
+  #
+  #   (1..10).each do |idx|
+  #     item = EDItX::Order::ItemDetail.new
+  #     item.line_number = idx
+  #
+  #     ean = EDItX::Order::ProductID.new$
+  #     ean.type = "EAN13"$
+  #     ean.identifier = "product code goes here"$
+  #     item.identifiers << ean
+  #
+  #     p = EDItX::Order::Price.new
+  #     p.monetary_amount = 10.00
+  #     item.prices << p
+  #
+  #     item.title_detail = "Title and author here"
+  #     item.order_quantity
+  #     msg.items << item
+  #   end
+  #
+  #   puts msg.to_s
+  #
+  # The challenge comes in making sure you output a VALID order file. Several elements are
+  # compulsory - I reccommend having a copy of the spec open to check which elements you
+  # need to include, and valid options for elements like fill_terms_code.
+  #
+  # To check the validity of your output, save it to a file and run xmllint on it, using
+  # the schemas distributed with this gem:
+  #
+  #   xmllint --valid --nonet --schema schemas/order_1_2.xsd testfile.ord
+  #
+  # Continue testing with that command until you get output like "testfile.ord validates".
+  #
+  class Order
+    include ROXML
+
+    xml_name "Order"
+
+    # header values
+    xml_accessor :version, :from => "@version", :as => BigDecimal, :to_xml => EDItX::Formatters.decimal
+    xml_accessor :order_number, :in => "Header", :from => "OrderNumber"
+    xml_accessor :issue_date_time, :in => "Header", :from => "IssueDateTime", :as => DateTime, :to_xml => EDItX::Formatters.yyyymmdd
+    xml_accessor :references, :in => "Header", :from => "ReferenceCoded", :as => [EDItX::Order::ReferenceCoded]
+    xml_accessor :purpose_code, :in => "Header", :from => "PurposeCode"
+    xml_accessor :currency_code, :in => "Header", :from => "CurrencyCode"
+    xml_accessor :country_code, :in => "Header", :from => "CountryCode"
+    xml_accessor :dates, :in => "Header", :from => "DateCoded", :as => [EDItX::Order::DateCoded]
+    xml_accessor :fill_terms_code, :in => "Header", :from => "FillTermsCode"
+    xml_accessor :buyer_party, :in => "Header", :from => "BuyerParty", :as => EDItX::Order::Party
+    xml_accessor :seller_party, :in => "Header", :from => "SellerParty", :as => EDItX::Order::Party
+    xml_accessor :ship_to_party, :in => "Header", :from => "ShipToParty", :as => EDItX::Order::Party
+    xml_accessor :bill_to_party, :in => "Header", :from => "BillToParty", :as => EDItX::Order::Party
+    xml_accessor :shipping_instructions_code, :in => "Header", :from => "ShippingInstructionsCode"
+    xml_accessor :invoice_instructions_code, :in => "Header", :from => "InvoiceInstructionsCode"
+    xml_accessor :discount_percentage, :in => "Header", :from => "DiscountPercentage", :as => BigDecimal, :to_xml => EDItX::Formatters.decimal
+
+    # detail
+    xml_accessor :items, :from => "ItemDetail", :as => [EDItX::Order::ItemDetail]
+
+    # footer / summary
+    xml_accessor :number_of_lines, :in => "Summary", :from => "NumberOfLines", :as => Fixnum
+    xml_accessor :units_ordered, :in => "Summary", :from => "UnitsOrdered", :as => Fixnum
+
+    def initialize
+      self.version = BigDecimal.new("1.2")
+      self.references = []
+      self.dates = []
+      self.items = []
+    end
+
+    def to_s
+      self.to_xml.to_s
+    end
+
+    def valid?
+      schema_path = File.join(File.dirname(__FILE__), "..", "..", "schemas")
+      case self.version
+      when BigDecimal.new("1.0")
+        schema_path << "/order_1_0.xsd"
+      when BigDecimal.new("1.1")
+        schema_path << "/order_1_1.xsd"
+      when BigDecimal.new("1.2")
+        schema_path << "/order_1_2.xsd"
+      else
+        raise ArgumentError, "version #{self.version} is invalid"
+      end
+
+      Tempfile.open("editx") do |tf|
+        tf.write self.to_s
+        tf.close
+
+        system("xmllint --schema #{schema_path} #{tf.path} &> /dev/null")
+        if $?.exitstatus == 0
+          return true
+        else
+          return false
+        end
+      end
+    end
+  end
+
+end

data/lib/editx/order/date_coded.rb

@@ -0,0 +1,13 @@
+module EDItX
+  class Order
+    class DateCoded
+      include ROXML
+
+      xml_name "DateCoded"
+
+      xml_accessor :date, :from => "Date", :as => Date, :to_xml => EDItX::Formatters.yyyymmdd
+      xml_accessor :qualifier_code, :from => "DateQualifierCode"
+    end
+  end
+
+end

data/lib/editx/order/discount_detail.rb

@@ -0,0 +1,18 @@
+module EDItX
+  class Order
+    class DiscountDetail
+      include ROXML
+
+      xml_name "DiscountDetail"
+
+      xml_accessor :code_type, :from => "DiscountCodeType"
+      xml_accessor :parts, :from => "DiscountPart", :as => [EDItX::Order::DiscountPart]
+
+      def initialize
+        @parts = []
+      end
+
+    end
+  end
+end
+

data/lib/editx/order/discount_part.rb

@@ -0,0 +1,14 @@
+module EDItX
+  class Order
+    class DiscountPart
+      include ROXML
+
+      xml_name "DiscountPart"
+
+      xml_accessor :code, :from => "DiscountCode"
+      xml_accessor :percentage, :from => "DiscountPercentage"
+
+    end
+  end
+end
+

data/lib/editx/order/item_detail.rb

@@ -0,0 +1,33 @@
+module EDItX
+  class Order
+    class ItemDetail
+      include ROXML
+
+      xml_name "ItemDetail"
+
+      xml_accessor :line_number, :from => "LineNumber", :as => Fixnum
+      xml_accessor :identifiers, :from => "ProductID", :as => [EDItX::Order::ProductID]
+      xml_accessor :title_detail, :in => "ItemDescription", :from => "TitleDetail"
+      xml_accessor :order_quantity, :from => "OrderQuantity", :as => Fixnum
+      xml_accessor :references, :from => "ReferenceCoded", :as => [EDItX::Order::ReferenceCoded]
+      xml_accessor :dates, :from => "DateCoded", :as => [EDItX::Order::DateCoded]
+      xml_accessor :fill_terms_code, :from => "FillTermsCode"
+      xml_accessor :qualifiers, :from => "OrderItemQualifierCoded", :as => [EDItX::Order::OrderItemQualifierCoded]
+      xml_accessor :prices, :in => "PricingDetail", :from => "Price", :as => [EDItX::Order::Price]
+      xml_accessor :discount_percentage, :in => "PricingDetail", :from => "DiscountPercentage", :as => BigDecimal
+      xml_accessor :discount_detail, :in => "PricingDetail", :from => "DiscountDetail", :as => [EDItX::Order::DiscountDetail]
+      xml_accessor :returns_conditions, :from => "ReturnsConditions", :as => [EDItX::Order::ReturnsConditions]
+      xml_accessor :messages, :from => "Message", :as => [EDItX::Order::Message]
+
+      def initialize
+        @identifiers = []
+        @references  = []
+        @dates       = []
+        @qualifiers  = []
+        @prices      = []
+        @returns_conditions = []
+      end
+
+    end
+  end
+end

data/lib/editx/order/message.rb

@@ -0,0 +1,18 @@
+module EDItX
+  class Order
+    class Message
+      include ROXML
+
+      xml_name "Message"
+
+      xml_accessor :type, :from => "MessageType"
+      xml_accessor :lines, :from => "MessageLine", :as => []
+
+      def initialize
+        @lines = []
+      end
+
+    end
+  end
+end
+

data/lib/editx/order/order_item_qualifier_coded.rb

@@ -0,0 +1,14 @@
+module EDItX
+  class Order
+    class OrderItemQualifierCoded
+      include ROXML
+
+      xml_name "OrderItemQualifierCoded"
+
+      xml_accessor :code_type, :from => "OrderItemQualifierCodeType"
+      xml_accessor :code, :from => "OrderItemQualifierCode"
+
+    end
+  end
+end
+

data/lib/editx/order/party.rb

@@ -0,0 +1,12 @@
+module EDItX
+  class Order
+    class Party
+      include ROXML
+
+      xml_accessor :id_type, :in => "PartyID", :from => "PartyIDType"
+      xml_accessor :id, :in => "PartyID", :from => "Identifier"
+      xml_accessor :name, :in => "PartyName", :from => "NameLine"
+
+    end
+  end
+end

data/lib/editx/order/price.rb

@@ -0,0 +1,16 @@
+module EDItX
+  class Order
+    class Price
+      include ROXML
+
+      xml_name "Price"
+
+      xml_accessor :monetary_amount, :from => "MonetaryAmount", :as => BigDecimal
+      xml_accessor :currency_code, :from => "CurrencyCode"
+      xml_accessor :country_code, :from => "CountryCode"
+      xml_accessor :qualifier_code, :from => "PriceQualifierCode"
+
+    end
+  end
+end
+

data/lib/editx/order/product_id.rb

@@ -0,0 +1,15 @@
+module EDItX
+  class Order
+    class ProductID
+      include ROXML
+
+      xml_name "ProductID"
+
+      xml_accessor :type, :from => "ProductIDType"
+      xml_accessor :type_name, :from => "ProductIDType"
+      xml_accessor :identifier, :from => "Identifier"
+
+    end
+  end
+end
+

data/lib/editx/order/reference_coded.rb

@@ -0,0 +1,15 @@
+module EDItX
+  class Order
+    class ReferenceCoded
+
+      include ROXML
+
+      xml_name "ReferenceCoded"
+
+      xml_accessor :type_code, :from => "ReferenceTypeCode"
+      xml_accessor :number, :from => "ReferenceNumber"
+      xml_accessor :date, :from => "ReferenceDate", :as => Date, :to_xml => EDItX::Formatters.yyyymmdd
+
+    end
+  end
+end

data/lib/editx/order/returns_condition_coded.rb

@@ -0,0 +1,14 @@
+module EDItX
+  class Order
+    class ReturnsConditionCoded
+      include ROXML
+
+      xml_name "ReturnsConditionCoded"
+
+      xml_accessor :type, :from => "ReturnsConditionCodeType"
+      xml_accessor :code, :from => "ReturnsConditionCode"
+
+    end
+  end
+end
+

data/lib/editx/order/returns_conditions.rb

@@ -0,0 +1,19 @@
+module EDItX
+  class Order
+    class ReturnsConditions
+      include ROXML
+
+      xml_name "ReturnsConditions"
+
+      xml_accessor :last_date_for_returns, :from => "LastDateForReturns", :as => DateTime, :to_xml => EDItX::Formatters.yyyymmdd
+      xml_accessor :max_returns_percentage, :from => "MaximumReturnsPercentage"
+      xml_accessor :max_returns_quantity, :from => "MaximumReturnsQuantity"
+      xml_accessor :conditions, :from => "ReturnsConditionCoded", :as => [EDItX::Order::ReturnsConditionCoded]
+
+      def initialize
+        @conditions = []
+      end
+
+    end
+  end
+end