splitclient-rb 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a41bec6c18ad02fe505150e1b411d7e543959fc0
+  data.tar.gz: a45a3845b7680d327b245d83d10b0d806afa680b
+SHA512:
+  metadata.gz: 5dce3094a147e53ac7c8ab61bc5d2338d550f4f277b2de096626953f3410679305f46e30a874824a65f2317431776b115ae4c9f9a05e415ef3e3923d44300c09
+  data.tar.gz: 3d268568ca1c0171df8ba79c42362827aea3f334cf881eb15247105415bde17e3fa50654f0ab1a538767358778930e2ca5e4c13ab5363fa09eab8d4f9bf0a63a

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Ignore Byebug command history file.
+.byebug_history

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in splitclient-rb.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   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.
+

data/README.md

@@ -0,0 +1,152 @@
+# splitclient-rb
+
+Ruby client for split software. This is 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
+
+	Or install it yourself as:
+
+	    $ gem install splitclient-rb
+
+ - If the gem is still unpublished you can install it through this git repository with the following instructions:
+
+	Add these lines to you application's Gemnfile
+	```ruby
+	gem 'splitclient-rb', :git=>'https://github.com/splitio/ruby-client.git',
+	```
+	You can also specify 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
+split_client = SplitIoClient::SplitClient.new("your_api_key")
+```
+###Ruby on Rails
+----
+If you're using Ruby on Rails
+
+Create an initializer file at config/initializers/splitclient.rb and then initialize the split client :
+```ruby
+Rails.configuration.split_client = SplitIoClient::SplitClient.new("your_api_key")
+```
+In your controllers, access the client using
+
+```ruby
+Rails.application.config.split_client
+```
+
+###Configuration
+---
+By default the split client uses its default configuration, it will 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/
+
+**local_store** : optional cache storage
+*default value* : custom cache local storage
+
+**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
+*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
+*default value* = 60
+
+**logger** : default logger for messages and errors
+*default value* : Ruby logger class set to STDOUT
+
+Example
+```ruby
+options = {base_uri: 'https://my.app.api/',
+           local_store: Rails.cache,
+           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')}
+
+split_client = SplitIoClient::SplitClient.new("your_api_key", options)
+```
+### Execution
+---
+In your application code you just need to call the is_on? method with the required parameters for key and feature name
+```ruby
+split_client.is_treatment?('key','feature_name','on')
+```
+
+For example
+```ruby
+if split_client.is_treatment?('employee_user_01','view_main_list','on')
+   my_app.display_main_list
+end
+```
+
+## 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 foleder 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:
+
+	    $ rake spec
+
+Also, simplecov is used for coverage reporting. After the execution of the rake tastk 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%.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/splitio/ruby-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache License](http://www.apache.org/licenses/).

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/splitclient-cache/local_store.rb

@@ -0,0 +1,45 @@
+require 'thread_safe'
+
+module SplitIoClient
+  # A thread-safe in-memory store suitable for use
+  # with the Faraday caching HTTP client, uses the
+  # Threadsafe gem as the underlying cache.
+  #
+  class LocalStore
+    #
+    # Default constructor
+    #
+    # @return [ThreadSafeMemoryStore] a new store
+    def initialize
+      @cache = ThreadSafe::Cache.new
+    end
+
+    #
+    # Read a value from the cache
+    # @param key [Object] the cache key
+    #
+    # @return [Object] the cache value
+    def read(key)
+      @cache[key]
+    end
+
+    #
+    # Store a value in the cache
+    # @param key [Object] the cache key
+    # @param value [Object] the value to associate with the key
+    #
+    # @return [Object] the value
+    def write(key, value)
+      @cache[key] = value
+    end
+
+
+    # deletes value from cache by given key
+    # @param key [Object] the cache key
+    def delete(key)
+      @cache[key] = nil
+    end
+
+  end
+
+end