itly-sdk 0.1.0

data/sig/aliases.rbs

@@ -0,0 +1,3 @@
+type untypedHash = Hash[untyped, untyped]
+type propertiesHash = Hash[String | Symbol, untyped]
+type callOptions = Hash[String, Itly::PluginCallOptions]

data/sig/event.rbs

@@ -0,0 +1,16 @@
+class Itly
+  class Event
+    attr_accessor name: String
+    attr_accessor properties: propertiesHash
+    attr_accessor id: String?
+    attr_accessor version: String?
+    attr_accessor plugins: Hash[String, bool]
+
+    def to_s: () -> String
+    def ==: (untyped other) -> untyped
+
+    private
+
+    def initialize: (name: String name, ?properties: propertiesHash properties, ?id: String? id, ?version: String? version, ?plugins: Hash[String | Symbol, bool] plugins) -> void
+  end
+end

data/sig/exceptions.rbs

@@ -0,0 +1,11 @@
+# Itly main class
+class Itly
+  class InitializationError < StandardError
+  end
+
+  class ValidationError < StandardError
+  end
+
+  class RemoteError < StandardError
+  end
+end

data/sig/itly.rbs

@@ -0,0 +1,32 @@
+class Itly
+  include Itly::Plugins
+
+  VERSION: String
+
+  attr_reader options: Itly::Options
+
+  def load: (?context: propertiesHash? context) ?{ (Itly::Options) -> void } -> void
+  def identify: (user_id: String user_id, ?properties: propertiesHash properties, ?options: callOptions options) -> void
+  def group: (user_id: String user_id, group_id: String group_id, ?properties: propertiesHash properties, ?options: callOptions options) -> void
+  def page: (user_id: String user_id, ?category: String? category, ?name: String? name, ?properties: propertiesHash? properties, ?options: callOptions options) -> void
+  def track: (user_id: String user_id, event: Itly::Event event, ?options: callOptions options) -> void
+  def alias: (user_id: String user_id, previous_id: String previous_id, ?options: callOptions options) -> void
+  def flush: () -> void
+  def shutdown: () -> void
+  def reset: () -> void
+  def validate: (event: Itly::Event event) -> Array[Itly::ValidationResponse]?
+
+  private
+
+  def initialize: () -> void
+  def was_initialized?: () -> bool
+  def validate_and_send_to_plugins: (action: ^(Itly::Plugin plugin, Itly::Event combined_event) -> void, post_action: ^(Itly::Plugin plugin, Itly::Event combined_event, Array[Itly::ValidationResponse] validation_results) -> void post_action, event: Itly::Event event, ?context: Itly::Event? context) -> void
+  def validate_context_and_event: (Itly::Event? context, Itly::Event event) -> [Array[Itly::ValidationResponse], Array[Itly::ValidationResponse], bool]
+  def log_validation_errors: (Array[Itly::ValidationResponse] validations, Itly::Event event) -> void
+  def raise_validation_errors: (bool is_valid, Array[Itly::ValidationResponse] validations, Itly::Event event) -> void
+  def enabled?: () -> bool
+  def validation_enabled?: () -> bool
+  def logger: () -> Logger?
+  def instantiate_plugins: () -> void
+  def run_on_plugins: () { (Itly::Plugin) -> untyped } -> Array[untyped]
+end

data/sig/lib/monitor_mixin.rbs

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

data/sig/loggers.rbs

@@ -0,0 +1,8 @@
+class Itly
+  class Loggers
+    def self.itly_dot_log: () -> Logger
+    def self.std_out: () -> Logger
+    def self.nil_logger?: () -> nil
+    def self.vars_to_log: (Hash[Symbol, untyped]) -> String
+  end
+end

data/sig/options.rbs

@@ -0,0 +1,18 @@
+class Itly
+  class Options
+    attr_accessor disabled: bool
+    attr_accessor environment: Symbol
+    attr_accessor logger: Logger?
+    attr_accessor plugins: Array[Itly::Plugin]
+    attr_writer validation: Integer
+
+    def for_plugin: () -> Itly::PluginOptions
+    def validation: () -> Integer
+    def development?: () -> bool
+    def production?: () -> bool
+
+    private
+
+    def initialize: () -> void
+  end
+end

data/sig/options/environment.rbs

@@ -0,0 +1,8 @@
+class Itly
+  class Options
+    module Environment
+      DEVELOPMENT: Symbol
+      PRODUCTION: Symbol
+    end
+  end
+end

data/sig/options/validation.rbs

@@ -0,0 +1,10 @@
+class Itly
+  class Options
+    module Validation
+      DEFAULT: Integer
+      DISABLED: Integer
+      TRACK_INVALID: Integer
+      ERROR_ON_INVALID: Integer
+    end
+  end
+end

data/sig/plugin.rbs

@@ -0,0 +1,21 @@
+class Itly
+  class Plugin
+    def load: (options: Itly::PluginOptions options) -> void
+    def identify: (user_id: String user_id, ?properties: propertiesHash? properties, ?options: Itly::PluginCallOptions? options) -> void
+    def post_identify: (user_id: String user_id, properties: propertiesHash? properties, validation_results: Array[Itly::ValidationResponse] validation_results) -> void
+    def group: (user_id: String user_id, group_id: String group_id, ?properties: propertiesHash? properties, ?options: Itly::PluginCallOptions? options) -> void
+    def post_group: (user_id: String user_id, group_id: String group_id, properties: propertiesHash? properties, validation_results: Array[Itly::ValidationResponse] validation_results) -> void
+    def page: (user_id: String user_id, ?category: String? category, ?name: String? name, ?properties: propertiesHash? properties, ?options: Itly::PluginCallOptions? options) -> void
+    def post_page: (user_id: String user_id, category: String? category, name: String? name, properties: propertiesHash? properties, validation_results: Array[Itly::ValidationResponse] validation_results) -> void
+    def track: (user_id: String user_id, event: Itly::Event event, ?options: Itly::PluginCallOptions? options) -> void
+    def post_track: (user_id: String user_id, event: Itly::Event event, validation_results: Array[Itly::ValidationResponse] validation_results) -> void
+    def alias: (user_id: String user_id, previous_id: String previous_id, ?options: Itly::PluginCallOptions? options) -> void
+    def post_alias: (user_id: String user_id, previous_id: String previous_id) -> void
+    def flush: () -> void
+    def shutdown: () -> void
+    def reset: () -> void
+    def validate: (event: Itly::Event event) -> Itly::ValidationResponse?
+    def get_plugin_options: (Itly::Options options) -> propertiesHash
+    def id: () -> String
+  end
+end

data/sig/plugin_call_options.rbs

@@ -0,0 +1,4 @@
+class Itly
+  class PluginCallOptions
+  end
+end

data/sig/plugin_options.rbs

@@ -0,0 +1,10 @@
+class Itly
+  class PluginOptions
+    attr_reader environment: Symbol
+    attr_reader logger: Logger?
+
+    private
+
+    def initialize: (environment: Symbol environment, logger: Logger? logger) -> void
+  end
+end

data/sig/plugins.rbs

@@ -0,0 +1,4 @@
+class Itly
+  class Plugins
+  end
+end

data/sig/validation_response.rbs

@@ -0,0 +1,13 @@
+class Itly
+  class ValidationResponse
+    attr_reader valid: bool
+    attr_reader plugin_id: String
+    attr_reader message: String
+
+    def to_s: () -> String
+
+    private
+
+    def initialize: (valid: bool valid, plugin_id: String plugin_id, ?message: String message) -> void
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: itly-sdk
+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: []
+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-sdk.gemspec
+- lib/itly-sdk.rb
+- lib/itly/event.rb
+- lib/itly/exceptions.rb
+- lib/itly/itly.rb
+- lib/itly/loggers.rb
+- lib/itly/options.rb
+- lib/itly/options/environment.rb
+- lib/itly/options/validation.rb
+- lib/itly/plugin.rb
+- lib/itly/plugin_call_options.rb
+- lib/itly/plugin_options.rb
+- lib/itly/plugins.rb
+- lib/itly/validation_response.rb
+- lib/itly/version.rb
+- sig/aliases.rbs
+- sig/event.rbs
+- sig/exceptions.rbs
+- sig/itly.rbs
+- sig/lib/monitor_mixin.rbs
+- sig/loggers.rbs
+- sig/options.rbs
+- sig/options/environment.rbs
+- sig/options/validation.rbs
+- sig/plugin.rbs
+- sig/plugin_call_options.rbs
+- sig/plugin_options.rbs
+- sig/plugins.rbs
+- sig/validation_response.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/sdk
+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: Iteratively SDK for Ruby
+test_files: []