magellanalytics 0.2.0.0

data/Gemfile.lock

@@ -0,0 +1,193 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    analytics-ruby (2.4.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.12.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    git (1.18.0)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    github_api (0.19.0)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (>= 0.8, < 2)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    hashie (3.6.0)
+    highline (2.1.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    juwelier (2.4.9)
+      builder
+      bundler
+      git
+      github_api
+      highline
+      kamelcase (~> 0)
+      nokogiri
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (2.7.0)
+    kamelcase (0.0.2)
+      semver2 (~> 3)
+    loofah (2.20.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.8.1)
+    minitest (5.18.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.3.0)
+    nokogiri (1.14.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.14.3-arm64-darwin)
+      racc (~> 1.4)
+    oauth2 (1.4.11)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+    parallel (1.23.0)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    psych (5.1.0)
+      stringio
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rchardet (1.8.0)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    semver2 (3.4.2)
+    shoulda (4.0.0)
+      shoulda-context (~> 2.0)
+      shoulda-matchers (~> 4.0)
+    shoulda-context (2.0.0)
+    shoulda-matchers (4.5.1)
+      activesupport (>= 4.2.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.0.6)
+    thread_safe (0.3.6)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 7.0.4.3, < 7.1)
+  activesupport (>= 7.0.4.3)
+  analytics-ruby
+  bundler (~> 2.0)
+  juwelier (~> 2.4)
+  rdoc (~> 6.3, >= 6.3.1)
+  rspec
+  rubocop
+  shoulda
+  simplecov
+
+RUBY VERSION
+   ruby 3.1.2p20
+
+BUNDLED WITH
+   2.2.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Ryan Kerr
+
+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.rdoc

@@ -0,0 +1,18 @@
+= MagellAnalytics
+
+A simple abstraction layer over Segment's `analytics-ruby` to simplify event configuration and dispatch.
+
+== Contributing to magellanalytics
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2020 Magellan AI.  All rights reserved.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'juwelier'
+require_relative 'lib/magellanalytics/version'
+
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name        = 'magellanalytics'
+  gem.homepage    = 'http://github.com/magellan-ai/magellanalytics'
+  gem.version     = Magellanalytics::Version::STRING
+  gem.license     = 'MIT'
+  gem.summary     = "Simple abstraction layer over Segment's `analytics-ruby`"
+  gem.description = "Simplifies configuration and event dispatch from Segment's analytics gem for ease-of-use in Rails applications."
+  gem.email       = 'rex@magellan.ai'
+  gem.authors     = ['Ryan Kerr', 'William Dana', 'Gregory Nelson', 'Rex Madden']
+
+  gem.required_ruby_version = '>= 2.7'
+
+  # dependencies defined in Gemfile
+end
+
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task default: :spec
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "Magellanalytics #{Magellanalytics::Version::STRING}"
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/magellanalytics/configuration.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Magellanalytics
+  class Configuration
+    attr_accessor :segment_write_key
+    attr_reader :track_user_check, :user_traits
+    attr_writer :base_integrations, :base_props
+
+    def initialize
+      @base_integrations = {}
+      @base_props        = {}
+      @events            = {}
+    end
+
+    def track_user_if(&block)
+      @track_user_check = block
+    end
+
+    def track_user_check?
+      instance_variable_defined?(:@track_user_check)
+    end
+
+    def event_description(name)
+      raise Magellanalytics::UnregisteredEvent, "Unknown event: #{name}" unless registered_events.include?(name.to_sym)
+
+      @events[name.to_sym]&.description
+    end
+
+    def register_event(event, description = nil)
+      @events[event.to_sym] = Magellanalytics::Event.new(event, description)
+    end
+
+    def registered_events
+      @events.keys
+    end
+
+    def user_traits?
+      instance_variable_defined?(:@user_traits)
+    end
+
+    def register_user_traits(&block)
+      @user_traits = block
+    end
+
+    def base_integrations
+      return @base_integrations.call if @base_integrations.respond_to?(:call)
+
+      @base_integrations
+    end
+
+    def base_props
+      return @base_props.call if @base_props.respond_to?(:call)
+
+      @base_props
+    end
+  end
+end

data/lib/magellanalytics/event.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Magellanalytics
+  class Event
+    attr_accessor :name, :description
+
+    def initialize(name, description = nil)
+      @name        = name.to_s.gsub(/\s+/, '_').underscore.to_sym
+      @description = description || name.to_s.humanize
+    end
+  end
+end

data/lib/magellanalytics/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Magellanalytics
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/magellanalytics/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Magellanalytics
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 0
+    BUILD = 0
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/lib/magellanalytics.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+require 'segment/analytics'
+
+require 'magellanalytics/configuration'
+require 'magellanalytics/event'
+require 'magellanalytics/railtie' if defined?(Rails::Railtie)
+
+module Magellanalytics
+  extend self
+
+  UnregisteredEvent = Class.new(StandardError)
+
+  def configure
+    yield config
+  end
+
+  def identify(user)
+    return unless track_user?(user)
+
+    payload          = { user_id: user.id }
+    payload[:traits] = config.user_traits.call(user) if config.user_traits?
+    analytics.identify(payload)
+  end
+
+  def page(user, request, **opts)
+    return unless track_user?(user)
+
+    identify user
+
+    props            = config.base_props
+    props[:params]   = request.filtered_parameters
+    props[:path]     = request.original_fullpath
+    props[:url]      = request.original_url
+    props[:referrer] = request.referer
+
+    payload =
+      {
+        user_id:    user.id,
+        properties: recursive_flatten(props).with_indifferent_access.merge(client_id: user.client_id),
+        name:       "#{request.parameters['controller']}/#{request.parameters['action']}",
+        **opts
+      }
+    analytics.page(payload)
+  end
+
+  def track(user, event, properties: {}, **opts)
+    return unless track_user?(user)
+
+    identify user
+
+    payload                          =
+      {
+        user_id:    user.id,
+        event:      config.event_description(event),
+        properties: config.base_props.merge(properties),
+        **opts
+      }
+    payload[:properties][:client_id] = user.client_id
+    payload[:integrations]           = config.base_integrations if config.base_integrations.present?
+
+    analytics.track(payload)
+  end
+
+  def reset_config!
+    @config = nil
+  end
+
+  private
+
+  def track_user?(user)
+    return true unless config.track_user_check?
+
+    config.track_user_check.call(user)
+  end
+
+  def analytics
+    @analytics ||= Segment::Analytics.new(write_key: config.segment_write_key)
+  end
+
+  def config
+    @config ||= Magellanalytics::Configuration.new
+  end
+
+  def recursive_flatten(to_flatten, prefix = nil, separator: '.') # rubocop:disable Metrics/PerceivedComplexity
+    result     = {}
+    to_flatten = to_flatten.as_json
+
+    case to_flatten
+    when Hash
+      to_flatten.map do |k, v|
+        k = "#{prefix}#{separator}#{k}" if prefix.present?
+        result.merge!([Hash, Array].include?(v.class) ? recursive_flatten(v, k) : { k => v })
+      end
+    when Array
+      to_flatten.uniq.each_with_index do |o, i|
+        i = "#{prefix}#{separator}#{i}" if prefix.present?
+        result.merge!([Hash, Array].include?(o.class) ? recursive_flatten(o, i) : { i => o })
+      end
+    end
+
+    result
+  rescue => e
+    Rails.logger.error "Could not flatten hash: #{e}" if defined?(Rails) && Rails.logger
+    to_flatten
+  end
+end

data/magellanalytics.gemspec

@@ -0,0 +1,78 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: magellanalytics 0.2.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "magellanalytics".freeze
+  s.version = "0.2.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Ryan Kerr".freeze, "William Dana".freeze, "Gregory Nelson".freeze, "Rex Madden".freeze]
+  s.date = "2023-11-09"
+  s.description = "Simplifies configuration and event dispatch from Segment's analytics gem for ease-of-use in Rails applications.".freeze
+  s.email = "rex@magellan.ai".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rspec_parallel",
+    ".rubocop.yml",
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "lib/magellanalytics.rb",
+    "lib/magellanalytics/configuration.rb",
+    "lib/magellanalytics/event.rb",
+    "lib/magellanalytics/railtie.rb",
+    "lib/magellanalytics/version.rb",
+    "magellanalytics.gemspec",
+    "magellanalytics.iml",
+    "spec/event_spec.rb",
+    "spec/magellanalytics_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/magellan-ai/magellanalytics".freeze
+  s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.7".freeze)
+  s.rubygems_version = "3.3.7".freeze
+  s.summary = "Simple abstraction layer over Segment's `analytics-ruby`".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<activesupport>.freeze, [">= 7.0.4.3"])
+    s.add_runtime_dependency(%q<analytics-ruby>.freeze, [">= 0"])
+    s.add_development_dependency(%q<bundler>.freeze, ["~> 2.0"])
+    s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.3", ">= 6.3.1"])
+    s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<actionpack>.freeze, [">= 7.0.4.3", "< 7.1"])
+  else
+    s.add_dependency(%q<activesupport>.freeze, [">= 7.0.4.3"])
+    s.add_dependency(%q<analytics-ruby>.freeze, [">= 0"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 2.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 6.3", ">= 6.3.1"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<actionpack>.freeze, [">= 7.0.4.3", "< 7.1"])
+  end
+end
+