brow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f08f2a47a1034332966c9ef42acdecc5629052fd8255857a61cdaa8483be502
+  data.tar.gz: f42dac7bdfe22a48b7e7d5e0ef5ecb91407505f9ef0fb91393a263b194a8845c
+SHA512:
+  metadata.gz: abb687ce5fe388f7c87826752255ff1227dd275365ed599d3e78519f1402a2bf4a6010e9f6da307f8f7265be8a69e6f26baea43e30b7bd9adc2cd9f3253ca447
+  data.tar.gz: 57722a879c3fa49461ffbf8334a5674333fce12bb30dc2037b7dcb09f65d3e2335e57d4abb47359a7ed2b032154e1e9494e92c3a5f1a9e00a99cd0627feb1488

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-10-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "minitest-heat", "~> 0.0"
+gem "webmock", "~> 3.10.0"
+
+group(:guard) do
+  gem "guard", "~> 2.18.0"
+  gem "guard-minitest", "~> 2.4.6"
+  gem "guard-bundler", "~> 3.0.0"
+  gem "rb-fsevent", "~> 0.10"
+end

data/Guardfile

@@ -0,0 +1,54 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 John Nunemaker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Brow
+
+A generic background thread worker for shipping events via https to some API backend.
+
+I've been wanting to build something like this for a while. This might be a terrible start. But its a start.
+
+I noticed a lot of companies copied segment's [analytics-ruby](https://github.com/segmentio/analytics-ruby) project and are using it successfully.
+
+So that's where I began. Seems safe to assume that project has been around long enough and is production hardened enough. I guess I'll find out. :)
+
+Things around here are pretty basic for now. But I'm looking to spruce it up and production test it over the coming months — likely with [Flipper](https://github.com/jnunemaker/flipper) and [Flipper Cloud](https://www.flippercloud.io/?utm_source=brow&utm_medium=web&utm_campaign=readme).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brow'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install brow
+
+## Usage
+
+```ruby
+require "brow"
+
+client = Brow::Client.new({
+  url: "https://requestbin.net/r/rna67for",
+})
+
+50.times do |n|
+  client.record({
+    number: n,
+    now: Time.now.utc,
+  })
+end
+
+# batch of 50 events sent to api url above as json
+client.flush
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jnunemaker/brow.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "brow"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/basic.rb

@@ -0,0 +1,14 @@
+require_relative "../lib/brow"
+
+client = Brow::Client.new({
+  url: "https://requestbin.net/r/rna67for",
+})
+
+50.times do |n|
+  client.record({
+    number: n,
+    now: Time.now.utc,
+  })
+end
+
+client.flush

data/lib/brow/backoff_policy.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Brow
+  class BackoffPolicy
+    # Private: The default minimum timeout between intervals in milliseconds.
+    MIN_TIMEOUT_MS = 100
+
+    # Private: The default maximum timeout between intervals in milliseconds.
+    MAX_TIMEOUT_MS = 10000
+
+    # Private: The value to multiply the current interval with for each
+    # retry attempt.
+    MULTIPLIER = 1.5
+
+    # Private: The randomization factor to use to create a range around the
+    # retry interval.
+    RANDOMIZATION_FACTOR = 0.5
+
+    # Public: Create new instance of backoff policy.
+    #
+    # options - The Hash of options.
+    #   :min_timeout_ms - The minimum backoff timeout.
+    #   :max_timeout_ms - The maximum backoff timeout.
+    #   :multiplier - The value to multiply the current interval with for each
+    #                 retry attempt.
+    #   :randomization_factor - The randomization factor to use to create a range
+    #                           around the retry interval.
+    def initialize(options = {})
+      @min_timeout_ms = options[:min_timeout_ms] || MIN_TIMEOUT_MS
+      @max_timeout_ms = options[:max_timeout_ms] || MAX_TIMEOUT_MS
+      @multiplier = options[:multiplier] || MULTIPLIER
+      @randomization_factor = options[:randomization_factor] || RANDOMIZATION_FACTOR
+
+      @attempts = 0
+    end
+
+    # Public: Returns the next backoff interval in milliseconds.
+    def next_interval
+      interval = @min_timeout_ms * (@multiplier**@attempts)
+      interval = add_jitter(interval, @randomization_factor)
+
+      @attempts += 1
+
+      [interval, @max_timeout_ms].min
+    end
+
+    private
+
+    def add_jitter(base, randomization_factor)
+      random_number = rand
+      max_deviation = base * randomization_factor
+      deviation = random_number * max_deviation
+
+      if random_number < 0.5
+        base - deviation
+      else
+        base + deviation
+      end
+    end
+  end
+end

data/lib/brow/client.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'thread'
+require 'time'
+
+require_relative 'utils'
+require_relative 'worker'
+require_relative 'test_queue'
+
+module Brow
+  class Client
+    # Private: Default # of items that can be in queue before we start dropping data.
+    MAX_QUEUE_SIZE = 10_000
+
+    # Public: Create a new instance of a client.
+    #
+    # options - The Hash of options.
+    #   :max_queue_size - The maximum number of calls to be remain queued.
+    #   :on_error - The Proc that handles error calls from the API.
+    def initialize(options = {})
+      options = Brow::Utils.symbolize_keys(options)
+
+      @worker_thread = nil
+      @worker_mutex = Mutex.new
+      @test = options[:test]
+      @max_queue_size = options[:max_queue_size] || MAX_QUEUE_SIZE
+      @logger = options.fetch(:logger) { Brow.logger }
+      @queue = options.fetch(:queue) { Queue.new }
+      @worker = options.fetch(:worker) { Worker.new(@queue, options) }
+
+      at_exit { @worker_thread && @worker_thread[:should_exit] = true }
+    end
+
+    # Public: Synchronously waits until the worker has flushed the queue.
+    #
+    # Use only for scripts which are not long-running, and will
+    # specifically exit.
+    def flush
+      while !@queue.empty? || @worker.requesting?
+        ensure_worker_running
+        sleep(0.1)
+      end
+    end
+
+    # Public: Enqueues the event.
+    #
+    # event - The Hash of event data.
+    #
+    # Returns Boolean of whether the item was added to the queue.
+    def record(event)
+      raise ArgumentError, "event must be a Hash" unless event.is_a?(Hash)
+
+      event = Brow::Utils.symbolize_keys(event)
+      event = Brow::Utils.isoify_dates(event)
+      enqueue event
+    end
+
+    # Public: Returns the number of messages in the queue.
+    def queued_messages
+      @queue.length
+    end
+
+    # Public: For test purposes only. If test: true is passed to #initialize
+    # then all recording of events will go to test queue in memory so they can
+    # be verified with assertions.
+    def test_queue
+      unless @test
+        raise 'Test queue only available when setting :test to true.'
+      end
+
+      @test_queue ||= TestQueue.new
+    end
+
+    private
+
+    # Private: Enqueues the event.
+    #
+    # Returns Boolean of whether the item was added to the queue.
+    def enqueue(action)
+      if @test
+        test_queue << action
+        return true
+      end
+
+      if @queue.length < @max_queue_size
+        @queue << action
+        ensure_worker_running
+
+        true
+      else
+        @logger.warn 'Queue is full, dropping events. The :max_queue_size configuration parameter can be increased to prevent this from happening.'
+        false
+      end
+    end
+
+    def ensure_worker_running
+      return if worker_running?
+      @worker_mutex.synchronize do
+        return if worker_running?
+        @worker_thread = Thread.new do
+          @worker.run
+        end
+      end
+    end
+
+    def worker_running?
+      @worker_thread && @worker_thread.alive?
+    end
+  end
+end

data/lib/brow/message_batch.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'forwardable'
+
+module Brow
+  # Internal: A batch of messages to be sent to the API.
+  class MessageBatch
+    extend Forwardable
+
+    # Private: The error raised when a message cannot be serialized to json.
+    class JSONGenerationError < ::Brow::Error; end
+
+    # Private: Maximum bytes for an individual message.
+    MAX_BYTES_PER_MESSAGE = 32_768 # 32Kb
+
+    # Private: Maximum total bytes for a batch.
+    MAX_BYTES = 512_000 # 500Kb
+
+    # Private: Maximum number of messages in a batch.
+    MAX_SIZE = 100
+
+    def_delegators :@messages, :empty?
+    def_delegators :@messages, :length
+
+    attr_reader :uuid, :json_size
+
+    def initialize(options = {})
+      clear
+      @max_size = options[:max_size] || MAX_SIZE
+      @logger = options.fetch(:logger) { Brow.logger }
+    end
+
+    def <<(message)
+      begin
+        message_json = message.to_json
+      rescue StandardError => error
+        raise JSONGenerationError, "Serialization error: #{error}"
+      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 = []
+      @json_size = 0
+      @uuid = SecureRandom.uuid
+    end
+
+    def as_json
+      {
+        uuid: @uuid,
+        messages: @messages,
+      }
+    end
+
+    def to_json
+      JSON.generate(as_json)
+    end
+
+    private
+
+    def item_count_exhausted?
+      @messages.length >= @max_size
+    end
+
+    def message_too_big?(message_json_size)
+      message_json_size > MAX_BYTES_PER_MESSAGE
+    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 - MAX_BYTES_PER_MESSAGE)
+    end
+  end
+end

data/lib/brow/prefixed_logger.rb

@@ -0,0 +1,25 @@
+module Brow
+  # Internal: Wraps an existing logger and adds a prefix to all messages.
+  class PrefixedLogger
+    def initialize(logger, prefix)
+      @logger = logger
+      @prefix = prefix
+    end
+
+    def debug(message)
+      @logger.debug("#{@prefix} #{message}")
+    end
+
+    def info(message)
+      @logger.info("#{@prefix} #{message}")
+    end
+
+    def warn(message)
+      @logger.warn("#{@prefix} #{message}")
+    end
+
+    def error(message)
+      @logger.error("#{@prefix} #{message}")
+    end
+  end
+end

data/lib/brow/response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brow
+  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/brow/test_queue.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Brow
+  # Public: The test queue to use if the `Client` is in test mode. Keeps all
+  # messages in an array so you can add assertions.
+  #
+  # Be sure to reset before each test case.
+  class TestQueue
+    attr_reader :messages
+
+    def initialize
+      reset
+    end
+
+    def count
+      messages.count
+    end
+    alias_method :size, :count
+    alias_method :length, :count
+
+    def <<(message)
+      messages << message
+    end
+
+    def reset
+      @messages = []
+    end
+  end
+end

data/lib/brow/transport.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'net/https'
+require 'json'
+
+require_relative 'response'
+require_relative 'backoff_policy'
+
+module Brow
+  class Transport
+    RETRIES = 10
+    HEADERS = {
+      "Accept" => "application/json",
+      "Content-Type" => "application/json",
+      "User-Agent" => "brow-ruby/#{Brow::VERSION}",
+      "Client-Language" => "ruby",
+      "Client-Language-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+      "Client-Platform" => RUBY_PLATFORM,
+      "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+      "Client-Pid" => Process.pid.to_s,
+      "Client-Thread" => Thread.current.object_id.to_s,
+      "Client-Hostname" => Socket.gethostname,
+    }
+
+    attr_reader :url
+
+    def initialize(options = {})
+      @url = options[:url] || raise(ArgumentError, ":url is required to be present so we know where to send batches")
+      @uri = URI.parse(@url)
+
+      # Default path if people forget a slash.
+      if @uri.path.nil? || @uri.path.empty?
+        @uri.path = "/"
+      end
+
+      @headers = HEADERS.merge(options[:headers] || {})
+      @retries = options[:retries] || RETRIES
+
+      @logger = options.fetch(:logger) { Brow.logger }
+      @backoff_policy = options.fetch(:backoff_policy) {
+        Brow::BackoffPolicy.new
+      }
+
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = @uri.scheme == "https"
+      @http.read_timeout = options[:read_timeout] || 8
+      @http.open_timeout = options[:open_timeout] || 4
+    end
+
+    # Sends a batch of messages to the API
+    #
+    # @return [Response] API response
+    def send_batch(batch)
+      @logger.debug("Sending request for #{batch.length} items")
+
+      last_response, exception = retry_with_backoff(@retries) do
+        response = send_request(batch)
+        status_code = response.code.to_i
+        should_retry = should_retry_request?(status_code, response.body)
+        @logger.debug("Response status code: #{status_code}")
+
+        [Response.new(status_code, nil), 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
+        # Server error. Retry and log.
+        @logger.info("Server error: status=#{status_code}, body=#{body}")
+        true
+      elsif status_code == 429
+        # Rate limited
+        @logger.info "Rate limit error"
+        true
+      elsif status_code >= 400
+        # Client error. Do not retry, but log.
+        @logger.error("Client error: status=#{status_code}, body=#{body}")
+        false
+      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 => error
+        @logger.debug "Request error: #{error}"
+        should_retry = true
+        caught_exception = error
+      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(batch)
+      payload = batch.to_json
+      @http.start unless @http.started? # Maintain a persistent connection
+      request = Net::HTTP::Post.new(@uri.path, @headers)
+      @http.request(request, payload)
+    end
+  end
+end

data/lib/brow/utils.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Brow
+  module Utils
+    extend self
+
+    # Internal: Return a new hash with keys converted from strings to symbols
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(k, v), memo|
+        memo[k.to_sym] = v
+      end
+    end
+
+    # Internal: 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
+
+    # Internal
+    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
+
+    # Internal
+    def time_in_iso8601(time)
+      "#{time.strftime('%Y-%m-%dT%H:%M:%S.%6N')}#{formatted_offset(time, true, 'Z')}"
+    end
+
+    # Internal
+    def date_in_iso8601(date)
+      date.strftime('%F')
+    end
+
+    # Internal
+    def formatted_offset(time, colon = true, alternate_utc_string = nil)
+      time.utc? && alternate_utc_string || seconds_to_utc_offset(time.utc_offset, colon)
+    end
+
+    # Internal
+    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
+
+    # Internal
+    UTC_OFFSET_WITH_COLON = '%s%02d:%02d'
+
+    # Internal
+    UTC_OFFSET_WITHOUT_COLON = UTC_OFFSET_WITH_COLON.sub(':', '')
+  end
+end

data/lib/brow/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Brow
+  VERSION = "0.1.0"
+end

data/lib/brow/worker.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'message_batch'
+require_relative 'transport'
+require_relative 'utils'
+
+module Brow
+  # Internal: The Worker to pull items off the queue and put them
+  class Worker
+    DEFAULT_ON_ERROR = proc { |response| }
+
+    # Internal: Creates a new worker
+    #
+    # The worker continuously takes messages off the queue and makes requests to
+    # the api.
+    #
+    # queue   - Queue synchronized between client and worker
+    # options - The 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.
+    #           transport - The Transport object to deliver batches.
+    #           logger - The Logger object for all log messages.
+    #           batch - The MessageBatch to collect messages and deliver batches
+    #                   via Transport.
+    def initialize(queue, options = {})
+      @queue = queue
+      @lock = Mutex.new
+      options = Brow::Utils.symbolize_keys(options)
+      @on_error = options[:on_error] || DEFAULT_ON_ERROR
+      @transport = options.fetch(:transport) { Transport.new(options) }
+      @logger = options.fetch(:logger) { Brow.logger }
+      @batch = options.fetch(:batch) { MessageBatch.new(max_size: options[:batch_size]) }
+    end
+
+    # Internal: 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
+
+        response = @transport.send_batch @batch
+        @on_error.call(response) unless response.status == 200
+
+        @lock.synchronize { @batch.clear }
+      end
+    ensure
+      @transport.shutdown
+    end
+
+    # Internal: Check whether we have outstanding requests.
+    def requesting?
+      @lock.synchronize { !@batch.empty? }
+    end
+
+    private
+
+    def consume_message_from_queue!
+      @batch << @queue.pop
+    rescue MessageBatch::JSONGenerationError => error
+      @on_error.call(Response.new(-1, error))
+    end
+  end
+end

data/lib/brow.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "brow/version"
+require "logger"
+
+module Brow
+  class Error < StandardError; end
+
+  # Public: Returns the logger instance to use for logging of things.
+  def self.logger
+    return @logger if @logger
+
+    base_logger = if defined?(Rails)
+      Rails.logger
+    else
+      Logger.new(STDOUT)
+    end
+
+    @logger = PrefixedLogger.new(base_logger, "[brow]")
+  end
+
+  # Public: Sets the logger instance to use for logging things.
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+end
+
+require_relative "brow/client"
+require_relative "brow/prefixed_logger"

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: brow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/basic.rb
+- lib/brow.rb
+- lib/brow/backoff_policy.rb
+- lib/brow/client.rb
+- lib/brow/message_batch.rb
+- lib/brow/prefixed_logger.rb
+- lib/brow/response.rb
+- lib/brow/test_queue.rb
+- lib/brow/transport.rb
+- lib/brow/utils.rb
+- lib/brow/version.rb
+- lib/brow/worker.rb
+homepage: https://github.com/jnunemaker/brow
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jnunemaker/brow
+  source_code_uri: https://github.com/jnunemaker/brow
+  changelog_uri: https://github.com/jnunemaker/brow/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A generic background thread worker for shipping events via https to some
+  API backend.
+test_files: []