path-reporting 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d921c4f5d8a011b077006a44cb6800d3f9d63329b46d750626aa9ff9fd17859
+  data.tar.gz: 1828887be14dbb2b8cbbe5a382e36e14800fce6d5b306764234e0f1f974729ac
+SHA512:
+  metadata.gz: 213c4dffd2afaaf7589ce520aa6cbe78d9ecf998ef0528fe9f35e1539d0b547a292a5ec0c42cd9f6031b25ab31628baca91356abbcb0eda2ebbc6a4a7e702bd5
+  data.tar.gz: 624e433365f0b3099c3c2d5e3eed73ca6aa2ba7648fd4df7590ebd578dc0752e1cea64a1b30073fe34b3d1386ca7dcde1683237db61e90d65981e3290c0504a0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  IgnoredMethods:
+    # rspec tests are expected to be long
+    - describe
+    - context
+
+Metrics/MethodLength:
+  IgnoredMethods:
+    # `record` is long because we format it to be more readable
+    - record
+    # `scrub_pii` is long both to be more readable and also because it
+    # is difficult to break up reasonably and keep it easy to understand
+    - scrub_pii
+
+Metrics/ParameterLists:
+  Max: 7
+
+Layout/LineLength:
+  Max: 200

data/.yardopts

@@ -0,0 +1 @@
+--no-private --plugin rspec

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in reporting.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake", "~> 0.6.0"
+gem "rubocop-rspec", "~> 2.10"
+
+gem "amplitude-api", "~> 0.4.1"
+
+group :development, :test do
+  gem "yard", "~> 0.9.27"
+  gem "yard-rspec", "~> 0.1"
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    path-reporting (0.1.1)
+      amplitude-api
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amplitude-api (0.4.1)
+      faraday (>= 1.0, < 3.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.2)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    yard-rspec (0.1)
+      yard
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  amplitude-api (~> 0.4.1)
+  path-reporting!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.10)
+  yard (~> 0.9.27)
+  yard-rspec (~> 0.1)
+
+BUNDLED WITH
+   2.3.10

data/README.md

@@ -0,0 +1,29 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add path-reporting
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install path-reporting
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pathccm/reporting.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/analytics/analytics.rb

@@ -0,0 +1,92 @@
+# 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

@@ -0,0 +1,115 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,41 @@
+# 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/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "analytics/configuration"
+
+module Path
+  module Reporting
+    # @!attribute [r] analytics
+    #   @return [Analytics::Configuration] the configuration for analytics reporting
+    class Configuration
+      attr_reader :analytics
+
+      # Create a new configuration. Sub configuration's will be used by the
+      # various reporting sections.
+      # @see Analytics::Configuration
+      def initialize
+        @analytics = Analytics::Configuration.new
+      end
+    end
+  end
+end

data/lib/reporting/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Path
+  module Reporting
+    VERSION = "0.1.1"
+  end
+end

data/lib/reporting.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "analytics/analytics"
+require_relative "configuration"
+require_relative "reporting/version"
+
+# Path is just a wrapper module so we can group any path specific gems under
+# this module heading
+module Path
+  # The `Reporting` module is our general, all-purpose reporting tool for
+  # analytics, metrics, performance, and any other data. This module is
+  # 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
+    class Error < StandardError; end
+
+    class << self
+      # Initialize our reporting setup. This is required to call before
+      # the module is ready to use.
+      #
+      # To configure this module, pass in a block that accepts a {Configuration}
+      # parameter. Using this parameter you can setup any reporting systems
+      # that you need.
+      #
+      # Each sub-type of reporting will have its own configuration. For example,
+      # to configure analytics reporting, you can use the `analytics` property
+      # on the {Configuration} object passed in, which will be an instance of
+      # {Analytics::Configuration}.
+      #
+      # @example Basic analytics setup
+      #   Path::Reporting.init do |config|
+      #     config.analytics.logger = Rails.logger
+      #   end
+      # @example If no configuration is needed, you still need to call this method
+      #   Path::Reporting.init
+      # @yieldparam config [Configuration] the Configuration object to set any and all configuration on
+      # @return [self]
+      # @see Configuration
+      # @see Analytics::Configuration
+      def init
+        @initialized = true
+        @config = Configuration.new
+        yield(@config) if block_given?
+
+        @analytics = Path::Reporting::Analytics.new @config.analytics
+        self
+      end
+
+      # @raise [Error] if the Path:Reporting module has not been initialized
+      # @return [Analytics] the configured analytics reporting module
+      def analytics
+        raise Error, "Must call init on Path::Reporting library before using" unless @initialized
+
+        @analyitcs
+      end
+
+      # Resets the module to an uninitialized state. Mostly used for testing
+      # @private
+      def reset!
+        @initialized = false
+        @config = nil
+        @analyitcs = nil
+        self
+      end
+    end
+  end
+end

data/lib/types/trigger.rb

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

data/reporting.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/reporting/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "path-reporting"
+  spec.version = Path::Reporting::VERSION
+  spec.authors = ["Alexis Hushbeck"]
+  spec.email = ["alexis.hushbeck@pathccm.com"]
+
+  spec.summary = "Reporting gem for Path Mental Health"
+  spec.homepage = "https://github.com/pathccm/reporting"
+  spec.required_ruby_version = ">= 3.0.3"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pathccm/reporting"
+  spec.metadata["changelog_uri"] = "https://github.com/pathccm/reporting/commits"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "amplitude-api"
+  spec.add_development_dependency "yard"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/reporting.rbs

@@ -0,0 +1,4 @@
+module Reporting
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: path-reporting
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexis Hushbeck
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amplitude-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- alexis.hushbeck@pathccm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- 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
+- reporting.gemspec
+- sig/reporting.rbs
+homepage: https://github.com/pathccm/reporting
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pathccm/reporting
+  source_code_uri: https://github.com/pathccm/reporting
+  changelog_uri: https://github.com/pathccm/reporting/commits
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.10
+signing_key:
+specification_version: 4
+summary: Reporting gem for Path Mental Health
+test_files: []