klipbook 2.1.3 → 3.0.0

data/bin/klipbook

@@ -1,224 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << File.expand_path('../../lib', __FILE__)
-
-require 'klipbook'
-require 'slop'
-
-##########
-# Helpers
-##########
-
-def get_book_source(opts)
-  exit_unless_valid_source(opts)
-
-  max_books   = opts[:number].to_i
-
-  unless max_books > 0
-    $stderr.puts "Error: Specify a number of books greater than 0"
-    exit 127
-  end
-
-  get_file_source(infile(opts), max_books) || get_site_source(credentials(opts), max_books)
-end
-
-def exit_unless_valid_source(opts)
-  unless opts[:infile] || opts[:credentials] || CONFIG[:credentials]
-    $stderr.puts "Error: #{SOURCE_HELP}"
-    exit 127
-  end
-end
-
-def get_site_source(creds, max_books)
-  return nil unless creds
-
-  unless creds =~ /(.+):(.+)/
-    $stderr.puts "Error: your credentials need to be in username:password format."
-    exit 127
-  end
-
-  username = $1
-  password = $2
-  Klipbook::Sources::AmazonSite::SiteScraper.new(username, password, max_books)
-end
-
-def get_file_source(file, max_books)
-  return nil unless file
-
-  Klipbook::Sources::KindleDevice::File.new(file, max_books)
-end
-
-def fetch_books(opts)
-  get_book_source(opts).books
-end
-
-def open_infile(file_path)
-  return nil unless file_path
-
-  unless File.exists? file_path
-    $stderr.puts "Error: could not open #{file_path}"
-    exit 127
-  end
-
-  File.open(file_path, "r")
-end
-
-def raw_json_from_file(file_path)
-  File.open(file_path, 'r') do |f|
-    f.read
-  end
-rescue
-  ""
-end
-
-def book_file(file_path)
-  Klipbook::ToJson::BookFile.from_json(raw_json_from_file(file_path))
-end
-
-#########
-# Params
-#########
-
-def infile(opts)
-  open_infile(opts[:infile])
-end
-
-def credentials(opts)
-  puts "Using credentials from ~/.klipbookrc" if !opts[:credentials] && CONFIG[:credentials]
-
-  opts[:credentials] || CONFIG[:credentials]
-end
-
-def ensure_outfile(opts)
-  unless opts[:outfile] || CONFIG[:outfile]
-    $stderr.puts("Error: Please specify an outfile.")
-    exit(127)
-  end
-
-  outfile_path(opts)
-end
-
-def outfile_path(opts)
-  puts "Using outfile from ~/.klipbookrc" if !opts[:outfile] && CONFIG[:outfile]
-
-  opts[:outfile] || CONFIG[:outfile]
-end
-
-def ensure_outdir(opts)
-  unless opts[:outdir] || CONFIG[:outdir]
-    $stderr.puts("Error: Please specify an outdir.")
-    exit(127)
-  end
-
-  outdir = outdir_path(opts)
-
-  unless File.exists?(outdir)
-    $stderr.puts("Error: Outdir does not exist.")
-    exit(127)
-  end
-
-  outdir
-end
-
-def outdir_path(opts)
-  puts "Using outdir from ~/.klipbookrc" if !opts[:outdir] && CONFIG[:outdir]
-
-  opts[:outdir] || CONFIG[:outdir] || Dir.pwd
-end
-
-##########
-# Go time
-##########
-
-CONFIG = Klipbook::Config.new.read
-
-DEFAULT_MAXBOOKS=5
-SOURCE_HELP = "You must specify either `--credentials` or `--infile` as an input."
-
-CONFIG_HELP = "Note that credentials, outdir, and outfile defaults can be stored in a file called ~/.klipbookrc\n\n" +
-              "This file is YAML formatted e.g.\n\n" +
-              ":credentials: my-kindle-user@blah.com:my-kindle-password\n" +
-              ":outdir: my/default/output/directory\n" +
-              ":outfile: my/default/output/file.json\n"
-
-def banner_for_command(command, description)
-  "Usage: klipbook #{command} [options]\n\n#{description}\n\n#{SOURCE_HELP}\n"
-end
-
-opts = Slop.parse(help: true) do
-  banner "Usage: klipbook <command> [options]\n\n" +
-         "Klipbook writes the clippings you've saved on your Kindle into JSON or pretty html.\n\n" +
-         CONFIG_HELP + "\n"
-
-  on :v, :version, "Print the version." do
-    puts "Klipbook version #{Klipbook::VERSION}"
-    exit 0
-  end
-
-  command "list" do
-    desc = "List the books on the site or in the clippings file."
-
-    banner banner_for_command("list", desc)
-
-    description desc
-
-    on :c, :credentials=, "<username>:<password> for Kindle site"
-    on :i, :infile=,      "Input file (default STDIN)"
-    on :n, :number=,      "Maximum number of books to list (default is #{DEFAULT_MAXBOOKS})", default: DEFAULT_MAXBOOKS
-
-    run do |opts, args|
-      books = fetch_books(opts)
-      Klipbook::Commands::ListBooks.new(books).call
-    end
-  end
-
-  command "tojson" do
-    desc = "Print book highlights as JSON. Note that this will update an existing JSON file in place with new entries."
-
-    banner banner_for_command("tojson", desc)
-
-    description desc
-
-    on :c, :credentials=, "<username>:<password> for Kindle site"
-    on :i, :infile=,      "Input file (default STDIN)"
-    on :n, :number=,      "Maximum number of books to print as json (default is #{DEFAULT_MAXBOOKS})", default: DEFAULT_MAXBOOKS
-    on :o, :outfile=,     "Output JSON file (default STDOUT)"
-    on :f, :force,        "Force overwrite of any existing book entries within the output file"
-
-    run do |opts, args|
-      outfile_path = ensure_outfile(opts)
-
-      books = fetch_books(opts)
-
-      Klipbook::Commands::ToJson.new(books, book_file(outfile_path)).call(outfile_path, opts[:force])
-    end
-  end
-
-  command "tohtml" do
-    desc = "Print book highlights as HTML."
-
-    banner banner_for_command("tohtml", desc)
-
-    description desc
-
-    on :c, :credentials=, "<username>:<password> for Kindle site"
-    on :i, :infile=,      "Input file (default STDIN)"
-    on :n, :number=,      "Maximum number of books to print as html (default is #{DEFAULT_MAXBOOKS})", default: DEFAULT_MAXBOOKS
-    on :o, :outdir=,      "Directory to write HTML files to (default pwd)"
-    on :f, :force,        "Force overwrite of existing files"
-
-    run do |opts, args|
-      books = fetch_books(opts)
-
-      outdir_path = ensure_outdir(opts)
-
-      Klipbook::Commands::ToHtml.new(books).call(outdir_path, opts[:force])
-    end
-  end
-
-  # Default action is to output help
-  run do |opts, args|
-    puts opts.help
-  end
-end
+require "bundler/setup"
+require "klipbook"
 
+Klipbook::CLI.new.execute!

data/klipbook.gemspec

@@ -1,124 +1,38 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: klipbook 2.1.3 ruby lib
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'klipbook/version'
 
-Gem::Specification.new do |s|
-  s.name = "klipbook"
-  s.version = "2.1.3"
+Gem::Specification.new do |spec|
+  spec.name          = "klipbook"
+  spec.version       = Klipbook::VERSION
+  spec.authors       = ["Ray Grasso"]
+  spec.email         = ["ray.grasso@gmail.com"]
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Ray Grasso"]
-  s.date = "2014-07-25"
-  s.description = "Process your Kindle clippings file to generate a nicely formatted compilation of the clippings of the books you've read"
-  s.email = "ray.grasso@gmail.com"
-  s.executables = ["klipbook"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".ruby-version",
-    ".travis.yml",
-    ".yardopts",
-    "CHANGELOG.txt",
-    "Gemfile",
-    "Gemfile.lock",
-    "Guardfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "bin/klipbook",
-    "example.png",
-    "features/fixtures/clippings-for-three-books.txt",
-    "features/list.feature",
-    "features/step_definitions/list_steps.rb",
-    "features/step_definitions/tohtml_steps.rb",
-    "features/step_definitions/tojson_steps.rb",
-    "features/support/env.rb",
-    "features/tohtml.feature",
-    "features/tojson.feature",
-    "klipbook.gemspec",
-    "lib/klipbook.rb",
-    "lib/klipbook/colours.rb",
-    "lib/klipbook/commands/list_books.rb",
-    "lib/klipbook/commands/tohtml.rb",
-    "lib/klipbook/commands/tojson.rb",
-    "lib/klipbook/config.rb",
-    "lib/klipbook/sources/amazon_site/book_scraper.rb",
-    "lib/klipbook/sources/amazon_site/site_scraper.rb",
-    "lib/klipbook/sources/book.rb",
-    "lib/klipbook/sources/clipping.rb",
-    "lib/klipbook/sources/invalid_source_error.rb",
-    "lib/klipbook/sources/kindle_device/entry.rb",
-    "lib/klipbook/sources/kindle_device/entry_parser.rb",
-    "lib/klipbook/sources/kindle_device/file.rb",
-    "lib/klipbook/sources/kindle_device/file_parser.rb",
-    "lib/klipbook/tohtml/html_book_summary.erb",
-    "lib/klipbook/tohtml/html_printer.rb",
-    "lib/klipbook/tojson/book_file.rb",
-    "lib/klipbook/util/blank.rb",
-    "lib/klipbook/util/struct_to_json.rb",
-    "lib/klipbook/version.rb",
-    "spec/lib/klipbook/commands/list_books_spec.rb",
-    "spec/lib/klipbook/commands/tohtml_spec.rb",
-    "spec/lib/klipbook/sources/book_spec.rb",
-    "spec/lib/klipbook/sources/kindle_device/entry_parser_spec.rb",
-    "spec/lib/klipbook/sources/kindle_device/file_parser_spec.rb",
-    "spec/lib/klipbook/sources/kindle_device/file_spec.rb",
-    "spec/lib/klipbook/tohtml/html_printer_spec.rb",
-    "spec/lib/klipbook/tojson/book_file_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "https://github.com/grassdog/klipbook"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "Klipbook creates a nice html summary of the clippings you've created on your Kindle."
+  spec.summary       = "Klipbook creates a nice html summary of the clippings you've created on your Kindle."
+  spec.description   = "Process your Kindle clippings file to generate a nicely formatted compilation of the clippings of the books you've read"
+  spec.homepage      = "https://github.com/grassdog/klipbook"
+  spec.license       = "MIT"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<slop>, ["~> 3.6"])
-      s.add_runtime_dependency(%q<mechanize>, ["~> 2.7"])
-      s.add_development_dependency(%q<rspec>, ["~> 3.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
-      s.add_development_dependency(%q<pry-byebug>, ["~> 1.3"])
-      s.add_development_dependency(%q<cucumber>, ["~> 1.3"])
-      s.add_development_dependency(%q<aruba>, ["~> 0.6"])
-      s.add_development_dependency(%q<guard>, [">= 0"])
-      s.add_development_dependency(%q<guard-rspec>, ["~> 4.3"])
-      s.add_development_dependency(%q<guard-cucumber>, ["~> 1.4"])
-      s.add_development_dependency(%q<terminal-notifier-guard>, ["~> 1.5"])
-    else
-      s.add_dependency(%q<slop>, ["~> 3.6"])
-      s.add_dependency(%q<mechanize>, ["~> 2.7"])
-      s.add_dependency(%q<rspec>, ["~> 3.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8"])
-      s.add_dependency(%q<pry-byebug>, ["~> 1.3"])
-      s.add_dependency(%q<cucumber>, ["~> 1.3"])
-      s.add_dependency(%q<aruba>, ["~> 0.6"])
-      s.add_dependency(%q<guard>, [">= 0"])
-      s.add_dependency(%q<guard-rspec>, ["~> 4.3"])
-      s.add_dependency(%q<guard-cucumber>, ["~> 1.4"])
-      s.add_dependency(%q<terminal-notifier-guard>, ["~> 1.5"])
-    end
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
   else
-    s.add_dependency(%q<slop>, ["~> 3.6"])
-    s.add_dependency(%q<mechanize>, ["~> 2.7"])
-    s.add_dependency(%q<rspec>, ["~> 3.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8"])
-    s.add_dependency(%q<pry-byebug>, ["~> 1.3"])
-    s.add_dependency(%q<cucumber>, ["~> 1.3"])
-    s.add_dependency(%q<aruba>, ["~> 0.6"])
-    s.add_dependency(%q<guard>, [">= 0"])
-    s.add_dependency(%q<guard-rspec>, ["~> 4.3"])
-    s.add_dependency(%q<guard-cucumber>, ["~> 1.4"])
-    s.add_dependency(%q<terminal-notifier-guard>, ["~> 1.5"])
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
-end
 
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "commander"
+  spec.add_dependency "mechanize"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+end

data/lib/klipbook/cli.rb

@@ -0,0 +1,69 @@
+require "commander"
+
+module Klipbook
+  class CLI
+    include Commander::Methods
+
+    def initialize(config=Klipbook::Config.new)
+      @config = config.read
+    end
+
+    def execute!
+      program :name, 'Klipbook'
+      program :version, Klipbook::VERSION
+      program :description, "Klipbook exports the clippings you've saved on your Kindle into JSON, Markdown, or pretty HTML"
+
+      program :help, 'Source', "You must specify either `--from-file` or `--from-site` as an input."
+      program :help, 'Config', "Note that command options can be stored in a file called ~/.klipbookrc. This file is YAML formatted and options should be snake case e.g.\n\n" +
+        ":from_site: my-kindle-user@blah.com:my-kindle-password\n" +
+        ":output_dir: ~/my/default/output/directory\n"
+
+      default_command :help
+
+      command :list do |c|
+        c.syntax = "klipbook list"
+        c.description = "List the books on the site or in the clippings file"
+
+        c.option '--from-file FILE', String, "Input clippings file"
+        c.option '--from-site username:password', String, "Credentials for Kindle highlights site"
+        c.option '-c', '--count COUNT', Integer, "Maximum number of books to list (default is #{Config::DEFAULT_MAXBOOKS})"
+
+        c.action do |_args, options|
+          merge_config(options, @config)
+
+          Klipbook::Commands::List.new.run!(options)
+        end
+      end
+
+      command :export do |c|
+        c.syntax = 'klipbook export'
+        c.description = 'Export book clippings'
+
+        c.option '--from-file FILE', String, "Input clippings file"
+        c.option '--from-site username:password', String, "Credentials for Kindle highlights site"
+        c.option '-c', '--count COUNT', Integer, "Maximum number of books to list (default is #{Config::DEFAULT_MAXBOOKS})"
+        c.option '--format FORMAT', "Format to export in [html, markdown, or json]"
+        c.option '--output-dir DIRECTORY', "Directory to export files to (default pwd)"
+        c.option '-f', '--force', "Force overwrite of existing files"
+
+        c.action do |_args, options|
+          merge_config(options, @config)
+
+          Klipbook::Commands::Export.new.run!(options)
+        end
+      end
+
+      run!
+    end
+
+    private
+
+    def merge_config(options, config)
+      if options.from_site || options.from_file
+        [:from_site, :from_file].each { |key| config.delete(key) }
+      end
+
+      options.default config
+    end
+  end
+end

data/lib/klipbook/commands/command.rb

@@ -0,0 +1,39 @@
+module Klipbook
+  module Commands
+    class Command
+      def initialize(logger=Logger.new)
+        @logger = logger
+      end
+
+      def run!(options)
+        run_command!(book_source(options), options)
+      end
+
+      def run_command!
+        raise "Implement me"
+      end
+
+      private
+
+      attr_reader :logger
+
+      def book_source(options)
+        Klipbook::Sources::Source.build(options)
+      end
+
+      def exit_unless_valid_source(options)
+        unless options.from_file || options.from_site
+          logger.error "Error: You must specify either `--from-file` or `--from-site` as an input."
+          exit 127
+        end
+      end
+
+      def exit_unless_valid_count(options)
+        unless options.count > 0
+          logger.error "Error: Specify a maximum book count greater than 0."
+          exit 127
+        end
+      end
+    end
+  end
+end

data/lib/klipbook/commands/export.rb

@@ -0,0 +1,50 @@
+module Klipbook
+  module Commands
+    class Export < Command
+      def run_command!(book_source, options)
+        exit_unless_valid_format(options)
+        exit_unless_valid_output_dir(options)
+
+        exporter(options).run!(
+          books: book_source.books,
+          force: options.force,
+          output_dir: options.output_dir
+        )
+      end
+
+      private
+
+      def exporter(options)
+        case options.format
+        when  "markdown"
+          Exporters::MarkdownExporter.new(logger)
+        when "html"
+          Exporters::HTMLExporter.new(logger)
+        when "json"
+          Exporters::JSONExporter.new(logger)
+        else
+          raise "Unexpected format"
+        end
+      end
+
+      def exit_unless_valid_format(options)
+        unless ["markdown", "html", "json"].include?(options.format)
+          logger.error "Error: You must specify a valid format."
+          exit 127
+        end
+      end
+
+      def exit_unless_valid_output_dir(options)
+        unless options.output_dir
+          logger.error "Error: Please specify an outdir."
+          exit 127
+        end
+
+        unless File.directory?(options.output_dir)
+          logger.error "Error: Output directory '#{options.output_dir}' does not exist."
+          exit 127
+        end
+      end
+    end
+  end
+end

data/lib/klipbook/commands/exporters/exporter.rb

@@ -0,0 +1,49 @@
+module Klipbook
+  module Commands
+    module Exporters
+      class Exporter
+        def initialize(logger=Logger.new)
+          @logger = logger
+        end
+
+        def run!(books:, force:, output_dir:)
+          @logger.info "Using output directory: #{output_dir}"
+
+          books.each do |book|
+            export_book(book, output_dir, force)
+          end
+        end
+
+        private
+
+        def export_book(book, output_dir, force)
+          filename = filename_for_book(book)
+          filepath = File.join(output_dir, filename)
+
+          if !force && File.exist?(filepath)
+            @logger.info "- Skipping #{filename}"
+            return
+          end
+
+          @logger.info "+ Writing #{filename}"
+
+          File.open(filepath, 'w') do |f|
+            f.write render_contents(book)
+          end
+        end
+
+        def render_contents(book)
+          raise "Implement me"
+        end
+
+        def extension
+          raise "Implement me"
+        end
+
+        def filename_for_book(book)
+          "#{book.title.gsub(/[:,\/!?]/, "")}.#{extension}"
+        end
+      end
+    end
+  end
+end

data/lib/klipbook/{tohtml → commands/exporters}/html_book_summary.erb

@@ -132,7 +132,7 @@
     <div class="clearfix"></div>
 
     <ul>
-      <% clippings.each do |clipping| %>
+      <% sorted_clippings.each do |clipping| %>
         <% unless clipping.text.blank? %>
         <li class="<%= clipping.type %>">
           <p>

data/lib/klipbook/commands/exporters/html_exporter.rb

@@ -0,0 +1,25 @@
+module Klipbook
+  module Commands
+    module Exporters
+      class HTMLExporter < Exporter
+        def initialize(pretty_printer=Html::Printer.new, logger=Logger.new)
+          super(logger)
+          @pretty_printer = pretty_printer
+        end
+
+        def render_contents(book)
+          ERB.new(template, 0, '%<>').result(book.get_binding)
+        end
+
+        def extension
+          "html"
+        end
+
+        def template
+          @template ||= File.read(File.join(File.dirname(__FILE__), 'html_book_summary.erb'))
+        end
+      end
+    end
+  end
+end
+

data/lib/klipbook/commands/exporters/json_exporter.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+module Klipbook
+  module Commands
+    module Exporters
+      class JSONExporter < Exporter
+        def render_contents(book)
+          JSON.pretty_generate(book)
+        end
+
+        def extension
+          "json"
+        end
+      end
+    end
+  end
+end

data/lib/klipbook/commands/exporters/markdown_book_summary.erb

@@ -0,0 +1,12 @@
+# <%= title %>
+
+<% unless author.blank? %>
+*by <%= author %>*
+<% end %>
+
+<% sorted_clippings.each do |clipping| %>
+  <% unless clipping.text.blank? %>
+<%= clipping.text %> <%= location_markdown(clipping.location) %>
+
+  <% end %>
+<% end %>

data/lib/klipbook/commands/exporters/markdown_exporter.rb

@@ -0,0 +1,19 @@
+module Klipbook
+  module Commands
+    module Exporters
+      class MarkdownExporter < Exporter
+        def render_contents(book)
+          ERB.new(template, 0, '%<>').result(book.get_binding)
+        end
+
+        def extension
+          "md"
+        end
+
+        def template
+          @template ||= File.read(File.join(File.dirname(__FILE__), 'markdown_book_summary.erb'))
+        end
+      end
+    end
+  end
+end