epubmeta 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1011bfe3193d925bd9c24d7581533a9517be04f3daae0a045b94a4fd88d87887
+  data.tar.gz: 8beea6a90e8502b7a7adbedd6fc52e2a02a22723569c311417c56584d4d41a9c
+SHA512:
+  metadata.gz: a47ea2db7f32ec6315a7c8fe5aeeecc56d19a3feb666c6b947214fc46031e1bf9face4c98f7631324be9c537de482dce08afcb58550743caed41a09e4578a837
+  data.tar.gz: 1414699d02f38d19332d81c6682efff214f963cf6dd61a50aba0a27320f49f68a1e0489214fe2238e10c33ba7af8ca69e542303deb3d282aab6d8d9aebc7766d

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Andrew Roberts
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# epubmeta
+Extracts metadata information from EPUB files. Supports EPUB2 and EPUB3 formats.
+
+*This lib is a fork of `epubinfo`, which had not been updated since 2014.*
+
+## Usage
+
+```ruby
+require 'epubmeta'
+EPUBMeta.get('path/to/epub/file.epub')
+```
+
+Which returns a `EPUBMeta::Models::Book` instance, please refer to the [API documentation](http://rubydoc.info/gems/epubmeta/frames) from here on
+
+## Changelog
+
+**0.5.0** *August 10, 2018*
+
+* Convert module name EPUBMeta
+* Fix cover metadata parsing bug (credit: @Gizmokid2005)
+
+** < 0.5.0 **
+
+* Changelog for previous versions (pre-fork) can be found in the [epubinfo changelog](https://github.com/chdorner/epubinfo#changelog).
+
+## Contributing to epubmeta
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2018 Andrew Roberts. 
+Copyright (c) 2012--2014 Christof Dorner. 
+See LICENSE.txt for further details.

data/lib/epubmeta.rb

@@ -0,0 +1,20 @@
+require 'zip'
+require 'nokogiri'
+require 'cgi'
+
+require 'epubmeta/parser'
+require 'epubmeta/models/book'
+require 'epubmeta/models/cover'
+require 'epubmeta/models/person'
+require 'epubmeta/models/date'
+require 'epubmeta/models/identifier'
+require 'epubmeta/utils'
+
+module EPUBMeta
+  # Parses an epub file and returns a Book instance.
+  # @return [EPUBMeta::Models::Book] a model representation of the epub file
+  def self.get(path)
+    parser = EPUBMeta::Parser.parse(path)
+    EPUBMeta::Models::Book.new(parser)
+  end
+end

data/lib/epubmeta/models/book.rb

@@ -0,0 +1,120 @@
+module EPUBMeta
+  module Models
+    class Book
+      # Titles, array of String instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.1 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :titles
+      def titles; @titles || []; end
+
+      # Creators, array of Person instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.2 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :creators
+      def creators; @creators || []; end
+
+      # Subjects, array of String instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.3 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :subjects
+      def subjects; @subjects || []; end
+
+      # Description ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.4 EPUB2 reference})
+      # @return [String]
+      attr_accessor :description
+
+      # Publisher ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.5 EPUB2 reference})
+      # @return [String]
+      attr_accessor :publisher
+
+      # Contributors, array of Person instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :contributors
+      def contributors; @contributors || []; end
+
+      # Dates, array of Date instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.7 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :dates
+      def dates; @dates || []; end
+
+      # Identifiers, array of Identifier instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.10 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :identifiers
+      def identifiers; @identifiers || []; end
+
+      # Source ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.11 EPUB2 reference})
+      # @return [String]
+      attr_accessor :source
+
+      # Languages, array of String instances ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.12 EPUB2 reference})
+      # @return [Array]
+      attr_accessor :languages
+      def languages; @languages || []; end
+
+      # Rights ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.15 EPUB2 reference})
+      # @return [String]
+      attr_accessor :rights
+
+      # DRM protected
+      # @return [Boolean]
+      attr_accessor :drm_protected
+      def drm_protected; @drm_protected || false; end
+      alias :drm_protected? :drm_protected
+
+      # Cover
+      # @return [Cover]
+      attr_accessor :cover
+
+      # EPUB Version ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section1.4.1.2})
+      # @return [String]
+      attr_accessor :version
+
+      # Should never be called directly, go through EPUBMeta.get
+      def initialize(parser)
+        document = parser.metadata_document
+        return if document.nil?
+        document.remove_namespaces!
+        metadata = document.css('metadata')
+        self.version = document.css('package')[0]['version']
+        self.titles = metadata.xpath('.//title').map(&:content)
+        self.creators = metadata.xpath('.//creator').map {|c| EPUBMeta::Models::Person.new(c) }
+        self.subjects = metadata.xpath('.//subject').map(&:content)
+        self.description = metadata.xpath('.//description').first.content rescue nil
+        self.publisher = metadata.xpath('.//publisher').first.content rescue nil
+        self.contributors = metadata.xpath('.//contributor').map {|c| EPUBMeta::Models::Person.new(c) }
+        self.dates = metadata.xpath('.//date').map { |d| EPUBMeta::Models::Date.new(d) }
+        modified_date = metadata.xpath(".//meta[@property='dcterms:modified']").map do |d|
+          date = EPUBMeta::Models::Date.new(d)
+          date.event = 'modification'
+          date
+        end
+        self.dates += modified_date;
+        self.identifiers = metadata.xpath('.//identifier').map { |i| EPUBMeta::Models::Identifier.new(i) }
+        self.source = metadata.xpath('.//source').first.content rescue nil
+        self.languages = metadata.xpath('.//language').map(&:content)
+        self.rights = metadata.xpath('.//rights').first.content rescue nil
+        self.drm_protected = parser.drm_protected?
+        self.cover = EPUBMeta::Models::Cover.new(parser)
+      end
+
+
+      # Returns Hash representation of the book
+      # @return [Hash]
+      def to_hash
+        {
+          :titles => @titles,
+          :creators => @creators.map(&:to_hash),
+          :subjects => @subjects,
+          :description => @description,
+          :publisher => @publisher,
+          :contributors => @contributors.map(&:to_hash),
+          :dates => @dates.map(&:to_hash),
+          :identifiers => @identifiers.map(&:to_hash),
+          :source => @source,
+          :languages => @languages,
+          :rights => @rights,
+          :drm_protected => @drm_protected,
+          :cover => @cover,
+        }
+      end
+    end
+  end
+end
+

data/lib/epubmeta/models/cover.rb

@@ -0,0 +1,101 @@
+module EPUBMeta
+  module Models
+    class Cover
+      def self.new(parser)
+        return nil unless EPUBMeta::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
+
+      # 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
+      # and closed after the block is executed
+      #   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('epubmeta')
+        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[properties = \"#{cover_id}\"]").first rescue nil) ||
+            (manifest.css("item[property = \"#{cover_id}\"]").first rescue nil) ||
+            (manifest.css("item[id = img-bookcover-jpeg]").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/epubmeta/models/date.rb

@@ -0,0 +1,34 @@
+require 'time'
+
+module EPUBMeta
+  module Models
+    class Date
+      # Date ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.7 EPUB2 reference})
+      # @return Date
+      attr_accessor :date
+      # Date as a string ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.7 EPUB2 reference})
+      # @return String
+      attr_accessor :date_str
+      # Event ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.7 EPUB2 reference})
+      # @return String
+      attr_accessor :event
+
+      # Should never be called directly, go through EPUBMeta.get
+      def initialize(node)
+        self.date = Utils.parse_iso_8601_date(node.content) rescue nil
+        self.date_str = node.content
+        self.event = node.attribute('event').content rescue nil
+      end
+
+      # Returns Hash representation of a date
+      # @return [Hash]
+      def to_hash
+        {
+          :time => @time,
+          :event => @event
+        }
+      end
+    end
+  end
+end
+

data/lib/epubmeta/models/identifier.rb

@@ -0,0 +1,28 @@
+module EPUBMeta
+  module Models
+    class Identifier
+      # Identifier ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.1 EPUB2 reference})
+      # @return [String]
+      attr_accessor :identifier
+      # Scheme ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.1 EPUB2 reference})
+      # @return [String]
+      attr_accessor :scheme
+
+      # Should never be called directly, go through EPUBMeta.get
+      def initialize(node)
+        self.identifier = node.content
+        self.scheme = node.attribute('scheme').content rescue nil
+      end
+
+      # Returns Hash representation of an identifier
+      # @return [Hash]
+      def to_hash
+        {
+          :identifier => @identifier,
+          :scheme => @scheme
+        }
+      end
+    end
+  end
+end
+

data/lib/epubmeta/models/person.rb

@@ -0,0 +1,33 @@
+module EPUBMeta
+  module Models
+    class Person
+      # Name ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6 EPUB2 reference})
+      # @return [String]
+      attr_accessor :name
+      # File as ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6 EPUB2 reference})
+      # @return [String]
+      attr_accessor :file_as
+      # Role ({http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6 EPUB2 reference})
+      # @return [String]
+      attr_accessor :role
+
+      # Should never be called directly, go through EPUBMeta.get
+      def initialize(node)
+        self.name = node.content
+        self.file_as = node.attribute('file-as').content rescue nil
+        self.role = node.attribute('role').content rescue nil
+      end
+
+      # Returns Hash representation of a person
+      # @return [Hash]
+      def to_hash
+        {
+          :name => @name,
+          :file_as => @file_as,
+          :role => @role
+        }
+      end
+    end
+  end
+end
+

data/lib/epubmeta/parser.rb

@@ -0,0 +1,48 @@
+module EPUBMeta
+  class Parser
+    attr_accessor :path, :metadata_document
+
+    def self.parse(path)
+      epubmeta = EPUBMeta::Parser.new
+      epubmeta.path = path
+      epubmeta
+    end
+
+    def metadata_document
+      @metadata_document ||= load_metadata_file
+    end
+
+    def drm_protected?
+      @drm_protected ||= !!zip_file.find_entry('META-INF/rights.xml')
+    end
+
+    def zip_file
+      begin
+        @zip_file ||= Zip::File.open(@path)
+      rescue Zip::Error => e
+        raise NotAnEPUBFileError.new(e)
+      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'))
+      rescue => e
+        raise NotAnEPUBFileError.new(e)
+      end
+    end
+
+    def load_metadata_file
+      Nokogiri::XML(zip_file.read(metadata_path))
+    end
+  end
+end

data/lib/epubmeta/utils.rb

@@ -0,0 +1,17 @@
+module EPUBMeta
+  module Utils
+    def self.parse_iso_8601_date(date_str)
+      case date_str.count('-')
+      when 0
+        Date.strptime(date_str, '%Y')
+      when 1
+        Date.strptime(date_str, '%Y-%m')
+      when 2
+        Date.strptime(date_str, '%Y-%m-%d')
+      end
+    end
+  end
+
+  class NotAnEPUBFileError < StandardError; end
+end
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: epubmeta
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Andrew Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Supports EPUB2 and EPUB3 formats.
+email: andy.roberts.uk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/epubmeta.rb
+- lib/epubmeta/models/book.rb
+- lib/epubmeta/models/cover.rb
+- lib/epubmeta/models/date.rb
+- lib/epubmeta/models/identifier.rb
+- lib/epubmeta/models/person.rb
+- lib/epubmeta/parser.rb
+- lib/epubmeta/utils.rb
+homepage: https://github.com/andyroberts/epubmeta
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Extracts metadata information from EPUB files
+test_files: []