cased-ruby 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3404d2c5e8385e78dfd4a65f7cfc8a2f6554271a782cb693b19f11ad49c9bd97
-  data.tar.gz: 0f181045afaef98ccf76a78b7622b48d0d9d325dbe11ac8d57c052db646a3124
+  metadata.gz: a98d48b740d571c68ad950fe60ecd5af5126fa9567b80030c50bc9cf3f7428c3
+  data.tar.gz: b1fdbda8126943f5421176269d42d60144425790c22d57179abe6cf892e99cb6
 SHA512:
-  metadata.gz: ad8b59c1a598c4e131207fdec357059511446924f2606a198cc3a55f438d8ad4f777e4b1a372c6bb20a31270ea305f39ec90b590505ee5f387f3dc7e69574b3b
-  data.tar.gz: e492c1719d7a3fac650830d93a11735a0474852c790db6f503621eedff135c4ba5f4aae5bafffb344f12ea5cb18355a97b79dc83fa68db1cf988c211e090dc4b
+  metadata.gz: b519bd5dac037cc8ae8c5e795f44d658f44f44ad879e0456e1368dd18378323e5e9f4c8c8ea2e23a12958c4acc7c4c78a0b18afc95a57b6b78be8fe535bbfb0a
+  data.tar.gz: 9ce3b66f202ea6b431ae70d28cc4c22327eb4c5b25ac100a320a733964d91c08b139ecc75fbf4a5932f3603cc796983b9a9de39d68a80c54c80ada772bc7f3c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cased-ruby (0.4.5)
+    cased-ruby (0.4.6)
       activesupport (~> 6)
       dotpath (= 0.1.0)
       faraday (~> 1.0)
@@ -38,7 +38,7 @@ GEM
     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)

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/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/session.rb

@@ -128,7 +128,7 @@ module Cased
         @authentication = authentication || Cased::CLI::Authentication.new
         @reason = reason
         @command = command || [$PROGRAM_NAME, *ARGV].join(' ')
-        @metadata = metadata
+        @metadata = Cased.config.cli.metadata.merge(metadata)
         @requester = {}
         @responder = {}
         @guard_application = {}

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.

data/lib/cased/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cased-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Garrett Bjerkhoel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -305,6 +305,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
@@ -356,7 +357,7 @@ files:
 - vendor/cache/faraday-net_http-1.0.1.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