readwise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60dff970e4d8c8989265de5ff247010545019f0ca9f9f93f027726de8dda5755
+  data.tar.gz: 5c4ad097f466e5adf35424dc07f51d45865ea325d3fa455f17c8d0d2290fa6e7
+SHA512:
+  metadata.gz: 63f00184411add2fb4403ebf67cf1fcc89a677ec84826524a92be7fce52d46bf53d2a654db17d9f04e1a89eb15ac938e7ff6ebb861e0c2931ca1d65c1803f247
+  data.tar.gz: 301c9c0f4bf4a810bf62a2f1a2f116f56969535c71c7b4811192be20db1c9bdba71d74962252930f6d2e85b77bcffb1e29610f311fbffd03f07f6913fcb54514

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.1.0] - 2023-01-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## 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 email@andjosh.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 [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in readwise.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    readwise (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (10.5.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  readwise!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Josh Beckman
+
+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/README.md

@@ -0,0 +1,54 @@
+# Readwise
+
+[Readwise](https://readwise.io/) is an application suite to store, revisit, and learn from your book and article highlights. This is a basic library to call the [Readwise API](https://readwise.io/api_deets) to read and write highlights.
+
+This library is not at 100% coverage of the API, so if you need a method that is missing, open an issue or contribute changes!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'readwise'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install readwise
+
+## Usage
+
+First, obtain an API access token from https://readwise.io/access_token.
+
+```ruby
+client = Readwise::Client.new(token: token)
+
+books = client.export # export all highlights
+books = client.export(updated_after: '2023-01-01') # export recent highlights
+books = client.export(book_ids: ['123']) # export specific highlights
+
+puts books.first.title # books are Readwise::Book structs
+puts books.first.highlights.map(&:text) # highlights are Readwise::Highlight structs
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andjosh/readwise. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Readwise project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andjosh/readwise/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "readwise"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/readwise/book.rb

@@ -0,0 +1,44 @@
+require 'time'
+
+module Readwise
+  Book = Struct.new(
+    'ReadwiseBook',
+    :asin,
+    :author,
+    :book_id,
+    :category,
+    :cover_image_url,
+    :highlights,
+    :readable_title,
+    :readwise_url,
+    :source,
+    :source_url,
+    :tags,
+    :title,
+    :unique_url,
+    keyword_init: true
+  ) do
+
+    def article?
+      category == 'article'
+    end
+
+    def book?
+      category == 'book'
+    end
+
+    def supplemental?
+      category == 'supplemental'
+    end
+
+    def email_sourced?
+      !!source_url.match(/^mailto:/)
+    end
+
+    def highlighted_at_time
+      date = highlights.sort_by(&:highlighted_at).first&.highlighted_at_time
+      date ||= highlights.sort_by(&:updated_at).first&.updated_at_time
+      date || Time.now
+    end
+  end
+end

data/lib/readwise/client.rb

@@ -0,0 +1,95 @@
+require 'json'
+require 'net/http'
+require_relative 'book.rb'
+require_relative 'highlight.rb'
+
+module Readwise
+  class Client
+    class Error < StandardError; end
+
+    def initialize(token: nil)
+      raise ArgumentError unless token
+      @token = token.to_s
+    end
+
+    def create_highlight(highlight:)
+      create_highlights([highlight])
+    end
+
+    def create_highlights(highlights: [])
+      raise NotImplementedError
+    end
+
+    def export(updated_after: nil, book_ids: [])
+      resp = export_page(updated_after: updated_after, book_ids: book_ids)
+      next_page_cursor = resp[:next_page_cursor]
+      results = resp[:results]
+      while next_page_cursor
+        resp = export_page(updated_after: updated_after, book_ids: book_ids, page_cursor: next_page_cursor)
+        results.concat(resp[:results])
+        next_page_cursor = resp[:next_page_cursor]
+      end
+      results.sort_by(&:highlighted_at_time)
+    end
+
+    private
+
+    def export_page(page_cursor: nil, updated_after: nil, book_ids: [])
+      params = {}
+      params['updatedAfter'] = updated_after if updated_after
+      params['ids'] = book_ids if book_ids.any?
+      params['pageCursor'] = page_cursor if page_cursor
+      url = 'https://readwise.io/api/v2/export/?' + URI.encode_www_form(params)
+      export_uri = URI.parse(url)
+      export_req = Net::HTTP::Get.new(export_uri)
+      export_req['Authorization'] = "Token #{@token}"
+      export_res = Net::HTTP.start(export_uri.hostname, export_uri.port, use_ssl: true) do |http|
+        http.request(export_req)
+      end
+      raise Error, 'Export request failed' unless export_res.is_a?(Net::HTTPSuccess)
+
+      parsed_body = JSON.parse(export_res.body)
+      results = parsed_body.dig('results').map do |item|
+        Book.new(
+          asin: item['asin'],
+          author: item['author'],
+          book_id: item['user_book_id'].to_s,
+          category: item['category'],
+          cover_image_url: item['cover_image_url'],
+          readable_title: item['readable_title'],
+          readwise_url: item['readwise_url'],
+          source: item['source'],
+          source_url: item['source_url'],
+          tags: item['book_tags'],
+          title: item['title'],
+          unique_url: item['unique_url'],
+          highlights: item['highlights'].map do |highlight|
+            Highlight.new(
+              book_id: highlight['book_id'].to_s,
+              color: highlight['color'],
+              created_at: highlight['created_at'],
+              end_location: highlight['end_location'],
+              external_id: highlight['external_id'],
+              highlight_id: highlight['id'].to_s,
+              highlighted_at: highlight['highlighted_at'],
+              is_discard: highlight['is_discard'],
+              is_favorite: highlight['is_favorite'],
+              location: highlight['location'],
+              location_type: highlight['location_type'],
+              note: highlight['note'],
+              readwise_url: highlight['readwise_url'],
+              tags: highlight['tags'],
+              text: highlight['text'],
+              updated_at: highlight['updated_at'],
+              url: highlight['url'],
+            )
+          end
+        )
+      end
+      {
+        results: results,
+        next_page_cursor: parsed_body.dig('nextPageCursor')
+      }
+    end
+  end
+end

data/lib/readwise/highlight.rb

@@ -0,0 +1,43 @@
+require 'time'
+
+module Readwise
+  Highlight = Struct.new(
+    'ReadwiseHighlight',
+    :book_id,
+    :color,
+    :created_at,
+    :end_location,
+    :external_id,
+    :highlight_id,
+    :highlighted_at,
+    :is_discard,
+    :is_favorite,
+    :location,
+    :location_type,
+    :note,
+    :readwise_url,
+    :tags,
+    :text,
+    :updated_at,
+    :url,
+    keyword_init: true
+  ) do
+    def created_at_time
+      return unless created_at
+
+      Time.parse(created_at)
+    end
+
+    def updated_at_time
+      return unless updated_at
+
+      Time.parse(updated_at)
+    end
+
+    def highlighted_at_time
+      return unless highlighted_at
+
+      Time.parse(highlighted_at)
+    end
+  end
+end

data/lib/readwise/version.rb

@@ -0,0 +1,3 @@
+module Readwise
+  VERSION = "0.1.0"
+end

data/lib/readwise.rb

@@ -0,0 +1,6 @@
+require 'readwise/version'
+require 'readwise/client'
+
+module Readwise
+  class Error < StandardError; end
+end

data/readwise.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "readwise/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "readwise"
+  spec.version       = Readwise::VERSION
+  spec.authors       = ["Josh Beckman"]
+  spec.email         = ["josh@joshbeckman.org"]
+
+  spec.summary       = "Readwise API client"
+  spec.description   = "Minimal Readwise API client and highlight parsing library"
+  spec.homepage      = "https://github.com/andjosh/readwise-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: readwise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Beckman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Minimal Readwise API client and highlight parsing library
+email:
+- josh@joshbeckman.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/readwise.rb
+- lib/readwise/book.rb
+- lib/readwise/client.rb
+- lib/readwise/highlight.rb
+- lib/readwise/version.rb
+- readwise.gemspec
+homepage: https://github.com/andjosh/readwise-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/andjosh/readwise-ruby
+  source_code_uri: https://github.com/andjosh/readwise-ruby
+  changelog_uri: https://github.com/andjosh/readwise-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Readwise API client
+test_files: []