chronicle-imessage 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2be4dbec8ee2945136d579ab8d42d8580160c6eacc839d92a55a5a462f749385
-  data.tar.gz: c9a229903ebaffcc63fd52a480237e47f119142d3036c6a0c32513f7891ba114
+  metadata.gz: 9c6cdfbc6a52ca7ae467378ff36cb35ad24c8a4dcbeee36a3953daab19a8e6e2
+  data.tar.gz: 28768a3f6378e7e5c2327cdec73dcdff9bab064f32e9f7c93784e49fac3f249d
 SHA512:
-  metadata.gz: 86dd00967c9a1a689bd575d399c0869db3b42152f7043386362caf84eaccb13a5f4c865c38546c4d6f30692629e37132687266ed284d90f2ac0141d021cba330
-  data.tar.gz: f3de0abf901aa6f9a2c3484f6414bd8f9d9d566c57f2ebaf4e2e3a6c74f465a1efedf6e69d88567a903c9c090a51a0e685a6c9bbeb31ad37a0c40a677c17daba
+  metadata.gz: e7f1101ccbf489834f48a5bc909758bb6d1d4b0c34a512a4b17b31efcf9d851a0c1d7174e8745b35671df9cd2e9d4b525216e4d2a9800dbb63c16d1047f0432a
+  data.tar.gz: 2e8601ef4107929d5ce524e62badaa5b7f16afebb4b7527455ffcf0542b12c4bdc0aee5147bf053f2e505e04593e52f6674127718a174064069bde897564af89

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

@@ -27,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
@@ -58,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: nil,
+          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.3"
+    VERSION = "0.2.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-imessage
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Louis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-03-16 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