readwise 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 766eb82d68f06591b6e05211877532619182404c3aa29c24720de5cd1788ad0a
-  data.tar.gz: 70b4affa8b2e46271fb1d690e00328be10e1fcbb5fd6a3d5ae08135947818671
+  metadata.gz: 2132de7e8f9fdbc395fc94872968cee73d333c67723b2e81a7554b61105e1469
+  data.tar.gz: 4aca80570f7ea3d6d7045cfe0f3fe75c64d578e4ea2de05697d98e747215d74a
 SHA512:
-  metadata.gz: f6b8cda492331d61352a83bc01732fee2d30191419b226327334daf4c00338afe6876bfb5b806318506bc42a5706f826225a2c917dcaf17a0172d9c12cc3cd08
-  data.tar.gz: 7b2e849cc2bff772ebe84c7b93cb0b7bdf9c506c9bce80a79754554590a537717c39882f6b04faa8e43105b5eac20598fd89f1a39002746d8212557a4bdaf42d
+  metadata.gz: 35498d0c04b98eab247b3bf78bdf66dc51294f0538273c9515d8122b737c494421a4425f241d25577d77ec55a2ce01455e02fb91281a72769c753a7d74e9690c
+  data.tar.gz: 751bfaf4334fcf74cd6f16b685108a8df095a84366b91c76e1978447d839f28ff7234c136f933bd37eb18f7e1b0e437a40e84e7b17a4c5e3641a6d0995519268

data/.github/FUNDING.yml

@@ -1,3 +1,3 @@
 # These are supported funding model platforms
 
-github: andjosh
+github: joshbeckman

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [0.5.0] - 2023-06-15
+- Add methods to create/update highlights ([#8](https://github.com/joshbeckman/readwise-ruby/pull/12))
+- Add methods to add/update/remove highlight tags
+- Add method to get book
+
 ## [0.4.0] - 2023-03-19
 
 - Add `get_highlight` client method ([#10](https://github.com/andjosh/readwise-ruby/pull/10) from [@ajistrying](https://github.com/ajistrying))

data/README.md

@@ -33,11 +33,30 @@ 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
+
+# create a highlight
+create = Readwise::HighlightCreate.new(text: 'foobar', author: 'Joan')
+highlight = client.create_highlight(highlight: create)
+
+# update a highlight
+update = Readwise::HighlightUpdate.new(text: 'foobaz', color: 'yellow')
+updated = client.update_highlight(highlight: highlight, update: update)
+
+# add a tag to a highlight
+tag = Readwise::Tag.new(name: 'foobar')
+added_tag = client.add_highlight_tag(highlight: highlight, tag: tag)
+
+# update a tag on a highlight
+added_tag.name = 'bing'
+updated_tag = client.update_highlight_tag(highlight: highlight, tag: added_tag)
+
+# remove a tag from a highlight
+client.remove_highlight_tag(highlight: highlight, tag: added_tag)
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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).
 

data/lib/readwise/book.rb

@@ -10,6 +10,7 @@ module Readwise
     :cover_image_url,
     :highlights,
     :note,
+    :num_highlights,
     :readable_title,
     :readwise_url,
     :source,

data/lib/readwise/client.rb

@@ -12,25 +12,81 @@ module Readwise
 
     def initialize(token: nil)
       raise ArgumentError unless token
+
       @token = token.to_s
     end
 
     def create_highlight(highlight:)
-      create_highlights([highlight])
+      create_highlights(highlights: [highlight]).first
     end
 
     def create_highlights(highlights: [])
-      raise NotImplementedError
+      raise ArgumentError unless highlights.all? { |item| item.is_a?(Readwise::HighlightCreate) }
+      return [] unless highlights.any?
+
+      url = BASE_URL + 'highlights/'
+
+      payload = { highlights: highlights.map(&:serialize) }
+      res = post_readwise_request(url, payload: payload)
+
+      modified_ids = res.map { |book| book['modified_highlights'] }.flatten
+      modified_ids.map { |id| get_highlight(highlight_id: id) }
     end
 
     def get_highlight(highlight_id:)
-      url = BASE_URL + 'highlights/' + highlight_id
+      url = BASE_URL + "highlights/#{highlight_id}"
 
       res = get_readwise_request(url)
 
       transform_highlight(res)
     end
 
+    def update_highlight(highlight:, update:)
+      raise ArgumentError unless update.is_a?(Readwise::HighlightUpdate)
+
+      url = BASE_URL + "highlights/#{highlight.highlight_id}"
+
+      res = patch_readwise_request(url, payload: update.serialize)
+
+      transform_highlight(res)
+    end
+
+    def remove_highlight_tag(highlight:, tag:)
+      url = BASE_URL + "highlights/#{highlight.highlight_id}/tags/#{tag.tag_id}"
+
+      delete_readwise_request(url)
+    end
+
+    def add_highlight_tag(highlight:, tag:)
+      raise ArgumentError unless tag.is_a?(Readwise::Tag)
+
+      url = BASE_URL + "highlights/#{highlight.highlight_id}/tags"
+
+      payload = tag.serialize.select { |k, v| k == :name }
+      res = post_readwise_request(url, payload: payload)
+
+      transform_tag(res)
+    end
+
+    def update_highlight_tag(highlight:, tag:)
+      raise ArgumentError unless tag.is_a?(Readwise::Tag)
+
+      url = BASE_URL + "highlights/#{highlight.highlight_id}/tags/#{tag.tag_id}"
+
+      payload = tag.serialize.select { |k, v| k == :name }
+      res = patch_readwise_request(url, payload: payload)
+
+      transform_tag(res)
+    end
+
+    def get_book(book_id:)
+      url = BASE_URL + "books/#{book_id}"
+
+      res = get_readwise_request(url)
+
+      transform_book(res)
+    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]
@@ -48,22 +104,7 @@ module Readwise
     def export_page(page_cursor: nil, updated_after: nil, book_ids: [])
       parsed_body = get_export_page(page_cursor: page_cursor, updated_after: updated_after, book_ids: book_ids)
       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'],
-          note: item['document_note'],
-          readable_title: item['readable_title'],
-          readwise_url: item['readwise_url'],
-          source: item['source'],
-          source_url: item['source_url'],
-          tags: item['book_tags'].map { |tag| transform_tag(tag) },
-          title: item['title'],
-          unique_url: item['unique_url'],
-          highlights: item['highlights'].map { |highlight| transform_highlight(highlight) },
-        )
+        transform_book(item)
       end
       {
         results: results,
@@ -82,6 +123,27 @@ module Readwise
 
     end
 
+    def transform_book(res)
+      highlights = (res['highlights'] || []).map { |highlight| transform_highlight(highlight) }
+      Book.new(
+        asin: res['asin'],
+        author: res['author'],
+        book_id: res['user_book_id'].to_s,
+        category: res['category'],
+        cover_image_url: res['cover_image_url'],
+        note: res['document_note'],
+        readable_title: res['readable_title'],
+        readwise_url: res['readwise_url'] || res['highlights_url'],
+        source: res['source'],
+        source_url: res['source_url'],
+        tags: (res['book_tags'] || res['tags'] || []).map { |tag| transform_tag(tag) },
+        title: res['title'],
+        unique_url: res['unique_url'],
+        highlights: highlights,
+        num_highlights: res['num_highlights'] || highlights.size,
+      )
+    end
+
     def transform_highlight(res)
       Highlight.new(
         book_id: res['book_id'].to_s,
@@ -118,10 +180,51 @@ module Readwise
       res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
         http.request(req)
       end
-      
-      raise Error, 'Export request failed' unless res.is_a?(Net::HTTPSuccess)
-  
+
+      raise Error, 'Get request failed' unless res.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(res.body)
+    end
+
+    def patch_readwise_request(url, payload:)
+      uri = URI.parse(url)
+      req = Net::HTTP::Patch.new(uri)
+      req['Authorization'] = "Token #{@token}"
+      req['Content-Type'] = 'application/json'
+      req.body = payload.to_json
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      raise Error, 'Patch request failed' unless res.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(res.body)
+    end
+
+    def post_readwise_request(url, payload:)
+      uri = URI.parse(url)
+      req = Net::HTTP::Post.new(uri)
+      req['Authorization'] = "Token #{@token}"
+      req['Content-Type'] = 'application/json'
+      req.body = payload.to_json
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      raise Error, 'Post request failed' unless res.is_a?(Net::HTTPSuccess)
+
       JSON.parse(res.body)
     end
+
+    def delete_readwise_request(url)
+      uri = URI.parse(url)
+      req = Net::HTTP::Delete.new(uri)
+      req['Authorization'] = "Token #{@token}"
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      raise Error, 'Delete request failed' unless res.is_a?(Net::HTTPSuccess)
+    end
   end
 end

data/lib/readwise/highlight.rb

@@ -39,5 +39,45 @@ module Readwise
 
       Time.parse(highlighted_at)
     end
+
+    def serialize
+      to_h
+    end
+  end
+
+  HighlightCreate = Struct.new(
+    'ReadwiseHighlightCreate',
+    :author,
+    :category,  # One of: books, articles, tweets or podcasts.
+                # (default: articles when source_url is provided, otherwise: books)
+    :highlight_url,
+    :highlighted_at,
+    :image_url,
+    :location,
+    :location_type, # One of: page, order or time_offset (default: order)
+    :note,
+    :source_type,
+    :source_url,
+    :text,
+    :title,
+    keyword_init: true
+  ) do
+    def serialize
+      to_h.compact
+    end
+  end
+
+  HighlightUpdate = Struct.new(
+    'ReadwiseHighlightUpdate',
+    :color,
+    :location,
+    :note,
+    :text,
+    :url,
+    keyword_init: true
+  ) do
+    def serialize
+      to_h.compact
+    end
   end
 end

data/lib/readwise/tag.rb

@@ -4,5 +4,9 @@ module Readwise
     :tag_id,
     :name,
     keyword_init: true
-  )
+  ) do
+    def serialize
+      to_h
+    end
+  end
 end

data/lib/readwise/version.rb

@@ -1,3 +1,3 @@
 module Readwise
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readwise
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Josh Beckman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: Readwise API client