chronicle-imessage 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76cac6e564a07e8e411e2378c43b15b812c4b4631dedcdee3863eedb0e3932e6
-  data.tar.gz: 7f7551136fae37aa832a98f9bd5ba386fceb7d4d1c0e3396eee4d64c0cbc03d0
+  metadata.gz: 7cb26617d37224afe34143ff667c42b021736feb1a4c50b40a69c123ffea215a
+  data.tar.gz: 0b09ac95860c9fb5c871d0f79703d5aa305e8563ff42fbd2849a36217d28934e
 SHA512:
-  metadata.gz: fec05237d35c28b1ff9be65c5a60a622abdabec4c3726d7a91583c579891903e5ecd0860422c88bd35ef5b63d9f1c1fea807233dc6997ae6cd8ee3a0557dc4de
-  data.tar.gz: f1d909c69c41258d43d0175ad707dd1069f540527abc122460a587815ff0617fb7b452e2c53ac93de5bc366a6f0fae6ff89905d11edc7eca9b008096ab2f6c80
+  metadata.gz: 58438e98dafbf84d7a959d48428ad0ea63066f8f83b5112e70f63bdbc0c115642ab6876e10b0420e3ec6e1cba34d40e4bdc7573a0cc9bddb61046175f9b3be61
+  data.tar.gz: '0480e7dfce115a6471b2a7732175ff679560b083ea941157d4b765b115ae36e423e5bfbaf70ce49b1d4234d9ac3948446c45e64cb97388534784a3c10eb50b18'

data/README.md

@@ -1,18 +1,42 @@
 # Chronicle::Imessage
+[![Gem Version](https://badge.fury.io/rb/chronicle-imessage.svg)](https://badge.fury.io/rb/chronicle-imessage)
 
-IMessage importer for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
+Access your iMessage messages and attachments using the command line with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl).
+
+## Usage
+
+```sh
+# Install chronicle-etl and this plugin
+$ gem install chronicle-etl
+$ chronicle-etl plugins:install imessage
+
+# Load messages since February 7
+$ chronicle-etl --extractor imessage --transformer imessage --since "2022-02-07"
+
+# Of the latest 1000 messages received, who were the top senders?
+$ chronicle-etl -e imessage -t imessage --limit 1000 --no-header-row --fields actor.title | sort | uniq -c | sort -nr
+
+# Get the raw query results for the latest 10 messages and save as a CSV
+$ chronicle-etl -e imessage --loader csv --limit 10 -o imessages.csv
+```
 
 ## Available Connectors
 ### Extractors
-- `imessage` - Extractor for importing messages and attachments from local macOS iMessage install (`~/Library/Messages/chat.db`)
 
-### Transformers
-- `imessage` - Transformer for processing messages into Chronicle Schema
+#### `imessage`
+Extractor for importing messages and attachments from local macOS iMessage install (`~/Library/Messages/chat.db`)
 
-## Usage
+##### Settings
+- `load_attachments`: (default: false) Whether to load message attachments
+- `only_attachments`: (default: fasle) Whether to load only messages with attachments
 
-```bash
-gem install chronicle-etl
-chronicle-etl plugins:install imessage
-chronicle-etl --extractor imessage --since "2022-02-07" --transformer imessage
-```
+We want messages to have sender/receiver information set properly so we try to infer your iCloud information and phone number automatically. If these fail, you can provide the necessary information with:
+- `my_phone_number`: Your phone number (for setting messages's actor fields properly)
+- `my_name`: Your name (for setting messages's actor fields properly)
+- `icloud_account_id`: Specify an email address that represents your iCloud account ID
+- `icloud_account_dsid`: Specify iCloud DSID
+  - Can find in Keychain or by running `$ defaults read MobileMeAccounts Accounts`
+### Transformers
+
+#### `imessage`
+Transform an iMessage message into Chronicle Schema

data/chronicle-imessage.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "chronicle-etl", "~> 0.4.2"
+  spec.add_dependency "chronicle-etl", "~> 0.4.4"
   spec.add_dependency "sqlite3", "~> 1.4"
   spec.add_dependency "phonelib", "~> 0.6"
 

data/lib/chronicle/imessage/imessage_extractor.rb

@@ -1,6 +1,5 @@
 require 'chronicle/etl'
 require 'sqlite3'
-require 'pry'
 
 module Chronicle
   module Imessage 
@@ -28,8 +27,8 @@ module Chronicle
           meta = {}
           meta[:participants] = @chats[message['chat_id']]
           meta[:attachments] = @attachments[message['message_id']] if @attachments
-          meta[:my_phone_contact] = @my_phone_contact
-          meta[:my_icloud_account] = @my_icloud_account
+          meta[:my_phone_contact] = @my_phone_contact if @my_phone_contact.values.all?
+          meta[:my_icloud_account] = @my_icloud_account if @my_icloud_account.values.all?
 
           yield Chronicle::ETL::Extraction.new(data: message, meta: meta)
         end
@@ -59,16 +58,16 @@ module Chronicle
 
       def load_my_phone_contact(local_contacts)
         {
-          phone_number: @config.my_phone_number || local_contacts.my_phone_contact.fetch(:phone_number),
-          name: @config.my_name || local_contacts.my_phone_contact.fetch(:full_name)
+          phone_number: @config.my_phone_number || local_contacts.my_phone_contact&.fetch(:phone_number),
+          name: @config.my_name || local_contacts.my_phone_contact&.fetch(:full_name)
         }
       end
 
       def load_my_icloud_account(local_contacts)
         {
-          id: @config.icloud_account_id || local_contacts.my_icloud_account.fetch(:AccountID),
-          dsid: @config.icloud_account_dsid || local_contacts.my_icloud_account.fetch(:AccountDSID),
-          display_name: @config.icloud_account_display_name || @config.my_name || local_contacts.my_icloud_account.fetch(:DisplayName)
+          id: @config.icloud_account_id || local_contacts.my_icloud_account&.fetch(:AccountID),
+          dsid: @config.icloud_account_dsid || local_contacts.my_icloud_account&.fetch(:AccountDSID),
+          display_name: @config.icloud_account_display_name || @config.my_name || local_contacts.my_icloud_account&.fetch(:DisplayName)
         }
       end
 

data/lib/chronicle/imessage/imessage_transformer.rb

@@ -102,7 +102,7 @@ module Chronicle
       end
 
       def build_identity identity
-        raise ::Chronicle::ETL::UntransformableRecordError.new("Could not build identity", transformation: self) unless identity
+        raise(Chronicle::ETL::UntransformableRecordError, "Could not build record due to missing identity data") unless identity
 
         record = ::Chronicle::ETL::Models::Entity.new({
           represents: 'identity',
@@ -125,7 +125,7 @@ module Chronicle
 
       def build_identity_mine_icloud
         icloud_account = @extraction.meta[:my_icloud_account]
-        raise(UntransformableRecordError, "Missing iCloud account information") unless icloud_account
+        raise(Chronicle::ETL::UntransformableRecordError, "Could not build record due to missing iCloud details. Please provide them through the extractor settings.") unless icloud_account
 
         record = ::Chronicle::ETL::Models::Entity.new({
           represent: 'identity',
@@ -140,7 +140,7 @@ module Chronicle
 
       def build_identity_mine_phone
         phone_account = @extraction.meta[:my_phone_contact]
-        raise(UntransformableRecordError, "Missing own phone contact information") unless phone_account
+        raise(Chronicle::ETL::UntransformableRecordError, "Could not build record due to missing phone details. Please provide them through the extractor settings.") unless phone_account
 
         record = ::Chronicle::ETL::Models::Entity.new({
           represent: 'identity',

data/lib/chronicle/imessage/local_contacts.rb

@@ -31,6 +31,8 @@ module Chronicle
         @my_icloud_account ||= load_my_icloud_account
       end
 
+      private
+
       # The synced address book doesn't have a stable folder location so we 
       # have to search for it
       def find_local_icloud_address_book

data/lib/chronicle/imessage/version.rb

@@ -1,5 +1,5 @@
 module Chronicle
   module Imessage
-    VERSION = "0.2.2"
+    VERSION = "0.2.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-imessage
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Andrew Louis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronicle-etl
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ metadata:
   homepage_uri: https://github.com/chronicle-app/chronicle-imessage
   source_code_uri: https://github.com/chronicle-app/chronicle-imessage
   changelog_uri: https://github.com/chronicle-app/chronicle-imessage
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: iMessage importer for Chronicle
 test_files: []