chronicle-pinboard 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290728f6a7dcff698aba9ba5e636e6da3ee0074d073926ade6a6d8841fbec859
-  data.tar.gz: 1a8e7e70b604e7c71b37e05cd95dbd001459b7c1682ae1e03d97146a50db48fb
+  metadata.gz: c3ca6b04d95423377e1b2b2d5fc935ae991917e7f29bbb21174e9412eb6c0251
+  data.tar.gz: 78166200e312683229681764e3b43c99b16eb2359df2e3b019814f14adf21571
 SHA512:
-  metadata.gz: 866eb3508e2aa678690a55b70d40ce5d6d6d64b3b8fe036fcd2e77f911ff4f86952e033eaabb33e8b68b0261540f6e1b453490021078a3993b14979dd62903a7
-  data.tar.gz: 8dacd215171fb01db26c7d8a9956237f1af07625d58f167030ae3808898b06c42e78f183e0b4db348b6e7b84682ead9d47f271463210585a565c044923c5236d
+  metadata.gz: 735e34e238f0f2ff2f455b985484c4e4434372fc7293c20efa90a24327131dd303082f8d8fb9a315fca5cf1571c5c2f7f53bd41dcd8291c1b34b0738e0a62fe7
+  data.tar.gz: a5b7bc6653435128cd375e71a0c9a5045c74118567032ab323fd9d2878f45ba29d673d86cb1c0e959ce389dd031135b7471d7b19af73a268aefa7c80ce6bc198

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  chronicle-core: .rubocop-plugin.yml

data/Gemfile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in chronicle-pinboard.gemspec

data/README.md

@@ -13,11 +13,12 @@ Extract your Pinboard bookmarks using the command line with this plugin for [chr
 ## Usage
 
 ```sh
-gem install chronicle-etl
-chronicle-etl connectors:install pinboard
+$ gem install chronicle-etl
+$ chronicle-etl plugins:install pinboard
+
+# You can get a pinboard access token from https://pinboard.in/settings/password
+$ chronicle-etl secrets:set pinboard access_token PINBOARD_ACCESS_TOKEN
 
-# You can get PINBOARD_ACCESS_TOKEN from https://pinboard.in/settings/password
 # Extract pinboard bookmarks from the last 10 days
-chronicle-etl --extractor pinboard --extractor-opts access_token:$PINBOARD_ACCESS_TOKEN --since 10d
+$ chronicle-etl --extractor pinboard --since 10d
 ```
-

data/Rakefile

@@ -1,4 +1,2 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 task default: %i[]

data/bin/console

@@ -1,15 +1,7 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
-require "bundler/setup"
-require "chronicle/pinboard"
+require 'bundler/setup'
+require 'chronicle/pinboard'
 
-# 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__)
+require 'pry'
+Pry.start

data/chronicle-pinboard.gemspec

@@ -1,45 +1,48 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "chronicle/pinboard/version"
+require 'chronicle/pinboard/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "chronicle-pinboard"
+  spec.name          = 'chronicle-pinboard'
   spec.version       = Chronicle::Pinboard::VERSION
-  spec.authors       = ["Andrew Louis"]
-  spec.email         = ["andrew@hyfen.net"]
+  spec.authors       = ['Andrew Louis']
+  spec.email         = ['andrew@hyfen.net']
 
-  spec.summary       = "Pinboard importer for Chronicle"
-  spec.description   = "Import your Pinboard bookmarks"
-  spec.homepage      = "https://github.com/chronicle-app/chronicle-pinboard"
+  spec.summary       = 'Pinboard importer for Chronicle'
+  spec.description   = 'Import your Pinboard bookmarks'
+  spec.homepage      = 'https://github.com/chronicle-app/chronicle-pinboard'
 
   # 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['allowed_push_host'] = 'https://rubygems.org'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/chronicle-app/chronicle-pinboard"
-    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-pinboard"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/chronicle-app/chronicle-pinboard'
+    spec.metadata['changelog_uri'] = 'https://github.com/chronicle-app/chronicle-pinboard'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "chronicle-etl", "~> 0.5"
-  spec.add_dependency "faraday", "~> 2.2"
-
-  spec.add_development_dependency "bundler", "~> 2.3"
-  spec.add_development_dependency "rake", "~> 13.0.6"
-  spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'chronicle-core', '~> 0.3'
+  spec.add_dependency 'chronicle-etl', '~> 0.6'
+  spec.add_dependency 'faraday', '~> 2'
+  spec.add_dependency 'omniauth-oauth2', '~> 1'
+  spec.add_dependency 'sqlite3', '~> 1.4'
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.63'
 end

data/lib/chronicle/pinboard/pinboard_extractor.rb

@@ -2,25 +2,27 @@ require 'chronicle/etl'
 require 'faraday'
 
 module Chronicle
-  module Pinboard 
+  module Pinboard
     class PinboardExtractor < Chronicle::ETL::Extractor
       register_connector do |r|
-        r.provider = 'pinboard'
-        r.description = 'bookmarks'
+        r.source = :pinboard
+        r.type = :bookmark
+        r.strategy = :api
+        r.description = 'a bookmark from pinboard'
       end
 
       setting :access_token, required: true
 
       def prepare
-        raise(Chronicle::ETL::ExtractionError, "Access token is missing") if @config.access_token.empty?
+        raise(Chronicle::ETL::ExtractionError, 'Access token is missing') if @config.access_token.empty?
 
         @bookmarks = load_bookmarks
-        @username = @config.access_token.split(":").first
+        @username = @config.access_token.split(':').first
       end
 
       def extract
         @bookmarks.each do |bookmark|
-          yield Chronicle::ETL::Extraction.new(data: bookmark, meta: { username: @username })
+          yield build_extraction(data: bookmark, meta: { username: @username })
         end
       end
 
@@ -34,18 +36,19 @@ module Chronicle
         params = {
           auth_token: @config.access_token,
           format: 'json',
-          meta: true,
+          meta: true
         }
         params[:fromdt] = @config.since.utc.iso8601 if @config.since
 
         conn = Faraday.new(
           url: 'https://api.pinboard.in/',
-          params: params
+          params:
         )
 
         response = conn.get('/v1/posts/all')
         bookmarks = JSON.parse(response.body, { symbolize_names: true })
         bookmarks = bookmarks.keep_if { |bookmark| Time.parse(bookmark[:time]) < @config.until } if @config.until
+        bookmarks = bookmarks.first(@config.limit) if @config.limit
         bookmarks
       end
     end

data/lib/chronicle/pinboard/pinboard_transformer.rb

@@ -1,98 +1,85 @@
 require 'chronicle/etl'
+require 'chronicle/models'
 
 module Chronicle
   module Pinboard
     class PinboardTransformer < Chronicle::ETL::Transformer
       register_connector do |r|
-        r.provider = 'pinboard'
-        r.description = 'bookmark from pinboard'
+        r.source = :pinboard
+        r.type = :bookmark
+        r.strategy = :api
+        r.description = 'a booknark from pinboard'
+        r.from_schema = :extraction
+        r.to_schema = :chronicle
       end
 
-      def transform
-        @bookmark = @extraction.data
-        build_liked
-      end
+      def transform(record)
+        site = build_site(record.data)
+        agent = build_agent(record.extraction.meta[:username])
+        id = record.data[:hash]
+        end_time = Time.parse(record.data[:time])
 
-      def timestamp
-        Time.parse(@bookmark[:time])
-      end
+        actions = []
 
-      def id
-        @bookmark[:hash]
-      end
+        actions << build_bookmark(site:, agent:, id:, end_time:)
 
-      private
+        note = record.data[:extended]
+        actions << build_comment(site:, agent:, id:, end_time:, note:) if note.size.positive?
 
-      def build_liked
-        record = ::Chronicle::ETL::Models::Activity.new
-        record.end_at = timestamp
-        record.verb = 'liked'
-        record.provider_id = id
-        record.provider = 'pinboard'
-        record.dedupe_on = [[:provider, :verb, :provider_id]]
-
-        record.involved = build_bookmark
-        record.actor = build_actor
-
-        record
+        actions.compact
       end
 
-      def build_bookmark
-        record = ::Chronicle::ETL::Models::Entity.new
-        record.title = @bookmark[:description]
-        record.provider_url = @bookmark[:href]
-        record.dedupe_on << [:provider_url]
+      private
 
-        record.abouts = build_tags
+      def build_bookmark(site:, agent:, id:, end_time:)
+        Chronicle::Models::BookmarkAction.new do |r|
+          r.source = 'pinboard'
+          r.source_id = id
+          r.end_time = end_time
+          r.agent = agent
+          r.object = site
 
-        record.aboutables = build_note
-        record
+          r.dedupe_on = [%i[source source_id type]]
+        end
       end
 
-      def build_note
-        note = @bookmark[:extended]
-        return unless note.size.positive?
-
-        record = ::Chronicle::ETL::Models::Entity.new
-        record.provider_id = id
-        record.represents = "thought"
-        record.body = note
-        record.provider = "pinboard"
-        record.dedupe_on << [:represents, :provider, :provider_id]
-
-        involvement = ::Chronicle::ETL::Models::Activity.new
-        involvement.end_at = timestamp
-        involvement.verb = 'noted'
-        involvement.provider_id = id
-        involvement.provider = 'pinboard'
-        involvement.dedupe_on << [:provider, :verb, :provider_id]
-        involvement.actor = build_actor
+      def build_comment(site:, agent:, id:, note:, end_time:)
+        comment = Chronicle::Models::Comment.new do |r|
+          r.source = 'pinboard'
+          r.source_id = id
+          r.text = note
+          r.about = [site]
+          r.dedupe_on = [%i[source source_id type]]
+        end
 
-        record.involvements = [involvement]
+        Chronicle::Models::CommentAction.new do |r|
+          r.source = 'pinboard'
+          r.source_id = id
+          r.end_time = end_time
+          r.agent = agent
+          r.result = comment
+          r.object = site
 
-        record
+          r.dedupe_on = [%i[source source_id type]]
+        end
       end
 
-      def build_tags
-        @bookmark[:tags].split(" ").map do |tag|
-          record = ::Chronicle::ETL::Models::Entity.new
-          record.represents = 'topic'
-          record.provider = 'pinboard'
-          record.slug = tag.downcase
-          record.dedupe_on << [:provider, :slug, :represents]
-          record
+      def build_site(bookmark)
+        Chronicle::Models::Thing.new do |r|
+          r.name = bookmark[:description]
+          r.url = bookmark[:href]
+          r.dedupe_on = [[:url]]
+          r.keywords = bookmark[:tags].split.map(&:strip)
         end
       end
 
-      def build_actor
-        record = ::Chronicle::ETL::Models::Entity.new
-        record.represents = 'identity'
-        record.slug = @extraction.meta[:username] 
-        record.provider = 'pinboard'
-        record.provider_url = "https://pinboard.in/u:#{record.slug}"
-        record.dedupe_on << [:provider_url]
-        record.dedupe_on << [:provider, :represents, :slug]
-        record
+      def build_agent(username)
+        Chronicle::Models::Person.new do |r|
+          r.source = 'pinboard'
+          r.slug = username
+          r.url = "https://pinboard.in/u:#{username}"
+          r.dedupe_on = [[:url], %i[source slug type]]
+        end
       end
     end
   end

data/lib/chronicle/pinboard/version.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 module Chronicle
   module Pinboard
-    VERSION = "0.1.1"
+    VERSION = '0.2.0'
   end
 end

data/lib/chronicle/pinboard.rb

@@ -1,8 +1,6 @@
-# frozen_string_literal: true
-
-require_relative "pinboard/version"
-require_relative "pinboard/pinboard_extractor"
-require_relative "pinboard/pinboard_transformer"
+require_relative 'pinboard/version'
+require_relative 'pinboard/pinboard_extractor'
+require_relative 'pinboard/pinboard_transformer'
 
 module Chronicle
   module Pinboard

metadata

@@ -1,43 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-pinboard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Louis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronicle-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: chronicle-etl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.63'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.63'
 description: Import your Pinboard bookmarks
 email:
 - andrew@hyfen.net
@@ -88,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -106,6 +163,7 @@ metadata:
   homepage_uri: https://github.com/chronicle-app/chronicle-pinboard
   source_code_uri: https://github.com/chronicle-app/chronicle-pinboard
   changelog_uri: https://github.com/chronicle-app/chronicle-pinboard
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -121,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Pinboard importer for Chronicle