kindleclippings 1.0.0 → 1.1.0

data/README.markdown

@@ -5,11 +5,21 @@ Kindleclippings is a ruby library for parsing annotations created on your kindle
 When you make annotations on a kindle, they are saved as a file called "My Clippings.txt" under the documents folder.   
 This library will parse these annotations/clippings and give you an array of ruby objects.
 
+## Installation
+
+To install kindleclippings just run
+
+    % sudo gem install kindleclippings
+
 ## Usage
 
+### Parsing
+
+Parsing the `My Clippings.txt` file.
+
     require 'kindleclippings'
 
-    parser = KindleClippings::ClippingParser.new
+    parser = KindleClippings::Parser.new
 
     clippings = parser.parse_file('My Clippings.txt')
     clipping = clippings.last
@@ -18,14 +28,24 @@ This library will parse these annotations/clippings and give you an array of rub
     clipping.author # => "Berkun  Scott"
     clipping.type # => :Highlight
     clipping.added_on # => #<DateTime: 2009-12-14T19:10:00+00:00 (353545963/144,0/1,2299161)>
-    clipping.content # => "Most people say \"umm\" and \"uhh\" when they speak. These are called filler sounds, and we make them mostly to hold our place in conversation. You're letting the people you're talking to know you are not done speaking."
+    clipping.content # => "Most people say \"umm\" and \"uhh\" when they speak. These are called filler sounds ..."
+
+The annotations can also be parsed directly.
 
-## Note on Patches/Pull Requests
+    require 'kindleclippings'
+
+    parser = KindleClippings::Parser.new
+    clippings = parser.parse("the content you want to parse.")
+
+### Retrieve only the information you care about
+
+You can retrieve only the annotationstypes you care about. After parsing, you can call `highlights`, `notes` or `bookmarks` on the collection to get only annotations of that type.
  
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+    require 'kindleclippings'
+
+    parser = KindleClippings::Parser.new
+    clippings = parser.parse_file('My Clippings.txt')
+    
+    clippings.notes      # All the notes
+    clippings.highlights # All the highlights
+    clippings.bookmarks  # All the bookmarks

data/lib/clippingresult.rb

@@ -0,0 +1,25 @@
+module KindleClippings
+  
+  class ClippingResult < Array
+    
+    def highlights
+      filter_by_type(:Highlight)
+    end
+    
+    def notes
+      filter_by_type(:Note)
+    end
+    
+    def bookmarks
+      filter_by_type(:Bookmark)
+    end
+    
+    private
+    
+    def filter_by_type(type)
+      return self unless type
+      self.select { |item| item.type == type }
+    end
+    
+  end
+end

data/lib/kindleclippings.rb

@@ -1,15 +1,15 @@
 # encoding: utf-8
 module KindleClippings
   
-  class ClippingParser
-    require File.expand_path(File.dirname(__FILE__) + '/clipping.rb')
+  class Parser
+    ['clipping', 'clippingresult'].each { |file| require File.expand_path(File.dirname(__FILE__) + '/' + file) }
     
     def parse_file(path)
       parse(open(path).read)
     end
     
     def parse(filecontent)
-      @clippings = Array.new
+      @clippings = ClippingResult.new
       
       filecontent.split("=" * 10).each do |clipping|
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kindleclippings
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Georg Alexander Boe
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-29 00:00:00 +01:00
+date: 2010-01-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,7 @@ extra_rdoc_files:
 - README.markdown
 files: 
 - lib/clipping.rb
+- lib/clippingresult.rb
 - lib/kindleclippings.rb
 - LICENSE
 - README.markdown