ebook_library 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 846024e35f3f3460e2e072b4baf1bd272f5a9091
+  data.tar.gz: a52d936666c0c3f926f506b394a531f69d58f534
+SHA512:
+  metadata.gz: 68afad92c71bfb5a7acd49935accab6c6285b53d5e16fe33e5b66831cff91e338e564313d8a2e7a2a643fab39a875843c87f866eac305c6f370fd6ce99f5ca1c
+  data.tar.gz: be32071a4b316c076d4ebe01429095df539fb0379c4ab3d70cc49589eefc22b5bc754534452f759c11c0818ba4a2afb4f2cbe689c2aecf0bef2c496a901555d4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ebook_library.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# EbookLibrary
+
+generate an organized library from a local ebook directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ebook_library'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebook_library
+
+## Usage
+
+in a rake task you might want to run
+
+```
+EbookLibrary::Gatherer.gather
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake false` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/ebook_library. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of
+conduct.
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'ebook_library'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --colour)
+end
+
+task :default => 'spec'
+
+# example rake task
+task :generate => :environment do
+  require 'json'
+  ebooks = EbookLibrary.dump
+  File.open("./books.json", 'w') { |file| file.write(ebooks) }
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ebook_library"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ebook_library.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ebook_library/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ebook_library"
+  spec.version       = EbookLibrary::VERSION
+  spec.authors       = ["tippenein"]
+  spec.email         = ["brady.ouren@gmail.com"]
+
+  spec.summary       = "generate an organized library from a local ebook directory."
+
+  spec.description   = "generate an organized library from a local ebook directory."
+  spec.homepage      = "https://github.com/tippenein/ebook_library"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "mobi"
+  spec.add_dependency "epub-parser"
+  spec.add_dependency "pdf-reader"
+  spec.add_dependency "monadic"
+end

data/lib/ebook_library.rb

@@ -0,0 +1,21 @@
+require "ebook_library/version"
+require "ebook_library/gatherer"
+require "ebook_library/ebook"
+require "ebook_library/ebook_factory"
+require "ebook_library/factory/epub"
+require "ebook_library/factory/mobi"
+require "ebook_library/factory/pdf"
+
+module EbookLibrary
+  def self.default_path
+    File.join ENV["HOME"], "Documents/ebooks"
+  end
+
+  #TODO allow different outputs
+  def self.dump(type=:json)
+    require 'json' if type.to_sym == :json
+    Gatherer.new.gather.to_json
+  end
+
+  class InvalidPath < StandardError; end
+end

data/lib/ebook_library/ebook.rb

@@ -0,0 +1,70 @@
+require 'epub/parser'
+require 'pdf-reader'
+require 'mobi'
+
+module EbookLibrary
+  class Ebook
+    attr_reader :raw_ebook, :path, :adapter
+    def initialize(ebook_path)
+      @path = ebook_path
+      @raw_ebook = File.open ebook_path
+      @adapter = get_adapter
+    end
+
+    def title
+      has_metadata? ? adapter.title : "unknown"
+    end
+
+    def author
+      has_metadata? ? adapter.author : "unknown"
+    end
+
+    def format
+      @format ||= File.extname(path).gsub(/^./, "")
+    end
+
+    def to_hash
+      Hash[attrs.map{|attr| [attr, send(attr)]}] if valid?
+    end
+
+    def has_metadata?
+      !metadata.nil?
+    end
+
+    def valid?
+      EbookFactory.supported_types.include?(format)
+    end
+
+    private
+
+    def get_adapter
+      EbookFactory.new(format, metadata)
+    end
+
+    def attrs
+      [:title, :author, :format, :path]
+    end
+
+    def metadata
+      %i(parse_mobi parse_epub parse_pdf).inject(nil) do |parsed, parser|
+        begin
+          parsed || send(parser)
+        rescue
+          nil
+        end
+      end
+    end
+
+    def parse_epub
+      ::EPUB::Parser.parse(path).metadata
+    end
+
+    def parse_mobi
+      ::Mobi.metadata raw_ebook
+    end
+
+    def parse_pdf
+      ::PDF::Reader.new(raw_book).metadata
+    end
+  end
+end

data/lib/ebook_library/ebook_factory.rb

@@ -0,0 +1,41 @@
+require 'monadic'
+module EbookLibrary
+  class EbookFactory
+    attr_reader :adapter
+    def initialize(format, metadata)
+      raise UnsupportedFormatError unless %w(epub mobi pdf).include? format
+      @adapter = for_type(format).new(metadata)
+    end
+
+    def self.supported_types
+      %w(epub mobi pdf)
+    end
+
+    def title
+      Maybe(adapter).title._("untitled").encode('UTF-8', encode_options)
+    end
+
+    def author
+      Maybe(adapter).author._("").encode('UTF-8', encode_options)
+    end
+
+    private
+    #TODO move these to config
+    def encode_options
+      {invalid: :replace, undef: :replace, replace: '?'}
+    end
+
+    def for_type(format)
+      case format
+      when 'epub'
+        Factory::Epub
+      when 'mobi', 'azw'
+        Factory::Mobi
+      when 'pdf'
+        Factory::Pdf
+      end
+    end
+  end
+
+  class UnsupportedFormatError < StandardError; end
+end

data/lib/ebook_library/factory/epub.rb

@@ -0,0 +1,19 @@
+module EbookLibrary
+  module Factory
+    class Epub
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def author
+        metadata.creators.map(&:content).join(" ")
+      end
+
+      def title
+        metadata.title || metadata.titles
+      end
+    end
+  end
+end
+

data/lib/ebook_library/factory/mobi.rb

@@ -0,0 +1,18 @@
+module EbookLibrary
+  module Factory
+    class Mobi
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def author
+        metadata.author
+      end
+
+      def title
+        metadata.title
+      end
+    end
+  end
+end

data/lib/ebook_library/factory/pdf.rb

@@ -0,0 +1,19 @@
+module EbookLibrary
+  module Factory
+    class Pdf
+      attr_reader :metadata
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      def author
+        nil
+      end
+
+      def title
+        nil
+      end
+    end
+  end
+end
+

data/lib/ebook_library/gatherer.rb

@@ -0,0 +1,37 @@
+# this could possibly use the ebook-meta tool
+#   http://manual.calibre-ebook.com/cli/ebook-meta.html
+#
+# reference:
+#   http://wiki.mobileread.com/wiki/MOBI
+
+module EbookLibrary
+  class Gatherer
+    attr_accessor :path
+
+    def initialize(path=EbookLibrary.default_path)
+      @path = path if File.exist?(path)
+      raise InvalidPath if @path.nil?
+    end
+
+    def gather
+      results = gather_ebooks.map do |book_path|
+        begin
+          ebook = Ebook.new(book_path)
+          ebook.to_hash
+        rescue EbookLibrary::UnsupportedFormatError
+          puts "skipping: " + book_path
+        end
+      end
+      { books: results.compact }
+    end
+
+    private
+
+    # returns [FilePath]
+    def gather_ebooks
+      Dir.glob("#{path}/**/*").inject([]) do |paths, book_path|
+        paths << book_path
+      end
+    end
+  end
+end

data/lib/ebook_library/version.rb

@@ -0,0 +1,3 @@
+module EbookLibrary
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ebook_library
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- tippenein
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: mobi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: epub-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: monadic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: generate an organized library from a local ebook directory.
+email:
+- brady.ouren@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ebook_library.gemspec
+- lib/ebook_library.rb
+- lib/ebook_library/ebook.rb
+- lib/ebook_library/ebook_factory.rb
+- lib/ebook_library/factory/epub.rb
+- lib/ebook_library/factory/mobi.rb
+- lib/ebook_library/factory/pdf.rb
+- lib/ebook_library/gatherer.rb
+- lib/ebook_library/version.rb
+homepage: https://github.com/tippenein/ebook_library
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: generate an organized library from a local ebook directory.
+test_files: []