cased-ruby 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 136251a6fad727d85e14bf64bfdb5ecf33fdba19735646c3599398c7a0e44abb
-  data.tar.gz: 94f191ec590bc6bd68ef98b137abbaa052c8438573bb84d9cb9b63ffec4ae8e4
+  metadata.gz: dc3d9c43168af4bfb222f063557726b6579ee497059ee14343e422b49f16c879
+  data.tar.gz: bfdb95c9831fd38d4ad86a25772aac3a1740c5de33ad3441c4b7edb0a6f173e9
 SHA512:
-  metadata.gz: 613409847cfcda2948b2b3559a754ac6822fca908cec0d1a089475be19801290bf8aee866e592d00bef882b1e3b7027ead484346bd39a404c171b8205a5631fa
-  data.tar.gz: 3a3d8435ecce240a7cff4a83061c57412d08dd1d16e91c9995caf1f755a4706f40744e7ce11c015a4557d66ea1948b6c54caf05f893205a2f8296aedb9780e7b
+  metadata.gz: 1849cbc38766aa621046ba7db1d66e841714a3c8b6005cfc9beda6e606270f83c8429627f3797ce327415f67c55a3db8b3d799c738d446342a283cdb07d3098c
+  data.tar.gz: 3bccd4a530a8f5f4384c793570d7cd245fb6a339b5fa5c1df7874bdfcec28f63c21ad90dc3f109a2c9739968c02b69e899ab1f14bfcbf5624b2b6a7620aa2fac

data/.github/workflows/ruby.yml

@@ -28,19 +28,3 @@ jobs:
       - name: Run Tests
         run: |
           bundle exec rake test
-
-      - name: Generate yard documentation
-        run: |
-          bundle exec yard
-
-      - name: Upload test coverage report
-        uses: actions/upload-artifact@v2
-        with:
-          name: coverage
-          path: coverage/**/*
-
-      - name: Upload generated yard documentation
-        uses: actions/upload-artifact@v2
-        with:
-          name: yard
-          path: doc/**/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cased-ruby (0.4.4)
+    cased-ruby (0.5.0)
       activesupport (~> 6)
       dotpath (= 0.1.0)
       faraday (~> 1.0)
@@ -10,11 +10,12 @@ PATH
       jwt (~> 2)
       net-http-persistent (~> 3.0)
       subprocess (~> 1.5.0)
+      tty-prompt (~> 0.23.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -30,19 +31,23 @@ GEM
       safe_yaml (~> 1.0.0)
     docile (1.3.2)
     dotpath (0.1.0)
-    faraday (1.3.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     json (2.5.1)
-    jwt (2.2.2)
+    jwt (2.2.3)
     minitest (5.13.0)
     mocha (1.11.2)
     multipart-post (2.1.1)
@@ -51,6 +56,8 @@ GEM
     parallel (1.19.1)
     parser (2.7.1.3)
       ast (~> 2.4.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
     public_suffix (4.0.5)
     rack (2.2.2)
     rack-protection (2.0.8.1)
@@ -80,6 +87,16 @@ GEM
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
     subprocess (1.5.4)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.6.1)
@@ -87,6 +104,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    wisper (2.0.1)
     yard (0.9.24)
     zeitwerk (2.4.2)
 

data/README.md

@@ -9,6 +9,7 @@ A Cased client for Ruby applications in your organization to control and monitor
 - [Usage](#usage)
   - [Cased CLI](#cased-cli)
     - [Starting an approval workflow](#starting-an-approval-workflow)
+    - [Attaching metadata to all CLI requests](#attaching-metadata-to-all-cli-requests)
   - [Audit trails](#audit-trails)
     - [Publishing events to Cased](#publishing-events-to-cased)
     - [Retrieving events from a Cased audit trail](#retrieving-events-from-a-cased-audit-trail)
@@ -85,6 +86,17 @@ Cased.configure do |config|
 
   # CASED_HTTP_READ_TIMEOUT=10
   config.http_read_timeout = 10
+
+  # Attach metadata to all CLI requests. This metadata will appear in Cased and
+  # any notification source such as email or Slack.
+  #
+  # You are limited to 20 properties and cannot be a nested dictionary. Metadata
+  # specified in the CLI request overrides any configured globally.
+  config.cli.metadata = {
+    rails_env: ENV['RAILS_ENV'],
+    heroku_application: ENV['HEROKU_APP_NAME'],
+    git_commit: ENV['GIT_COMMIT'],
+  }
 end
 ```
 
@@ -181,6 +193,27 @@ You no longer need to handle obtaining the user token or asking for a reason up
 front, `Cased::CLI::InteractiveSession` will prompt the user for any reason
 being required as necessary.
 
+#### Attaching metadata to all CLI requests
+
+While you can customize the metadata included for each CLI request, it may prove
+useful to specify metadata globally that will be included with each CLI request.
+Some useful information to include may be the current Rails environment, Heroku
+application, Git commit deployed, and more.
+
+Metadata is limited to 20 properties and cannot be a nested dictionary.
+
+```ruby
+Cased.configure do |config|
+  config.cli.metadata = {
+    rails_env: ENV['RAILS_ENV'],
+    heroku_application: ENV['HEROKU_APP_NAME'],
+    git_commit: ENV['GIT_COMMIT'],
+  }
+end
+```
+
+Note: Metadata specified in the CLI request overrides any configured globally.
+
 ### Audit trails
 
 #### Publishing events to Cased

data/cased-ruby.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jwt', '~> 2'
   spec.add_dependency 'net-http-persistent', '~> 3.0'
   spec.add_dependency 'subprocess', '~> 1.5.0'
+  spec.add_dependency 'tty-prompt', '~> 0.23.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/cli/asciinema/file.rb

@@ -15,12 +15,17 @@ module Cased
         end
 
         def self.from_cast(cast)
+          return if cast.blank?
+
           stream = cast.split("\n").collect do |data|
             JSON.parse(data)
           end
           header = stream.shift
+          return unless header.is_a?(Hash)
 
           new(header, stream)
+        rescue JSON::ParserError
+          nil
         end
 
         # Required

data/lib/cased/cli/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cased
+  module CLI
+    class Config
+      # @example
+      #   Cased.configure do |config|
+      #     config.cli.metadata = {
+      #       rails_env: ENV['RAILS_ENV'],
+      #       heroku_application: ENV['HEROKU_APP_NAME'],
+      #       git_commit: ENV['GIT_COMMIT'],
+      #     }
+      #   end
+      attr_accessor :metadata
+
+      def initialize
+        @metadata = {}
+      end
+    end
+  end
+end

data/lib/cased/cli/interactive_session.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'cased/cli/session'
+require 'tty/prompt'
 
 module Cased
   module CLI
@@ -27,6 +28,8 @@ module Cased
           command: command,
           metadata: metadata,
         )
+
+        @prompt = TTY::Prompt.new
       end
 
       def create
@@ -81,8 +84,11 @@ module Cased
       private
 
       def reason_prompt
-        print Cased::CLI::Log.string 'Please enter a reason for access: '
-        session.reason = STDIN.gets.chomp
+        reason = @prompt.multiline(Cased::CLI::Log.string('Please enter a reason for access:'), help: '(Press Ctrl+D or Ctrl+Z to submit)')
+        session.reason = reason.join("\n")
+      rescue TTY::Reader::InputInterrupt
+        Cased::CLI::Log.log 'Exiting and canceling request…'
+        exit 0
       end
 
       def wait_for_approval
@@ -112,8 +118,10 @@ module Cased
           exit 1
         when 'timed_out'
           Cased::CLI::Log.log 'CLI session has timed out'
+          exit 1
         when 'canceled'
           Cased::CLI::Log.log 'CLI session has been canceled'
+          exit 0
         end
       end
     end

data/lib/cased/cli/session.rb

@@ -124,11 +124,18 @@ module Cased
       # @return [Hash, nil]
       attr_reader :guard_application
 
+      # Public: Cased may filter out sensitive data in the command, we shouldn't
+      # execute what is returned from the server.
+      #
+      # @return [String, nil]
+      attr_reader :original_command
+
       def initialize(reason: nil, command: nil, metadata: {}, authentication: nil)
         @authentication = authentication || Cased::CLI::Authentication.new
         @reason = reason
-        @command = command || [$PROGRAM_NAME, *ARGV].join(' ')
-        @metadata = metadata
+        @original_command = command || [$PROGRAM_NAME, *ARGV].join(' ')
+        @command = @original_command
+        @metadata = Cased.config.cli.metadata.merge(metadata)
         @requester = {}
         @responder = {}
         @guard_application = {}
@@ -216,7 +223,7 @@ module Cased
 
         Cased::CLI::Log.log 'CLI session is now recording'
 
-        recorder = Cased::CLI::Recorder.new(command.split(' '), env: {
+        recorder = Cased::CLI::Recorder.new(original_command.split(' '), env: {
           'GUARD_SESSION_ID' => id,
           'GUARD_APPLICATION_ID' => guard_application.fetch('id'),
           'GUARD_USER_TOKEN' => requester.fetch('id'),

data/lib/cased/config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'cased/cli/config'
+
 module Cased
   class Config
     # The amount of time in seconds to allow the HTTP client to open a
@@ -149,6 +151,16 @@ module Cased
     #   end
     attr_writer :silence
 
+    # @example
+    #   Cased.configure do |config|
+    #     config.cli.metadata = {
+    #       rails_env: ENV['RAILS_ENV'],
+    #       heroku_application: ENV['HEROKU_APP_NAME'],
+    #       git_commit: ENV['GIT_COMMIT'],
+    #     }
+    #   end
+    attr_reader :cli
+
     def initialize
       @http_read_timeout = ENV.fetch('CASED_HTTP_READ_TIMEOUT', 10).to_i
       @http_open_timeout = ENV.fetch('CASED_HTTP_OPEN_TIMEOUT', 5).to_i
@@ -172,6 +184,7 @@ module Cased
           hash[normalized_key] = api_key if api_key
         end
       end
+      @cli = Cased::CLI::Config.new
     end
 
     # Policy keys are used to query for events from audit trails.
@@ -224,7 +237,7 @@ module Cased
     private
 
     def parse_bool(val)
-      %w[1 true t].include?(val&.downcase)
+      %w[1 true t].include?(val.to_s&.downcase)
     end
   end
 end

data/lib/cased/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cased
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cased-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Garrett Bjerkhoel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -305,6 +319,7 @@ files:
 - lib/cased/cli/asciinema/file.rb
 - lib/cased/cli/asciinema/writer.rb
 - lib/cased/cli/authentication.rb
+- lib/cased/cli/config.rb
 - lib/cased/cli/identity.rb
 - lib/cased/cli/interactive_session.rb
 - lib/cased/cli/log.rb
@@ -343,7 +358,7 @@ files:
 - lib/cased/sensitive/string.rb
 - lib/cased/test_helper.rb
 - lib/cased/version.rb
-- vendor/cache/activesupport-6.1.3.gem
+- vendor/cache/activesupport-6.1.3.2.gem
 - vendor/cache/addressable-2.7.0.gem
 - vendor/cache/ast-2.4.0.gem
 - vendor/cache/byebug-11.0.1.gem
@@ -352,20 +367,23 @@ files:
 - vendor/cache/crack-0.4.3.gem
 - vendor/cache/docile-1.3.2.gem
 - vendor/cache/dotpath-0.1.0.gem
-- vendor/cache/faraday-1.3.0.gem
+- vendor/cache/faraday-1.4.1.gem
+- vendor/cache/faraday-excon-1.1.0.gem
 - vendor/cache/faraday-net_http-1.0.1.gem
+- vendor/cache/faraday-net_http_persistent-1.1.0.gem
 - vendor/cache/faraday_middleware-1.0.0.gem
 - vendor/cache/hashdiff-1.0.1.gem
-- vendor/cache/i18n-1.8.9.gem
+- vendor/cache/i18n-1.8.10.gem
 - vendor/cache/jaro_winkler-1.5.4.gem
 - vendor/cache/json-2.5.1.gem
-- vendor/cache/jwt-2.2.2.gem
+- vendor/cache/jwt-2.2.3.gem
 - vendor/cache/minitest-5.13.0.gem
 - vendor/cache/mocha-1.11.2.gem
 - vendor/cache/multipart-post-2.1.1.gem
 - vendor/cache/net-http-persistent-3.1.0.gem
 - vendor/cache/parallel-1.19.1.gem
 - vendor/cache/parser-2.7.1.3.gem
+- vendor/cache/pastel-0.8.0.gem
 - vendor/cache/public_suffix-4.0.5.gem
 - vendor/cache/rack-2.2.2.gem
 - vendor/cache/rack-protection-2.0.8.1.gem
@@ -381,9 +399,15 @@ files:
 - vendor/cache/simplecov-0.18.5.gem
 - vendor/cache/simplecov-html-0.12.2.gem
 - vendor/cache/subprocess-1.5.4.gem
+- vendor/cache/tty-color-0.6.0.gem
+- vendor/cache/tty-cursor-0.7.1.gem
+- vendor/cache/tty-prompt-0.23.1.gem
+- vendor/cache/tty-reader-0.9.0.gem
+- vendor/cache/tty-screen-0.8.1.gem
 - vendor/cache/tzinfo-2.0.4.gem
 - vendor/cache/unicode-display_width-1.6.1.gem
 - vendor/cache/webmock-3.8.3.gem
+- vendor/cache/wisper-2.0.1.gem
 - vendor/cache/yard-0.9.24.gem
 - vendor/cache/zeitwerk-2.4.2.gem
 homepage: https://github.com/cased/cased-ruby