itly-plugin-schema-validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4019396633434a7415feac1efa74be0672c5db11f054d2fcac3d8849230b353d
+  data.tar.gz: 1b81d30c1d7ba450578a9cd238806406f478cd9a7ec9c78f6cbf3f2d2d784001
+SHA512:
+  metadata.gz: 9475e517a4f4c7b855d2f7374fc6d1e4b94661b46287af0aa28bbfcc8aa04d3f8572cda7ae9b159f3983c5a94892f4d20b03ce70205921550756c61c8fa97819
+  data.tar.gz: 227e09dd3c772e8315eed6b44b76ba6077154624786c9b87f7115af56918f0bc0599f39e3fe03ae682677eee9a13c4d61fbad06ebbd744fd2b22a58e1684c7a6

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-schema-validator.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-schema_validator'
+
+# 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-schema-validator.gemspec

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

data/lib/itly/plugin-schema-validator.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'plugin-schema_validator'

data/lib/itly/plugin-schema_validator.rb

@@ -0,0 +1,9 @@
+# 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/schema_validator/schema_validator'
+require_relative 'plugin/schema_validator/version'

data/lib/itly/plugin/schema_validator/schema_validator.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'itly-sdk'
+require 'json_schemer'
+
+class Itly
+  class Plugin
+    ##
+    # Schema Validator plugin class for Itly SDK
+    #
+    # Automatically loaded at runtime in any new +Itly+ object
+    #
+    class SchemaValidator < Plugin
+      attr_reader :disabled
+
+      ##
+      # Instantiate a new Plugin::SchemaValidator
+      #
+      # @param [Hash] schemas: schemas for validation. Example:
+      #
+      #     Plugin::SchemaValidator.new schema: {
+      #       schema_1: {field: 'value, ...},
+      #       schema_2: {field: 'value, ...}
+      #     }
+      # @param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false
+      #
+      def initialize(schemas:, disabled: false)
+        super()
+        @schemas = schemas
+        @disabled = disabled
+        @validators = {}
+      end
+
+      ##
+      # Initialize the Plugin::SchemaValidator object
+      #
+      # @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
+
+      ##
+      # Validate an Event
+      #
+      # Call +event+ on all plugins and collect their return values.
+      #
+      # @param [Event] event: the event to validate
+      #
+      # @return [Itly::ValidationResponse] a Itly::ValidationResponse object generated
+      # by the plugins or nil to indicate that there were no error
+      #
+      def validate(event:)
+        super
+        return unless enabled?
+
+        # Log
+        log = Itly::Loggers.vars_to_log event: event
+        @logger&.info "#{id}: validate(#{log})"
+
+        # Check that we have a schema for this event
+        if @schemas[event.name.to_sym].nil?
+          raise Itly::ValidationError, "Event '#{event.name}' not found in tracking plan."
+        end
+
+        # Lazily initialize and cache validator
+        @validators[event.name.to_sym] ||= JSONSchemer.schema(@schemas[event.name.to_sym])
+
+        # Validation
+        properties = deeply_stringify_keys event.properties
+        result = @validators[event.name.to_sym].validate properties
+
+        return_validation_responses event, result
+      end
+
+      ##
+      # Get the plugin ID
+      #
+      # @return [String] plugin id
+      #
+      def id
+        'schema_validator'
+      end
+
+      private
+
+      def enabled?
+        !@disabled
+      end
+
+      def return_validation_responses(event, result)
+        return if result.count.zero?
+
+        message = "Passed in '#{event.name}' properties did not validate against your tracking plan. "\
+          "Error#{'s' if result.count > 1}: "
+
+        message += result.collect do |error|
+          if error['details']
+            hash_to_message error['details']
+          else
+            "#{error['data']} #{error['data_pointer']}"
+          end
+        end.join '. '
+
+        Itly::ValidationResponse.new valid: false, plugin_id: id, message: message
+      end
+
+      def deeply_stringify_keys(hash)
+        stringified_hash = {}
+        hash.each do |k, v|
+          stringified_hash[k.to_s] = \
+            case v
+            when Hash
+              deeply_stringify_keys(v)
+            when Array
+              v.map { |i| i.is_a?(Hash) ? deeply_stringify_keys(i) : i }
+            else
+              v
+            end
+        end
+        stringified_hash
+      end
+
+      def hash_to_message(hash)
+        hash.collect do |k, v|
+          "#{k}: #{v.join ', '}"
+        end.join '. '
+      end
+    end
+  end
+end

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

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

data/sig/lib/json_schemer.rbs

@@ -0,0 +1,3 @@
+class JSONSchemer
+  def validate: (propertiesHash) -> untyped
+end

data/sig/lib/monitor_mixin.rbs

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

data/sig/schema_validator.rbs

@@ -0,0 +1,21 @@
+class Itly
+  class Plugin
+    class SchemaValidator < Plugin
+      VERSION: String
+
+      attr_reader disabled: bool
+
+      def load: (options: Itly::PluginOptions options) -> void
+      def validate: (event: Itly::Event event) -> Itly::ValidationResponse?
+      def id: () -> String
+
+      private
+
+      def initialize: (schemas: propertiesHash schemas, ?disabled: bool disabled) -> void
+      def enabled?: () -> bool
+      def return_validation_responses: (Itly::Event event, untyped result) -> Itly::ValidationResponse?
+      def deeply_stringify_keys: (propertiesHash hash) -> Hash[String, untyped]
+      def hash_to_message: (propertiesHash hash) -> String
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: itly-plugin-schema-validator
+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: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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-schema-validator.gemspec
+- lib/itly/plugin-schema-validator.rb
+- lib/itly/plugin-schema_validator.rb
+- lib/itly/plugin/schema_validator/schema_validator.rb
+- lib/itly/plugin/schema_validator/version.rb
+- sig/lib/json_schemer.rbs
+- sig/lib/monitor_mixin.rbs
+- sig/schema_validator.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-schema-validator
+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: SchemaValidator plugin for Iteratively SDK for Ruby
+test_files: []