itly-plugin-testing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8abdb87423a7837ed4c440182e4942d59c3b575a5a66b236b80e692c8a941f5
+  data.tar.gz: 22dff78de21efb4e434d8dcc5b0bcac92307c401978fce7457410e102ffc6652
+SHA512:
+  metadata.gz: 72e0a57e668dad74226a7357fe86e215742093c3ef60b9d8bbe8dba2cc565923d948fd1bf4028713b179e0d526221fcaaa9b28fd018766c13e6d9c0b91705560
+  data.tar.gz: c8d4c76591439746abf764f9ea444699bb6dd29ffaf8494a26d9e6591d54a89a33355f1eddb4efdb9875cb09169450ebdf5da40e6ba9c5b5757fa4ac83242ef6

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-testing.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-testing'
+
+# 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./spec/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-testing.gemspec

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

data/lib/itly/plugin-testing.rb

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

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Itly
+  class Plugin
+    # Testing plugin class for Itly SDK
+    class Testing
+      ##
+      # Testing specific plugin options class
+      #
+      class CallOptions < Itly::PluginCallOptions
+      end
+
+      ##
+      # Testing 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/testing/testing.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+require 'itly-sdk'
+
+class Itly
+  class Plugin
+    ##
+    # Testing plugin class for Itly SDK
+    #
+    class Testing < Plugin
+      attr_reader :logger, :disabled
+
+      ##
+      # Instantiate a new Plugin::Testing
+      #
+      # @param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false
+      #
+      def initialize(disabled: false)
+        super()
+        @calls = Concurrent::Hash.new
+        @disabled = disabled
+      end
+
+      ##
+      # Initialize TestingApi client
+      #
+      # @param [Itly::PluginOptions] options: plugins options
+      #
+      def load(options:)
+        super
+        # Get options
+        @logger = options.logger
+
+        # Log
+        logger&.info "#{id}: load()"
+
+        logger&.info "#{id}: plugin is disabled!" if @disabled
+      end
+
+      ##
+      # Empty the cache
+      #
+      def reset
+        @calls.clear
+      end
+
+      ##
+      # Get all events that was sent to the +track+ method
+      #
+      # @param [String] user_id: (optional) filter the events returned by the method by the user_id.
+      #   Leave it +nil+ to get all events
+      # @return [Array] array of EvItly::Event objects that was sent to the +track+ method
+      #
+      def all(user_id: nil)
+        calls = @calls['track'].dup
+        calls = calls.select { |call| call[:user_id] == user_id } unless user_id.nil?
+        calls.collect { |call| call[:event] }
+      end
+
+      ##
+      # Get events that was sent to the +track+ method of the specified class name
+      #
+      # @param [Event] class_name: the method return only events of the specified class name
+      # @param [String] user_id: (optional) filter the events returned by the method by the user_id.
+      #   Leave it +nil+ to get all events
+      # @return [Array] array of Itly::Event objects that was sent to the +track+ method
+      #
+      def of_type(class_name:, user_id: nil)
+        calls = all user_id: user_id
+        calls.select { |call| call.is_a? class_name }
+      end
+
+      ##
+      # Get the first event that was sent to the +track+ method of the specified class name
+      #
+      # @param [Event] class_name: the method return only an event of the specified class name
+      # @param [String] user_id: (optional) filter the events returned by the method by the user_id.
+      #   Leave it +nil+ to get all events
+      # @return [Itly::Event] object that was sent to the +track+ method. +nil+ if none was found
+      #
+      def first_of_type(class_name:, user_id: nil)
+        of_type(class_name: class_name, user_id: user_id).first
+      end
+
+      ##
+      # Tracking methods
+      #
+      # Accept any params, store them in the @calls instance variable
+      #
+      %i[alias identify group track].each do |method_name|
+        define_method method_name do |args|
+          track_calls method_name.to_s, args
+        end
+      end
+
+      ##
+      # Get the plugin ID
+      #
+      # @return [String] plugin id
+      #
+      def id
+        'testing'
+      end
+
+      private
+
+      def enabled?
+        !@disabled
+      end
+
+      def track_calls(method_name, args)
+        @calls[method_name] ||= []
+        @calls[method_name] << args
+      end
+    end
+  end
+end

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

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

data/sig/call_options.rbs

@@ -0,0 +1,23 @@
+class Itly
+  class Plugin
+    class Testing
+      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/testing.rbs

@@ -0,0 +1,28 @@
+class Itly
+  class Plugin
+    class Testing < Plugin
+      VERSION: String
+
+      attr_reader logger: Logger?
+      attr_reader disabled: bool
+
+      def load: (options: Itly::PluginOptions options) -> void
+      def reset: () -> void
+      def all: (?user_id: String? user_id) -> Array[Itly::Event]
+      def of_type: (class_name: Class class_name, ?user_id: String? user_id) -> Array[Itly::Event]
+      def first_of_type: (class_name: Class class_name, ?user_id: String? user_id) -> Itly::Event?
+
+      def alias: (user_id: String user_id, previous_id: String previous_id, ?options: Itly::PluginCallOptions? options) -> void
+      def identify: (user_id: String user_id, ?properties: propertiesHash? properties, ?options: Itly::PluginCallOptions? options) -> void
+      def group: (user_id: String user_id, group_id: String group_id, ?properties: propertiesHash? properties, ?options: Itly::PluginCallOptions? options) -> void
+      def track: (user_id: String user_id, event: Itly::Event event, ?options: Itly::PluginCallOptions? options) -> void
+      def id: () -> String
+
+      private
+
+      def initialize: (?disabled: bool disabled) -> void
+      def enabled?: () -> bool
+      def track_calls: (String method_name, Hash[Symbol, untyped] args) -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: itly-plugin-testing
+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: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+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-testing.gemspec
+- lib/itly/plugin-testing.rb
+- lib/itly/plugin/testing/call_options.rb
+- lib/itly/plugin/testing/testing.rb
+- lib/itly/plugin/testing/version.rb
+- sig/call_options.rbs
+- sig/testing.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-testing
+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: Testing plugin for Iteratively SDK for Ruby
+test_files: []