itly-plugin-mixpanel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3d00fe05fc92ea65d0c280a313d3e96a461f1eea1e87c3c8c88a267f7f19789
+  data.tar.gz: 942e907363c69b46375c5c4cdf46071cf6300e34170a2ac86714e3ab721be5ee
+SHA512:
+  metadata.gz: 82e21945dd10ee74ca764701e6740e5291ae80f166553ff486de8d32bdb8282b4440a1ccb6c2b2250c76ac992dfe2c54a838656f2b493d7eefc2f5460c105d6f
+  data.tar.gz: 13e1e33189bb30be5c0f0ce9c4d5971f84bd41798c7563b97f898f2adce8efa51fcaaa1baccad488733b7f539624dd4994ccef4b6a7376399f5248617beb573d

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in itly-plugin-mixpanel.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+if ENV['LOCAL_ITLY_GEM']
+  # TODO: before publication to RubyGems, switch to version 1
+  gem 'itly-sdk', '~> 0.1', path: '../sdk'
+end
+
+gem 'rbs', '~> 1.0'
+gem 'rspec'
+gem 'steep', '~> 0.41'

data/Steepfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  library 'logger', 'set', 'itly-sdk'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'itly/plugin-mixpanel'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Configure and load RBS
+unless ENV['DISABLE_TYPE_CHECKING']
+  ENV['RBS_TEST_TARGET'] = 'Itly::*'
+  ENV['RBS_TEST_LOGLEVEL'] = 'warn'
+  ENV['RBS_TEST_DOUBLE_SUITE'] = 'rspec'
+  ENV['RBS_TEST_OPT'] = '-I./sig -I../sdk/sig'
+
+  require 'rbs/test/setup'
+end
+
+# Start RSpec
+require 'rspec/core'
+
+ENV['RSPEC_RUN_FROM_SCRIPT'] = 'true'
+RSpec::Core::Runner.invoke

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/itly-plugin-mixpanel.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/itly/plugin/mixpanel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'itly-plugin-mixpanel'
+  spec.version       = Itly::Plugin::Mixpanel::VERSION
+  spec.authors       = ['Iteratively', 'Benjamin Bouchet', 'Justin Fiedler', 'Andrey Sokolov']
+  spec.email         = ['support@iterative.ly']
+
+  spec.summary       = 'Mixpanel plugin for Iteratively SDK for Ruby'
+  spec.description   = 'Track and validate analytics with a unified, extensible interface ' \
+                       'that works with all your 3rd party analytics providers.'
+  spec.homepage      = 'https://github.com/iterativelyhq/itly-sdk-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/iterativelyhq/itly-sdk-ruby/plugin-mixpanel'
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'itly-sdk', '~> 0.1'
+  spec.add_dependency 'mixpanel-ruby', '~> 2.2'
+end

data/lib/itly/plugin-mixpanel.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+if ENV['LOCAL_ITLY_GEM']
+  lib = File.expand_path('../../../sdk/lib', File.dirname(__FILE__))
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+
+require_relative 'plugin/mixpanel/mixpanel'
+require_relative 'plugin/mixpanel/options'
+require_relative 'plugin/mixpanel/call_options'
+require_relative 'plugin/mixpanel/error_handler'
+require_relative 'plugin/mixpanel/version'

data/lib/itly/plugin/mixpanel/call_options.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    # Mixpanel plugin class for Itly SDK
+    class Mixpanel
+      ##
+      # Mixpanel specific plugin options class
+      #
+      class CallOptions < Itly::PluginCallOptions
+      end
+
+      ##
+      # Mixpanel specific plugin options class for calls to plugin methods
+      #
+      %w[Identify Group Page Track Alias].each do |name|
+        class_eval(
+          <<-EVAL, __FILE__, __LINE__ + 1
+            class #{name}Options < CallOptions         # class IdentifyOptions < CallOptions
+            end                                        # end
+          EVAL
+        )
+      end
+    end
+  end
+end

data/lib/itly/plugin/mixpanel/error_handler.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+require 'mixpanel-ruby'
+
+class Itly
+  class Plugin
+    class Mixpanel
+      ##
+      # Error handler class used by Mixpanel::Tracker
+      #
+      # Raise an +Itly::RemoteError+ error in case of error
+      #
+      class ErrorHandler < ::Mixpanel::ErrorHandler
+        def handle(error)
+          raise Itly::RemoteError, "The client returned an error: #{error}"
+        end
+      end
+    end
+  end
+end

data/lib/itly/plugin/mixpanel/mixpanel.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+require 'mixpanel-ruby'
+
+class Itly
+  class Plugin
+    ##
+    # Mixpanel plugin class for Itly SDK
+    #
+    # Automatically loaded at runtime in any new +Itly+ object
+    #
+    class Mixpanel < Plugin
+      attr_reader :client, :disabled
+
+      ##
+      # Instantiate a new Plugin::Mixpanel
+      #
+      # @param [String] project_token: specify the Mixpanel project token
+      # @param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false
+      #
+      def initialize(project_token:, disabled: false)
+        super()
+        @project_token = project_token
+        @disabled = disabled
+      end
+
+      ##
+      # Initialize Mixpanel::Tracker client
+      #
+      # @param [Itly::PluginOptions] options: plugin options
+      #
+      def load(options:)
+        super
+        # Get options
+        @logger = options.logger
+
+        # Log
+        @logger&.info "#{id}: load()"
+
+        if @disabled
+          @logger&.info "#{id}: plugin is disabled!"
+          return
+        end
+
+        # Configure client
+        @client = ::Mixpanel::Tracker.new @project_token, ErrorHandler.new
+      end
+
+      ##
+      # Identify a user
+      #
+      # Raise an error if the client fails
+      #
+      # @param [String] user_id: the id of the user in your application
+      # @param [Hash] properties: the properties containing user's traits to pass to your application
+      # @param [Itly::Plugin::Mixpanel::IdentifyOptions] options: the plugin specific options
+      #
+      def identify(user_id:, properties: nil, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log user_id: user_id, properties: properties, options: options
+        @logger&.info "#{id}: identify(#{log})"
+
+        # Send through the client
+        @client.people.set user_id, properties
+      end
+
+      ##
+      # Track an event
+      #
+      # Raise an error if the client fails
+      #
+      # @param [String] user_id: the id of the user in your application
+      # @param [Event] event: the Event object to pass to your application
+      # @param [Itly::Plugin::Mixpanel::TrackOptions] options: the plugin specific options
+      #
+      def track(user_id:, event:, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log(
+          user_id: user_id, event: event&.name, properties: event&.properties, options: options
+        )
+        @logger&.info "#{id}: track(#{log})"
+
+        # Send through the client
+        @client.track user_id, event.name, event.properties
+      end
+
+      ##
+      # Associate one user ID with another (typically a known user ID with an anonymous one).
+      #
+      # Raise an error if the client fails
+      #
+      # @param [String] user_id: The ID that the user will be identified by going forward. This is
+      #   typically the user's database ID (as opposed to an anonymous ID), or their updated ID
+      #   (for example, if the ID is an email address which the user just updated).
+      # @param [String] previous_id: The ID the user has been identified by so far.
+      # @param [Itly::Plugin::Mixpanel::AliasOptions] options: the plugin specific options
+      #
+      def alias(user_id:, previous_id:, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log user_id: user_id, previous_id: previous_id, options: options
+        @logger&.info "#{id}: alias(#{log})"
+
+        # Send through the client
+        @client.alias user_id, previous_id
+      end
+
+      ##
+      # Get the plugin ID
+      #
+      # @return [String] plugin id
+      #
+      def id
+        'mixpanel'
+      end
+
+      private
+
+      def enabled?
+        !@disabled
+      end
+    end
+  end
+end

data/lib/itly/plugin/mixpanel/options.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+
+class Itly
+  class Plugin
+    class Mixpanel
+      ##
+      # Options for the Mixpanel plugin class
+      #
+      # rubocop:disable Lint/EmptyClass
+      class Options
+      end
+      # rubocop:enable Lint/EmptyClass
+    end
+  end
+end

data/lib/itly/plugin/mixpanel/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    class Mixpanel < Plugin
+      VERSION = '0.1.0'
+    end
+  end
+end

data/sig/call_options.rbs

@@ -0,0 +1,23 @@
+class Itly
+  class Plugin
+    class Mixpanel
+      class CallOptions < Itly::PluginCallOptions
+      end
+
+      class IdentifyOptions < CallOptions
+      end
+
+      class GroupOptions < CallOptions
+      end
+
+      class PageOptions < CallOptions
+      end
+
+      class TrackOptions < CallOptions
+      end
+
+      class AliasOptions < CallOptions
+      end
+    end
+  end
+end

data/sig/error_handler.rbs

@@ -0,0 +1,7 @@
+class Itly
+  class Plugin::Mixpanel < Plugin
+    class ErrorHandler < Mixpanel::ErrorHandler
+      def handle: (String error) -> void
+    end
+  end
+end

data/sig/lib/mixpanel_error_handler.rbs

@@ -0,0 +1,5 @@
+# Part of the gems
+class Mixpanel
+  class ErrorHandler
+  end
+end

data/sig/lib/mixpanel_tracker.rbs

@@ -0,0 +1,13 @@
+# Part of the gems
+class Mixpanel
+  class Tracker
+    attr_reader people: Mixpanel::Tracker::People
+
+    def track: (String user_id, String event_name, propertiesHash properties) -> void
+    def alias: (String user_id, String previoud_id) -> void
+
+    private
+
+    def initialize: (String project_token, Mixpanel::ErrorHandler error_handler) -> void
+  end
+end

data/sig/lib/mixpanel_tracker_people.rbs

@@ -0,0 +1,8 @@
+# Part of the gems
+class Mixpanel
+  class Tracker
+    class People
+      def set: (String user_id, propertiesHash properties) -> void
+    end
+  end
+end

data/sig/lib/monitor_mixin.rbs

@@ -0,0 +1,3 @@
+# Part of the gems
+class MonitorMixin
+end

data/sig/mixpanel.rbs

@@ -0,0 +1,19 @@
+class Itly
+  class Plugin::Mixpanel < Plugin
+    VERSION: String
+
+    attr_reader client: Mixpanel::Tracker?
+    attr_reader disabled: bool
+
+    def load: (options: Itly::PluginOptions options) -> void
+    def identify: (user_id: String user_id, ?properties: propertiesHash? properties, ?options: Itly::Plugin::Mixpanel::IdentifyOptions? options) -> void
+    def track: (user_id: String user_id, event: Itly::Event event, ?options: Itly::Plugin::Mixpanel::TrackOptions? options) -> void
+    def alias: (user_id: String user_id, previous_id: String previous_id, ?options: Itly::Plugin::Mixpanel::AliasOptions? options) -> void
+    def id: () -> String
+
+    private
+
+    def initialize: (project_token: String project_token, ?disabled: bool disabled) -> void
+    def enabled?: () -> bool
+  end
+end

data/sig/options.rbs

@@ -0,0 +1,8 @@
+class Itly
+  class Plugin
+    class Mixpanel
+      class Options
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: itly-plugin-mixpanel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Iteratively
+- Benjamin Bouchet
+- Justin Fiedler
+- Andrey Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: itly-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Track and validate analytics with a unified, extensible interface that
+  works with all your 3rd party analytics providers.
+email:
+- support@iterative.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Steepfile
+- bin/console
+- bin/rspec
+- bin/setup
+- itly-plugin-mixpanel.gemspec
+- lib/itly/plugin-mixpanel.rb
+- lib/itly/plugin/mixpanel/call_options.rb
+- lib/itly/plugin/mixpanel/error_handler.rb
+- lib/itly/plugin/mixpanel/mixpanel.rb
+- lib/itly/plugin/mixpanel/options.rb
+- lib/itly/plugin/mixpanel/version.rb
+- sig/call_options.rbs
+- sig/error_handler.rbs
+- sig/lib/mixpanel_error_handler.rbs
+- sig/lib/mixpanel_tracker.rbs
+- sig/lib/mixpanel_tracker_people.rbs
+- sig/lib/monitor_mixin.rbs
+- sig/mixpanel.rbs
+- sig/options.rbs
+homepage: https://github.com/iterativelyhq/itly-sdk-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/iterativelyhq/itly-sdk-ruby
+  source_code_uri: https://github.com/iterativelyhq/itly-sdk-ruby/plugin-mixpanel
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Mixpanel plugin for Iteratively SDK for Ruby
+test_files: []