chronicle-shell 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb256c224fc5da05d9a0cdcdb9d4efd15156f9194783088e110fd5213549dc55
-  data.tar.gz: 1f1f7415835c37376b46ac436f431cb48081bf669440afb58617e41a5a5f27fa
+  metadata.gz: 2b88a844a7e429898c8cd9851e9326be1cb1a61cb7fb0598d44456519941d3b9
+  data.tar.gz: 51db09766b5dacf94e4cd92ea5531cdb6475e5afa4759d48acb7e3e8f224cc36
 SHA512:
-  metadata.gz: 94112b98f9536c38fdc9bd8de1900b119b92a400e82f93d38de594d12f8baed537081bb1dc07350afbf51fc6a187fa1097f8d82f39adc5ad64067487a994aca7
-  data.tar.gz: c813a082d7d2e36f0c4091cd875d3b9be5d262b39ddf249e011f6ac68fcc3aea05e7d73d1855d0d71565cf5e1b7d20c53e6c03d213f01637a684b9a1d1254121
+  metadata.gz: 0a4f39726fe053ad6b5341cc5bece31eafb52bfde210fc7cb601cf388b4f7d131d0828d656946f436c455632d9c4f688e3c933f2069fcd55aef7c3204804d9f1
+  data.tar.gz: e4941551b42d16d90ac55345395d7b7bfbd73873a05dde157d129f4add9b0f839a4e55bf90705cd048e3a1c91e261f34aaf346933ebcc948630caf07df179c37

data/README.md

@@ -1,39 +1,19 @@
 # Chronicle::Shell
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chronicle/shell`. To experiment with that code, run `bin/console` for an interactive prompt.
+Shell importer for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
 
-TODO: Delete this and the text above, and describe your gem
+## Available Connectors
+### Extractors
+- `shell-history` - Extract shell history from bash or zsh
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'chronicle-shell'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install chronicle-shell
+### Transformers
+- `shell-history` - Process a shell command
 
 ## Usage
 
-TODO: Write usage instructions here
+```bash
+gem install chronicle-etl
+chronicle-etl plugins:install shell
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chronicle-shell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chronicle-shell/blob/main/CODE_OF_CONDUCT.md).
-
-## Code of Conduct
-
-Everyone interacting in the Chronicle::Shell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chronicle-shell/blob/main/CODE_OF_CONDUCT.md).
+chronicle-etl --extractor shell-history --since "2022-02-07" --transformer shell-history --loader table
+```

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.3.0"
+  spec.add_dependency "chronicle-etl", "~> 0.4.3"
 end

data/lib/chronicle/shell/shell_history_extractor.rb

@@ -1,5 +1,4 @@
 require 'chronicle/etl'
-require 'tty-command'
 
 module Chronicle
   module Shell
@@ -7,16 +6,15 @@ module Chronicle
       register_connector do |r|
         r.provider = 'shell'
         r.description = 'shell command history'
-        r.identifier = 'shell-history'
+        r.identifier = 'history'
       end
 
+      setting :input
+      setting :shell, default: 'bash'
+
       BASH_TIMESTAMP_REGEX = /^\#(?<timestamp>[0-9]{10})/
 
       def prepare
-        # TODO: determine if we're working with bash or zsh
-        @shell_name = 'bash'
-
-        @filename = history_filename
         @commands = load_commands
       end
 
@@ -29,7 +27,7 @@ module Chronicle
           meta = {
             username: username,
             hostname: hostname,
-            shell_name: @shell_name
+            shell_name: @config.shell
           }
           yield Chronicle::ETL::Extraction.new(data: command, meta: meta)
         end
@@ -37,10 +35,20 @@ module Chronicle
 
       private
 
+      # TODO: modularize the shell-specific stuff
       def history_filename
+        # 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
         File.join(Dir.home, ".bash_history")
       end
 
+      def history_filename_default_zsh
+        File.join(Dir.home, ".zsh_history")
+      end
+
       def username
         @username ||= Etc.getlogin
       end
@@ -55,10 +63,10 @@ module Chronicle
       def load_commands
         commands = []
 
-        loader = "load_commands_from_#{@shell_name}"
-        send(loader) do |command|
-          next if @options[:load_since] && command[:timestamp] < @options[:load_since]
-          next if @options[:load_until] && command[:timestamp] > @options[:load_until]
+        loader = "load_commands_from_#{@config.shell}"
+        __send__(loader) do |command|
+          next if @config.since && command[:timestamp] < @config.since
+          next if @config.until && command[:timestamp] > @config.until
 
           if block_given?
             yield command
@@ -67,23 +75,28 @@ module Chronicle
           end
         end
 
+        commands = commands.first(@config.limit) if @config.limit
+
         commands
       end
 
       def load_commands_from_bash
-        timestamp = nil
-        File.foreach(@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
 
       def load_commands_from_zsh
         # TODO: implement this
+        raise NotImplementedError
       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.1.0"
+    VERSION = "0.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-shell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Louis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-10 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.3.0
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.3
 description: Extract shell command history from Bash or Zsh
 email:
 - andrew@hyfen.net
@@ -33,7 +33,6 @@ extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -50,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
@@ -65,8 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Shell connectors for Chronicle-ETL
 test_files: []

data/Gemfile.lock

@@ -1,84 +0,0 @@
-PATH
-  remote: .
-  specs:
-    chronicle-shell (0.1.0)
-      chronicle-etl (~> 0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    chronic_duration (0.10.6)
-      numerizer (~> 0.1.1)
-    chronicle-etl (0.3.0)
-      activesupport
-      chronic_duration (~> 0.10.6)
-      colorize (~> 0.8.1)
-      marcel (~> 1.0.2)
-      mini_exiftool (~> 2.10)
-      nokogiri (~> 1.13)
-      runcom (~> 6.2)
-      sequel (~> 5.35)
-      sqlite3 (~> 1.4)
-      thor (~> 0.20)
-      tty-progressbar (~> 0.17)
-      tty-table (~> 0.11)
-    colorize (0.8.1)
-    concurrent-ruby (1.1.9)
-    i18n (1.9.1)
-      concurrent-ruby (~> 1.0)
-    marcel (1.0.2)
-    mini_exiftool (2.10.2)
-    mini_portile2 (2.7.1)
-    minitest (5.15.0)
-    nokogiri (1.13.1)
-      mini_portile2 (~> 2.7.0)
-      racc (~> 1.4)
-    numerizer (0.1.1)
-    pastel (0.8.0)
-      tty-color (~> 0.5)
-    racc (1.6.0)
-    rake (13.0.6)
-    refinements (7.18.0)
-    runcom (6.6.0)
-      refinements (~> 7.16)
-      xdg (~> 4.4)
-    sequel (5.53.0)
-    sqlite3 (1.4.2)
-    strings (0.2.1)
-      strings-ansi (~> 0.2)
-      unicode-display_width (>= 1.5, < 3.0)
-      unicode_utils (~> 1.4)
-    strings-ansi (0.2.0)
-    thor (0.20.3)
-    tty-color (0.6.0)
-    tty-cursor (0.7.1)
-    tty-progressbar (0.18.2)
-      strings-ansi (~> 0.2)
-      tty-cursor (~> 0.7)
-      tty-screen (~> 0.8)
-      unicode-display_width (>= 1.6, < 3.0)
-    tty-screen (0.8.1)
-    tty-table (0.12.0)
-      pastel (~> 0.8)
-      strings (~> 0.2.0)
-      tty-screen (~> 0.8)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    unicode_utils (1.4.0)
-    xdg (4.5.0)
-
-PLATFORMS
-  -darwin-20
-
-DEPENDENCIES
-  chronicle-shell!
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.3.6