bisac 0.8

data/lib/bisac/poa.rb

@@ -0,0 +1,212 @@
+module Bisac
+
+  # Represents a single BISAC purchase order acknowledgement
+  # 
+  # = Generating
+  #
+  # It's currently not possible to generate a POA with this class. All it needs
+  # is a to_s method though, much like Bisac::PO. Patches welcome.
+  #
+  # = Reading
+  #
+  # Each POA file can contain multiple POA's, so use pasrse_file() to iterate
+  # over them all.
+  #
+  #   Bisac::POA.parse_file("filename.bsc") do |msg|
+  #     puts msg.source_san
+  #     puts msg.source_name
+  #     puts msg.items.size
+  #     ...
+  #   end
+  class POA
+
+    # file header attributes
+    attr_accessor :source_san, :source_suffix, :source_name
+    attr_accessor :date, :filename, :format_version
+    attr_accessor :destination_san, :destination_suffix
+    attr_accessor :ack_type
+
+    # poa header attributes
+    attr_accessor :supplier_poa_number, :po_number
+    attr_accessor :customer_san, :customer_suffix
+    attr_accessor :supplier_san, :supplier_suffix
+    attr_accessor :poa_date, :currency, :po_date
+    attr_accessor :po_cancel_date, :po_type
+    attr_accessor :items
+
+    # 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
+    def self.parse_file(input, &block)
+      raise ArgumentError, 'no file provided' if input.nil?
+      raise ArgumentError, 'Invalid file' unless File.file?(input)
+      self.parse_string(File.read(input)) do |msg|
+        yield msg
+      end
+    end
+
+    # return all POs from a BISAC string
+    def self.parse_string(input, &block)
+      raise ArgumentError, 'no data provided' if input.nil?
+      data = []
+      input.split("\n").each do |l|
+        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"
+          msg = Bisac::POA.new
+          msg.build_message(data)
+          yield msg
+          data = []
+        end
+      end
+
+      # if we've got to the end of the file, and haven't hit a footer line yet, the file
+      # is probably malformed. Call build_message anyway, and let it detect any errors
+      if data.size > 0
+        msg = Bisac::POA.new
+        msg.build_message(data)
+        yield msg
+      end
+    end
+
+    def total_qty
+      @items.collect { |i| i.qty }.inject { |sum, x| sum ? sum+x : x}
+    end
+
+    def to_s
+      lines = []
+
+      # file header
+      line = " " * 80
+      line[0,2]   = "00" # line type
+      line[2,5]   = "00001"  # line counter
+      line[7,7]   = pad_trunc(@source_san, 7)
+      line[14,5]  = pad_trunc(@source_suffix, 5)
+      line[19,13] = pad_trunc(@source_name, 13)
+      line[32,6]  = pad_trunc(@date, 6)
+      line[38,22] = pad_trunc(@filename, 22)
+      line[60,3]  = pad_trunc(@format_version, 3)
+      line[63,7]  = pad_trunc(@destination_san, 7)
+      line[70,5]  = pad_trunc(@destination_suffix, 5)
+      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
+      @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
+      end
+
+      # PO control
+      line = " " * 80
+      line[0,2]   = "50"
+      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")
+      lines << line
+
+      # file trailer
+      line = " " * 80
+      line[0,2]   = "90"
+      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[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
+      lines << line
+
+      lines.join("\n")
+    end
+
+    # Populate the current object with the message contained in data
+    #
+    # An array of lines making a complete, single POA message
+    #
+    def 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?("02")
+      raise Bisac::InvalidFileError, 'Missing footer information' unless data[-1][0,2].eql?("91")
+
+      data.each do |line|
+        # ensure each line is at least 80 chars long
+        line = line.ljust(80)
+
+        case line[0,2]
+        when "02" # file header
+          self.source_san = line[7,7].strip
+          self.source_suffix = line[14,5].strip
+          self.source_name = line[19,13].strip
+          self.date = line[32,6].strip
+          self.filename = line[38,22].strip
+          self.format_version = line[60,3].strip
+          self.destination_san = line[63,7].strip
+          self.destination_suffix = line[70,5].strip
+          self.ack_type = line[75,1].strip
+        when "11" # poa header
+          self.supplier_poa_number = line[7,13].strip
+          self.po_number = line[20,13].strip
+          self.customer_san = line[33,7].strip
+          self.customer_suffix = line[40,5].strip
+          self.supplier_san = line[45,7].strip
+          self.supplier_suffix = line[52,5].strip
+          self.poa_date = line[57,6].strip
+          self.currency = line[63,3].strip
+          self.po_date  = line[66,6].strip
+          self.po_cancel_date = line[72,6].strip
+          self.po_type = line[78,2].strip
+        when "40" # line item
+          item = Bisac::POALineItem.load_from_string(line)
+          self.items << item
+        when "41"
+        when "42"
+        when "59" # poa footer
+          # check the built objects match the file
+        when "91" # file footer
+          # check the built objects match the file
+        end
+
+      end
+
+      self
+    end
+
+  end
+end

data/lib/bisac/poa_line_item.rb

@@ -0,0 +1,81 @@
+require 'bigdecimal'
+
+module Bisac
+
+  # represents a single line on the purchase order ack
+  class POALineItem
+
+    attr_accessor :sequence_number, :supplier_poa_number
+    attr_accessor :line_item_number, :order_qty, :unit_price, :nett_price
+    attr_accessor :list_nett_indicator, :special_price, :discount
+    attr_accessor :shippable_qty, :status, :warehouse_status
+    attr_reader :isbn
+
+    # returns a new Bisac::POLineItem object using the data passed in as a string
+    # refer to the bisac spec for the expected format of the string
+    def self.load_from_string(data)
+      data = data.to_s.ljust(93)
+      raise ArgumentError, "POA Line Items must start with '40'" unless data[0,2] == "40"
+
+      item = POALineItem.new
+
+      item.sequence_number = data[2,5].to_i
+      item.supplier_poa_number = data[7,13].strip
+      item.line_item_number = data[20,10].strip
+
+      # prefer the 13 digit ISBN if it exists (it's a non-standard, Pacstream extension)
+      # fallback to the ISBN10
+      item.isbn = data[80,13].strip
+      item.isbn = data[30,10].strip if item.isbn.nil?
+      item.order_qty = data[40,5].to_i
+      item.unit_price = BigDecimal.new(data[45,8]) / 100
+      item.nett_price = BigDecimal.new(data[53,9]) / 100
+      item.list_nett_indicator = data[62,1]
+      item.special_price = data[63,1]
+      item.discount = BigDecimal.new(data[63,1]) / 100
+      item.shippable_qty = data[69,5].to_i
+      item.status = data[74,2].to_i
+      item.warehouse_status = data[76,2].to_i
+
+      return item
+    end
+
+    def isbn=(val)
+      if val == ""
+        @isbn = nil
+      elsif RBook::ISBN.valid_isbn10?(val)
+        @isbn = RBook::ISBN.convert_to_isbn13(val)
+      else
+        @isbn = val
+      end
+    end
+
+    # is the isbn for this product valid?
+    def isbn?
+      RBook::ISBN.valid_isbn13?(@isbn || "")
+    end
+
+    def isbn10
+      if isbn?
+        RBook::ISBN.convert_to_isbn10(@isbn)
+      else
+        @isbn
+      end
+    end
+
+    def status_text
+      case self.status
+      when 1  then "Title Shipped As Ordered"
+      when 3  then "Cancelled: Future Publication"
+      when 6  then "Cancelled: Out of Stock"
+      when 7  then "Backordered: Out of Stock"
+      when 9  then "Partial Ship: Cancel Rest"
+      when 10 then "Partial Ship: Backorder Rest"
+      when 20 then "Cancelled: Not Carried"
+      when 28 then "Cancelled: Out of Print"
+      else
+        "UNKNOWN"
+      end
+    end
+  end
+end

data/lib/bisac/product.rb

@@ -0,0 +1,174 @@
+module Bisac
+
+  # Class to represent a single product line in a Bisac File. See
+  # Bisac::Message for basic usage instructions.
+  class Product
+
+    attr_reader :isbn, :title, :author, :price, :pubdate, :publisher
+    attr_reader :imprint, :volumes, :edition, :binding, :volume, :status
+
+    # Creates a new product object with the requested ISBN. Must be a 10 digit ISBN.
+    def initialize(isbn)
+      raise ArgumentError, 'isbn must 10 chars or less' if isbn.to_s.length > 10
+
+      @isbn = isbn.to_s
+      @title = ""
+      @author = ""
+      @price = ""
+      @pubdate = ""
+      @publisher = ""
+      @imprint = ""
+      @volumes = ""
+      @edition = ""
+      @binding = ""
+      @volume = ""
+      @status = ""
+    end
+
+    # sets the products author. Maximum of 30 chars.
+    def author=(author)
+      @author = author.to_s
+    end
+
+    # sets the products binding. Maximum of 2 chars.
+    def binding=(binding)
+      @binding = binding.to_s
+    end
+
+    # sets the products edition number. Maximum of 3 chars.
+    def edition=(edition)
+      @edition = edition.to_s
+    end
+
+    # takes a single line from a BISAC file and attempts to convert
+    # it to a Product object
+    def self.from_string(s)
+      s = s.to_s
+      return nil if s.length < 259
+      product = self.new(s[0,10])
+      product.title = s[15,30].strip
+      product.author = s[46,30].strip
+      product.price = s[79,7].strip if s[79,7].strip.match(/\A\d{0,7}\Z/)
+      product.pubdate = s[87,6].strip if s[87,6].strip.match(/\A\d{6}\Z/)
+      product.publisher = s[94,10].strip
+      product.imprint = s[105,14].strip
+      product.volumes = s[120,3].strip
+      product.edition = s[124,2].strip
+      product.binding = s[127,2].strip
+      product.volume = s[130,3].strip
+      product.status = s[153,3].strip
+      return product
+    end
+
+    # Sets the products imprint. Maximum of 14 chars.
+    def imprint=(imprint)
+      @imprint = imprint.to_s
+    end
+
+    # Sets the price imprint. Maximum of 7 chars. Must by a whole 
+    # number (represent price in cents).
+    def price=(price)
+      unless price.to_s.match(/\A\d{0,7}\Z/)
+        raise ArgumentError, 'price should be a whole number with no more than 7 digits. (price in cents)'
+      end
+      @price = price.to_s
+    end
+
+    # Sets the products pubdate. Must be in the form YYMMDD
+    def pubdate=(pubdate)
+      unless pubdate.to_s.match(/\A\d{6}\Z/)
+        raise ArgumentError, 'pubdate should be a date in the form YYMMDD.'
+      end
+      @pubdate = pubdate.to_s
+    end
+
+    # sets the products publisher. Maximum of 10 chars.
+    def publisher=(publisher)
+      @publisher = publisher.to_s
+    end
+
+    # sets the products status code. Maximum of 3 chars.
+    def status=(status)
+      @status = status.to_s
+    end
+
+    # sets the products title. Maximum of 30 chars.
+    def title=(title)
+      @title = title.to_s
+    end
+
+    # Returns the product as a single line ready for inserting into a BISAC file.
+    # Doesn't have a \n on the end
+    def to_s
+      content = ""
+      content << @isbn[0,10].ljust(10) # 10 digit isbn
+      content << "1"
+      content << "N"
+      content << "N"
+      content << "B"
+      content << "N"
+      content << @title[0,30].ljust(30)
+      content << "N"
+      content << @author[0,30].ljust(30)
+      content << "N"
+      content << "A" # author role
+      content << "N"
+      content << @price[0,7].rjust(7,"0") # current price
+      content << "N"
+      content << @pubdate[0,6].ljust(6) # published date
+      content << "N"
+      content << @publisher[0,10].ljust(10) # publisher
+      content << "N"
+      content << @imprint[0,14].ljust(14) #imprint
+      content << "N"
+      content << @volumes[0,3].rjust(3,"0") # volumes included in this isbn
+      content << "N"
+      content << @edition[0,2].rjust(2,"0") # edition
+      content << "N"
+      content << @binding[0,2].rjust(2,"0") # binding
+      content << "N"
+      content << @volume[0,3].rjust(3,"0") # volume number
+      content << "N"
+      content << "0000000" # new price
+      content << "N"
+      content << "000000" # new price effective date
+      content << "N"
+      content << "   " # audience type
+      content << "N"
+      content << @status[0,3].rjust(3) # status
+      content << "N"
+      content << "      " # available date. only use for status' like NYP
+      content << "N"
+      content << "          " # alternate isbn
+      content << "N"
+      content << "999999" # out of print date. only use for status == OP
+      content << "N"
+      content << "   " # geographic restrictions
+      content << "N"
+      content << "        " # library of congress catalogue number
+      content << "N"
+      content << "".ljust(40) # series title
+      content << "N"
+      content << "0" # price code for current price
+      content << "N"
+      content << "0" # price code for new price
+      content << "N"
+      content << "0000000" # freight pass through price
+      content << "N"
+      content << "000000" # new freight pass through price
+      content << "00000" # last changed date
+
+      return content
+    end
+
+    # sets the products volume number. Maximum of 3 chars.
+    def volume=(volume)
+      @volume = volume.to_s
+    end
+
+    # sets the number of volumes in the set this product belongs to. Maximum of 3 chars.
+    def volumes=(volumes)
+      @volumes = volumes.to_s
+    end
+  end
+end