bento-sdk 0.5.0

data/lib/bento/sdk/utils.rb

@@ -0,0 +1,91 @@
+require "securerandom"
+
+module Bento
+  class Analytics
+    module Utils
+      extend self
+
+      # public: 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
+
+      # 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({}) do |(k, v), memo|
+          memo[k.to_s] = v
+        end
+      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 = if fraction_digits > 0
+          (".%06i" % time.usec)[0, fraction_digits + 1]
+        end
+
+        "#{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
+
+      UTC_OFFSET_WITH_COLON = "%s%02d:%02d"
+      UTC_OFFSET_WITHOUT_COLON = UTC_OFFSET_WITH_COLON.sub(":", "")
+    end
+  end
+end

data/lib/bento/sdk/version.rb

@@ -0,0 +1,5 @@
+module Bento
+  class Analytics
+    VERSION = "0.1"
+  end
+end

data/lib/bento/sdk/worker.rb

@@ -0,0 +1,69 @@
+require "bento/sdk/defaults"
+require "bento/sdk/message_batch"
+require "bento/sdk/transport"
+require "bento/sdk/utils"
+
+module Bento
+  class Analytics
+    class Worker
+      include Bento::Analytics::Utils
+      include Bento::Analytics::Defaults
+      include Bento::Analytics::Logging
+
+      # public: Creates a new worker
+      #
+      # The worker continuously takes messages off the queue
+      # and makes requests to the app.bentonow.com API
+      #
+      # queue   - Queue synchronized between client and worker
+      # write_key  - String of the project's Write 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, write_key, options = {})
+        symbolize_keys! options
+        @queue = queue
+        @write_key = write_key
+        @on_error = options[:on_error] || proc { |status, error| }
+        batch_size = options[:batch_size] || Bento::Analytics::Defaults::MessageBatch::MAX_SIZE
+        @batch = Bento::Analytics::MessageBatch.new(batch_size)
+        @lock = Mutex.new
+        @transport = Bento::Analytics::Transport.new
+      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 @write_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 Bento::Analytics::MessageBatch::JSONGenerationError => e
+        @on_error.call(-1, e.to_s)
+      end
+    end
+  end
+end

data/lib/bento-sdk.rb

@@ -0,0 +1,68 @@
+require "bento/analytics"
+require "bento/core/client"
+require "bento/core/error"
+require "bento/core/response"
+require "bento/core/version"
+require "bento/core/validators/base"
+require "bento/core/validators/event_validators"
+require "bento/core/validators/email_validators"
+require "bento/resources/subscribers"
+require "bento/resources/events"
+require "bento/resources/emails"
+require "bento/resources/spam"
+
+require "bento/sdk/configuration"
+
+require 'forwardable'
+require 'faraday'
+
+module Bento
+  class Error < StandardError; end
+
+  class ArgumentError < Error; end
+
+  class ConfigurationError < Error
+    attr_reader :key
+
+    def initialize(key)
+      @key = key.to_sym
+
+      super <<~CONFIG_ERROR_MESSAGE
+        Missing config value for `#{key}`
+
+        Please set a value for `#{key}` using an environment variable:
+
+          BENTO_#{key.to_s.upcase}=your-value
+
+        or via the `Bento.configure` method:
+
+          Bento.configure do |config|
+            config.#{key} = 'your-value'
+          end
+      CONFIG_ERROR_MESSAGE
+    end
+  end
+
+  class << self
+    extend Forwardable
+
+    # User configurable options
+    def_delegators :@config, :site_uuid, :site_uuid=
+    def_delegators :@config, :publishable_key, :publishable_key=
+    def_delegators :@config, :secret_key, :secret_key=
+    def_delegators :@config, :log_level, :log_level=
+    def_delegators :@config, :dev_mode, :dev_mode=
+
+    def config
+      @config ||= Bento::Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def reset!
+      @config = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: bento-sdk
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- bentonow.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The easiest way to track users and send emails in your Ruby on Rails
+  app
+email: support@Bentonow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bento-sdk.rb
+- lib/bento/analytics.rb
+- lib/bento/core/client.rb
+- lib/bento/core/error.rb
+- lib/bento/core/response.rb
+- lib/bento/core/validators/base.rb
+- lib/bento/core/validators/email_validators.rb
+- lib/bento/core/validators/event_validators.rb
+- lib/bento/core/version.rb
+- lib/bento/resources/emails.rb
+- lib/bento/resources/events.rb
+- lib/bento/resources/spam.rb
+- lib/bento/resources/subscribers.rb
+- lib/bento/sdk/backoff_policy.rb
+- lib/bento/sdk/client.rb
+- lib/bento/sdk/configuration.rb
+- lib/bento/sdk/defaults.rb
+- lib/bento/sdk/field_parser.rb
+- lib/bento/sdk/logging.rb
+- lib/bento/sdk/message_batch.rb
+- lib/bento/sdk/response.rb
+- lib/bento/sdk/transport.rb
+- lib/bento/sdk/utils.rb
+- lib/bento/sdk/version.rb
+- lib/bento/sdk/worker.rb
+homepage: https://github.com/bentonow/bento-ruby-sdk
+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.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Bento Ruby on Rails SDK
+test_files: []