fluidfeatures-rails 0.1.3 → 0.1.4

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/BigFastSite/fluidfeatures-rails.png)](http://travis-ci.org/BigFastSite/fluidfeatures-rails)
+[![Build Status](https://secure.travis-ci.org/FluidFeatures/fluidfeatures-rails.png)](http://travis-ci.org/FluidFeatures/fluidfeatures-rails)
 
 fluidfeatures-rails
 ===================

data/lib/fluidfeatures/rails/version.rb

@@ -1,5 +1,5 @@
 module FluidFeatures
   module Rails
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

data/lib/fluidfeatures/rails.rb

@@ -1,26 +1,37 @@
 
-require 'rails'
-require 'net/http'
-require 'persistent_http'
-
-#
-# Without these FluidFeatures credentials we cannot talk to
-# the FluidFeatures service.
-#
-%w[FLUIDFEATURES_BASEURI FLUIDFEATURES_SECRET FLUIDFEATURES_APPID].each do |key|
-  unless ENV[key]
-    raise "Environment variable #{key} expected"
-  end
-end
-
 module FluidFeatures
   module Rails
+
+    class << self
+      attr_accessor :enabled
+    end
     
     #
     # This is called once, when your Rails application fires up.
     # It sets up the before and after request hooks
     #
     def self.initializer
+
+      #
+      # Without these FluidFeatures credentials we cannot talk to
+      # the FluidFeatures service.
+      #
+      %w[FLUIDFEATURES_BASEURI FLUIDFEATURES_SECRET FLUIDFEATURES_APPID].each do |key|
+        unless ENV[key]
+          $stderr.puts "!! fluidfeatures-rails requires ENV[\"#{key}\"] (fluidfeatures is disabled)"
+          return
+        end
+      end
+      unless defined? ::Rails
+        $stderr.puts "!! fluidfeatures-rails requires rails (fluidfeatures is disabled)"
+        return
+      end
+      $stderr.puts "=> fluidfeatures-rails initializing as app #{ENV["FLUIDFEATURES_APPID"]} with #{ENV["FLUIDFEATURES_BASEURI"]}"
+
+
+      require 'net/http'
+      require 'persistent_http'
+
       ::Rails::Application.initializer "fluidfeatures.initializer" do
         ActiveSupport.on_load(:action_controller) do
 
@@ -38,11 +49,13 @@ module FluidFeatures
           @@unknown_features = {}
           @@last_fetch_duration = nil
 
-          ActionController::Base.append_before_filter :fluidfeatures_request_init
-          ActionController::Base.append_after_filter :fluidfeatures_store_features_hit
+          ActionController::Base.append_before_filter :fluidfeatures_request_before
+          ActionController::Base.append_after_filter  :fluidfeatures_request_after
 
         end
       end
+
+      @enabled = true
     end
     
     #
@@ -156,30 +169,18 @@ module FluidFeatures
     # back with the default_enabled status (see unknown_feature_hit)
     # so that FluidFeatures can auto-populate the dashboard.
     #
-    def self.log_features_hit(user_id, features_hit, request_duration)
+    def self.log_request(user_id, payload)
       begin
-        uri = URI(@@baseuri + "/app/" + @@app_id.to_s + "/user/" + user_id.to_s + "/features/hit")
+        (payload[:stats] ||= {})[:ff_latency] = @@last_fetch_duration
+        if @@unknown_features.size
+          (payload[:features] ||= {})[:unknown] = @@unknown_features
+          @@unknown_features = {}
+        end
+        uri = URI(@@baseuri + "/app/#{@@app_id}/user/#{user_id}/features/hit")
         request = Net::HTTP::Post.new uri.path
         request["Content-Type"] = "application/json"
         request["Accept"] = "application/json"
         request['AUTHORIZATION'] = @@secret
-        payload = {
-          :stats => {
-            :fetch => {
-              :duration => @@last_fetch_duration
-            },
-            :request => {
-              :duration => request_duration
-            }
-          },
-          :features => {
-            :hit => features_hit
-          }
-        }
-        if @@unknown_features.size
-          payload[:features][:unknown] = @@unknown_features
-          @@unknown_features = {}
-        end
         request.body = JSON.dump(payload)
         response = @@http.request request
         unless response.is_a?(Net::HTTPSuccess)
@@ -197,14 +198,45 @@ end
 module ActionController
   class Base
     
+    # allow fluidfeature to be called from templates
+    helper_method :fluidfeature
+
     #
     # Here is how we know what your user_id is for the user
     # making the current request.
     # This must be overriden within the user application.
     # We recommend doing this in application_controller.rb
     #
-    def fluidfeatures_set_user_id(user_id)
+    def fluidfeatures_set_user_id(user_id, options={})
+
+      if user_id and not options[:anonymous]
+        # We no longer an anoymous users. Let's delete the cookie
+        if cookies.has_key? :fluidfeatures_anonymous
+          cookies.delete(:fluidfeatures_anonymous)
+        end
+      else
+        # We're an anonymous user
+
+        # if we were not given a user_id for this anonymous user, then get
+        # it from an existing cookie or create a new one.
+        unless user_id
+          # Have we seen them before?
+          if cookies.has_key? :fluidfeatures_anonymous
+            user_id = cookies[:fluidfeatures_anonymous]
+          else
+            # Create new cookie. Use rand + micro-seconds of current time
+            user_id = "anon-" + Random.rand(9999999999).to_s + "-" + ((Time.now.to_f * 1000000).to_i % 1000000).to_s
+          end
+        end
+        # update the cookie, with whatever the user_id has been set to
+        cookies[:fluidfeatures_anonymous] = user_id
+      end
+
       @ff_user_id = user_id
+      @ff_user_anonymous = !!options[:anonymous]
+      @ff_user_attributes = options[:attributes]
+
+      user_id
     end
     
     #
@@ -217,6 +249,9 @@ module ActionController
       if defaults === true or defaults === false
         defaults = { :enabled => defaults }
       end
+      unless ::FluidFeatures::Rails.enabled
+        return defaults[:enabled] || false
+      end
       global_defaults = fluidfeatures_defaults || {}
       version_name = (defaults[:version] || global_defaults[:version]).to_s
       if not @features
@@ -254,7 +289,7 @@ module ActionController
     #
     # Initialize the FluidFeatures state for this request.
     #
-    def fluidfeatures_request_init
+    def fluidfeatures_request_before
       @ff_request_start_time = Time.now
       @features = nil
     end
@@ -273,10 +308,28 @@ module ActionController
     # This helps the FluidFeatures database prepopulate the feature set
     # without requiring the developer to do it manually.
     # 
-    def fluidfeatures_store_features_hit
+    def fluidfeatures_request_after
       if @features
         request_duration = Time.now - @ff_request_start_time
-        FluidFeatures::Rails.log_features_hit(@ff_user_id, @features_hit, request_duration)
+        url = "#{request.protocol}#{request.host_with_port}#{request.fullpath}"
+        payload = {
+          :stats => {
+            :request => {
+              :duration => request_duration
+            }
+          },
+          :features => {
+            :hit => @features_hit
+          },
+          :url => url
+        }
+        if @ff_user_anonymous
+          (payload[:user] ||= {})[:anonymous] = true
+        end
+        if @ff_user_attributes
+          (payload[:user] ||= {})[:attributes] = @ff_user_attributes
+        end
+        FluidFeatures::Rails.log_request(@ff_user_id, payload)
       end
     end
     
@@ -284,7 +337,7 @@ module ActionController
       # By default unknown features are disabled.
       {
         :enabled => false,
-        :version => 1
+        :version => :default
       }
     end
 

data/test/testapp/spec/controllers/home_controller_spec.rb

@@ -38,33 +38,33 @@ describe HomeController do
 
       # Check the call to features hit
       features_hit_request = FakeWeb.last_request
-      JsonSpec.exclude_keys("duration")
+      JsonSpec.exclude_keys("duration", "ff_latency")
       features_hit_request.body.should be_json_eql(%({
         "features": {
           "hit": {
             "apples": {
-                "1": {}
+                "default": {}
             }
           },
           "unknown": {
             // features that we have not seen before
             "apples": {
               "versions": {
-                "1": {
+                "default": {
                   "enabled": true
                 }
               }
             },
             "lemons": {
               "versions": {
-                "1": {
+                "default": {
                   "enabled": false
                 }
               }
             },
             "oranges": {
               "versions": {
-                "1": {
+                "default": {
                   "enabled": false
                 }
               }
@@ -72,13 +72,12 @@ describe HomeController do
           }
         },
         "stats": {
-          "fetch": {
-            // duration ignored
-          },
+          "ff_latency": 1,
           "request": {
             // duration ignored
           }
-        }
+        },
+        "url": "http://test.host/?user_id=1"
       }))
     end
 
@@ -89,15 +88,15 @@ describe HomeController do
 
       # Check the call to features hit
       features_hit_request = FakeWeb.last_request
-      JsonSpec.exclude_keys("duration")
+      JsonSpec.exclude_keys("duration", "ff_latency")
       features_hit_request.body.should be_json_eql(%({
         "features": {
           "hit": {
             "oranges": {
-                "1": {}
+                "default": {}
             },
             "lemons": {
-                "1": {}
+                "default": {}
             }
           },
           "unknown": {
@@ -105,13 +104,12 @@ describe HomeController do
           }
         },
         "stats": {
-          "fetch": {
-            // duration ignored
-          },
+          "ff_latency": 1,
           "request": {
             // duration ignored
           }
-        }
+        },
+        "url": "http://test.host/?user_id=2"
       }))
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluidfeatures-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: persistent_http