splitclient-rb 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d77194aa317ca92f5fb7850a54763bc1f175781c
-  data.tar.gz: 13dec41a00e619c4773a228201959bc6df8b159f
+  metadata.gz: 81550066a81a8d86d50b4cea93346252fd3e19f6
+  data.tar.gz: 004ebf8003e161eef3712c4ba68350a732f113d8
 SHA512:
-  metadata.gz: '0851d8db28125840f18669eb1f300103bcad670a41e76bdbe2254d27676ffc32a82dc440aee3de08fd5a6e734d2256284a6f484181f20eb90e1e9b4fa73df0ca'
-  data.tar.gz: 28ae6c46f3ccd7a17f6c83b6f42f59afe39fa258713df80b26c94543acb0386dfa8097fd792f316241d4786830f51b74a90faa8bafe287b3f71c88f2c9adfe8f
+  metadata.gz: bc9efa8080b148c9513ada659f842543ed1672e42cd64c1085c1c8a162e31553930509ca43e30a8b12a1ee9c5c434b5ac4347318bdd3cbb15e707071b45d368b
+  data.tar.gz: 43cfabd292ae2579e976508bc133894c697978f9cd03cc1c344ac1e48670f51b9cf77888e8db99ce1c8b3eb0f6b31061ddb577b550822d6a5905e74a194a6b23

data/CHANGES.txt

@@ -1,5 +1,13 @@
+4.2.0 (July 18, 2017)
+- Add new boolean/regexp matchers
+- Add support for split dependency on other splits
+- Pass bucketing_key to `match?` method
+- Fix IP address fetching
+- Remove unneeded dependencies (faraday_middleware, faraday-http-cache)
+
 4.1.0 (April 16, 2017)
 - Add new string/set matchers
+- Use Rails logger if available. Now we do not pollute STDOUT by default
 
 4.0.0
 - Add support for murmur3 algo

data/NEWS

@@ -1,3 +1,9 @@
+4.2.0
+
+Introduce new matchers: boolean and regexp (string).
+Remove unneeded dependencies
+Introduce dependency matcher, which allows treatment of one split to depend on the evaluation of another.
+
 4.1.0
 
 Introduce set matchers: part of set, contains all and contains any, starts with, ends with and contains.

data/README.md

@@ -4,7 +4,7 @@ This SDK is designed to work with [Split](https://www.split.io), the platform fo
 
 ### Quick setup
 
-For specific instructions on how to set up the Ruby SDK refer to our [Detailed-README](Detailed-README.md) or our [official SDK documentation](http://docs.split.io/docs/sdk-overview).
+For specific instructions on how to set up the Split SDK refer to our [official SDK documentation](http://docs.split.io/docs/sdk-overview).
 
 ### Commitment to Quality:
 
@@ -12,21 +12,11 @@ Split’s SDKs are in active development and are constantly tested for quality.
 
 ### About Split:
 
-Split builds on feature flags to create the platform for controlled rollouts, so any team can target customers and release or revert new features without a deployment—or touching code. Get started quickly with SDKs in your language, then create on/off, percentage, and multivariate rollout plans in seconds. Integrations with the services you use to monitor, alert and track issues reduce time-to-resolution when things go wrong, and hotfixes are entirely avoided by killing problem features with a single click.
-
- * What you can do with Split. Split goes beyond the simple on/off capabilities of basic feature flagging to give your team the power to:
-
- 	* Create multivariate feature releases
-	* Create A/B feature releases
-	* Kill any feature, over the browser, with a single click
-	* Target releases to subsets of your audience, including percentage roll outs, whitelists,    attribute-based targeting, and individual user IDs 
-	* Integrate with the services your team uses to monitor, plan and communicate, like Datadog, JIRA and Slack 
-	* Manage team access, with features like two-factor authentication and role-based permissioning.
-
+Split is the leading platform for intelligent software delivery, helping businesses of all sizes deliver exceptional user experiences, and mitigate risk, by providing an easy, secure way to target features to customers. Companies like WePay, LendingTree and thredUP rely on Split to safely launch and test new features and derive insights on their use. Founded in 2015, Split's team comes from some of the most innovative enterprises in Silicon Valley, including Google, LinkedIn, Salesforce and Splunk. Split is based in Redwood City, California and backed by Accel Partners and Lightspeed Venture Partners. To learn more about Split, contact hello@split.io, or start a 14-day free trial at www.split.io/trial.
 
 Split has built and maintains a SDKs for:
 
-* Java [Docs](http://docs.split.io/docs/java-sdk-guide)
+* Java [Github](https://github.com/splitio/java-client) [Docs](http://docs.split.io/docs/java-sdk-guide)
 * Javascript [Github](https://github.com/splitio/javascript-client) [Docs](http://docs.split.io/docs/javascript-sdk-overview)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](http://docs.split.io/docs/nodejs-sdk-overview)
 * .NET [Github](https://github.com/splitio/.net-client) [Docs](http://docs.split.io/docs/net-sdk-overview)
@@ -34,11 +24,11 @@ Split has built and maintains a SDKs for:
 * PHP [Github](https://github.com/splitio/php-client) [Docs](http://docs.split.io/docs/php-sdk-overview)
 * Python [Github](https://github.com/splitio/python-client) [Docs](http://docs.split.io/docs/python-sdk-overview)
 
-For a comprenhensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
+For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 
 **Try Split for Free:**
 
-Split is available as a 30-day free trial. To create an account, visit [split.io/trial](https://www.split.io/trial).
+Split is available as a 14-day free trial. To create an account, visit [split.io/trial](https://www.split.io/trial).
 
 **Learn more about Split:** 
 
@@ -47,6 +37,3 @@ Visit [split.io/product](https://www.split.io/product) for an overview of Split,
 **System Status:**
 
 We use a status page to monitor the availability of Split’s various services. You can check the current status at [status.split.io](http://status.split.io).
-
-----
-

data/lib/splitclient-rb.rb

@@ -1,25 +1,25 @@
 require 'splitclient-rb/version'
 
-require 'exceptions/sdk_blocker_timeout_expired_exception'
-require 'cache/adapters/memory_adapters/map_adapter'
-require 'cache/adapters/memory_adapters/queue_adapter'
-require 'cache/adapters/memory_adapter'
-require 'cache/adapters/redis_adapter'
-require 'cache/repositories/repository'
-require 'cache/repositories/segments_repository'
-require 'cache/repositories/splits_repository'
-require 'cache/repositories/impressions_repository'
-require 'cache/repositories/impressions/memory_repository'
-require 'cache/repositories/impressions/redis_repository'
-require 'cache/repositories/metrics_repository'
-require 'cache/repositories/metrics/memory_repository'
-require 'cache/repositories/metrics/redis_repository'
-require 'cache/senders/impressions_formatter'
-require 'cache/senders/impressions_sender'
-require 'cache/senders/metrics_sender'
-require 'cache/stores/sdk_blocker'
-require 'cache/stores/segment_store'
-require 'cache/stores/split_store'
+require 'splitclient-rb/exceptions/sdk_blocker_timeout_expired_exception'
+require 'splitclient-rb/cache/adapters/memory_adapters/map_adapter'
+require 'splitclient-rb/cache/adapters/memory_adapters/queue_adapter'
+require 'splitclient-rb/cache/adapters/memory_adapter'
+require 'splitclient-rb/cache/adapters/redis_adapter'
+require 'splitclient-rb/cache/repositories/repository'
+require 'splitclient-rb/cache/repositories/segments_repository'
+require 'splitclient-rb/cache/repositories/splits_repository'
+require 'splitclient-rb/cache/repositories/impressions_repository'
+require 'splitclient-rb/cache/repositories/impressions/memory_repository'
+require 'splitclient-rb/cache/repositories/impressions/redis_repository'
+require 'splitclient-rb/cache/repositories/metrics_repository'
+require 'splitclient-rb/cache/repositories/metrics/memory_repository'
+require 'splitclient-rb/cache/repositories/metrics/redis_repository'
+require 'splitclient-rb/cache/senders/impressions_formatter'
+require 'splitclient-rb/cache/senders/impressions_sender'
+require 'splitclient-rb/cache/senders/metrics_sender'
+require 'splitclient-rb/cache/stores/sdk_blocker'
+require 'splitclient-rb/cache/stores/segment_store'
+require 'splitclient-rb/cache/stores/split_store'
 
 require 'splitclient-rb/localhost_utils'
 require 'splitclient-rb/clients/localhost_split_client'
@@ -31,37 +31,48 @@ require 'splitclient-rb/split_factory_builder'
 require 'splitclient-rb/localhost_split_factory'
 require 'splitclient-rb/split_config'
 
-require 'engine/api/client'
-require 'engine/api/impressions'
-require 'engine/api/metrics'
-require 'engine/api/segments'
-require 'engine/api/splits'
-require 'engine/parser/condition'
-require 'engine/parser/partition'
-require 'engine/parser/split_adapter'
-require 'engine/parser/split_treatment'
-require 'engine/partitions/treatments'
-require 'engine/matchers/combiners'
-require 'engine/matchers/combining_matcher'
-require 'engine/matchers/all_keys_matcher'
-require 'engine/matchers/negation_matcher'
-require 'engine/matchers/user_defined_segment_matcher'
-require 'engine/matchers/whitelist_matcher'
-require 'engine/matchers/equal_to_matcher'
-require 'engine/matchers/greater_than_or_equal_to_matcher'
-require 'engine/matchers/less_than_or_equal_to_matcher'
-require 'engine/matchers/between_matcher'
-require 'engine/matchers/set_matcher'
-require 'engine/matchers/part_of_set_matcher'
-require 'engine/matchers/equal_to_set_matcher'
-require 'engine/matchers/contains_any_matcher'
-require 'engine/matchers/contains_all_matcher'
-require 'engine/matchers/starts_with_matcher'
-require 'engine/matchers/ends_with_matcher'
-require 'engine/matchers/contains_matcher'
-require 'engine/evaluator/splitter'
-require 'engine/metrics/metrics'
-require 'engine/metrics/binary_search_latency_tracker'
-require 'engine/models/split'
-require 'engine/models/label'
-require 'splitclient-rb_utilitites'
+require 'splitclient-rb/engine/api/faraday_middleware/gzip'
+require 'splitclient-rb/engine/api/client'
+require 'splitclient-rb/engine/api/impressions'
+require 'splitclient-rb/engine/api/metrics'
+require 'splitclient-rb/engine/api/segments'
+require 'splitclient-rb/engine/api/splits'
+require 'splitclient-rb/engine/parser/condition'
+require 'splitclient-rb/engine/parser/partition'
+require 'splitclient-rb/engine/parser/split_adapter'
+require 'splitclient-rb/engine/parser/evaluator'
+require 'splitclient-rb/engine/matchers/combiners'
+require 'splitclient-rb/engine/matchers/combining_matcher'
+require 'splitclient-rb/engine/matchers/all_keys_matcher'
+require 'splitclient-rb/engine/matchers/negation_matcher'
+require 'splitclient-rb/engine/matchers/user_defined_segment_matcher'
+require 'splitclient-rb/engine/matchers/whitelist_matcher'
+require 'splitclient-rb/engine/matchers/equal_to_matcher'
+require 'splitclient-rb/engine/matchers/greater_than_or_equal_to_matcher'
+require 'splitclient-rb/engine/matchers/less_than_or_equal_to_matcher'
+require 'splitclient-rb/engine/matchers/between_matcher'
+require 'splitclient-rb/engine/matchers/set_matcher'
+require 'splitclient-rb/engine/matchers/part_of_set_matcher'
+require 'splitclient-rb/engine/matchers/equal_to_set_matcher'
+require 'splitclient-rb/engine/matchers/contains_any_matcher'
+require 'splitclient-rb/engine/matchers/contains_all_matcher'
+require 'splitclient-rb/engine/matchers/starts_with_matcher'
+require 'splitclient-rb/engine/matchers/ends_with_matcher'
+require 'splitclient-rb/engine/matchers/contains_matcher'
+require 'splitclient-rb/engine/matchers/dependency_matcher'
+require 'splitclient-rb/engine/matchers/equal_to_boolean_matcher'
+require 'splitclient-rb/engine/matchers/equal_to_matcher'
+require 'splitclient-rb/engine/matchers/matches_string_matcher'
+require 'splitclient-rb/engine/evaluator/splitter'
+require 'splitclient-rb/engine/metrics/metrics'
+require 'splitclient-rb/engine/metrics/binary_search_latency_tracker'
+require 'splitclient-rb/engine/models/split'
+require 'splitclient-rb/engine/models/label'
+require 'splitclient-rb/engine/models/treatment'
+require 'splitclient-rb/utilitites'
+
+module SplitIoClient
+  def self.root
+    File.dirname(__dir__)
+  end
+end

data/lib/{cache → splitclient-rb/cache}/senders/impressions_sender.rb

@@ -37,7 +37,7 @@ module SplitIoClient
             loop do
               post_impressions
 
-              sleep(::Utilities.randomize_interval(@config.impressions_refresh_rate))
+              sleep(SplitIoClient::Utilities.randomize_interval(@config.impressions_refresh_rate))
             end
           end
         end

data/lib/{cache → splitclient-rb/cache}/senders/metrics_sender.rb

@@ -29,7 +29,7 @@ module SplitIoClient
             loop do
               post_metrics
 
-              sleep(::Utilities.randomize_interval(@config.metrics_refresh_rate))
+              sleep(SplitIoClient::Utilities.randomize_interval(@config.metrics_refresh_rate))
             end
           end
         end

data/lib/splitclient-rb/clients/localhost_split_client.rb

@@ -44,12 +44,12 @@ module SplitIoClient
     def get_treatment(id, feature, attributes = nil)
       unless id
         @config.logger.warn('id was null for feature: ' + feature)
-        return Treatments::CONTROL
+        return SplitIoClient::Engine::Models::Treatment::CONTROL
       end
 
       unless feature
         @config.logger.warn('feature was null for id: ' + id)
-        return Treatments::CONTROL
+        return SplitIoClient::Engine::Models::Treatment::CONTROL
       end
 
       result = get_localhost_treatment(feature)
@@ -83,7 +83,7 @@ module SplitIoClient
     def get_localhost_treatment(feature)
       treatment = @localhost_mode_features.select { |h| h[:feature] == feature }.last || {}
 
-      treatment[:treatment] || Treatments::CONTROL
+      treatment[:treatment] || SplitIoClient::Engine::Models::Treatment::CONTROL
     end
   end
 end

data/lib/splitclient-rb/clients/split_client.rb

@@ -19,14 +19,17 @@ module SplitIoClient
 
     def get_treatments(key, split_names, attributes = nil)
       bucketing_key, matching_key = keys_from_key(key)
+      evaluator = Engine::Parser::Evaluator.new(@segments_repository, @splits_repository, true)
 
       treatments_labels_change_numbers =
         @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
-          memo.merge!(name => get_treatment(key, name, attributes, data, false, true))
+          memo.merge!(name => get_treatment(key, name, attributes, data, false, true, evaluator))
         end
 
       if @config.impressions_queue_size > 0
-        @impressions_repository.add_bulk(matching_key, bucketing_key, treatments_labels_change_numbers, (Time.now.to_f * 1000.0).to_i)
+        @impressions_repository.add_bulk(
+          matching_key, bucketing_key, treatments_labels_change_numbers, (Time.now.to_f * 1000.0).to_i
+        )
       end
 
       split_names = treatments_labels_change_numbers.keys
@@ -44,32 +47,38 @@ module SplitIoClient
     # @param split_data [Hash] split data, when provided this method doesn't fetch splits_repository for the data
     # @param store_impressions [Boolean] impressions aren't stored if this flag is false
     # @param multiple [Hash] internal flag to signal if method is called by get_treatments
+    # @param evaluator [Evaluator] Evaluator class instance, used to cache treatments
     #
     # @return [String/Hash] Treatment as String or Hash of treatments in case of array of features
-    def get_treatment(key, split_name, attributes = nil, split_data = nil, store_impressions = true, multiple = false)
+    def get_treatment(
+        key, split_name, attributes = nil, split_data = nil, store_impressions = true,
+        multiple = false, evaluator = nil
+      )
       bucketing_key, matching_key = keys_from_key(key)
+      treatment_data = { label: Engine::Models::Label::EXCEPTION, treatment: SplitIoClient::Engine::Models::Treatment::CONTROL }
+      evaluator ||= Engine::Parser::Evaluator.new(@segments_repository, @splits_repository)
 
       if matching_key.nil?
         @config.logger.warn('matching_key was null for split_name: ' + split_name.to_s)
-        return parsed_treatment(multiple, { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL })
+        return parsed_treatment(multiple, treatment_data)
       end
 
       if split_name.nil?
         @config.logger.warn('split_name was null for key: ' + key)
-        return parsed_treatment(multiple, { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL })
+        return parsed_treatment(multiple, treatment_data)
       end
 
       start = Time.now
-      treatment_label_change_number = { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL }
 
       begin
         split = multiple ? split_data : @splits_repository.get_split(split_name)
 
         if split.nil?
           @config.logger.debug("split_name: #{split_name} does not exist. Returning CONTROL")
-          return parsed_treatment(multiple, treatment_label_change_number)
+          return parsed_treatment(multiple, treatment_data)
         else
-          treatment_label_change_number = SplitIoClient::Engine::Parser::SplitTreatment.new(@segments_repository).call(
+          treatment_data =
+            evaluator.call(
             { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
           )
         end
@@ -78,17 +87,17 @@ module SplitIoClient
 
         store_impression(
           split_name, matching_key, bucketing_key,
-          { treatment: SplitIoClient::Treatments::CONTROL, label: Engine::Models::Label::EXCEPTION },
+          { treatment: SplitIoClient::Engine::Models::Treatment::CONTROL, label: Engine::Models::Label::EXCEPTION },
           store_impressions
         )
 
-        return parsed_treatment(multiple, treatment_label_change_number)
+        return parsed_treatment(multiple, treatment_data)
       end
 
       begin
         latency = (Time.now - start) * 1000.0
         # Disable impressions if @config.impressions_queue_size == -1
-        split && store_impression(split_name, matching_key, bucketing_key, treatment_label_change_number, store_impressions)
+        split && store_impression(split_name, matching_key, bucketing_key, treatment_data, store_impressions)
 
         # Measure
         @adapter.metrics.time('sdk.get_treatment', latency)
@@ -97,14 +106,14 @@ module SplitIoClient
 
         store_impression(
           split_name, matching_key, bucketing_key,
-          { treatment: SplitIoClient::Treatments::CONTROL, label: Engine::Models::Label::EXCEPTION },
+          { treatment: SplitIoClient::Engine::Models::Treatment::CONTROL, label: Engine::Models::Label::EXCEPTION },
           store_impressions
         )
 
-        return parsed_treatment(multiple, treatment_label_change_number)
+        return parsed_treatment(multiple, treatment_data)
       end
 
-      parsed_treatment(multiple, treatment_label_change_number)
+      parsed_treatment(multiple, treatment_data)
     end
 
     def store_impression(split_name, matching_key, bucketing_key, treatment, store_impressions)
@@ -129,22 +138,16 @@ module SplitIoClient
       end
     end
 
-    def parsed_treatment(multiple, treatment_label_change_number)
+    def parsed_treatment(multiple, treatment_data)
       if multiple
         {
-          treatment: treatment_label_change_number[:treatment],
-          label: treatment_label_change_number[:label],
-          change_number: treatment_label_change_number[:change_number]
+          treatment: treatment_data[:treatment],
+          label: treatment_data[:label],
+          change_number: treatment_data[:change_number]
         }
       else
-        treatment_label_change_number[:treatment]
+        treatment_data[:treatment]
       end
     end
-
-    private
-
-    def split_treatment
-      @split_treatment ||= SplitIoClient::Engine::Parser::SplitTreatment.new(@segments_repository)
-    end
   end
 end

data/lib/{engine → splitclient-rb/engine}/api/client.rb

@@ -1,10 +1,10 @@
-require 'faraday/http_cache'
-require 'bundler/vendor/net/http/persistent' unless defined?(Net::HTTP)
-require 'faraday_middleware'
+require 'net/http/persistent'
 
 module SplitIoClient
   module Api
     class Client
+      RUBY_ENCODING = '1.9'.respond_to?(:force_encoding)
+
       def get_api(url, config, api_key, params = {})
         api_client.get(url, params) do |req|
           req.headers = common_headers(api_key, config).merge('Accept-Encoding' => 'gzip')
@@ -47,7 +47,7 @@ module SplitIoClient
 
       def api_client
         @api_client ||= Faraday.new do |builder|
-          builder.use FaradayMiddleware::Gzip
+          builder.use SplitIoClient::FaradayMiddleware::Gzip
           builder.adapter :net_http_persistent
         end
       end