class HTTPI::Dime

Constants

BINARY
XML

Public Class Methods

new(body) click to toggle source
# File lib/httpi/dime.rb, line 13
def initialize(body)
  bytes = body.unpack('C*')

  while bytes.length > 0
    record = DimeRecord.new
    configure_record(record, bytes)

    big_endian_lengths(bytes).each do |attribute_set|
      read_data(record, bytes, attribute_set)
    end

    self << record
  end
end

Public Instance Methods

big_endian_lengths(bytes) click to toggle source

Fetch big-endian lengths.

# File lib/httpi/dime.rb, line 41
def big_endian_lengths(bytes)
  lengths = [] # we can't use a hash since the order will be screwed in Ruby 1.8
  lengths << [:options, (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "options" field
  lengths << [:id,      (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "ID" or "name" field
  lengths << [:type,    (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "type" field
  lengths << [:data,    (bytes.shift << 24) | (bytes.shift << 16) | (bytes.shift << 8) | bytes.shift] # 4 bytes   Size of the included file
  lengths
end
binary_records() click to toggle source
# File lib/httpi/dime.rb, line 67
def binary_records
  select { |r| r.type_format == BINARY }
end
configure_record(record, bytes) click to toggle source

Shift out bitfields for the first fields.

# File lib/httpi/dime.rb, line 29
def configure_record(record, bytes)
  byte = bytes.shift

  record.version     = (byte >> 3) & 31         # 5 bits  DIME format version (always 1)
  record.first       = (byte >> 2) & 1          # 1 bit   Set if this is the first part in the message
  record.last        = (byte >> 1) & 1          # 1 bit   Set if this is the last part in the message
  record.chunked     = byte & 1                 # 1 bit   This file is broken into chunked parts
  record.type_format = (bytes.shift >> 4) & 15  # 4 bits  Type of file in the part (1 for binary data, 2 for XML)
                                                # 4 bits  Reserved (skipped in the above command)
end
read_data(record, bytes, attribute_set) click to toggle source

Read in padded data.

# File lib/httpi/dime.rb, line 51
def read_data(record, bytes, attribute_set)
  attribute, length = attribute_set
  content = bytes.slice!(0, length).pack('C*')

  if attribute == :data && record.type_format == BINARY
    content = StringIO.new(content)
  end

  record.send "#{attribute.to_s}=", content
  bytes.slice!(0, 4 - (length & 3)) if (length & 3) != 0
end
xml_records() click to toggle source
# File lib/httpi/dime.rb, line 63
def xml_records
  select { |r| r.type_format == XML }
end