chronicle-safari 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a6714d6637bd3d9566e3c55bd88c1b6adaa28f24ad90d532fbd96148e98046
-  data.tar.gz: 54af96d1596c5a620580a8f3545a44f227ebd7ba034ce17188f9c6f151fa2ab5
+  metadata.gz: 7330b68fd8e6fc1a77c118d177ae175dc42567e760b34332723227bbd6f011cf
+  data.tar.gz: 7f6c17d05026554124eb50c52e0ca2119a3e377859b48404a81a2183883961ad
 SHA512:
-  metadata.gz: 456c6bde7c176b653df3cbdaac209274b3face8eae1fe86b82b54386d196155584e5ff3aa9a9320acf9e92d7fbbc70ce28862f31fc707409d2201fae73b96991
-  data.tar.gz: 115670f23e5da5c44dfaabea0e6cb100e54d0acb47cb00d61eee522b94a89c055e634c36e3f472c148caff49e7fcb6c54ead5b809940b38c87c54d7e15ec0120
+  metadata.gz: 94711ac7afd35f5d0427d909c75f4b3b89d7ec6075ea8e88a6242d82ebdefb7ecd19b174c9cae75e2f07651efe58d8e302bca543e3f0a564c4346af3b8a090e2
+  data.tar.gz: 0c3b6e5211641cddcf462daab83f1d0f787e769a8715b4f410b59fe558aee9ab9d2471284a0a9c5b0fb37ad5e4278fb637ae6aaba64a43065a5dfe89e9bfd58e

data/.rubocop.yml

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

data/README.md

@@ -1,10 +1,11 @@
 # Chronicle::Safari
+[![Gem Version](https://badge.fury.io/rb/chronicle-safari.svg)](https://badge.fury.io/rb/chronicle-safari)
 
-Safri plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
+Extract your Safari browser history with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
 
 ## Available Connectors
 ### Extractors
-- `safari` - Extractor for history
+- `safari` - Extractor for browser history
 
 ### Transformers
 - `safari` - Transforms history into Chronicle Schema
@@ -12,8 +13,13 @@ Safri plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
 ## Usage
 
 ```sh
-gem install chronicle-etl
-chronicle-etl connectors:install safari
+# Install chronicle-etl and then this plugin
+$ gem install chronicle-etl
+$ chronicle-etl connectors:install safari
 
-chronicle-etl --extractor safari --since 2022-02-07
+# Extract all history
+$ chronicle-etl --extractor safari
+
+# Get last week of history and transform it into Chronicle Schema
+$ chronicle-etl --extractor safari --since 1w --transformer safari
 ```

data/bin/console

@@ -1,15 +1,7 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
-require "bundler/setup"
-require "chronicle/safari"
+require 'bundler/setup'
+require 'chronicle/safari'
 
-# 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-safari.gemspec

@@ -1,45 +1,50 @@
 # 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/safari/version"
+require 'chronicle/safari/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "chronicle-safari"
+  spec.name          = 'chronicle-safari'
   spec.version       = Chronicle::Safari::VERSION
-  spec.authors       = ["Andrew Louis"]
-  spec.email         = ["andrew@hyfen.net"]
+  spec.authors       = ['Andrew Louis']
+  spec.email         = ['andrew@hyfen.net']
 
-  spec.summary       = "Safari importer for Chronicle"
-  spec.description   = "Import your safari history"
-  spec.homepage      = "https://github.com/chronicle-app/chronicle-safari"
+  spec.summary       = 'Safari importer for Chronicle'
+  spec.description   = 'Import your safari history'
+  spec.homepage      = 'https://github.com/chronicle-app/chronicle-safari'
 
   # 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-safari"
-    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-safari"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/chronicle-app/chronicle-safari'
+    spec.metadata['changelog_uri'] = 'https://github.com/chronicle-app/chronicle-safari'
   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 "sqlite3", "~> 1.4"
-
-  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.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'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/chronicle/safari/{safari_extractor.rb → browse_extractor.rb}

@@ -2,10 +2,12 @@ require 'chronicle/etl'
 require 'sqlite3'
 
 module Chronicle
-  module Safari 
-    class SafariExtractor < Chronicle::ETL::Extractor
+  module Safari
+    class BrowseExtractor < Chronicle::ETL::Extractor
       register_connector do |r|
-        r.provider = 'safari'
+        r.source = :safari
+        r.type = :browse
+        r.strategy = :local_db
         r.description = 'browser history'
       end
 
@@ -23,7 +25,10 @@ module Chronicle
       def extract
         @history.each do |entry|
           entry.transform_keys!(&:to_sym)
-          yield Chronicle::ETL::Extraction.new(data: entry, meta: { icloud_account: @icloud_account } )
+
+          meta = {}
+          meta[:my_icloud_account] = @icloud_account
+          yield build_extraction(data: entry, meta:)
         end
       end
 
@@ -50,22 +55,22 @@ module Chronicle
 
       def load_history
         conditions = []
-        conditions << "history_visits.redirect_destination IS NULL"
+        conditions << 'history_visits.redirect_destination IS NULL'
         conditions << "visit_time_utc > '#{@config.since.utc}'" if @config.since
         conditions << "visit_time_utc < '#{@config.until.utc}'" if @config.until
 
         sql = <<~SQL
           SELECT
               *,
-              datetime(visit_time + 978307200, 'unixepoch') as visit_time_utc           
+              datetime(visit_time + 978307200, 'unixepoch') as visit_time_utc
           FROM
-              history_visits             
+              history_visits
           LEFT JOIN
-              history_items             
-                  ON history_items.id = history_item 
+              history_items
+                  ON history_items.id = history_item
         SQL
-        sql += " WHERE #{conditions.join(" AND ")}" if conditions.any?
-        sql += " ORDER BY visit_time_utc DESC"
+        sql += " WHERE #{conditions.join(' AND ')}" if conditions.any?
+        sql += ' ORDER BY visit_time_utc DESC'
         sql += " LIMIT #{@config.limit}" if @config.limit
 
         results = @db.execute(sql)

data/lib/chronicle/safari/browse_transformer.rb

@@ -0,0 +1,51 @@
+require 'chronicle/etl'
+require 'chronicle/models'
+
+module Chronicle
+  module Safari
+    class BrowseTransformer < Chronicle::ETL::Transformer
+      register_connector do |r|
+        r.source = :safari
+        r.type = :browse
+        r.strategy = :local_db
+        r.description = 'a history item'
+        r.from_schema = :extraction
+        r.to_schema = :chronicle
+      end
+
+      def transform(record)
+        build_browse(record.data, record.extraction.meta[:my_icloud_account])
+      end
+
+      private
+
+      def build_browse(data, icloud_account)
+        Chronicle::Models::ViewAction.new do |r|
+          r.source = 'safari'
+          r.end_time = Time.parse(data[:visit_time_utc])
+          r.agent = build_agent(icloud_account)
+          r.object = build_site(data)
+        end
+      end
+
+      def build_site(data)
+        Chronicle::Models::Thing.new do |r|
+          r.name = data[:title]
+          r.url = data[:url]
+
+          r.dedupe_on = [[:url]]
+        end
+      end
+
+      def build_agent(icloud_account)
+        Chronicle::Models::Person.new do |r|
+          r.name = icloud_account[:display_name]
+          r.source = 'icloud'
+          r.slug = icloud_account[:id]
+          r.source_id = icloud_account[:dsid]
+          r.dedupe_on = [%i[type source source_id]]
+        end
+      end
+    end
+  end
+end

data/lib/chronicle/safari/version.rb

@@ -2,6 +2,6 @@
 
 module Chronicle
   module Safari
-    VERSION = "0.1.1"
+    VERSION = '0.2.0'
   end
 end

data/lib/chronicle/safari.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "safari/version"
-require_relative "safari/safari_extractor"
-require_relative "safari/safari_transformer"
+require_relative 'safari/version'
+require_relative 'safari/browse_extractor'
+require_relative 'safari/browse_transformer'
 
 module Chronicle
   module Safari

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-safari
 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-26 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.6'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: '0.5'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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 safari history
 email:
 - andrew@hyfen.net
@@ -88,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -96,8 +153,8 @@ files:
 - bin/setup
 - chronicle-safari.gemspec
 - lib/chronicle/safari.rb
-- lib/chronicle/safari/safari_extractor.rb
-- lib/chronicle/safari/safari_transformer.rb
+- lib/chronicle/safari/browse_extractor.rb
+- lib/chronicle/safari/browse_transformer.rb
 - lib/chronicle/safari/version.rb
 homepage: https://github.com/chronicle-app/chronicle-safari
 licenses: []
@@ -106,6 +163,7 @@ metadata:
   homepage_uri: https://github.com/chronicle-app/chronicle-safari
   source_code_uri: https://github.com/chronicle-app/chronicle-safari
   changelog_uri: https://github.com/chronicle-app/chronicle-safari
+  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: Safari importer for Chronicle

data/lib/chronicle/safari/safari_transformer.rb

@@ -1,60 +0,0 @@
-require 'chronicle/etl'
-
-module Chronicle
-  module Safari
-    class SafariTransformer < Chronicle::ETL::Transformer
-      register_connector do |r|
-        r.provider = 'safari'
-        r.description = 'a history item'
-      end
-
-      def transform
-        @data = @extraction.data
-        build_browsed
-      end
-
-      def id
-        # IDs from local db aren't global or stable across multiple installs 
-      end
-
-      def timestamp
-        Time.parse(@data[:visit_time_utc])
-      end
-
-      private
-
-      def build_browsed
-        record = ::Chronicle::ETL::Models::Activity.new({
-          verb: 'browsed',
-          provider: 'safari',
-          end_at: timestamp
-        })
-        record.dedupe_on << [:provider, :verb, :end_at]
-        record.actor = build_actor
-        record.involved = build_involved
-        record
-      end
-
-      def build_involved
-        record = ::Chronicle::ETL::Models::Entity.new({
-          title: @data[:title],
-          provider_url: @data[:url],
-        })
-        record.dedupe_on << [:provider_url]
-        record
-      end
-
-      def build_actor
-        record = ::Chronicle::ETL::Models::Entity.new({
-          represent: 'identity',
-          provider: 'icloud',
-          provider_id: @extraction.meta[:icloud_account][:dsid],
-          title: @extraction.meta[:icloud_account][:display_name],
-          slug: @extraction.meta[:icloud_account][:id]
-        })
-        record.dedupe_on << [:provider, :represents, :slug]
-        record
-      end
-    end
-  end
-end