klipbook 2.1.3 → 3.0.0

data/lib/klipbook/commands/list.rb

@@ -0,0 +1,17 @@
+module Klipbook
+  module Commands
+    class List < Command
+      def run_command!(book_source, _options)
+        books = book_source.books
+        if books.empty?
+          logger.info 'No books available'
+        else
+          logger.info 'Book list:'
+          books.each_with_index do |book, index|
+            logger.info "[#{index + 1}] #{book.title_and_author}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/klipbook/config.rb

@@ -1,22 +1,30 @@
+require 'yaml'
+
 module Klipbook
   class Config
-    def initialize(config_file_name='.klipbookrc')
-      @config_file_name = config_file_name
-    end
+    DEFAULT_MAXBOOKS = 5
 
     def read
-      merge_config_from_rc_file({})
+      merge_config_from_rc_file({
+        count: DEFAULT_MAXBOOKS,
+        output_dir: Dir.pwd,
+        force: false
+      })
     end
 
+    private
+
     def merge_config_from_rc_file(config)
-      config_file = File.join(File.expand_path(ENV['HOME']), @config_file_name)
+      config.merge(file_config)
+    end
 
-      if config_file && File.exist?(config_file)
-        require 'yaml'
-        config.merge!(File.open(config_file) { |file| YAML::load(file) })
+    def file_config
+      config_file = File.expand_path("~/.klipbookrc")
+      if File.exist?(config_file)
+        YAML.load(File.read(config_file)) || {}
+      else
+        {}
       end
-
-      config
     end
   end
 end

data/lib/klipbook/logger.rb

@@ -0,0 +1,15 @@
+module Klipbook
+  class Logger
+    def initialize(stdout=$stdout, stderr=$stderr)
+      @stdout, @stderr = stdout, stderr
+    end
+
+    def info(msg)
+      @stdout.puts msg
+    end
+
+    def error(msg)
+      @stderr.puts msg
+    end
+  end
+end

data/lib/klipbook/sources/amazon_site/book_scraper.rb

@@ -1,5 +1,3 @@
-require 'mechanize'
-
 module Klipbook::Sources
   module AmazonSite
     class BookScraper

data/lib/klipbook/sources/book.rb

@@ -1,28 +1,43 @@
-Klipbook::Book = Struct.new(:asin, :author, :title, :last_update, :clippings) do
-  def title_and_author
-    author_txt = author ? " by #{author}" : ''
-    "#{title}#{author_txt}"
-  end
+# coding: utf-8
+module Klipbook
+  Book = Struct.new(:asin, :author, :title, :last_update, :clippings) do
+    def title_and_author
+      author_txt = author ? " by #{author}" : ''
+      "#{title}#{author_txt}"
+    end
 
-  def get_binding
-    binding
-  end
+    def sorted_clippings
+      clippings.sort_by(&:location)
+    end
 
-  def location_html(location)
-    if self.asin
-      "<a href=\"kindle://book?action=open&asin=#{asin}&location=#{location}\">loc #{location}</a>"
-    else
-      "loc #{location}"
+    def get_binding
+      binding
+    end
+
+    def location_html(location)
+      if asin
+        "<a href=\"kindle://book?action=open&asin=#{asin}&location=#{location}\">loc #{location}</a>"
+      else
+        "loc #{location}"
+      end
+    end
+
+    def location_markdown(location)
+      if asin
+        "[∞](kindle://book?action=open&asin=#{asin}&location=#{location})"
+      else
+        ""
+      end
     end
-  end
 
-  def self.from_hash(hash)
-    self.new.tap do |b|
-      b.asin = hash['asin']
-      b.author = hash['author']
-      b.title = hash['title']
-      b.last_update = hash['last_update']
-      b.clippings = hash['clippings'].map { |clip| Klipbook::Clipping.from_hash(clip) }
+    def self.from_hash(hash)
+      self.new.tap do |b|
+        b.asin = hash['asin']
+        b.author = hash['author']
+        b.title = hash['title']
+        b.last_update = hash['last_update']
+        b.clippings = hash['clippings'].map { |clip| Klipbook::Clipping.from_hash(clip) }
+      end
     end
   end
 end

data/lib/klipbook/sources/clipping.rb

@@ -1,11 +1,13 @@
-Klipbook::Clipping = Struct.new(:annotation_id, :text, :location, :type, :page) do
-  def self.from_hash(hash)
-    self.new.tap do |b|
-      b.annotation_id = hash['annotation_id']
-      b.text = hash['text']
-      b.location = hash['location']
-      b.type = hash['type']
-      b.page = hash['page']
+module Klipbook
+  Clipping = Struct.new(:annotation_id, :text, :location, :type, :page) do
+    def self.from_hash(hash)
+      self.new.tap do |b|
+        b.annotation_id = hash['annotation_id']
+        b.text = hash['text']
+        b.location = hash['location']
+        b.type = hash['type']
+        b.page = hash['page']
+      end
     end
   end
 end

data/lib/klipbook/sources/kindle_device/entry.rb

@@ -1,10 +1,12 @@
-module Klipbook::Sources
-  module KindleDevice
-    class Entry
-      attr_accessor :title, :author, :type, :location, :page, :added_on, :text
+module Klipbook
+  module Sources
+    module KindleDevice
+      class Entry
+        attr_accessor :title, :author, :type, :location, :page, :added_on, :text
 
-      def initialize
-        yield self if block_given?
+        def initialize
+          yield self if block_given?
+        end
       end
     end
   end

data/lib/klipbook/sources/kindle_device/entry_parser.rb

@@ -1,84 +1,86 @@
-module Klipbook::Sources
-  module KindleDevice
-    class EntryParser
-
-      def build_entry(entry_text)
-        return nil if invalid_entry?(entry_text)
-
-        lines = split_text_into_lines(entry_text)
-        title_line = lines[0].strip
-        metadata = lines[1].strip
-        text_lines = lines[3..-1]
-
-        type = extract_type(metadata)
-
-        Klipbook::Sources::KindleDevice::Entry.new do |h|
-          h.title = extract_title(title_line)
-          h.author = extract_author(title_line)
-          h.location = extract_location(metadata)
-          h.page = extract_page(metadata)
-          h.added_on = extract_added_date(metadata)
-          h.text = extract_content(text_lines)
-          h.type = extract_type(metadata)
+module Klipbook
+  module Sources
+    module KindleDevice
+      class EntryParser
+
+        def build_entry(entry_text)
+          return nil if invalid_entry?(entry_text)
+
+          lines = split_text_into_lines(entry_text)
+          title_line = lines[0].strip
+          metadata = lines[1].strip
+          text_lines = lines[3..-1]
+
+          type = extract_type(metadata)
+
+          Klipbook::Sources::KindleDevice::Entry.new do |h|
+            h.title = extract_title(title_line)
+            h.author = extract_author(title_line)
+            h.location = extract_location(metadata)
+            h.page = extract_page(metadata)
+            h.added_on = extract_added_date(metadata)
+            h.text = extract_content(text_lines)
+            h.type = extract_type(metadata)
+          end
         end
-      end
 
-    private
+        private
 
-      def invalid_entry?(entry_text)
-        entry_text.blank? || incomplete_entry?(entry_text)
-      end
+        def invalid_entry?(entry_text)
+          entry_text.blank? || incomplete_entry?(entry_text)
+        end
 
-      def incomplete_entry?(entry_text)
-        split_text_into_lines(entry_text).length < 2
-      end
+        def incomplete_entry?(entry_text)
+          split_text_into_lines(entry_text).length < 2
+        end
 
-      def split_text_into_lines(entry_text)
-        entry_text.lstrip.lines.to_a
-      end
+        def split_text_into_lines(entry_text)
+          entry_text.lstrip.lines.to_a
+        end
 
-      def extract_title(title_line)
-        if title_line =~ /\(.+\)\Z/
-          title_line.scan(/(.*)\s+\(.+\)\Z/).first.first
-        else
-          title_line
+        def extract_title(title_line)
+          if title_line =~ /\(.+\)\Z/
+            title_line.scan(/(.*)\s+\(.+\)\Z/).first.first
+          else
+            title_line
+          end
         end
-      end
 
-      def extract_author(title_line)
-        match = title_line.scan /\(([^\(]+)\)\Z/
-        match.empty? ? nil : match.first.first
-      end
+        def extract_author(title_line)
+          match = title_line.scan /\(([^\(]+)\)\Z/
+          match.empty? ? nil : match.first.first
+        end
 
-      def extract_type(metadata)
-        type = metadata.scan(/^-( Your)? (\w+)/).first[1]
-        type.downcase.to_sym
-      end
+        def extract_type(metadata)
+          type = metadata.scan(/^-( Your)? (\w+)/).first[1]
+          type.downcase.to_sym
+        end
 
-      def extract_location(metadata)
-        match = metadata.scan(/Loc(ation|\.) ([0-9]+-?)/)
+        def extract_location(metadata)
+          match = metadata.scan(/Loc(ation|\.) ([0-9]+-?)/)
 
-        return 0 if match.empty?
+          return 0 if match.empty?
 
-        location = match.first[1]
-        location.to_i
-      end
+          location = match.first[1]
+          location.to_i
+        end
 
-      def extract_page(metadata)
-        match = metadata.scan(/Page (\d+)/)
+        def extract_page(metadata)
+          match = metadata.scan(/Page (\d+)/)
 
-        return nil if match.empty?
+          return nil if match.empty?
 
-        location = match.first.first
-        location.to_i
-      end
+          location = match.first.first
+          location.to_i
+        end
 
-      def extract_content(text_lines)
-        text_lines.join('').rstrip
-      end
+        def extract_content(text_lines)
+          text_lines.join('').rstrip
+        end
 
-      def extract_added_date(metadata)
-        DateTime.parse(metadata.scan(/Added on (.+)$/i).first.first)
+        def extract_added_date(metadata)
+          DateTime.parse(metadata.scan(/Added on (.+)$/i).first.first)
+        end
       end
     end
   end

data/lib/klipbook/sources/kindle_device/file.rb

@@ -1,54 +1,56 @@
-module Klipbook::Sources
-  module KindleDevice
-    class File
-      def initialize(infile, max_books, file_parser=FileParser.new)
-        @file_text = infile.read.strip
-        @file_parser = file_parser
-        @max_books = max_books
-      end
+module Klipbook
+  module Sources
+    module KindleDevice
+      class File
+        def initialize(infile, max_books, file_parser=FileParser.new)
+          @file_text = infile.strip
+          @file_parser = file_parser
+          @max_books = max_books
+        end
 
-      # TODO Shift max books here
-      def books
-        @books ||= build_books.take(@max_books)
-      end
+        # TODO Shift max books here
+        def books
+          @books ||= build_books.take(@max_books)
+        end
 
-    private
+        private
 
-      def build_books
-        sorted_entries = extract_sorted_entries_from_file_text
-        build_sorted_book_list(sorted_entries)
-      end
+        def build_books
+          sorted_entries = extract_sorted_entries_from_file_text
+          build_sorted_book_list(sorted_entries)
+        end
 
-      def extract_sorted_entries_from_file_text
-        entries = @file_parser.extract_entries(@file_text)
-        entries.sort { |entry_a, entry_b| entry_a.title <=> entry_b.title }
-      end
+        def extract_sorted_entries_from_file_text
+          entries = @file_parser.extract_entries(@file_text)
+          entries.sort { |entry_a, entry_b| entry_a.title <=> entry_b.title }
+        end
 
-      def build_sorted_book_list(sorted_entries)
-        books_from_entries(sorted_entries).sort do |book_a, book_b|
-          book_b.last_update <=> book_a.last_update
+        def build_sorted_book_list(sorted_entries)
+          books_from_entries(sorted_entries).sort do |book_a, book_b|
+            book_b.last_update <=> book_a.last_update
+          end
         end
-      end
 
-      def books_from_entries(entries)
-        entries.select { |entry| entry.type != :bookmark }
-               .group_by(&:title)
-               .map { |title, book_entries| book_from_entries(book_entries) }
-      end
+        def books_from_entries(entries)
+          entries.select { |entry| entry.type != :bookmark }
+            .group_by(&:title)
+            .map { |title, book_entries| book_from_entries(book_entries) }
+        end
 
-      def book_from_entries(entries)
-        entries.sort! { |ea, eb| ea.location <=> eb.location }
-
-        Klipbook::Book.new.tap do |b|
-          b.title = entries.first.title
-          b.author = entries.first.author
-          b.last_update = entries.map(&:added_on).max
-          b.clippings = entries.map do |e|
-            Klipbook::Clipping.new.tap do |c|
-              c.location = e.location
-              c.page = e.page
-              c.text = e.text
-              c.type = e.type
+        def book_from_entries(entries)
+          entries.sort! { |ea, eb| ea.location <=> eb.location }
+
+          Klipbook::Book.new.tap do |b|
+            b.title = entries.first.title
+            b.author = entries.first.author
+            b.last_update = entries.map(&:added_on).max
+            b.clippings = entries.map do |e|
+              Klipbook::Clipping.new.tap do |c|
+                c.location = e.location
+                c.page = e.page
+                c.text = e.text
+                c.type = e.type
+              end
             end
           end
         end

data/lib/klipbook/sources/kindle_device/file_parser.rb

@@ -1,32 +1,34 @@
 # encoding: UTF-8
 
-module Klipbook::Sources
-  module KindleDevice
-    class FileParser
-      def initialize(entry_parser=EntryParser.new)
-        @entry_parser = entry_parser
-      end
+module Klipbook
+  module Sources
+    module KindleDevice
+      class FileParser
+        def initialize(entry_parser=EntryParser.new)
+          @entry_parser = entry_parser
+        end
 
-      def extract_entries(file_text)
-        entries_text = split_into_raw_entries_text(file_text)
+        def extract_entries(file_text)
+          entries_text = split_into_raw_entries_text(file_text)
 
-        build_entries(entries_text)
-      end
+          build_entries(entries_text)
+        end
 
-    private
+        private
 
-      def build_entries(entries_text)
-        entries_text.map do |entry_text|
-          @entry_parser.build_entry(entry_text)
-        end.compact
-      end
+        def build_entries(entries_text)
+          entries_text.map do |entry_text|
+            @entry_parser.build_entry(entry_text)
+          end.compact
+        end
 
-      def strip_control_characters(file_text)
-        file_text.gsub("\r", '').gsub("\xef\xbb\xbf", '')
-      end
+        def strip_control_characters(file_text)
+          file_text.gsub("\r", '').gsub("\xef\xbb\xbf", '')
+        end
 
-      def split_into_raw_entries_text(file_text)
-        strip_control_characters(file_text).split('==========')
+        def split_into_raw_entries_text(file_text)
+          strip_control_characters(file_text).split('==========')
+        end
       end
     end
   end

data/lib/klipbook/sources/source.rb

@@ -0,0 +1,30 @@
+module Klipbook
+  module Sources
+    class Source
+      def self.build(options)
+        if options.from_file
+          file_source(options.from_file, options.count)
+        elsif options.from_site
+          site_source(options.from_site, options.count)
+        else
+          raise "Unknown source type"
+        end
+      end
+
+      def self.site_source(credentials, max_books)
+        unless credentials =~ /(.+):(.+)/
+          logger.error "Error: your credentials need to be in username:password format."
+          exit 127
+        end
+
+        username = $1
+        password = $2
+        Sources::AmazonSite::SiteScraper.new(username, password, max_books)
+      end
+
+      def self.file_source(file, max_books)
+        Sources::KindleDevice::File.new(File.read(file), max_books)
+      end
+    end
+  end
+end

data/lib/klipbook/version.rb

@@ -1,3 +1,3 @@
 module Klipbook
-  VERSION = '2.1.3'
+  VERSION = '3.0.0'
 end

data/lib/klipbook.rb

@@ -1,16 +1,21 @@
-# encoding: utf-8
+require 'klipbook/cli'
 require 'klipbook/util/blank'
 require 'klipbook/util/struct_to_json'
 require 'klipbook/version'
-require 'klipbook/colours'
+require 'klipbook/config'
+require 'klipbook/logger'
 
-require 'klipbook/commands/tojson'
-require 'klipbook/commands/list_books'
-require 'klipbook/commands/tohtml'
+require 'klipbook/commands/command'
+require 'klipbook/commands/list'
+require 'klipbook/commands/export'
+require 'klipbook/commands/exporters/exporter'
+require 'klipbook/commands/exporters/json_exporter'
+require 'klipbook/commands/exporters/html_exporter'
+require 'klipbook/commands/exporters/markdown_exporter'
 
+require 'klipbook/sources/source'
 require 'klipbook/sources/book'
 require 'klipbook/sources/clipping'
-require 'klipbook/sources/invalid_source_error'
 
 require 'klipbook/sources/kindle_device/file_parser'
 require 'klipbook/sources/kindle_device/entry_parser'
@@ -19,8 +24,3 @@ require 'klipbook/sources/kindle_device/file'
 
 require 'klipbook/sources/amazon_site/site_scraper'
 require 'klipbook/sources/amazon_site/book_scraper'
-
-require 'klipbook/config'
-
-require 'klipbook/tohtml/html_printer'
-require 'klipbook/tojson/book_file'