kameleoon-client-ruby 1.0.9 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887e6709dff33fa410a8e34a32577d8ad1ffe56fa52cadd24bd1734c68d2e46b
-  data.tar.gz: e42d4d944e8c1549eae488f74e7b5c8891bf41f35dcce02133bfc68cee969463
+  metadata.gz: 3e62c8e4dfa35f91706257ff5367a266736af7c03786803ad8f9fff06aa8c194
+  data.tar.gz: 7773e082be938108b42c65cd0109392413bf938619cf04cc994617111c746f15
 SHA512:
-  metadata.gz: 3cf8ee8561091145b530082e2ce86614b41f9c63c70b644518c5a9d3738e659084526003ad298cdf320da0570cc7d55b551b3b80e680877a1c4c0bd984bc1b9f
-  data.tar.gz: 4c9e4873467d1f2578be20f8246a47ad3810401251fb9e3dd34d3baad073184c6083fa0a35893c95e308a3482ebb3b42d58e1fd8e82c9400fa554ebbd1e16d63
+  metadata.gz: d74b03762402a1f4c6e7349bb085e3b185ee564f0a7f645a16f7bb8da0321b73689adad785d52bdce48e9a0646f6b10de6c3f2fc8016b9459b713eafbda77e6f
+  data.tar.gz: a835f8b23265a2ae8241114fb2c5fe1f8965544fb348c2f6c16d714fe543fa6396b5bc6cbf7f68d8ac5e5391b8cbf594f55086e8c24290fda57a7b18ac5f57c4

data/lib/kameleoon/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kameleoon/targeting/models'
 require 'kameleoon/request'
 require 'kameleoon/exceptions'
@@ -7,6 +9,8 @@ require 'rufus/scheduler'
 require 'yaml'
 require 'json'
 require 'em-synchrony'
+require 'em-synchrony/em-http'
+require 'em-synchrony/fiber_iterator'
 require 'objspace'
 require 'time'
 
@@ -27,11 +31,14 @@ module Kameleoon
       @site_code = site_code
       @blocking = blocking
       @default_timeout = config['default_timeout'] || default_timeout # in ms
-      @interval = config['actions_configuration_refresh_interval'].to_s + 'm' || interval
+      refresh_interval = config['actions_configuration_refresh_interval']
+      @interval = refresh_interval.nil? ? interval : "#{refresh_interval}m"
       @tracking_url = config['tracking_url'] || "https://api-ssx.kameleoon.com"
+      @api_data_url = "https://api-data.kameleoon.com"
       @client_id = client_id || config['client_id']
       @client_secret = client_secret || config['client_secret']
       @data_maximum_size = config['visitor_data_maximum_size'] || 500 # mb
+      @environment = config['environment'] || DEFAULT_ENVIRONMENT
       @verbose_mode = config['verbose_mode'] || false
       @experiments = []
       @feature_flags = []
@@ -119,6 +126,7 @@ module Kameleoon
         end
         variation_id.to_i
       else
+        check_site_code_enable(experiment)
         visitor_data = @data.select { |key, value| key.to_s == visitor_code }.values.flatten! || []
         if experiment['targetingSegment'].nil? || experiment['targetingSegment'].check_tree(visitor_data)
           threshold = obtain_hash_double(visitor_code, experiment['respoolTime'], experiment['id'])
@@ -262,6 +270,7 @@ module Kameleoon
         result.to_s != "null"
 
       else
+        check_site_code_enable(feature_flag)
         visitor_data = @data.select { |key, value| key.to_s == visitor_code }.values.flatten! || []
         unless feature_flag['targetingSegment'].nil? || feature_flag['targetingSegment'].check_tree(visitor_data)
           raise Exception::NotTargeted.new(visitor_code)
@@ -269,7 +278,7 @@ module Kameleoon
 
         if is_feature_flag_scheduled(feature_flag, Time.now.to_i)
           threshold = obtain_hash_double(visitor_code, {}, id)
-          if threshold <= feature_flag['expositionRate']
+          if threshold >= 1 - feature_flag['expositionRate']
             track_experiment(visitor_code, id, feature_flag["variations"].first['id'])
             true
           else
@@ -288,7 +297,7 @@ module Kameleoon
     # A feature variable can be changed easily via our web application.
     #
     # @param [String | Integer] feature_key
-    # @param [String ] variable_key
+    # @param [String] variable_key
     #
     # @raise [Kameleoon::Exception::FeatureConfigurationNotFound]
     # @raise [Kameleoon::Exception::FeatureVariableNotFound]
@@ -313,22 +322,48 @@ module Kameleoon
       end
     end
 
+    ##
+    # The retrieved_data_from_remote_source method allows you to retrieve data (according to a key passed as argument) 
+    # stored on a remote Kameleoon server. Usually data will be stored on our remote servers via the use of our Data API. 
+    # This method, along with the availability of our highly scalable servers for this purpose, provides a convenient way
+    # to quickly store massive amounts of data that can be later retrieved for each of your visitors / users.
+    #
+    # @param [String] key Key you want to retrieve data. This field is mandatory.
+    # @param [Int] timeout Timeout for request. Equals default_timeout in a config file. This field is optional.
+    #
+    # @return [Hash] Hash object of the json object.
+    #
+    #
+    def retrieve_data_from_remote_source(key, timeout = @default_timeout)
+      connexion_options = { connect_timeout: (timeout.to_f / 1000.0) }
+      path = get_api_data_request_url(key)
+      log "Retrieve API Data connexion: #{connexion_options.inspect}"
+      response = get_sync(@api_data_url + path, connexion_options)
+      if is_successful_sync(response)
+        JSON.parse(response.body) unless response.nil?
+      else
+        return nil
+      end
+    end
+
     private
-    API_SSX_URL = "https://api-ssx.kameleoon.com"
+
+    API_SSX_URL = 'https://api-ssx.kameleoon.com'
     REFERENCE = 0
-    STATUS_ACTIVE = "ACTIVE"
-    FEATURE_STATUS_DEACTIVATED = "DEACTIVATED"
+    STATUS_ACTIVE = 'ACTIVE'
+    FEATURE_STATUS_DEACTIVATED = 'DEACTIVATED'
+    DEFAULT_ENVIRONMENT = 'production'
     attr :site_code, :client_id, :client_secret, :access_token, :experiments, :feature_flags, :scheduler, :data,
          :blocking, :tracking_url, :default_timeout, :interval, :memory_limit, :verbose_mode
 
     def fetch_configuration
       @scheduler = Rufus::Scheduler.singleton
       @scheduler.every @interval do
-        log("Scheduled job to fetch configuration is starting.")
+        log('Scheduled job to fetch configuration is starting.')
         fetch_configuration_job_graphql
       end
       @scheduler.schedule '0s' do
-        log("Start-up, fetching is starting")
+        log('Start-up, fetching is starting')
         fetch_configuration_job_graphql
       end
     end
@@ -337,7 +372,7 @@ module Kameleoon
       EM.synchrony do
         obtain_access_token
         @experiments = obtain_experiments_graphql(@site_code) || @experiments
-        @feature_flags = obtain_feature_flags_graphql(@site_code) || @feature_flags
+        @feature_flags = obtain_feature_flags_graphql(@site_code, @environment) || @feature_flags
         EM.stop
       end
     end
@@ -479,9 +514,9 @@ module Kameleoon
       experiments
     end
 
-    def obtain_feature_flags_graphql(site_id, per_page = -1)
+    def obtain_feature_flags_graphql(site_id, environment = @environment, per_page = -1)
       log "Fetching feature flags GraphQL"
-      feature_flags = fetch_all_graphql("v1/graphql?perPage=#{per_page}", Kameleoon::Query.query_feature_flags(site_code)).map { |it| JSON.parse(it.response)['data']['featureFlags']['edges'] }.flatten.map do |feature_flag|
+      feature_flags = fetch_all_graphql("v1/graphql?perPage=#{per_page}", Kameleoon::Query.query_feature_flags(site_code, environment)).map { |it| JSON.parse(it.response)['data']['featureFlags']['edges'] }.flatten.map do |feature_flag|
           complete_campaign_graphql(feature_flag['node'])
       end
       log "Feature flags are fetched: " + feature_flags.inspect
@@ -575,11 +610,21 @@ module Kameleoon
       "/dataTracking?" + URI.encode_www_form(get_common_ssx_parameters(visitor_code))
     end
 
+    def get_api_data_request_url(key)
+      mapKey = {
+        siteCode: site_code,
+        key: key
+      }
+      "/data?#{URI.encode_www_form(mapKey)}"
+    end
+
     def get_feature_flag(feature_key)
       if feature_key.is_a?(String)
         feature_flag = @feature_flags.select { |ff| ff['identificationKey'] == feature_key}.first
       elsif feature_key.is_a?(Integer)
         feature_flag = @feature_flags.select { |ff| ff['id'].to_i == feature_key}.first
+        print "\nPassing `feature_key` with type of `int` to `activate_feature` or `obtain_feature_variable` "\
+        "is deprecated, it will be removed in next releases. This is necessary to support multi-environment feature\n"
       else
         raise TypeError.new("Feature key should be a String or an Integer.")
       end
@@ -671,6 +716,12 @@ module Kameleoon
       end
     end
 
+    def check_site_code_enable(exp_or_ff)
+      unless exp_or_ff['site'].nil? || exp_or_ff['site']['isKameleoonEnabled']
+        raise Exception::SiteCodeDisabled.new(site_code)
+      end
+    end
+
     def data_not_sent(visitor_code = nil)
       if visitor_code.nil?
         @data.select {|key, values| values.any? {|data| !data.sent}}

data/lib/kameleoon/exceptions.rb

@@ -50,5 +50,10 @@ module Kameleoon
         super("Visitor code not valid: " + message)
       end
     end
+    class SiteCodeDisabled < KameleoonError
+      def initialize(message = "")
+        super("Site with siteCode '" + message + "' is disabled")
+      end
+    end
   end
 end

data/lib/kameleoon/query_graphql.rb

@@ -4,7 +4,7 @@ module Kameleoon
     def self.query_experiments(site_code)
       '{
           "operationName": "getExperiments",
-          "query": "query getExperiments($first: Int, $after: String, $filter: FilteringExpression, $sort: [SortingParameter!]) { experiments(first: $first, after: $after, filter: $filter, sort: $sort) { edges { node { id name type site { id code } status variations { id customJson } deviations { variationId value } respoolTime {variationId value } segment { id name conditionsData { firstLevelOrOperators firstLevel { orOperators conditions { targetingType isInclude ... on CustomDataTargetingCondition { customDataIndex value valueMatchType } } } } } __typename } __typename } pageInfo { endCursor hasNextPage __typename } totalCount __typename } }",
+          "query": "query getExperiments($first: Int, $after: String, $filter: FilteringExpression, $sort: [SortingParameter!]) { experiments(first: $first, after: $after, filter: $filter, sort: $sort) { edges { node { id name type site { id code isKameleoonEnabled } status variations { id customJson } deviations { variationId value } respoolTime {variationId value } segment { id name conditionsData { firstLevelOrOperators firstLevel { orOperators conditions { targetingType isInclude ... on CustomDataTargetingCondition { customDataIndex value valueMatchType } } } } } __typename } __typename } pageInfo { endCursor hasNextPage __typename } totalCount __typename } }",
           "variables": {
               "filter": {
                   "and": [{
@@ -13,13 +13,15 @@ module Kameleoon
                           "operator": "IN",
                           "parameters": ["ACTIVE", "DEVIATED", "USED_AS_PERSONALIZATION"]
                       }
-                  }, {
+                  }, 
+                  {
                       "condition": {
                           "field": "type",
                           "operator": "IN",
                           "parameters": ["SERVER_SIDE", "HYBRID"]
                       }
-                  }, {
+                  }, 
+                  {
                       "condition": {
                           "field": "siteCode",
                           "operator": "IN",
@@ -35,10 +37,10 @@ module Kameleoon
       }'
     end
     
-    def self.query_feature_flags(site_code)
+    def self.query_feature_flags(site_code, environment)
       '{
           "operationName": "getFeatureFlags",
-          "query": "query getFeatureFlags($first: Int, $after: String, $filter: FilteringExpression, $sort: [SortingParameter!]) { featureFlags(first: $first, after: $after, filter: $filter, sort: $sort) { edges { node { id name site { id code } bypassDeviation status variations { id customJson } respoolTime { variationId value } expositionRate identificationKey featureFlagSdkLanguageType featureStatus schedules { dateStart dateEnd } segment { id name conditionsData { firstLevelOrOperators firstLevel { orOperators conditions { targetingType isInclude ... on CustomDataTargetingCondition { customDataIndex value valueMatchType } } } } } __typename } __typename } pageInfo { endCursor hasNextPage __typename } totalCount __typename } }",
+          "query": "query getFeatureFlags($first: Int, $after: String, $filter: FilteringExpression, $sort: [SortingParameter!]) { featureFlags(first: $first, after: $after, filter: $filter, sort: $sort) { edges { node { id name site { id code isKameleoonEnabled } bypassDeviation status variations { id customJson } respoolTime { variationId value } expositionRate identificationKey featureFlagSdkLanguageType featureStatus schedules { dateStart dateEnd } segment { id name conditionsData { firstLevelOrOperators firstLevel { orOperators conditions { targetingType isInclude ... on CustomDataTargetingCondition { customDataIndex value valueMatchType } } } } } __typename } __typename } pageInfo { endCursor hasNextPage __typename } totalCount __typename } }",
           "variables": {
               "filter": {
                   "and": [{
@@ -47,13 +49,21 @@ module Kameleoon
                           "operator": "IN",
                           "parameters": ["ACTIVATED", "SCHEDULED", "DEACTIVATED"]
                       }
-                  }, {
+                  }, 
+                  {
                       "condition": {
                           "field": "siteCode",
                           "operator": "IN",
                           "parameters": ["' + site_code + '"]
                       }
-                  }]
+                  }, 
+                  {
+                    "condition": {
+                        "field": "environment.key",
+                        "operator": "IN",
+                        "parameters": ["' + environment + '"]
+                    }
+                }]
               },
               "sort": [{
                   "field": "id",

data/lib/kameleoon/request.rb

@@ -1,5 +1,6 @@
 require "em-synchrony/em-http"
 require "kameleoon/version"
+require 'net/http'
 
 module Kameleoon
   # @api private
@@ -20,6 +21,10 @@ module Kameleoon
       request(Method::POST, request_options, url, connexion_options)
     end
 
+    def get_sync(url = API_URL, connexion_options = {})
+      request_sync(Method::GET, url, connexion_options)
+    end
+
     private
 
     def request(method, request_options, url, connexion_options)
@@ -29,7 +34,22 @@ module Kameleoon
         when Method::POST then
           return EventMachine::HttpRequest.new(url, connexion_options).apost request_options
         when Method::GET then
-          return EventMachine::HttpRequest.new(url, connexion_options).aget request_options
+          return EventMachine::HttpRequest.new(url, connexion_options).get request_options
+        else
+          print "Unknown request type"
+          return false
+      end
+    end
+
+    def request_sync(method, url, connexion_options)
+      request_options = {} if request_options.nil?
+      add_user_agent(request_options)
+      case method
+        when Method::GET then
+          uri = URI(url)
+          request = Net::HTTP.new(url)
+          response = Net::HTTP.get_response(uri)
+          response
         else
           print "Unknown request type"
           return false
@@ -40,6 +60,10 @@ module Kameleoon
       !request.nil? && request != false && /20\d/.match(request.response_header.status.to_s)
     end
 
+    def is_successful_sync(response)
+      !response.nil? && response != false && response.is_a?(Net::HTTPSuccess)
+    end
+
     def add_user_agent(request_options)
       if request_options[:head].nil?
         request_options[:head] = {'Kameleoon-Client' => 'sdk/ruby/' + Kameleoon::VERSION}

data/lib/kameleoon/targeting/conditions/custom_datum.rb

@@ -34,7 +34,7 @@ module Kameleoon
 
       def check(datas)
         is_targeted = false
-        custom_data = datas.select { |data| data.instance == DataType::CUSTOM && data.id == @index }.first
+        custom_data = datas.select { |data| data.instance == DataType::CUSTOM && data.id == @index }.last
         if custom_data.nil?
           is_targeted = (@operator == Operator::UNDEFINED.to_s)
         else

data/lib/kameleoon/version.rb

@@ -1,3 +1,3 @@
 module Kameleoon
-  VERSION = '1.0.9'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.1
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request