featureflow 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f5d6bd8646de5633e8a38969a098cf296a2dfbe
-  data.tar.gz: 97abda2e673d39895f2bde9482c618c7d2e3d829
+  metadata.gz: 47b0db4c710ccf1fcff7d0042b2df43a14fb5ea1
+  data.tar.gz: d7b00c1a246338da291a2bb65db33b57bbbaada9
 SHA512:
-  metadata.gz: 6733b393ac9bff5c4c62a4fede84237172de8952aa56a61c8580e910d4fa49f32da7dbd9344776474156ffdd3ba0eaa6365c507399d0c8ff48bf98fe3b6280cb
-  data.tar.gz: a6982e435fe692e96cd7e3c95b7912c091b99d758d536da7ef132d07400ee454d55f2726234506b5eaf217040b5dfe8903acf3be57238c9e09c1a2c4d48bd3bc
+  metadata.gz: bf23b554a973e5ec9c4fb1169f6575750b40198f01e94c4018b5f0d820bb3a1f88733be3c5f76afecf90917224a5c35b72995f95e45aa3390e78c0c43451b64e
+  data.tar.gz: 8e2171aa3d6ce88e209912b32e2ff63c093a3efbfcd37124f5f392d25b90057bfe1af56011da43a52315f282cfcb28de6e04a64bb8f80418a882f094363123b7

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change log
+## [0.3.3] - 2017-06-23
+### Changed
+- Initial Release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    featureflow (0.3.5)
+    featureflow (0.3.6)
       excon (~> 0.57.0)
 
 GEM

data/README.md

@@ -1,4 +1,141 @@
 # featureflow-ruby-sdk
 Ruby SDK for featureflow
 
-FEATUREFLOW_SERVER_KEY=
+[![][dependency-img]][dependency-url]
+
+[![][rubygems-img]][rubygems-url]
+
+> Featureflow Ruby SDK
+
+Get your Featureflow account at [featureflow.io](http://www.featureflow.io)
+
+## Get Started
+
+The easiest way to get started is to follow the [Featureflow quick start guides](http://docs.featureflow.io/docs)
+
+## Change Log
+
+Please see [CHANGELOG](https://github.com/featureflow/featureflow-node-sdk/blob/master/CHANGELOG.md).
+
+## Usage
+
+### Getting Started
+
+##### Ruby
+
+Add the following line to your Gemfile
+
+```ruby
+gem 'featureflow'
+```
+
+Requiring `featureflow` in your ruby application will expose the classes
+ `Featureflow::Client`, `Featuerflow::ContextBuilder` and `Featureflow::Feature`.
+
+The usage of each class is documented below.
+
+### Quick start
+
+Get your environment's Featureflow Server API key and initialise a new Featureflow client
+
+```ruby
+FEATUREFLOW_SERVER_KEY = '<Your server api key goes here>'
+featureflow = Featureflow::Client.new api_key: FEATUREFLOW_SERVER_KEY
+```
+
+This will load the rules for each feature for the current environment specified by the api key.
+These rules can be changed at `https://<your-org-key>.featureflow.io`, and the changes will be applied to your application.
+
+**Note: You are responsible for passing the featureflow instance around your application**
+
+#### Defining Context
+
+Before evaluating a feature you must define a context for the current user.  
+Featureflow uses context to target different user groups to specific feature variants. 
+A featureflow context has a `key`, which should uniquely identify the current user, and optionally additional `values`. 
+Featureflow requires the context `key` to be unique per user for gradual rollout of features.
+
+There are two ways to define context:
+```ruby
+require 'featureflow'
+context_key = '<unique_user_identifier>'
+
+# option 1, use the context builder
+context = Featureflow::ContextBuilder.new(context_key)
+                                     .with_values(country: 'US',
+                                                  roles: %w[USER_ADMIN, BETA_CUSTOMER])
+                                     .build
+
+# option 2, use just a string
+context = context_key
+```
+
+#### Evaluating Features
+
+In your code, you can test the value of your feature using something similar to below
+For these examples below, assume the feature `my-feature-key` is equal to `'on'` for the current `context`
+```ruby
+if featureflow.evaluate('my-feature-key', context).is? 'on'
+  # this code will be run because 'my-feature-key' is set to 'on' for the given context
+end
+```
+Because the most common variants for a feature are `'on'` and `'off'`, we have provided two helper methods `.on?` and `.off?`
+
+```ruby
+if featureflow.evaluate('my-feature-key', context).on?
+  # this feature code will be run because 'my-feature-key' is set to 'on'
+end
+
+if featureflow.evaluate('my-feature-key', context).off?
+  # this feature code won't be run because 'my-feature-key' is not set to 'off'
+end
+```
+
+#### Pre-registering Features
+
+Featureflow allows you to pre-register features that may not be defined in your Featureflow project to ensure that those 
+features are available when that version of your code is running. 
+If in the off-chance your application is unable to access the Featureflow servers and you don't have access 
+to a cached version of the features, you can specify a failover variant for any feature. 
+
+The failover variant allows you to control what variant a feature will evaluate to when no rules are available for the feature.
+If a failover variant isn't defined, each feature will use a default feailover variant of `'off'`.
+
+You can pre-register features at the initialisation of your featureflow client like below:
+
+```ruby
+require 'featureflow'
+
+FEATUREFLOW_SERVER_KEY = '<Your server api key goes here>'
+
+featureflow = Featureflow::Client.new(api_key: FEATUREFLOW_SERVER_KEY,
+                                      with_features: [
+                                        Featureflow::Feature.create('key-one', 'on'),
+                                        Featureflow::Feature.create('key-two'),
+                                        Featureflow::Feature.create('key-three', 'custom'),
+                                      ])
+
+# ... app has been started offline
+featureflow.evaluate('key-one', context).on? # == true
+featureflow.evaluate('key-two', context).off? # == true
+featureflow.evaluate('key-three', context).is? 'custom' # == true
+
+```
+
+#### Further documentation
+Further documentation can be found [here](http://docs.featureflow.io/docs)
+
+## Roadmap
+- [x] Write documentation
+- [x] Release to RubyGems
+- [ ] Write Ruby on Rails integration
+
+## License
+
+Apache-2.0
+
+[rubygems-url]: https://rubygems.org/gems/featureflow
+[rubygems-img]: https://badge.fury.io/rb/featureflow.png
+
+[dependency-url]: https://www.featureflow.io
+[dependency-img]: https://www.featureflow.io/wp-content/uploads/2016/12/featureflow-web.png

data/lib/featureflow/client.rb

@@ -50,7 +50,13 @@ module Featureflow
 
     def evaluate(key, context)
       raise ArgumentError, 'key must be a string' unless key.is_a?(String)
-      raise ArgumentError, 'context is required (build with Featureflow::ContextBuilder)' unless context
+      raise ArgumentError, 'context is required' unless context
+      unless context.is_a?(String) || context.is_a?(Hash)
+        raise ArgumentError, 'context must be either a string context key,' + \
+                             ' or a Hash built using Featureflow::ContextBuilder)'
+      end
+
+      context = ContextBuilder.new(context).build if context.is_a?(String)
 
       context = context.dup
       context[:values] = context[:values].merge('featureflow.key' => context[:key],

data/lib/featureflow/feature.rb

@@ -1,6 +1,6 @@
 module Featureflow
   class Feature
-    def self.create(key, failover_variant)
+    def self.create(key, failover_variant = 'off')
       raise ArgumentError, 'Parameter key must be a String' unless valid_key?(key)
       raise ArgumentError, 'Parameter default_variant must be a String' unless valid_key?(failover_variant) || failover_variant.is_a?(NilClass)
       {

data/lib/featureflow/version.rb

@@ -1,3 +1,3 @@
 module Featureflow
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

data/test.rb

@@ -4,12 +4,15 @@ require 'featureflow'
 with_features = [
   Featureflow::Feature.create('default', 'variant')
 ]
+
+
+
 api_key = 'srv-env-9b5fff890c724d119a334a64ed4d2eb2'
 featureflow_client = Featureflow::Client.new(api_key: api_key, with_features: with_features)
-context = Featureflow::ContextBuilder.new('user1').build
-puts('test-integration is on? ' + featureflow_client.evaluate('test-integration', context).on?.to_s)
-featureflow_client.evaluate('nooooo', context).on?
-featureflow_client.evaluate('default', context).on?
+# context = Featureflow::ContextBuilder.new('user1').build
+puts('test-integration is on? ' + featureflow_client.evaluate('test-integration', 'user1').on?.to_s)
+featureflow_client.evaluate('nooooo', 'user1').on?
+featureflow_client.evaluate('default', 'user1').on?
 
 #
 # loop do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: featureflow
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Henry Young
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE