readwise 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60dff970e4d8c8989265de5ff247010545019f0ca9f9f93f027726de8dda5755
-  data.tar.gz: 5c4ad097f466e5adf35424dc07f51d45865ea325d3fa455f17c8d0d2290fa6e7
+  metadata.gz: 3430c0062c1b93b7f57032195dd68953f5747fe221104c3f9d27edac52bc6fa2
+  data.tar.gz: 9436565954a21d0b34b8ae7896ded212801daf05512d1fb512207272547792c9
 SHA512:
-  metadata.gz: 63f00184411add2fb4403ebf67cf1fcc89a677ec84826524a92be7fce52d46bf53d2a654db17d9f04e1a89eb15ac938e7ff6ebb861e0c2931ca1d65c1803f247
-  data.tar.gz: 301c9c0f4bf4a810bf62a2f1a2f116f56969535c71c7b4811192be20db1c9bdba71d74962252930f6d2e85b77bcffb1e29610f311fbffd03f07f6913fcb54514
+  metadata.gz: e9d2cf349ca75d6b9a21dcf60c2c8ea2af9ddff6e3aace2ecb82c748b9a1845204e1ac7c9d72c23e5a6c4dbcd9bf682c455162d72ac56b62fb5348d32f958b6f
+  data.tar.gz: 4fdcdc6cca2bb5a7881ee8beceb1c3096f348776839fed87c330d8bb91abd004d1ab75bff9cd9e9ce5d23b0d57c3f1ed55b34738ae9888c3fd42e72c94447dd2

data/.github/FUNDING.yml

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

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [0.3.0] - 2023-02-28
+
+- Change `Tag` from hash to struct ([#6](https://github.com/andjosh/readwise-ruby/pull/6) from [@ajistrying](https://github.com/ajistrying))
+
+## [0.2.0] - 2023-02-20
+
+- Add support for `Book.note` ([#4](https://github.com/andjosh/readwise-ruby/pull/4))
+
 ## [0.1.0] - 2023-01-16
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readwise (0.1.0)
+    readwise (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,6 +17,8 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
+    rspec-file_fixtures (0.1.6)
+      rspec (~> 3.0)
     rspec-mocks (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
@@ -26,10 +28,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.4.4)
   rake (~> 10.0)
   readwise!
   rspec (~> 3.0)
+  rspec-file_fixtures (~> 0.1.6)
 
 BUNDLED WITH
-   1.17.2
+   2.4.4

data/README.md

@@ -28,7 +28,7 @@ First, obtain an API access token from https://readwise.io/access_token.
 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(updated_after: '2023-01-17T22:02:48Z') # export recent highlights
 books = client.export(book_ids: ['123']) # export specific highlights
 
 puts books.first.title # books are Readwise::Book structs
@@ -37,7 +37,7 @@ puts books.first.highlights.map(&:text) # highlights are Readwise::Highlight str
 
 ## 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.
+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.
 
 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

@@ -9,6 +9,7 @@ module Readwise
     :category,
     :cover_image_url,
     :highlights,
+    :note,
     :readable_title,
     :readwise_url,
     :source,

data/lib/readwise/client.rb

@@ -1,7 +1,8 @@
 require 'json'
 require 'net/http'
-require_relative 'book.rb'
-require_relative 'highlight.rb'
+require_relative 'book'
+require_relative 'highlight'
+require_relative 'tag'
 
 module Readwise
   class Client
@@ -35,20 +36,7 @@ module Readwise
     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)
+      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'],
@@ -56,11 +44,17 @@ module Readwise
           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'],
+          tags: item['book_tags'].map do |tag|
+            Tag.new(
+              tag_id: tag['id'].to_s,
+              name: tag['name']
+            )
+          end,
           title: item['title'],
           unique_url: item['unique_url'],
           highlights: item['highlights'].map do |highlight|
@@ -78,7 +72,12 @@ module Readwise
               location_type: highlight['location_type'],
               note: highlight['note'],
               readwise_url: highlight['readwise_url'],
-              tags: highlight['tags'],
+              tags: highlight['tags'].map do |tag|
+                Tag.new(
+                  tag_id: tag['id'].to_s,
+                  name: tag['name']
+                )
+              end,
               text: highlight['text'],
               updated_at: highlight['updated_at'],
               url: highlight['url'],
@@ -91,5 +90,22 @@ module Readwise
         next_page_cursor: parsed_body.dig('nextPageCursor')
       }
     end
+
+    def get_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)
+
+      JSON.parse(export_res.body)
+    end
   end
 end

data/lib/readwise/tag.rb

@@ -0,0 +1,8 @@
+module Readwise
+  Tag = Struct.new(
+    'ReadwiseTag',
+    :tag_id,
+    :name,
+    keyword_init: true
+  )
+end

data/lib/readwise/version.rb

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

data/readwise.gemspec

@@ -36,7 +36,8 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 2.4.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-file_fixtures", "~> 0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readwise
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Beckman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.4.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-file_fixtures
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
 description: Minimal Readwise API client and highlight parsing library
 email:
 - josh@joshbeckman.org
@@ -59,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -73,6 +88,7 @@ files:
 - lib/readwise/book.rb
 - lib/readwise/client.rb
 - lib/readwise/highlight.rb
+- lib/readwise/tag.rb
 - lib/readwise/version.rb
 - readwise.gemspec
 homepage: https://github.com/andjosh/readwise-ruby
@@ -83,7 +99,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.7
+signing_key:
 specification_version: 4
 summary: Readwise API client
 test_files: []