phi_attrs 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c95e0078a0816fa79591bab794e8c423d70d8792354cbb09cb69cda60b93d4b
-  data.tar.gz: 7af031bbc1cc1aa2ba308dc778611b590faf33b4e572e9e264477dde4fb24ace
+  metadata.gz: 1cc2ab95144c51b9ce2322864983ff9302d65d3e585c8ced98f1fe3098761173
+  data.tar.gz: 377a9e45f0069b4817a9156a66969b3056553707ae0f6a61716c16cbdc978a8a
 SHA512:
-  metadata.gz: a13b688097f56ad46044a7da0f91402565e582383e80f522f6ef3829fc75e677a5518a3190e261114713177ab6ab746783eb10bec4cc83215cf8089ca17cbc35
-  data.tar.gz: 323f3337e8d687e5e8e781324fd284008344a9ee8c15ff737840b736908face774331b762783076ffd5bb9e37a150452e4d712129a4a30fc169a33edde3abec9
+  metadata.gz: 78aa212eceac4e6b0ef10289ac0517b3d9943add98550fcffbc374e9d3d773ab3395d0cfae792161b6793f05fd7a08347e60b76201a6c719954956c902396fb2
+  data.tar.gz: 8fed8925c193caf3c169dff50800766d0abd9b45e6dd652de31b93b8219a2c3d425ac111a9c4b8608fbbfbc23a2e038f13bda2d89004a65fa801eb15dfcdbb37

data/.github/workflows/build.yml

@@ -11,15 +11,14 @@ jobs:
         ruby: [2.5, 2.6, 2.7]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Install dependencies
         run: |
-          gem install bundler
-          bundle install
           bundle exec appraisal install
       - name: Run rspec
         run: bundler exec appraisal rspec

data/.github/workflows/publish.yml

@@ -11,18 +11,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.6'
-      - name: Install dependencies
-        run: |
-          gem install bundler:2.1.4
-          bundle install
+          bundler-cache: true
       - name: Release Gem
         if: contains(github.ref, 'refs/tags/v')
         uses: cadwallion/publish-rubygems-action@master
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-          RELEASE_COMMAND: bundle exec rake release
+          RELEASE_COMMAND: bundle exec rake release

data/README.md

@@ -39,7 +39,7 @@ Or install it yourself as:
 
 ## Initialize
 
-Create an initializer to configure the PHI log file location.
+Create an initializer to configure the PHI log file location. Log rotation can be configured with log_shift_age and log_shift_size (disabled by default).
 
 Example:
 
@@ -48,6 +48,8 @@ Example:
 ```ruby
 PhiAttrs.configure do |conf|
   conf.log_path = Rails.root.join("log", "phi_access_#{Rails.env}.log")
+  conf.log_shift_age  = 10            # how many logs to keep of `log_shift_size` or frequency to rotate ('daily', 'weekly' or 'monthly'). Disable rotation with 0 (default).
+  conf.log_shift_size = 100.megabytes # size in bytes when using `log_shift_age` as a number
 end
 ```
 
@@ -275,7 +277,7 @@ There is also a block syntax of `disallow_phi` for temporary suppression phi acc
 ```ruby
 patient = PatientInfo.find(params[:id])
 patient.allow_phi!('allowed_user@example.com', 'Display Patient Data')
-patient.diallow_phi do
+patient.disallow_phi do
   @data = patient.to_json # PHIAccessException
 end # Access is allowed again beyond this point
 ```
@@ -284,7 +286,7 @@ or a block level on a class:
 
 ```ruby
 PatientInfo.allow_phi!('allowed_user@example.com', 'Display Patient Data')
-PatientInfo.diallow_phi do
+PatientInfo.disallow_phi do
   @data = PatientInfo.find(params[:id]).to_json # PHIAccessException
 end # Access is allowed again beyond this point
 ```
@@ -391,6 +393,27 @@ person_phi.allow_phi(nil, "Because I felt like looking at PHI") do
 end
 ```
 
+### Request UUID
+
+It can be helpful to include the Rails request UUID to match up your general application
+logs to your PHI access logs. The following snippet will prepend your PHI access logs
+with the request UUID.
+
+#### `app/controllers/application_controller.rb`
+
+```ruby
+around_action :tag_phi_log_with_request_id
+
+...
+
+private
+
+def tag_phi_log_with_request_id
+  PhiAttrs::Logger.logger.tagged("Request ID: #{request.uuid}") do
+    yield
+  end
+end
+```
 ## Best Practices
 
 * Mix and matching `instance`, `class` and `block` syntaxes for allowing/denying PHI is not recommended.

data/lib/phi_attrs/configure.rb

@@ -2,6 +2,8 @@
 
 module PhiAttrs
   @@log_path = nil
+  @@log_shift_age = 0 # Default to disabled
+  @@log_shift_size = 1048576 # 1MB - Default from logger class
   @@current_user_method = nil
   @@translation_prefix = 'phi'
 
@@ -17,6 +19,22 @@ module PhiAttrs
     @@log_path = value
   end
 
+  def self.log_shift_age
+    @@log_shift_age
+  end
+
+  def self.log_shift_age=(value)
+    @@log_shift_age = value
+  end
+
+  def self.log_shift_size
+    @@log_shift_size
+  end
+
+  def self.log_shift_size=(value)
+    @@log_shift_size = value
+  end
+
   def self.translation_prefix
     @@translation_prefix
   end

data/lib/phi_attrs/logger.rb

@@ -7,7 +7,7 @@ module PhiAttrs
     class << self
       def logger
         unless @logger
-          logger = ActiveSupport::Logger.new(PhiAttrs.log_path)
+          logger = ActiveSupport::Logger.new(PhiAttrs.log_path, PhiAttrs.log_shift_age, PhiAttrs.log_shift_size)
           logger.formatter = Formatter.new
           @logger = ActiveSupport::TaggedLogging.new(logger)
         end

data/lib/phi_attrs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhiAttrs
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phi_attrs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Wyatt Kirby
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -285,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: PHI Access Restriction & Logging for Rails ActiveRecord