epubinfo 0.3.6 → 0.4.0

data/README.md

@@ -13,6 +13,10 @@ Which returns a `EPUBInfo::Models::Book` instance, please refer to the [API docu
 
 ## Changelog
 
+**0.4.0** *July 31, 2012*
+
+* Added Book#cover method for extracting covers from epubs
+
 **0.3.6** *June 18, 2012*
 
 * Upgraded rubyzip dependency to version 0.9.9 for more robust zip handling

data/lib/epubinfo.rb

@@ -1,8 +1,10 @@
 require 'zip/zip'
 require 'nokogiri'
+require 'cgi'
 
 require 'epubinfo/parser'
 require 'epubinfo/models/book'
+require 'epubinfo/models/cover'
 require 'epubinfo/models/person'
 require 'epubinfo/models/date'
 require 'epubinfo/models/identifier'

data/lib/epubinfo/models/book.rb

@@ -58,6 +58,10 @@ module EPUBInfo
       def drm_protected; @drm_protected || false; end
       alias :drm_protected? :drm_protected
 
+      # Cover
+      # @return [Cover]
+      attr_accessor :cover
+
       # Should never be called directly, go through EPUBInfo.get
       def initialize(parser)
         document = parser.metadata_document
@@ -76,6 +80,7 @@ module EPUBInfo
         self.languages = metadata.xpath('.//language').map(&:content)
         self.rights = metadata.xpath('.//rights').first.content rescue nil
         self.drm_protected = parser.drm_protected?
+        self.cover = EPUBInfo::Models::Cover.new(parser)
       end
 
 
@@ -94,7 +99,8 @@ module EPUBInfo
           :source => @source,
           :languages => @languages,
           :rights => @rights,
-          :drm_protected => @drm_protected
+          :drm_protected => @drm_protected,
+          :cover => @cover,
         }
       end
     end

data/lib/epubinfo/models/cover.rb

@@ -0,0 +1,99 @@
+module EPUBInfo
+  module Models
+    class Cover
+      def self.new(parser)
+        return nil unless EPUBInfo::Parser === parser
+
+        cover = super(parser)
+
+        if cover.exists?
+          cover
+        else
+          nil
+        end
+      end
+
+      def initialize(parser)
+        @parser = parser
+        @path   = epub_cover_file_path
+        @content_type = epub_cover_content_type
+      end
+
+      # Original name of cover file
+      # @return [String]
+      def original_file_name
+        File.basename(@path) if @path
+      end
+
+      # Content type of cover file
+      # @return [String]
+      attr_accessor :content_type
+      def content_type; @content_type; end
+
+      # Cover exists?
+      # @return [Boolean]
+      # @!visibility private
+      def exists?
+        !!@path && @parser.zip_file.find_entry(zip_file_path)
+      end
+
+      # Cover file
+      # @return [File]
+      # Tempfile is used to enable access to cover file
+      # If block is passed, the tempfile is passed to it
+      #   cover.file do { |f| puts f.size }
+      # Otherwise user is responsible to unlink and close tempfile
+      #   file = book.cover.file
+      #   file.size
+      #   file.close!
+      def tempfile(&block)
+        tempfile = Tempfile.new('epubinfo')
+        tempfile.binmode
+
+        cover_file = @parser.zip_file.read(zip_file_path)
+        tempfile.write(cover_file)
+
+        if block_given?
+          yield tempfile
+          tempfile.close!
+        else
+          # user is responsible for closing file
+          tempfile
+        end
+      end
+
+      private
+
+      def epub_cover_file_path
+        epub_cover_item.attr('href') if epub_cover_item
+      end
+
+      def epub_cover_content_type
+        epub_cover_item.attr('media-type') if epub_cover_item
+      end
+
+      def epub_cover_item
+        @epub_cover_item ||= begin
+          metadata = @parser.metadata_document.css('metadata')
+          cover_id = metadata.css('meta [name=cover]').attr('content').value rescue nil || 'cover-image'
+
+          manifest = @parser.metadata_document.css('manifest')
+
+          manifest.css("item [id = #{cover_id}]").first rescue nil ||
+            manifest.css("item [property = #{cover_id}]").first rescue nil
+        end
+      end
+
+      def zip_file_path
+        dir = File.dirname(@parser.metadata_path)
+        path =
+          if dir == '.'
+            @path
+          else
+            File.join(dir, @path)
+          end
+        CGI::unescape(path)
+      end
+    end
+  end
+end

data/lib/epubinfo/parser.rb

@@ -16,8 +16,6 @@ module EPUBInfo
       @drm_protected ||= !!zip_file.find_entry('META-INF/rights.xml')
     end
 
-    private
-
     def zip_file
       begin
         @zip_file ||= Zip::ZipFile.open(@path)
@@ -26,6 +24,15 @@ module EPUBInfo
       end
     end
 
+    def metadata_path
+      @metadata_path ||= begin
+        root_document.remove_namespaces!
+        root_document.css('container rootfiles rootfile:first-child').attribute('full-path').content
+      end
+    end
+
+    private
+
     def root_document
       begin
         @root_document ||= Nokogiri::XML(zip_file.read('META-INF/container.xml'))
@@ -34,11 +41,6 @@ module EPUBInfo
       end
     end
 
-    def metadata_path
-      root_document.remove_namespaces!
-      root_document.css('container rootfiles rootfile:first-child').attribute('full-path').content
-    end
-
     def load_metadata_file
       Nokogiri::XML(zip_file.read(metadata_path))
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epubinfo
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-18 00:00:00.000000000 Z
+date: 2012-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70280533680660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.9.9
   type: :runtime
   prerelease: false
-  version_requirements: *70280533680660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70280533680000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 1.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *70280533680000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70280533679060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70280533679060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70280533678520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *70280533678520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70280533678040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70280533678040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70280533693600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70280533693600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70280533692540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280533692540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70280533691160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280533691160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70280533690620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +149,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280533690620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70280533690140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +165,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280533690140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70280533689640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +181,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280533689640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &70280533689160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +197,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280533689160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Supports EPUB2 and EPUB3 formats.
 email: christof@chdorner.com
 executables: []
@@ -153,6 +213,7 @@ extra_rdoc_files:
 files:
 - lib/epubinfo.rb
 - lib/epubinfo/models/book.rb
+- lib/epubinfo/models/cover.rb
 - lib/epubinfo/models/date.rb
 - lib/epubinfo/models/identifier.rb
 - lib/epubinfo/models/person.rb
@@ -175,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1061795473107184859
+      hash: 425566557774208517
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -184,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Extracts metadata information from EPUB files