kindle-highlights 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8965c4c6a5c1a03d4995b880216b34bd7eaa7689
-  data.tar.gz: 2b8d217f0bef63038fb22aea5a58b4aaf6cfa9f1
+  metadata.gz: e4ba7bab3c883c076439b271b56f106f8c03335d
+  data.tar.gz: f6f0cc0fbf202a3771a0f2ccc22fc9375ab1cc72
 SHA512:
-  metadata.gz: 3071f361fb4c0d03daefbad09800cabae12638776ef1725df0dea8b7aac8d7ecffd33f8d43a8f3643a96051bd0a2bbe75210f3f91a11015528172b58e9c01277
-  data.tar.gz: 71988265df7a3cb976dcd1dec09144bad05c4b3b3cc906c919bd39376763be02e9df262a92015d62ff510ecbdf4e2ae96f5e649969952910f0970431c73d52fe
+  metadata.gz: 72200505594865df64726113c90263a8033591126b5c7e74099e88b1576513522fa83a28dbd277b29de7789d3f12c21e34770e45e96638e49cdc8cca15835ba0
+  data.tar.gz: dbb58e9d60ff449202d95561eda889f9b283ac64248b42800f2d7373d5d6e20a168a45b07f93ffeaa175be89a613fddeff6e0b33b798e1efe6567fb58d11df52

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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 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/lib/kindle_highlights/book.rb

@@ -0,0 +1,56 @@
+module KindleHighlights
+  class Book
+    attr_accessor :asin, :author, :title
+
+    def self.from_html_elements(html_element:, mechanize_agent:)
+      new(
+        mechanize_agent: mechanize_agent,
+        asin: html_element.attributes["id"].value.squish,
+        title: html_element.children.search("h2").first.text.squish,
+        author: html_element.children.search("p").first.text.split(":").last.strip.squish
+      )
+    end
+
+    def initialize(asin:, author:, title:, mechanize_agent: nil)
+      @asin = asin
+      @author = author
+      @title = title
+      @mechanize_agent = mechanize_agent
+    end
+
+    def to_s
+      "#{title} by #{author}"
+    end
+
+    def inspect
+      "<#{self.class}: #{inspectable_vars}>"
+    end
+
+    def highlights_from_amazon
+      return [] unless mechanize_agent.present?
+
+      @highlights ||= fetch_highlights_from_amazon
+    end
+
+    private
+
+    attr_reader :mechanize_agent
+
+    def fetch_highlights_from_amazon
+      mechanize_agent
+        .get("https://read.amazon.com/kp/notebook?captcha_verified=1&asin=#{asin}&contentLimitState=&")
+        .search("div#kp-notebook-annotations")
+        .children
+        .select { |child| child.name == "div" }
+        .select { |child| child.children.search("div.kp-notebook-highlight").first.present? }
+        .map    { |html_elements| Highlight.from_html_elements(book: self, html_elements: html_elements) }
+    end
+
+    def inspectable_vars
+      instance_variables
+        .select { |ivar| ivar != :@mechanize_agent }
+        .map    { |ivar| "#{ivar}=#{instance_variable_get(ivar).inspect}" }
+        .join(", ")
+    end
+  end
+end

data/lib/kindle_highlights/client.rb

@@ -2,14 +2,20 @@ module KindleHighlights
   class Client
     class CaptchaError < StandardError; end
     class AuthenticationError < StandardError; end
+    class AsinNotFoundError < StandardError; end
 
-    attr_writer :mechanize_agent
-    attr_accessor :kindle_logged_in_page
+    KINDLE_LOGIN_PAGE      = "https://read.amazon.com/notebook"
+    SIGNIN_FORM_IDENTIFIER = "signIn"
+    MAX_AUTH_RETRIES       = 2
+
+    attr_writer :mechanize_agent, :kindle_logged_in_page
 
     def initialize(email_address:, password:, mechanize_options: {})
-      @email_address     = email_address
-      @password          = password
+      @email_address = email_address
+      @password = password
       @mechanize_options = mechanize_options
+      @retries = 0
+      @kindle_logged_in_page = nil
     end
 
     def books
@@ -17,35 +23,46 @@ module KindleHighlights
     end
 
     def highlights_for(asin)
-      conditionally_sign_in_to_amazon
+      if book = books.detect { |book| book.asin == asin }
+        book.highlights_from_amazon
+      else
+        raise AsinNotFoundError, "Book with ASIN #{asin} not found."
+      end
+    end
 
-      cursor     = 0
-      highlights = []
+    private
 
-      loop do
-        # This endpoint includes a `hasMore` field. Unfortunately at the time of this writing is always `false`.
-        page  = mechanize_agent.get("https://kindle.amazon.com/kcw/highlights?asin=#{asin}&cursor=#{cursor}&count=#{BATCH_SIZE}")
-        items = JSON.parse(page.body).fetch("items", [])
+    attr_accessor :email_address, :password, :mechanize_options
+    attr_reader :kindle_logged_in_page
 
-        break unless items.any?
+    def mechanize_agent
+      @mechanize_agent ||= initialize_mechanize_agent
+    end
 
-        highlights.concat(items)
-        cursor += BATCH_SIZE
+    def initialize_mechanize_agent
+      mechanize_agent = Mechanize.new
+      mechanize_agent.user_agent_alias = Mechanize::AGENT_ALIASES.keys.grep(/\A(Linux|Mac|Windows)/).sample
+      mechanize_agent.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      mechanize_options.each do |mech_attr, value|
+        mechanize_agent.send("#{mech_attr}=", value)
       end
-      highlights
+      mechanize_agent
     end
 
-    private
+    def load_books_from_kindle_account
+      conditionally_sign_in_to_amazon
 
-    attr_accessor :email_address, :password, :mechanize_options
+      kindle_library.map do |book|
+        unless book.attributes["id"].blank?
+          Book.from_html_elements(html_element: book, mechanize_agent: mechanize_agent)
+        end
+      end.compact
+    end
 
     def conditionally_sign_in_to_amazon
-      if @kindle_logged_in_page.nil?
-        signin_page            = mechanize_agent.get(KINDLE_LOGIN_PAGE)
-        signin_form            = signin_page.form(SIGNIN_FORM_IDENTIFIER)
-        signin_form.email      = email_address
-        signin_form.password   = password
-        post_signin_page       = mechanize_agent.submit(signin_form)
+      if login?
+        post_signin_page = login_via_mechanize
 
         if post_signin_page.search("#ap_captcha_img").any?
           resolution_url = post_signin_page.link_with(text: /See a new challenge/).resolved_uri.to_s
@@ -57,41 +74,32 @@ module KindleHighlights
           @kindle_logged_in_page = post_signin_page
         end
       end
+    rescue AuthenticationError
+      retry unless too_many_retries?
     end
 
-    def load_books_from_kindle_account
-      conditionally_sign_in_to_amazon
-
-      books           = {}
-      highlights_page = mechanize_agent.click(kindle_logged_in_page.link_with(text: /Your Books/))
-
-      loop do
-        highlights_page.search(".//td[@class='titleAndAuthor']").each do |book|
-          asin_and_title_element = book.search("a").first
-          asin                   = asin_and_title_element.attributes.fetch("href").value.split("/").last
-          title                  = asin_and_title_element.inner_html
-          books[asin]            = title
-        end
+    def kindle_library
+      @kindle_library ||= @kindle_logged_in_page.search("div#kp-notebook-library").children
+    end
 
-        break if highlights_page.link_with(text: /Next/).nil?
-        highlights_page = mechanize_agent.click(highlights_page.link_with(text: /Next/))
-      end
-      books
+    def login_via_mechanize
+      signin_page = mechanize_agent.get(KINDLE_LOGIN_PAGE)
+      signin_form = signin_page.form(SIGNIN_FORM_IDENTIFIER)
+      signin_form.email = email_address
+      signin_form.password = password
+      mechanize_agent.submit(signin_form)
     end
 
-    def mechanize_agent
-      @mechanize_agent ||= initialize_mechanize_agent
+    def login?
+      @kindle_logged_in_page.blank?
     end
 
-    def initialize_mechanize_agent
-      mechanize_agent                        = Mechanize.new
-      mechanize_agent.user_agent_alias       = 'Windows Mozilla'
-      mechanize_agent.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    def too_many_retries?
+      retry! == MAX_AUTH_RETRIES
+    end
 
-      mechanize_options.each do |mech_attr, value|
-        mechanize_agent.send("#{mech_attr}=", value)
-      end
-      mechanize_agent
+    def retry!
+      retries += 1
     end
   end
 end

data/lib/kindle_highlights/highlight.rb

@@ -0,0 +1,23 @@
+module KindleHighlights
+  class Highlight
+    attr_accessor :asin, :text, :location
+
+    def self.from_html_elements(book:, html_elements:)
+      new(
+        asin: book.asin,
+        text: html_elements.children.search("div.kp-notebook-highlight").first.text.squish,
+        location: html_elements.children.search("input#kp-annotation-location").first.attributes["value"].value,
+      )
+    end
+
+    def initialize(asin:, text:, location:)
+      @asin = asin
+      @text = text
+      @location = location
+    end
+
+    def to_s
+      text
+    end
+  end
+end

data/lib/kindle_highlights.rb

@@ -1,10 +1,8 @@
 require 'rubygems'
 require 'mechanize'
-require 'json'
-require 'kindle_highlights/client'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/filters'
 
-module KindleHighlights  
-  KINDLE_LOGIN_PAGE      = "http://kindle.amazon.com/login"
-  SIGNIN_FORM_IDENTIFIER = "signIn"
-  BATCH_SIZE             = 200
-end
+require_relative './kindle_highlights/client'
+require_relative './kindle_highlights/book'
+require_relative './kindle_highlights/highlight'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kindle-highlights
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Farkas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.2
+        version: 2.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.2
+        version: 2.7.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +66,31 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Until there is a Kindle API, this will suffice.
 email: eric@prudentiadigital.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - lib/kindle_highlights.rb
+- lib/kindle_highlights/book.rb
 - lib/kindle_highlights/client.rb
+- lib/kindle_highlights/highlight.rb
 homepage: https://github.com/speric/kindle-highlights
 licenses:
 - MIT
@@ -94,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Kindle highlights
 test_files: []
-has_rdoc: