vwo-fme-ruby-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f333409ec82d99443663437007b9b0934fe205e07e1cef53d905c911faf7980
+  data.tar.gz: 7a866f482484ff481d503a90bca9534bbce6832daf99e81a1791a36d0e41e290
+SHA512:
+  metadata.gz: 0db232a732e10984da13efbc1b47a4e9bb72103a9453da6f910e4c76b43f35b507db4fbd556175e8428c10d9dd17c89fc45b8d097435b1e2133b247d3e101686
+  data.tar.gz: 80119347d3b874637c6af47aa2ee91bdc2fe095a665c4b63de3d8761466e7e587557ad42c24cae879630a06fff211decec14328441fbf0cbf8175ef23ab389a2

data/lib/vwo/constants.rb

@@ -0,0 +1,24 @@
+# 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.
+
+module VWO
+    module Constants
+      HTTPS_PROTOCOL = 'https://'
+      BASE_URL = 'dev.visualwebsiteoptimizer.com'
+      ENDPOINT_GET_FLAG = '/server-side/getFlag'
+      ENDPOINT_TRACK_EVENT = '/server-side/trackEvent'
+      ENDPOINT_SET_ATTRIBUTE = '/server-side/setAttribute'
+      ENDPOINT_ACCOUNT_SETTINGS = '/server-side/v2-settings'
+    end
+  end

data/lib/vwo/utils/feature_flag_response.rb

@@ -0,0 +1,38 @@
+# 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.
+
+module VWO
+  class FeatureFlagResponse
+    def initialize(is_enabled, variables = [])
+      @is_enabled = is_enabled
+      @variables = variables
+    end
+
+    # Method to check if the flag is enabled
+    def is_enabled
+      @is_enabled
+    end
+
+    # Method to get all variables
+    def get_variables
+      @variables
+    end
+
+    # Method to get a specific variable by key, with a fallback default value
+    def get_variable(key, default_value)
+      variable = @variables.find { |var| var['key'] == key }
+      variable ? variable['value'] : default_value
+    end
+  end
+end

data/lib/vwo/utils/logger_helper.rb

@@ -0,0 +1,24 @@
+# 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 'logger'
+
+module LoggerHelper
+  # Singleton logger instance
+  def self.logger
+    @logger ||= Logger.new(STDOUT)  # You can log to a file like 'application.log'
+    @logger.level = Logger::DEBUG    # Set the default logging level
+    @logger
+  end
+end

data/lib/vwo/utils/request.rb

@@ -0,0 +1,89 @@
+# 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

data/lib/vwo/vwo_builder.rb

@@ -0,0 +1,29 @@
+# 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_relative 'constants'
+require_relative 'utils/request'  # Include your request utilities
+
+module VWO
+  class VWOBuilder
+    def initialize(options)
+      @options = options
+    end
+
+    # Initializes the HTTP client for VWOBuilder
+    def init_client
+      Utils::Request.set_base_url(@options[:gateway_service_url] || Constants::HTTPS_PROTOCOL + Constants::BASE_URL)
+    end
+  end
+end

data/lib/vwo/vwo_client.rb

@@ -0,0 +1,142 @@
+# 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 'json'
+require_relative 'utils/logger_helper'
+require_relative 'constants'
+require_relative 'utils/request'
+require_relative 'utils/feature_flag_response'
+
+module VWO
+  # VWOClient class provides methods to interact with the VWO feature flag system,
+  # including retrieving feature flags, tracking events, and setting attributes.
+  class VWOClient
+    # Makes the `options` instance variable private and only accessible within the class.
+    private attr_reader :options
+
+    # Initializes a new instance of the VWOClient.
+    #
+    # @param [Hash] options Configuration options like account_id and sdk_key.
+    def initialize(options)
+      @options = options
+    end
+
+    # Fetches a feature flag for a given feature_key and context.
+    #
+    # @param [String] feature_key The unique identifier for the feature flag.
+    # @param [Hash] context The context data, which must include a `:id` for user identification.
+    #
+    # @return [FeatureFlagResponse] Returns a FeatureFlagResponse with the status of the feature flag and any associated variables.
+    #         Returns `isEnabled: false` and empty variables if any error occurs.
+    #
+    # @raise [StandardError] Raises an error if `feature_key`, `context`, or `userId` are missing or invalid.
+    def get_flag(feature_key, context)
+      # Raise an error if the SDK is not initialized with options.
+      raise 'VWO is not initialized' if @options.nil?
+
+      # Validate that feature_key and context are present, and userId is in context.
+      raise 'feature_key is required to get the feature flag' if feature_key.nil? || feature_key.empty?
+      raise 'context is required to get the feature flag' if context.nil?
+      raise 'userId is required for flag evaluation, please provide id in context' if context[:id].nil? || context[:id].empty?
+
+      # Add the feature key to the context.
+      context['featureKey'] = feature_key
+
+      # Construct the API endpoint for getting the feature flag.
+      endpoint = "#{Constants::ENDPOINT_GET_FLAG}?accountId=#{@options[:account_id]}&sdkKey=#{@options[:sdk_key]}"
+
+      # Send a POST request to retrieve the feature flag.
+      response = Utils::Request.send_post_request(endpoint, context)
+
+      # If a response is received, parse it and return a FeatureFlagResponse.
+      if response
+        parsed_response = JSON.parse(response)
+        return FeatureFlagResponse.new(parsed_response['isEnabled'], parsed_response['variables'])
+      else
+        # Return a default disabled response if no response was received.
+        return FeatureFlagResponse.new(false, [])
+      end
+    rescue StandardError => e
+      # Log the error and return a default FeatureFlagResponse with `isEnabled: false`.
+      LoggerHelper.logger.error("Error in get_flag: #{e.message}")
+      return FeatureFlagResponse.new(false, [])
+    end
+
+    # Tracks an event for a given event_name and context.
+    #
+    # @param [String] event_name The name of the event to track.
+    # @param [Hash] context The context data, which must include a `:id` for user identification.
+    # @param [Hash] event_properties Optional properties related to the event.
+    #
+    # @return [String, nil] The response from the server, or nil if an error occurred.
+    #
+    # @raise [StandardError] Raises an error if `event_name`, `context`, or `userId` are missing or invalid.
+    def track_event(event_name, context, event_properties = {})
+      # Raise an error if the SDK is not initialized with options.
+      raise 'VWO is not initialized' if @options.nil?
+
+      # Validate that event_name and userId in context are present.
+      raise 'event_name is required to track the event' if event_name.nil? || event_name.empty?
+      raise 'userId is required to track the event, please provide id in context' if context.nil? || context[:id].nil? || context[:id].empty?
+
+      # Add event details to the context.
+      context['eventName'] = event_name
+      context['eventProperties'] = event_properties
+
+      # Construct the API endpoint for tracking the event.
+      endpoint = "#{Constants::ENDPOINT_TRACK_EVENT}?accountId=#{@options[:account_id]}&sdkKey=#{@options[:sdk_key]}"
+
+      # Send a POST request to track the event.
+      response = Utils::Request.send_post_request(endpoint, context)
+
+      # Return the server response.
+      response
+    rescue StandardError => e
+      # Log the error if any occurs during event tracking.
+      LoggerHelper.logger.error("Error tracking event: #{e.message}")
+    end
+
+    # Sets an attribute for a given user context.
+    #
+    # @param [String] attribute_key The key of the attribute to set.
+    # @param [String] attribute_value The value of the attribute to set.
+    # @param [Hash] context The context data, which must include a `:id` for user identification.
+    #
+    # @return [String, nil] The response from the server, or nil if an error occurred.
+    #
+    # @raise [StandardError] Raises an error if `attribute_key`, `attribute_value`, or `userId` are missing or invalid.
+    def set_attribute(attribute_key, attribute_value, context)
+      # Raise an error if the SDK is not initialized with options.
+      raise 'VWO is not initialized' if @options.nil?
+
+      # Validate that attribute_key, attribute_value, and userId in context are present.
+      raise 'attribute_key is required for set_attribute' if attribute_key.nil? || attribute_key.empty?
+      raise 'attribute_value is required for set_attribute' if attribute_value.nil?
+      raise 'userId is required to set attribute, please provide id in context' if context.nil? || context[:id].nil? || context[:id].empty?
+
+      # Add the attribute details to the context.
+      context['attributeKey'] = attribute_key
+      context['attributeValue'] = attribute_value
+
+      # Construct the API endpoint for setting the attribute.
+      endpoint = "#{Constants::ENDPOINT_SET_ATTRIBUTE}?accountId=#{@options[:account_id]}&sdkKey=#{@options[:sdk_key]}"
+
+      # Send a POST request to set the attribute.
+      Utils::Request.send_post_request(endpoint, context)
+    rescue StandardError => e
+      # Log the error if any occurs during setting the attribute.
+      LoggerHelper.logger.error("Error setting attribute: #{e.message}")
+    end
+  end
+end

data/lib/vwo.rb

@@ -0,0 +1,56 @@
+# 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_relative 'vwo/utils/logger_helper'
+require_relative 'vwo/vwo_client'
+require_relative 'vwo/vwo_builder'
+require_relative 'vwo/constants'
+require_relative 'vwo/utils/request'
+
+# The main VWO module
+module VWO
+  # Class-level variable to hold the VWO client instance
+  @@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)
+  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)
+  end
+
+  # Get the singleton instance of VWO
+  def self.instance
+    @@instance
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: vwo-fme-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- VWO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  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: A Ruby SDK for Feature Management And Experimentation
+email:
+- dev@wingify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/vwo_builder.rb
+- lib/vwo/vwo_client.rb
+homepage: 
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/wingify/vwo-fme-ruby-sdk/issues
+  changelog_uri: https://github.com/wingify/vwo-fme-ruby-sdk/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/wingify/vwo-fme-ruby-sdk
+  source_code_uri: https://github.com/wingify/vwo-fme-ruby-sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+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: VWO FME Ruby SDK
+test_files: []