localshelf 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7aef35c4ce45d54162ad3c1d4f067f73264e5099
+  data.tar.gz: 74512b56476e859dffaa8630094b7dac1e5dce88
+SHA512:
+  metadata.gz: d9449e94cdcdf840211da8f6b4ecfd292c6260b91439888238601e5febdc272f0d71d52eb7d13707a4f5ab922be9f69aac0a13002a8b0cf18e0ec1702681e33a
+  data.tar.gz: 30f3f7113f177f18b49aca432a2063fdc4b8314b5903851d363239a156d9d02a75fbeb6103e0c9f276df5ef566b1823381b1051e5824dc481de7b98f6fc94cdd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Weera Wu
+
+MIT License
+
+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,39 @@
+# Localshelf
+
+Ebook shelf for a group.
+
+Localshelf allows users to manage and share their ebooks within a local network
+through its web interface.
+
+Only EPUB format is supported currently.
+
+## Installation
+
+Execute this line to install:
+
+    $ gem install localshelf
+
+## Usage
+
+Create a bookshelf:
+
+    $ localshelf init
+    $ localshelf create OfficeShelf
+
+Import ebooks to your bookshelf:
+
+    $ localshelf import path/to/folder/
+
+Share your bookshelf with others:
+
+    $ localshelf server
+
+Then check out http://<your-ip-address>:4567/ to see your collection.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/localshelf/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test
+

data/bin/localshelf

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { exit 1 }
+
+require 'localshelf'
+require 'localshelf/cli'
+Localshelf::CLI.start(ARGV, :debug => true)

data/lib/localshelf/book.rb

@@ -0,0 +1,17 @@
+module Localshelf
+  class Book < ActiveRecord::Base
+    belongs_to :bookshelf
+    has_many :formats
+    validates :title, :identifier, presence: true
+
+    def target_location
+      File.join(bookshelf.location, identifier)
+    end
+
+    def construct!
+      return false unless persisted? && valid?
+      FileUtils.mkdir_p(target_location)
+      formats.to_a.count(&:construct!)
+    end
+  end
+end

data/lib/localshelf/bookshelf.rb

@@ -0,0 +1,16 @@
+module Localshelf
+  class Bookshelf < ActiveRecord::Base
+    has_many :books
+    validates :name, :location, presence: true, uniqueness: true
+
+    def target_location
+      location
+    end
+
+    def construct!
+      return false unless persisted? && valid?
+      FileUtils.mkdir_p(target_location)
+      books.to_a.count(&:construct!)
+    end
+  end
+end

data/lib/localshelf/cli.rb

@@ -0,0 +1,136 @@
+require 'thor'
+require 'rack'
+require 'socket'
+require 'active_record'
+require 'sqlite3'
+require 'localshelf/bookshelf'
+require 'localshelf/book'
+require 'localshelf/format'
+
+module Localshelf
+  class CLI < Thor
+    include Thor::Actions
+
+    LOCALSHELF_HOME = File.expand_path("~/Localshelf")
+    IP_ADDRESS      = Socket.ip_address_list.detect(&:ipv4_private?).ip_address
+
+    desc "load_config", "Load Localshelf configs"
+    def load_config
+      abort(" ! Localshelf has not been initialized yet.") unless initialized?
+
+      I18n.enforce_available_locales = false
+
+      ActiveRecord::Base.establish_connection(
+        adapter:  "sqlite3",
+        database: File.join(LOCALSHELF_HOME, "Localshelf.sqlite3")
+      )
+    end
+
+    desc "init", "Initialize Localshelf application"
+    def init
+      abort(" ! Localshelf has already been initialized.") if initialized?
+
+      say("Initializing Localshelf at #{LOCALSHELF_HOME}")
+      FileUtils.mkdir_p(LOCALSHELF_HOME)
+
+      invoke :load_config, []
+
+      ActiveRecord::Schema.define do
+        create_table "bookshelves", force: true do |t|
+          t.string   "name"
+          t.string   "location"
+          t.datetime "created_at", null: false
+          t.datetime "updated_at", null: false
+        end
+
+        create_table "books", force: true do |t|
+          t.integer  "bookshelf_id"
+          t.string   "title"
+          t.string   "language"
+          t.string   "identifier"
+          t.string   "creator"
+          t.string   "cover_location"
+          t.datetime "created_at", null: false
+          t.datetime "updated_at", null: false
+        end
+        add_index "books", ["bookshelf_id"], name: "index_books_on_bookshelf_id"
+
+        create_table "formats", force: true do |t|
+          t.integer  "book_id"
+          t.string   "checksum"
+          t.string   "location"
+          t.string   "original_location"
+          t.integer  "size"
+          t.string   "type"
+          t.datetime "created_at", null: false
+          t.datetime "updated_at", null: false
+        end
+        add_index "formats", ["book_id"], name: "index_formats_on_book_id"
+        add_index "formats", ["checksum"], name: "index_formats_on_checksum", unique: true
+      end
+    end
+
+    desc "create [NAME]", "Create a new bookshelf"
+    def create(name="Default")
+      invoke(:load_config, [])
+
+      location = File.join(LOCALSHELF_HOME, name)
+      say("Creating #{name} bookshelf at #{location}")
+
+      bookshelf = Bookshelf.new(name: name, location: location)
+      unless bookshelf.save
+        abort(" ! Cannot create Bookshelf: #{bookshelf.errors.full_messages}")
+      end
+      bookshelf.construct!
+    end
+
+    # TODO Add support for wildcard argument
+    desc "import FILES", "Import books to Localshelf"
+    def import(files)
+      invoke :load_config, []
+
+      files        = File.expand_path(files)
+      book_files   = files unless File.directory?(files)
+      book_files ||= File.join(files, "*.{epub,EPUB}")  # TODO
+      bookshelf    = Bookshelf.first  # TODO
+
+      Dir[book_files].each do |file|
+        filename = File.basename(file)
+
+        if Format.exists?(original_location: file)
+          say("Skipping #{filename}")
+          next
+        else
+          say("Importing #{filename} to #{bookshelf.name}")
+          format = Epub.new(original_location: file) # TODO
+          unless format.save
+            abort(" ! Cannot create Format: #{format.errors.full_messages}")
+          end
+
+          metadata = format.extract_metadata
+          book     = bookshelf.books.find_by(identifier: metadata[:identifier])
+          book   ||= bookshelf.books.build(metadata)
+          book.formats << format
+
+          unless book.save
+            abort(" ! Cannot create Book: #{book.errors.full_messages}")
+          end
+          book.construct!
+        end
+      end
+    end
+
+    desc "server", "Share your bookshelf on http://#{IP_ADDRESS}:8080"
+    def server
+      app = Rack::Directory.new(LOCALSHELF_HOME)
+      Rack::Handler::WEBrick.run(app)
+    end
+
+    private
+
+      def initialized?
+        Dir.exists?(LOCALSHELF_HOME)
+      end
+
+  end
+end

data/lib/localshelf/format.rb

@@ -0,0 +1,77 @@
+require 'epubinfo'
+
+module Localshelf
+  class Format < ActiveRecord::Base
+    belongs_to :book
+    validates :original_location, presence: true
+    validate :original_location_exists
+    before_create :set_metadata
+
+    def target_location
+      target_extname  = File.extname(original_location).downcase
+      target_filename = [checksum, target_extname].join
+      File.join(book.bookshelf.location, book.identifier, target_filename)
+    end
+
+    def construct!
+      return false unless persisted? && valid?
+      return false if File.exists?(target_location)
+      FileUtils.cp(original_location, target_location)
+      update(location: target_location)
+    end
+
+    private
+
+      def original_location_exists
+        unless File.exists?(original_location)
+          errors.add(:original_location, "doesn't exist")
+        end
+      end
+
+      def set_metadata
+        self.checksum ||= "%x" % ( Integer( `cksum '#{original_location}'`[/^\d+/] ) & 0xffffffff )
+        self.size     ||= File.size(original_location)
+      end
+  end
+
+  class Epub < Format
+    validates :original_location, format: { with: /epub\z/i }
+
+    def extract_metadata
+      {
+        title:      parser.titles.first,
+        language:   parser.languages.first,
+        identifier: parser.identifiers.first.identifier.gsub(/\D+/, ""),
+        creator:    parser.creators.map(&:name).join(", ")
+      }
+    end
+
+    def construct!
+      super
+
+      # TODO
+      return unless parser.cover
+      target_extname  = File.extname(parser.cover.original_file_name).downcase
+      target_location = File.join(
+                          book.bookshelf.location,
+                          book.identifier,
+                          ["cover", target_extname].join
+                        )
+      unless File.exists?(target_location)
+        parser.cover.tempfile { |f| FileUtils.cp(f.path, target_location) }
+        book.update(cover_location: target_location)
+      end
+    end
+
+    private
+
+      def parser
+        return @_parser if @_parser
+        raise "No location" unless original_location?
+        EPUBInfo.get(original_location)
+      end
+  end
+
+  class Pdf < Format
+  end
+end

data/lib/localshelf/version.rb

@@ -0,0 +1,3 @@
+module Localshelf
+  VERSION = "0.0.1.pre"
+end

data/lib/localshelf.rb

@@ -0,0 +1,5 @@
+require "localshelf/version"
+
+module Localshelf
+  # Your code goes here...
+end

data/localshelf.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'localshelf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "localshelf"
+  spec.version       = Localshelf::VERSION
+  spec.authors       = ["Weera Wu"]
+  spec.email         = ["weera@oozou.com"]
+  spec.summary       = %q{Ebook shelf for a group}
+  spec.description   = %q{Localshelf allows users to manage and share their ebooks within a local network through its web interface.}
+  spec.homepage      = "https://github.com/wulab/localshelf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "rack"
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "sqlite3"
+  spec.add_runtime_dependency "epubinfo"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'localshelf'
+
+require 'minitest/autorun'

data/test/test_localshelf.rb

@@ -0,0 +1,11 @@
+require 'minitest_helper'
+
+class TestLocalshelf < MiniTest::Unit::TestCase
+  def test_that_it_has_a_version_number
+    refute_nil ::Localshelf::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: localshelf
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Weera Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: rack
+  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: activerecord
+  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: sqlite3
+  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: epubinfo
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: Localshelf allows users to manage and share their ebooks within a local
+  network through its web interface.
+email:
+- weera@oozou.com
+executables:
+- localshelf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/localshelf
+- lib/localshelf.rb
+- lib/localshelf/book.rb
+- lib/localshelf/bookshelf.rb
+- lib/localshelf/cli.rb
+- lib/localshelf/format.rb
+- lib/localshelf/version.rb
+- localshelf.gemspec
+- test/minitest_helper.rb
+- test/test_localshelf.rb
+homepage: https://github.com/wulab/localshelf
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ebook shelf for a group
+test_files:
+- test/minitest_helper.rb
+- test/test_localshelf.rb