kindlefs 0.1.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create --install 1.9.3@kindlefs

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Arthur Andersen
+
+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,32 @@
+# KindleFS
+
+KindleFS is a FuseFS that mounts a Kindles data via Rindle and allows
+the management of the kindles collection information via filesystem tools.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kindlefs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kindlefs
+
+## Usage
+
+Just mount the kindle into some folder.
+
+    $ kindlefs /path/to/kindle/root /path/to/mountpoint
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/kindlefs

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'fusefs'
+require 'rindle'
+require 'kindlefs'
+
+if ARGV.length < 1
+  puts "usage: kindlefs <kindle_root> <mount_point>"
+  exit 1
+end
+
+trap("INT") do
+  puts "exiting kindlefs ..."
+  FuseFS.exit
+  FuseFS.unmount
+  exit
+end
+
+kindle_root = ARGV.shift.sub(/#{Regexp.escape(File::SEPARATOR)}$/, '')
+mount_path = ARGV.shift.sub(/#{Regexp.escape(File::SEPARATOR)}$/, '')
+
+Rindle::load(kindle_root)
+
+kindle = KindleFS::Filesystem.new
+FuseFS.set_root kindle
+FuseFS.mount_under mount_path
+FuseFS.run

data/kindlefs.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/kindlefs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Arthur Andersen"]
+  gem.email         = ["leoc.git@gmail.com"]
+  gem.description   = %q{KindleFS mounts the collection information of a Kindle device as file system in user space via the Rindle gem.}
+  gem.summary       = %q{Mount Kindle via Rindle.}
+  gem.homepage      = "https://github.com/leoc/kindlefs"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "kindlefs"
+  gem.require_paths = ["lib"]
+  gem.version       = KindleFS::VERSION
+
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'rfusefs'
+  gem.add_dependency 'rindle'
+end

data/lib/kindlefs.rb

@@ -0,0 +1,4 @@
+require "kindlefs/version"
+require "kindlefs/filesystem"
+
+module KindleFS; end

data/lib/kindlefs/filesystem.rb

@@ -0,0 +1,219 @@
+require 'fusefs'
+require 'rindle/mixins/regexp'
+
+module KindleFS
+  class Filesystem < FuseFS::FuseDir
+    ROOT_PATH        = /^\/$/
+    COLLECTIONS_PATH = /^\/collections$/.freeze
+    DOCUMENTS_PATH   = /^\/documents$/.freeze
+    PICTURES_PATH    = /^\/pictures$/.freeze
+    COLLECTION_NAME  = /([A-Za-z0-9_\-\s'"\.]+)/i.freeze
+    COLLECTION_PATH  = /^#{COLLECTIONS_PATH.strip}\/#{COLLECTION_NAME.strip}$/.freeze
+    DOCUMENT_NAME    = /([A-Za-z0-9_\s\-]+\.(mobi|epub|rtf|pdf|azw|azw1)+)/i.freeze
+    COLLECTION_DOCUMENT_PATH   = /^#{COLLECTIONS_PATH.strip}\/#{COLLECTION_NAME.strip}\/#{DOCUMENT_NAME.strip}$/.freeze
+    UNASSOCIATED_DOCUMENT_PATH = /^#{COLLECTIONS_PATH.strip}\/#{DOCUMENT_NAME.strip}$/.freeze
+    DOCUMENT_PATH    = /^#{DOCUMENTS_PATH.strip}\/#{DOCUMENT_NAME.strip}$/.freeze
+
+    def contents path
+      case path
+      when ROOT_PATH
+        [ 'collections', 'documents', 'pictures' ]
+      when COLLECTIONS_PATH
+        Rindle::Collection.all.map(&:name) + Rindle::Document.unassociated.map(&:filename)
+      when DOCUMENTS_PATH
+        Rindle::Document.all.map(&:filename)
+      when COLLECTION_PATH
+        collection = Rindle::Collection.first :named => $1
+        collection.documents.map(&:filename)
+      else
+        []
+      end
+    end
+
+    def file?(path)
+      case path
+      when DOCUMENT_PATH
+        return true
+      when COLLECTION_DOCUMENT_PATH
+        col = Rindle::Collection.find_by_name $1
+        doc = Rindle::Document.find_by_name $2
+        return doc && col.include?(doc)
+      when UNASSOCIATED_DOCUMENT_PATH
+        doc = Rindle::Document.find_by_name $1
+        return doc.collections.empty? if doc
+      end
+      false
+    end
+
+    def directory?(path)
+      case path
+      when COLLECTIONS_PATH, DOCUMENTS_PATH, PICTURES_PATH
+        true
+      when COLLECTION_PATH
+        Rindle::Collection.exists?(:named => $1)
+      else
+        false
+      end
+    end
+
+    def executable? path
+      false
+    end
+
+    def size path
+      doc = Rindle::Document.find_by_name File.basename(path)
+      File.size File.join(Rindle.root_path, doc.path)
+    end
+
+    def can_delete?(path)
+      case path
+      when DOCUMENTS_PATH, PICTURES_PATH, COLLECTIONS_PATH
+        false
+      else
+        true
+      end
+    end
+
+    def can_write?(path)
+      if path !~ ROOT_PATH
+        true
+      else
+        false
+      end
+    end
+
+    def can_mkdir?(path)
+      case path
+      when COLLECTION_PATH
+        true
+      else
+        false
+      end
+    end
+
+    def can_rmdir?(path)
+      case path
+      when COLLECTION_PATH
+        true
+      else
+        false
+      end
+    end
+
+    def touch(path, val = 0)
+      filename = File.basename(path)
+      case path
+      when UNASSOCIATED_DOCUMENT_PATH, DOCUMENT_PATH
+        doc = Rindle::Document.find_by_name $1
+        doc = Rindle::Document.create $1 unless doc
+        FileUtils.touch(File.join(Rindle.root_path, doc.path))
+        Rindle.save
+        true
+      else
+        false
+      end
+    end
+
+    def mkdir(path)
+      if path =~ COLLECTION_PATH
+        col = Rindle::Collection.find_by_name $1
+        Rindle::Collection.create($1) if col.nil?
+        Rindle.save
+        true
+      else
+        false
+      end
+    end
+
+    def rmdir(path)
+      if path =~ COLLECTION_PATH
+        collection = Rindle::Collection.first :named => $1
+        return false unless collection
+        collection.destroy!
+      else
+        return false
+      end
+      Rindle.save
+      true
+    end
+
+    def delete path
+      case path
+      when COLLECTION_DOCUMENT_PATH
+        col = Rindle::Collection.find_by_name $1
+        doc = Rindle::Document.find_by_name $2
+        col.remove doc
+      when DOCUMENT_PATH, UNASSOCIATED_DOCUMENT_PATH
+        doc = Rindle::Document.find_by_name $1
+        doc.delete!
+      end
+      Rindle.save
+      true
+    end
+
+    def rename old, new
+      case old
+      when UNASSOCIATED_DOCUMENT_PATH
+        doc = Rindle::Document.find_by_name $1
+        if new =~ COLLECTION_DOCUMENT_PATH
+          col = Rindle::Collection.find_by_name $1
+          col.add doc
+        end
+        if doc and !doc.amazon?
+          doc.rename! File.basename(new)
+        else
+          return false
+        end
+      when COLLECTION_DOCUMENT_PATH
+        old_col = Rindle::Collection.find_by_name $1
+        doc = Rindle::Document.find_by_name $2
+        if new =~ COLLECTION_DOCUMENT_PATH
+          new_col = Rindle::Collection.find_by_name $1
+          unless old_col == new_col
+            old_col.remove doc
+            new_col.add doc
+          end
+          doc.rename! File.basename(new)
+        else
+          return false
+        end
+      when COLLECTION_PATH
+        collection = Rindle::Collection.find_by_name $1
+        if new =~ COLLECTION_PATH
+          collection.rename! File.basename(new)
+        else
+          return false
+        end
+      else
+        return false
+      end
+      Rindle.save
+      true
+    end
+
+    def write_to path, body
+      doc = Rindle::Document.find_by_name File.basename(path)
+      if doc
+        if path =~ COLLECTION_DOCUMENT_PATH
+          col = Rindle::Collection.find_by_name $1
+          col.add doc
+        end
+      else
+        doc = Rindle::Document.create File.basename(path)
+        File.open(File.join(Rindle.root_path, doc.path), 'w+') do |f|
+          f.write body
+        end
+        if path =~ COLLECTION_DOCUMENT_PATH
+          Rindle::Collection.find_by_name($1).add doc
+        end
+      end
+      Rindle.save
+      true
+    end
+
+    def read_file path
+      doc = Rindle::Document.find_by_name File.basename(path)
+      File.read File.join(Rindle.root_path, doc.path)
+    end
+  end
+end

data/lib/kindlefs/version.rb

@@ -0,0 +1,3 @@
+module KindleFS
+  VERSION = "0.1.0"
+end

data/spec/data/README.md

@@ -0,0 +1 @@
+This directory contains dummy data for the specs.

data/spec/data/kindle/documents/A book in another collection.mobi

@@ -0,0 +1 @@
+Some dummy data

data/spec/data/kindle/documents/A test aswell.mobi

@@ -0,0 +1 @@
+Some dummy data

data/spec/data/kindle/documents/Definitely a Test.pdf

@@ -0,0 +1 @@
+Some dummy data

data/spec/data/kindle/documents/Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw

@@ -0,0 +1 @@
+Some dummy data

data/spec/data/kindle/documents/The Adventures of Sherlock Holme-asin_B000JQU1VS-type_EBOK-v_0.azw

@@ -0,0 +1 @@
+Some dummy data

data/spec/data/kindle/documents/This is a test document.rtf

@@ -0,0 +1 @@
+Some dummy data

data/spec/data/kindle/system/collections.json

@@ -0,0 +1 @@
+{"collection2@en-US":{"items":["*440f49b58ae78d34f4b8ad3233f04f6b8f5490c2","*5c4dc5c9e385385cbcaf1beedef7690c165a39ca"],"lastAccess":1298745909918},"amazon books@en-US":{"items":["#B001UQ5HVA^EBSP","#B000JQU1VS^EBOK"],"lastAccess":1298745909917},"test collection@en-US":{"items":[],"lastAccess":0},"collection1@en-US":{"items":["*0849dd9b85fc341d10104f56985e423b3848e1f3","*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7"],"lastAccess":1298745909919}}

data/spec/kindlefs/filesystem_spec.rb

@@ -0,0 +1,459 @@
+require "spec_helper"
+
+describe KindleFS::Filesystem do
+  before(:all) do
+    Rindle.load(kindle_root)
+    @fs = KindleFS::Filesystem.new
+  end
+
+  context ' regular expressions' do
+    it 'should match root path correctly' do
+      '/'.should match(KindleFS::Filesystem::ROOT_PATH)
+      '/collections'.should_not match(KindleFS::Filesystem::ROOT_PATH)
+    end
+
+    it 'should match the documents path correctly' do
+      '/documents'.should match(KindleFS::Filesystem::DOCUMENTS_PATH)
+      '/collections'.should_not match(KindleFS::Filesystem::DOCUMENTS_PATH)
+      '/documents/dummy'.should_not match(KindleFS::Filesystem::DOCUMENTS_PATH)
+    end
+
+    it 'should match the collections path correctly' do
+      '/collections'.should match(KindleFS::Filesystem::COLLECTIONS_PATH)
+      '/documents'.should_not match(KindleFS::Filesystem::COLLECTIONS_PATH)
+      '/collections/dummy'.should_not match(KindleFS::Filesystem::COLLECTIONS_PATH)
+    end
+  end
+
+  describe '#contents' do
+    it 'lists view options' do
+      list = @fs.contents('/')
+      list.should =~ [ 'collections', 'documents', 'pictures' ]
+    end
+    it 'lists all documents' do
+      list = @fs.contents '/documents'
+      list.should =~ [
+                      'A book in another collection.mobi',
+                      'A test aswell.mobi',
+                      'Definitely a Test.pdf',
+                      'Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw',
+                      'The Adventures of Sherlock Holme-asin_B000JQU1VS-type_EBOK-v_0.azw',
+                      'This is a test document.rtf'
+                     ]
+    end
+    it 'lists collections and unassociated documents' do
+      list = @fs.contents('/collections')
+      list.should =~ [ 'collection1', 'collection2', 'amazon books',
+                       "This is a test document.rtf" ]
+    end
+    it 'lists documents in a collection' do
+      list = @fs.contents('/collections/collection1')
+      list.should =~ [ 'A test aswell.mobi', 'Definitely a Test.pdf' ]
+    end
+
+  end
+
+  describe '#file?' do
+    it 'returns true if path to a collections document given' do
+      @fs.file?('/collections/collection1/A test aswell.mobi').should == true
+    end
+
+    it 'returns false if path to collection given' do
+      @fs.file?('/collections/collection1').should == false
+    end
+  end
+
+  describe '#directory?' do
+    it 'returns true if path to root folders given' do
+      @fs.directory?('/collections').should == true
+      @fs.directory?('/documents').should == true
+      @fs.directory?('/pictures').should == true
+    end
+
+    it 'returns true if path to collection given' do
+      @fs.directory?('/collections/collection1').should == true
+    end
+
+    it 'returns false if path to collections document given' do
+      @fs.directory?('/collections/collection1/A test aswell.mobi').should == false
+    end
+
+    it 'returns false if path to unassociated document given' do
+      @fs.directory?('/collections/test.mobi').should == false
+    end
+
+    it 'returns false if path to document given' do
+      @fs.directory?('/documents/test.mobi').should == false
+    end
+  end
+
+  describe '#executable?' do
+    it 'should return false' do
+      @fs.executable?('/some/path').should == false
+    end
+  end
+
+  describe '#can_delete?' do
+    it 'should return false for documents path' do
+      @fs.can_delete?('/documents').should == false
+    end
+
+    it 'should return false for pictures path' do
+      @fs.can_delete?('/pictures').should == false
+    end
+
+    it 'should return false for collections path' do
+      @fs.can_delete?('/collections').should == false
+    end
+
+    it 'should return true for document path' do
+      @fs.can_delete?('/documents/abc.pdf').should == true
+    end
+
+    it 'should return true for collection document path' do
+      @fs.can_delete?('/collections/abc/my_document.pdf').should == true
+    end
+
+    it 'should return true for unasssociated document path' do
+      @fs.can_delete?('/collections/my_document.pdf').should == true
+    end
+  end
+
+  describe '#can_write?' do
+    it 'should return false for root path' do
+      @fs.can_write?('/').should == false
+    end
+  end
+
+  describe '#can_mkdir?' do
+    it 'should return false for root path' do
+      @fs.can_mkdir?('/').should == false
+    end
+
+    it 'should return false for documents path' do
+      @fs.can_mkdir?('/documents').should == false
+    end
+
+    it 'should return false for pictures path' do
+      @fs.can_mkdir?('/pictures').should == false
+    end
+
+    it 'should return false for collections path' do
+      @fs.can_mkdir?('/collections').should == false
+    end
+
+    it 'should return true for collection path' do
+      @fs.can_mkdir?('/collections/collection').should == true
+    end
+
+    it 'should return false for collection document path' do
+      @fs.can_mkdir?('/collections/collection/document.pdf').should == false
+    end
+
+    it 'should return false for document path' do
+      @fs.can_mkdir?('/documents/document.pdf').should == false
+    end
+  end
+
+  describe '#can_rmdir?' do
+    it 'should return false for root path' do
+      @fs.can_rmdir?('/').should == false
+    end
+
+    it 'should return false for documents path' do
+      @fs.can_rmdir?('/documents').should == false
+    end
+
+    it 'should return false for pictures path' do
+      @fs.can_rmdir?('/pictures').should == false
+    end
+
+    it 'should return false for collections path' do
+      @fs.can_rmdir?('/collections').should == false
+    end
+
+    it 'should return true for collection path' do
+      @fs.can_rmdir?('/collections/collection').should == true
+    end
+
+    it 'should return false for collection document path' do
+      @fs.can_rmdir?('/collections/collection/document.pdf').should == false
+    end
+
+    it 'should return false for document path' do
+      @fs.can_rmdir?('/documents/document.pdf').should == false
+    end
+  end
+
+  describe '#touch' do
+    before :all do
+      @fs.touch '/collections/abc.rtf'
+    end
+
+    after :all do
+      FileUtils.rm_f File.join(Rindle.root_path, '/documents/abc.rtf')
+    end
+
+    it 'should create an empty file for given path' do
+      File.should exist File.join(Rindle.root_path, '/documents/abc.rtf')
+    end
+  end
+
+  describe '#mkdir' do
+    context 'given collection path' do
+      it 'should create a new collection if non-existent' do
+        @fs.mkdir '/collections/test collection'
+        Rindle.collections.should have_key 'test collection'
+      end
+    end
+
+    context 'given another path' do
+      it 'should return false' do
+        @fs.mkdir('/collections/test collection/something').should == false
+      end
+    end
+  end
+
+  describe '#rmdir' do
+    context 'given collection path' do
+      before :all do
+        Rindle::Collection.create 'some collection'
+      end
+
+      context 'with existing collection' do
+        it 'should delete the collection' do
+          @fs.rmdir '/collections/some collection'
+          Rindle.collections.should_not have_key 'some collection'
+        end
+      end
+
+      context 'with non-existing collection' do
+        it 'should return false' do
+          ret = @fs.rmdir '/collections/some collection'
+          ret.should == false
+        end
+      end
+    end
+
+    context 'given another path' do
+      it 'should return false' do
+        ret = @fs.rmdir '/collections/some collection/something'
+        ret.should == false
+      end
+    end
+  end
+
+  describe '#delete' do
+    context 'given a collection document path' do
+      before :all do
+        @fs.delete '/collections/collection1/A test aswell.mobi'
+      end
+
+      it 'should remove the document from the collection' do
+        Rindle.collections['collection1'].
+          include?('*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7').
+          should == false
+      end
+    end
+
+    context 'given a document path' do
+      before :all do
+        @fs.delete '/documents/A test aswell.mobi'
+      end
+
+      after :all do
+        doc = Rindle::Document.create 'A test aswell.mobi', :data => 'Some dummy data'
+        Rindle.collections['collection1'].add doc
+      end
+
+      it 'should remove the document from index' do
+        Rindle.index.should_not have_key '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'
+      end
+
+      it 'should remove all references in collections' do
+        Rindle.collections['collection1'].indices.
+          should_not include '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'
+      end
+
+      it 'should delete the document file' do
+        File.should_not exist File.join(Rindle.root_path, '/documents/A test aswell.mobi')
+      end
+    end
+
+    context 'given an unassociated document path' do
+      before :all do
+        @fs.delete '/collections/This is a test document.rtf'
+      end
+
+      after :all do
+        doc = Rindle::Document.create 'This is a test document.rtf', :data => 'Some dummy data'
+      end
+
+      it 'should remove the document from index' do
+        Rindle.index.should_not have_key '*3a102b4032d485025650409b2f7753a1158b199d'
+      end
+
+      it 'should delete the document file' do
+        File.should_not exist File.join(Rindle.root_path, '/documents/This is a test document.rtf')
+      end
+    end
+  end
+
+  describe '#rename' do
+    context 'given an unassociated document path as `old` and a collection document path as `new`' do
+      before :all do
+        @doc = Rindle::Document.find_by_name 'This is a test document.rtf'
+        @fs.rename '/collections/This is a test document.rtf', '/collections/collection1/Test.rtf'
+      end
+
+      after :all do
+        Rindle.collections['collection1'].remove @doc
+        @doc.rename! 'This is a test document.rtf'
+      end
+
+      it 'should rename the document' do
+        @doc.filename.should == 'Test.rtf'
+        File.should_not exist File.join(Rindle.root_path, '/documents/This is a test document.rtf')
+        File.should exist File.join(Rindle.root_path, '/documents/Test.rtf')
+      end
+
+      it 'should add the document to the given collection' do
+        Rindle.collections['collection1'].include?(@doc).should == true
+      end
+    end
+
+    context 'given a collection document path as `old`' do
+      context 'and a collection document path as `new`' do
+        context 'is equal to the `old` one' do
+          before :all do
+            @doc = Rindle::Document.find_by_name 'A test aswell.mobi'
+            @fs.rename '/collections/collection1/A test aswell.mobi',
+                       '/collections/collection1/test aswell.mobi'
+          end
+
+          after :all do
+            @doc.rename! 'A test aswell.mobi'
+          end
+
+          it 'should rename the document' do
+            File.should exist File.join(Rindle.root_path, '/documents/test aswell.mobi')
+          end
+        end
+
+        context 'is not equal to the `old` one' do
+          before :all do
+            @doc = Rindle::Document.find_by_name 'A test aswell.mobi'
+            @fs.rename '/collections/collection1/A test aswell.mobi',
+                       '/collections/collection2/A test aswell.mobi'
+          end
+
+          after :all do
+            Rindle.collections['collection2'].remove @doc
+            Rindle.collections['collection1'].add @doc
+          end
+
+          it 'should remove the document from the old collection' do
+            @doc.collections.map(&:name).should_not include 'collection1'
+          end
+
+          it 'should add the document to the new collection' do
+            @doc.collections.map(&:name).should include 'collection2'
+          end
+        end
+      end
+    end
+
+    context 'given a collection path as `old`' do
+      context 'and a collection path as `new`' do
+        before :all do
+          @col = Rindle::Collection.find_by_name 'collection1'
+          @fs.rename '/collections/collection1',
+                     '/collections/collection_renamed'
+        end
+
+        after :all do
+          @col.rename! 'collection1'
+        end
+
+        it 'should rename the collection' do
+          @col.name.should == 'collection_renamed'
+        end
+      end
+    end
+  end
+
+  describe '#write_to' do
+    context 'given document exists' do
+      context 'and in collection document path' do
+        before :all do
+          @doc = Rindle::Document.find_by_name 'A test aswell.mobi'
+          @fs.write_to '/collections/collection2/A test aswell.mobi',
+                       'Some dummy data'
+        end
+
+        after :all do
+          Rindle.collections['collection2'].remove @doc
+        end
+
+        it 'should add the document to the collection' do
+          Rindle.collections['collection2'].include?(@doc).should == true
+        end
+      end
+    end
+
+    context 'given document does not exist' do
+      before :all do
+        @fs.write_to '/collections/My test.mobi',
+                     'Some dummy data'
+        @doc = Rindle::Document.find_by_name 'My test.mobi'
+      end
+
+      after :all do
+        @doc.delete!
+      end
+
+      it 'should write the file to `documents` folder' do
+        File.read(File.join(Rindle.root_path, @doc.path)).
+          should == 'Some dummy data'
+      end
+
+      it 'should add the document to the index' do
+        Rindle.index['*5c4dc5c9e385385cbcaf1beedef7690c165a39ca'].should == @doc
+      end
+    end
+
+    context 'given document does not exist and in collection document path' do
+      before :all do
+        @fs.write_to '/collections/collection2/My test.mobi',
+                     'Some dummy data'
+        @doc = Rindle::Document.find_by_name 'My test.mobi'
+      end
+
+      after :all do
+        @doc.delete!
+      end
+
+      it 'should write the file to `documents` folder' do
+        File.read(File.join(Rindle.root_path, @doc.path)).
+          should == 'Some dummy data'
+      end
+
+      it 'should add the document to the index' do
+        Rindle.index['*5c4dc5c9e385385cbcaf1beedef7690c165a39ca'].should == @doc
+      end
+
+      it 'should add the new document to the collection' do
+        Rindle.collections['collection2'].
+          include?('*5c4dc5c9e385385cbcaf1beedef7690c165a39ca').
+          should == true
+      end
+    end
+  end
+
+  describe '#read_file' do
+    it 'should return the file data' do
+      data = @fs.read_file '/collections/collection1/A test aswell.mobi'
+      data.should == 'Some dummy data'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'rindle'
+require 'kindlefs'
+
+def kindle_root; File.join(File.dirname(__FILE__), 'data', 'kindle'); end
+
+File.open 'spec/data/kindle/system/collections.json', 'w+' do |f|
+  f.write <<JSON
+{
+    "collection1@en-US":{
+        "items":["*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7", "*0849dd9b85fc341d10104f56985e423b3848e1f3"],
+        "lastAccess": 1298745909919
+    },
+    "collection2@en-US":{
+        "items":["*440f49b58ae78d34f4b8ad3233f04f6b8f5490c2"],
+        "lastAccess": 1298745909918
+    },
+    "amazon books@en-US":{
+        "items":["#B001UQ5HVA^EBSP","#B000JQU1VS^EBOK"],
+        "lastAccess": 1298745909917
+    }
+}
+JSON
+end
+
+system 'rm -rf spec/data/kindle/documents/*'
+
+[ 'A book in another collection.mobi',
+'A test aswell.mobi',
+'Definitely a Test.pdf',
+'Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw',
+'The Adventures of Sherlock Holme-asin_B000JQU1VS-type_EBOK-v_0.azw',
+'This is a test document.rtf' ].each do |filename|
+  File.open File.join('spec/data/kindle/documents', filename), 'w+' do |f|
+    f.write 'Some dummy data'
+  end
+end
+
+# this is to reset the Singleton'ish nature of the Kindle module
+class Rindle
+  def self.reset
+    self.class_variables.each do |var|
+      eval "#{var} = nil"
+    end
+  end
+end
+
+# 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
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: kindlefs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Arthur Andersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &11542360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11542360
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11445000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11445000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11058220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11058220
+- !ruby/object:Gem::Dependency
+  name: rfusefs
+  requirement: &9408900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9408900
+- !ruby/object:Gem::Dependency
+  name: rindle
+  requirement: &8717100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8717100
+description: KindleFS mounts the collection information of a Kindle device as file
+  system in user space via the Rindle gem.
+email:
+- leoc.git@gmail.com
+executables:
+- kindlefs
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/kindlefs
+- kindlefs.gemspec
+- lib/kindlefs.rb
+- lib/kindlefs/filesystem.rb
+- lib/kindlefs/version.rb
+- spec/data/README.md
+- spec/data/kindle/documents/A book in another collection.mobi
+- spec/data/kindle/documents/A test aswell.mobi
+- spec/data/kindle/documents/Definitely a Test.pdf
+- spec/data/kindle/documents/Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw
+- spec/data/kindle/documents/The Adventures of Sherlock Holme-asin_B000JQU1VS-type_EBOK-v_0.azw
+- spec/data/kindle/documents/This is a test document.rtf
+- spec/data/kindle/system/collections.json
+- spec/kindlefs/filesystem_spec.rb
+- spec/kindlefs_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/leoc/kindlefs
+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'
+      segments:
+      - 0
+      hash: -3452657948332476179
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3452657948332476179
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Mount Kindle via Rindle.
+test_files:
+- spec/data/README.md
+- spec/data/kindle/documents/A book in another collection.mobi
+- spec/data/kindle/documents/A test aswell.mobi
+- spec/data/kindle/documents/Definitely a Test.pdf
+- spec/data/kindle/documents/Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw
+- spec/data/kindle/documents/The Adventures of Sherlock Holme-asin_B000JQU1VS-type_EBOK-v_0.azw
+- spec/data/kindle/documents/This is a test document.rtf
+- spec/data/kindle/system/collections.json
+- spec/kindlefs/filesystem_spec.rb
+- spec/kindlefs_spec.rb
+- spec/spec_helper.rb