posthog-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a418b6727a9730ad159789d9b6fdb7b9df4b680fbb9e6d4a5e4ee3d05fa52e6
-  data.tar.gz: 978744c42354807116a2a59e8dafe673cb939fea688d388f6090d877bb64ed31
+  metadata.gz: b45334d5c62eb513540ccc0b292e2b29b097785a50e53527f33ae0b6a81abc1e
+  data.tar.gz: 3bba8055756830eeb52cd8fc8c53c4a994b452b665929d4e487324d0ac94b5a1
 SHA512:
-  metadata.gz: 8a44e8cc2f0ce02e3a44f5cf61f5e6b291233a91e79dc89eb6eaa8e07fea4d42174802b694d5a52c76ec81c5825a12728fae7c4020470eb9faf271e7c0b9c4f9
-  data.tar.gz: 8f5a14c51e7130bac3aa58ea644ae45d2ed44c5ff045413c574af15a5fcbbefee751a840c1b3fcdb61d0eef8af1ce689f6f5e019c18fbb3cea3107a08e3d6b20
+  metadata.gz: 94977f7338a9859aed6e556d77aa98ff9d04a0a70edd8104e3917166f7428600fa46c78a19ae21c38fc2522b413342ef0af6801f365cf95e7f1d245fc802fc93
+  data.tar.gz: 8edc603d8a4e59339538b9f52d4c73177888393e3a6abd3c6063eb9a9f46d039a3dde88185be325dbbf6e894b2f880de1b047d9706c8e4a3533d567b14fa0fbf

data/lib/posthog/client.rb

@@ -5,6 +5,8 @@ require 'posthog/defaults'
 require 'posthog/logging'
 require 'posthog/utils'
 require 'posthog/worker'
+require 'posthog/feature_flags'
+
 
 class PostHog
   class Client
@@ -25,12 +27,21 @@ class PostHog
       @worker_mutex = Mutex.new
       @worker = Worker.new(@queue, @api_key, opts)
       @worker_thread = nil
+      @feature_flags_poller = nil
+      @personal_api_key = nil
 
       check_api_key!
 
+      if opts[:personal_api_key].present?
+        @personal_api_key = opts[:personal_api_key]
+        @feature_flags_poller = FeatureFlagsPoller.new(opts[:feature_flags_polling_interval], opts[:personal_api_key], @api_key, opts[:host])
+      end
+
+
       at_exit { @worker_thread && @worker_thread[:should_exit] = true }
     end
 
+    
     # Synchronously waits until the worker has flushed the queue.
     #
     # Use only for scripts which are not long-running, and will specifically
@@ -87,6 +98,36 @@ class PostHog
       @queue.length
     end
 
+    def is_feature_enabled(flag_key, distinct_id, default_value=false)
+      unless @personal_api_key
+        logger.error('You need to specify a personal_api_key to use feature flags')
+        return
+      end
+      is_enabled = @feature_flags_poller.is_feature_enabled(flag_key, distinct_id, default_value)
+      capture({
+           'distinct_id': distinct_id,
+           'event': '$feature_flag_called',
+           'properties': {
+               '$feature_flag': flag_key,
+               '$feature_flag_response': is_enabled
+           }
+       })
+       return is_enabled
+    end
+
+    def reload_feature_flags
+      unless @personal_api_key
+        logger.error('You need to specify a personal_api_key to use feature flags')
+        return
+      end
+      @feature_flags_poller.load_feature_flags(true)
+    end
+
+    def shutdown
+      @feature_flags_poller.shutdown_poller
+      flush
+    end
+
     private
 
     # private: Enqueues the action.

data/lib/posthog/feature_flags.rb

@@ -0,0 +1,123 @@
+require 'concurrent'
+require 'net/http'
+require 'json'
+require 'posthog/version'
+require 'posthog/logging'
+require 'digest'
+class PostHog
+    class FeatureFlagsPoller
+      include PostHog::Logging
+
+      def initialize(polling_interval, personal_api_key, project_api_key, host)
+        @polling_interval = polling_interval || 60 * 5
+        @personal_api_key = personal_api_key
+        @project_api_key = project_api_key 
+        @host = host || 'app.posthog.com'
+        @feature_flags = Concurrent::Array.new
+        @loaded_flags_successfully_once = Concurrent::AtomicBoolean.new
+
+
+        @task = Concurrent::TimerTask.new(execution_interval: polling_interval, timeout_interval: 15) do
+            _load_feature_flags
+        end
+
+        # load once before timer
+        load_feature_flags
+        @task.execute
+      end
+
+
+      def is_feature_enabled(key, distinct_id, default_result = false)
+        # make sure they're loaded on first run
+        load_feature_flags
+
+
+        unless @loaded_flags_successfully_once
+          return default_result
+        end
+
+        feature_flag = nil
+
+        # puts @feature_flags
+
+        @feature_flags.each do |flag|
+          if key == flag['key']
+            feature_flag = flag
+            break
+          end
+        end
+
+        if !feature_flag
+          return default_result
+        end
+
+        flag_rollout_pctg = feature_flag['rollout_percentage'] ? feature_flag['rollout_percentage'] : 100
+        if feature_flag['is_simple_flag']
+          return is_simple_flag_enabled(key, distinct_id, flag_rollout_pctg)
+        else
+          data = { 'distinct_id' => distinct_id }
+          res = _request('POST', 'decide', false, data)
+          return res['featureFlags'].include? key
+        end
+
+        return false
+      end
+
+      def is_simple_flag_enabled(key, distinct_id, rollout_percentage)
+        hash = Digest::SHA1.hexdigest "#{key}.#{distinct_id}"
+        return (Integer(hash[0..14], 16).to_f / 0xfffffffffffffff) <= (rollout_percentage / 100)
+      end
+
+      def load_feature_flags(force_reload = false)
+        if @loaded_flags_successfully_once.false? || force_reload
+          _load_feature_flags
+        end
+        
+      end
+
+      def shutdown_poller()
+        @task.shutdown
+      end
+
+      private
+
+      def _load_feature_flags()
+        res = _request('GET', 'api/feature_flag', true)
+        @feature_flags.clear
+        @feature_flags = res['results'].filter { |flag| flag['active'] }
+        if @loaded_flags_successfully_once.false?
+          @loaded_flags_successfully_once.make_true
+        end
+      end
+
+      def _request(method, endpoint, use_personal_api_key = false, data = {})
+        uri = URI("https://#{@host}/#{endpoint}/?token=#{@project_api_key}")
+        req = nil
+        if use_personal_api_key
+          req = Net::HTTP::Get.new(uri)
+          req['Authorization'] = "Bearer #{@personal_api_key}"
+        else
+          req = Net::HTTP::Post.new(uri)
+          req['Content-Type'] = 'application/json'
+          data['token'] = @project_api_key
+          req.body = data.to_json
+        end
+
+        req['User-Agent'] = "posthog-ruby#{PostHog::VERSION}"
+
+        begin
+          res_body = nil
+          res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => true) do |http|
+            res = http.request(req)
+            res_body = JSON.parse(res.body)
+            return res_body
+          end
+        rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+          logger.debug("Unable to complete request to #{uri}")
+          throw e
+        end
+      end
+
+    end
+  end
+  

data/lib/posthog/version.rb

@@ -1,3 +1,3 @@
 class PostHog
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -135,6 +135,7 @@ files:
 - lib/posthog/backoff_policy.rb
 - lib/posthog/client.rb
 - lib/posthog/defaults.rb
+- lib/posthog/feature_flags.rb
 - lib/posthog/field_parser.rb
 - lib/posthog/logging.rb
 - lib/posthog/message_batch.rb