ablaevent-ruby 2.3.0

data/lib/posthog/message_batch.rb

@@ -0,0 +1,71 @@
+require 'forwardable'
+require 'posthog/logging'
+
+class PostHog
+  # A batch of `Message`s to be sent to the API
+  class MessageBatch
+    class JSONGenerationError < StandardError
+    end
+
+    extend Forwardable
+    include PostHog::Logging
+    include PostHog::Defaults::MessageBatch
+
+    def initialize(max_message_count)
+      @messages = []
+      @max_message_count = max_message_count
+      @json_size = 0
+    end
+
+    def <<(message)
+      begin
+        message_json = message.to_json
+      rescue StandardError => e
+        raise JSONGenerationError, "Serialization error: #{e}"
+      end
+
+      message_json_size = message_json.bytesize
+      if message_too_big?(message_json_size)
+        logger.error('a message exceeded the maximum allowed size')
+      else
+        @messages << message
+        @json_size += message_json_size + 1 # One byte for the comma
+      end
+    end
+
+    def full?
+      item_count_exhausted? || size_exhausted?
+    end
+
+    def clear
+      @messages.clear
+      @json_size = 0
+    end
+
+    def_delegators :@messages, :to_json
+    def_delegators :@messages, :empty?
+    def_delegators :@messages, :length
+
+    private
+
+    def item_count_exhausted?
+      @messages.length >= @max_message_count
+    end
+
+    def message_too_big?(message_json_size)
+      message_json_size > Defaults::Message::MAX_BYTES
+    end
+
+    # We consider the max size here as just enough to leave room for one more
+    # message of the largest size possible. This is a shortcut that allows us
+    # to use a native Ruby `Queue` that doesn't allow peeking. The tradeoff
+    # here is that we might fit in less messages than possible into a batch.
+    #
+    # The alternative is to use our own `Queue` implementation that allows
+    # peeking, and to consider the next message size when calculating whether
+    # the message can be accomodated in this batch.
+    def size_exhausted?
+      @json_size >= (MAX_BYTES - Defaults::Message::MAX_BYTES)
+    end
+  end
+end

data/lib/posthog/noop_worker.rb

@@ -0,0 +1,16 @@
+# A worker that doesn't consume jobs
+class PostHog
+  class NoopWorker
+    def initialize(queue)
+      @queue = queue
+    end
+
+    def run
+      # Does nothing
+    end
+
+    def is_requesting?
+      false
+    end
+  end
+end

data/lib/posthog/response.rb

@@ -0,0 +1,13 @@
+class PostHog
+  class Response
+    attr_reader :status, :error
+
+    # public: Simple class to wrap responses from the API
+    #
+    #
+    def initialize(status = 200, error = nil)
+      @status = status
+      @error = error
+    end
+  end
+end

data/lib/posthog/send_worker.rb

@@ -0,0 +1,67 @@
+require 'posthog/defaults'
+require 'posthog/message_batch'
+require 'posthog/transport'
+require 'posthog/utils'
+
+class PostHog
+  class SendWorker
+    include PostHog::Utils
+    include PostHog::Defaults
+    include PostHog::Logging
+
+    # public: Creates a new worker
+    #
+    # The worker continuously takes messages off the queue
+    # and makes requests to the posthog.com api
+    #
+    # queue   - Queue synchronized between client and worker
+    # api_key  - String of the project's API key
+    # options - Hash of worker options
+    #           batch_size - Fixnum of how many items to send in a batch
+    #           on_error   - Proc of what to do on an error
+    #
+    def initialize(queue, api_key, options = {})
+      symbolize_keys! options
+      @queue = queue
+      @api_key = api_key
+      @on_error = options[:on_error] || proc { |status, error| }
+      batch_size = options[:batch_size] || Defaults::MessageBatch::MAX_SIZE
+      @batch = MessageBatch.new(batch_size)
+      @lock = Mutex.new
+      @transport = Transport.new api_host: options[:host], skip_ssl_verification: options[:skip_ssl_verification]
+    end
+
+    # public: Continuously runs the loop to check for new events
+    #
+    def run
+      until Thread.current[:should_exit]
+        return if @queue.empty?
+
+        @lock.synchronize do
+          consume_message_from_queue! until @batch.full? || @queue.empty?
+        end
+
+        res = @transport.send @api_key, @batch
+        @on_error.call(res.status, res.error) unless res.status == 200
+
+        @lock.synchronize { @batch.clear }
+      end
+    ensure
+      @transport.shutdown
+    end
+
+    # public: Check whether we have outstanding requests.
+    #
+    def is_requesting?
+      @lock.synchronize { !@batch.empty? }
+    end
+
+    private
+
+    def consume_message_from_queue!
+      @batch << @queue.pop
+    rescue MessageBatch::JSONGenerationError => e
+      @on_error.call(-1, e.to_s)
+    end
+  end
+end

data/lib/posthog/transport.rb

@@ -0,0 +1,144 @@
+require 'posthog/defaults'
+require 'posthog/utils'
+require 'posthog/response'
+require 'posthog/logging'
+require 'posthog/backoff_policy'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+class PostHog
+  class Transport
+    include PostHog::Defaults::Request
+    include PostHog::Utils
+    include PostHog::Logging
+
+    def initialize(options = {})
+      if options[:api_host]
+        uri = URI.parse(options[:api_host])
+        options[:host] = uri.host
+        options[:ssl] = uri.scheme == 'https'
+        options[:port] = uri.port
+      end
+
+      options[:host] = !options[:host].nil? ? options[:host] : HOST
+      options[:port] = !options[:port].nil? ? options[:port] : PORT
+      options[:ssl] = !options[:ssl].nil? ? options[:ssl] : SSL
+      
+      @headers = options[:headers] || HEADERS
+      @path = options[:path] || PATH
+      @retries = options[:retries] || RETRIES
+      @backoff_policy = options[:backoff_policy] || PostHog::BackoffPolicy.new
+
+      http = Net::HTTP.new(options[:host], options[:port])
+      http.use_ssl = options[:ssl]
+      http.read_timeout = 8
+      http.open_timeout = 4
+      if options[:skip_ssl_verification]
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      @http = http
+    end
+
+    # Sends a batch of messages to the API
+    #
+    # @return [Response] API response
+    def send(api_key, batch)
+      logger.debug("Sending request for #{batch.length} items")
+
+      last_response, exception =
+        retry_with_backoff(@retries) do
+          status_code, body = send_request(api_key, batch)
+          error = JSON.parse(body)['error']
+          should_retry = should_retry_request?(status_code, body)
+          logger.debug("Response status code: #{status_code}")
+          logger.debug("Response error: #{error}") if error
+
+          [Response.new(status_code, error), should_retry]
+        end
+
+      if exception
+        logger.error(exception.message)
+        exception.backtrace.each { |line| logger.error(line) }
+        Response.new(-1, exception.to_s)
+      else
+        last_response
+      end
+    end
+
+    # Closes a persistent connection if it exists
+    def shutdown
+      @http.finish if @http.started?
+    end
+
+    private
+
+    def should_retry_request?(status_code, body)
+      if status_code >= 500
+        true # Server error
+      elsif status_code == 429
+        true # Rate limited
+      elsif status_code >= 400
+        logger.error(body)
+        false # Client error. Do not retry, but log
+      else
+        false
+      end
+    end
+
+    # Takes a block that returns [result, should_retry].
+    #
+    # Retries upto `retries_remaining` times, if `should_retry` is false or
+    # an exception is raised. `@backoff_policy` is used to determine the
+    # duration to sleep between attempts
+    #
+    # Returns [last_result, raised_exception]
+    def retry_with_backoff(retries_remaining, &block)
+      result, caught_exception = nil
+      should_retry = false
+
+      begin
+        result, should_retry = yield
+        return result, nil unless should_retry
+      rescue StandardError => e
+        should_retry = true
+        caught_exception = e
+      end
+
+      if should_retry && (retries_remaining > 1)
+        logger.debug("Retrying request, #{retries_remaining} retries left")
+        sleep(@backoff_policy.next_interval.to_f / 1000)
+        retry_with_backoff(retries_remaining - 1, &block)
+      else
+        [result, caught_exception]
+      end
+    end
+
+    # Sends a request for the batch, returns [status_code, body]
+    def send_request(api_key, batch)
+      payload = JSON.generate(api_key: api_key, batch: batch)
+
+      request = Net::HTTP::Post.new(@path, @headers)
+
+      if self.class.stub
+        logger.debug "stubbed request to #{@path}: " \
+                       "api key = #{api_key}, batch = #{JSON.generate(batch)}"
+
+        [200, '{}']
+      else
+        @http.start unless @http.started? # Maintain a persistent connection
+        response = @http.request(request, payload)
+        [response.code.to_i, response.body]
+      end
+    end
+
+    class << self
+      attr_writer :stub
+
+      def stub
+        @stub || ENV['STUB']
+      end
+    end
+  end
+end

data/lib/posthog/utils.rb

@@ -0,0 +1,132 @@
+require 'securerandom'
+
+class PostHog
+
+  class InconclusiveMatchError < StandardError
+  end
+
+  module Utils
+    extend self
+
+    # public: Return a new hash with keys converted from strings to symbols
+    #
+    def symbolize_keys(hash)
+      hash.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v }
+    end
+
+    # public: Convert hash keys from strings to symbols in place
+    #
+    def symbolize_keys!(hash)
+      hash.replace symbolize_keys hash
+    end
+
+    # public: Return a new hash with keys as strings
+    #
+    def stringify_keys(hash)
+      hash.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v }
+    end
+
+    # public: Returns a new hash with all the date values in the into iso8601
+    #         strings
+    #
+    def isoify_dates(hash)
+      hash.each_with_object({}) do |(k, v), memo|
+        memo[k] = datetime_in_iso8601(v)
+      end
+    end
+
+    # public: Converts all the date values in the into iso8601 strings in place
+    #
+    def isoify_dates!(hash)
+      hash.replace isoify_dates hash
+    end
+
+    # public: Returns a uid string
+    #
+    def uid
+      arr = SecureRandom.random_bytes(16).unpack('NnnnnN')
+      arr[2] = (arr[2] & 0x0fff) | 0x4000
+      arr[3] = (arr[3] & 0x3fff) | 0x8000
+      '%08x-%04x-%04x-%04x-%04x%08x' % arr
+    end
+
+    def datetime_in_iso8601(datetime)
+      case datetime
+      when Time
+        time_in_iso8601 datetime
+      when DateTime
+        time_in_iso8601 datetime.to_time
+      when Date
+        date_in_iso8601 datetime
+      else
+        datetime
+      end
+    end
+
+    def time_in_iso8601(time, fraction_digits = 3)
+      fraction =
+        (('.%06i' % time.usec)[0, fraction_digits + 1] if fraction_digits > 0)
+
+      "#{time.strftime('%Y-%m-%dT%H:%M:%S')}#{fraction}#{formatted_offset(time, true, 'Z')}"
+    end
+
+    def date_in_iso8601(date)
+      date.strftime('%F')
+    end
+
+    def formatted_offset(time, colon = true, alternate_utc_string = nil)
+      time.utc? && alternate_utc_string ||
+        seconds_to_utc_offset(time.utc_offset, colon)
+    end
+
+    def seconds_to_utc_offset(seconds, colon = true)
+      (colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON) % [
+        (seconds < 0 ? '-' : '+'),
+        (seconds.abs / 3600),
+        ((seconds.abs % 3600) / 60)
+      ]
+    end
+
+    def convert_to_datetime(value)
+      if value.respond_to?(:strftime)
+        parsed_date = value
+        return parsed_date
+      elsif value.respond_to?(:to_str)
+        begin
+          parsed_date = DateTime.parse(value)
+          return parsed_date
+        rescue ArgumentError => e
+          raise InconclusiveMatchError.new("#{value} is not in a valid date format")
+        end
+      else
+        raise InconclusiveMatchError.new("The date provided must be a string or date object")
+      end
+    end
+
+    UTC_OFFSET_WITH_COLON = '%s%02d:%02d'
+    UTC_OFFSET_WITHOUT_COLON = UTC_OFFSET_WITH_COLON.sub(':', '')
+
+    def is_valid_regex(regex)
+      begin
+        Regexp.new(regex)
+        return true
+      rescue RegexpError
+        return false
+      end
+    end
+
+    class SizeLimitedHash < Hash
+      def initialize(max_length, *args, &block)
+        super(*args, &block)
+        @max_length = max_length
+      end
+
+      def []=(key, value)
+        if length >= @max_length
+          clear
+        end
+        super
+      end
+    end
+  end
+end

data/lib/posthog/version.rb

@@ -0,0 +1,3 @@
+class PostHog
+  VERSION = '2.3.0'
+end

data/lib/posthog-ruby.rb

@@ -0,0 +1 @@
+require 'posthog'

data/lib/posthog.rb

@@ -0,0 +1,9 @@
+require 'posthog/version'
+require 'posthog/defaults'
+require 'posthog/utils'
+require 'posthog/field_parser'
+require 'posthog/client'
+require 'posthog/send_worker'
+require 'posthog/transport'
+require 'posthog/response'
+require 'posthog/logging'

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: ablaevent-ruby
+version: !ruby/object:Gem::Version
+  version: 2.3.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.11
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+description: The PostHog ruby library
+email: hey@posthog.com
+executables:
+- posthog
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/posthog
+- lib/posthog-ruby.rb
+- lib/posthog.rb
+- 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
+- lib/posthog/noop_worker.rb
+- lib/posthog/response.rb
+- lib/posthog/send_worker.rb
+- lib/posthog/transport.rb
+- lib/posthog/utils.rb
+- lib/posthog/version.rb
+homepage: https://github.com/AblaAnalytics/ablaevent-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: PostHog library
+test_files: []