hawx-alexandria 0.1.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2013 Joshua Hawxwell
+
+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,35 @@
+# Alexandria
+
+Alexandria is a command-line ebook manager.
+
+## Installing
+
+
+## Adding a book
+
+When a book is added to alexandria it is automatically converted to each
+supported format (at the moment `.epub` and `.mobi`). This is done with the
+`ebook-convert` tool provided by [Calibre][]. You will need to install
+[Calibre][] then set the environment variable `EBOOK_CONVERT` to be the path to
+the `ebook-convert` file.
+
+You can the add books like,
+
+``` bash
+$ alexandria add /path/to/book.epub
+...
+$ alexandria add /path/to/another-book.mobi
+...
+```
+
+
+## Listing books
+
+You can list all books with
+
+``` bash
+$ alexandria list
+```
+
+
+[Calibre]: http://calibre-ebook.com

data/bin/alexandria

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+
+require 'clive'
+require 'pp'
+require 'data_mapper'
+require 'highline/import'
+
+LIB_ROOT = File.expand_path(ENV['ALEXANDRIA_LIBRARY'] || '~/alexandria')
+
+FileUtils.mkdir_p LIB_ROOT
+DataMapper.setup(:default, "sqlite://#{LIB_ROOT}/library.db")
+
+require_relative '../lib/alexandria'
+
+class Alexandria::CLI < Clive
+
+  desc 'Adds a book to library, converting it to all formats'
+  command :add, arg: '<path>...' do
+    bool :quiet, default: true
+    bool :force, default: false
+
+    action do
+      options = {
+        quiet: get(:quiet),
+        force: get(:force)
+      }
+
+      path.each {|book_path|
+        ::Alexandria::Library.add book_path, options
+      }
+    end
+  end
+
+  desc 'Lists all books in the library'
+  command :list do
+    desc 'Show only for author'
+    opt :author, args: '<name>'
+
+    desc 'Show only with title'
+    opt :title, args: '<name>'
+
+    desc 'List by author'
+    bool :by_author
+
+    desc 'Show full output'
+    bool :v, :verbose
+
+    action do
+      criteria = {
+        title: get(:title),
+        author: {
+          name: get(:author)
+        }
+      }
+
+      if get(:by_author)
+        ::Alexandria::Library.authors(criteria[:author]).each do |author|
+          puts author.name.bold
+
+          author.books.each do |book|
+            puts "  #{book.title}"
+            puts "    #{book.path}\n".grey if get(:verbose)
+          end
+        end
+
+      else
+        ::Alexandria::Library.books(criteria).each do |book|
+          puts "#{book.title.bold} by #{book.author.name}"
+          puts "  #{book.path}\n".grey if get(:verbose)
+        end
+      end
+    end
+  end
+
+  desc 'Syncs books from a connected device to the library'
+  command :sync do
+    bool :dry_run
+
+    action do
+      device = ::Alexandria::Device.find
+
+      unless device
+        puts "Nothing to sync.".red
+        exit
+      end
+
+      device.each_book do |book|
+        unless Book.any?(author: book.author, title: book.title)
+          if get(:dry_run)
+            puts "Missing: #{book.title} by #{book.author}"
+          else
+            ::Alexandria::Library.add(book)
+          end
+        end
+      end
+    end
+  end
+end
+
+Alexandria::CLI.run

data/lib/alexandria/book.rb

@@ -0,0 +1,26 @@
+module Alexandria
+  module Book
+    @@registered = {}
+
+    def self.register(extensions, klass)
+      extensions.each do |extension|
+        @@registered[extension] = klass
+      end
+    end
+
+    def self.create(path)
+      ext = File.extname(path)
+
+      unless @@registered.has_key?(ext)
+        warn "Unrecognised extension #{ext}"
+        exit 2
+      end
+
+      @@registered[ext].new(path)
+    end
+
+    def self.extensions
+      @@registered.values.map(&:extension)
+    end
+  end
+end

data/lib/alexandria/books/base.rb

@@ -0,0 +1,40 @@
+require 'fileutils'
+
+module Alexandria::Book
+
+  # @abstract Implement {#author}, {#title} and {.extension}.
+  class Base
+    EXTENSIONS = []
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path.to_s
+    end
+
+    def author
+      "None"
+    end
+
+    def title
+      "Untitled"
+    end
+
+    def self.extension
+      ".missing"
+    end
+
+    def write(dir)
+      name = File.basename(dir)
+      write_path = File.join(dir, "#{name}#{self.class.extension}")
+
+      FileUtils.mkdir_p dir
+      File.write(write_path, File.read(self.path))
+    end
+
+    def inspect
+      "#<#{self.class} '#{self.title}'>"
+    end
+    alias_method :to_s, :inspect
+  end
+end

data/lib/alexandria/books/epub.rb

@@ -0,0 +1,35 @@
+require 'peregrin'
+
+class Peregrin::Property
+  def to_h
+    {key => value}
+  end
+end
+
+module Alexandria::Book
+
+  class Epub < Base
+    def author
+      metadata['creator'] || super
+    end
+
+    def title
+      metadata['title'].force_encoding("utf-8") || super
+    end
+
+    def self.extension
+      ".epub"
+    end
+
+    private
+
+    def metadata
+      @meta ||= Peregrin::Epub.read(@path)
+        .to_book
+        .properties
+        .inject({}) {|a,e| a.merge(e.to_h) }
+    end
+  end
+
+  register %w(.epub), Epub
+end

data/lib/alexandria/books/mobi.rb

@@ -0,0 +1,26 @@
+require 'mobi'
+
+module Alexandria::Book
+
+  class Mobi < Base
+    def author
+      metadata.author || super
+    end
+
+    def title
+      metadata.title.force_encoding("utf-8") || super
+    end
+
+    def self.extension
+      ".mobi"
+    end
+
+    private
+
+    def metadata
+      ::Mobi.metadata File.open(@path)
+    end
+  end
+
+  register %w(.mobi .azw .azw3), Mobi
+end

data/lib/alexandria/converter.rb

@@ -0,0 +1,51 @@
+module Alexandria
+
+  class Converter
+
+    def initialize(original_path, options={})
+      @original_path = original_path
+      @book = Book.create(@original_path)
+    end
+
+    def dir
+      File.dirname(@original_path)
+    end
+
+    def normalised_title
+      Helpers.normalise(@book.title)
+    end
+
+    def new_path(ext)
+      File.join(dir, normalised_title + ext)
+    end
+
+    def converted_to?(ext)
+      File.exist? new_path(ext)
+    end
+
+    def convert_to(new_ext)
+      new_path = new_path(new_ext)
+
+      if converted_to?(new_ext)
+        return unless agree("File already exists '#{new_path}', convert again? [y/n]".red)
+      end
+
+      if execute(@original_path, new_path, @options[:quiet])
+        puts "  created".grey + " #{new_path}"
+      else
+        puts "  problem".red + " converting #{@original_path} to #{new_ext}"
+      end
+    end
+
+    private
+
+    def execute(from, to, quiet=true)
+      if quiet
+        `#{EBOOK_CONVERT} \"#{from}\" \"#{to}\"`
+      else
+        system "#{EBOOK_CONVERT} \"#{from}\" \"#{to}\""
+      end
+    end
+
+  end
+end

data/lib/alexandria/core_ext.rb

@@ -0,0 +1,15 @@
+class Hash
+  def compact
+    self.map {|k,v|
+      v.respond_to?(:compact) ? [k, v.compact] : [k,v]
+    }.reject {|k,v|
+      v.nil? || v.empty?
+    }.to_h
+  end
+end
+
+class Object
+  def to_h
+    Hash[self]
+  end
+end

data/lib/alexandria/device.rb

@@ -0,0 +1,14 @@
+module Alexandria
+
+  class Device
+    @@registered = {}
+
+    def self.register(name, klass)
+      @@registered[name] = klass
+    end
+
+    def self.find
+      @@registered.map(&:find).compact.first
+    end
+  end
+end

data/lib/alexandria/devices/kindle.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+
+class Alexandria::Device
+
+  class Kindle
+    def self.find
+      return false unless Dir.exist?('/Volumes/Kindle')
+      new '/Volumes/Kindle'
+    end
+
+    def initialize(path)
+      @path = Pathname.new(path)
+    end
+
+    def each_book
+      Dir[@path + 'documents' + '**/*.{azw,azw3,mobi}'].each {|path|
+        yield Book.create(File.expand_path(path))
+      }
+    end
+  end
+
+  register :kindle, Kindle
+end

data/lib/alexandria/helpers.rb

@@ -0,0 +1,18 @@
+module Alexandria
+
+  module Helpers
+    extend self
+
+    def normalise(title)
+      title.gsub(' ', '_').gsub(/\W/, '').gsub('_', '-').downcase
+    end
+
+    def book_path(author, title)
+      normal_author = normalise(author)
+      normal_title = normalise(title)
+      path = File.join(normal_author, normal_title)
+
+      File.join LIB_ROOT, path
+    end
+  end
+end

data/lib/alexandria/library.rb

@@ -0,0 +1,30 @@
+module Alexandria
+  module Library
+    extend self
+
+    # Adds a book to the current library, then converts it to all possible formats.
+    #
+    # @param path [String] Path to the book to add.
+    def add(path, options={})
+      book = Storage::Book.from_path(File.expand_path(path), options)
+
+      instance = Dir.glob(book.path + '/*').first
+
+      extensions_missing = Book.extensions - [File.extname(instance)]
+
+      converter = Converter.new(instance, options)
+
+      extensions_missing.each do |extension|
+        converter.convert_to(extension)
+      end
+    end
+
+    def books(criteria={})
+      Storage::Book.all criteria.compact.merge(:order => [:title.asc])
+    end
+
+    def authors(criteria={})
+      Storage::Author.all criteria.compact.merge(:order => [:name.asc])
+    end
+  end
+end

data/lib/alexandria/storage.rb

@@ -0,0 +1,60 @@
+module Alexandria
+
+  module Storage
+
+    class Book
+      include ::DataMapper::Resource
+
+      property :id,    Serial
+      property :title, String
+      property :path,  String
+
+      belongs_to :author
+
+      def self.from_path(path, options={})
+        book = ::Alexandria::Book.create(path)
+
+        path = ::Alexandria::Helpers.book_path(book.author, book.title)
+
+        if found = Book.first(:path => path)
+          puts "Book already exists!".red
+          return found unless options[:force]
+        end
+
+        book.write(path)
+
+        author = Author.first_or_create(:name => book.author)
+        created = Book.first_or_create(:title => book.title, :author => author, :path => path)
+        created.save!
+
+        puts "  created".grey + " #{path}"
+
+        created
+      end
+
+      def epub_path
+        File.join path, File.basename(path) + '.epub'
+      end
+
+      def mobi_path
+        File.join path, File.basename(path) + '.mobi'
+      end
+    end
+
+    class Author
+      include ::DataMapper::Resource
+
+      property :id,   Serial
+      property :name, String
+
+      has n, :books
+
+      def books
+        Book.all(:author => self, :order => [:title.asc])
+      end
+    end
+
+    ::DataMapper.finalize
+    ::DataMapper.auto_upgrade!
+  end
+end

data/lib/alexandria.rb

@@ -0,0 +1,23 @@
+# coding: UTF-8
+
+require 'pathname'
+require 'clive/output'
+
+EBOOK_CONVERT = ENV['EBOOK_CONVERT'] ||
+                '/Applications/calibre.app/Contents/MacOS/ebook-convert'
+# Fall back to default mac location. I know, mac.
+
+require_relative 'alexandria/core_ext'
+require_relative 'alexandria/helpers'
+
+require_relative 'alexandria/book'
+require_relative 'alexandria/books/base'
+require_relative 'alexandria/books/epub'
+require_relative 'alexandria/books/mobi'
+
+require_relative 'alexandria/device'
+require_relative 'alexandria/devices/kindle'
+
+require_relative 'alexandria/converter'
+require_relative 'alexandria/library'
+require_relative 'alexandria/storage'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: hawx-alexandria
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Hawxwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: peregrin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mobi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: clive
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dm-sqlite-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: ! '    An ebook library manager, with one-way kindle syncing.
+
+'
+email: m@hawx.me
+executables:
+- alexandria
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- bin/alexandria
+- lib/alexandria/book.rb
+- lib/alexandria/books/base.rb
+- lib/alexandria/books/epub.rb
+- lib/alexandria/books/mobi.rb
+- lib/alexandria/converter.rb
+- lib/alexandria/core_ext.rb
+- lib/alexandria/device.rb
+- lib/alexandria/devices/kindle.rb
+- lib/alexandria/helpers.rb
+- lib/alexandria/library.rb
+- lib/alexandria/storage.rb
+- lib/alexandria.rb
+homepage: http://github.com/hawx/alexandria
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A library for your ebooks.
+test_files: []
+has_rdoc: