vwo-fme-ruby-sdk 1.0.0 → 1.2.0

data/lib/vwo.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
+# Copyright 2025 Wingify Software Pvt. Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,45 +12,63 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'vwo/utils/logger_helper'
-require_relative 'vwo/vwo_client'
+require 'json'
+require 'uri'
 require_relative 'vwo/vwo_builder'
-require_relative 'vwo/constants'
-require_relative 'vwo/utils/request'
+require_relative 'vwo/vwo_client'
 
-# The main VWO module
-module VWO
-  # Class-level variable to hold the VWO client instance
+class VWO
+  @@vwo_builder = nil
   @@instance = nil
 
-  # Initialize the VWO SDK with the given options
-  def self.init(options = {})
-    raise 'options is required to initialize VWO' unless options.is_a?(Hash)
-    raise 'sdk_key is required to initialize VWO' if options[:sdk_key].nil? || options[:sdk_key].empty?
-    raise 'account_id is required to initialize VWO' if options[:account_id].nil? || options[:account_id].empty?
-    raise 'gateway_service_url is required to initialize VWO' if options[:gateway_service_url].nil? || options[:gateway_service_url].empty?
-
-    vwo_init_options = {
-      sdk_key: options[:sdk_key],
-      account_id: options[:account_id],
-      gateway_service_url: options[:gateway_service_url]
-    }
-
-    set_instance(vwo_init_options)
-  rescue StandardError => e
-    LoggerHelper.logger.error("Error initializing VWO: #{e.message}")
-    @@instance = VWOClient.new(nil)
+  def initialize(options)
+    self.class.set_instance(options)
   end
 
-  # Set the VWO instance using VWOBuilder and VWOClient
   def self.set_instance(options)
-    vwo_builder = VWOBuilder.new(options)
-    vwo_builder.init_client
-    @@instance = VWOClient.new(options)
+    options_vwo_builder = options[:vwo_builder]
+    @@vwo_builder = options_vwo_builder || VWOBuilder.new(options)
+
+    @@instance = @@vwo_builder
+                   .set_logger
+                   .set_settings_service
+                   .set_storage
+                   .set_network_manager
+                   .set_segmentation
+                   .init_polling
+
+    if options[:settings]
+      return @@vwo_builder.build(options[:settings])
+    end
+
+    settings = @@vwo_builder.get_settings
+    @@instance = @@vwo_builder.build(settings)
+    @@instance
   end
 
-  # Get the singleton instance of VWO
   def self.instance
     @@instance
   end
-end
+
+  def self.init(options)
+
+    begin
+      unless options.is_a?(Hash)
+        puts "[ERROR]: VWO-SDK: Please provide the options as a hash"
+      end
+
+      unless options[:sdk_key]&.is_a?(String) && !options[:sdk_key].empty?
+        puts "[ERROR]: VWO-SDK: Please provide the sdkKey in the options and should be a of type string"
+      end
+
+      unless options[:account_id] && (options[:account_id].is_a?(Integer) || (options[:account_id].is_a?(String) && !options[:account_id].empty?))
+        puts "[ERROR]: VWO-SDK: Please provide VWO account ID in the options and should be a of type string|number"
+      end
+
+      new(options)
+      @@instance
+    rescue StandardError => e
+      puts "[ERROR]: VWO-SDK: Got error while initializing VWO: #{e.message}"
+    end
+  end
+end

metadata

@@ -1,29 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: vwo-fme-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - VWO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: net-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: A Ruby SDK for Feature Management And Experimentation
 email:
 - dev@wingify.com
@@ -31,11 +143,81 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/resources/debug_messages.json
+- lib/resources/error_messages.json
+- lib/resources/info_messages.json
+- lib/resources/warn_messages.json
 - lib/vwo.rb
-- lib/vwo/constants.rb
-- lib/vwo/utils/feature_flag_response.rb
-- lib/vwo/utils/logger_helper.rb
-- lib/vwo/utils/request.rb
+- lib/vwo/api/get_flag.rb
+- lib/vwo/api/set_attribute.rb
+- lib/vwo/api/track_event.rb
+- lib/vwo/constants/constants.rb
+- lib/vwo/decorators/storage_decorator.rb
+- lib/vwo/enums/api_enum.rb
+- lib/vwo/enums/campaign_type_enum.rb
+- lib/vwo/enums/decision_types_enum.rb
+- lib/vwo/enums/event_enum.rb
+- lib/vwo/enums/headers_enum.rb
+- lib/vwo/enums/hooks_enum.rb
+- lib/vwo/enums/http_method_enum.rb
+- lib/vwo/enums/log_level_enum.rb
+- lib/vwo/enums/status_enum.rb
+- lib/vwo/enums/storage_enum.rb
+- lib/vwo/enums/url_enum.rb
+- lib/vwo/models/campaign/campaign_model.rb
+- lib/vwo/models/campaign/feature_model.rb
+- lib/vwo/models/campaign/impact_campaign_model.rb
+- lib/vwo/models/campaign/metric_model.rb
+- lib/vwo/models/campaign/rule_model.rb
+- lib/vwo/models/campaign/variable_model.rb
+- lib/vwo/models/campaign/variation_model.rb
+- lib/vwo/models/gateway_service_model.rb
+- lib/vwo/models/schemas/settings_schema_validation.rb
+- lib/vwo/models/settings/settings_model.rb
+- lib/vwo/models/storage/storage_data_model.rb
+- lib/vwo/models/user/context_model.rb
+- lib/vwo/models/user/context_vwo_model.rb
+- lib/vwo/models/user/get_flag_response.rb
+- lib/vwo/models/vwo_options_model.rb
+- lib/vwo/packages/decision_maker/decision_maker.rb
+- lib/vwo/packages/logger/core/log_manager.rb
+- lib/vwo/packages/logger/core/transport_manager.rb
+- lib/vwo/packages/logger/log_message_builder.rb
+- lib/vwo/packages/logger/logger.rb
+- lib/vwo/packages/logger/transports/console_transport.rb
+- lib/vwo/packages/network_layer/client/network_client.rb
+- lib/vwo/packages/network_layer/handlers/request_handler.rb
+- lib/vwo/packages/network_layer/manager/network_manager.rb
+- lib/vwo/packages/network_layer/models/global_request_model.rb
+- lib/vwo/packages/network_layer/models/request_model.rb
+- lib/vwo/packages/network_layer/models/response_model.rb
+- lib/vwo/packages/segmentation_evaluator/core/segmentation_manager.rb
+- lib/vwo/packages/segmentation_evaluator/enums/segment_operand_regex_enum.rb
+- lib/vwo/packages/segmentation_evaluator/enums/segment_operand_value_enum.rb
+- lib/vwo/packages/segmentation_evaluator/enums/segment_operator_value_enum.rb
+- lib/vwo/packages/segmentation_evaluator/evaluators/segment_evaluator.rb
+- lib/vwo/packages/segmentation_evaluator/evaluators/segment_operand_evaluator.rb
+- lib/vwo/packages/segmentation_evaluator/utils/segment_util.rb
+- lib/vwo/packages/storage/connector.rb
+- lib/vwo/packages/storage/storage.rb
+- lib/vwo/services/campaign_decision_service.rb
+- lib/vwo/services/hooks_service.rb
+- lib/vwo/services/logger_service.rb
+- lib/vwo/services/settings_service.rb
+- lib/vwo/services/storage_service.rb
+- lib/vwo/utils/campaign_util.rb
+- lib/vwo/utils/data_type_util.rb
+- lib/vwo/utils/decision_util.rb
+- lib/vwo/utils/function_util.rb
+- lib/vwo/utils/gateway_service_util.rb
+- lib/vwo/utils/impression_util.rb
+- lib/vwo/utils/log_message_util.rb
+- lib/vwo/utils/meg_util.rb
+- lib/vwo/utils/network_util.rb
+- lib/vwo/utils/rule_evaluation_util.rb
+- lib/vwo/utils/settings_util.rb
+- lib/vwo/utils/url_util.rb
+- lib/vwo/utils/uuid_util.rb
 - lib/vwo/vwo_builder.rb
 - lib/vwo/vwo_client.rb
 homepage: 
@@ -54,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/vwo/utils/request.rb

@@ -1,89 +0,0 @@
-# Copyright 2024 Wingify Software Pvt. Ltd.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require 'net/http'
-require 'uri'
-require 'json'
-
-module VWO
-  module Utils
-    # The Request class is responsible for sending HTTP GET and POST requests.
-    # It uses a base URL that can be set once and then reused for all subsequent requests.
-    class Request
-      @@base_url = ''  # Class variable to store the base URL for requests.
-
-      # Sets the base URL to be used for making HTTP requests.
-      #
-      # @param [String] url The base URL to be used for all requests.
-      def self.set_base_url(url)
-        @@base_url = url
-      end
-
-      # Sends an HTTP GET request to a specific endpoint using the set base URL.
-      #
-      # @param [String] endpoint The API endpoint to send the GET request to.
-      # @return [String, nil] Returns the response body if the request is successful, or nil if it fails.
-      def self.send_get_request(endpoint)
-        # Combine the base URL and endpoint into a full URI.
-        full_url = URI.join(@@base_url, endpoint)
-
-        # Send the GET request and capture the response.
-        response = Net::HTTP.get_response(full_url)
-
-        # Check if the response was successful (status code 2xx).
-        if response.is_a?(Net::HTTPSuccess)
-          response.body  # Return the response body if successful.
-        else
-          # Log an error message if the request fails and return nil.
-          puts "GET request failed with response code: #{response.code}"
-          nil
-        end
-      end
-
-      # Sends an HTTP POST request with JSON data to a specific endpoint using the set base URL.
-      #
-      # @param [String] endpoint The API endpoint to send the POST request to.
-      # @param [Hash] data The data to be sent as the POST request body, in JSON format.
-      # @return [String, nil] Returns the response body if the request is successful, or nil if it fails.
-      def self.send_post_request(endpoint, data)
-        # Combine the base URL and endpoint into a full URI.
-        full_url = URI.join(@@base_url, endpoint)
-
-        # Initialize a new HTTP object for the specified host and port.
-        http = Net::HTTP.new(full_url.host, full_url.port)
-
-        # Enable SSL (HTTPS) if the URL scheme is 'https'.
-        http.use_ssl = true if full_url.scheme == 'https'
-
-        # Create a new POST request object, setting the content type to JSON.
-        request = Net::HTTP::Post.new(full_url, { 'Content-Type' => 'application/json' })
-
-        # Convert the data to JSON and set it as the request body.
-        request.body = data.to_json
-
-        # Send the POST request and capture the response.
-        response = http.request(request)
-
-        # Check if the response was successful (status code 2xx).
-        if response.is_a?(Net::HTTPSuccess)
-          response.body  # Return the response body if successful.
-        else
-          # Log an error message if the request fails and return nil.
-          puts "POST request failed with response code: #{response.code}"
-          nil
-        end
-      end
-    end
-  end
-end