readwise 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77088f2664c1f2d285ed893bd5ef67d313971e75bfafcd5eaebb6f2e05177e62
-  data.tar.gz: 472f2d70b184549e9be6232399f821e5b7f99a24f964d716fcec913ec7cae5bb
+  metadata.gz: 766eb82d68f06591b6e05211877532619182404c3aa29c24720de5cd1788ad0a
+  data.tar.gz: 70b4affa8b2e46271fb1d690e00328be10e1fcbb5fd6a3d5ae08135947818671
 SHA512:
-  metadata.gz: 1fd02d43c7ee4d4e5a47582abc46eecd25c1df344bc848df2b56bac9f6290a5a6e814432443d8f6884a6066b04713f166a3db1b022122edbf9fc0e68fdfd413b
-  data.tar.gz: 0e261d0744c012b2b0b9d80b77f1ee5b8e22f5e908681b41d8b0aef587771abc3d66244d4eb869ba1336dad4bf0ac3dd638c1d782f37ed18b9bcf82d1f2b6710
+  metadata.gz: f6b8cda492331d61352a83bc01732fee2d30191419b226327334daf4c00338afe6876bfb5b806318506bc42a5706f826225a2c917dcaf17a0172d9c12cc3cd08
+  data.tar.gz: 7b2e849cc2bff772ebe84c7b93cb0b7bdf9c506c9bce80a79754554590a537717c39882f6b04faa8e43105b5eac20598fd89f1a39002746d8212557a4bdaf42d

data/.github/workflows/ruby.yml

@@ -0,0 +1,39 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+          # bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install deps
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -46,7 +46,7 @@ build-iPhoneSimulator/
 
 # 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
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [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))
+
+## [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))

data/README.md

@@ -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/client.rb

@@ -1,12 +1,15 @@
 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
     class Error < StandardError; end
 
+    BASE_URL = "https://readwise.io/api/v2/"
+
     def initialize(token: nil)
       raise ArgumentError unless token
       @token = token.to_s
@@ -20,6 +23,14 @@ module Readwise
       raise NotImplementedError
     end
 
+    def get_highlight(highlight_id:)
+      url = BASE_URL + 'highlights/' + highlight_id
+
+      res = get_readwise_request(url)
+
+      transform_highlight(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,30 +59,10 @@ module Readwise
           readwise_url: item['readwise_url'],
           source: item['source'],
           source_url: item['source_url'],
-          tags: item['book_tags'],
+          tags: item['book_tags'].map { |tag| transform_tag(tag) },
           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
+          highlights: item['highlights'].map { |highlight| transform_highlight(highlight) },
         )
       end
       {
@@ -85,16 +76,52 @@ module Readwise
       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)
+      url = BASE_URL + 'export/?' + URI.encode_www_form(params)
+
+      get_readwise_request(url)
 
-      JSON.parse(export_res.body)
+    end
+
+    def transform_highlight(res)
+      Highlight.new(
+        book_id: res['book_id'].to_s,
+        color: res['color'],
+        created_at: res['created_at'],
+        end_location: res['end_location'],
+        external_id: res['external_id'],
+        highlight_id: res['id'].to_s,
+        highlighted_at: res['highlighted_at'],
+        is_discard: res['is_discard'],
+        is_favorite: res['is_favorite'],
+        location: res['location'],
+        location_type: res['location_type'],
+        note: res['note'],
+        readwise_url: res['readwise_url'],
+        tags: res['tags'].map { |tag| transform_tag(tag) },
+        text: res['text'],
+        updated_at: res['updated_at'],
+        url: res['url'],
+      )
+    end
+
+    def transform_tag(res)
+      Tag.new(
+        tag_id: res['id'].to_s,
+        name: res['name'],
+      )
+    end
+
+    def get_readwise_request(url)
+      uri = URI.parse(url)
+      req = Net::HTTP::Get.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, 'Export request failed' unless res.is_a?(Net::HTTPSuccess)
+  
+      JSON.parse(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.2.0"
+  VERSION = "0.4.0"
 end

data/readwise.gemspec

@@ -36,7 +36,7 @@ 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", "~> 2.4.4"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-file_fixtures", "~> 0.1.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readwise
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Beckman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,11 +74,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -88,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
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Readwise API client

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    readwise (0.2.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-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)
-    rspec-support (3.12.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.4.4)
-  rake (~> 10.0)
-  readwise!
-  rspec (~> 3.0)
-  rspec-file_fixtures (~> 0.1.6)
-
-BUNDLED WITH
-   2.4.4