splitclient-rb 3.1.0.pre.rc12 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 792c1c774edec245bff63e2a6bc6a400df5b3e66
-  data.tar.gz: 73b1d0d2087fa5c75bfd3adb4e38bbcd83b73584
+  metadata.gz: a5117f6f857f704d74de7ad686f76fe016245794
+  data.tar.gz: 8fdaf54c1819746efc035274ec8cd466f318c6c7
 SHA512:
-  metadata.gz: d51c707dcad7e97aab05edb06651f11b9265af9ee2769eb7d92684dfc189fa90dd546fbf895dbeead0163e798249a13b20af5e8351a20ead2b40a5fc94a1e40f
-  data.tar.gz: e27d3b2122d0b362e5c3d7455545720965f2a8542d194e0c9fa8d2ea9bd406bbb3c4b8db2eaf3815fc65d48c419f0b64fe89fce2eabd6c61ef9a46e2d9a64d5f
+  metadata.gz: 37e6ece18bd94cf91577f11d27d21d14a6d95e41e010b865621b36fb387769b208e1160029a096512d4d35b05a16e04904e3df103e6b47e1f241e699833293d7
+  data.tar.gz: 840b6cc2480523351a7d6f612b641f65309ffcb2cc6a1993acaacb457b89a924d061f87e5ec104af972de70e20b6156509042e5ace91f0f36f84c4fcbfd42171

data/CHANGES.txt

@@ -4,6 +4,8 @@
 - add impressions_queue_size to prevent memory leak when Threads pauses due to 'smart' fork.
 - do not report latencies for get_treatment is array is all zeros
 - Fix deduplication problem when posting impressions
+- Change in how factory is construct.
+- Detach implementation for local factory and regular one.
 
 3.0.3
 

data/Detailed-README.md

@@ -0,0 +1,406 @@
+# Split Ruby SDK
+
+Ruby SDK for Split software, provided as a gem that can be installed to your Ruby application.
+
+## Installation
+---
+
+ - Once the gem is published you can install it with the following steps:
+
+	Add this line to your application's Gemfile:
+
+	```ruby
+	gem 'splitclient-rb'
+	```
+
+	And then execute:
+
+	    $ bundle install
+
+	Or install it yourself as:
+
+	    $ gem install splitclient-rb
+
+ - You can also use the most recent version from github:
+
+	Add these lines to you application's `Gemfile`:
+	```ruby
+	gem 'splitclient-rb', git: 'https://github.com/splitio/ruby-client.git',
+	```
+	You can also use any specific branch if necessary:
+	```ruby
+	gem 'splitclient-rb', git: 'https://github.com/splitio/ruby-client.git', branch: 'development'
+	```
+	And then execute:
+
+	    $ bundle install
+
+## Usage
+
+### Quick Setup
+---
+
+Within your application you need the following:
+
+Require the Split client:
+```ruby
+require 'splitclient-rb'
+```
+
+Create a new split client instance with your API key:
+```ruby
+factory  = SplitIoClient::SplitFactoryBuilder.build('YOUR_API_KEY').client
+split_client = factory.client
+```
+
+For advance use cases you can also obtain a `manager` instance from the factory.
+```ruby
+manager = factory.manager
+```
+
+#### Localhost mode
+
+You can run SDK in so called "localhost" mode. In this mode SDK won't hit Split API and return treatments based on ".split" file on your local machine. The format of this file is two columns separated by whitespace. The left column is the Split name, the right column is the treatment name. Here is a sample file:
+
+```
+# this is a comment
+
+# split_client.get_treatment('foo', 'reporting_v2') => 'on'
+
+reporting_v2 on
+double_writes_to_cassandra off
+new-navigation v3
+
+```
+
+To use SDK in the localhost mode you should pass `localhost` as an API key like this:
+
+```ruby
+factory  = SplitIoClient::SplitFactoryBuilder.build('localhost', path: '/where/to-look-for/<file_name>')
+split_client = factory.client
+```
+
+By default SDK will look in your home directory (i.e. `~`) for a `.split` file, but you can specify a different 
+file name (full path) to look for the file (note: you must provide absolute path):
+
+
+### Ruby on Rails
+---
+
+Create an initializer: `config/initializers/splitclient.rb` and then initialize the split client:
+
+```ruby
+Rails.configuration.split_client = SplitIoClient::SplitFactoryBuilder.build('YOUR_API_KEY').client
+```
+In your controllers, access the client using:
+
+```ruby
+Rails.application.config.split_client
+```
+
+### Configuration
+---
+
+Split client's default configuration should be sufficient for most scenarios. However you can also provide custom configuration when initializing the client using an optional hash of options.
+
+The following values can be customized:
+
+**base_uri** :  URI for the api endpoints
+
+*defualt value* = `https://sdk.split.io/api/`
+
+**connection_timeout** :  timeout for network connections in seconds
+
+*default value* = `5`
+
+**read_timeout** : timeout for requests in seconds
+
+*default value* = `5`
+
+**features_refresh_rate** : The SDK polls Split servers for changes to feature roll-out plans. This parameter controls this polling period in seconds
+split_client.get_treatment('user_id','feature_name', attr: 'val')
+*default value* = `30`
+
+**segments_refresh_rate** : The SDK polls Split servers for changes to segment definitions. This parameter controls this polling period in seconds
+
+*default value* = `60`
+
+**metrics_refresh_rate** : The SDK sends diagnostic metrics to Split servers. This parameters controls this metric flush period in seconds
+
+*default value* = `60`
+
+**impressions_refresh_rate** : The SDK sends information on who got what treatment at what time back to Split servers to power analytics. This parameter controls how often this data is sent to Split servers in seconds
+
+**impressions_queue_size** : The size of the impressions queue in case of `cache_adapter == :memory` and the size impressions batch to be fetched from Redis in case of `cache_adapter == :redis`. Use `-1` to disable impressions.
+
+*default value* = `60`
+
+**debug_enabled** : Enables extra logging
+
+*default value* = `false`
+
+**transport_debug_enabled** : Enables extra transport logging
+
+*default value* = `false`
+
+**logger** : default logger for messages and errors
+
+*default value* = `Logger.new($stdout)`
+
+**block_until_ready** : The SDK will block your app for provided amount of seconds until it's ready. If timeout expires `SplitIoClient::SDKBlockerTimeoutExpiredException` will be thrown. If `false` provided, then SDK would run in non-blocking mode
+
+*default value* = `false`
+
+**mode** : See [SDK modes section](#sdk-modes).
+
+*default value* = `:standalone`
+
+#### Cache adapter
+
+The SDK needs some container to store data, i.e. splits/segments/impressions. By default it will store everything in the application's memory, but you can also use Redis.
+
+To use Redis, you have to include `redis-rb` in your app's Gemfile.
+
+**cache_adapter** : Supported options: `:memory`, `:redis`
+
+*default value* = `memory`
+
+**redis_url** : Redis URL or hash with configuration for SDK to connect to.
+
+*default value* = `'redis://127.0.0.1:6379/0'`
+
+You can also use Sentinel like this:
+
+```ruby
+SENTINELS = [{host: '127.0.0.1', port: 26380},
+             {host: '127.0.0.1', port: 26381}]
+
+redis_connection = { url: 'redis://mymaster', sentinels: SENTINELS, role: :master }
+
+options = {
+  # Other options here
+  redis_url: redis_connection
+}
+```
+
+Example using Redis
+```ruby
+options = {
+  connection_timeout: 10,
+  read_timeout: 5,
+  features_refresh_rate: 120,
+  segments_refresh_rate: 120,
+  metrics_refresh_rate: 360,
+  impressions_refresh_rate: 360,
+  logger: Logger.new('logfile.log'),
+  cache_adapter: :redis,
+  mode: :standalone,
+  redis_url: 'redis://127.0.0.1:6379/0'
+}
+begin
+  split_client = SplitIoClient::SplitFactoryBuilder.build('YOUR_API_KEY', options).client
+rescue SplitIoClient::SDKBlockerTimeoutExpiredException
+  # Some arbitrary actions
+end
+```
+
+#### IMPORTANT
+
+For now, SDK does not support both `producer` mode and `block_until_ready`. You must either run SDK in `standalone` mode, or do not use `block_until_ready` option.
+
+This begin-rescue-end block is optional, you might want to use it to catch timeout expired exception and apply some logic.
+
+### Execution
+---
+
+In your application code you just need to call the `get_treatment` method with the required parameters for key and feature name:
+```ruby
+split_client.get_treatment('user_id','feature_name', attr: 'val')
+```
+
+For example
+```ruby
+if split_client.get_treatment('employee_user_01','view_main_list', age: 35)
+   my_app.display_main_list
+end
+```
+
+Also, you can use different keys for actually getting treatment and sending impressions to the server:
+```ruby
+split_client.get_treatment(
+	{ matching_key: 'user_id', bucketing_key: 'private_user_id' },
+	'feature_name',
+	attr: 'val'
+)
+```
+When it might be useful? Say, you have a user browsing your website and not signed up yet. You assign some internal id to that user (i.e. bucketing_key) and after user signs up you assign him a matching_key.
+By doing this you can provide both anonymous and signed up user with the same treatment.
+
+`bucketing_key` may be `nil` in that case `matching_key` would be used as a key, so calling
+```ruby
+split_client.get_treatment(
+	{ matching_key: 'user_id' },
+	'feature_name',
+	attr: 'val'
+)
+```
+Is exactly the same as calling
+```ruby
+split_client.get_treatment('user_id' ,'feature_name', attr: 'val')
+```
+`bucketing_key` must not be nil
+
+Also you can use the split manager:
+
+```ruby
+split_manager = SplitIoClient::SplitFactoryBuilder.build('your_api_key', options).manager
+```
+
+With the manager you can get a list of your splits by doing:
+
+```ruby
+manager.splits
+```
+
+And you should get something like this:
+
+```ruby
+[
+	{
+		name: 'some_feature',
+		traffic_type_name: nil,
+		killed: false,
+		treatments: nil,
+		change_number: 1469134003507
+	},
+	{
+		name: 'another_feature',
+		traffic_type_name: nil,
+		killed: false,
+		treatments: nil,
+		change_number: 1469134003414
+	},
+	{
+		name: 'even_more_features',
+		traffic_type_name: nil,
+		killed: false,
+		treatments: nil,
+		change_number: 1469133991063
+	},
+	{
+		name: 'yet_another_feature',
+		traffic_type_name: nil,
+		killed: false,
+		treatments: nil,
+		change_number: 1469133757521
+	}
+]
+ ```
+
+### SDK Modes
+
+By default SDK would run alongside with your application and will be run in `standalone` mode, which includes two modes:
+- `producer` - storing information from the Splits API in the chosen cache
+- `consumer` - retrieving data from the cache and providing `get_treatment` interface
+
+As you might think, you can choose between these 3 modes by providing `mode` option in the config.
+
+#### Producer mode
+
+If you have, say, one Redis cache which is used by several Split SDKs at once, e.g.: Python and Ruby, you want to have only one of them to write data to Redis, so it would remain consistent. That's why we have producer mode.
+
+SDK can be ran in `producer` mode both in the scope of the application (e.g. as a part of the Rails app), and as a separate process. Let's see what steps are needed to run it as a separate process:
+
+- You need to create a config file with .yml extension. All options specified in the above example section are valid, but you should write them in the YAML format, like this:
+
+```yaml
+---
+:api_key: 'SECRET_API_KEY'
+:connection_timeout: 10
+:read_timeout: 5
+:features_refresh_rate: 120
+:segments_refresh_rate: 120
+:metrics_refresh_rate: 360
+:impressions_refresh_rate: 360
+:cache_adapter: :redis
+:mode: :producer
+:redis_url: 'redis://127.0.0.1:6379/0'
+```
+
+- Install binstubs
+```ruby
+bundle binstubs splitclient-rb
+```
+
+- Run the executable provided by the SDK:
+```ruby
+bundle exec bin/splitio -c ~/path/to/config/file.yml
+```
+
+That's it!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Coverage
+
+The gem uses rspec for unit testing. Under the default `/spec` folder you will find the files for the unit tests and the specs helper file ( spec_helper.rb ). If a new spec file with new unit tests is required you just simply need to create it under the spec folder and all its test will be executed on the next rspec execution.
+
+To run the suite of unit tests a rake task is provided. It's executed with the following command:
+
+```bash
+  $ rake spec
+```
+
+Also, simplecov is used for coverage reporting. After the execution of the rake task it will create the `/coverage` folder with coverage reports in pretty HTML format.
+Right now, the code coverage of the gem is at about 95%.
+
+## Release
+
+```bash
+gem build splitclient-rb.gemspec
+```
+
+This will generate a file gemspec with the right version, then:
+
+```bash
+gem push splitclient-rb-<VERSION>.gem
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/splitio/ruby-client.
+
+## Gem version publish
+
+To build a new version of the gem, after you have finished the desired changes, documented the CHANGES.txt and the NEWS, as well as named it properly in the version.rb. This steps assume that all of your new cool features and fixes have been merged into development, and into master branches of the ruby-client repo. Once that is ready to go, you will have to run the build command to obtain a .gem file:
+
+```bash
+gem build splitclient-rb.gemspec
+```
+
+That will generate a splitclient-rb-x.x.x.gem file, with the corresponding version information on it.
+To publish this new version of the gem at rubygems.org you must run the following command:
+
+```bash
+gem push splitclient-rb-x.x.x.gem
+```
+
+A valid rubygems username and password will be required.
+
+After this action, the new splitclient-rb-x.x.x version is available for its use from any ruby app.
+
+So for instance in a rails app Gemfile, you could add the:
+
+```ruby
+gem 'splitclient-rb', '~> x.x.x'
+```
+
+line to have the latest version of the gem ready to be used.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License](http://www.apache.org/licenses/).

data/LICENSE

@@ -1,202 +1,13 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+Copyright 2016 Split Software, Co.
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+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
 
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   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.
+    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.