kindle 0.1.3 → 0.7.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fafc93d8eb10c2b27dec751b4a5f846b460cd02
-  data.tar.gz: 5c42068c457ea86d97b8047f11aa17ec9a53d058
+  metadata.gz: d76fcf6266ee2a160164f3ca599d53145d5f388f
+  data.tar.gz: ca81d7a57bddd7cc8e81b3e791c5a980630bcf34
 SHA512:
-  metadata.gz: 60060ece4b26901906d818bae5fb85e9a784db63b4c8695ac1fe91aabe704d4b38259569891bf9375f736a93bd592a923684955d6c91dad05e3c9c8f1a54fc93
-  data.tar.gz: 513db19d90ee37e3bd126d636a84c4269bece90b8090c0719f88f60298e08dea551a7b7e60bdec809cd98b1b1ecb363c1ea89c12db40dd31f76533eb76b869fc
+  metadata.gz: 48e50e8d8785f1df6bce208a8fb900f1c6626e647555859273dfef0ff2f13d1879dcaee3fc00b1e34297b8f8bc5633d21dd6af368c87e24f7105049c188c15aa
+  data.tar.gz: 52e20c55f7294702607df3af0b77573d35149b0ff5a11d0904440edc93b0f5a5448367a77d0d31df5e5985f091a04afec61c063a653f3dc886eafdafea0e8570

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.env

data/CHANGELOG.adoc

@@ -0,0 +1,44 @@
+= CHANGELOG
+
+:numbered!:
+
+== Version 0.7
+
+* Major refactor and feature additions
+
+Features:
+
+* Allow specification of output type
+* cache results
+* handle Captcha issue
+* add proper tests via MiniTest and Cucumber
+
+== Version 0.2.1
+
+* Add Code of Conduct
+* Use Asciidoc for files (README, CODE_OF_CONDUCT, CHANGELOG)
+
+== Version 0.1.2
+
+* Also retrieve the highlight annotation_id
+
+== Version 0.1.1
+
+* Fix renamed file require
+
+== Version 0.1.0
+
+* Confirm the script still works as of 2014-04-10
+* Make the default command line output semi-colon delimited
+
+== Version 0.0.3
+
+* Update headers in requests to get pages of highlights
+
+== Version 0.0.2
+
+* Use highline to read command line information
+
+== Version 0.0.1
+
+* Initial working version

data/CODE_OF_CONDUCT.adoc

@@ -0,0 +1,73 @@
+= Contributor Covenant Code of Conduct
+
+:numbered!:
+
+== Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+== Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+== Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+== Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@kizmeta.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+== Attribution
+
+This Code of Conduct is adapted from the link:http://contributor-covenant.org[Contributor Covenant], version 1.4,
+available at http://contributor-covenant.org/version/1/4

data/Gemfile

@@ -1,4 +1,16 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in kindle.gemspec
-gemspec
+# gem "gli"
+# gem "sqlite3"
+# gem "activerecord", "~>5.0.0"
+# gem "nokogiri"
+# gem "mechanize"
+# gem "rainbow"
+# gem "pry"
+
+group :test, :development do
+  gem "cucumber", '~> 2'
+  gem "aruba"
+  gem "timecop"
+  gem 'cucumber-timecop', require: false
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Matt Petty
+Copyright (c) 2012-2016 Matt Petty
 
 MIT License
 

data/README.adoc

@@ -0,0 +1,180 @@
+= Kindle Highlights for the Command Line
+:author: Matt Petty <matt@kizmeta.com>
+:copyright: 2016
+
+:numbered!:
+
++++
+<img src="http://link.nx.is/sWdP.png" style="float:right;width:40%" />
++++
+
+== What is this?
+
+The kindle highlights app gives **YOU** your kindle highlights without the poor interface Amazon has wrapped around _YOUR DATA_.
+
+If you are like me, you make a lot of highlights while you read ebooks. I mark vocab words, great phrases, and inspirational sections.
+
+The kindle command empowers you to actually _DO_ something with all those highlights you've been making on your Kindle and Kindle apps. The app downloads and caches your highlights. You can then get them in various formats like JSON, CSV, and a nice little Markdown format to run through pandoc or Marked app.
+
+**Specifically, you can:**
+
+* scrape and parse your kindle highlights and book data
+* keep your highlights stored _**locally**_
+* output in JSON format
+* output in CSV format
+* output in Markdown format
+* do sophisticated queries on your data using the `kindle console`
+
+**Future plans:**
+
+* automatic scanning for vocabulary words
+* output in other formats
+
+// TODO. What is this and why do you want to use it?
+
+== Installation
+
+```sh
+gem install kindle
+```
+
+There are a lot of dependencies (including the latest Rails ActiveRecord v5), as this app is intended to provide a lot of conveniences and functionality over other lighter link:https://github.com/speric/kindle-highlights[libraries] like from our friend link:https://github.com/speric[@speric]! :heart:
+
+== Usage:
+
+=== Warnings and Caveats (HACKER ALERT)
+
+image::http://i.perezhilton.com/wp-content/uploads/2014/12/hackers.gif[width="100%"]
+
+Let's talk about passwords and security. Using the kindle command line app gives you the convenience to save your Amazon credentials in a file on your computer. This is probably bad. **Don't do it**. You've been warned.
+
+Hax0rz *will* hack.
+
+If, however, you intend to keep your password out of the settings file, you'll need to pass in the `--password=<secret>` argument every time. **Again: Be Forewarned**: Your shell is probably configured by default to save a history of what you type in. For that reason, you should be using something like the `zsh` option link:http://zsh.sourceforge.net/Doc/Release/Options.html[`HIST_IGNORE_SPACE`] to _"hide"_ your most-secretest commands.
+
+---
+
+=== Step 1: Initialization
+
+==== kindle init
+
+First you need to initialize the app with some default and/or customized settings, as well as create the database to store your highlights.
+
+To initialize and save your password and username:
+
+```sh
+# Option 1
+kindle --username=change@your.email --password=yoursecret init
+```
+
+**OR**
+
+To initialize with just a username:
+
+```sh
+# Option 2
+kindle --username=change@your.email init
+```
+
+**OR**
+
+Just run the `init` sub-command without any parameters, knowing you will just have to pass them in later. Every time.
+
+```sh
+# Option 3
+kindle init
+```
+
+
+---
+
+=== Step 2: Fetch your data
+
+==== kindle update
+
+The `update` sub-command uses either the passed in credentials or the saved credentials in the settings file and reaches out to Amazon's Kindle highlights website. It slurps all the highlights (and book info) and saves it in a SQLite3 database in `~/.kindle`.
+
+```sh
+kindle update
+```
+
+The `update` command will take a while to run, depending on how many highlights you have. Don't worry if it doesn't seem to do anything. That's okay. Trust in the UNIX-way.
+
+---
+
+=== Step 3: Output your data
+
+==== kindle highlights
+
+The `highlights` sub-command requires a third command to generate the appropriate output. Currently the available output formats are: JSON, CSV, and Markdown.
+
+Example with JSON:
+
+```sh
+# Output in json format and redirect to highlights.json file
+kindle highlights json > highlights.json
+```
+
+Example with CSV:
+
+
+```sh
+# Output in csv format and redirect to highlights.csv file
+kindle highlights csv > highlights.csv
+```
+
+Example with Markdown:
+
+```sh
+# Output in markdown format and redirect to highlights.md file
+kindle highlights markdown > highlights.md
+```
+
+---
+
+== Advanced Topic: The Console
+
+image::http://link.nx.is/1hbw6.png[]
+
+I've also included a `console` command for those of you familiar with Ruby on Rails, irb, etc. Issuing the `kindle console` command will open a console session with two ActiveRecord objects: `Book` and `Highlight`. These are real ActiveRecord v5.0 models pointing to the database of highlights.
+
+image:http://link.nx.is/Qesb.png[width="100%"]
+
+`kindle console` examples:
+
+```ruby
+
+Kindle :) Book.count
+=> 45
+
+Kindle :) Highlight.count
+=> 587
+
+Kindle :) Highlight.first
+=> #<Kindle::Models::Highlight:0x007fd43a50ae90
+ id: 1,
+ highlight: "riparian",
+ amazon_id: nil,
+ book_id: 1,
+ created_at: 2016-07-01 00:18:32 UTC,
+ updated_at: 2016-07-01 00:18:32 UTC>
+
+Kindle :) Book.first
+=> #<Kindle::Models::Book:0x007fd43a591800
+ id: 1,
+ asin: "B004J4WN0I",
+ title: "Hounded (with two bonus short stories): The Iron Druid Chronicles, Book One",
+ author: "by Kevin Hearne",
+ highlight_count: 8,
+ created_at: 2016-07-01 00:18:32 UTC,
+ updated_at: 2016-07-01 00:18:32 UTC>
+
+```
+
+
+== Endcap
+
+In case you are too lazy to open the LICENSE file, just FYI this is all MIT licensed.
+
+
+(C) 2012-2016 Matt Petty link:https://github.com/lodestone[@lodestone]

data/bin/kindle

@@ -1,21 +1,4 @@
 #!/usr/bin/env ruby
-
 require_relative "../lib/kindle"
-require 'highline/import'
-
-login = ask("Enter your Amazon.com username:  ") { |q| q.echo = true } unless login = ARGV[0]
-passwd = ask("Enter your Amazon.com password (This is not stored):  ") { |q| q.echo = "*" }
-
-begin
-  k = Kindle::Highlights.new(:login => login, :password => passwd)
-  puts "Getting your kindle highlights..."
-  highlights = k.fetch_highlights # TODO: Pass in something to bide our time
-  # TODO: Multiple output formats. CSV, JSON, Pretty, HTML?
-  highlights.each do |highlight|
-    puts "#{highlight.asin};#{highlight.title};#{highlight.author};#{highlight.highlight}"
-  end
-rescue => ex
-  # TODO Actually handle this!
-  puts ex
-  puts "Crud, something went wrong..."
-end
+require_relative "../lib/kindle/cli"
+# Nothing to see here...

data/features/highlights.feature

@@ -0,0 +1,117 @@
+Feature: Kindle Highlights
+
+  In order to make highlighting in ebooks more useful
+  As an Amazon user who highlights content via Kindle or Kindle app
+  I want to get and interact with my kindle highlights via the command line
+
+  Scenario: Default run without parameters should show help
+    Given I successfully run `kindle`
+    Then the output should contain:
+    """
+    kindle [global options] command [command options] [arguments...]
+    """
+
+  Scenario: When calling help
+    Given I successfully run `kindle help`
+    Then the output should contain:
+    """
+    kindle [global options] command [command options] [arguments...]
+    """
+
+  Scenario: `kindle init`
+
+  Scenario: `kindle update`
+
+  Scenario: `kindle highlights json` should do something
+    Given time is frozen
+    And a database exists
+    And a file named "~/.kindle/kindlerc.yml" with:
+    """
+    ---
+    :version: false
+    :help: false
+    :username: me@my.email
+    :password: secret
+    :domain: amazon.com
+    commands:
+      :_doc: {}
+      :initdb: {}
+      :init: {}
+      :highlights:
+        commands:
+          :update: {}
+          :json: {}
+          :csv: {}
+          :markdown: {}
+      :console: {}
+    """
+    When I run `kindle highlights json`
+    Then the output should match:
+    """
+    [.*\"Reach for enlightenment".*"Zen".*]
+    """
+    And the features should all pass
+
+  Scenario: `kindle highlights csv`
+    Given time is frozen
+    And a database exists
+    And a file named "~/.kindle/kindlerc.yml" with:
+    """
+    ---
+    :version: false
+    :help: false
+    :username: me@my.email
+    :password: secret
+    :domain: amazon.com
+    commands:
+      :_doc: {}
+      :initdb: {}
+      :init: {}
+      :highlights:
+        commands:
+          :update: {}
+          :json: {}
+          :csv: {}
+          :markdown: {}
+      :console: {}
+    """
+    When I run `kindle highlights csv`
+    Then the output should match:
+    """
+    .*"Reach for enlightenment","Zen",.*
+    """
+    And the features should all pass
+
+  Scenario: `kindle highlights markdown`
+    Given time is frozen
+    And a database exists
+    And a file named "~/.kindle/kindlerc.yml" with:
+    """
+    ---
+    :version: false
+    :help: false
+    :username: me@my.email
+    :password: secret
+    :domain: amazon.com
+    commands:
+      :_doc: {}
+      :initdb: {}
+      :init: {}
+      :highlights:
+        commands:
+          :update: {}
+          :json: {}
+          :csv: {}
+          :markdown: {}
+      :console: {}
+    """
+    When I run `kindle highlights markdown`
+    Then the output should match:
+    """    
+    ### Zen by Monk
+
+    > Reach for enlightenment
+    """
+    And the features should all pass
+
+  Scenario: `kindle console`