chronicle-shell 0.2.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1f1e5fd44c4e21f27a1f0879096ebedc08dcb866ec62393b5935e348816c9a1
-  data.tar.gz: d1fee6983b672b691f19bf1efb6fa10629cbc3b112205761da35e7f82e5e59ec
+  metadata.gz: 83dc9bab0e1b65930d8243a16ba6debe3d92cb4424b50e80d8511dc13dc6f3e4
+  data.tar.gz: 57d4a5d1f434dedacb3071c3f96ac211990f42b92b75db1416b852b3b5f93806
 SHA512:
-  metadata.gz: 15d51d049d46e24bed446cb8ea03cf2faed69f362a974e828336c5e3449d0037e221c15941cbc417c9585ff0e01160f6fcac5765a494f62f0e3d2d0b7934c0c3
-  data.tar.gz: ca9f88415679b7aa492a318e48885d1df401b98975c5f735bb36eb310494374d33b4e7cbdac06a06714c5161213ff5472796589bb225a96a40842d036f7dab9f
+  metadata.gz: de0dba35c9ea5e3612c52f2adcf543c4922485e69e44e650113a89cb03ad24737bf7a1a271cdb3febd409ab02a481ed1d436a9374fe50a181c634dc6d69c2b93
+  data.tar.gz: 5cbfef0e14a2d6e1ee7ffabdc99627ab5af6bad3d30368e082dad3057a701bc5dfef3da38e5ce7c8aadcf8689b35910060fe36486e060f1f7ffd358599a414c2

data/README.md

@@ -1,19 +1,25 @@
 # Chronicle::Shell
+[![Gem Version](https://badge.fury.io/rb/chronicle-shell.svg)](https://badge.fury.io/rb/chronicle-shell)
 
 Shell importer for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
 
 ## Available Connectors
 ### Extractors
-- `shell-history` - Extract shell history from bash or zsh
+- `shell:history` - Extract shell history from bash or zsh
 
 ### Transformers
-- `shell-history` - Process a shell command
+- `shell:history` - Turn a shell command into Chronicle Schema
 
-## Usage
+## Usage and examples
 
 ```bash
+# install chronicle-etl and then this plugin
 gem install chronicle-etl
 chronicle-etl plugins:install shell
 
-chronicle-etl --extractor shell-history --since "2022-02-07" --transformer shell-history --loader table
+# output commands since Feb 7 as json
+chronicle-etl --extractor shell:history --transformer shell:history --since "2022-02-07" --loader json
+
+# Show recent commands sorted by frequency of use
+chronicle-etl --extractor shell:history --limit 500 --fields command --silent | sort | uniq -c | sort -nr
 ```

data/chronicle-shell.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "chronicle-etl", "~> 0.4.3"
+  spec.add_dependency "chronicle-etl", "~> 0.5"
 end

data/lib/chronicle/shell/shell_history_extractor.rb

@@ -6,10 +6,10 @@ module Chronicle
       register_connector do |r|
         r.provider = 'shell'
         r.description = 'shell command history'
-        r.identifier = 'shell-history'
+        r.identifier = 'history'
       end
 
-      setting :filename, default: ENV['HISTFILE']
+      setting :input
       setting :shell, default: 'bash'
 
       BASH_TIMESTAMP_REGEX = /^\#(?<timestamp>[0-9]{10})/
@@ -37,7 +37,8 @@ module Chronicle
 
       # TODO: modularize the shell-specific stuff
       def history_filename
-        @config.filename || __send__("history_filename_default_#{@config.shell}")
+        # Ideally we coudl just use ENV['HISTFILE] but it's not available outside of Bash
+        @config.input&.first || __send__("history_filename_default_#{@config.shell}")
       end
 
       def history_filename_default_bash
@@ -80,13 +81,15 @@ module Chronicle
       end
 
       def load_commands_from_bash
-        timestamp = nil
-        File.foreach(history_filename) do |line|
-          if match = line.scrub.match(BASH_TIMESTAMP_REGEX)
-            timestamp = Time.at(match[:timestamp].to_i)
-          elsif timestamp
-            command = { timestamp: timestamp, command: line.scrub.strip }
+        command = nil
+        File.readlines(history_filename).reverse_each do |line|
+          timestamp_line = line.scrub.match(BASH_TIMESTAMP_REGEX)
+          if timestamp_line && command
+            timestamp = Time.at(timestamp_line[:timestamp].to_i)
+            command = { timestamp: timestamp, command: command }
             yield command
+          else
+            command = line.scrub.strip
           end
         end
       end

data/lib/chronicle/shell/shell_history_transformer.rb

@@ -6,7 +6,7 @@ module Chronicle
       register_connector do |r|
         r.provider = 'shell'
         r.description = 'a shell command'
-        r.identifier = 'shell-history'
+        r.identifier = 'history'
       end
 
       def transform

data/lib/chronicle/shell/version.rb

@@ -2,6 +2,6 @@
 
 module Chronicle
   module Shell
-    VERSION = "0.2.1"
+    VERSION = "0.2.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-shell
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Louis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-03-25 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.3
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: '0.5'
 description: Extract shell command history from Bash or Zsh
 email:
 - andrew@hyfen.net
@@ -49,7 +49,7 @@ metadata:
   homepage_uri: https://github.com/chronicle-app/chronicle-shell
   source_code_uri: https://github.com/chronicle-app/chronicle-shell
   changelog_uri: https://github.com/chronicle-app/chronicle-shell/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +64,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: Shell connectors for Chronicle-ETL
 test_files: []