bisac 0.8.1 → 0.9

data/README

@@ -20,5 +20,6 @@ claiming otherwise.
 
 = Links
 
-- http://www.bisg.org/bisac/
-- http://www.anchordistributors.com/EDIInfo.aspx
+- Project source: http://github.com/yob/bisac/tree/master
+- Standards body: http://www.bisg.org/bisac/
+- Partial specs:  http://www.anchordistributors.com/EDIInfo.aspx

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require 'spec/rake/spectask'
 
-PKG_VERSION = "0.8.1"
+PKG_VERSION = "0.9"
 PKG_NAME = "bisac"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBYFORGE_PROJECT = 'rbook'

data/lib/bisac.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 # load other files from within this lib
+require 'bisac/utils'
 require 'bisac/message'
 require 'bisac/product'
 require 'bisac/po'

data/lib/bisac/po.rb

@@ -26,6 +26,7 @@ module Bisac
   #     ...
   #   end
   class PO
+    include Bisac::Utils
 
     attr_accessor :source_san, :source_suffix, :source_name
     attr_accessor :date, :filename, :format_version
@@ -176,7 +177,7 @@ module Bisac
       line[40,5]  = "00001" # number of '10'-'19' records
       line[55,5]  = (@items.size * 3).to_s.rjust(5,"0") # number of '40'-'49' records
       line[60,5]  = "00000" # number of '50'-'59' records
-      line[45,5]  = "00000" # number of '60'-'69' records
+      line[65,5]  = "00000" # number of '60'-'69' records
       lines << line
 
       lines.join("\n")
@@ -184,19 +185,6 @@ module Bisac
 
     private
 
-    def yes_no(bool)
-      bool ? "Y" : "N"
-    end
-
-    def pad_trunc(str, len, pad = " ")
-      str = str.to_s
-      if str.size > len
-        str[0,len]
-      else
-        str.ljust(len, pad)
-      end
-    end
-
     def self.build_message(data)
       raise Bisac::InvalidFileError, 'File appears to be too short' unless data.size >= 3
       raise Bisac::InvalidFileError, 'Missing header information' unless data[0][0,2].eql?("00")

data/lib/bisac/po_line_item.rb

@@ -5,6 +5,7 @@ module Bisac
   # represents a single line on the purchase order. Has attributes like
   # price, qty and description
   class POLineItem
+    include Bisac::Utils
 
     attr_accessor :sequence_number, :po_number, :line_item_number
     attr_accessor :qty, :catalogue_code, :price
@@ -97,19 +98,5 @@ module Bisac
       lines.join("\n")
     end
 
-    private
-
-    def yes_no(bool)
-      bool ? "Y" : "N"
-    end
-
-    def pad_trunc(str, len, pad = " ")
-      str = str.to_s
-      if str.size > len
-        str[0,len]
-      else
-        str.ljust(len, pad)
-      end
-    end
   end
 end

data/lib/bisac/poa.rb

@@ -19,6 +19,7 @@ module Bisac
   #     ...
   #   end
   class POA
+    include Bisac::Utils
 
     # file header attributes
     attr_accessor :source_san, :source_suffix, :source_name
@@ -37,14 +38,9 @@ module Bisac
     # creates a new Bisac::POA object
     def initialize
       @items = []
-
-      # default values
-      @cancellation_date = "000000"
-      @do_not_ship_before = "000000"
-      @backorder = true
     end
 
-    # return all POs from a BISAC file
+    # return all POAs from a BISAC file
     def self.parse_file(input, &block)
       raise ArgumentError, 'no file provided' if input.nil?
       raise ArgumentError, 'Invalid file' unless File.file?(input)
@@ -53,7 +49,7 @@ module Bisac
       end
     end
 
-    # return all POs from a BISAC string
+    # return all POAs from a BISAC string
     def self.parse_string(input, &block)
       raise ArgumentError, 'no data provided' if input.nil?
       data = []
@@ -61,8 +57,8 @@ module Bisac
         data << l
 
         # yield each message found in the string. A line starting with
-        # 90 is the footer to a PO
-        if data.last[0,2] == "90"
+        # 91 is the footer to a POA
+        if data.last[0,2] == "91"
           msg = Bisac::POA.new
           msg.build_message(data)
           yield msg
@@ -79,16 +75,27 @@ module Bisac
       end
     end
 
-    def total_qty
-      @items.collect { |i| i.qty }.inject { |sum, x| sum ? sum+x : x}
+    # total number of units ordered by the customer
+    #
+    def total_order_qty
+      @items.collect { |i| i.order_qty }.inject { |sum, x| sum ? sum+x : x}
+    end
+
+    # total number of units to ship
+    #
+    def total_shippable_qty
+      @items.collect { |i| i.shippable_qty }.inject { |sum, x| sum ? sum+x : x}
     end
 
+    # convert this POA into a standards compliant string, ready for sending
+    # to customers.
+    #
     def to_s
       lines = []
 
       # file header
       line = " " * 80
-      line[0,2]   = "00" # line type
+      line[0,2]   = "02" # line type
       line[2,5]   = "00001"  # line counter
       line[7,7]   = pad_trunc(@source_san, 7)
       line[14,5]  = pad_trunc(@source_suffix, 5)
@@ -98,59 +105,56 @@ module Bisac
       line[60,3]  = pad_trunc(@format_version, 3)
       line[63,7]  = pad_trunc(@destination_san, 7)
       line[70,5]  = pad_trunc(@destination_suffix, 5)
+      line[75,1]  = pad_trunc(@ack_type, 1)
       lines << line
 
       # po header
-      lines << ""
-      lines.last << "10"
-      lines.last << "00002"  # line counter
-      lines.last << " "
-      lines.last << @po_number.to_s.ljust(11, " ")
-      lines.last << " " # TODO
-      lines.last << pad_trunc(@source_san, 7)
-      lines.last << pad_trunc("",5) # TODO
-      lines.last << pad_trunc(@destination_san, 7)
-      lines.last << pad_trunc("",5) # TODO
-      lines.last << pad_trunc(@date, 6)
-      lines.last << pad_trunc(@cancellation_date,6)
-      lines.last << yes_no(@backorder)
-      lines.last << pad_trunc(@do_not_exceed_action,1)
-      lines.last << pad_trunc(@do_not_exceed_amount,7)
-      lines.last << pad_trunc(@invoice_copies,2)
-      lines.last << yes_no(@special_instructions)
-      lines.last << pad_trunc("",5) # TODO
-      lines.last << pad_trunc(@do_not_ship_before,6)
-
-      sequence = 3
+      line = " " * 80
+      line[0,2]    = "11" # line type
+      line[2,5]    = "00002"  # line counter
+      line[7,13]   = pad_trunc(@supplier_poa_number, 13)
+      line[20,13]  = pad_trunc(@po_number, 13)
+      line[33,7]   = pad_trunc(@customer_san, 7)
+      line[40,5]   = pad_trunc(@customer_suffice, 5)
+      line[45,7]   = pad_trunc(@supplier_san, 7)
+      line[52,5]   = pad_trunc(@supplier_suffice, 5)
+      line[57,6]   = pad_trunc(@poa_date, 6)
+      line[63,3]   = pad_trunc(@currency, 3)
+      line[66,6]   = pad_trunc(@po_date, 6)
+      line[72,6]   = pad_trunc(@po_cancel_date, 6)
+      line[78,2]   = pad_trunc(@po_type, 2)
+      lines << line
+
       @items.each_with_index do |item, idx|
         item.line_item_number = idx + 1
-        item.sequence_number  = sequence
-        lines    += item.to_s.split("\n")
-        sequence += 3
+        item.sequence_number  = lines.size + 1
+        lines << item.to_s
       end
 
-      # PO control
+      # POA control
       line = " " * 80
-      line[0,2]   = "50"
+      line[0,2]   = "59"
       line[2,5]   = (lines.size + 1).to_s.rjust(5,"0")  # line counter
-      line[8,12]  = @po_number.to_s.ljust(13, " ")
-      line[20,5]  = "00001" # number of POs in file
-      line[25,10] = @items.size.to_s.rjust(10,"0")
-      line[35,10] = total_qty.to_s.rjust(10,"0")
+      line[7,13]  = pad_trunc(@supplier_poa_number, 13)
+      line[20,5]  = (lines.size).to_s.rjust(5,"0") # number of lines to this point
+      line[25,10] = (lines.size - 2).to_s.rjust(10,"0") # number of line items in file
+      line[35,10] = total_shippable_qty.to_s.rjust(10,"0")
       lines << line
 
       # file trailer
       line = " " * 80
-      line[0,2]   = "90"
+      line[0,2]   = "91"
       line[2,5]   = (lines.size+1).to_s.rjust(5,"0")  # line counter
       line[7,20]  = @items.size.to_s.rjust(13,"0")
-      line[20,5]  = "00001" # total '10' (PO) records
-      line[25,10] = total_qty.to_s.rjust(10,"0")
+      line[20,5]  = "00001" # total '11' (POA) records
+      line[25,10] = total_shippable_qty.to_s.rjust(10,"0")
       line[35,5]  = "00001" # number of '00'-'09' records
       line[40,5]  = "00001" # number of '10'-'19' records
-      line[55,5]  = (@items.size * 3).to_s.rjust(5,"0") # number of '40'-'49' records
-      line[60,5]  = "00000" # number of '50'-'59' records
-      line[45,5]  = "00000" # number of '60'-'69' records
+      line[45,5]  = "00000" # number of '20'-'29' records
+      line[50,5]  = "00000" # number of '30'-'39' records
+      line[55,5]  = (@items.size).to_s.rjust(5,"0") # number of '40'-'49' records
+      line[60,5]  = "00001" # number of '50'-'59' records
+      line[65,5]  = "00001" # number of '60'-'99' records
       lines << line
 
       lines.join("\n")

data/lib/bisac/poa_line_item.rb

@@ -3,7 +3,9 @@ require 'bigdecimal'
 module Bisac
 
   # represents a single line on the purchase order ack
+  #
   class POALineItem
+    include Bisac::Utils
 
     attr_accessor :sequence_number, :supplier_poa_number
     attr_accessor :line_item_number, :order_qty, :unit_price, :nett_price
@@ -63,6 +65,25 @@ module Bisac
       end
     end
 
+    def to_s
+      line = " " * 93
+      line[0,2]   = "40" # line type
+      line[2,5]   = @sequence_number.to_s.rjust(5,"0") # line counter
+      line[7,13]  = pad_trunc(@supplier_poa_number, 13)
+      line[20,10] = rpad_trunc(@line_item_number, 10, "0")
+      line[30,10] = pad_trunc(isbn10, 10)
+      line[40,5]  = rpad_trunc(@order_qty, 5, "0")
+      line[45,8]  = rpad_trunc(@unit_price.to_i, 8, "0")
+      line[53,9]  = rpad_trunc(@nett_price.to_i, 9, "0")
+      line[62,1]  = pad_trunc(@list_nett_indicator, 1)
+      line[63,1]  = rpad_trunc(@special_price, 1, "0")
+      line[64,5]  = rpad_trunc(@discount.to_i, 5, "0")
+      line[69,5]  = rpad_trunc(@shippable_qty, 5, "0")
+      line[74,2]  = rpad_trunc(@status, 2, "0")
+      line[80,13] = pad_trunc(isbn, 13)
+      line
+    end
+
     def status_text
       case self.status
       when 1  then "Accepted: Title Shipped As Ordered"

data/lib/bisac/utils.rb

@@ -0,0 +1,28 @@
+module Bisac
+  module Utils
+
+    private
+
+    def yes_no(bool)
+      bool ? "Y" : "N"
+    end
+
+    def pad_trunc(str, len, pad = " ")
+      str = str.to_s
+      if str.size > len
+        str[0,len]
+      else
+        str.ljust(len, pad)
+      end
+    end
+
+    def rpad_trunc(str, len, pad = " ")
+      str = str.to_s
+      if str.size > len
+        str[0,len]
+      else
+        str.rjust(len, pad)
+      end
+    end
+  end
+end

data/specs/data/valid_poa.txt

@@ -4,80 +4,54 @@
 40000040000000019629000000000207148483010000400000000000000000  000000000401    9780714848303
 40000050000000019629000000000307459426440000100000000000000000  000000000101    9780745942643
 40000060000000019629000000000407459466310000600000000000000000  000000000007    9780745946634
-4100007000000001962900000  000000                                               
-40000080000000019629000000000507459493040000200000000000000000  000000000201    9780745949307
-40000090000000019629000000000607459493550000200000000000000000  000000000007    9780745949352
-4100010000000001962900000  000000                                               
-40000110000000019629000000000707459493630000100000000000000000  000000000007    9780745949369
-4100012000000001962900000  000000                                               
-40000130000000019629000000000807459496650000100000000000000000  000000000101    9780745949666
-40000140000000019629000000000907459496810000100000000000000000  000000000007    9780745949680
-4100015000000001962900000  000000                                               
-40000160000000019629000000001007459497970000300000000000000000  000000000301    9780745949796
-40000170000000019629000000001107459499670000300000000000000000  000000000301    9780745949963
-40000180000000019629000000001207459522240000100000000000000000  000000000101    9780745952222
-40000190000000019629000000001307459523480000200000000000000000  000000000007    9780745952345
-4100020000000001962900000  000000                                               
-400002100000000196290000000014074595278X0000100000000000000000  000000000101    9780745952789
-40000220000000019629000000001507459531900000100000000000000000  000000000105    9780745953199
-4100023000000001962900001  000000                                               
-40000240000000019629000000001607459600490000200000000000000000  000000000201    9780745960043
-400002500000000196290000000017074596012X0000200000000000000000  000000000007    9780745960128
-4100026000000001962900000  000000                                               
-40000270000000019629000000001807459601620000700000000000000000  000000000701    9780745960166
-40000280000000019629000000001907459607070000100000000000000000  000000000101    9780745960708
-40000290000000019629000000002007459608470000200000000000000000  000000000201    9780745960845
-40000300000000019629000000002107459608630000500000000000000000  000000000110    9780745960869
-4100031000000001962900001  000000                                               
-40000320000000019629000000002207459609520000100000000000000000  000000000007    9780745960951
-4100033000000001962900000  000000                                               
-40000340000000019629000000002307459610450000600000000000000000  000000000605    9780745961040
-4100035000000001962900006  000000                                               
-40000360000000019629000000002407459610530000200000000000000000  000000000201    9780745961057
-40000370000000019629000000002507459610880000500000000000000000  000000000501    9780745961088
-40000380000000019629000000002607459612230000700000000000000000  000000001409    9780745961224
-40000390000000019629000000002707459690460000400000000000000000  000000000007    9780745969046
-4100040000000001962900000  000000                                               
-40000410000000019629000000002807624166960000200000000000000000  000000000201    9780762416691
-40000420000000019629000000002908979349380000200000000000000000  000000000201    9780897934930
-40000430000000019629000000003015925825400000700000000000000000  000000000701    9781592582549
-40000440000000019629000000003118453930070000400000000000000000  000000000401    9781845393007
-400004500000000196290000000032184666411X0000100000000000000000  000000000101    9781846664113
-40000460000000019629000000003318516848240000600000000000000000  000000000007    9781851684823
-4100047000000001962900000  000000                                               
-40000480000000019629000000003418542483400000100000000000000000  000000000007    9781854248343
-4100049000000001962900000  000000                                               
-400005000000000196290000000035185424874X0000100000000000000000  000000000116    9781854248749
-40000510000000019629000000003618589426160000200000000000000000  000000000007    9781858942612
-4100052000000001962900000  000000                                               
-40000530000000019629000000003718589426240000200000000000000000  000000000007    9781858942629
-4100054000000001962900000  000000                                               
-400005500000000196290000000038185985334X0000600000000000000000  000000000007    9781859853344
-4100056000000001962900000  000000                                               
-40000570000000019629000000003918598549310000200000000000000000  000000000201    9781859854938
-40000580000000019629000000004018598552450000100000000000000000  000000000007    9781859855249
-4100059000000001962900000  000000                                               
-40000600000000019629000000004118598562760000500000000000000000  000000000007    9781859856277
-4100061000000001962900000  000000                                               
-40000620000000019629000000004218598562840000500000000000000000  000000000007    9781859856284
-4100063000000001962900000  000000                                               
-40000640000000019629000000004318598563060000100000000000000000  000000000101    9781859856307
-40000650000000019629000000004418598563220000300000000000000000  000000000301    9781859856321
-40000660000000019629000000004518598566320000200000000000000000  000000000007    9781859856635
-4100067000000001962900000  000000                                               
-40000680000000019629000000004618598566400000200000000000000000  000000000007    9781859856642
-4100069000000001962900000  000000                                               
-400007000000000196290000000047185985673X0000300000000000000000  000000000301    9781859856734
-40000710000000019629000000004818598569690000100000000000000000  000000000007    9781859856963
-4100072000000001962900000  000000                                               
-40000730000000019629000000004918598576120000100000000000000000  000000000007    9781859857618
-4100074000000001962900000  000000                                               
-40000750000000019629000000005018598576710000900000000000000000  000000000905    9781859857670
-4100076000000001962900009  000000                                               
-400007700000000196290000000051185985768X0001100000000000000000  000000001105    9781859857687
-4100078000000001962900011  000000                                               
-40000790000000019629000000005218942229620000400000000000000000  000000000008    9781894222969
-40000800000000019629000000005319052793450000100000000000000000  000000000007    9781905279340
-4100081000000001962900000  000000                                               
-590008200000000196290008100000000530000000104                                   
-9100083000000000005300001000000010400000000000000000000000000000000000          
+40000070000000019629000000000507459493040000200000000000000000  000000000201    9780745949307
+40000080000000019629000000000607459493550000200000000000000000  000000000007    9780745949352
+40000090000000019629000000000707459493630000100000000000000000  000000000007    9780745949369
+40000100000000019629000000000807459496650000100000000000000000  000000000101    9780745949666
+40000110000000019629000000000907459496810000100000000000000000  000000000007    9780745949680
+40000120000000019629000000001007459497970000300000000000000000  000000000301    9780745949796
+40000130000000019629000000001107459499670000300000000000000000  000000000301    9780745949963
+40000140000000019629000000001207459522240000100000000000000000  000000000101    9780745952222
+40000150000000019629000000001307459523480000200000000000000000  000000000007    9780745952345
+400001600000000196290000000014074595278X0000100000000000000000  000000000101    9780745952789
+40000170000000019629000000001507459531900000100000000000000000  000000000105    9780745953199
+40000180000000019629000000001607459600490000200000000000000000  000000000201    9780745960043
+400001900000000196290000000017074596012X0000200000000000000000  000000000007    9780745960128
+40000200000000019629000000001807459601620000700000000000000000  000000000701    9780745960166
+40000210000000019629000000001907459607070000100000000000000000  000000000101    9780745960708
+40000220000000019629000000002007459608470000200000000000000000  000000000201    9780745960845
+40000230000000019629000000002107459608630000500000000000000000  000000000110    9780745960869
+40000240000000019629000000002207459609520000100000000000000000  000000000007    9780745960951
+40000250000000019629000000002307459610450000600000000000000000  000000000605    9780745961040
+40000260000000019629000000002407459610530000200000000000000000  000000000201    9780745961057
+40000270000000019629000000002507459610880000500000000000000000  000000000501    9780745961088
+40000280000000019629000000002607459612230000700000000000000000  000000001409    9780745961224
+40000290000000019629000000002707459690460000400000000000000000  000000000007    9780745969046
+40000300000000019629000000002807624166960000200000000000000000  000000000201    9780762416691
+40000310000000019629000000002908979349380000200000000000000000  000000000201    9780897934930
+40000320000000019629000000003015925825400000700000000000000000  000000000701    9781592582549
+40000330000000019629000000003118453930070000400000000000000000  000000000401    9781845393007
+400003400000000196290000000032184666411X0000100000000000000000  000000000101    9781846664113
+40000350000000019629000000003318516848240000600000000000000000  000000000007    9781851684823
+40000360000000019629000000003418542483400000100000000000000000  000000000007    9781854248343
+400003700000000196290000000035185424874X0000100000000000000000  000000000116    9781854248749
+40000380000000019629000000003618589426160000200000000000000000  000000000007    9781858942612
+40000390000000019629000000003718589426240000200000000000000000  000000000007    9781858942629
+400004000000000196290000000038185985334X0000600000000000000000  000000000007    9781859853344
+40000410000000019629000000003918598549310000200000000000000000  000000000201    9781859854938
+40000420000000019629000000004018598552450000100000000000000000  000000000007    9781859855249
+40000430000000019629000000004118598562760000500000000000000000  000000000007    9781859856277
+40000440000000019629000000004218598562840000500000000000000000  000000000007    9781859856284
+40000450000000019629000000004318598563060000100000000000000000  000000000101    9781859856307
+40000460000000019629000000004418598563220000300000000000000000  000000000301    9781859856321
+40000470000000019629000000004518598566320000200000000000000000  000000000007    9781859856635
+40000480000000019629000000004618598566400000200000000000000000  000000000007    9781859856642
+400004900000000196290000000047185985673X0000300000000000000000  000000000301    9781859856734
+40000500000000019629000000004818598569690000100000000000000000  000000000007    9781859856963
+40000510000000019629000000004918598576120000100000000000000000  000000000007    9781859857618
+40000520000000019629000000005018598576710000900000000000000000  000000000905    9781859857670
+400005300000000196290000000051185985768X0001100000000000000000  000000001105    9781859857687
+40000540000000019629000000005218942229620000400000000000000000  000000000008    9781894222969
+40000550000000019629000000005319052793450000100000000000000000  000000000007    9781905279340
+590005600000000196290005500000000530000000104                                   
+9100057000000000005300001000000010400001000010000000000000530000100001          

data/specs/poa_line_item_spec.rb

@@ -27,10 +27,15 @@ context "A new bisac purchase order line item object" do
   end
 
   specify "Should prefer the ISBN13 over ISBN10 when available" do
-    item = Bisac::POLineItem.load_from_string(@valid_isbn13_row)
-    item.should be_a_kind_of(Bisac::POLineItem)
+    item = Bisac::POALineItem.load_from_string(@valid_isbn13_row)
+    item.should be_a_kind_of(Bisac::POALineItem)
 
     item.isbn.should eql("9780711226067")
   end
 
+  specify "Should correctly convert into a string" do
+    item = Bisac::POALineItem.load_from_string(@valid_isbn13_row)
+    item.to_s.should eql(@valid_isbn13_row)
+  end
+
 end

data/specs/poa_spec.rb

@@ -67,4 +67,14 @@ context "A BISAC POA object" do
   specify "Should raise an appropriate exception when an invalid file is loaded" do
     lambda { msg = Bisac::POA.parse_file(@invalid_file_onix) }.should raise_error(Bisac::InvalidFileError)
   end
+
+  specify "Should correctly convert into a string" do
+    original = File.read(@valid_file).split("\n")
+    Bisac::POA.parse_file(@valid_file) do |msg|
+      msg.to_s.split("\n").size.should eql(57)
+      msg.to_s.split("\n").each_with_index do |line, idx|
+        line.strip.should eql(original[idx].strip)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bisac
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
+  version: "0.9"
 platform: ruby
 authors: 
 - James Healy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 +10:00
+date: 2008-11-24 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,6 +41,7 @@ files:
 - lib/bisac/product.rb
 - lib/bisac/poa.rb
 - lib/bisac/poa_line_item.rb
+- lib/bisac/utils.rb
 - specs/data
 - specs/data/bisac_multi_po.txt
 - specs/data/bisac_po.txt
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rbook
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A library for manipulating BISAC files