cased-ruby 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c422e1920ea510d16c5c8a5b91016ac2a4eedb9a2b880ff29018dc18580a13
-  data.tar.gz: 83e14abb44637e8d61a3fff592d8b434cbf8373cd8a4c8afede513cf89852f8a
+  metadata.gz: e22f14bbfac74d8d6ed2565ab7d4dd2607b03178a8534e15681ebad08aadd047
+  data.tar.gz: aeec32fc2d39829a6e4c24b4b8024b416dad08d84528d13eaa2d310c4a3c2c59
 SHA512:
-  metadata.gz: 5beffb4be2a539b74e6145c4d4b7b96ae6aea94c2bb5cdf9a79dfb90bfaeac615c80b537db0249702d807acb7f69727ff7b81cfc62896d03ad6e2c44124c1360
-  data.tar.gz: 8ae4ac844f566981de31a5d51ecfe28d4e665f9cebd5c6f5327a596b052e43e92ab0d7db9bb07029211f0786db5baf00035db8022a376b5ea3ba30ac512dbbda
+  metadata.gz: ba38566776a824c05f9750a72ca0e0b878279a07e5134fac83d54e9f10d462a8a940bf01f5d0968c1654adfb9a196f3d7ad6398614c987e41168bdf81d40cd93
+  data.tar.gz: f5bde94bab92b5cfc4dce4a146ca5a1d02d7946f14e5003386b3b82c920c656b92665b801b5ae5ef116316b0d33e7c3d727a730bda46426e30d08380b7bac798

data/Gemfile.lock

@@ -1,43 +1,48 @@
 PATH
   remote: .
   specs:
-    cased-ruby (0.3.3)
+    cased-ruby (0.4.0)
       activesupport (~> 6)
       dotpath (= 0.1.0)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
       json (~> 2)
+      jwt (~> 2)
       net-http-persistent (~> 3.0)
+      subprocess (~> 1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     byebug (11.0.1)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     connection_pool (2.2.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     docile (1.3.2)
     dotpath (0.1.0)
-    faraday (1.1.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
+    faraday-net_http (1.0.1)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.3.1)
+    json (2.5.1)
+    jwt (2.2.2)
     minitest (5.13.0)
     mocha (1.11.2)
     multipart-post (2.1.1)
@@ -63,7 +68,7 @@ GEM
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
     safe_yaml (1.0.5)
     sidekiq (6.0.7)
       connection_pool (>= 2.2.2)
@@ -74,16 +79,16 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    subprocess (1.5.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.6.1)
     webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.24)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,15 +8,15 @@ A Cased client for Ruby applications in your organization to control and monitor
 - [Configuration](#configuration)
 - [Usage](#usage)
   - [Publishing events to Cased](#publishing-events-to-cased)
-  - [Retrieving events from a Cased Policy](#retrieving-events-from-a-cased-policy)
-  - [Retrieving events from a Cased Policy containing variables](#retrieving-events-from-a-cased-policy-containing-variables)
-  - [Retrieving events from multiple Cased Policies](#retrieving-events-from-multiple-cased-policies)
+  - [Retrieving events from a Cased audit trail](#retrieving-events-from-a-cased-audit-trail)
+  - [Retrieving events from multiple Cased audit trails](#retrieving-events-from-multiple-cased-audit-trails)
   - [Exporting events](#exporting-events)
-  - [Masking & filtering sensitive information](#masking-and-filtering-sensitive-information)
+  - [Masking & filtering sensitive information](#masking--filtering-sensitive-information)
   - [Disable publishing events](#disable-publishing-events)
   - [Context](#context)
   - [Testing](#testing)
 - [Customizing cased-ruby](#customizing-cased-ruby)
+- [Contributing](#contributing)
 
 ## Installation
 
@@ -100,7 +100,7 @@ Cased.publish(
 
 **Cased::Model**
 
-cased-ruby provides a class mixin that gives you a framework to publish events.
+`cased-ruby` provides a class mixin that gives you a framework to publish events.
 
 ```ruby
 require 'cased-ruby'
@@ -170,9 +170,9 @@ Both examples above are equivelent in that they publish the following `credit_ca
 }
 ```
 
-### Retrieving events from a Cased Policy
+### Retrieving events from a Cased audit trail
 
-If you plan on retrieving events from your audit trails you must use an Cased Policy token.
+If you plan on retrieving audit events from your Cased audit trail you must use a Cased API key.
 
 ```ruby
 require 'cased-ruby'
@@ -193,31 +193,9 @@ query.success? # => true
 query.error? # => false
 ```
 
-### Retrieving events from a Cased Policy containing variables
+### Retrieving events from multiple Cased audit trails
 
-Cased policies allow you to filter events by providing variables to your Cased Policy events query. One example of a Cased Policy is to have a single Cased Policy that you can use to query events for any user in your database without having to create a Cased Policy for each user.
-
-```ruby
-require 'cased-ruby'
-
-Cased.configure do |config|
-  config.policy_key = 'policy_live_1dQpY5JliYgHSkEntAbMVzuOROh'
-end
-
-variables = {
-  user_id: 'user_1dSHQSNtAH90KA8zGTooMnmMdiD',
-}
-query = Cased.policy(variables: variables).events.limit(25).page(1)
-results = query.results
-results.each do |event|
-  puts event['action'] # => credit_card.charge
-  puts event['timestamp'] # => 2020-06-23T02:02:39.932759Z
-end
-```
-
-### Retrieving events from multiple Cased Policies
-
-To retrieve events from one or more Cased Policies you can configure multiple Cased Policy API keys and retrieve events for each one.
+To retrieve audit events from one or more Cased audit trails you can configure multiple Cased Policy API keys and retrieve events for each one.
 
 ```ruby
 require 'cased-ruby'
@@ -229,14 +207,14 @@ Cased.configure do |config|
   }
 end
 
-query = Cased.policy[:users].events.limit(25).page(1)
+query = Cased.policies[:users].events.limit(25).page(1)
 results = query.results
 results.each do |event|
   puts event['action'] # => user.login
   puts event['timestamp'] # => 2020-06-23T02:02:39.932759Z
 end
 
-query = Cased.policy[:organizations].events.limit(25).page(1)
+query = Cased.policies[:organizations].events.limit(25).page(1)
 results = query.results
 results.each do |event|
   puts event['action'] # => organization.create
@@ -246,7 +224,7 @@ end
 
 ### Exporting events
 
-Exporting events from a Cased Policy allows you to provide users with exports of their own data or to respond to data requests.
+Exporting events from Cased allows you to provide users with exports of their own data or to respond to data requests.
 
 ```ruby
 require 'cased-ruby'
@@ -281,14 +259,9 @@ Cased.publish(
 
 ### Console Usage
 
-Most Cased events will be created by users from actions on the website from
-custom defined events or lifecycle callbacks. The exception is any console
-session where models may generate Cased events as you start to modify records.
+Most Cased events will be created by users from actions on the website from custom defined events or lifecycle callbacks. The exception is any console session where models may generate Cased events as you start to modify records.
 
-By default any console session will include the hostname of where the console
-session takes place. Since every event must have an actor, you must set the
-actor at the beginning of your console session. If you don't know the user,
-it's recommended you create a system/robot user.
+By default any console session will include the hostname of where the console session takes place. Since every event must have an actor, you must set the actor at the beginning of your console session. If you don't know the user, it's recommended you create a system/robot user.
 
 ```ruby
 # OTHER CONSOLE INITIALIZATION HERE

data/bin/cli

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cased-ruby'
+
+Cased.configure do |config|
+  config.guard_application_key = 'guard_application_1oFqltbMqSEtJQKRCAYQNrQoXsS'
+  config.guard_deny_if_unreachable = true
+end
+
+Cased::CLI::InteractiveSession.start
+
+puts 'Something destructive'

data/cased-ruby.gemspec

@@ -33,7 +33,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 1.0'
   spec.add_dependency 'faraday_middleware', '~> 1.0'
   spec.add_dependency 'json', '~> 2'
+  spec.add_dependency 'jwt', '~> 2'
   spec.add_dependency 'net-http-persistent', '~> 3.0'
+  spec.add_dependency 'subprocess', '~> 1.5.0'
   spec.add_development_dependency 'bundler', '2.1.4'
   spec.add_development_dependency 'byebug', '11.0.1'
   spec.add_development_dependency 'minitest', '5.13.0'

data/lib/cased.rb

@@ -15,6 +15,7 @@ require 'cased/sensitive'
 require 'cased/publishers'
 require 'cased/test_helper'
 require 'cased/instrumentation/log_subscriber'
+require 'cased/cli'
 
 # Integrations
 begin

data/lib/cased/cli.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cased
+  module CLI
+  end
+end
+
+require 'cased/cli/asciinema/writer'
+require 'cased/cli/asciinema/file'
+require 'cased/cli/recorder'
+require 'cased/cli/log'
+require 'cased/cli/session'
+require 'cased/cli/interactive_session'

data/lib/cased/cli/asciinema/file.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cased
+  module CLI
+    # Spec: https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md
+    module Asciinema
+      class File
+        OUT = 'o'
+        IN = 'i'
+
+        def self.from_writer(writer)
+          new(writer.header, writer.stream)
+        end
+
+        def self.from_cast(cast)
+          stream = cast.split("\n").collect do |data|
+            JSON.parse(data)
+          end
+          header = stream.shift
+
+          new(header, stream)
+        end
+
+        # Required
+        attr_reader :header
+        attr_reader :version
+        attr_reader :width
+        attr_reader :height
+        attr_reader :stream
+
+        # Optional
+        attr_reader :timestamp
+        attr_reader :duration
+        attr_reader :idle_time_limit
+        attr_reader :command
+        attr_reader :title
+        attr_reader :env
+        attr_reader :theme
+
+        def initialize(header, stream)
+          @header = header
+          @version = header.fetch('version')
+          @width = header.fetch('width')
+          @height = header.fetch('height')
+          self.timestamp = header['timestamp']
+          self.duration = header['duration']
+          self.idle_time_limit = header['idle_time_limit']
+          @command = header['command']
+          @title = header['title']
+          @env = header.fetch('env', {})
+          @theme = header['theme']
+          @stream = stream
+        end
+
+        def timestamp=(new_timestamp)
+          @timestamp = case new_timestamp
+          when Integer
+            Time.at(new_timestamp)
+          when Time, NilClass
+            new_timestamp
+          else
+            raise ArgumentError, "unexpected timestamp format #{new_timestamp.class}, expected Integer, Time, or nil"
+          end
+        end
+
+        def duration=(new_duration)
+          @duration = case new_duration
+          when Float, NilClass
+            new_duration
+          else
+            raise ArgumentError, "unexpected duration format #{new_duration.class}, expected Float or nil"
+          end
+        end
+
+        def idle_time_limit=(new_idle_time_limit)
+          @idle_time_limit = case new_idle_time_limit
+          when Numeric, NilClass
+            new_idle_time_limit
+          else
+            raise ArgumentError, "unexpected idle_time_limit format #{new_idle_time_limit.class}, expected Integer, Float, or nil"
+          end
+        end
+
+        def to_cast
+          builder = []
+          builder << JSON.dump(header)
+          stream.each do |duration, type, data|
+            builder << JSON.dump([duration, type, data])
+          end
+          builder.join("\n")
+        end
+
+        def to_s
+          str = []
+          stream.each do |_timestamp, type, data|
+            next unless type == OUT
+
+            str << data
+          end
+
+          str.join
+        end
+      end
+    end
+  end
+end

data/lib/cased/cli/asciinema/writer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cased
+  module CLI
+    # Spec: https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md
+    module Asciinema
+      class Writer
+        VERSION = 2
+
+        attr_accessor :width
+        attr_accessor :height
+        attr_reader :stream
+        attr_reader :started_at
+        attr_reader :finished_at
+
+        def initialize(command: [], width: 80, height: 24)
+          @command = command
+          @width = width
+          @height = height
+          @stream = []
+          @started_at = Time.now
+        end
+
+        def <<(output)
+          stream << [Time.now - started_at, 'o', output]
+        end
+
+        def time
+          @started_at = Time.now
+          ret = yield
+          @finished_at = Time.now
+          ret
+        end
+
+        def to_cast
+          # In the event we didn't run the writer in a #time block, we should
+          # set the finished time if it isn't set.
+          @finished_at ||= Time.now
+
+          File.new(header, stream).to_cast
+        end
+
+        def header
+          {
+            'version' => VERSION,
+            'env' => {
+              'SHELL' => ENV['SHELL'],
+              'TERM' => ENV['TERM'],
+            },
+            'width' => width,
+            'height' => height,
+          }.tap do |h|
+            if started_at
+              h['timestamp'] = started_at.to_i
+            end
+
+            if started_at && finished_at
+              h['duration'] = finished_at - started_at
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cased/cli/authentication.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Cased
+  module CLI
+    class Authentication
+      attr_reader :directory
+      attr_reader :credentials_path
+      attr_writer :token
+
+      def initialize
+        @token = Cased.config.guard_user_token
+        @directory = Pathname.new(File.expand_path('~/.cguard'))
+        @credentials_path = @directory.join('credentials')
+      end
+
+      def exists?
+        !token.nil?
+      end
+
+      def token
+        @token ||= begin
+          credentials_path.read
+        rescue Errno::ENOENT
+          nil
+        end
+      end
+    end
+  end
+end