klipbook 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f132dad97344e2d4aa75b9ebdb0e10be4e983e8e
-  data.tar.gz: f38310d3b68338bc0f4f2b033ec4da4e5ba7388b
+  metadata.gz: 307a672f1458f7fc37543aaa4157b70bc247086d
+  data.tar.gz: 8c1586619868e3517043d4ec610165dd22802ef9
 SHA512:
-  metadata.gz: d9febc14521644a805b71423c7bd7a07964575ea3a5f4bc0631e087ef51c062a5729851ad39eac0c24285dc904f1690af0fdc6b9e82784dd5361a42dc5744c8e
-  data.tar.gz: 3ad42a80ada1ebd515e1fd8d20839276f43f43902376075466d092f6f0bedd47dbd8329d8e44529e22822842363cc85737b5521450f2c7934b4b0152c341deef
+  metadata.gz: f67d8ceefa6a239fb61c3df9319c5ab5aceb85474a4edb0520975ded47f3c7f5d33a38287c854dd57345e459c239c5bc5aa2554939268a9031ca86924313a84b
+  data.tar.gz: 195d8294a0d2fdbf8b6f176f6314b0f478eacac11c768c9965bdec4134e2afa088416722c904c4cf35ff2a2a5eab15010d63853c4cff4558bdf9e53b00b036f3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.3.1

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.3.1

data/CHANGELOG.txt

@@ -1,3 +1,14 @@
+== 3.0.0 / 2016-09-18
+
+* Feature Changes
+
+	* Added markdown as an export format.
+
+* Breaking changes
+
+	* Changed command flags to make things more consistent. 
+	* Changed JSON export to export into individual files rather than a single file. Again for consistency with other export formats.
+
 == 2.1.3 / 2014-07-25
 
 * Minor changes

data/Gemfile

@@ -1,16 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'slop', '~> 3.6'
-gem 'mechanize', '~> 2.7'
-
-group :development do
-  gem 'rspec', '~> 3.0'
-  gem 'jeweler', '~> 1.8'
-  gem 'pry-byebug', '~> 1.3'
-  gem 'cucumber', '~> 1.3'
-  gem 'aruba', '~> 0.6'
-  gem 'guard'
-  gem 'guard-rspec', '~> 4.3'
-  gem 'guard-cucumber', '~> 1.4'
-  gem 'terminal-notifier-guard', '~> 1.5'
-end
+gemspec

data/Gemfile.lock

@@ -1,149 +1,109 @@
+PATH
+  remote: .
+  specs:
+    klipbook (3.0.0)
+      commander
+      mechanize
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.3.6)
-    aruba (0.6.0)
-      childprocess (>= 0.3.6)
-      cucumber (>= 1.1.1)
-      rspec-expectations (>= 2.7.0)
+    aruba (0.14.2)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
     builder (3.2.2)
-    byebug (2.7.0)
-      columnize (~> 0.3)
-      debugger-linecache (~> 1.2)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    childprocess (0.5.3)
+    byebug (9.0.5)
+    childprocess (0.5.9)
       ffi (~> 1.0, >= 1.0.11)
-    coderay (1.1.0)
-    columnize (0.8.9)
-    cucumber (1.3.15)
+    coderay (1.1.1)
+    commander (4.4.0)
+      highline (~> 1.7.2)
+    contracts (0.14.0)
+    cucumber (2.4.0)
       builder (>= 2.1.2)
+      cucumber-core (~> 1.5.0)
+      cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12)
+      gherkin (~> 4.0)
       multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.1)
-    debugger-linecache (1.2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
+    cucumber-wire (0.0.1)
     diff-lcs (1.2.5)
-    domain_name (0.5.19)
+    domain_name (0.5.20160826)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    ffi (1.9.3)
-    formatador (0.2.5)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
-    git (1.2.7)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
-      hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
-      oauth2
-    guard (2.6.1)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-cucumber (1.4.1)
-      cucumber (>= 1.2.0)
-      guard (>= 1.1.0)
-    guard-rspec (4.3.1)
-      guard (~> 2.1)
-      rspec (>= 2.14, < 4.0)
-    hashie (3.2.0)
-    highline (1.6.21)
+    ffi (1.9.14)
+    gherkin (4.0.0)
+    highline (1.7.8)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
-    jeweler (1.8.8)
-      builder
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      github_api (= 0.10.1)
-      highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
-      rake
-      rdoc
-    json (1.8.1)
-    jwt (1.0.0)
-    listen (2.7.9)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    mechanize (2.7.3)
+    mechanize (2.7.5)
       domain_name (~> 0.5, >= 0.5.1)
       http-cookie (~> 1.0)
-      mime-types (~> 2.0)
+      mime-types (>= 1.17.2)
       net-http-digest_auth (~> 1.1, >= 1.1.1)
       net-http-persistent (~> 2.5, >= 2.5.2)
-      nokogiri (~> 1.4)
+      nokogiri (~> 1.6)
       ntlm-http (~> 0.1, >= 0.1.1)
       webrobots (>= 0.0.9, < 0.2)
     method_source (0.8.2)
-    mime-types (2.3)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
-    multi_xml (0.5.5)
-    multipart-post (1.2.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
+    multi_test (0.1.2)
     net-http-digest_auth (1.4)
     net-http-persistent (2.9.4)
-    nokogiri (1.5.10)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
     ntlm-http (0.1.1)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    pry (0.10.0)
+    pkg-config (1.1.7)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (1.3.3)
-      byebug (~> 2.7)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
       pry (~> 0.10)
-    rack (1.5.2)
     rake (10.3.2)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rdoc (4.1.1)
-      json (~> 1.4)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.3)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.3)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
     slop (3.6.0)
-    terminal-notifier-guard (1.5.3)
     thor (0.19.1)
-    timers (1.1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.6)
-    webrobots (0.1.1)
+    unf_ext (0.0.7.2)
+    webrobots (0.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0.6)
-  cucumber (~> 1.3)
-  guard
-  guard-cucumber (~> 1.4)
-  guard-rspec (~> 4.3)
-  jeweler (~> 1.8)
-  mechanize (~> 2.7)
-  pry-byebug (~> 1.3)
-  rspec (~> 3.0)
-  slop (~> 3.6)
-  terminal-notifier-guard (~> 1.5)
+  aruba
+  bundler
+  cucumber
+  klipbook!
+  pry-byebug
+  rake
+  rspec
+
+BUNDLED WITH
+   1.12.4

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2013 Ray Grasso
+The MIT License (MIT)
 
-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:
+Copyright (c) 2016 Ray Grasso
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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

@@ -3,118 +3,115 @@
 [![Build Status](https://travis-ci.org/grassdog/klipbook.png)](https://travis-ci.org/grassdog/klipbook)
 
 Klipbook takes the highlights and notes that you've created on your Kindle and
-outputs them into nice html or JSON.
+outputs them into nice HTML, Markdown, or JSON.
 
-## An example of a html clippings file generated by Klipbook
+## An example of a HTML clippings file generated by Klipbook
 
 <img src="https://github.com/grassdog/klipbook/raw/master/example.png" alt="Example
 of a clippings file" />
 
 ## What sources does it support?
 
-Klipbook can take your highlights from a clippings file off a physical Kindle device
-or from the [Kindle highlights site](https://kindle.amazon.com/your_highlights)
-itself.
+Klipbook can take your highlights from a clippings file off a physical Kindle device or from the [Kindle highlights site](https://kindle.amazon.com/your_highlights) itself.
 
-## When should I use the file and when should I use the site?
+### When should I use the file and when should I use the site?
 
-If your books are purchased from Amazon directly then use the site. The site is the
-canonical source and will contain all of your notes and highlights from across all of
-your Kindle devices and applications. Currently the Amazon highlights site only shows
-clippings for books you've purchased on Amazon.
+If your books are purchased from Amazon directly then use the site. The site is the canonical source and will contain all of your notes and highlights from across all of your Kindle devices and applications. Currently the Amazon highlights site only shows clippings for books you've purchased on Amazon.
 
-If your books are personal documents and you've read them on your Kindle device
-itself then you should use the file from that device as a source i.e. your Kindle
-device only keeps clippings that you made directly on it.
+If your books are personal documents and you've read them on your Kindle device itself then you should use the file from that device as a source i.e. your Kindle device only keeps clippings that you make directly on it.
 
 ## How does it work?
 
-Klipbook supports three commands: `list`, `tohtml`, and `tojson`.
+Klipbook supports two commands: `list` and `export`.
 
-### To HTML
+`list` shows the books in the specified source and `export` exports books to a different format.
 
-`tohtml` retrieves the clippings from your latest annotated books and writes them
-out into a pretty html file for each book.
+## Specifying an Input Source
 
-#### From a file
+Both commands require you to specify the source of your clippings.
 
-Copy your clippings file (called "My Clippings.txt" on a 3rd generation Kindle) from
-your Kindle device to your local drive via USB.
+### Reading from a clippings file
 
-Then write out a list of your clippings via:
+Copy your clippings file (called "My Clippings.txt" on a 3rd generation Kindle) from your Kindle device to your local drive via USB.
+
+Then specify the path to your clippings via:
 
 ```sh
-$ klipbook tohtml -i "My Clippings.txt"
+$ klipbook --from-file "My Clippings.txt"
 ```
 
-This command will write the collected clippings for the latest annotated book to a
-file in the current directory. You can override the output directory with the
-`--outdir` switch.
+### Reading from the highlights site
 
-You can also specify a maximum count of books you'd like collated with the
-`--number` switch.
+Specify your Amazon credentials to klipbook and it will scrape the site and output a clippings file.
 
-Klipbook will not overwrite an exiting file by default. You can change this with the
-`--force` flag.
+```sh
+$ klipbook --from-site my-username@blah.com:my-password
+```
 
-#### From the site
+Note that the scraping requires a network connection (obviously) and can take a while so please be patient.
 
-Specify your Amazon credentials to klipbook and it will scrape the site and
-output a clippings file.
+## List
+
+The `list` command lists the books available in the specified source.
 
 ```sh
-$ klipbook tohtml -c my-username@blah.com:my-password
+$ klipbook list --from-file "My Clippings.txt"
+
+Book list:
+[1] The Big Sleep by Raymond Chandler
+[2] How to jump out of a plane without a parachute and survive by Rip Rockjaw
 ```
 
-The same flags above apply.
+By default it will only list the latest book. This can be overrided with the `--count` switch.
 
-Note that the scraping requires a network connection (obviously) and can take a while
-so please be patient.
+## Export
 
-### Set up defaults
+`export` reads the clippings from your source and writes them out in the specified format.
 
-If you don't feel like having your Amazon credentials in your shell history you can
-set your default source in the klipbook rc file: `~/.klipbookrc`.
+You can specify the directory to export into with the `--output-dir` switch. This defaults to the current directory.
 
-This is simply a YAML file and you can specify default values for the source and the
-output directory, e.g.
+You can also specify a maximum number of books you'd like exported with the `--count` switch.
 
-```sh
-$ cat ~/.klipbookrc
+Klipbook will not overwrite an exiting file by default. You can change this with the `--force` flag.
 
-:credentials: my-username@blah.com:my-password
-:outdir: /path/to/my/default/output/directory
-```
+### Export to Html
 
-Command line options override the defaults stored in the rc file.
+You can export clippings into a pretty html file for each book.
+
+```sh
+$ klipbook export ---from-file "My Clippings.txt" --output-format html
+```
 
-### List
+### Export to JSON
 
-The `list` command lists the books available in the specified source.
+You can export clippings into a JSON file for each book.
 
 ```sh
-$ klipbook list -i "My Clippings.txt"
+$ klipbook export --from-file "My Clippings.txt" --output-format json
+```
 
-Book list:
-[1] The Big Sleep by Raymond Chandler
-[2] How to jump out of a plane without a parachute and survive by Rip Rockjaw
+### Export to Markdown
+
+You can export clippings into a markdown file for each book.
+
+```sh
+$ klipbook export --from-file "My Clippings.txt" --output-format markdown
 ```
 
-By default it will only list the latest book. This can be overrided with the
-`--number` switch.
+## Set defaults
 
-### To JSON
+If you don't feel like having your Amazon credentials in your shell history you can set your default source in the klipbook rc file: `~/.klipbookrc`.
 
-`tojson` pulls together the clippings from your latest annotated books and combines
-them into a single JSON file.
+This is a YAML file and you can specify default values for the source and the output directory (note the use of snake case) e.g.
 
 ```sh
-$ klipbook tojson -i "My Clippings.txt" -o books.json
+$ cat ~/.klipbookrc
+
+:from_site: my-username@blah.com:my-password
+:output_dir: /path/to/my/default/output/directory
 ```
 
-You can rerun tojson on an existing JSON file to add new books. By default existing
-books in the JSON file will not be overwritten. This can be changed with the `--force`
-flag.
+Command line options override the defaults stored in the rc file.
 
 ## Installation
 
@@ -126,19 +123,16 @@ $ gem install klipbook
 
 ## Supported Devices
 
-Klipbook has been tested on clippings files from 3rd generation Kindles and the
-Kindle Touch.
+Klipbook has been tested on clippings files from 3rd generation Kindles and the Kindle Touch.
 
 ## Tested platforms
 
-Klipbook has been tested on Mac OSX Mavericks using Ruby 2.1.2.
+Klipbook has been tested on Mac OS X El Capitan using Ruby 2.3.1.
 
 ## Contributing to Klipbook
 
-Fork the project on [Github](https://github.com/grassdog/klipbook), add tests for
-your changes, and submit a well described pull request.
+Fork the project on [Github](https://github.com/grassdog/klipbook), add tests for your changes, and submit a well described pull request.
 
 ## Copyright
 
-Copyright (c) 2014 Ray Grasso. See LICENSE.txt for further details.
-
+Copyright (c) 2016 Ray Grasso. See LICENSE.txt for further details.

data/Rakefile

@@ -1,40 +1,13 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler/setup'
-require 'rake'
-require './lib/klipbook/version.rb'
+require "bundler/gem_tasks"
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = 'klipbook'
-  gem.homepage = 'https://github.com/grassdog/klipbook'
-  gem.license = 'MIT'
-  gem.summary = %Q{Klipbook creates a nice html summary of the clippings you've created on your Kindle.}
-  gem.description = %Q{Process your Kindle clippings file to generate a nicely formatted compilation of the clippings of the books you've read}
-  gem.email = 'ray.grasso@gmail.com'
-  gem.authors = ['Ray Grasso']
-  gem.version = Klipbook::VERSION
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = Klipbook::VERSION
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "klipbook #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+require 'cucumber/rake/task'
 
 desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec)
 
-require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = '--format pretty --tags ~@slow'
 end