featureflow 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b0db4c710ccf1fcff7d0042b2df43a14fb5ea1
-  data.tar.gz: d7b00c1a246338da291a2bb65db33b57bbbaada9
+  metadata.gz: bb85e275ba7fc47744ef930e0a983e75a15323fd
+  data.tar.gz: 037f88e647b2ba2f72f3389f357bbb830e35ce23
 SHA512:
-  metadata.gz: bf23b554a973e5ec9c4fb1169f6575750b40198f01e94c4018b5f0d820bb3a1f88733be3c5f76afecf90917224a5c35b72995f95e45aa3390e78c0c43451b64e
-  data.tar.gz: 8e2171aa3d6ce88e209912b32e2ff63c093a3efbfcd37124f5f392d25b90057bfe1af56011da43a52315f282cfcb28de6e04a64bb8f80418a882f094363123b7
+  metadata.gz: ccaac50587ea54480ac8beef8d3346cb905f9ce98e5158da9085bc1aa92a8769d40923ee41cd947e5a9188802c05f1c2d12faa4ac9279baf3cdbc8fae7395760
+  data.tar.gz: 6716daafbc92e7c94a2f0f10b7c065d5908181c50dc6ae1d2990837ab4377b7a0b195b9051269ff3ff1495fefa2bd332e7bfa359d8d90f90ec2bf9b4249e8912

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Change log
+## [0.4.0] - 2017-06-26
+### Changed
+- Added Rails support
 ## [0.3.3] - 2017-06-23
 ### Changed
 - Initial Release

data/Gemfile.lock

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

data/README.md

@@ -36,17 +36,48 @@ The usage of each class is documented below.
 
 ### Quick start
 
-Get your environment's Featureflow Server API key and initialise a new Featureflow client
+Firstly you will need to get your environment's Featureflow Server API key and initialise a new Featureflow client
+
+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`. 
+When the rules are updated, the changes made will be applied to your application.
+
+##### Ruby Quick Start
+
+If you are using ruby you can create a featureflow client like this:
 
 ```ruby
-FEATUREFLOW_SERVER_KEY = '<Your server api key goes here>'
-featureflow = Featureflow::Client.new api_key: FEATUREFLOW_SERVER_KEY
+featureflow = Featureflow::Client.new api_key: '<Your server api key goes here>'
+```
+
+Or, you can set the environment variable `FEATUREFLOW_SERVER_KEY` and just write:
+
+```ruby
+featureflow = Featureflow::Client.new
+```
+**Note: `featureflow`, as instantiated above, should be treated as a singleton. You are responsible for sharing it with the rest of your application**
+
+##### Rails Quick Start
+
+If you are using rails you can run the generator to setup Featureflow in your Rails application.
+
+```bash
+$ rails generator featureflow <Your server api key goes here>
+```
+
+Or, you can set the environment variable `FEATUREFLOW_SERVER_KEY` and the Rails Featureflow client will pick it up and use that.
+
+You will then be able to access your Featureflow client in your controllers, for example:
+
+```ruby
+class MainController < ApplicationController
+  def index
+    featureflow # this method will now reference the featureflow client
+  end
+end
 ```
 
-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
 
@@ -128,7 +159,8 @@ Further documentation can be found [here](http://docs.featureflow.io/docs)
 ## Roadmap
 - [x] Write documentation
 - [x] Release to RubyGems
-- [ ] Write Ruby on Rails integration
+- [x] Write Ruby on Rails integration
+- [ ] Add Ruby on Rails helper to user featureflow in views
 
 ## License
 

data/lib/featureflow/evaluate.rb

@@ -1,4 +1,4 @@
-require_relative 'evaluate_helpers'
+require 'featureflow/evaluate_helpers'
 
 module Featureflow
   class Evaluate

data/lib/featureflow/polling_client.rb

@@ -4,7 +4,7 @@ require 'json'
 module Featureflow
   class PollingClient
     DEFAULT_OPTIONS = {
-      delay: 30,
+      poll_interval: 30,
       timeout: 30
     }.freeze
     def initialize(url, api_key, options = {}, &set_features)
@@ -17,7 +17,7 @@ module Featureflow
       load_features
       Thread.new do
         loop do
-          sleep @options[:delay]
+          sleep @options[:poll_interval]
           load_features
         end
       end

data/lib/featureflow/rails/rails_client.rb

@@ -0,0 +1,19 @@
+require 'featureflow/client'
+
+module Featureflow
+  class RailsClient
+    def initialize(request)
+      @request = request
+    end
+    def evaluate(key, context)
+      request_context_values = {
+        'featureflow.ip' => @request.remote_ip,
+        'featureflow.url' => @request.original_url
+      }
+      context = {key: context, values: {}} if context.is_a?(String)
+      Featureflow.featureflow.evaluate(key,
+                                  key: context[:key],
+                                  values: request_context_values.merge(context[:values]))
+    end
+  end
+end

data/lib/featureflow/rails/railtie.rb

@@ -0,0 +1,42 @@
+require 'featureflow/rails/rails_client'
+module Featureflow
+  LOCK = Mutex.new
+
+  class << self
+    def configure(config_hash=nil)
+      if config_hash
+        configuration.merge!(config_hash)
+      end
+
+      yield(configuration) if block_given?
+      yield(featureflow) if block_given?
+    end
+
+    # Configuration getters
+    def configuration
+      @configuration = nil unless defined?(@configuration)
+      @configuration || LOCK.synchronize { @configuration ||= {} }
+    end
+
+    # Configuration getters
+    def featureflow
+      @featureflow = nil unless defined?(@featureflow)
+      @featureflow || LOCK.synchronize { @featureflow ||= Featureflow::Client.new(configuration) }
+    end
+  end
+
+  class FeatureflowRailtie < Rails::Railtie
+
+    config.before_initialize do
+      ActiveSupport.on_load(:action_controller) do
+        # @client =
+        ActionController::Base.class_eval do
+          def featureflow
+            Featureflow::RailsClient.new(request)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/featureflow/version.rb

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

data/lib/featureflow.rb

@@ -13,4 +13,6 @@ module Featureflow
       end
     end
   end
-end
+end
+
+require 'featureflow/rails/railtie' if defined?(Rails)

data/lib/generators/featureflow_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+class FeatureflowGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :api_key, required: true, :desc => "required"
+
+  gem "featureflow"
+
+  desc "Configures the featureflow with your API key"
+
+  def create_initializer_file
+    unless /^srv-env-[a-f0-9]{32}$/ =~ api_key
+      raise Thor::Error, "Invalid featureflow environment api key #{api_key.inspect}\nYou can find your environment api key on your featureflow dashboard at https://[APP-NAME].featureflow.io/"
+    end
+
+    initializer "featureflow.rb" do
+      <<-EOF
+Featureflow.configure(
+  api_key: #{api_key.inspect}
+)
+      EOF
+    end
+  end
+end

data/test.rb

@@ -7,15 +7,15 @@ with_features = [
 
 
 
-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', 'user1').on?.to_s)
-featureflow_client.evaluate('nooooo', 'user1').on?
-featureflow_client.evaluate('default', 'user1').on?
+# api_key = 'srv-env-9b5fff890c724d119a334a64ed4d2eb2'
+api_key = 'srv-env-f472cfa8c2774ea2b3678fc5a3dbfe13'
+featureflow_client = Featureflow::Client.new(api_key: api_key, with_features: with_features, url: 'http://10.10.2.163:8081')
+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?
 
 #
-# loop do
-#   puts('test-integration is on? ' + featureflow_client.evaluate('test-integration', context).on?.to_s)
-#   sleep 5
-# end
+loop do
+  sleep 1
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: featureflow
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Henry Young
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,7 +105,10 @@ files:
 - lib/featureflow/events_client.rb
 - lib/featureflow/feature.rb
 - lib/featureflow/polling_client.rb
+- lib/featureflow/rails/rails_client.rb
+- lib/featureflow/rails/railtie.rb
 - lib/featureflow/version.rb
+- lib/generators/featureflow_generator.rb
 - test.rb
 homepage: https://github.com/featureflow/featureflow-ruby-sdk
 licenses: