path-reporting 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37d78cfbdf517535d51c48f43a69899a7d5c00b57dc76e6d450551ddc157ed3
-  data.tar.gz: 12f2ca0f0c8de09d5a0467793461ea2bd8a678c8086a63062f5e13b256958dca
+  metadata.gz: 9cf8b0c5159e89a7fde5da0bf0c2d4912f05f03d62fa5c66e2f5f48143916f36
+  data.tar.gz: ee8d74820b4f6c194813448700c0eb66c4d72b3b84d8431955c7a297c4db01f0
 SHA512:
-  metadata.gz: b4159af503e477b87299ac911e8e7d935cd2dff29b30af85a3a2d9e0492b52abae5ebf54adfb247a6b31a27225b1c6e095178f43785857e5b58a298cf4b21792
-  data.tar.gz: c8af462a40b0240a3b54da2793345ba25446a50a7699ef2ac39482992021618d570f1e7c73dcc677d1a796971382f1f66d6da8023c23d147f1948331492dae43
+  metadata.gz: '0528361202c2f3750e68181a3203a63c43c7c731710f9bd03814da1416bd46861650337df5f56351b774e0226a4eebb83e9de13119303c6b76822e5f374747c6'
+  data.tar.gz: ecee15c13b20cbfbabdc9040212bd392ef28ceb8c24dd0cac7e4e7394c16f85f39e5a602543a30fe5b005ef90757c444bbe33480d5fdea3903d5b6260489a835

data/.tool-versions

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

data/Gemfile.lock

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

data/README.md

@@ -37,13 +37,13 @@ After initialing the module, record an analytics event with the following code.
 
 ```ruby
 
-PathReporting.analytics.record(
+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: PathReporting::UserType.PATIENT,
-  trigger: PathReporting::Trigger.PAGE_VIEW,
+  user_type: Path::Reporting::UserType::PATIENT,
+  trigger: Path::Reporting::Trigger::PAGE_VIEW,
   metadata: analytics_metadata,
 )
 ```

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "reporters/amplitude"
-require_relative "reporters/console"
-require_relative "../types/trigger"
-require_relative "../types/user_type"
+require_relative "analytics/amplitude"
+require_relative "analytics/console"
+require_relative "types/trigger"
+require_relative "types/user_type"
 
 module Path
   module Reporting
@@ -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,7 +132,7 @@ 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,
       #    )
       #
@@ -158,8 +158,8 @@ 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]

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.include? maybe_trigger
+        end
+      end
+    end
+  end
+end

data/lib/{types → 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/{reporting → path/reporting}/version.rb

@@ -3,6 +3,6 @@
 module Path
   module Reporting
     # Current version of the module
-    VERSION = "0.1.2"
+    VERSION = "0.1.5"
   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
@@ -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

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: path-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Alexis Hushbeck
@@ -47,21 +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/configuration.rb
-- lib/analytics/reporters/amplitude.rb
-- lib/analytics/reporters/console.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/types/trigger.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-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
-        INTERACTION = "Interaction"
-        # Page view: When the event was an indirect result of viewing something.
-        # @note Because of usage limits, we do not want to record page views
-        #   as a separate action, this is only for indirect consequences
-        PAGE_VIEW = "Page view"
-        # Automation: Some automation or tool was the cause of this event
-        AUTOMATION = "Automation"
-
-        # @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