path-reporting 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 612edf8ed822d34efd5492f054daccdca4c8c1d667968bbbb6792d970f84f48e
-  data.tar.gz: 87c775d49a7299a74309e0e34ef024027b9d2d36b7e1cd845a83dcf2d473e55e
+  metadata.gz: 65674aaa398a650317c350551a9687bc580927ca8c69be1aec45c5888e2135a0
+  data.tar.gz: 387f6fe0f5ea344dfa3bda38bdc9caa01ca24f4d99eb56fba464624e54f137bc
 SHA512:
-  metadata.gz: 2eccd9730018b5e4e1468229ebc630e39a539dad448b5d7b71a8aa922a63d7912d56dbca08decf109f287710ac282f36d93d0061480f14df871c8c5e3aa614cd
-  data.tar.gz: c1f436dae888ddd42d396d9b7cd3f7f50e4a6ad6f9767e8eb4b6b9675bc2afc2f2a72016b5d2a1fc51ad90ca159fad08f02d48b3fe9036da7149afd1d299fe49
+  metadata.gz: 310a25c14394ac6f910b751ae09ff8aa6d9a49c048fe36724ce4cb42395f7191c550cc223add47ffcda3c4e2c91c2a70d2480b7e7d50e093ff5c92f7eaec7d71
+  data.tar.gz: bfe1442c36f0ea3822d9294ac156183b944be879ef39baec1cbca8598e820cca6a1a8f4fb58190843d8d00e7ba94890023e0e8d9471a67ae35550502bc3343a0

data/.rubocop.yml

@@ -23,6 +23,10 @@ Metrics/MethodLength:
     # is difficult to break up reasonably and keep it easy to understand
     - scrub_pii
 
+Metrics/AbcSize:
+  IgnoredMethods:
+    - record
+
 Metrics/ParameterLists:
   Max: 7
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    path-reporting (0.1.3)
+    path-reporting (0.2.0)
       amplitude-api
 
 GEM

data/README.md

@@ -42,8 +42,8 @@ Path::Reporting.analytics.record(
   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,
+  user_type: Path::Reporting::UserType::PATIENT,
+  trigger: Path::Reporting::Trigger::PAGE_VIEW,
   metadata: analytics_metadata,
 )
 ```

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

@@ -57,6 +57,8 @@ module Path
     class Analytics
       # Amplitude analytics is our primary analytics channel for production
       class Amplitude
+        attr_reader :config
+
         # 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
@@ -64,7 +66,7 @@ module Path
         def initialize(config)
           @config = config
 
-          config.amplitude_config.each do |key, value|
+          config.analytics.amplitude_config.each do |key, value|
             AmplitudeAPI.config.instance_variable_set("@#{key}", value)
           end
         end
@@ -81,9 +83,10 @@ module Path
           metadata = metadata.dup
           user[:user_type] = user_type
           metadata[:trigger] = trigger
+          metadata[:system_name] = config.system_name
 
           event_props = {
-            user_id: user[:id].to_s,
+            user_id: (user[:id] || user["id"]).to_s,
             user_properties: scrub_pii(user),
             event_type: name,
             event_properties: scrub_pii(metadata)
@@ -92,7 +95,10 @@ module Path
             event_props[key] = metadata[key] if metadata.key? key
           end
 
-          AmplitudeAPI.track AmplitudeAPI::Event.new event_props
+          response = AmplitudeAPI.track AmplitudeAPI::Event.new event_props
+          raise Error, response.body unless response.success?
+
+          response
         end
 
         # Scrub known PII keys from a hash
@@ -117,6 +123,8 @@ module Path
 
           data
         end
+
+        class Error < StandardError; end
       end
     end
   end

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

@@ -44,7 +44,7 @@ module Path
         # @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_enabled = !(conf.nil? || conf.empty?)
           @amplitude_config = conf
         end
 

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

@@ -10,7 +10,7 @@ module Path
         # @param config [Analytics::Configuration] the configuration for the reporter
         # @see Analytics::Configuration
         def initialize(config)
-          @config = config
+          @config = config.analytics
         end
 
         # Log the analytics event to the configured logger

data/lib/path/reporting/analytics.rb

@@ -36,14 +36,14 @@ module Path
       # @private
       def setup_amplitude
         # Amplitude reporting for metrics
-        return Path::Reporting::Analytics::Amplitude.new @config if @config.amplitude_enabled?
+        return Path::Reporting::Analytics::Amplitude.new @config if @config.analytics.amplitude_enabled?
 
         nil
       end
 
       # @private
       def setup_console
-        return Path::Reporting::Analytics::Console.new @config if @config.console_enabled?
+        return Path::Reporting::Analytics::Console.new @config if @config.analytics.console_enabled?
 
         nil
       end
@@ -122,7 +122,7 @@ module Path
       #     product_area: Constants::ANALYTICS_PRODUCT_AREA_MATCHING,
       #     name: 'Preferred provider multiple valid matches',
       #     user: @contact.analytics_friendly_hash,
-      #     user_type: PathReporting::UserType.PATIENT,
+      #     user_type: PathReporting::UserType::PATIENT,
       #     trigger: PathReporting::Trigger.PAGE_VIEW,
       #     metadata: analytics_metadata,
       #   )
@@ -132,12 +132,12 @@ module Path
       #      product_area: Constants::ANALYTICS_PRODUCT_AREA_MATCHING,
       #      name: 'No preferred provider',
       #      user: @contact.analytics_friendly_hash,
-      #      user_type: PathReporting::UserType.PATIENT,
+      #      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?
+      #      Rails.logger.warn("#{status.reporter} failed") unless status[:result].nil?
       #    end
       #
       # @raise [StandardError] if no user is provided or user does not have id
@@ -146,8 +146,8 @@ module Path
       #
       # @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` [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
@@ -158,13 +158,13 @@ module Path
         product_area:,
         name:,
         user:,
-        user_type: UserType.PATIENT,
-        trigger: Trigger.INTERACTION,
+        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)
+        throw Error.new("No user hash provided when reporting analytics") if !user.is_a?(Hash) || !(user[:id] || user["id"])
+        throw Error.new("Invalid UserType #{user_type}") unless UserType.valid?(user_type)
+        throw Error.new("Invalid Trigger #{trigger}") unless Trigger.valid?(trigger)
 
         clients.map do |reporter, client|
           {
@@ -185,7 +185,6 @@ module Path
       # @private
       def send_event_to_client(client, event)
         client&.record(**event)
-        nil
       rescue StandardError => e
         e
       end

data/lib/path/reporting/configuration.rb

@@ -9,6 +9,7 @@ module Path
     #   @return [Analytics::Configuration] the configuration for analytics reporting
     class Configuration
       attr_reader :analytics
+      attr_accessor :system_name
 
       # Create a new configuration. Sub configuration's will be used by the
       # various reporting sections.

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

@@ -4,22 +4,22 @@ module Path
   module Reporting
     # The trigger or cause of reporting events
     class Trigger
-      class << self
-        # 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"
+      # 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
           [
@@ -32,7 +32,7 @@ module Path
         # Check if a given item is a valid Trigger
         # @param maybe_trigger [Any] item to check
         def valid?(maybe_trigger)
-          triggers.includes? maybe_trigger
+          triggers.include? maybe_trigger
         end
       end
     end

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

@@ -4,20 +4,20 @@ module Path
   module Reporting
     # User types that data may be recorded for or on
     class UserType
-      class << self
-        # 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"
+      # 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
           [
@@ -33,7 +33,7 @@ module Path
         # Check if a given item is a valid UserType
         # @param maybe_type [Any] item to check
         def valid?(maybe_type)
-          types.includes? maybe_type
+          types.include? maybe_type
         end
       end
     end

data/lib/path/reporting/version.rb

@@ -3,6 +3,6 @@
 module Path
   module Reporting
     # Current version of the module
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/lib/path/reporting.rb

@@ -43,7 +43,7 @@ module Path
         @config = Configuration.new
         yield(@config) if block_given?
 
-        @analytics = Path::Reporting::Analytics.new @config.analytics
+        @analytics = Path::Reporting::Analytics.new @config
         self
       end
 
@@ -52,7 +52,7 @@ module Path
       def analytics
         raise Error, "Must call init on Path::Reporting library before using" unless @initialized
 
-        @analyitcs
+        @analytics
       end
 
       # Resets the module to an uninitialized state. Mostly used for testing
@@ -60,7 +60,7 @@ module Path
       def reset!
         @initialized = false
         @config = nil
-        @analyitcs = nil
+        @analytics = nil
         self
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: path-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexis Hushbeck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amplitude-api