bookbinder 0.3.1 → 0.3.2

data/lib/bookbinder/file_system/directory.rb

@@ -25,6 +25,11 @@ class Bookbinder::FileSystem::Directory
   end
 
 
+  def get_io(path, &blk)
+    get_file(path, 'r', &blk)
+  end
+
+
   def get_file(path, mode = 'r', &blk)
     fpath = full_path(path)
     must_exist(fpath)  if mode[0] != 'w'

data/lib/bookbinder/file_system/memory.rb

@@ -22,6 +22,11 @@ class Bookbinder::FileSystem::Memory
   end
 
 
+  def get_io(path, &blk)
+    blk.call(StringIO.new(read(path)))
+  end
+
+
   # Creates a tempfile so you can do memory-efficient stuff.
   #
   def get_file(path, mode = 'r', &blk)

data/lib/bookbinder/file_system/zip_file.rb

@@ -26,6 +26,11 @@ class Bookbinder::FileSystem::ZipFile < Bookbinder::FileSystem
   end
 
 
+  def get_io(path, &blk)
+    @zipfile.get_entry(path).get_input_stream(&blk)
+  end
+
+
   def get_file(path, mode = 'r', &blk)
     read_before = mode[0] != 'w'
     write_after = mode[0] != 'r'

data/lib/bookbinder/file_system.rb

@@ -15,6 +15,11 @@ class Bookbinder::FileSystem
   end
 
 
+  def get_io(path, &blk)
+    # IMPLEMENT IN SUBCLASS
+  end
+
+
   def get_file(path, mode = 'r', &blk)
     # IMPLEMENT IN SUBCLASS
   end

data/lib/bookbinder/operations.rb

@@ -2,12 +2,19 @@ class Bookbinder::Operations
 
   class << self
 
+    def package_classes
+      ObjectSpace.each_object(Class).select { |klass|
+        klass < Bookbinder::Package
+      }
+    end
+
+
     # This inspects a path and gives you the package class that
     # probably can read or write it.
     #
     def recognize(path)
-      ObjectSpace.each_object(Class).detect { |klass|
-        klass < Bookbinder::Package && klass.recognize(path)
+      package_classes.detect { |klass|
+        klass.recognize(path)
       } || raise(Bookbinder::UnknownFormat, path)
     end
 

data/lib/bookbinder/package/epub.rb

@@ -33,12 +33,7 @@ class Bookbinder::Package::EPUB < Bookbinder::Package
 
 
   def self.transforms
-    @transforms = DEFAULT_TRANSFORMS
-  end
-
-
-  def transforms
-    self.class.transforms
+    @transforms ||= DEFAULT_TRANSFORMS
   end
 
 

data/lib/bookbinder/package/media_ripper.rb

@@ -22,12 +22,26 @@ class Bookbinder::Package::MediaRipper < Bookbinder::Package
 
 
   def self.transforms
-    @transforms = DEFAULT_TRANSFORMS
+    @transforms ||= DEFAULT_TRANSFORMS
   end
 
 
-  def transforms
-    self.class.transforms
+  def audio_paths
+    xml_paths.collect { |xml_path|
+      next  unless doc = file(xml_path).document('r')
+      next  unless markers_tag = doc.find('AudioBook > Markers')
+      markers_tag['file']
+    }.compact
+  end
+
+
+  def xml_paths
+    xml_paths = []
+    file_system.each { |path|
+      next  unless match = path.match(/Part(\d+)\.xml$/)
+      xml_paths[match[1].to_i] = path
+    }
+    xml_paths.compact!
   end
 
 end

data/lib/bookbinder/package/mp3_audiobook.rb

@@ -0,0 +1,43 @@
+class Bookbinder::Package::MP3Audiobook < Bookbinder::Package
+
+  require_transforms('mp3_audiobook')
+
+  DEFAULT_TRANSFORMS = [
+    Bookbinder::Transform::MP3Audiobook_Rendition,
+    Bookbinder::Transform::MP3Audiobook_Title,
+    Bookbinder::Transform::MP3Audiobook_Creator,
+    Bookbinder::Transform::MP3Audiobook_Description,
+    Bookbinder::Transform::MP3Audiobook_Publisher,
+    Bookbinder::Transform::MP3Audiobook_Subject,
+    Bookbinder::Transform::MP3Audiobook_CoverImage,
+    Bookbinder::Transform::MP3Audiobook_Spine,
+    Bookbinder::Transform::MP3Audiobook_NavToc,
+    Bookbinder::Transform::Organizer,
+    Bookbinder::Transform::Generator
+  ]
+
+  MP3_EXT_RE = /.mp3$/i
+
+
+  def self.recognize(path)
+    File.directory?(path) && Dir.glob(File.join(path, '*')).all? { |path|
+      path.match(MP3_EXT_RE)
+    }
+  end
+
+
+  def self.transforms
+    @transforms ||= DEFAULT_TRANSFORMS
+  end
+
+
+  def audio_paths
+    [].tap { |aud_paths|
+      file_system.each { |path|
+        aud_paths << path  if path.match(MP3_EXT_RE)
+      }
+      aud_paths.sort!
+    }
+  end
+
+end

data/lib/bookbinder/package/openbook.rb

@@ -16,8 +16,8 @@ class Bookbinder::Package::Openbook < Bookbinder::Package
   end
 
 
-  def transforms
-    [
+  def self.transforms
+    @transforms ||= [
       Bookbinder::Transform::Generator,
       Bookbinder::Transform::Openbook_JSON
     ]

data/lib/bookbinder/package.rb

@@ -29,6 +29,11 @@ class Bookbinder::Package
   end
 
 
+  def self.transforms
+    [] # Implement in subclasses
+  end
+
+
   # Creates a new package of this class pointing at the given
   # path (but not reading from it automatically).
   #
@@ -188,8 +193,7 @@ class Bookbinder::Package
   # this package.
   #
   def transforms
-    # IMPLEMENT IN SUBCLASSES
-    []
+    self.class.transforms
   end
 
 

data/lib/bookbinder/transform/media_ripper/nav_toc.rb

@@ -14,7 +14,7 @@ class Bookbinder::Transform::MediaRipper_NavToc < Bookbinder::Transform
 
   def to_map(package)
     toc = []
-    xml_paths_in_package(package).each { |xml_path|
+    package.xml_paths.each { |xml_path|
       doc = package.file(xml_path).document('r')
       markers_tag = doc.find('AudioBook > Markers')
       aud_path = markers_tag['file']
@@ -32,16 +32,6 @@ class Bookbinder::Transform::MediaRipper_NavToc < Bookbinder::Transform
 
   protected
 
-    def xml_paths_in_package(package)
-      xml_paths = []
-      package.file_system.each { |path|
-        next  unless match = path.match(/Part(\d+)\.xml$/)
-        xml_paths[match[1].to_i] = path
-      }
-      xml_paths.compact!
-    end
-
-
     # MediaMarker time string comes in like:
     #
     #   74:48.000

data/lib/bookbinder/transform/media_ripper/spine.rb

@@ -2,7 +2,7 @@ class Bookbinder::Transform::MediaRipper_Spine < Bookbinder::Transform
 
   def to_map(package)
     package.map['resources'] = []
-    package.map['spine'] = audio_paths_in_package(package).collect { |path|
+    package.map['spine'] = package.audio_paths.collect { |path|
       {
         'path' => path,
         'media-type' => package.file(path).media_type,
@@ -14,30 +14,12 @@ class Bookbinder::Transform::MediaRipper_Spine < Bookbinder::Transform
 
   protected
 
-    def audio_paths_in_package(package)
-      xml_paths_in_package(package).collect { |xml_path|
-        next  unless doc = package.file(xml_path).document('r')
-        next  unless markers_tag = doc.find('AudioBook > Markers')
-        markers_tag['file']
-      }.compact
-    end
-
-
-    def xml_paths_in_package(package)
-      xml_paths = []
-      package.file_system.each { |path|
-        next  unless match = path.match(/Part(\d+)\.xml$/)
-        xml_paths[match[1].to_i] = path
-      }
-      xml_paths.compact!
-    end
-
-
     def audio_length(package, path)
       length = 0
       begin
-        package.file(path).get_file { |f|
-          Mp3Info.open(f) { |info| length = info.length }
+        package.file_system.get_io(path) { |zip_io|
+          io = StringIO.new(zip_io.read(4096))
+          Mp3Info.open(io) { |info| length = info.length }
         }
       rescue => e
         # TODO - is there error handling to do here?

data/lib/bookbinder/transform/mp3_audiobook/cover_image.rb

@@ -0,0 +1,25 @@
+class Bookbinder::Transform::MP3Audiobook_CoverImage < Bookbinder::Transform
+
+  TAG = 'APIC'
+  PATH = 'cover.jpg'
+
+  def to_map(package)
+    return  unless path = package.audio_paths.first
+    package.file(path).get_file { |mp3|
+      Mp3Info.open(mp3) { |info|
+        info.tag2.pictures.each { |desc, data|
+          parts = [File.basename(desc), File.extname(desc)]
+          path = Dir::Tmpname.create(parts) {}
+          File.binwrite(path, data)
+          package.file_system.set_file(desc, File.new(path))
+          package.map['cover'] = { 'front' => {
+            'path' => desc,
+            'media-type' => Bookbinder::MediaType.of(desc)
+          } }
+          return
+        }
+      }
+    }
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/creator.rb

@@ -0,0 +1,27 @@
+class Bookbinder::Transform::MP3Audiobook_Creator < Bookbinder::Transform
+
+  TAG = 'TPE1'
+
+
+  def dependencies
+    [Bookbinder::Transform::MP3Audiobook_Metadata]
+  end
+
+
+  def to_map(package)
+    return  unless md = package.map['metadata']
+    return  unless md[TAG] &&  md[TAG].first
+    creator = md[TAG].first['@']
+    md.delete(TAG)
+    creators = creator.split('/')
+    package.map['creator'] = [{
+      'name' => creators.shift,
+      'role' => 'aut'
+    }]
+    package.map['creator'].push({
+      'name' => creators.shift,
+      'role' => 'nrt'
+    })  if creators.any?
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/description.rb

@@ -0,0 +1,18 @@
+class Bookbinder::Transform::MP3Audiobook_Description < Bookbinder::Transform
+
+  TAG = 'COMM'
+
+
+  def dependencies
+    [Bookbinder::Transform::MP3Audiobook_Metadata]
+  end
+
+
+  def to_map(package)
+    return  unless md = package.map['metadata']
+    return  unless md[TAG] &&  md[TAG].first
+    package.map['description'] = { 'full' => md[TAG].first['@'] }
+    md.delete(TAG)
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/metadata.rb

@@ -0,0 +1,20 @@
+class Bookbinder::Transform::MP3Audiobook_Metadata < Bookbinder::Transform
+
+  SKIP_FIELDS = ['TRCK', 'TENC', 'APIC']
+
+
+  def to_map(package)
+    return  unless path = package.audio_paths.first
+    md = {}
+    package.file(path).get_file { |mp3|
+      Mp3Info.open(mp3) { |info|
+        info.tag2.each_pair { |name, value|
+          next  if value == 'null' || SKIP_FIELDS.include?(name)
+          md[name] = [md[name], { '@' => value }].flatten.compact
+        }
+      }
+    }
+    package.map['metadata'] = md
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/nav_toc.rb

@@ -0,0 +1,58 @@
+# TXXX MediaMarker XML format is like this:
+#
+# OverDrive MediaMarkers\\x00<Markers><Marker><Name>Part I - Chapter 1</Name><Time>0:00.000</Time></Marker>... etc ...</Markers>
+#
+class Bookbinder::Transform::MP3Audiobook_NavToc < Bookbinder::Transform
+
+  TAG = 'TXXX'
+  MEDIAMARKER_PREFIX_RE = /^.*MediaMarkers[^<]*/
+
+
+  def dependencies
+    [Bookbinder::Transform::MP3Audiobook_Metadata]
+  end
+
+
+  def to_map(package)
+    toc = []
+    package.audio_paths.each { |aud_path|
+      xml = nil
+      package.file(aud_path).get_file { |mp3|
+        Mp3Info.open(mp3) { |info| xml = info.tag2[TAG] }
+      }
+      next  unless xml && xml.slice!(MEDIAMARKER_PREFIX_RE)
+      doc = Nokogiri::XML(xml)
+      doc.root.css('Marker').each { |marker_tag|
+        seconds = translate_time(marker_tag.at_css('Time').content)
+        toc << {
+          'title' => marker_tag.at_css('Name').content.strip,
+          'path' => "#{aud_path}#{seconds ? "##{seconds}" : ''}"
+        }
+      }
+    }
+    package.map['nav'] = { 'toc' => toc }
+    if txxx = package.map['metadata'][TAG]
+      txxx.delete_if { |val| val['@'].match(MEDIAMARKER_PREFIX_RE) }
+    end
+    package.map['metadata'].delete(TAG)  if txxx.empty?
+  end
+
+
+  protected
+
+    # MediaMarker time string comes in like:
+    #
+    #   74:48.000
+    #
+    # We should translate to 74*60+48.0 ==> 4488
+    #
+    def translate_time(time_str)
+      match = time_str.match(/^(\d+):([\d\.]+)$/)
+      minutes = match[1].to_i
+      seconds = match[2].to_f
+      seconds = seconds.round  if seconds % 1 == 0
+      out = minutes * 60 + seconds
+      out > 0 ? out : nil
+    end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/publisher.rb

@@ -0,0 +1,18 @@
+class Bookbinder::Transform::MP3Audiobook_Publisher < Bookbinder::Transform
+
+  TAG = 'TPUB'
+
+
+  def dependencies
+    [Bookbinder::Transform::MP3Audiobook_Metadata]
+  end
+
+
+  def to_map(package)
+    return  unless md = package.map['metadata']
+    return  unless md[TAG] &&  md[TAG].first
+    package.map['publisher'] = md[TAG].first['@']
+    md.delete(TAG)
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/rendition.rb

@@ -0,0 +1,7 @@
+class Bookbinder::Transform::MP3Audiobook_Rendition < Bookbinder::Transform
+
+  def to_map(package)
+    package.map['rendition-format'] = 'audiobook'
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/spine.rb

@@ -0,0 +1,30 @@
+class Bookbinder::Transform::MP3Audiobook_Spine < Bookbinder::Transform
+
+  def to_map(package)
+    package.map['resources'] = []
+    package.map['spine'] = package.audio_paths.collect { |path|
+      {
+        'path' => path,
+        'media-type' => 'audio/mpeg',
+        'audio-duration' => audio_length(package, path)
+      }
+    }
+  end
+
+
+  protected
+
+    def audio_length(package, path)
+      length = 0
+      begin
+        package.file(path).get_file { |mp3|
+          Mp3Info.open(mp3) { |info| length = info.length }
+        }
+      rescue => e
+        # TODO - is there error handling to do here?
+        raise e
+      end
+      length
+    end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/subject.rb

@@ -0,0 +1,18 @@
+class Bookbinder::Transform::MP3Audiobook_Subject < Bookbinder::Transform
+
+  TAG = 'TCON'
+
+
+  def dependencies
+    [Bookbinder::Transform::MP3Audiobook_Metadata]
+  end
+
+
+  def to_map(package)
+    return  unless md = package.map['metadata']
+    return  unless md[TAG] &&  md[TAG].first
+    package.map['subject'] = [md[TAG].collect { |h| h['@'] }]
+    md.delete(TAG)
+  end
+
+end

data/lib/bookbinder/transform/mp3_audiobook/title.rb

@@ -0,0 +1,18 @@
+class Bookbinder::Transform::MP3Audiobook_Title < Bookbinder::Transform
+
+  TAG = 'TALB'
+
+  def dependencies
+    [Bookbinder::Transform::MP3Audiobook_Metadata]
+  end
+
+
+  def to_map(package)
+    package.map['title'] = titles = {}
+    return  unless md = package.map['metadata']
+    return  unless md[TAG] && md[TAG].first
+    titles['main'] = md[TAG].first['@']
+    md.delete(TAG)
+  end
+
+end

data/lib/bookbinder/transform/organizer.rb

@@ -13,6 +13,7 @@ class Bookbinder::Transform::Organizer < Bookbinder::Transform
     eisbn
     pisbn
     publisher
+    subject
     rendition-*
     audio-*
     spine

data/lib/bookbinder/version.rb

@@ -1,5 +1,5 @@
 module Bookbinder
 
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 
 end

data/lib/bookbinder.rb

@@ -29,3 +29,4 @@ require 'bookbinder/file_system/zip_file'
 require 'bookbinder/package/openbook'
 require 'bookbinder/package/epub'
 require 'bookbinder/package/media_ripper'
+require 'bookbinder/package/mp3_audiobook'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbinder
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &22943580 !ruby/object:Gem::Requirement
+  requirement: &13080360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22943580
+  version_requirements: *13080360
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &22940240 !ruby/object:Gem::Requirement
+  requirement: &13076700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *22940240
+  version_requirements: *13076700
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &22938680 !ruby/object:Gem::Requirement
+  requirement: &13075540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22938680
+  version_requirements: *13075540
 - !ruby/object:Gem::Dependency
   name: ruby-mp3info
-  requirement: &23389640 !ruby/object:Gem::Requirement
+  requirement: &13920580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *23389640
+  version_requirements: *13920580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &23389220 !ruby/object:Gem::Requirement
+  requirement: &13920160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23389220
+  version_requirements: *13920160
 description: Convert easily between common ebook formats.
 email:
 - jpearson@overdrive.com
@@ -85,6 +85,7 @@ files:
 - lib/bookbinder/operations.rb
 - lib/bookbinder/package/epub.rb
 - lib/bookbinder/package/media_ripper.rb
+- lib/bookbinder/package/mp3_audiobook.rb
 - lib/bookbinder/package/openbook.rb
 - lib/bookbinder/package.rb
 - lib/bookbinder/transform/epub/audio_overlay.rb
@@ -116,6 +117,16 @@ files:
 - lib/bookbinder/transform/media_ripper/rendition.rb
 - lib/bookbinder/transform/media_ripper/spine.rb
 - lib/bookbinder/transform/media_ripper/title.rb
+- lib/bookbinder/transform/mp3_audiobook/cover_image.rb
+- lib/bookbinder/transform/mp3_audiobook/creator.rb
+- lib/bookbinder/transform/mp3_audiobook/description.rb
+- lib/bookbinder/transform/mp3_audiobook/metadata.rb
+- lib/bookbinder/transform/mp3_audiobook/nav_toc.rb
+- lib/bookbinder/transform/mp3_audiobook/publisher.rb
+- lib/bookbinder/transform/mp3_audiobook/rendition.rb
+- lib/bookbinder/transform/mp3_audiobook/spine.rb
+- lib/bookbinder/transform/mp3_audiobook/subject.rb
+- lib/bookbinder/transform/mp3_audiobook/title.rb
 - lib/bookbinder/transform/openbook/json.rb
 - lib/bookbinder/transform/organizer.rb
 - lib/bookbinder/transform.rb