splitclient-rb 7.0.0.pre.rc3-java → 7.0.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5daeec48636b151d045e56802a5f9a13f7f260c
-  data.tar.gz: 5129f877e3bef50cdb447f9bb5d3faa3e53ae381
+  metadata.gz: 0113b5144ddaff19b0231dafd90e0ce6b6173a0e
+  data.tar.gz: 62c75ac933beef2d057e8abfe5d2ac3524143e10
 SHA512:
-  metadata.gz: 4618d8cf58aec9ec933c07a3aa3af3237a0bc38bde5a120ae7d2c69810f67d86e524529ed2ec040054b97cc3afdec76b5b98430cb34f417d74e10e9e693f36b6
-  data.tar.gz: 156b3ca7caafef03e7ad1e1c0b9cd4b06a5d5a2b38139a446352f26f85429d6a775b0e2869e41781518c0d5511693630bdd94a88796613d37e70055669e14fe4
+  metadata.gz: 9a24e1b12d51669a62d9406e27af33754dc0ac0a1ba4b3dd286d8db94ada7b46e86ee552fe2955966c984b9944d73348e30b5efe2090fd4bd5dc32cf39b8e9ce
+  data.tar.gz: 1a788402527b1795d82e04a085bc1d1b9b593bb052120f5ec688b801b45145726e80518741071f86a4b8522a5aced65bcc0970f893ead2df2fe2f18a895f8d1f

data/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+# Ruby SDK
+
+## What did you accomplish?
+
+
+## How to test new changes?
+
+
+## Extra Notes
+

data/.gitignore

@@ -52,3 +52,5 @@ dump.rdb
 
 # Ignore Appraisal gemfile.lock files
 /gemfiles/*.gemfile.lock
+
+release.sh

data/.travis.yml

@@ -6,6 +6,15 @@ rvm:
 services:
   - redis-server
 
+addons:
+  sonarqube: true
+
+git:
+  depth: false
+
 before_install:
   - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
   - gem install bundler -v '< 2'
+
+after_success:
+  - bash sonar-scanner.sh

data/CHANGES.txt

@@ -1,8 +1,24 @@
-7.0.0 (Aug 21, 2019)
+7.0.1 (Oct 31, 2019)
+ - Updated localhost mode so that parsing of test files results in JSON data for splits analogous to that returned by the Split backend.
+ - Updated localhost mode to parse the mock data into Split objects to keep differences in operation to a minimum.
+ - Removed specific spare code dealing with localhost operations.
+ - Removed the disable_impressions configuration param.
+ - Fixed an issue about Event properties were not sent to be.
+ - Added ip_addresses_enabled to enable/disable sending MachineName and MachineIP headers when data is posted to Split Servers.
+ - Fixed an issue about attributes in matchers.
+ - Fixed an issue about trying to access a nil property when sending telemetry metrics.
+
+7.0.0 (Aug 23, 2019)
+ - BREAKING CHANGE: block_until_ready is now a method in both split_client and split_manager that needs to be explicitly called. The block_until_ready parameter is now ignored if passed in the configuration, and defaults to 15s unless passed as a parameter of the block_until_ready method.
+ - Added warning to track calls when traffic type does not belong to an existing split (only issued in the online client and when SDK is ready).
+ - Added warning to the get_treatment's method family when split does not exist in the current environment (only issued by online client and when SDK is ready).
+ - Added warning to the split_manager's split method when split does not exist in the current environment (only issued by online client and when SDK is ready).
+ - Added ability to create multiple split_factory instances. Added factory counts and warnings.
+ - Added SDK not ready impressions label.
  - Changed the splits method implementation in the splits_repository to make use of get_splits, which outperforms the current implementation.
 
 6.4.1 (Jul 26, 2019)
- - Fixed an issue in the latency metrics format preventing the synchronizer from correctly picking them up (consumer mode only). Old keys will be deleted on SDK startup. 
+ - Fixed an issue in the latency metrics format preventing the synchronizer from correctly picking them up (consumer mode only). Old keys will be deleted on SDK startup.
 
 6.4.0 (Jul 05, 2019)
  - Added properties to track method.
@@ -171,34 +187,27 @@
 - Detach implementation for local factory and regular one.
 
 3.0.3
-
 - Fix nil ref in manager
 
 3.0.2
-
 - add ability to provide different bucketing/matching keys
 
 3.0.1
-
 - fix segments not deleting from the cache
 
 3.0.0
-
 - add new caching interface
 - add replaceable adapters to store cache in
 - add first cache adapter: MemoryAdapter
 - refactoring
 
 2.0.1
-
 - Supress warnings cause by Net::HTTP when it already exists.
 
 2.0.0
-
 - Add Factory for creation of Client and Manager interface.
 
 1.0.4
-
 - added support for AND combiner on conditions
 - added events_uri as config param which defines the metrics post url
 - updated metrics post default endpoint to be https://events.split.io/api/
@@ -214,10 +223,8 @@
 - added condition to return CONTROL on the deleted features
 
 1.0.1
-
 - .splits to .split for local env
 - isTreatment was removed from the API.
 
 1.0.0
-
 - Support multivariate treatment

data/CONTRIBUTORS-GUIDE.md

@@ -0,0 +1,49 @@
+# Contributing to the Split Ruby SDK
+ 
+Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
+ 
+## Development
+
+### Development process
+ 
+1. Fork the repository and create a topic branch from `development` branch. Please use a descriptive name for your branch.
+2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like "fix bug".
+3. Make sure to add tests for both positive and negative cases.
+4. Run the linter script of the project and fix any issues you find.
+5. Run the build script and make sure it runs with no errors.
+6. Run all tests and make sure there are no failures.
+7. `git push` your changes to GitHub within your topic branch.
+8. Open a Pull Request(PR) from your forked repo and into the `development` branch of the original repository.
+9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
+10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into `development`.
+11. Keep an eye out for any feedback or comments from Split's SDK team.
+
+### Building the SDK
+To install this gem dependencies onto your local machine, run `bundle exec rake install`.
+
+Then you can build the gem using `gem build splitclient-rb.gemspec` and install on your Ruby version with `gem install splitclient-rb-X.X.X.gem` (_the version number should match what you just built_).
+
+### Running tests
+The gem uses `rspec` for unit testing. You can find the files for the unit tests and the specs helper file (`spec_helper.rb`) under the default `/spec` folder.
+
+To run all the specs in the `spec` folder, use the provided rake task (_make sure Redis is running in localhost_):
+
+```bash
+  bundle exec rspec
+```
+
+`Simplecov` is used for coverage reporting. Upon executing the rake task it will store the reports in the `/coverage` folder.
+
+### Linting and other useful checks
+To run the static code analysis using Rubocop run:
+```bash
+bundle exec rubocop
+```
+
+If you want to benchmark the hashing algorithm (MurmurHash) run:
+```bash
+bundle exec rake compile:murmurhash
+```
+ 
+# Contact
+If you have any other questions or need to contact us directly in a private manner send us a note at developers@split.io

data/README.md

@@ -1,44 +1,78 @@
+# Split SDK for Ruby
 [![Build Status](https://travis-ci.com/splitio/ruby-client.svg?branch=master)](https://travis-ci.com/splitio/ruby-client)
 
-# Split Ruby SDK
-
-This SDK is designed to work with [Split](https://www.split.io), the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
-
-### Quick setup
-
-For specific instructions on how to set up the Split SDK refer to our [Detailed-README](Detailed-README.md) or our [official SDK documentation](http://docs.split.io/docs/sdk-overview).
-
-### Commitment to Quality:
-
-Split’s SDKs are in active development and are constantly tested for quality. Unit tests are developed for each SDK based on the unique needs of that language, and integration tests, load and performance tests, and behavior consistency tests are running 24/7 via automated bots. In addition, monitoring instrumentation ensures that these SDKs behave under the expected parameters of memory, CPU, and I/O.
-
-### About Split:
-
-Split is the leading platform for feature experimentation, empowering businesses of all sizes to make smarter product decisions. Companies like Vevo, Twilio, and LendingTree rely on Split to securely release new features, target them to customers, and measure the impact of features on their customer experience metrics. Founded in 2015, Split's team comes from some of the most innovative enterprises in Silicon Valley, including Google, LinkedIn, Salesforce and Databricks. Split is based in Redwood City, California and backed by Accel Partners and Lightspeed Venture Partners.
-
-Our platform is a unified solution for continuous delivery and full-stack experimentation. Split unifies DevOps and product management, helping agile engineering and product teams accelerate the pace of product delivery and make data-driven decisions, through our robust feature flagging and extensive experimentation capabilities. With Split, organizations can now accelerate time to value, mitigate risk, and drive better outcomes, all in a unified platform.
-
-To learn more about Split, contact hello@split.io, or start a 14-day trial at https://www.split.io/signup/.
-
-Split has built and maintains a SDKs for:
-
-* 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)
-* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](http://docs.split.io/docs/ruby-sdk-overview)
-* 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)
-* GO [Github](https://github.com/splitio/go-client) [Docs](http://docs.split.io/docs/go-sdk-overview)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/docs/android-sdk-overview)
-* IOS [Github](https://github.com/splitio/ios-client) [Docs](https://docs.split.io/docs/ios-sdk-overview)
-
-For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
-
+## Overview
+This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.
+ 
+[![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
+
+## Compatibility
+The Ruby SDK support Ruby version 2.3.0 or later and JRuby or 9.1.17 o later.
+
+Also the Ruby SDK has been tested as a standalone app as well as using the following web servers:
+ - Puma
+ - Passenger
+ - Unicorn
+
+For other setups, please reach out to [support@split.io](mailto:support@split.io).
+
+## Getting started
+Below is a simple example that describes the instantiation and most basic usage of our SDK:
+```ruby
+require 'splitclient-rb'
+
+split_factory = SplitIoClient::SplitFactory.new('SDK_API_KEY')
+split_client = split_factory.client
+
+begin  
+  split_client.block_until_ready  
+rescue SplitIoClient::SDKBlockerTimeoutExpiredException
+  puts 'SDK is not ready. Decide whether to continue or abort execution'  
+end  
+
+treatment = split_client.get_treatment('CUSTOMER_ID', 'SPLIT_NAME');
+
+if treatment == 'on'
+  # insert code here to show on treatment
+elsif treatment == 'off'
+  # insert code here to show off treatment
+else
+  # insert your control treatment code here
+end
+```
+For multi-process environments you also need to setup Split Synchronizer. See [Sharing state: Redis integration](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK#sharing-state-redis-integration)
+ 
+Please refer to [our official docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK) to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.
+
+## Submitting issues
+The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/ruby-client/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
+
+## Contributing
+Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
+ 
+## License
+Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
+
+## About Split 
+Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.
+ 
+To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
+ 
+Split has built and maintains SDKs for:
+ 
+* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
+* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
+* .NET [Github](https://github.com/splitio/.net-core-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
+* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
+* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
+* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
+* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
+ 
+For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
+ 
 **Learn more about Split:**
-
-Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [docs.split.io](http://docs.split.io) for more detailed information.
-
-**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).
+ 
+Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.

data/lib/splitclient-rb.rb

@@ -25,18 +25,18 @@ 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/senders/events_sender'
+require 'splitclient-rb/cache/senders/localhost_repo_cleaner'
+require 'splitclient-rb/cache/stores/store_utils'
+require 'splitclient-rb/cache/stores/localhost_split_builder'
 require 'splitclient-rb/cache/stores/sdk_blocker'
 require 'splitclient-rb/cache/stores/segment_store'
 require 'splitclient-rb/cache/stores/split_store'
+require 'splitclient-rb/cache/stores/localhost_split_store'
 
-require 'splitclient-rb/localhost_utils'
-require 'splitclient-rb/clients/localhost_split_client'
 require 'splitclient-rb/clients/split_client'
-require 'splitclient-rb/managers/localhost_split_manager'
 require 'splitclient-rb/managers/split_manager'
 require 'splitclient-rb/split_factory'
 require 'splitclient-rb/split_factory_builder'
-require 'splitclient-rb/localhost_split_factory'
 require 'splitclient-rb/split_config'
 require 'splitclient-rb/split_logger'
 require 'splitclient-rb/validators'

data/lib/splitclient-rb/cache/adapters/memory_adapters/map_adapter.rb

@@ -121,6 +121,10 @@ module SplitIoClient
             end
           end
 
+          def empty?
+            @map.empty?
+          end
+
           # This method is used in Redis adapter
           # "stubbing" it here to keep the interface
           def pipelined(&block)

data/lib/splitclient-rb/cache/adapters/memory_adapters/queue_adapter.rb

@@ -42,6 +42,10 @@ module SplitIoClient
           def length
             @current_size.value
           end
+
+          def empty?
+            @queue.empty?
+          end
         end
       end
     end

data/lib/splitclient-rb/cache/repositories/impressions/memory_repository.rb

@@ -46,6 +46,10 @@ module SplitIoClient
             @adapter.clear
           end
 
+          def empty?
+            @adapter.empty?
+          end
+
           private
 
           def random_sampler

data/lib/splitclient-rb/cache/repositories/impressions_repository.rb

@@ -6,11 +6,11 @@ module SplitIoClient
       # Repository which forwards impressions interface to the selected adapter
       class ImpressionsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add, :add_bulk, :batch, :clear, :empty?
+        def_delegators :@repository, :add, :add_bulk, :batch, :clear, :empty?
 
         def initialize(config)
           super(config)
-          @adapter = case @config.impressions_adapter.class.to_s
+          @repository = case @config.impressions_adapter.class.to_s
                      when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
                        Repositories::Impressions::MemoryRepository.new(@config)
                      when 'SplitIoClient::Cache::Adapters::RedisAdapter'

data/lib/splitclient-rb/cache/repositories/metrics/memory_repository.rb

@@ -152,7 +152,7 @@ module SplitIoClient
           end
 
           def find_operation_latencies(operation)
-            @latencies.find { |l| l[:operation] == operation }
+            @latencies.find { |l| l[:operation] == operation unless l.nil? }
           end
         end
       end

data/lib/splitclient-rb/cache/repositories/metrics_repository.rb

@@ -4,12 +4,12 @@ module SplitIoClient
       # Repository which forwards impressions interface to the selected adapter
       class MetricsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add_count, :add_latency, :add_gauge, :counts, :latencies, :gauges,
+        def_delegators :@repository, :add_count, :add_latency, :add_gauge, :counts, :latencies, :gauges,
                        :clear_counts, :clear_latencies, :clear_gauges, :clear, :fix_latencies
 
         def initialize(config)
           super(config)
-          @adapter = case @config.metrics_adapter.class.to_s
+          @repository = case @config.metrics_adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
             Repositories::Metrics::MemoryRepository.new(@config)
           when 'SplitIoClient::Cache::Adapters::RedisAdapter'

data/lib/splitclient-rb/cache/senders/impressions_sender.rb

@@ -11,11 +11,6 @@ module SplitIoClient
         end
 
         def call
-          if @config.disable_impressions
-            @config.logger.info('Disabling impressions service by config')
-            return
-          end
-
           if ENV['SPLITCLIENT_ENV'] == 'test'
             post_impressions
           else

data/lib/splitclient-rb/cache/senders/localhost_repo_cleaner.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Cache
+    module Senders
+      class LocalhostRepoCleaner
+        def initialize(impressions_repository, metrics_repository, events_repository, config)
+          @impressions_repository = impressions_repository
+          @metrics_repository = metrics_repository
+          @events_repository = events_repository
+          @config = config
+        end
+
+        def call
+          if ENV['SPLITCLIENT_ENV'] == 'test'
+            clear_repositories
+          else
+            cleaner_thread
+
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                cleaner_thread if forked
+              end
+            end
+          end
+        end
+
+        private
+
+        def cleaner_thread
+          @config.threads[:repo_cleaner] = Thread.new do
+            @config.logger.info('Starting repositories cleanup service')
+            loop do
+              clear_repositories
+
+              sleep(SplitIoClient::Utilities.randomize_interval(@config.features_refresh_rate))
+            end
+          end
+        end
+
+        def clear_repositories
+          @impressions_repository.clear
+          @metrics_repository.clear
+          @events_repository.clear
+        end
+      end
+    end
+  end
+end