mobi 0.1.2 → 0.2.0

data/lib/mobi/metadata.rb

@@ -1,79 +1,56 @@
+require 'forwardable'
+
 module Mobi
   class Metadata
-    DRM_KEY_SIZE = 48
-    
-    EXTH_RECORDS = { 100 => :author, 101 => :publisher, 102 => :imprint, 103 => :description, 104 => :isbn, 105 => :subject,
-                     106 => :published_at, 107 => :review, 108 => :contributor, 109 => :rights, 110 => :subject_code, 
-                     111 => :type, 112 => :source, 113 => :asin, 114 => :version}
-    attr_reader *EXTH_RECORDS.values
-    attr_reader :title
+    extend Forwardable
+
+    EXTH_RECORDS = %w(author publisher imprint description isbn subject
+                      published_at review contributor rights subject_code type
+                      source asin version)
+
+    # Raw data stream
+    attr_reader :data
+    # Individual header classes for your reading pleasure.
+    attr_reader :palm_doc_header, :mobi_header, :exth_header
+
+    def initialize(file)
+      @file = file
+      @data = StreamSlicer.new(file)
+
+      raise InvalidMobi, "The supplied file is not in a valid mobi format" unless bookmobi?
+
+      @record_zero_stream = MetadataStreams.record_zero_stream(file)
+      @palm_doc_header    = Header::PalmDocHeader.new @record_zero_stream
+      @mobi_header        = Header::MobiHeader.new @record_zero_stream
+
+      @exth_stream = MetadataStreams.exth_stream(file, @mobi_header.header_length)
+      @exth_header = Header::ExthHeader.new @exth_stream
+    end
+
+    # Gets the title of the book.
+    #
+    # Returns a String.
+    def title
+      return @title if @title
 
-    attr_accessor :stream, :data, :mobi, :exth
-    attr_reader :exth_records
+      offset = @mobi_header.full_name_offset
+      length = @mobi_header.full_name_length
 
-    def initialize(stream)
-      @stream = stream
-      @data = StreamSlicer.new(stream)
-      @exth_records = []
-      return unless bookmobi?
-      @mobi = mobi_stream    
-      @title = read_title
-      @exth = exth_stream
-    
-      store_mobi_data
+      @title = @record_zero_stream[offset, length]
     end
-    
+
+    # Determines if the file is a valid mobi file.
+    #
+    # Returns true if the file is a valid MOBI.
     def bookmobi?
       @data[60, 8] == "BOOKMOBI"
     end
-    
-    def mobi_stream
-      offset = 78
-      start, = @data[offset, 4].unpack('N*')
-      stop,  = @data[offset + 8, offset + 12].unpack('N*')
-      StreamSlicer.new(self.stream, start, stop)
-    end
-    
-    def exth_stream
-      exth_off = @mobi[20, 4].unpack('N*').first + 16 + @mobi.start
-      StreamSlicer.new(stream, exth_off, @mobi.stop)
-    end
-    
-    def read_title
-      offset, = @mobi[84, 4].unpack('N*')
-      length, = @mobi[88, 4].unpack('N*')
-      @mobi[offset.to_i, length.to_i]
-    end
-    
-    def store_mobi_data
-      record_count, = @exth[8, 4].unpack('N*')
-      start = 12
-      record_count.times do
-        code, = @exth[start, 4].unpack('N*')
-        code  = code.to_i
-        
-        length, = @exth[start + 4, 4].unpack('N*')
-        value   = @exth[start + 8, length - 8]
-        
-        if EXTH_RECORDS[code]
-          instance_variable_set "@#{EXTH_RECORDS[code].to_s}", value
-          @exth_records << EXTH_RECORDS[code]
-        end
-      
-        start += length
-      end
+
+    # Delegate EXTH records types to the EXTH header.
+    EXTH_RECORDS.each do |type|
+      def_delegators :@exth_header, type.to_sym, type.to_sym
     end
 
+    class InvalidMobi < ArgumentError;end;
   end
-  
-end
-  
-# def record(self, n):
-#     if n >= self.nrecs:
-#         raise ValueError('non-existent record %r' % n)
-#     offoff = 78 + (8 * n)
-#     start, = unpack('>I', self.data[offoff + 0:offoff + 4])
-#     stop = None
-#     if n < (self.nrecs - 1):
-#         stop, = unpack('>I', self.data[offoff + 8:offoff + 12])
-#     return StreamSlicer(self.stream, start, stop)
+end

data/lib/mobi/metadata_streams.rb

@@ -0,0 +1,46 @@
+module Mobi
+  module MetadataStreams
+
+    # Creates a stream starting at the Record 0 in the PalmDOC.
+    #
+    # Returns a StreamSlicer.
+    def self.record_zero_stream(file)
+      data = StreamSlicer.new(file)
+
+      start, stop = record_zero_endpoints(data)
+
+      StreamSlicer.new(file, start, stop)
+    end
+
+    # Creates a stream starting at the EXTH header in Record 0.
+    #
+    # Returns a StreamSlicer.
+    def self.exth_stream(file, header_length)
+      record_zero_stream = record_zero_stream(file)
+
+      record_zero_offset     = record_zero_stream.start
+      palm_doc_header_length = 16
+
+      exth_off = record_zero_offset +
+                 palm_doc_header_length +
+                 header_length
+
+      StreamSlicer.new(file, exth_off, record_zero_stream.stop)
+    end
+
+    private
+
+    # Determines the start and end points of Record 0 in the PalmDOC. The start point
+    # is returned as the first value in the array, and the end point as the
+    # second value.
+    #
+    # Returns an Array.
+    def self.record_zero_endpoints(data)
+      offset = 78
+      start, = data[offset, 4].unpack('N*')
+      stop,  = data[offset + 8, offset + 12].unpack('N*');
+      [start, stop]
+    end
+
+  end
+end

data/lib/mobi/stream_slicer.rb

@@ -1,67 +1,44 @@
 module Mobi
   class StreamSlicer
 
-    attr_reader :stream, :length
+    attr_reader   :stream, :length
     attr_accessor :start, :stop
 
-    def initialize(stream, start=0, stop=nil)
+    def initialize(stream, start = 0, stop = nil)
       @stream = stream
       @start  = start
+
       if stop.nil?
         stream.seek(0, 2)
         stop = stream.tell
       end
-      @stop = stop
+
+      @stop    = stop
       @length  = stop - start
     end
 
     def [](offset, bytes=1)
       stream = @stream
-      base = @start
-      
+      base   = @start
+
       if bytes == 1
         stream.seek(base + offset)
         return stream.read(1)
       end
-      
+
       start = offset
       stop  = offset + bytes
-      
+
       # Reverse if you want to pass in negative bytes
       start, stop = stop, start if bytes < 0
-      
+
+      # I can't find a use case where it will ever get here
       size = stop - start
-      return "" if size <= 0
-      
+      return nil if size <= 0
+
       stream.seek(base + start)
       data = stream.read(size)
       return data
     end
-
-
-    # def [](key)
-    #   stream = self.stream
-    #   base = self.start
-    #   if key.is_a? Integer
-    #     stream.seek(base + key)
-    #     return stream.read(1)
-    #   end
-    #   if key.is_a? Range
-    #     start = key.first 
-    #     stop = key.last
-    # 
-    #     if key.max.nil?
-    #       start, stop = stop, start
-    #     end
-    #     size = stop - start
-    # 
-    #     return "" if size <= 0
-    # 
-    #     stream.seek(base + start)
-    #     data = stream.read(size)
-    #     return data
-    #   end
-    # end
-
   end
-end
+end

data/mobi.gemspec

@@ -4,20 +4,22 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{mobi}
-  s.version = "0.1.2"
+  s.name = "mobi"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jkongie"]
-  s.date = %q{2011-04-10}
-  s.description = %q{Mobi is a Rubygem that allows you to easily read MOBI e-book format metadata }
-  s.email = %q{jkongie@gmail.com}
+  s.date = "2012-08-06"
+  s.description = "Mobi is a Rubygem that allows you to easily read MOBI e-book format metadata."
+  s.email = "jkongie@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    ".rspec",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -25,41 +27,47 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/mobi.rb",
+    "lib/mobi/header/exth_header.rb",
+    "lib/mobi/header/mobi_header.rb",
+    "lib/mobi/header/palm_doc_header.rb",
     "lib/mobi/metadata.rb",
+    "lib/mobi/metadata_streams.rb",
     "lib/mobi/stream_slicer.rb",
     "mobi.gemspec",
-    "test/helper.rb",
-    "test/test_mobi.rb"
+    "spec/fixtures/sherlock.mobi",
+    "spec/lib/mobi/header/exth_header_spec.rb",
+    "spec/lib/mobi/header/mobi_header_spec.rb",
+    "spec/lib/mobi/header/palm_doc_header_spec.rb",
+    "spec/lib/mobi/metadata_spec.rb",
+    "spec/lib/mobi/stream_slicer_spec.rb",
+    "spec/lib/mobi_spec.rb",
+    "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/jkongie/mobi}
+  s.homepage = "http://github.com/jkongie/mobi"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{A Rubygem that inspects MOBI metadata}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_mobi.rb"
-  ]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A Rubygem that inspects MOBI metadata."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0.4"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.0"])
     else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.11.0"])
+      s.add_dependency(%q<rr>, ["~> 1.0.4"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.0"])
     end
   else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.11.0"])
+    s.add_dependency(%q<rr>, ["~> 1.0.4"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.0"])
   end
 end
 

data/spec/lib/mobi/header/exth_header_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+require 'mobi/stream_slicer'
+require 'mobi/metadata_streams'
+require 'mobi/header/mobi_header'
+require 'mobi/header/exth_header'
+
+describe Mobi::Header::ExthHeader do
+
+  before :all do
+    file   = File.open('spec/fixtures/sherlock.mobi')
+
+    record_zero_stream = Mobi::MetadataStreams.record_zero_stream(file)
+    mobi_header        = Mobi::Header::MobiHeader.new record_zero_stream
+    exth_stream        = Mobi::MetadataStreams.exth_stream(file, mobi_header.header_length)
+
+    @header = Mobi::Header::ExthHeader.new exth_stream
+  end
+
+  it 'gets the author' do
+    @header.author.should == 'Sir Arthur Conan Doyle'
+  end
+
+  it 'gets the book subject' do
+    @header.subject.should == 'Detective and mystery stories, English'
+  end
+
+  it 'gets the book rights' do
+    @header.rights.should == 'Public domain in the USA.'
+  end
+
+  it 'gets the book source' do
+    @header.source.should == 'http://www.gutenberg.org/files/2350/2350-h/2350-h.htm'
+  end
+
+end

data/spec/lib/mobi/header/mobi_header_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+require 'mobi/stream_slicer'
+require 'mobi/metadata_streams'
+require 'mobi/header/mobi_header'
+
+describe Mobi::Header::MobiHeader do
+  before :all do
+    file = File.open('spec/fixtures/sherlock.mobi')
+    stream    = Mobi::MetadataStreams.record_zero_stream(file)
+
+    @header = Mobi::Header::MobiHeader.new stream
+  end
+
+  it 'gets the identifier' do
+    @header.identifier.should == 'MOBI'
+  end
+
+  it 'gets the length of the MOBI header' do
+    @header.header_length.should == 232
+  end
+
+  it 'gets the mobi type as an integer' do
+    @header.raw_mobi_type.should == 2
+  end
+
+  it 'gets the mobi type as a string' do
+    @header.mobi_type.should == 'MOBIpocket Book'
+  end
+
+  it 'gets the raw text encoding' do
+    @header.raw_text_encoding.should == 65001
+  end
+
+  it 'gets the text encoding' do
+    @header.text_encoding.should == 'UTF-8'
+  end
+
+  it 'gets the unique id' do
+    @header.unique_id.should == 1532466569
+  end
+
+  it 'gets the file version' do
+    @header.file_version.should == 6
+  end
+
+  it 'gets the first non book index' do
+    @header.first_non_book_index.should == 16
+  end
+
+  it 'gets the full name offset' do
+    @header.full_name_offset.should == 688
+  end
+
+  it 'gets the full name length' do
+    @header.full_name_length.should == 12
+  end
+
+  it 'gets the raw locale code' do
+    @header.raw_locale_code.should == 9
+  end
+
+  it 'gets the minimum supported mobipocket version' do
+    @header.minimum_supported_mobipocket_version.should == 6
+  end
+
+  it 'gets the first image index record number' do
+    @header.first_image_index_record_number.should == 19
+  end
+
+  it 'gets the EXTH header flag' do
+    @header.exth_flag.should == 1
+  end
+
+  it 'checks if there an EXTH header exists' do
+    @header.exth_header?.should be_true
+  end
+
+end