kindle-notebook 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2140c0eb8f9baa719a922a97273ec8ded43b91e06b426b591060cf3c748d7b2a
-  data.tar.gz: 02f8eb3c8769aaaa367f67a470817f0d9898fc5c48bcefd564ef5fdf63c1f174
+  metadata.gz: fdf9f8aae86d86694218ea71a942afad7dc5867970b79671f0dede3372bdb5ee
+  data.tar.gz: 6a132ae2b4b7291693c0e72992cb02b59248a908fdb0ded0fd220a6c20de2646
 SHA512:
-  metadata.gz: 25872df3af96a21ddc6452112483d3010a6c4e3c6668aa684ac3e706baff891bd01786275de7489b389bd120bd1aaecf9df87eaf4354dfed308cd59d8163b383
-  data.tar.gz: 9425897ec0a94e74774d3c81967ee10bb547e4292b116c88613675845111e418a2ebc182a7b7c01e3ad5b711fa0fbc1c6bc8279c2a78b0ee533d3cddf851f83d
+  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.3.0)
+    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,6 +18,24 @@ 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
 
 Sign in:
@@ -76,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/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,15 +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
 
-  class << self
-    attr_accessor :configuration, :session
+  class Configuration
+    attr_accessor :url, :login, :password, :selenium_driver, :headless_mode, :min_highlight_words,
+                  :max_highlight_words
 
-    def configure
-      self.configuration ||= Configuration.new
-      yield(configuration)
+    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_writer :configuration
+    attr_accessor :session
+  end
+
+  def self.configuration
+    @configuration ||= KindleNotebook::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/kindle_notebook/amazon_auth.rb

@@ -10,7 +10,7 @@ module KindleNotebook
     def sign_in
       session.visit(KindleNotebook.configuration.url)
       if valid_cookies?
-        puts 'Session restored!'
+        puts "Session restored!"
         return session
       end
 

data/lib/kindle_notebook/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kindle-notebook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bianca Vieira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-24 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara