itly-plugin-snowplow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 779553f73b44ead11e1d4b49e4614c4153102013a2546815ce577844b1de1384
+  data.tar.gz: c301b0f5f83964bd074627f29fb161485e6b14ccf698457ca147859d51e9dc0c
+SHA512:
+  metadata.gz: 4875fe0a940a56388daa2cdfe627a69117d7e4ef9d8cd52a946572c8ddc2eb2b02a37fe20cb347add3d30aec32b2a499485f78036e64bdbc1e8605a601d1c6b7
+  data.tar.gz: 59c579f660e7e1988f523c5d18b594187dd37b67e894ead091f59c658de1902ce679c1b72a55fda6ce9c9bab65b8a44fd8ca6b549899dfdc3ca282a62e87492b

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-snowplow.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-snowplow'
+
+# 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-snowplow.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/itly/plugin/snowplow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'itly-plugin-snowplow'
+  spec.version       = Itly::Plugin::Snowplow::VERSION
+  spec.authors       = ['Iteratively', 'Benjamin Bouchet', 'Justin Fiedler', 'Andrey Sokolov']
+  spec.email         = ['support@iterative.ly']
+
+  spec.summary       = 'Snowplow 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-snowplow'
+
+  # 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 'snowplow-tracker', '~> 0.6'
+end

data/lib/itly/plugin-snowplow.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/snowplow/snowplow'
+require_relative 'plugin/snowplow/context'
+require_relative 'plugin/snowplow/call_options'
+require_relative 'plugin/snowplow/options'
+require_relative 'plugin/snowplow/version'

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    # Snowplow plugin class for Itly SDK
+    class Snowplow
+      ##
+      # Snowplow specific plugin options class
+      #
+      class CallOptions < Itly::PluginCallOptions
+      end
+
+      ##
+      # Snowplow specific plugin options class for calls to +page+
+      #
+      class PageOptions < CallOptions
+        attr_reader :contexts, :callback
+
+        def initialize(contexts: nil, callback: nil)
+          super()
+          @contexts = contexts
+          @callback = callback
+        end
+
+        def to_s
+          class_name = self.class.name.split('::').last
+          contexts_str = contexts.nil? ? 'nil' : "[#{contexts.collect(&:to_s).join ', '}]"
+          "#<Snowplow::#{class_name} contexts: #{contexts_str} callback: #{callback.nil? ? 'nil' : 'provided'}>"
+        end
+      end
+
+      ##
+      # Snowplow specific plugin options class for calls to +track+
+      #
+      class TrackOptions < CallOptions
+        attr_reader :contexts, :callback
+
+        def initialize(contexts: nil, callback: nil)
+          super()
+          @contexts = contexts
+          @callback = callback
+        end
+
+        def to_s
+          class_name = self.class.name.split('::').last
+          contexts_str = contexts.nil? ? 'nil' : "[#{contexts.collect(&:to_s).join ', '}]"
+          "#<Snowplow::#{class_name} contexts: #{contexts_str} callback: #{callback.nil? ? 'nil' : 'provided'}>"
+        end
+      end
+
+      ##
+      # Snowplow specific plugin options class for calls to plugin methods
+      #
+      %w[Identify Group 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/snowplow/context.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    class Snowplow
+      ##
+      # Snowplow context to be used by CallOptions
+      #
+      class Context
+        attr_reader :schema, :data
+
+        def initialize(schema:, data:)
+          @schema = schema
+          @data = data
+        end
+
+        def to_self_describing_json
+          SnowplowTracker::SelfDescribingJson.new schema, data
+        end
+
+        def to_s
+          "#<Snowplow::Context schema: #{schema} data: #{data}>"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+
+class Itly
+  class Plugin
+    class Snowplow
+      ##
+      # Options for the Snowplow plugin class
+      #
+      class Options
+        attr_reader :endpoint, :protocol, :method, :buffer_size, :disabled
+
+        ##
+        # Instantiate a new Options
+        #
+        # @param [String] endpoint: specify the Snowplow endpoint
+        # @param [String] protocol: specify the protocol to connect to the Snowplow endpoint.
+        #   Can be 'http' or 'https'. Default to 'http'
+        # @param [String] method: specify the HTTP verb to use when sending events to the Snowplow endpoint.
+        #   Can be 'get' or 'post'. Default to 'get'
+        # @param [Integer] buffer_size: specify the buffer size before flushing event to the Snowplow endpoint.
+        #   Leave it to +nil+ to set it's default value. Default to 1 for GET method, and 10 for POST
+        # @param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false
+        #
+        def initialize(endpoint:, protocol: 'http', method: 'get', buffer_size: nil, disabled: false)
+          super()
+          @endpoint = endpoint
+          @protocol = protocol
+          @method = method
+          @buffer_size = buffer_size
+          @disabled = disabled
+        end
+      end
+    end
+  end
+end

data/lib/itly/plugin/snowplow/snowplow.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+require 'snowplow-tracker'
+
+class Itly
+  class Plugin
+    ##
+    # Snowplow plugin class for Itly SDK
+    #
+    class Snowplow < Plugin
+      attr_reader :logger, :vendor, :disabled, :client
+
+      ##
+      # Instantiate a new Plugin::Snowplow
+      #
+      # @param [String] vendor: the Snowplow vendor
+      # @param [Itly::Plugin::Snowplow::Options] options: the options. See +Itly::Plugin::Snowplow::Options+
+      #
+      def initialize(vendor:, options:)
+        super()
+        @vendor = vendor
+        @disabled = options.disabled
+
+        emitter = SnowplowTracker::Emitter.new \
+          options.endpoint, protocol: options.protocol, method: options.method, buffer_size: options.buffer_size
+        @client = SnowplowTracker::Tracker.new emitter
+      end
+
+      ##
+      # Initialize Snowplow plugin
+      #
+      # @param [Itly::PluginOptions] options: plugin options
+      #
+      def load(options:)
+        super
+        # Get options
+        @logger = options.logger
+
+        # Log
+        logger&.info "#{id}: load()"
+
+        logger&.info "#{id}: plugin is disabled!" if @disabled
+      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: unused
+      # @param [Itly::Plugin::Snowplow::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, options: options
+        logger&.info "#{id}: identify(#{log})"
+
+        # Send through the client
+        client.set_user_id user_id
+      end
+
+      ##
+      # Record page views
+      #
+      # Raise an error if the client fails
+      #
+      # @param [String] user_id: the id of the user in your application
+      # @param [String] category: the category of the page
+      # @param [String] name: the name of the page.
+      # @param [Hash] properties: the properties to pass to your application
+      # @param [Itly::Plugin::Snowplow::PageOptions] options: the plugin specific options
+      #
+      def page(user_id:, category: nil, name: nil, properties: nil, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log(
+          user_id: user_id, category: category, name: name, properties: properties, options: options
+        )
+        logger&.info "#{id}: page(#{log})"
+
+        # Identify the user
+        client.set_user_id user_id
+
+        # Send through the client
+        contexts = nil
+        if options&.contexts.is_a?(Array) && options.contexts.any?
+          contexts = options.contexts.collect(&:to_self_describing_json)
+        end
+
+        client.track_screen_view name, nil, contexts
+      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::Snowplow::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, version: event&.version, properties: event&.properties, options: options
+        )
+        logger&.info "#{id}: track(#{log})"
+
+        # Identify the user
+        client.set_user_id user_id
+
+        # Send through the client
+        schema_version = event.version&.gsub(/\./, '-')
+        schema = "iglu:#{vendor}/#{event.name}/jsonschema/#{schema_version}"
+
+        event_json = SnowplowTracker::SelfDescribingJson.new(
+          schema, event.properties
+        )
+
+        contexts = nil
+        if options&.contexts.is_a?(Array) && options.contexts.any?
+          contexts = options.contexts.collect(&:to_self_describing_json)
+        end
+
+        client.track_self_describing_event event_json, contexts
+      end
+
+      ##
+      # Get the plugin ID
+      #
+      # @return [String] plugin id
+      #
+      def id
+        'snowplow'
+      end
+
+      private
+
+      def enabled?
+        !@disabled
+      end
+    end
+  end
+end

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

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

data/sig/call_options.rbs

@@ -0,0 +1,39 @@
+class Itly
+  class Plugin
+    class Snowplow
+      class CallOptions < Itly::PluginCallOptions
+      end
+
+      class PageOptions < CallOptions
+        attr_reader contexts: Array[Itly::Plugin::Snowplow::Context]?
+        attr_reader callback: (^(Integer?, String?) -> void)?
+
+        def to_s: () -> String
+
+        private
+
+        def initialize: (?contexts: Array[Itly::Plugin::Snowplow::Context]? contexts, ?callback: (^(Integer?, String?) -> void)? callback) -> void
+      end
+
+      class TrackOptions < CallOptions
+        attr_reader contexts: Array[Itly::Plugin::Snowplow::Context]?
+        attr_reader callback: (^(Integer?, String?) -> void)?
+
+        def to_s: () -> String
+
+        private
+
+        def initialize: (?contexts: Array[Itly::Plugin::Snowplow::Context]? contexts, ?callback: (^(Integer?, String?) -> void)? callback) -> void
+      end
+
+      class IdentifyOptions < CallOptions
+      end
+
+      class GroupOptions < CallOptions
+      end
+
+      class AliasOptions < CallOptions
+      end
+    end
+  end
+end

data/sig/context.rbs

@@ -0,0 +1,17 @@
+class Itly
+  class Plugin
+    class Snowplow
+      class Context
+        attr_reader schema: String
+        attr_reader data: Hash[String, untyped]
+
+        def to_self_describing_json: () -> SnowplowTracker::SelfDescribingJson
+        def to_s: () -> String
+
+        private
+
+        def initialize: (schema: String schema, data: Hash[String, untyped] data) -> void
+      end
+    end
+  end
+end

data/sig/lib/snowplow_tracker.rbs

@@ -0,0 +1,8 @@
+# Part of the gems
+class SnowplowTracker
+  class Tracker
+  end
+
+  class SelfDescribingJson
+  end
+end

data/sig/options.rbs

@@ -0,0 +1,17 @@
+class Itly
+  class Plugin
+    class Snowplow
+      class Options
+        attr_reader endpoint: String
+        attr_reader protocol: String
+        attr_reader method: String
+        attr_reader buffer_size: Integer?
+        attr_reader disabled: bool
+
+        private
+
+        def initialize: (endpoint: String endpoint, ?protocol: String protocol, ?method: String method, ?buffer_size: Integer buffer_size, ?disabled: bool disabled) -> void
+      end
+    end
+  end
+end

data/sig/snowplow.rbs

@@ -0,0 +1,23 @@
+class Itly
+  class Plugin
+    class Snowplow < Plugin
+      VERSION: String
+
+      attr_reader logger: Logger?
+      attr_reader vendor: String
+      attr_reader disabled: bool
+      attr_reader client: SnowplowTracker::Tracker
+
+      def load: (options: Itly::PluginOptions options) -> void
+      def identify: (user_id: String user_id, ?properties: propertiesHash? properties, ?options: Itly::Plugin::Snowplow::IdentifyOptions? options) -> void
+      def page: (user_id: String user_id, ?category: String? category, ?name: String? name, ?properties: propertiesHash? properties, ?options: Itly::Plugin::Segment::PageOptions? options) -> void
+      def track: (user_id: String user_id, event: Itly::Event event, ?options: Itly::Plugin::Snowplow::TrackOptions? options) -> void
+      def id: () -> String
+
+      private
+
+      def initialize: (vendor: String vendor, options: Itly::Plugin::Snowplow::Options options) -> void
+      def enabled?: () -> bool
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: itly-plugin-snowplow
+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: snowplow-tracker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+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-snowplow.gemspec
+- lib/itly/plugin-snowplow.rb
+- lib/itly/plugin/snowplow/call_options.rb
+- lib/itly/plugin/snowplow/context.rb
+- lib/itly/plugin/snowplow/options.rb
+- lib/itly/plugin/snowplow/snowplow.rb
+- lib/itly/plugin/snowplow/version.rb
+- sig/call_options.rbs
+- sig/context.rbs
+- sig/lib/snowplow_tracker.rbs
+- sig/options.rbs
+- sig/snowplow.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-snowplow
+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: Snowplow plugin for Iteratively SDK for Ruby
+test_files: []