KindleCG 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d1d82944b95dbf3604090ecdb82aec451a30964
+  data.tar.gz: 31029f6e48a1b38bc5761284182d30da4d9852c8
+SHA512:
+  metadata.gz: 6b6b16eec0216586da49de7dc723956d85a83b73074c3af122d79b95eb7f8d606a1207f6f64abfdca240b9af071937098520375b4473a75ab95f8bd419943c10
+  data.tar.gz: 5baa89ab6bddcc950ef128395b64f4894b31fd6dce1916c54dfad6e06529824109dcbff9c092c02af32ff540c3512e911ba5c2dfe6d5390978f2da0b22428bbb

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+kindle_collections
+.ruby-gemset
+.rspec

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/KindleCG.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'KindleCG/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "KindleCG"
+  spec.version       = KindleCG::VERSION
+  spec.authors       = ["Antonio Lorusso"]
+  spec.email         = ["antonio.lorusso@gmail.com"]
+  spec.description   = %q{Mirror your ebooks directory tree into kindle collections}
+  spec.summary       = %q{kindlecg helps you manage your kindle collections using the filesystem directory tree}
+  spec.homepage      = "http://antoniolorusso.com/KindleCG"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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", "~> 0.18.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Antonio Lorusso
+
+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,24 @@
+# KindleCG
+## Directory Tree to Kindle Collections generator
+
+A command line ruby script that will generate collections in your kindle based on the directory structure of your ebooks.
+The library to understand the mobi format are a straight port/refactor of the python plugin for calibre.
+
+## Installation
+
+    $ gem install KindleCG
+
+## Usage
+
+After installing the gem you will have access to a command line tool kindlecg.
+Just run it and will generate collections based on the directory structure of your ebooks in your kindle device.
+
+*WARNING* The script is under development. It override your current collections!!!
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/kindlecg

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+Signal.trap("INT") { exit 1 }
+
+require 'KindleCG'
+require 'KindleCG/cli'
+
+KindleCG::CLI.start(ARGV)

data/lib/KindleCG/cli.rb

@@ -0,0 +1,25 @@
+require 'thor'
+require 'KindleCG'
+
+module KindleCG
+  class CLI < Thor
+    desc 'generate', 'generate and save the collections'
+    def generate
+      check
+
+      kindle = Generator.new
+      kindle.generate_collections
+      kindle.save
+    end
+
+    desc 'check', 'check if a kindle is attached to the computer'
+    def check
+      unless File.directory?(KindleCG.os_mountpoint)
+        raise Thor::Error, "Could not find any kindle attached to #{KindleCG.os_mountpoint}"
+        exit 1
+      else
+        say "Your kindle is attached to #{KindleCG.os_mountpoint}. Very good! :)", :green
+      end
+    end
+  end
+end

data/lib/KindleCG/collections.rb

@@ -0,0 +1,23 @@
+module KindleCG
+  class Collections
+    attr_reader :collections
+
+    def initialize
+      @collections = {}
+    end
+
+    def add(name, language = 'en-US')
+      collection_name = "#{name}@#{language}"
+      @collections[collection_name] = { items: [] } 
+      collection_name
+    end
+
+    def add_item_to_collection(collection_name, ebook)
+      @collections[collection_name][:items] << ebook.hash
+    end
+
+    def to_json
+      JSON.generate(@collections)
+    end
+  end
+end

data/lib/KindleCG/ebook/ebook.rb

@@ -0,0 +1,50 @@
+require 'KindleCG/ebook/sectionizer'
+require 'KindleCG/ebook/mobi'
+require 'KindleCG/ebook/pdf'
+require 'digest'
+require 'forwardable'
+
+module KindleCG
+  module Ebook
+
+    class EbookError < StandardError; end
+
+    class Ebook
+      extend Forwardable
+
+      def_delegators :@metadata, :title, :asin, :type
+
+      def initialize(file)
+        @file = file
+        @metadata = initialize_metadata(file)
+      end
+
+      def hash
+        if @metadata.type && @metadata.asin
+          "#%s^%s" % [@metadata.asin, @metadata.type]
+        else
+          folder = File.dirname(@file)
+          filename = File.basename(@file)
+          "*" + Digest::SHA1.hexdigest([KindleCG.device_mountpoint.to_path, folder.match(/(documents).*/)[0], filename].join("/"))
+        end
+      end
+
+      private
+
+      def initialize_metadata(file)
+        case get_extension(file)
+        when /(mobi|azw)/
+          Mobi.new(file)
+        when /(pdf)/
+          Pdf.new(file)
+        else
+          raise EbookError, "Can't handle this book type"
+        end
+      end
+
+      def get_extension(file)
+        @_extension ||= File.basename(file).downcase.split('.')[-1]
+      end
+    end
+  end
+end

data/lib/KindleCG/ebook/mobi.rb

@@ -0,0 +1,49 @@
+module KindleCG
+  module Ebook
+    class Mobi
+
+      attr_reader :title, :mobi_type, :text_encoding, :exth
+
+      def initialize(file)
+        sections = KindleCG::Ebook::Sectionizer.new(file, 'rb')
+        @header = sections.load_section(0)
+        @len_mobi = @header[20..-1].unpack('L>')[0] + 16
+      end 
+
+      def exth
+        len_exth, = @header[@len_mobi+4..-1].unpack('L>')
+        exth_records = @header[@len_mobi..@len_mobi+len_exth][12..-1]
+        _exth = {}
+        while exth_records.length > 8 do
+          rectype, reclen = exth_records.unpack('L>L>')
+          recdata = exth_records[8...reclen]
+          _exth[rectype] = recdata
+          exth_records = exth_records[reclen..-1]
+        end
+        _exth
+      end
+
+      def mobi_type
+        @header[24..-1].unpack('L>')
+      end
+
+      def title
+        mobi_raw = @header[0..@len_mobi]
+        titleoffset, titlelen = mobi_raw[84..-1].unpack('L>L>')
+        @header[titleoffset...titleoffset+titlelen]
+      end
+
+      def text_encoding
+        @header[28..-1].unpack('L>')
+      end
+
+      def type
+        exth[501]
+      end
+
+      def asin
+        exth[113]
+      end
+    end
+  end
+end

data/lib/KindleCG/ebook/pdf.rb

@@ -0,0 +1,21 @@
+module KindleCG
+  module Ebook
+    class Pdf
+      def initialize(file)
+        # TODO: not sure what to do with pdfs yet
+      end
+
+      def title
+        # TODO: implement if ever needed
+      end
+
+      def asin
+        # TODO: implement if ever needed
+      end
+
+      def type
+        # TODO: implement if ever needed
+      end
+    end
+  end
+end

data/lib/KindleCG/ebook/sectionizer.rb

@@ -0,0 +1,33 @@
+module KindleCG
+  module Ebook
+    class Sectionizer
+
+      attr_accessor :file, :header, :sections, :identity
+
+      def initialize(file, perm) 
+        @file = File.open(file, perm)
+        @header = @file.read(78)
+        @sections = split_sections(@header, @file)
+      end
+
+      def load_section(section)
+        before, after = @sections[section..section+2]
+        @file.seek(before)
+        @file.read(after - before)
+      end
+
+      def identity
+        @header[0x3C...0x3C+8]
+      end
+
+      private
+
+      def split_sections(header, file)
+        num_sections, = header[76..-1].unpack 'S!>'
+        raw_sections = file.read(num_sections*8)
+        sections_unpacked = raw_sections.unpack ("L>%d" % (num_sections*2))
+        sections_unpacked.values_at(*(0..sections_unpacked.size).step(2)).compact + [0xfffffff]
+      end
+    end
+  end
+end

data/lib/KindleCG/version.rb

@@ -0,0 +1,3 @@
+module KindleCG
+  VERSION = "0.0.1"
+end

data/lib/KindleCG.rb

@@ -0,0 +1,78 @@
+require 'KindleCG/version'
+require 'json'
+require 'KindleCG/collections'
+require 'KindleCG/ebook/ebook'
+
+module KindleCG
+
+  class << self
+    attr_writer :device_mountpoint, :os_mountpoint
+
+    def device_mountpoint
+      @device_mountpoint ||= Pathname.new '/mnt/us'
+    end
+
+    def os_mountpoint
+      @os_mountpoint ||= Pathname.new '/Volumes/Kindle'
+    end
+
+    def system_path
+      device_mountpoint.join('system').to_path
+    end
+
+    def documents_path
+      device_mountpoint.join('documents').to_path
+    end
+
+    def os_documents_path
+      os_mountpoint.join('documents').to_path
+    end
+
+    def os_collections_path
+      os_mountpoint.join('system/collections.json').to_path
+    end
+  end
+  
+  class Generator
+    def initialize
+      @collections = Collections.new
+    end
+
+    def generate_collections
+      generate_tree(KindleCG.os_documents_path)
+      @collections
+    end
+
+    def generate_tree(path, current_collection = nil)
+      Dir.foreach(path) do |item|
+        next if item[0] == '.'
+
+        fullpath = [path, item].join("/")
+
+        if File.directory?(fullpath)
+          new_collection = @collections.add(relative_path(fullpath))
+          generate_tree(fullpath, new_collection)
+        else
+          begin
+            ebook = Ebook::Ebook.new(fullpath)
+            @collections.add_item_to_collection(current_collection, ebook) unless current_collection.nil?
+          rescue Ebook::EbookError
+            next
+          end
+        end
+      end
+    end
+
+    def save
+      IO.write(KindleCG.os_collections_path, @collections.to_json)
+    end
+
+    private
+
+    def relative_path(path)
+      _path = path.dup
+      _path.slice!(KindleCG.os_documents_path + '/')
+      _path == KindleCG.os_documents_path ? "" : _path
+    end 
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: KindleCG
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antonio Lorusso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: Mirror your ebooks directory tree into kindle collections
+email:
+- antonio.lorusso@gmail.com
+executables:
+- kindlecg
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- KindleCG.gemspec
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/kindlecg
+- lib/KindleCG.rb
+- lib/KindleCG/cli.rb
+- lib/KindleCG/collections.rb
+- lib/KindleCG/ebook/ebook.rb
+- lib/KindleCG/ebook/mobi.rb
+- lib/KindleCG/ebook/pdf.rb
+- lib/KindleCG/ebook/sectionizer.rb
+- lib/KindleCG/version.rb
+- spec/spec_helper.rb
+homepage: http://antoniolorusso.com/KindleCG
+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.0.3
+signing_key: 
+specification_version: 4
+summary: kindlecg helps you manage your kindle collections using the filesystem directory
+  tree
+test_files:
+- spec/spec_helper.rb