fluidfeatures 0.4.1 → 0.4.4

data/.gitignore

@@ -1,6 +1,8 @@
 *.gem
 *.swp
 .bundle
+.idea
+.rvmrc
 Gemfile.lock
 pkg/*
 *.rbc

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+gemfile:
+  - Gemfile
+script: bundle exec rake spec
+env: FLUIDFEATURES_APPID=1vu33ki6emqe3 FLUIDFEATURES_SECRET=secret FLUIDFEATURES_BASEURI=https://www.fluidfeatures.com/service

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/fluidfeatures/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/fluidfeatures.gemspec

@@ -15,4 +15,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_dependency "persistent_http", "~>1.0.3"
   s.add_dependency "uuid", "~>2.3.5"
+
+  s.add_development_dependency('rake', '~> 10.0.2')
+  s.add_development_dependency('rspec', '~> 2.12.0')
+  s.add_development_dependency('guard-rspec', '~> 2.2.1')
+  s.add_development_dependency('rb-inotify', '~> 0.8.8')
+  s.add_development_dependency('vcr', '~> 2.3.0')
+  s.add_development_dependency('fakeweb', '~> 1.3.0')
 end

data/lib/fluidfeatures/app/feature.rb

@@ -15,7 +15,7 @@ module FluidFeatures
       version_name ||= ::FluidFeatures::DEFAULT_VERSION_NAME
       raise "version_name invalid : #{version_name}" unless version_name.is_a? String
 
-      @app = client
+      @app = app
       @feature_name = feature_name
       @version_name = version_name
 
@@ -34,7 +34,7 @@ module FluidFeatures
 
       app.put("/feature/#{feature_name}/#{version_name}/enabled/percent", {
         :enabled => {
-          :percent => enabled_percent
+          :percent => percent
         }
       })
     end

data/lib/fluidfeatures/app/reporter.rb

@@ -1,4 +1,3 @@
-
 require "fluidfeatures/const"
 require "thread"
 
@@ -27,9 +26,12 @@ module FluidFeatures
     WAIT_BETWEEN_SEND_FAILURES = 5 # seconds
     
     def initialize(app)
-
       raise "app invalid : #{app}" unless app.is_a? ::FluidFeatures::App
+      configure(app)
+      run_loop
+    end
 
+    def configure(app)
       @app = app
 
       @buckets = []
@@ -41,13 +43,10 @@ module FluidFeatures
 
       @unknown_features = {}
       @unknown_features_lock = ::Mutex.new
-
-      run_transcation_sender
-
     end
 
-    # Pass FluidFeatures::AppTransaction for reporting back to the
-    # FluidFeatures service.
+    # Pass FluidFeatures::AppUserTransaction for reporting
+    # back to the FluidFeatures service.
     def report_transaction(transaction)
 
       user = transaction.user
@@ -81,7 +80,7 @@ module FluidFeatures
 
     end
 
-    def run_transcation_sender
+    def run_loop
       Thread.new do
         while true
           begin
@@ -91,7 +90,7 @@ module FluidFeatures
               next
             end
 
-            success = send_transcations
+            success = send_transactions
 
             if success
               # Unless we have a full bucket waiting do not make
@@ -109,7 +108,7 @@ module FluidFeatures
 
           rescue Exception => err
             # catch errors, so that we do not affect the rest of the application
-            app.logger.error "[FF] send_transcations failed : #{err.message}\n#{err.backtrace.join("\n")}"
+            app.logger.error "[FF] send_transactions failed : #{err.message}\n#{err.backtrace.join("\n")}"
             # hold off for a little while and try again
             sleep WAIT_BETWEEN_SEND_FAILURES
           end
@@ -135,9 +134,9 @@ module FluidFeatures
     end
 
     @private
-    def send_transcations
+    def send_transactions
       bucket = remove_bucket
-      
+
       # Take existing unknown features and reset
       unknown_features = nil
       @unknown_features_lock.synchronize do
@@ -173,7 +172,7 @@ module FluidFeatures
       unless success
         # return bucket into bucket queue until the next attempt at sending
         if not unremove_bucket(bucket)
-          app.logger.warn "[FF] Discarded #{discarded_bucket.size} transactions due to reporter backlog. These will not be reported to FluidFeatures."
+          app.logger.warn "[FF] Discarded transactions due to reporter backlog. These will not be reported to FluidFeatures."
         end
         # return unknown features to queue until the next attempt at sending
         queue_unknown_features(unknown_features)
@@ -251,7 +250,7 @@ module FluidFeatures
     def queue_unknown_features(unknown_features)
       raise "unknown_features should be a Hash" unless unknown_features.is_a? Hash
       unknown_features.each_pair do |feature_name, versions|
-        raise "unknown_features values should be Hash. versions=#{versions}" unless versions.is_a? Hash
+        raise "unknown_features values should be a Hash. versions=#{versions}" unless versions.is_a? Hash
       end
       @unknown_features_lock.synchronize do
         unknown_features.each_pair do |feature_name, versions|

data/lib/fluidfeatures/app/state.rb

@@ -1,4 +1,3 @@
-
 require "digest/sha1"
 require "set"
 require "thread"
@@ -8,10 +7,11 @@ require "fluidfeatures/app/transaction"
 
 module FluidFeatures
   class AppState
-    
+
     attr_accessor :app
-    USER_ID_NUMERIC = Regexp.compile("^\d+$")
-    
+
+    USER_ID_NUMERIC = /^\d+$/
+
     # Request to FluidFeatures API to long-poll for max
     # 30 seconds. The API may choose a different duration.
     # If not change in this time, API will return HTTP 304.
@@ -28,15 +28,15 @@ module FluidFeatures
     WAIT_BETWEEN_FETCH_FAILURES = 5 # seconds
 
     def initialize(app)
+      raise "app invalid : #{app}" unless app.is_a? ::FluidFeatures::App
+      configure(app)
+      run_loop
+    end
 
-      raise "app invalid : #{app}" unless app.is_a? FluidFeatures::App
-
+    def configure(app)
       @app = app
       @features = {}
       @features_lock = ::Mutex.new
-
-      run_state_fetcher
-
     end
 
     def features
@@ -54,7 +54,7 @@ module FluidFeatures
       end
     end
 
-    def run_state_fetcher
+    def run_loop
       Thread.new do
         while true
           begin
@@ -105,7 +105,7 @@ module FluidFeatures
       raise "version_name invalid : #{version_name}" unless version_name.is_a? String
 
       #assert(isinstance(user_id, basestring))
-      
+
       user_attributes ||= {}
       user_attributes["user"] = user_id.to_s
       if user_id.is_a? Integer
@@ -122,7 +122,6 @@ module FluidFeatures
       modulus = user_id_hash % feature["num_parts"]
       enabled = version["parts"].include? modulus
 
-      # check attributes
       feature["versions"].each_pair do |other_version_name, other_version|
         if other_version
           version_attributes = (other_version["enabled"] || {})["attributes"]

data/lib/fluidfeatures/app/transaction.rb

@@ -12,7 +12,7 @@ module FluidFeatures
       @url  = url
 
       # take a snap-shot of the features end at
-      # the beginning of the transaction
+      # the beginning of the transactionapplication
       @features = user.features
 
       @features_hit = {}
@@ -99,11 +99,10 @@ module FluidFeatures
     # so that FluidFeatures can auto-populate the dashboard.
     #
     def end_transaction
-
-      raise "transaction already ended" if ended
-      @ended = true
-      @duration = Time.now - start_time
+      raise "transaction ended" if ended
+      @duration = duration #Time.now - start_time
       user.app.reporter.report_transaction(self)
+      @ended = true
     end
 
   end

data/lib/fluidfeatures/app/user.rb

@@ -76,7 +76,7 @@ module FluidFeatures
       end
 
       if ENV["FLUIDFEATURES_USER_FEATURES_FROM_API"]
-        features_enabled = get("/features", attribute_ids) || {}
+        success, features_enabled = get("/features", attribute_ids) || {}
       else
         features_enabled = {}
         app.state.features.each do |feature_name, feature|

data/lib/fluidfeatures/client.rb

@@ -4,6 +4,7 @@ require "persistent_http"
 require "pre_ruby192/uri" if RUBY_VERSION < "1.9.2"
 require "thread"
 require "uuid"
+require "json"
 
 require "fluidfeatures/app"
 
@@ -149,14 +150,14 @@ module FluidFeatures
       success = false
       begin
 
-        request = Net::HTTP::Put.new uri_path
+        request = Net::HTTP::Put.new url_path
         request["Authorization"] = auth_token
         request["Accept"] = "application/json"
         request["Accept-Encoding"] = "gzip"
         encode_request_body(request, payload)
 
         request_start_time = Time.now
-        response = @http.request uri, request
+        response = @http.request request
         duration = Time.now - request_start_time
 
         raise "expected Net::HTTPResponse" if not response.is_a? Net::HTTPResponse

data/lib/fluidfeatures/version.rb

@@ -1,3 +1,3 @@
 module FluidFeatures
-  VERSION = '0.4.1'
+  VERSION = '0.4.4'
 end

data/spec/app/feature_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe FluidFeatures::AppFeatureVersion do
+
+  let(:app) { mock "FluidFeatures::App", client: mock("client", uuid: 'client uuid'), logger: mock('logger') }
+
+  before(:each) do
+    app.stub!(:is_a?).and_return(false)
+    app.stub!(:is_a?).with(FluidFeatures::App).and_return(true)
+  end
+
+  context "initialization" do
+
+    it "should raise error if invalid application passed" do
+      app.stub!(:is_a?).with(FluidFeatures::App).and_return(false)
+      expect { described_class.new(app, "Feature", "a") }.to raise_error /app invalid/
+    end
+
+    it "should raise error if invalid feature name passed" do
+      expect { described_class.new(app, 0, "a") }.to raise_error /feature_name invalid/
+
+    end
+
+    it "should raise error if invalid version name passed" do
+      expect { described_class.new(app, "Feature", 0) }.to raise_error /version_name invalid/
+    end
+
+    it "should use default version name if omitted" do
+      described_class.new(app, "Feature").version_name.should == described_class::DEFAULT_VERSION_NAME
+    end
+
+    it "should initialize instance variables with passed values" do
+      feature = described_class.new(app, "Feature", "a")
+      feature.app.should == app
+      feature.feature_name.should == "Feature"
+      feature.version_name.should == "a"
+    end
+
+  end
+
+  describe "#set_enabled_percent" do
+
+    let(:feature) { described_class.new(app, "Feature", "a") }
+
+    ["50", 120, -12.2, nil].each do |invalid_percent|
+      it "should raise error if '#{invalid_percent}' passed as percentage value" do
+        expect { feature.set_enabled_percent(invalid_percent) }.to raise_error /percent invalid/
+      end
+    end
+
+    it "should update percentage on server" do
+      app.should_receive(:put).with("/feature/Feature/a/enabled/percent", {:enabled=>{:percent=>44}})
+      feature.set_enabled_percent(44)
+    end
+
+  end
+
+end

data/spec/app/reporter_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe FluidFeatures::AppReporter do
+
+  it_should_behave_like "polling loop", :send_transactions do
+    before(:each) { described_class.any_instance.stub(:transactions_queued?).and_return(true) }
+  end
+
+  context do
+
+    let(:reporter) { described_class.new(app) }
+
+    let(:user) { mock('user', unique_id: 'unique id', display_name: 'John Doe', anonymous: false, unique_attrs: [], cohort_attrs: []) }
+
+    let(:transaction) { mock('transaction', url: 'http://example.com/source.html', duration: 999, user: user, unknown_features: [], features_hit: %w[feature], goals_hit: %w[goal]) }
+
+    before(:each) do
+      described_class.any_instance.stub(:run_loop)
+    end
+
+    describe "#report_transaction" do
+
+      before(:each) do
+        reporter.stub!(:queue_transaction_payload)
+        reporter.stub!(:queue_unknown_features)
+      end
+
+      it "should queue transaction payload" do
+        reporter.should_not_receive(:queue_unknown_features)
+        reporter.should_receive(:queue_transaction_payload).with(
+            url: "http://example.com/source.html",
+            user: { id: "unique id", name: "John Doe", unique: [], cohorts: [] },
+            hits: { feature: ["feature"], goal: ["goal"] },
+            stats: { duration: 999 }
+        )
+        reporter.report_transaction(transaction)
+      end
+
+      it "should queue unknown features if any" do
+        transaction.stub!(:unknown_features).and_return(%w[feature])
+        reporter.should_receive(:queue_unknown_features).with(transaction.unknown_features)
+        reporter.report_transaction(transaction)
+      end
+
+    end
+
+    describe "#transactions_queued?" do
+      before(:each) do
+        reporter.configure(app)
+      end
+
+      it "should return false if no transaction queued" do
+        reporter.transactions_queued?.should be_false
+      end
+
+      it "should return true if at least one transaction queued" do
+        reporter.instance_variable_set(:@buckets, %w[bucket])
+        reporter.instance_variable_set(:@current_bucket, %w[payload])
+        reporter.transactions_queued?.should be_true
+      end
+    end
+
+    describe "#queue_transaction_payload" do
+      it "should push transaction payload to current bucket" do
+        reporter.instance_variable_set(:@current_bucket, [])
+        reporter.queue_transaction_payload({ foo: 'bar' })
+        reporter.instance_variable_get(:@current_bucket).should == [{ foo: 'bar' }]
+      end
+
+      it "should create new bucket if current bucket is full" do
+        reporter.instance_variable_set(:@current_bucket, [])
+        current_bucket = reporter.instance_variable_get(:@current_bucket)
+        current_bucket.stub!(:size).and_return(described_class::MAX_BUCKET_SIZE + 1)
+        reporter.should_receive(:new_bucket).and_return([])
+        reporter.queue_transaction_payload({ foo: 'bar' })
+      end
+    end
+
+    describe "#queue_unknown_features" do
+      let(:unknown_features) { { "feature" => { "a" => true } } }
+      it "should add unknown_features to instance variable" do
+        reporter.queue_unknown_features(unknown_features)
+        reporter.instance_variable_get(:@unknown_features).should == unknown_features
+      end
+
+      it "should raise error if unknown_features is not Hash" do
+        expect { reporter.queue_unknown_features("not cool") }.to raise_error /should be a Hash/
+      end
+
+      it "should raise error if versions is not Hash" do
+        expect { reporter.queue_unknown_features("feature" => "not cool") }.to raise_error /should be a Hash/
+      end
+
+    end
+
+    describe "#send_transactions" do
+      let(:unknown_features) { { "feature" => { "a" => true } } }
+      let(:app) { mock "FluidFeatures::App", client: mock("client", uuid: 'client uuid'), logger: mock('logger') }
+
+      before(:each) do
+        app.stub!(:is_a?).and_return(false)
+        app.stub!(:is_a?).with(FluidFeatures::App).and_return(true)
+        app.client.stub(:siphon_api_request_log).and_return("api log")
+        app.stub!(:post)
+        reporter.stub(:remove_bucket).and_return(["transactions"])
+        reporter.instance_variable_set(:@unknown_features, unknown_features)
+        reporter.instance_variable_set(:@buckets, [%w[one], %w[one two]])
+      end
+
+      it "should send transaction to server" do
+        app.should_receive(:post).with("/report/transactions", :client_uuid=>"client uuid", :transactions=>["transactions"], :stats=>{:waiting_buckets=>[1, 2]}, :unknown_features=>{"feature"=>{"a"=>true}}, :api_request_log=>"api log").and_return(true)
+        reporter.send_transactions
+      end
+
+      it "should emit warning and queue unknown features on failure" do
+        app.stub!(:post).and_return(false)
+        reporter.stub!(:unremove_bucket).and_return(false)
+        app.logger.should_receive(:warn)
+        reporter.should_receive(:queue_unknown_features).with(unknown_features)
+        reporter.send_transactions
+      end
+
+    end
+
+  end
+
+end