rindle 0.1.0 → 0.1.1

data/README.md

@@ -1,19 +1,42 @@
-# Rindle: A Gem packaging multiple kindle tools
+# Rindle - Kindle Collections Management in Ruby
 
 Rindle is a package of useful classes to manage the kindles content.
 In mature versions it should provide an object-oriented interface to
 access the collections and documents on the kindle with all their
-metadata. And it should provide a convenient way for converting
-various eBook formats.
+metadata.
 
-## Libraries for kindle access
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rindle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rindle
+
+## Usage
 
 First load the kindle:
 
-    Rindle::Kindle.load '/path/to/root'
+    Rindle.load '/path/to/root'
 
-Then just use `Kindle::Collection` or `Kindle::File` with an
+Then just use `Rindle::Collection` or `Rindle::Document` with an
 ActiveRecord like interface:
 
     Rindle::Collection.first named: 'Test Collection'
-    Rindle::Collection.all named: /(.*)[1|2]$/
+    collections = Rindle::Collection.all named: /(.*)[1|2]$/
+    Rindle::Document.find_by_name 'A book.pdf'
+    documents = Rindle::Document.all
+
+## 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/lib/rindle/collection.rb

@@ -1,4 +1,4 @@
-module Rindle
+class Rindle
   class Collection
     class << self
       def all options = {}

data/lib/rindle/collections.rb

@@ -3,7 +3,7 @@ require 'json'
 
 require 'rindle/collection'
 
-module Rindle
+class Rindle
   class Collections < Hash
 
     class NoSuchFile < Exception; end

data/lib/rindle/document.rb

@@ -1,6 +1,6 @@
 require "digest/sha1"
 
-module Rindle
+class Rindle
   class Document
     class NotFound < Exception; end
 

data/lib/rindle/index.rb

@@ -2,7 +2,7 @@
 require "rubygems"
 require "json"
 
-module Rindle
+class Rindle
   class Index < Hash
     def initialize
       @index = {}

data/lib/rindle/mixins/regexp.rb

@@ -1,4 +1,4 @@
-module Rindle
+class Rindle
   module Mixins
     module Regexp
 
@@ -8,7 +8,7 @@ module Rindle
       def strip
         self.source.gsub(/^\^/,'').gsub(/\$$/,'')
       end
-      
+
     end
   end
 end

data/lib/rindle/version.rb

@@ -1,3 +1,3 @@
-module Rindle
-  VERSION = "0.1.0"
+class Rindle
+  VERSION = "0.1.1"
 end

data/lib/rindle.rb

@@ -14,45 +14,47 @@ require 'rindle/mixins/regexp'
 #
 #   Rindle.load(path)
 #
-# After that you may use the models Collection, Document, Album
-module Rindle
+# After that you may use the models `Collection` and `Document`.
+class Rindle
   @@root_path = nil
   @@collections = nil
   @@index = nil
 
   class NotLoaded < Exception; end
 
-  def self.root_path
-    if @@root_path
-      @@root_path
-    else
-      raise NotLoaded
+  class << self
+    def root_path
+      if @@root_path
+        @@root_path
+      else
+        raise NotLoaded
+      end
     end
-  end
 
-  def self.index
-    if @@index
-      @@index
-    else
-      raise NotLoaded
+    def index
+      if @@index
+        @@index
+      else
+        raise NotLoaded
+      end
     end
-  end
 
-  def self.collections
-    if @@collections
-      @@collections
-    else
-      raise NotLoaded
+    def collections
+      if @@collections
+        @@collections
+      else
+        raise NotLoaded
+      end
     end
-  end
 
-  def self.load root_path
-    @@root_path = root_path
-    @@index = Index.load(root_path)
-    @@collections = Collections.load(root_path)
-  end
+    def load root_path
+      @@root_path = root_path
+      @@index = Index.load(root_path)
+      @@collections = Collections.load(root_path)
+    end
 
-  def self.save
-    @@collections.save
+    def save
+      @@collections.save
+    end
   end
 end

data/rindle.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["leoc.git@gmail.com"]
   gem.description   = %q{The Rindle gem provides an object-oriented way to manage kindle collection data.}
   gem.summary       = %q{Access kindle collection data}
-  gem.homepage      = "https://github.com/leoc/rindle"
+  gem.homepage      = "http://leoc.github.com/rindle"
 
   gem.files         = `git ls-files`.split("\n")
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'rindle'
 def kindle_root; File.join(File.dirname(__FILE__), 'data', 'kindle'); end
 
 # this is to reset the Singleton'ish nature of the Kindle module
-module Rindle
+class Rindle
   def self.reset
     self.class_variables.each do |var|
       eval "#{var} = nil"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rindle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21636720 !ruby/object:Gem::Requirement
+  requirement: &25561500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21636720
+  version_requirements: *25561500
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &21636100 !ruby/object:Gem::Requirement
+  requirement: &25560820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21636100
+  version_requirements: *25560820
 description: The Rindle gem provides an object-oriented way to manage kindle collection
   data.
 email:
@@ -73,7 +73,7 @@ files:
 - spec/rindle/mixins/regexp_spec.rb
 - spec/rindle_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/leoc/rindle
+homepage: http://leoc.github.com/rindle
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 391700311857255160
+      hash: -4501087522031064736
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 391700311857255160
+      hash: -4501087522031064736
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17