path-reporting 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d921c4f5d8a011b077006a44cb6800d3f9d63329b46d750626aa9ff9fd17859
-  data.tar.gz: 1828887be14dbb2b8cbbe5a382e36e14800fce6d5b306764234e0f1f974729ac
+  metadata.gz: 134152ef7ea6fed2b3b09883f364a31ebb1e21ef6b5f6cd3db8108ddc750de8a
+  data.tar.gz: f059d45004af1ba04ae2b8af2838de5a7fbbaa4575f53873123204546f1190fb
 SHA512:
-  metadata.gz: 213c4dffd2afaaf7589ce520aa6cbe78d9ecf998ef0528fe9f35e1539d0b547a292a5ec0c42cd9f6031b25ab31628baca91356abbcb0eda2ebbc6a4a7e702bd5
-  data.tar.gz: 624e433365f0b3099c3c2d5e3eed73ca6aa2ba7648fd4df7590ebd578dc0752e1cea64a1b30073fe34b3d1386ca7dcde1683237db61e90d65981e3290c0504a0
+  metadata.gz: d9634c2cf01eeaa497d1b3df429568f40bb6d714235aa8f0922b9196376301679c72d5d58f48e8f942f852553712f72a6577edb96e4dfd8e3ccfd5473e5acb36
+  data.tar.gz: aeb9e1f444090af5ed104917b222327d3fe8dd95147964b7f8297065252b8d10feb19445cf5df4eb74724aa7807824e67a6939ca82c9aa23793d124e18e886f0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.3

data/.yardopts

@@ -1 +1 @@
---no-private --plugin rspec
+--no-private --plugin rspec -m markdown --title="Path Reporting"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    path-reporting (0.1.1)
+    path-reporting (0.1.4)
       amplitude-api
 
 GEM
@@ -61,6 +61,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   amplitude-api (~> 0.4.1)

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Path CCM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,12 @@
-# Reporting
+# Path Reporting
 
-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/reporting`. To experiment with that code, run `bin/console` for an interactive prompt.
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pathccm/reporting/Ruby?style=flat-square) ![Gem](https://img.shields.io/gem/v/path-reporting?style=flat-square) ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/rubygems/path-reporting?style=flat-square) ![GitHub](https://img.shields.io/github/license/pathccm/reporting?style=flat-square)
 
-TODO: Delete this and the text above, and describe your gem
+The one stop shop for reporting at [Path](https://pathmentalhealth.com)
+
+This gem contains (or will contain) all the various types of reporting we need
+to do at Path. From metrics to analytics to performance and beyond, this gem
+is meant to enable us to report anything we need as simply as possible.
 
 ## Installation
 
@@ -16,7 +20,35 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+First you will need to initialize and configure the module
+
+```ruby
+Path::Reporting.init do |config|
+  config.analytics.logger = Rails.logger
+end
+```
+
+See [our Configuration docs](https://www.rubydoc.info/gems/path-reporting/Path/Reporting/Configuration)
+for more information on how to configure this module
+
+### Analytics
+
+After initialing the module, record an analytics event with the following code.
+
+```ruby
+
+Path::Reporting.analytics.record(
+  product_code: Constants::ANALYTICS_PRODUCT_CODE,
+  product_area: Constants::ANALYTICS_PRODUCT_AREA_MATCHING,
+  name: 'Preferred provider multiple valid matches',
+  user: @contact.analytics_friendly_hash,
+  user_type: Path::Reporting::UserType::PATIENT,
+  trigger: Path::Reporting::Trigger::PAGE_VIEW,
+  metadata: analytics_metadata,
+)
+```
+
+Be sure to read our [Analytics Guide (Internal Doc)](https://docs.google.com/document/d/1axnk1EkKCb__sxtvMomrPNup3wsviDOAefQWwXU3Z3U/edit#)
 
 ## Development
 

data/lib/path/reporting/analytics/amplitude.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "amplitude-api"
+
+# See https://developers.amplitude.com/docs/http-api-v2#schemauploadrequestbody
+API_METADATA_TO_ELEVATE = [
+  "device_id",
+  "app_version",
+  "platform",
+  "os_name",
+  "os_version",
+  "device_brand",
+  "device_manufacturer",
+  "device_model",
+  "carrier",
+  "country",
+  "region",
+  # We do not elevate city because at that level it is possibly PII
+  "dma",
+  "language",
+  "price",
+  "quantity",
+  "revenue",
+  "productId",
+  "revenueType",
+  # We do not elevate lat/long/IP because it is PII (IP at least for analytics)
+  "event_id",
+  "session_id",
+  "insert_id",
+  "plan"
+].freeze
+
+# Amplitue is not HIPAA compliant, so there are a number of PII things we want
+# to make sure to filter out. These are keys (all lowercase) that are things
+# we want to filter. Lowercased matching keys in data are obfuscated.
+DISALLOWED_METADATA_PII_KEYS = %w[
+  email
+  name
+  first_name
+  firstname
+  last_name
+  lastname
+  zip
+  ssn
+  dob
+  address
+  phone
+  contactinfo
+  patient_chart_id
+].freeze
+
+# Don't clean to infinity (and beyond)
+MAX_METADATA_DEPTH = 4
+
+module Path
+  module Reporting
+    class Analytics
+      # Amplitude analytics is our primary analytics channel for production
+      class Amplitude
+        # Setup and configure AmplitudeAPI with the given configuration
+        # @param config [AmplitudeAPI::Config] the configuration for AmplitudeAPI
+        # @see https://www.rubydoc.info/gems/amplitude-api/AmplitudeAPI/Config AmplitudeAPI::Config Documentation
+        # @see https://github.com/toothrot/amplitude-api AmplitudeAPI repository
+        def initialize(config)
+          @config = config
+
+          config.amplitude_config.each do |key, value|
+            AmplitudeAPI.config.instance_variable_set("@#{key}", value)
+          end
+        end
+
+        # Record the metadata to Amplitude
+        # @param name [String] Formatted name to send to Amplitude
+        # @param user [Hash] User object. Must contain `:id` and no PII
+        # @param user_type [UserType] Type of `user`
+        # @param trigger [Trigger] Trigger for this event
+        # @param metadata [Hash] Metadata to send with the event
+        # @see Analytics
+        def record(name:, user:, user_type:, trigger:, metadata: {})
+          user = user.dup
+          metadata = metadata.dup
+          user[:user_type] = user_type
+          metadata[:trigger] = trigger
+
+          event_props = {
+            user_id: user[:id].to_s,
+            user_properties: scrub_pii(user),
+            event_type: name,
+            event_properties: scrub_pii(metadata)
+          }
+          API_METADATA_TO_ELEVATE.each do |key|
+            event_props[key] = metadata[key] if metadata.key? key
+          end
+
+          AmplitudeAPI.track AmplitudeAPI::Event.new event_props
+        end
+
+        # Scrub known PII keys from a hash
+        # @private
+        def scrub_pii(data, depth: 0)
+          return "[DATA]" if depth > MAX_METADATA_DEPTH
+
+          case data
+          when Hash
+            data = data.dup
+            # Replace any disallowed keys, and recurse for allowed values
+            data.each do |key, val|
+              data[key] = if DISALLOWED_METADATA_PII_KEYS.include? key.to_s
+                            "XXXXXXXX"
+                          else
+                            scrub_pii(val, depth: depth + 1)
+                          end
+            end
+          when Array
+            return data.map { |item| scrub_pii(item, depth: depth + 1) }
+          end
+
+          data
+        end
+      end
+    end
+  end
+end

data/lib/path/reporting/analytics/configuration.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Path
+  module Reporting
+    class Analytics
+      # Configuration for analytics reporting. Generally this is for
+      # configuring amplitude and/or a logger that analytics should
+      # be reported to
+      # @!attribute amplitude_config
+      #   Set the configuration for the AmplitudeAPI gem
+      #   @return [Hash] amplitude configuration options as passed along to the amplitude-api gem
+      #   @see https://www.rubydoc.info/gems/amplitude-api/AmplitudeAPI/Config AmplitudeAPI::Config
+      # @!attribute logger
+      #   The logger for the console logging analytics reporter
+      #   @return [#info] a logging interface with a .info method we can log analytics to
+      #   @example
+      #     conf.logger = Rails.logger
+      class Configuration
+        attr_reader :amplitude_config, :logger
+
+        # New Configuration with all reporting off by default
+        def initialize
+          @console_enabled = false
+          @logger = nil
+          @amplitude_enabled = false
+          @amplitude_config = nil
+        end
+
+        def logger=(logger)
+          @console_enabled = !logger.nil?
+          @logger = logger
+        end
+
+        alias console= logger=
+
+        # Check if the logger has been configured and is available for use
+        # @return [Boolean] if logger is available for use
+        def console_enabled?
+          @console_enabled && @logger
+        end
+
+        # Set the configuration for the AmplitudeAPI gem
+        # @param conf [Hash] configuration options for amplitude
+        # @return [Hash] amplitude configuration options as passed along to the amplitude-api gem
+        # @see https://www.rubydoc.info/gems/amplitude-api/AmplitudeAPI/Config AmplitudeAPI::Config
+        def amplitude_config=(conf)
+          @amplitude_enabled = !conf.nil?
+          @amplitude_config = conf
+        end
+
+        alias amplitude= amplitude_config=
+
+        # Check if Amplitude has been configured and is available for use
+        # @return [Boolean] if Amplitude is available for use
+        def amplitude_enabled?
+          @amplitude_enabled && @amplitude_config
+        end
+      end
+    end
+  end
+end

data/lib/path/reporting/analytics/console.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Path
+  module Reporting
+    class Analytics
+      # Simple non-structure console logging for analytics data. Most helpful
+      # for development or backup rather than analysis.
+      class Console
+        # Create new console logging analytics reporter
+        # @param config [Analytics::Configuration] the configuration for the reporter
+        # @see Analytics::Configuration
+        def initialize(config)
+          @config = config
+        end
+
+        # Log the analytics event to the configured logger
+        # @param name [String] Formatted name to send to Amplitude
+        # @param user [Hash] User object. Must contain `:id` and no PII
+        # @param user_type [UserType] Type of `user`
+        # @param trigger [Trigger] Trigger for this event
+        # @param metadata [Hash] Metadata to send with the event
+        # @see Analytics
+        def record(name:, user:, user_type:, trigger:, metadata: {})
+          @config.logger.info("[#{trigger}]:#{name} - #{user.inspect} (#{user_type}) #{metadata.nil? ? "" : metadata.inspect}")
+        end
+      end
+    end
+  end
+end

data/lib/path/reporting/analytics.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require_relative "analytics/amplitude"
+require_relative "analytics/console"
+require_relative "types/trigger"
+require_relative "types/user_type"
+
+module Path
+  module Reporting
+    # Our primary class for reporting analytics data. Once configured, this
+    # class can report analytics to any and all enabled and configured
+    # reporters.
+    #
+    # This class is not a singleton, but is exposed via the {Reporting.analytics}
+    # property once the Reporting module is initialized
+    class Analytics
+      # Create a new analytics reporter with the given configuration
+      # @param config [Analytics::Configuration] configuration to use
+      def initialize(config)
+        @config = config
+      end
+
+      # Get clients for reporting events based on environment
+      # @private
+      def clients
+        if @clients.nil?
+          @clients = {
+            amplitude: setup_amplitude,
+            console: setup_console
+          }
+        end
+
+        @clients
+      end
+
+      # @private
+      def setup_amplitude
+        # Amplitude reporting for metrics
+        return Path::Reporting::Analytics::Amplitude.new @config if @config.amplitude_enabled?
+
+        nil
+      end
+
+      # @private
+      def setup_console
+        return Path::Reporting::Analytics::Console.new @config if @config.console_enabled?
+
+        nil
+      end
+
+      # Normalize the event name for easier searching in our analytics tools
+      #
+      # Generally the format is:
+      # - Product code: All uppercase, _ separator between words
+      # - Product area: Upper camel case, no spaces or separators
+      # - (Event) Name: Sentence case, _ separator between words
+      # @private
+      def format_event_name(product_code:, product_area:, name:)
+        formatted_code = product_code.gsub(" ", "_").upcase
+        formatted_area = product_area.split(" ").each(&:capitalize!).join("")
+        formatted_desc = name.capitalize.gsub(" ", "_")
+        "#{formatted_code}_#{formatted_area}_#{formatted_desc}"
+      end
+
+      # Record analytics data to our enabled analytics channel
+      #
+      # This is the primary (and at the moment only) way to report analytics
+      # data in our systems. Every configured analytics reporter will record
+      # the event with the data given here.
+      #
+      # @note ***No patient PII or PHI is allowed in our analytics data.***
+      #   By default we will attempt to strip this out of user data as well
+      #   as metadata, but this is imperfect and should not be relied on.
+      #   Instead, proactively exclude that data before it gets here.
+      # @note The `product_code`, `product_area`, and `name` parameters will
+      #   be formatted for easier searching automatically. Feel free to use
+      #   regular text formatting here. E.g. "Self Scheduling" or "Hold booked"
+      #
+      # @param product_code [String] Code denoting which product this event
+      #   occurred within. For example, "Self Scheduling". Can be used to view
+      #   all the events that happen in a specific product
+      #
+      #   Bias names toward whatever the major user-facing component is. For
+      #   example, Therapy or Operations.
+      # @param product_area [String] Area of the product that event relates to.
+      #   For example, “Appointment Booking” or “User Settings”. Can be used to
+      #   see all events in a particular product area, as well as in rare cases
+      #   be used across product codes to show events across the system.
+      #
+      #   Bias this name toward the particular flow or feature being used,
+      #   e.g. Scheduling
+      # @param name [String] Short plain text description of the event that is
+      #   being recorded. For example, “Hold booked”
+      #
+      #   Follow the format: “Object action [descriptor]”. For example,
+      #   “Hold converted to appointment” or “Appointment deleted”
+      # @param user [Hash] A simple hash containing relevant user information.
+      #   **This information should never contain any PII or PHI**. There does,
+      #   however, need to be an `id` property to uniquely identify the user.
+      #
+      #   One of the following (in order):
+      #
+      #   1. Patient/User
+      #   2. If it does not relate to a patient, Provider
+      #   3. If it does not relate to a patient or provider, Insurer
+      #   4. If it does not relate to a patient, provider, or insurer, use external system ID information
+      #       - E.g. for Zocdoc, this maybe the primary key for their API key
+      #       - Do not use an API key as an identifier, instead use another key like the id in our database for that key
+      #
+      #   If a different user (like an ops person) took an action, put an ID
+      #   for them under `agent_id` in the metadata
+      # @param user_type [Reporting::UserType] The type of user we are reporting
+      #   this event for
+      # @param trigger [Reporting::Trigger] What triggered this event to be
+      #   recoreded (e.g. a page view, or an interaction).
+      # @param metadata [Hash] Metadata to report alongside the analytics event.
+      #    **This should not contain any PII or PHI*
+      #
+      # @example
+      #   PathReporting.analytics.record(
+      #     product_code: Constants::ANALYTICS_PRODUCT_CODE,
+      #     product_area: Constants::ANALYTICS_PRODUCT_AREA_MATCHING,
+      #     name: 'Preferred provider multiple valid matches',
+      #     user: @contact.analytics_friendly_hash,
+      #     user_type: PathReporting::UserType::PATIENT,
+      #     trigger: PathReporting::Trigger.PAGE_VIEW,
+      #     metadata: analytics_metadata,
+      #   )
+      # @example Validating Successful Reporting
+      #    analytics_reported = PathReporting.analytics.record(
+      #      product_code: Constants::ANALYTICS_PRODUCT_CODE,
+      #      product_area: Constants::ANALYTICS_PRODUCT_AREA_MATCHING,
+      #      name: 'No preferred provider',
+      #      user: @contact.analytics_friendly_hash,
+      #      user_type: PathReporting::UserType::PATIENT,
+      #      trigger: PathReporting::Trigger.PAGE_VIEW,
+      #    )
+      #
+      #    analytics_reported.each do |status|
+      #      Rails.logger.warn("#{status.reporter} failed") unless status.result.nil?
+      #    end
+      #
+      # @raise [StandardError] if no user is provided or user does not have id
+      # @raise [StandardError] if user_type is not a Reporting::UserType
+      # @raise [StandardError] if trigger is not a Reporting::Trigger
+      #
+      # @return [Array] An array of result hashes with two keys:
+      #
+      #     - `reporter` [String] the analytics reporter the result is for
+      #     - `result` [nil | StandardError] what the result of running this
+      #        reporter was. If it did not run, it will always be `nil`
+      #
+      # @see https://docs.google.com/document/d/1axnk1EkKCb__sxtvMomrPNup3wsviDOAefQWwXU3Z3U/edit# Analytics Guide
+      # @see Reporting::UserType
+      # @see Reporting::Trigger
+      def record(
+        product_code:,
+        product_area:,
+        name:,
+        user:,
+        user_type: UserType::PATIENT,
+        trigger: Trigger::INTERACTION,
+        metadata: {}
+      )
+        throw Error("No user provided when reporting analytics") if !user || !user[:id]
+        throw Error("Invalid UserType #{user_type}") unless UserType.valid?(user_type)
+        throw Error("Invalid Trigger #{trigger}") unless Trigger.valid?(trigger)
+
+        clients.map do |reporter, client|
+          {
+            reporter: reporter.to_s,
+            result: send_event_to_client(client, {
+                                           name: format_event_name(product_code: product_code, product_area: product_area, name: name),
+                                           user: user,
+                                           user_type: user_type,
+                                           metadata: metadata,
+                                           trigger: trigger
+                                         })
+          }
+        end
+      end
+
+      # Wraps sending to the client in a rescue so we can report results
+      # without causing other reporters to not run
+      # @private
+      def send_event_to_client(client, event)
+        client&.record(**event)
+        nil
+      rescue StandardError => e
+        e
+      end
+
+      # Primarily used for testing
+      # @private
+      def reset!
+        @clients = nil
+      end
+    end
+  end
+end

data/lib/{configuration.rb → path/reporting/configuration.rb}

@@ -4,6 +4,7 @@ require_relative "analytics/configuration"
 
 module Path
   module Reporting
+    # Global configuration for all reporting sub-modules
     # @!attribute [r] analytics
     #   @return [Analytics::Configuration] the configuration for analytics reporting
     class Configuration

data/lib/path/reporting/types/trigger.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Path
+  module Reporting
+    # The trigger or cause of reporting events
+    class Trigger
+      # Interaction: When a direct intentional user action is the cause of
+      # this event that is not a simple navigation. E.g. Submitted form or
+      # changed password
+      INTERACTION = "Interaction"
+      # Page view: When the event was an indirect result of viewing something.
+      # E.g. auto-assigning a provider or appointment because the user has an
+      # existing provider already
+      # @note Because of usage limits, we do not want to record page views
+      #   as a separate action, this is only for indirect consequences that
+      #   result in a change in something either for the user or for our
+      #   systems
+      PAGE_VIEW = "Page view"
+      # Automation: Some automation or tool was the cause of this event
+      AUTOMATION = "Automation"
+
+      class << self
+        # @private
+        def triggers
+          [
+            INTERACTION,
+            PAGE_VIEW,
+            AUTOMATION
+          ]
+        end
+
+        # Check if a given item is a valid Trigger
+        # @param maybe_trigger [Any] item to check
+        def valid?(maybe_trigger)
+          triggers.includes? maybe_trigger
+        end
+      end
+    end
+  end
+end

data/lib/path/reporting/types/user_type.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Path
+  module Reporting
+    # User types that data may be recorded for or on
+    class UserType
+      # Patient or potential patient
+      PATIENT = "Patient"
+      # Provider, which can be any sub-type (e.g. therapist)
+      PROVIDER = "Provider"
+      # Insurer, not currently in-use
+      INSURER = "Insurer"
+      # Operator or any internal non-developer
+      OPERATOR = "Operator"
+      # Developer; mostly relevant for backfills or manual intervention
+      DEVELOPER = "Developer"
+      # System, either first-party or third-party
+      SYSTEM = "System"
+
+      class << self
+        # @private
+        def types
+          [
+            PATIENT,
+            PROVIDER,
+            INSURER,
+            OPERATOR,
+            DEVELOPER,
+            SYSTEM
+          ]
+        end
+
+        # Check if a given item is a valid UserType
+        # @param maybe_type [Any] item to check
+        def valid?(maybe_type)
+          types.include? maybe_type
+        end
+      end
+    end
+  end
+end

data/lib/{reporting → path/reporting}/version.rb

@@ -2,6 +2,7 @@
 
 module Path
   module Reporting
-    VERSION = "0.1.1"
+    # Current version of the module
+    VERSION = "0.1.4"
   end
 end

data/lib/{reporting.rb → path/reporting.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "analytics/analytics"
-require_relative "configuration"
+require_relative "reporting/analytics"
+require_relative "reporting/configuration"
 require_relative "reporting/version"
 
 # Path is just a wrapper module so we can group any path specific gems under
@@ -12,6 +12,7 @@ module Path
   # meant to be a one-stop shop for all of our ruby code to import and have
   # everything they need to track all the things
   module Reporting
+    # @private
     class Error < StandardError; end
 
     class << self

data/lib/path.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# defines the Path namespace
+module Path
+end

data/reporting.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/reporting/version"
+require_relative "lib/path/reporting/version"
 
 Gem::Specification.new do |spec|
   spec.name = "path-reporting"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: path-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Alexis Hushbeck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amplitude-api
@@ -47,20 +47,23 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - ".yardopts"
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
-- lib/analytics/analytics.rb
-- lib/analytics/channels/amplitude.rb
-- lib/analytics/channels/console.rb
-- lib/analytics/configuration.rb
-- lib/configuration.rb
-- lib/reporting.rb
-- lib/reporting/version.rb
-- lib/types/trigger.rb
-- lib/types/user_type.rb
+- lib/path.rb
+- lib/path/reporting.rb
+- lib/path/reporting/analytics.rb
+- lib/path/reporting/analytics/amplitude.rb
+- lib/path/reporting/analytics/configuration.rb
+- lib/path/reporting/analytics/console.rb
+- lib/path/reporting/configuration.rb
+- lib/path/reporting/types/trigger.rb
+- lib/path/reporting/types/user_type.rb
+- lib/path/reporting/version.rb
 - reporting.gemspec
 - sig/reporting.rbs
 homepage: https://github.com/pathccm/reporting

data/lib/analytics/analytics.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "channels/amplitude"
-require_relative "channels/console"
-require_relative "../types/trigger"
-require_relative "../types/user_type"
-
-module Path
-  module Reporting
-    class Analytics
-      def initialize(config)
-        @config = config
-      end
-
-      # Get clients for reporting events based on environment
-      def clients
-        if @clients.nil?
-          @clients = {
-            amplitude: setup_amplitude,
-            console: setup_console
-          }
-        end
-
-        @clients
-      end
-
-      def setup_amplitude
-        # Amplitude reporting for metrics
-        return Path::Reporting::Analytics::Channels::Amplitude.new @config if @config.amplitude_enabled?
-
-        nil
-      end
-
-      def setup_console
-        return Path::Reporting::Analytics::Channels::Console.new @config if @config.console_enabled?
-
-        nil
-      end
-
-      def format_event_name(product_code:, product_area:, name:)
-        formatted_code = product_code.gsub(" ", "_").upcase
-        formatted_area = product_area.split(" ").each(&:capitalize!).join("")
-        formatted_desc = name.capitalize.gsub(" ", "_")
-        "#{formatted_code}_#{formatted_area}_#{formatted_desc}"
-      end
-
-      def record(
-        product_code:,
-        product_area:,
-        name:,
-        user:,
-        user_type: UserType.PATIENT,
-        trigger: Trigger.INTERACTION,
-        metadata: {}
-      )
-        throw Error("No user provided when reporting analytics") unless user
-        throw Error("Invalid UserType #{user_type}") unless UserType.valid?(user_type)
-        throw Error("Invalid Trigger #{trigger}") unless Trigger.valid?(trigger)
-
-        all_succeeded = true
-        exceptions = {}
-        clients.each do |_reporter, client|
-          next if client.nil?
-
-          begin
-            event_name = format_event_name(product_code: product_code, product_area: product_area, name: name)
-            client.record(
-              name: event_name,
-              user: user,
-              user_type: user_type,
-              metadata: metadata,
-              trigger: trigger
-            )
-            exceptions[client.channel_name] = nil
-          rescue StandardError => e
-            all_succeeded = false
-            exceptions[client.channel_name] = e
-          end
-        end
-
-        {
-          all_succeeded: all_succeeded,
-          exceptions: exceptions
-        }
-      end
-
-      def reset!
-        @clients = nil
-      end
-    end
-  end
-end

data/lib/analytics/channels/amplitude.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require "amplitude-api"
-
-# See https://developers.amplitude.com/docs/http-api-v2#schemauploadrequestbody
-API_METADATA_TO_ELEVATE = [
-  "device_id",
-  "app_version",
-  "platform",
-  "os_name",
-  "os_version",
-  "device_brand",
-  "device_manufacturer",
-  "device_model",
-  "carrier",
-  "country",
-  "region",
-  # We do not elevate city because at that level it is possibly PII
-  "dma",
-  "language",
-  "price",
-  "quantity",
-  "revenue",
-  "productId",
-  "revenueType",
-  # We do not elevate lat/long/IP because it is PII (IP at least for analytics)
-  "event_id",
-  "session_id",
-  "insert_id",
-  "plan"
-].freeze
-
-# Amplitue is not HIPAA compliant, so there are a number of PII things we want
-# to make sure to filter out. These are keys (all lowercase) that are things
-# we want to filter. Lowercased matching keys in data are obfuscated.
-DISALLOWED_METADATA_PII_KEYS = %w[
-  email
-  name
-  first_name
-  firstname
-  last_name
-  lastname
-  zip
-  ssn
-  dob
-  address
-  phone
-  contactinfo
-  patient_chart_id
-].freeze
-
-# Don't clean to infinity (and beyond)
-MAX_METADATA_DEPTH = 4
-
-module Path
-  module Reporting
-    class Analytics
-      module Channels
-        # Amplitude analytics is our primary analytics channel for production
-        class Amplitude
-          attr_reader :channel_name
-
-          def initialize(config)
-            @channel_name = "Amplitude"
-            @config = config
-
-            config.amplitude_config.each do |key, value|
-              AmplitudeAPI.config.instance_variable_set("@#{key}", value)
-            end
-          end
-
-          def record(name:, user:, user_type:, trigger:, metadata: {})
-            user = user.dup
-            metadata = metadata.dup
-            user[:user_type] = user_type
-            metadata[:trigger] = trigger
-
-            event_props = {
-              user_id: user[:id].to_s,
-              user_properties: scrub_pii(user),
-              event_type: name,
-              event_properties: scrub_pii(metadata)
-            }
-            API_METADATA_TO_ELEVATE.each do |key|
-              event_props[key] = metadata[key] if metadata.key? key
-            end
-
-            AmplitudeAPI.track AmplitudeAPI::Event.new event_props
-          end
-
-          def scrub_pii(data, depth: 0)
-            return "[DATA]" if depth > MAX_METADATA_DEPTH
-
-            case data
-            when Hash
-              data = data.dup
-              # Replace any disallowed keys, and recurse for allowed values
-              data.each do |key, val|
-                data[key] = if DISALLOWED_METADATA_PII_KEYS.include? key.to_s
-                              "XXXXXXXX"
-                            else
-                              scrub_pii(val, depth: depth + 1)
-                            end
-              end
-            when Array
-              return data.map { |item| scrub_pii(item, depth: depth + 1) }
-            end
-
-            data
-          end
-        end
-      end
-    end
-  end
-end

data/lib/analytics/channels/console.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Path
-  module Reporting
-    class Analytics
-      module Channels
-        class Console
-          attr_reader :channel_name
-
-          def initialize(config)
-            @channel_name = "Console"
-            @config = config
-          end
-
-          def record(name:, user:, user_type:, trigger:, metadata: {})
-            @config.console_logger.info("[#{trigger}]:#{name} - #{user.inspect} (#{user_type}) #{metadata.nil? ? "" : metadata.inspect}")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/analytics/configuration.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Path
-  module Reporting
-    class Analytics
-      class Configuration
-        attr_accessor :console_enabled
-        attr_reader :amplitude_config, :console_logger
-
-        def initialize
-          @console_enabled = false
-          @console_logger = nil
-          @amplitude_enabled = false
-          @amplitude_config = nil
-        end
-
-        def logger=(logger)
-          @console_enabled = !logger.nil?
-          @console_logger = logger
-        end
-
-        alias console= logger=
-
-        def console_enabled?
-          @console_enabled && @console_logger
-        end
-
-        def amplitude_config=(conf)
-          @amplitude_enabled = !conf.nil?
-          @amplitude_config = conf
-        end
-
-        alias amplitude= amplitude_config=
-
-        def amplitude_enabled?
-          @amplitude_enabled && @amplitude_config
-        end
-      end
-    end
-  end
-end

data/lib/types/trigger.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Path
-  module Reporting
-    class Trigger
-      class << self
-        INTERACTION = "Interaction"
-        PAGE_VIEW = "Page view"
-        AUTOMATION = "Automation"
-
-        def triggers
-          [
-            INTERACTION,
-            PAGE_VIEW,
-            AUTOMATION
-          ]
-        end
-
-        def valid?(maybe_trigger)
-          triggers.includes? maybe_trigger
-        end
-      end
-    end
-  end
-end

data/lib/types/user_type.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Path
-  module Reporting
-    class UserType
-      class << self
-        PATIENT = "Patient"
-        PROVIDER = "Provider"
-        INSURER = "Insurer"
-        OPERATOR = "Operator"
-        DEVELOPER = "Developer"
-        SYSTEM = "System"
-
-        def types
-          [
-            PATIENT,
-            PROVIDER,
-            INSURER,
-            OPERATOR,
-            DEVELOPER,
-            SYSTEM
-          ]
-        end
-
-        def valid?(maybe_type)
-          types.includes? maybe_type
-        end
-      end
-    end
-  end
-end