itly-plugin-segment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9f20dfcfa5ed0fa7ef7d326b01393cbf9ec6569156574b860ecc476ac7a37e2
+  data.tar.gz: ce26f8c877644a4c61cdbb6f0229326f26779090bf44ef5e2798f791cf31e5f0
+SHA512:
+  metadata.gz: 06df66a8cd5aaec7f3481b64e147668a87c5e9691b9e3337727c9081744092bdda7639982798f10e7f60e75050e79f90ae462bb8b773419b77bf3f43c3b5dc06
+  data.tar.gz: '0887e543ce1a1ce087ee64879924eb5c7e4861f5744da5049f0904c322582b7945bb59c8ae0c24ea037bd3e445a45bebeff8a2fe66282a6f6816479b4b809763'

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

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

data/lib/itly/plugin-segment.rb

@@ -0,0 +1,11 @@
+# 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/segment/segment'
+require_relative 'plugin/segment/options'
+require_relative 'plugin/segment/call_options'
+require_relative 'plugin/segment/version'

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    # Segment plugin class for Itly SDK
+    class Segment
+      ##
+      # Segment specific plugin options class
+      #
+      class CallOptions < Itly::PluginCallOptions
+        attr_reader :callback, :integrations, :context, :message_id, :timestamp, :anonymous_id
+
+        def initialize(
+          callback: nil, integrations: nil, context: nil, message_id: nil, timestamp: nil, anonymous_id: nil
+        )
+          super()
+          @integrations = integrations
+          @callback = callback
+          @context = context
+          @message_id = message_id
+          @timestamp = timestamp
+          @anonymous_id = anonymous_id
+        end
+
+        ##
+        # Return all properties to be passed to the client
+        # While excluding the `callback` property
+        #
+        # @return [Hash] properties
+        #
+        def to_hash
+          %w[integrations context message_id timestamp anonymous_id].each_with_object({}) do |prop, hash|
+            hash[prop.to_sym] = send(prop) unless send(prop).nil?
+          end
+        end
+
+        ##
+        # Get the plugin description, for logs
+        #
+        # @return [String] description
+        #
+        def to_s
+          class_name = self.class.name.split('::').last
+          props = %w[integrations context message_id timestamp anonymous_id].collect do |prop|
+            " #{prop}: #{send prop}" unless send(prop).nil?
+          end.compact
+          "#<Segment::#{class_name} callback: #{callback.nil? ? 'nil' : 'provided'}#{props.join}>"
+        end
+      end
+
+      ##
+      # Segment 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/segment/options.rb

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

data/lib/itly/plugin/segment/segment.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+require 'simple_segment'
+
+class Itly
+  class Plugin
+    ##
+    # Segment plugin class for Itly SDK
+    #
+    # Automatically loaded at runtime in any new +Itly+ object
+    #
+    class Segment < Plugin
+      attr_reader :client, :disabled
+
+      ##
+      # Instantiate a new Plugin::Segment
+      #
+      # @param [String] write_key: specify the Segment write key
+      # @param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false
+      #
+      def initialize(write_key:, disabled: false)
+        super()
+        @write_key = write_key
+        @disabled = disabled
+      end
+
+      ##
+      # Initialize Segment::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
+        error_handler = proc do |error_code, error_body, exception, _|
+          message = 'The client returned an error.'
+          message += " Error code: #{error_code}. " if error_code
+          message += " Error body: #{error_body}. " if error_body
+          message += " Exception #{exception.class.name}: #{exception.message}." if exception
+
+          raise Itly::RemoteError, message
+        end
+
+        @client = ::SimpleSegment::Client.new \
+          write_key: @write_key, logger: @logger,
+          on_error: error_handler
+      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::Segment::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
+        payload = { user_id: user_id }
+        payload.merge! traits: properties.dup if properties
+        payload.merge! options.to_hash if options
+
+        call_end_point(options&.callback) do
+          @client.identify(**payload)
+        end
+      end
+
+      ##
+      # Associate a user with their group
+      #
+      # Raise an error if the client fails
+      #
+      # @param [String] user_id: the id of the user in your application
+      # @param [String] group_id: the id of the group in your application
+      # @param [Hash] properties: the properties to pass to your application
+      # @param [Itly::Plugin::Segment::GroupOptions] options: the plugin specific options
+      #
+      def group(user_id:, group_id:, properties: nil, options: nil)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log(
+          user_id: user_id, group_id: group_id, properties: properties, options: options
+        )
+        @logger&.info "#{id}: group(#{log})"
+
+        # Send through the client
+        payload = { user_id: user_id, group_id: group_id }
+        payload.merge! traits: properties.dup if properties
+        payload.merge! options.to_hash if options
+
+        call_end_point(options&.callback) do
+          @client.group(**payload)
+        end
+      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::Segment::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})"
+
+        # Send through the client
+        payload = { user_id: user_id }
+        payload.merge! name: name if name
+        payload.merge! options.to_hash if options
+        if properties && category
+          payload.merge! properties: properties.dup.merge(category: category)
+        elsif properties
+          payload.merge! properties: properties.dup
+        elsif category
+          payload.merge! properties: { category: category }
+        end
+
+        call_end_point(options&.callback) do
+          @client.page(**payload)
+        end
+      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::Segment::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
+        payload = { user_id: user_id, event: event.name, properties: event.properties.dup }
+        payload.merge! options.to_hash if options
+
+        call_end_point(options&.callback) do
+          @client.track(**payload)
+        end
+      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::Segment::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
+        payload = { user_id: user_id, previous_id: previous_id }
+        payload.merge! options.to_hash if options
+
+        call_end_point(options&.callback) do
+          @client.alias(**payload)
+        end
+      end
+
+      ##
+      # Get the plugin ID
+      #
+      # @return [String] plugin id
+      #
+      def id
+        'segment'
+      end
+
+      private
+
+      def enabled?
+        !@disabled
+      end
+
+      def call_end_point(callback)
+        raise 'You need to give a block' unless block_given?
+
+        # Call remote endpoint (Note: the Segment client returns a Net::HTTPResponse)
+        response = yield
+
+        # yield to the callback passed in to options
+        callback&.call(response.code.to_i, response.body)
+      end
+    end
+  end
+end

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

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

data/sig/call_options.rbs

@@ -0,0 +1,36 @@
+class Itly
+  class Plugin
+    class Segment
+      class CallOptions < Itly::PluginCallOptions
+        attr_reader callback: (^(Integer?, String?) -> void)?
+        attr_reader integrations: Hash[String, bool]?
+        attr_reader context: Hash[String, bool]?
+        attr_reader message_id: String?
+        attr_reader timestamp: String?
+        attr_reader anonymous_id: String?
+
+        def to_hash: () -> untypedHash
+        def to_s: () -> String
+
+        private
+
+        def initialize: (?callback: (^(Integer?, String?) -> void)? callback, ?integrations: Hash[String, bool]? integrations, ?context: Hash[String, bool]? context, ?message_id: String? message_id, ?timestamp: String? timestamp, ?anonymous_id: String? anonymous_id) -> void
+      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/lib/monitor_mixin.rbs

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

data/sig/lib/net_http_response.rbs

@@ -0,0 +1,4 @@
+class Net
+  class HTTPResponse
+  end
+end

data/sig/lib/simple_segment_client.rbs

@@ -0,0 +1,12 @@
+class SimpleSegment
+  class Client
+    def identify: (user_id: String user_id, traits: propertiesHash traits) -> void
+    def group: (user_id: String user_id, group_id: String group_id, traits: propertiesHash traits) -> void
+    def track: (user_id: String user_id, event: String event, properties: propertiesHash properties) -> void
+    def alias: (user_id: String user_id, previous_id: String previous_id) -> void
+
+    private
+
+    def initialize: (write_key: String write_key, logger: Logger? logger) -> void
+  end
+end

data/sig/options.rbs

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

data/sig/segment.rbs

@@ -0,0 +1,24 @@
+class Itly
+  class Plugin
+    class Segment < Plugin
+      VERSION: String
+
+      attr_reader client: SimpleSegment::Client?
+      attr_reader disabled: bool
+
+      def load: (options: Itly::PluginOptions options) -> void
+      def identify: (user_id: String user_id, ?properties: propertiesHash? properties, ?options: Itly::Plugin::Segment::IdentifyOptions? options) -> void
+      def group: (user_id: String user_id, group_id: String group_id, ?properties: propertiesHash? properties, ?options: Itly::Plugin::Segment::GroupOptions? 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::Segment::TrackOptions? options) -> void
+      def alias: (user_id: String user_id, previous_id: String previous_id, ?options: Itly::Plugin::Segment::AliasOptions? options) -> void
+      def id: () -> String
+
+      private
+
+      def initialize: (write_key: String write_key, ?disabled: bool disabled) -> void
+      def enabled?: () -> bool
+      def call_end_point: ((^(Integer?, String?) -> void)? callback) ?{ () -> Net::HTTPResponse } -> void
+    end
+  end
+end

metadata

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