kindle-notebook 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bec53d52818fd1e01eb99bba9b302edf0cf2b9b688f64224f1d624ac785f86ff
-  data.tar.gz: 7dcc6e513cb7c1f62abee9607f34fbfd488d6925458fe7c051e67abfd4604bfd
+  metadata.gz: fdf9f8aae86d86694218ea71a942afad7dc5867970b79671f0dede3372bdb5ee
+  data.tar.gz: 6a132ae2b4b7291693c0e72992cb02b59248a908fdb0ded0fd220a6c20de2646
 SHA512:
-  metadata.gz: 69f552342621a69d601ddea394b2c7ab3c85934d92d363b5c8fbeac9d7c6dbf008afa68d249892d17b32e8542ab7d5100c6efcfdd132fd0444941e550844abe5
-  data.tar.gz: 7c525530ddfefea76be5b3c88bcce5a936858e80b118c7d9d92a22429b9cc4aac45b371791c9df16327f47be7d75d31c50c238c7e39f8d450094dd0f9fc9fa8f
+  metadata.gz: ab04dbcf4e7e721f8bd5f2f85b879998ca6f235b8485e55b82d3ab07a8273bf90740f14f9d40a6c064c2ecab136e64a5294138e0d54c6411633390456db69ae4
+  data.tar.gz: 15b4d1b7ab4d83bcb98d7b092734ae3d617ae7b4da6c9b3d08c32c2caadd79fadd10768d5334cbb29fd6e0b4794ee14d38b3dcfff3fd0bb85b4832b0621e523f

data/.rubocop.yml

@@ -9,6 +9,15 @@ Naming/FileName:
   Exclude:
     - lib/kindle-notebook.rb
 
+RSpec/ExampleLength:
+  Max: 7
+
+RSpec/MultipleExpectations:
+  Max: 7
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
+
 Style/Documentation:
   Enabled: false
 

data/Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in kindle-notebook.gemspec
 gemspec
 
+gem "puffing-billy", "~> 3.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kindle-notebook (0.2.1)
+    kindle-notebook (0.3.1)
       capybara (~> 3.39)
       capybara-sessionkeeper (~> 0.2.0)
       selenium-webdriver (~> 4.9)
@@ -25,12 +25,27 @@ GEM
       capybara
       selenium-webdriver
     coderay (1.1.3)
+    cookiejar (0.3.3)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
+    em-http-request (1.1.7)
+      addressable (>= 2.3.4)
+      cookiejar (!= 0.3.1)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0)
+    em-socksify (0.3.2)
+      eventmachine (>= 1.0.0.beta.4)
+    em-synchrony (1.0.6)
+      eventmachine (>= 1.0.0.beta.1)
+    eventmachine (1.2.7)
+    eventmachine_httpserver (0.2.1)
+    http_parser.rb (0.6.0)
     json (2.6.3)
     matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
+    multi_json (1.15.0)
     nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
@@ -40,6 +55,14 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
+    puffing-billy (3.1.0)
+      addressable (~> 2.5)
+      em-http-request (~> 1.1, >= 1.1.0)
+      em-synchrony
+      eventmachine (~> 1.2)
+      eventmachine_httpserver
+      http_parser.rb (~> 0.6.0)
+      multi_json
     racc (1.6.2)
     rack (3.0.7)
     rack-test (2.1.0)
@@ -98,6 +121,7 @@ DEPENDENCIES
   dotenv (~> 2.8, >= 2.8.1)
   kindle-notebook!
   pry (~> 0.14.2)
+  puffing-billy (~> 3.1)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -18,12 +18,37 @@ If bundler is not being used to manage dependencies, install the gem by executin
 $ gem install kindle-notebook
 ```
 
+## Configuration
+
+You can either create a `.env` file and add your credentials, the default values will be fetched from this file, or configure the gem, for example in an initializer file.
+
+```rb
+KindleNotebook.configure do |config|
+  config.url = "https://read.amazon.com/"
+  config.login = ENV["AMAZON_EMAIL"]
+  config.password = ENV["AMAZON_PASSWORD"]
+  config.selenium_driver = :firefox
+  config.headless_mode = false
+  config.min_highlight_words = 1
+  config.max_highlight_words = 3
+end
+```
+
+The configuration options `min_highlight_words` and `max_highlight_words` determine the range for a highlight's word count. Highlights with a word count outside this range will not be considered will be filtered out.
+
 ## Usage
 
-To get the highlights from a book:
+Sign in:
 ```rb
-books = KindleNotebook::Client.books
-book = books.first.fetch_highlights
+client = KindleNotebook::Client.new
+client.sign_in
+```
+
+Get the highlights from a book:
+```rb
+books = client.books
+book = books.first
+book.fetch_highlights
 book.highlights
 ```
 
@@ -59,7 +84,7 @@ Highlight:
 Book CSV:
 ```csv
 text,page,context,book_asin,raw_text,raw_context
-journald,120,,B09FJ3411G,"journald,",
+journald,120,"If you get stuck, the logging component of systemd, called journald, can also help.",B09FJ3411G,"journald,","used, for example. If you get stuck, the logging component of systemd, called journald, can also help. This journald command displays the last 20 entries in the"
 swarm,225,"Docker Swarm In this chapter, you're going to learn how to create and use a Docker",B09FJ3411G,swarm.,"Docker Swarm In this chapter, you're going to learn how to create and use a Docker"
 ```
 
@@ -69,6 +94,19 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Testing
+
+This gem is using [puffing-billy](https://github.com/oesmith/puffing-billy) for testing which needs the geckodriver executable.  It can be installed with:
+```sh
+$ sudo apt-get install firefox-geckodriver # or
+$ brew install geckodriver
+```
+
+The executable should be in your `PATH`, if it is not you can run the following command (please adapt the location of the geckodriver executable with yours):
+```sh
+$ echo 'export PATH=$PATH:/home/user/.cache/selenium/geckodriver/linux64/0.33.0' >> ~/.zshrc
+ ```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/b1anca/kindle-notebook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/b1anca/kindle-notebook/blob/master/CODE_OF_CONDUCT.md).

data/kindle-notebook.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/kindle_notebook/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "kindle-notebook"
+  spec.version = KindleNotebook::VERSION
+  spec.authors = ["Bianca Vieira"]
+  spec.email = ["bncvr@outlook.com"]
+
+  spec.summary = "Kindle Notebook"
+  spec.description = "Fetch your Kindle Highlights along with their context using the Selenium Webdriver"
+  spec.homepage = "https://github.com/b1anca/kindle-notebook"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/b1anca/kindle-notebook"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "capybara", "~> 3.39"
+  spec.add_dependency "capybara-sessionkeeper", "~> 0.2.0"
+  spec.add_dependency "selenium-webdriver", "~> 4.9"
+
+  spec.add_development_dependency "dotenv", "~> 2.8", ">= 2.8.1"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/kindle-notebook.rb

@@ -4,6 +4,7 @@ require "capybara"
 require "capybara/sessionkeeper"
 require "csv"
 require "selenium-webdriver"
+require "dotenv"
 
 require_relative "kindle_notebook/amazon_auth"
 require_relative "kindle_notebook/book"
@@ -14,35 +15,36 @@ require_relative "kindle_notebook/highlights"
 require_relative "kindle_notebook/highlight"
 require_relative "kindle_notebook/version"
 
+Dotenv.load
+
 module KindleNotebook
   class Error < StandardError; end
 
-  Capybara.register_driver :chrome do |app|
-    options = Selenium::WebDriver::Chrome::Options.new
-    options.add_argument("--headless") if configuration.headless_mode
-    options.add_argument("--disable-gpu")
-    options.add_argument("--no-sandbox")
-
-    Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
-  end
-
-  Capybara.register_driver :firefox do |app|
-    options = Selenium::WebDriver::Firefox::Options.new
-    options.add_argument("--headless") if configuration.headless_mode
-
-    Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
+  class Configuration
+    attr_accessor :url, :login, :password, :selenium_driver, :headless_mode, :min_highlight_words,
+                  :max_highlight_words
+
+    def initialize
+      @url = ENV["KINDLE_READER_URL"]
+      @login = ENV["AMAZON_EMAIL"]
+      @password = ENV["AMAZON_PASSWORD"]
+      @selenium_driver = ENV["SELENIUM_DRIVER"]
+      @headless_mode = ENV["HEADLESS_MODE"] == "true"
+      @min_highlight_words = ENV["MIN_HIGHLIGHT_WORDS"].to_i
+      @max_highlight_words = ENV["MAX_HIGHLIGHT_WORDS"].to_i
+    end
   end
 
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
+    attr_accessor :session
+  end
 
-    def configure
-      self.configuration ||= Configuration.new
-      yield(configuration)
-    end
+  def self.configuration
+    @configuration ||= KindleNotebook::Configuration.new
+  end
 
-    def session
-      @session ||= AmazonAuth.new.sign_in
-    end
+  def self.configure
+    yield(configuration)
   end
 end

data/lib/kindle_notebook/amazon_auth.rb

@@ -2,52 +2,69 @@
 
 module KindleNotebook
   class AmazonAuth
-    def initialize
-      @auth_session = Capybara::Session.new(KindleNotebook.configuration.selenium_driver.to_sym)
+    def initialize(email:, password:)
+      @email = email
+      @password = password
     end
 
     def sign_in
-      auth_session.visit(KindleNotebook.configuration.url)
-      return auth_session if valid_cookies?
+      session.visit(KindleNotebook.configuration.url)
+      if valid_cookies?
+        puts "Session restored!"
+        return session
+      end
 
       submit_sign_in_form
-      auth_session.save_cookies
-      auth_session
+      submit_otp_form if mfa?
+      session.save_cookies
+      puts "You're signed in!"
     end
 
     private
 
-    attr_reader :auth_session
+    attr_reader :email, :password
+
+    def session
+      KindleNotebook.session
+    end
 
     def valid_cookies?
-      auth_session.find_latest_cookie_file
-      auth_session.restore_cookies
-      auth_session.refresh
-      auth_session.has_current_path?("/kindle-library")
+      session.find_latest_cookie_file
+      session.restore_cookies
+      session.refresh
+      session.has_current_path?("/kindle-library")
     end
 
     def submit_otp_form
       print "Enter OTP: "
-      mfa_code = gets.chomp
-      auth_session.fill_in("auth-mfa-otpcode", with: mfa_code)
-      auth_session.first("#auth-signin-button").click
+      otp = gets.chomp
+      session.fill_in("auth-mfa-otpcode", with: otp)
+      session.first("#auth-signin-button").click
+      check_errors
     end
 
     def submit_sign_in_form
-      auth_session.click_button("Sign in with your account", match: :first)
+      session.click_button("Sign in with your account", match: :first)
       fill_in_credentials
-      auth_session.check("rememberMe")
-      auth_session.first("#signInSubmit").click
-      submit_otp_form if mfa?
+      session.check("rememberMe")
+      session.first("#signInSubmit").click
+      check_errors
     end
 
     def fill_in_credentials
-      auth_session.fill_in("ap_email", with: KindleNotebook.configuration.login)
-      auth_session.fill_in("ap_password", with: KindleNotebook.configuration.password)
+      session.fill_in("ap_email", with: email)
+      session.fill_in("ap_password", with: password)
     end
 
     def mfa?
-      auth_session.current_path.match?(%r{ap/mfa})
+      session.current_path.match?(%r{ap/mfa})
+    end
+
+    def check_errors
+      return unless session.all("h4", text: "There was a problem").any?
+
+      message = session.all("div", class: "a-alert-content").map(&:text).join(", ") || "There was a problem"
+      raise StandardError, message
     end
   end
 end

data/lib/kindle_notebook/book.rb

@@ -31,8 +31,7 @@ module KindleNotebook
 
     def open_book
       session.visit(KindleNotebook.configuration.url) unless session.has_selector?("p", text: title)
-      session.find("p", text: title).click
-      sleep 3 # book might take a bit to load
+      session.find("p", text: title, wait: 3).click
     end
   end
 end

data/lib/kindle_notebook/client.rb

@@ -1,20 +1,64 @@
 # frozen_string_literal: true
 
 module KindleNotebook
-  module Client
-    class << self
-      def books
-        @books ||= fetch_books
+  class Client
+    attr_reader :session
+
+    def initialize(email: KindleNotebook.configuration.login,
+                   password: KindleNotebook.configuration.password,
+                   headless_mode: KindleNotebook.configuration.headless_mode,
+                   selenium_driver: KindleNotebook.configuration.selenium_driver)
+      @email = email
+      @password = password
+      @headless_mode = headless_mode
+      @selenium_driver = selenium_driver.to_sym
+      @session = new_capybara_session
+    end
+
+    def books
+      @books ||= fetch_books
+    end
+
+    def sign_in
+      AmazonAuth.new(password: password, email: email).sign_in
+    end
+
+    private
+
+    attr_reader :email, :password, :headless_mode, :selenium_driver
+
+    def fetch_books
+      session.find("ul#cover").all("li").map do |element|
+        Book.new(author: element.find("div", id: /author-/).text,
+                 title: element.find("div", id: /title-/).text,
+                 asin: element.find("div", match: :first)["data-asin"])
       end
+    end
+
+    def new_capybara_session
+      chrome_driver
+      firefox_driver
+
+      KindleNotebook.session = Capybara::Session.new(selenium_driver)
+    end
+
+    def firefox_driver
+      Capybara.register_driver :firefox do |app|
+        options = Selenium::WebDriver::Firefox::Options.new
+        options.add_argument("--headless") if headless_mode
+
+        Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
+      end
+    end
 
-      private
+    def chrome_driver
+      Capybara.register_driver :chrome do |app|
+        options = Selenium::WebDriver::Chrome::Options.new
+        options.add_argument("--headless") if headless_mode
+        options.add_argument("--disable-gpu")
+        options.add_argument("--no-sandbox")
 
-      def fetch_books
-        KindleNotebook.session.find("ul#cover").all("li").map do |element|
-          Book.new(author: element.find("div", id: /author-/).text,
-                   title: element.find("div", id: /title-/).text,
-                   asin: element.find("div", match: :first)["data-asin"])
-        end
+        Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
       end
     end
   end

data/lib/kindle_notebook/highlights.rb

@@ -29,7 +29,8 @@ module KindleNotebook
 
     # fetch all highlights (without context) from notebook
     def notebook_highlights
-      content = session.find("div", class: "notebook-content").all("ion-item")
+      notebook_content = session.all("div", class: "notebook-content")
+      content = notebook_content.any? ? notebook_content.first.all("ion-item") : []
       puts "#{content.count} highlights in this book \n"
       book.highlights_count = content.count
       content.map { |h| parse_notebook_highlight(h) }
@@ -82,7 +83,7 @@ module KindleNotebook
     end
 
     def show_toolbar
-      session.first(:xpath, "//ion-header", wait: 2).hover
+      session.first(:xpath, "//ion-header", wait: 3).hover
     end
 
     def search_highlight_context(text, page)

data/lib/kindle_notebook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KindleNotebook
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kindle-notebook
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Bianca Vieira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -103,8 +103,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- kindle_notebook-0.2.0.gem
-- kindle_notebook-0.2.1.gem
+- kindle-notebook.gemspec
 - lib/kindle-notebook.rb
 - lib/kindle_notebook/amazon_auth.rb
 - lib/kindle_notebook/book.rb