openils-mapper 0.8.2

data/README.rdoc

@@ -0,0 +1,60 @@
+= Introduction
+
+This module adds methods to edi4r's EDI::E::Interchange class to map between EDIFACT, Ruby structures, and JSON strings. It takes JSON input and turns it into valid, well-formatted EDIFACT messages. In order to provide the greatest range of flexibility, the mapper can process two types of input interchangeably: low-level (or raw) and high-level.
+
+== Low-Level
+
+Low-level input describes the exact structure of the required EDIFACT segments and data elements, without having to worry about syntax or exact placement. Any segment, simple data element (DE), or composite data element (CDE) can be specified directly. The tradeoff, of course, is that the application sending the JSON message has to be intimately aware of the underlying EDIFACT message's structure, including all segment and DE/CDE order, data types, and code lists. For example, the following EDIFACT segments describe a vendor (SU) identified by its Standard Address Number (code 31B), and with an internal department code (1865, qualified by the code IA):
+
+  NAD+SU+1556150::31B'
+  RFF+IA:1865'
+
+The low-level JSON representation of those two segments looks like this:
+
+  [
+    'NAD', { '3035' : 'SU', 'C082' : { '3039' : '1556150', '3055' : '31B' }},
+    'RFF', { 'C506' : { '1153' : 'IA', '1154' : '1865' }}
+  ]
+
+In this case, the JSON is more verbose than the raw EDIFACT, but at least it insulates the caller from the details of element order, blank DEs, and character escaping.
+
+== High-Level
+
+The mapper's high-level mode defines a number of pseudo-segments that know how to translate themselves into their low-level counterparts. For example, to create a simple supplier segment with an ID and using the defaults for everything else:
+
+  ['vendor', '1556150']
+  => NAD+SU+1556150::91'
+
+But it's easy to override some of the defaults and add extra segment information as well:
+
+  ['vendor', { 'id' : '1556150', 'id-qual' : '31B', 'reference' : { 'IA' : '1865' }}]
+  => NAD+SU+1556150::31B'
+     RFF+IA:1865'
+
+Another example involves the descriptive metadata sent with each line item in a purchase order. Strings longer than 35 characters have to be split across multiple DEs, and strings longer than 70 characters require multiple iterations of the IMD segment:
+
+  IMD+F+BAU+:::Campbell, James'
+  IMD+F+BTI+:::The Ghost Mountain boys ?: their epi:c march and the terrifying battle f'
+  IMD+F+BTI+:::or New Guinea -- the forgotten war :of the South Pacific'
+  IMD+F+BPU+:::Crown Publishers'
+  IMD+F+BPD+:::2007'''
+
+Note the character escaping (?:) and segmentation (:), as well as the repetition of the IMD title (BTI) field to accommodate the long string. The high level version can look like this:
+
+  [
+  'desc', { 'BAU' : 'Campbell, James' },
+  'desc', { 'BTI' : "The Ghost Mountain boys : their epic march and the terrifying battle for New Guinea -- the forgotten war of the South Pacific" },
+  'desc', { 'BPU' : 'Crown Publishers' },
+  'desc', { 'BPD' : 2007 }
+  ]
+
+or even like this:
+
+  ['desc', [
+    'BAU', 'Campbell, James',
+    'BTI', "The Ghost Mountain boys : their epic march and the terrifying battle for New Guinea -- the forgotten war of the South Pacific",
+    'BPU', 'Crown Publishers',
+    'BPD', 2007
+  ]]
+  
+Since the mapper uses regular expressions and closures to define and evaluate the high-level pseudo-segments, the mapper can be extended very easily (in some cases, trivially), and with great flexibility.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new do |t|
+  t.ruby_opts = ['-I ./lib','-r rubygems']
+  t.spec_opts = ['-c','-f specdoc']
+  t.spec_files = FileList['test/**/*_spec.rb']
+  t.warning = false
+  t.rcov = true
+  t.rcov_opts = ['--exclude',"json,edi4r,rcov,lib/spec,bin/spec,builder,active_"]
+end

data/lib/edi/edi2json.rb

@@ -0,0 +1,76 @@
+require 'json'
+
+module EDI
+
+class Collection
+  include Enumerable
+  
+  def to_hash
+    result = {}
+    
+    self.each { |child|
+      if child.is_a?(Collection)
+        hash = child.to_hash
+        result[child.name] = hash unless hash.empty?
+        unless self.children.empty?
+          segments = []
+          self.children.each { |segment|
+            segments << [segment.name, segment.to_hash]
+          }
+          result[self.sg_name] = segments
+        end
+      else
+        unless child.value.nil?
+          result[child.name] = child.value
+        end
+      end
+    }
+    result
+  end
+  
+  def to_json(*a)
+    self.to_hash.to_json(*a)
+  end
+  
+end
+
+class Interchange
+  
+  def to_hash
+    
+    messages = []
+    self.each { |message|
+      messages << [message.name, message.to_hash]
+    }
+    
+    {
+      'UNA' => self.una.to_s,
+      'header' => [self.header.name, self.header.to_hash],
+      'body' => messages,
+      'trailer' => [self.trailer.name, self.trailer.to_hash]
+    }
+  end
+  
+end
+
+class Message
+  
+  def to_hash
+    segments = []
+    
+    self.find_all { |segment|
+      segment.level < 2
+    }.each { |segment| 
+      segments << [segment.name, segment.to_hash] 
+    }
+    segments << [self.trailer.name, self.trailer.to_hash]
+    {
+      'header' => [self.header.name, self.header.to_hash],
+      'body' => segments,
+      'trailer' => [self.trailer.name, self.trailer.to_hash]
+    }
+  end
+  
+end
+
+end

data/lib/edi/mapper.rb

@@ -0,0 +1,209 @@
+require 'edi4r'
+require 'edi4r/edifact'
+begin
+  require 'edi4r-tdid'
+rescue LoadError
+  warn "WARNING: edi4r-tdid not found. Only EDIFACT versions d96a and d01b will be supported!"
+end
+require 'forwardable'
+require 'json'
+
+class String
+  
+  def chunk(len)
+    re = Regexp.new(".{0,#{len.to_i}}")
+    self.scan(re).flatten.reject { |chunk| chunk.nil? or chunk.empty? }
+  end
+  
+end
+
+module EDI::E
+
+  class Mapper
+    extend Forwardable
+    
+    attr :message
+    attr_accessor :defaults
+    def_delegators :@ic, :charset, :empty?, :groups_created, :header, 
+      :illegal_charset_pattern, :inspect, :is_iedi?, :messages_created, 
+      :output_mode, :output_mode=, :show_una, :show_una=, :syntax, :to_s, 
+      :to_xml, :to_xml_header, :to_xml_trailer, :trailer, :una, :validate, 
+      :version
+    
+    class << self
+      def defaults
+        @defaults || {}
+      end
+      
+      def defaults=(value)
+        unless value.is_a?(Hash)
+          raise TypeError, "Mapper defaults must be in the form of a Hash"
+        end
+        @defaults = value
+      end
+      
+      def map(name,expr = nil,&block)
+        register_mapping(name,expr,block)
+      end
+
+      def register_mapping(name, expr, proc)
+        if segment_handlers.find { |h| h[:name] == name }
+          raise NameError, "A pseudo-segment called '#{name}' is already registered"
+        end
+        if expr.nil?
+          expr = Regexp.new("^#{name}$")
+        end
+        segment_handlers.push({:name => name,:re => expr,:proc => proc})
+      end
+
+      def unregister_mapping(name)
+        segment_handlers.delete_if { |h|
+          h[:name] == name
+        }
+      end
+
+      def find_mapping(name)
+        segment_handlers.find { |h|
+          h[:re].match(name)
+        }
+      end
+      
+      private
+      def segment_handlers
+        if @segment_handlers.nil?
+          @segment_handlers = []
+        end
+        @segment_handlers
+      end
+    end
+    
+    def apply_mapping(name, value)
+      handler = self.class.find_mapping(name)
+      if handler.nil?
+        raise NameError, "Unknown pseudo-segment: '#{name}'"
+      end
+      handler[:proc].call(self, name, value)
+    end
+    
+    def self.from_json(json, ic_opts = {})
+      struct = JSON.parse(json)
+
+      json_opts = {}
+      [:sender,:recipient].each { |party|
+        party_info = struct[party.to_s]
+        if party_info.is_a?(Hash)
+          json_opts[party] = party_info['id']
+          json_opts["#{party}_qual".to_sym] = party_info['id-qualifier']
+        elsif party_info.is_a?(String)
+          (id,qual) = party_info.split(/:/)
+          json_opts[party] = id
+          json_opts["#{party}_qual".to_sym] = qual
+        end
+      }
+      
+      json_msg_opts = {}
+      if struct['msg_opts'].is_a?(Hash)
+        struct['msg_opts'].each_pair { |k,v| json_msg_opts[k.to_sym] = v }
+      end
+      
+      result = self.new(struct['msg_type'], json_msg_opts, ic_opts.merge(json_opts))
+      result.add(struct['msg'])
+      result.finalize
+    end
+
+    def initialize(msg_type, msg_opts = {}, ic_opts = {})
+      # Bug in edi4r 0.9 -- sometimes :recipient is used; sometimes :recip. It doesn't
+      # work. We'll override it.
+      local_ic_opts = ic_opts.reject { |k,v| [:sender,:sender_qual,:recipient,:recipient_qual].include?(k) }
+      @ic = EDI::E::Interchange.new(local_ic_opts || {})
+  
+      # Apply any envelope defaults.
+      ['UNA','UNB','UNZ'].each { |seg|
+        seg_defs = self.class.defaults[seg]
+        if seg_defs
+          seg_defs.each_pair { |cde,defs|
+            segment = @ic.header[cde].first
+            unless segment.nil?
+              defs.each_pair { |de,val|
+                segment[de][0].value = val
+              }
+            end
+          }
+        end
+      }
+
+      @ic.header.cS002.d0004 = ic_opts[:sender] unless ic_opts[:sender].nil?
+      @ic.header.cS002.d0007 = ic_opts[:sender_qual] unless ic_opts[:sender_qual].nil?
+      @ic.header.cS003.d0010 = ic_opts[:recipient] unless ic_opts[:recipient].nil?
+      @ic.header.cS003.d0007 = ic_opts[:recipient_qual] unless ic_opts[:recipient_qual].nil?
+      
+      @message = @ic.new_message( { :msg_type => msg_type, :version => 'D', :release => '96A', :resp_agency => 'UN' }.merge(msg_opts || {}) )
+      @ic.add(@message,false)
+    end
+    
+    def add(*args)
+      if args[0].is_a?(String)
+        while args.length > 0
+          add_segment(args.shift, args.shift)
+        end
+      elsif args.length == 1 and args[0].is_a?(Array)
+        add(*args[0])
+      else
+        args.each { |arg|
+          add(arg)
+        }
+      end
+    end
+    
+    def finalize
+      mode = @ic.output_mode
+      @ic = EDI::E::Interchange.parse(StringIO.new(@ic.to_s))
+      @ic.output_mode = mode
+      return self
+    end
+    
+    def to_s
+      @ic.to_s
+    end
+    
+    private
+    def add_segment(seg_name, value)
+      if seg_name =~ /^[A-Z]{3}$/
+        seg = @message.new_segment(seg_name)
+        @message.add(seg)
+        default = self.class.defaults[seg_name]
+        data = default.nil? ? value : default.merge(value)
+        data.each_pair { |de,val|
+          add_element(seg,de,val,default)
+        }
+      else
+        apply_mapping(seg_name, value)
+      end
+    end
+
+    def add_element(parent, de, value, default)
+      default = default[de] unless default.nil?
+      
+      if value.is_a?(Hash)
+        new_parent = parent.send("c#{de}")
+        data = default.nil? ? value : default.merge(value)
+        data.each_pair { |k,v| add_element(new_parent,k,v,default) }
+      elsif value.is_a?(Array)
+        de_array = parent.send("a#{de}")
+        value.each_with_index { |v,i|
+          element = de_array[i]
+          if v.is_a?(Hash)
+            data = default.nil? ? v : default.merge(v)
+            data.each_pair { |k,v1| add_element(element, k, v1, default) }
+          else
+            element.value = v
+          end
+        }
+      else
+        parent.send("d#{de}=",value)
+      end
+    end
+    
+  end
+  
+end

data/lib/openils/mapper.rb

@@ -0,0 +1,110 @@
+require 'edi/mapper'
+
+module OpenILS
+  
+  class Mapper < EDI::E::Mapper
+    VERSION = '0.8.2'
+  end
+  
+end
+
+OpenILS::Mapper.defaults = {
+  'UNB' => { 'S002' => { '0007' => '31B' }, 'S003' => { '0007' => '31B' } },
+  'BGM' => { 'C002' => { '1001' => 220 }, '1225' => 9 },
+  'DTM' => { 'C507' => { '2005' => 137, '2379' => 102 } },
+  'NAD' => { 'C082' => { '3055' => '31B' } },
+  'CUX' => { 'C504' => { '6347' => 2, '6345' => 'USD', '6343' => 9 } },
+  'LIN' => { 'C212' => { '7143' => 'EN' } },
+  'PIA' => { '4347' => 5, 'C212' => { '7143' => 'IB' } },
+  'IMD' => { '7077' => 'F' },
+  'PRI' => { 'C509' => { '5125' => 'AAB' } },
+  'QTY' => { 'C186' => { '6063' => 21 } },
+  'UNS' => { '0081' => 'S' },
+  'CNT' => { 'C270' => { '6069' => 2 } }
+}
+
+OpenILS::Mapper.map 'order' do |mapper,key,value|
+  mapper.add('BGM', { '1004' => value['po_number'] })
+  mapper.add('DTM', { 'C507' => { '2380' => value['date'] } })
+  value['buyer'].to_a.each { |buyer| mapper.add('buyer',buyer) }
+  value['vendor'].to_a.each { |vendor| mapper.add('vendor',vendor) }
+  mapper.add('currency',value['currency'])
+  value['items'].each_with_index { |item,index|
+    item['line_index'] = index + 1
+    item['line_number'] = "#{value['po_number']}/#{index+1}" if item['line_number'].nil?
+    mapper.add('item', item)
+  }
+  mapper.add("UNS", {})
+  mapper.add("CNT", { 'C270' => { '6066' => value['line_items'] } })
+end
+
+OpenILS::Mapper.map 'item' do |mapper,key,value|
+  mapper.add('LIN', { 'C212' => { '7143' => nil }, '1082' => value['line_index'] })
+
+  # use Array#inject() to group the identifiers in groups of 5.
+  # Same as Array#in_groups_of() without the active_support dependency. 
+  id_groups = value['identifiers'].inject([[]]) { |result,id|
+    result.last << id
+    if result.last.length == 5
+      result << []
+    end
+    result
+  }
+  
+  id_groups.each { |group|
+    ids = group.compact.collect { |data| 
+      id = { '7140' => data['id'] }
+      if data['id-qualifier']
+        id['7143'] = data['id-qualifier']
+      end
+      id
+    }
+    mapper.add('PIA',{ 'C212' => ids })
+  }
+  value['desc'].each { |desc| mapper.add('desc',desc) }
+  mapper.add('QTY', { 'C186' => { '6060' => value['quantity'] } })
+  mapper.add('PRI', { 'C509' => { '5118' => value['price'] } })
+  mapper.add('RFF', { 'C506' => { '1153' => 'LI', '1154' => value['line_number'] } })
+end
+
+OpenILS::Mapper.map('party',/^(buyer|vendor)$/) do |mapper,key,value|
+  codes = { 'buyer' => 'BY', 'supplier' => 'SU', 'vendor' => 'SU' }
+  party_code = codes[key]
+  
+  if value.is_a?(String)
+    value = { 'id' => value }
+  end
+
+  data = { 
+    '3035' => party_code, 
+    'C082' => { 
+      '3039' => value['id']
+    }
+  }
+  data['C082']['3055'] = value['id-qualifier'] unless value['id-qualifier'].nil?
+  mapper.add('NAD', data)
+
+  if value['reference']
+    value['reference'].each_pair { |k,v|
+      mapper.add('RFF', { 'C506' => { '1153' => k, '1154' => v }})
+    }
+  end
+end
+
+OpenILS::Mapper.map 'currency' do |mapper,key,value|
+  mapper.add('CUX', { 'C504' => ['6345' => value]})
+end
+
+OpenILS::Mapper.map 'desc' do |mapper,key,value|
+  values = value.to_a.flatten
+  while values.length > 0
+    code = values.shift
+    text = values.shift.to_s
+    code_qual = code =~ /^[0-9]+$/ ? 'L' : 'F'
+    chunked_text = text.chunk(35)
+    while chunked_text.length > 0
+      data = [chunked_text.shift,chunked_text.shift].compact
+      mapper.add('IMD', { '7077' => code_qual, '7081' => code, 'C273' => { '7008' => data } })
+    end
+  end
+end

data/test/map_spec.rb

@@ -0,0 +1,118 @@
+# map_spec.rb
+require 'edi/mapper'
+require 'edi/edi2json'
+
+describe EDI::E::Mapper do
+  
+  before(:each) do
+    @map = EDI::E::Mapper.new('ORDERS')
+  end
+  
+  it "should chunk text" do
+    s = 'abcdefghijklmnopqrstuvwxyz'
+    s.chunk(5).should == ['abcde','fghij','klmno','pqrst','uvwxy','z']
+  end
+
+  it "should produce an empty purchase order when initialized" do
+    ic_text = @map.to_s
+    ic_text.should_not be_nil
+    ic_text.should_not be_empty
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'UNT+2+1'"
+  end
+  
+  it "should add a single segment in tuple form" do
+    @map.add("BGM", {"1225" => 9,"C002" => {"1001" => 220},"1004" => "12345678"})
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+12345678+9'UNT+3+1'"
+  end
+
+  it "should properly apply defaults" do
+    old_defaults = EDI::E::Mapper.defaults
+    EDI::E::Mapper.defaults = {
+      'BGM' => { 'C002' => { '1001' => 220 }, '1225' => 9 }
+    }
+    @map.add("BGM", {"1004" => "12345678"})
+    EDI::E::Mapper.defaults = old_defaults
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+12345678+9'UNT+3+1'"
+  end
+
+  it "should raise an exception if defaults don't look right" do
+    lambda {
+      EDI::E::Mapper.defaults = 'This is wrong!'
+    }.should raise_error(TypeError)
+  end
+  
+  it "should properly fill in interchange envelope defaults" do
+    map = EDI::E::Mapper.new('ORDERS', nil, {:sender => '123456', :recipient => '654321'})
+    map.to_s.should =~ /UNA:\+\.\? 'UNB\+UNOB:3\+123456\+654321\+[0-9]{6}:[0-9]{4}\+1'UNH\+1\+ORDERS:D:96A:UN'UNT\+2\+1'UNZ\+1\+1'/
+  end
+  
+  it "should add multiple elements in tuple form" do
+    @map.add(
+      'BGM', { 'C002' => { '1001' => 220 }, '1004' => '12345678', '1225' => 9 },
+      'DTM', { 'C507' => { '2005' => 137, '2380' => '20090101', '2379' => 102 }}
+    )
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+12345678+9'DTM+137:20090101:102'UNT+4+1'"
+  end
+  
+  it "should add a single element in array form" do
+    @map.add(["BGM", {"1225" => 9,"C002" => {"1001" => 220},"1004" => "12345678"}])
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+12345678+9'UNT+3+1'"
+  end
+  
+  it "should add multiple elements in array form" do
+    @map.add(
+      ['BGM', { 'C002' => { '1001' => 220 }, '1004' => '12345678', '1225' => 9 }],
+      ['DTM', { 'C507' => { '2005' => 137, '2380' => '20090101', '2379' => 102 }}]
+    )
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+12345678+9'DTM+137:20090101:102'UNT+4+1'"
+  end
+  
+  it "should make use of custom mappings" do
+    EDI::E::Mapper.map 'currency' do |mapper,key,value|
+      mapper.add('CUX', { 'C504' => [{ '6347' => 2, '6345' => value, '6343' => 9 }]})
+    end
+
+    @map.add(
+      'BGM', { 'C002' => { '1001' => 220 }, '1004' => '12345678', '1225' => 9 },
+      'DTM', { 'C507' => { '2005' => 137, '2380' => '20090101', '2379' => 102 }},
+      'currency', 'USD'
+    )
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+12345678+9'DTM+137:20090101:102'CUX+2:USD:9'UNT+5+1'"
+  end
+  
+  it "should raise an exception when an unknown mapping is called" do
+    lambda {
+      @map.add('everything', { 'answer' => 42 })
+    }.should raise_error(NameError)
+  end
+
+  it "should raise an exception when re-registering a named mapping" do
+    lambda {
+      EDI::E::Mapper.map 'currency' do |mapper,key,value|
+        mapper.add('CUX', { 'C504' => [{ '6347' => 2, '6345' => value, '6343' => 9 }]})
+      end
+    }.should raise_error(NameError)
+  end
+  
+  it "should correctly unregister a mapping" do
+    EDI::E::Mapper.unregister_mapping 'currency'
+
+    lambda {
+      @map.add(
+        'BGM', { 'C002' => { '1001' => 220 }, '1004' => '12345678', '1225' => 9 },
+        'DTM', { 'C507' => { '2005' => 137, '2380' => '20090101', '2379' => 102 }},
+        'currency', 'USD'
+      )
+    }.should raise_error(NameError)
+  end
+  
+  it "should correctly generate a low-level JEDI hash from an EDIFACT message" do
+    interchange = File.open(File.join(File.dirname(__FILE__), 'test_po.edi')) { |f|
+      EDI::E::Interchange.parse(f)
+    }
+    # Can't compare everything because of timestamping, so we'll just compare
+    # the bodies for a high degree of confidence
+    interchange.to_hash['body'].should == [["ORDERS", {"trailer"=>["UNT", {"0074"=>33, "0062"=>"1"}], "body"=>[["BGM", {"C002"=>{"1001"=>"220"}, "1225"=>"9", "1004"=>"2"}], ["DTM", {"C507"=>{"2005"=>"137", "2380"=>"20090331", "2379"=>"102"}}], ["NAD", {"C082"=>{"3039"=>"3472205", "3055"=>"91"}, "SG2"=>[["RFF", {"C506"=>{"1153"=>"API", "1154"=>"3472205 0001"}}]], "3035"=>"BY"}], ["NAD", {"C082"=>{"3039"=>"3472205", "3055"=>"31B"}, "SG2"=>[["RFF", {"C506"=>{"1153"=>"API", "1154"=>"3472205 0001"}}]], "3035"=>"BY"}], ["NAD", {"C082"=>{"3039"=>"1556150", "3055"=>"31B"}, "3035"=>"SU"}], ["NAD", {"C082"=>{"3039"=>"1556150", "3055"=>"91"}, "SG2"=>[["RFF", {"C506"=>{"1153"=>"IA", "1154"=>"1865"}}]], "3035"=>"SU"}], ["CUX", {"C504"=>{"6345"=>"USD", "6347"=>"2", "6343"=>"9"}}], ["LIN", {"SG25"=>[["PIA", {"C212"=>{"7140"=>"03-0010837", "7143"=>"SA"}, "4347"=>"5"}], ["IMD", {"C273"=>{"7008"=>"Discernment"}, "7077"=>"F", "7081"=>"BTI"}], ["IMD", {"C273"=>{"7008"=>"Concord Records,"}, "7077"=>"F", "7081"=>"BPU"}], ["IMD", {"C273"=>{"7008"=>"1986."}, "7077"=>"F", "7081"=>"BPD"}], ["IMD", {"C273"=>{"7008"=>"1 sound disc :"}, "7077"=>"F", "7081"=>"BPH"}], ["QTY", {"C186"=>{"6060"=>2, "6063"=>"21"}}], ["PRI", {"C509"=>{"5125"=>"AAB", "5118"=>35.95}}], ["RFF", {"C506"=>{"1153"=>"LI", "1154"=>"2/1"}}]], "1082"=>1}], ["LIN", {"SG25"=>[["PIA", {"C212"=>{"7140"=>"03-0010840", "7143"=>"SA"}, "4347"=>"5"}], ["IMD", {"C273"=>{"7008"=>"The inner source"}, "7077"=>"F", "7081"=>"BTI"}], ["IMD", {"C273"=>{"7008"=>"Duke, George, 1946-"}, "7077"=>"F", "7081"=>"BAU"}], ["IMD", {"C273"=>{"7008"=>"MPS Records,"}, "7077"=>"F", "7081"=>"BPU"}], ["IMD", {"C273"=>{"7008"=>"1973."}, "7077"=>"F", "7081"=>"BPD"}], ["IMD", {"C273"=>{"7008"=>"2 sound discs :"}, "7077"=>"F", "7081"=>"BPH"}], ["QTY", {"C186"=>{"6060"=>1, "6063"=>"21"}}], ["PRI", {"C509"=>{"5125"=>"AAB", "5118"=>28.95}}], ["RFF", {"C506"=>{"1153"=>"LI", "1154"=>"2/2"}}]], "1082"=>2}], ["UNS", {"0081"=>"S"}], ["CNT", {"C270"=>{"6069"=>"2", "6066"=>2}}], ["UNT", {"0074"=>33, "0062"=>"1"}]], "header"=>["UNH", {"S009"=>{"0052"=>"D", "0065"=>"ORDERS", "0054"=>"96A", "0051"=>"UN"}, "0062"=>"1"}]}]]
+  end
+
+end

data/test/openils_map_spec.rb

@@ -0,0 +1,41 @@
+require 'openils/mapper'
+
+describe OpenILS::Mapper do
+  
+  before(:each) do
+    @map = OpenILS::Mapper.new('ORDERS')
+  end
+  
+  it "should add both qualified and unqualified buyer/vendor fields" do
+    @map.add(
+      ['buyer', { 'id' => '3472205', 'id-qualifier' => '91', 'reference' => { 'API' => '3472205 0001' } }],
+      ['buyer', { 'id' => '3472205', 'reference' => { 'API' => '3472205 0001' }}]
+    )
+    @map.add(
+      'vendor', '1556150', 
+      'vendor', { 'id' => '1556150', 'id-qualifier' => '91', 'reference' => { 'IA' => '1865' }}
+    )
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'NAD+BY+3472205::91'RFF+API:3472205 0001'NAD+BY+3472205::31B'RFF+API:3472205 0001'NAD+SU+1556150::31B'NAD+SU+1556150::91'RFF+IA:1865'UNT+9+1'"
+  end
+  
+  it "should properly chunk and add descriptive fields" do
+    @map.add(
+      'desc', [
+        'BAU', 'Campbell, James',
+        'BTI', "The Ghost Mountain boys : their epic march and the terrifying battle for New Guinea -- the forgotten war of the South Pacific",
+        'BPU', 'Crown Publishers',
+        'BPD', 2007
+      ]
+    )
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'IMD+F+BAU+:::Campbell, James'IMD+F+BTI+:::The Ghost Mountain boys ?: their epi:c march and the terrifying battle f'IMD+F+BTI+:::or New Guinea -- the forgotten war :of the South Pacific'IMD+F+BPU+:::Crown Publishers'IMD+F+BPD+:::2007'UNT+7+1'"
+  end
+
+  it "should create a message from high-level JEDI input" do
+    json = File.read(File.join(File.dirname(__FILE__), 'test_po.json'))
+    @map = OpenILS::Mapper.from_json(%{{ "msg_type": "ORDERS", "msg": #{json}, "sender": "123456", "recipient": {"id": "999999999", "id-qualifier": "1"}}})
+    @map.message.to_s.should == "UNH+1+ORDERS:D:96A:UN'BGM+220+2+9'DTM+137:20090331:102'NAD+BY+3472205::91'RFF+API:3472205 0001'NAD+BY+3472205::31B'RFF+API:3472205 0001'NAD+SU+1556150::31B'NAD+SU+1556150::91'RFF+IA:1865'CUX+2:USD:9'LIN+1'PIA+5+03-0010837:SA'IMD+F+BTI+:::Discernment'IMD+F+BPU+:::Concord Records,'IMD+F+BPD+:::1986.'IMD+F+BPH+:::1 sound disc ?:'QTY+21:2'PRI+AAB:35.95'RFF+LI:2/1'LIN+2'PIA+5+03-0010840:SA'IMD+F+BTI+:::The inner source'IMD+F+BAU+:::Duke, George, 1946-'IMD+F+BPU+:::MPS Records,'IMD+F+BPD+:::1973.'IMD+F+BPH+:::2 sound discs ?:'QTY+21:1'PRI+AAB:28.95'RFF+LI:2/2'UNS+S'CNT+2:2'UNT+33+1'"
+    @map.header.cS002.to_s.should == "123456:31B"
+    @map.header.cS003.to_s.should == "999999999:1"
+  end
+  
+end

data/test/test_po.edi

@@ -0,0 +1,36 @@
+UNA:+.? '
+UNB+UNOB:3+++090401:1152+1'
+UNH+1+ORDERS:D:96A:UN'
+BGM+220+2+9'
+DTM+137:20090331:102'
+NAD+BY+3472205::91'
+RFF+API:3472205 0001'
+NAD+BY+3472205::31B'
+RFF+API:3472205 0001'
+NAD+SU+1556150::31B'
+NAD+SU+1556150::91'
+RFF+IA:1865'
+CUX+2:USD:9'
+LIN+1'
+PIA+5+03-0010837:SA'
+IMD+F+BTI+:::Discernment'
+IMD+F+BPU+:::Concord Records,'
+IMD+F+BPD+:::1986.'
+IMD+F+BPH+:::1 sound disc ?:'
+QTY+21:2'
+PRI+AAB:35.95'
+RFF+LI:2/1'
+LIN+2'
+PIA+5+03-0010840:SA'
+IMD+F+BTI+:::The inner source'
+IMD+F+BAU+:::Duke, George, 1946-'
+IMD+F+BPU+:::MPS Records,'
+IMD+F+BPD+:::1973.'
+IMD+F+BPH+:::2 sound discs ?:'
+QTY+21:1'
+PRI+AAB:28.95'
+RFF+LI:2/2'
+UNS+S'
+CNT+2:2'
+UNT+33+1'
+UNZ+1+1'

data/test/test_po.json

@@ -0,0 +1,36 @@
+["order", {
+  "po_number":2,
+  "date":"20090331",
+  "buyer":[
+    {"id-qualifier":"91","id":"3472205","reference":{"API":"3472205 0001"}},
+    {"id":"3472205","reference":{"API":"3472205 0001"}}
+  ],
+  "vendor":[
+    "1556150",
+    {"id-qualifier":"91","reference":{"IA":"1865"},"id":"1556150"}
+  ],
+  "currency":"USD",
+  "items":[{
+    "identifiers":[{"id-qualifier":"SA","id":"03-0010837"}],
+    "price":35.95,
+    "desc":[
+      {"BTI":"Discernment"},
+      {"BPU":"Concord Records,"},
+      {"BPD":"1986."},
+      {"BPH":"1 sound disc :"}
+    ],
+    "quantity":2
+  },{
+    "identifiers":[{"id-qualifier":"SA","id":"03-0010840"}],
+    "price":28.95,
+    "desc":[
+      {"BTI":"The inner source"},
+      {"BAU":"Duke, George, 1946-"},
+      {"BPU":"MPS Records,"},
+      {"BPD":"1973."},
+      {"BPH":"2 sound discs :"}
+    ],
+    "quantity":1
+  }],
+  "line_items":2
+}]

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: openils-mapper
+version: !ruby/object:Gem::Version 
+  version: 0.8.2
+platform: ruby
+authors: 
+- Michael B. Klein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: edi4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: edi4r-tdid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.0
+    version: 
+description: Middleware layer to provide translation between high-level JSON and raw EDIFACT messages
+email: mbklein@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/edi/edi2json.rb
+- lib/edi/mapper.rb
+- lib/openils/mapper.rb
+- test/map_spec.rb
+- test/openils_map_spec.rb
+- test/test_po.edi
+- test/test_po.json
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: EDIFACT<->JSON middleware for the Evergreen Open Source ILS
+test_files: []
+