fluidfeatures 0.3.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.swp
+.bundle
+Gemfile.lock
+pkg/*
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fluidfeatures.gemspec
+gemspec

data/README.md

@@ -0,0 +1,7 @@
+[![Build Status](https://secure.travis-ci.org/FluidFeatures/fluidfeatures-ruby.png)](http://travis-ci.org/FluidFeatures/fluidfeatures-ruby)
+
+fluidfeatures-ruby
+===================
+
+Ruby client for API of FluidFeatures.com
+

data/fluidfeatures.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fluidfeatures/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fluidfeatures"
+  s.version     = FluidFeatures::VERSION
+  s.authors     = ["Phil Whelan"]
+  s.email       = ["phil@fluidfeatures.com"]
+  s.homepage    = "https://github.com/FluidFeatures/fluidfeatures-ruby"
+  s.summary     = %q{Ruby client for the FluidFeatures service.}
+  s.description = %q{Ruby client for the FluidFeatures service.}
+  s.rubyforge_project = s.name
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.add_dependency "persistent_http", "~>1.0.3"
+end

data/lib/fluidfeatures/client.rb

@@ -0,0 +1,207 @@
+
+require "logger"
+
+if RUBY_VERSION < "1.9.2"
+  require "pre_ruby192/uri"
+end
+
+module FluidFeatures
+  class Client
+
+    attr_accessor :logger
+
+    def initialize(base_uri, app_id, secret, options={})
+
+      @logger = options[:logger] || ::Logger.new(STDERR)
+
+      @baseuri = base_uri
+      @app_id = app_id
+      @secret = secret
+
+      @http = PersistentHTTP.new(
+        :name         => 'fluidfeatures',
+        :logger       => @logger,
+        :pool_size    => 10,
+        :warn_timeout => 0.25,
+        :force_retry  => true,
+        :url          => @baseuri
+      )
+
+      @unknown_features = {}
+      @last_fetch_duration = nil
+
+    end
+
+    #
+    # This can be used to control how much of your user-base sees a
+    # particular feature. It may be easier to use the dashboard provided
+    # at https://www.fluidfeatures.com/dashboard to manage this, or to
+    # set timers to automate the gradual rollout of your new features.
+    #
+    def feature_set_enabled_percent(feature_name, enabled_percent)
+      begin
+        uri = URI(@baseuri + "/app/" + @app_id.to_s + "/features/" + feature_name.to_s)
+        request = Net::HTTP::Put.new uri.path
+        request["Content-Type"] = "application/json"
+        request["Accept"] = "application/json"
+        request['AUTHORIZATION'] = @secret
+        payload = {
+          :enabled => {
+            :percent => enabled_percent
+          }
+        }
+        request.body = JSON.dump(payload)
+        response = @http.request uri, request
+        if response.is_a?(Net::HTTPSuccess)
+          logger.error{"[FF] [" + response.code.to_s + "] Failed to set feature enabled percent : " + uri.to_s + " : " + response.body.to_s}
+        end
+      rescue
+        logger.error{"[FF] Request to set feature enabled percent failed : " + uri.to_s}
+        raise
+      end
+    end
+
+    #
+    # Returns all the features that FluidFeatures knows about for
+    # your application. The enabled percentage (how much of your user-base)
+    # sees each feature is also provided.
+    #
+    def get_feature_set
+      features = nil
+      begin
+        uri = URI(@baseuri + "/app/" + @app_id.to_s + "/features")
+        request = Net::HTTP::Get.new uri.path
+        request["Accept"] = "application/json"
+        request['AUTHORIZATION'] = @secret
+        response = @http.request request
+        if response.is_a?(Net::HTTPSuccess)
+          features = JSON.parse(response.body)
+        end
+      rescue
+        logger.error{"[FF] Request failed when getting feature set from " + uri.to_s}
+        raise
+      end
+      if not features
+        logger.error{"[FF] Empty feature set returned from " + uri.to_s}
+      end
+      features
+    end
+
+    #
+    # Returns all the features enabled for a specific user.
+    # This will depend on the user_id and how many users each
+    # feature is enabled for.
+    #
+    def get_user_features(user)
+      logger.debug{"[FF] get_user_features #{user}"}
+      if not user
+        raise "user object should be a Hash"
+      end
+      if not user[:id]
+        raise "user does not contain :id field"
+      end
+
+      # extract just attribute ids into simple hash
+      attribute_ids = {
+        :anonymous => !!user[:anonymous]
+      }
+      [:unique, :cohorts].each do |attr_type|
+        if user.has_key? attr_type
+          user[attr_type].each do |attr_key, attr|
+            if attr.is_a? Hash
+              if attr.has_key? :id
+                attribute_ids[attr_key] = attr[:id]
+              end
+            else
+              attribute_ids[attr_key] = attr
+            end
+          end
+        end
+      end
+
+      # normalize attributes ids as strings
+      attribute_ids.each do |attr_key, attr_id|
+        if attr_id.is_a? FalseClass or attr_id.is_a? TrueClass
+          attribute_ids[attr_key] = attr_id.to_s.downcase
+        elsif not attr_id.is_a? String
+          attribute_ids[attr_key] = attr_id.to_s
+        end
+      end
+
+      features = {}
+      fetch_start_time = Time.now
+      begin
+        uri = URI("#{@baseuri}/app/#{@app_id}/user/#{user[:id]}/features")
+        uri.query = URI.encode_www_form( attribute_ids )
+        url_path = uri.path
+        if uri.query
+          url_path += "?" + uri.query
+        end
+        request = Net::HTTP::Get.new url_path
+        request["Accept"] = "application/json"
+        request['AUTHORIZATION'] = @secret
+        response = @http.request request
+        if response.is_a?(Net::HTTPSuccess)
+          features = JSON.parse(response.body)
+        else
+          logger.error{"[FF] [#{response.code}] Failed to get user features : #{uri} : #{response.body}"}
+        end
+      rescue
+        logger.error{"[FF] Request to get user features failed : #{uri}"}
+        raise
+      end
+      @last_fetch_duration = Time.now - fetch_start_time
+      features
+    end
+    
+    #
+    # This is called when we encounter a feature_name that
+    # FluidFeatures has no record of for your application.
+    # This will be reported back to the FluidFeatures service so
+    # that it can populate your dashboard with this feature.
+    # The parameter "default_enabled" is a boolean that says whether
+    # this feature should be enabled to all users or no users.
+    # Usually, this is "true" for existing features that you are
+    # planning to phase out and "false" for new feature that you
+    # intend to phase in.
+    #
+    def unknown_feature_hit(feature_name, version_name, defaults)
+      if not @unknown_features[feature_name]
+        @unknown_features[feature_name] = { :versions => {} }
+      end
+      @unknown_features[feature_name][:versions][version_name] = defaults
+    end
+    
+    #
+    # This reports back to FluidFeatures which features we
+    # encountered during this request, the request duration,
+    # and statistics on time spent talking to the FluidFeatures
+    # service. Any new features encountered will also be reported
+    # back with the default_enabled status (see unknown_feature_hit)
+    # so that FluidFeatures can auto-populate the dashboard.
+    #
+    def log_request(user_id, payload)
+      begin
+        (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
+        request.body = JSON.dump(payload)
+        response = @http.request request
+        unless response.is_a?(Net::HTTPSuccess)
+          logger.error{"[FF] [" + response.code.to_s + "] Failed to log features hit : " + uri.to_s + " : " + response.body.to_s}
+        end
+      rescue Exception => e
+        logger.error{"[FF] Request to log user features hit failed : " + uri.to_s}
+        raise
+      end
+    end
+
+  end
+end

data/lib/fluidfeatures/version.rb

@@ -0,0 +1,3 @@
+module FluidFeatures
+  VERSION = '0.3.0'
+end

data/lib/pre_ruby192/uri.rb

@@ -0,0 +1,120 @@
+
+# https://bitbucket.org/ged/ruby-axis/raw/ef212387adcbd567a39fa0d51eb6dc6051c416bf/lib/axis/monkeypatches.rb
+
+# Backport of Ruby 1.9.2 URI methods to 1.8.7.
+module URIFormEncoding
+
+    TBLENCWWWCOMP_ = {} # :nodoc:
+    TBLDECWWWCOMP_ = {} # :nodoc:
+
+
+    # Encode given +str+ to URL-encoded form data.
+    #
+    # This doesn't convert *, -, ., 0-9, A-Z, _, a-z,
+    # does convert SP to +, and convert others to %XX.
+    #
+    # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+    #
+    # See URI.decode_www_form_component, URI.encode_www_form
+    def encode_www_form_component( str )
+        if TBLENCWWWCOMP_.empty?
+            256.times do |i|
+                TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+            end
+            TBLENCWWWCOMP_[' '] = '+'
+            TBLENCWWWCOMP_.freeze
+        end
+        return str.to_s.gsub(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_)
+    end
+
+    # Decode given +str+ of URL-encoded form data.
+    #
+    # This decodes + to SP.
+    #
+    # See URI.encode_www_form_component, URI.decode_www_form
+    def decode_www_form_component( str )
+        if TBLDECWWWCOMP_.empty?
+            256.times do |i|
+                h, l = i>>4, i&15
+                TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+                TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+                TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+                TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+            end
+            TBLDECWWWCOMP_['+'] = ' '
+            TBLDECWWWCOMP_.freeze
+        end
+        raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%\h\h|[^%]+)*\z/ =~ str
+        return str.gsub( /\+|%\h\h/, TBLDECWWWCOMP_ )
+    end
+
+    # Generate URL-encoded form data from given +enum+.
+    #
+    # This generates application/x-www-form-urlencoded data defined in HTML5
+    # from given an Enumerable object.
+    #
+    # This internally uses URI.encode_www_form_component(str).
+    #
+    # This doesn't convert encodings of give items, so convert them before call
+    # this method if you want to send data as other than original encoding or
+    # mixed encoding data. (strings which is encoded in HTML5 ASCII incompatible
+    # encoding is converted to UTF-8)
+    #
+    # This doesn't treat files. When you send a file, use multipart/form-data.
+    #
+    # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+    #
+    # See URI.encode_www_form_component, URI.decode_www_form
+    def encode_www_form( enum )
+        str = nil
+        enum.each do |k,v|
+            if str
+                str << '&'
+            else
+                str = nil.to_s
+            end
+            str << encode_www_form_component(k)
+            str << '='
+            str << encode_www_form_component(v)
+        end
+        str
+    end
+
+    WFKV_ = '(?:%\h\h|[^%#=;&])' # :nodoc:
+
+    # Decode URL-encoded form data from given +str+.
+    #
+    # This decodes application/x-www-form-urlencoded data
+    # and returns array of key-value array.
+    # This internally uses URI.decode_www_form_component.
+    #
+    # This refers http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+    #
+    # ary = URI.decode_www_form("a=1&a=2&b=3")
+    # p ary                  #=> [['a', '1'], ['a', '2'], ['b', '3']]
+    # p ary.assoc('a').last  #=> '1'
+    # p ary.assoc('b').last  #=> '3'
+    # p ary.rassoc('a').last #=> '2'
+    # p Hash[ary]            # => {"a"=>"2", "b"=>"3"}
+    #
+    # See URI.decode_www_form_component, URI.encode_www_form
+    def decode_www_form( str )
+        return [] if str.empty?
+        unless /\A#{WFKV_}*=#{WFKV_}*(?:[;&]#{WFKV_}*=#{WFKV_}*)*\z/o =~ str
+            raise ArgumentError, "invalid data of application/x-www-form-urlencoded (#{str})"
+        end
+        ary = []
+        $&.scan(/([^=;&]+)=([^;&]*)/) do
+            ary << [decode_www_form_component($1, enc), decode_www_form_component($2, enc)]
+        end
+        ary
+    end
+
+end
+
+
+unless URI.methods.include?( :encode_www_form )
+    URI.extend( URIFormEncoding )
+end
+
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: fluidfeatures
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Phil Whelan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: persistent_http
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: Ruby client for the FluidFeatures service.
+email:
+- phil@fluidfeatures.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- fluidfeatures.gemspec
+- lib/fluidfeatures/client.rb
+- lib/fluidfeatures/version.rb
+- lib/pre_ruby192/uri.rb
+homepage: https://github.com/FluidFeatures/fluidfeatures-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: fluidfeatures
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby client for the FluidFeatures service.
+test_files: []