seerstack 0.1.0

data/lib/seerstack/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Internal
+    extend Seerstack::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Seerstack::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Seerstack::FilePart) }
+    end
+  end
+end

data/lib/seerstack/models/event_capture_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Models
+    # @see Seerstack::Resources::Events#capture
+    class EventCaptureParams < Seerstack::Internal::Type::BaseModel
+      extend Seerstack::Internal::Type::RequestParameters::Converter
+      include Seerstack::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :data, Seerstack::Internal::Type::HashOf[Seerstack::Internal::Type::Unknown, nil?: true]
+
+      # @!attribute timestamp
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!attribute user_id
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
+      #   @param name [String]
+      #   @param data [Hash{Symbol=>Object, nil}]
+      #   @param timestamp [Time]
+      #   @param user_id [String]
+      #   @param request_options [Seerstack::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/seerstack/models/event_capture_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Models
+    # @see Seerstack::Resources::Events#capture
+    class EventCaptureResponse < Seerstack::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Seerstack::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/seerstack/models/user_identify_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Models
+    # @see Seerstack::Resources::Users#identify
+    class UserIdentifyParams < Seerstack::Internal::Type::BaseModel
+      extend Seerstack::Internal::Type::RequestParameters::Converter
+      include Seerstack::Internal::Type::RequestParameters
+
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute attributes
+      #
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :attributes, Seerstack::Internal::Type::HashOf[Seerstack::Internal::Type::Unknown, nil?: true]
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
+      #   @param user_id [String]
+      #   @param attributes [Hash{Symbol=>Object, nil}]
+      #   @param email [String]
+      #   @param name [String]
+      #   @param request_options [Seerstack::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/seerstack/models/user_identify_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Models
+    # @see Seerstack::Resources::Users#identify
+    class UserIdentifyResponse < Seerstack::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Seerstack::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/seerstack/models.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Seerstack
+  [Seerstack::Internal::Type::BaseModel, *Seerstack::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Seerstack::Internal::AnyHash) } }
+  end
+
+  Seerstack::Internal::Util.walk_namespaces(Seerstack::Models).each do |mod|
+    case mod
+    in Seerstack::Internal::Type::Enum | Seerstack::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Seerstack::Internal::Util.walk_namespaces(Seerstack::Models)
+                           .lazy
+                           .grep(Seerstack::Internal::Type::Union)
+                           .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  EventCaptureParams = Seerstack::Models::EventCaptureParams
+
+  UserIdentifyParams = Seerstack::Models::UserIdentifyParams
+end

data/lib/seerstack/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Seerstack
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Seerstack::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Seerstack::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Seerstack::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Seerstack::Internal::Type::HashOf[Seerstack::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Seerstack::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Seerstack::Internal::Type::HashOf[Seerstack::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Seerstack::RequestOptions, Seerstack::Internal::AnyHash) }
+    end
+  end
+end

data/lib/seerstack/resources/events.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Resources
+    class Events
+      # Capture an event
+      #
+      # @overload capture(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
+      #
+      # @param name [String]
+      # @param data [Hash{Symbol=>Object, nil}]
+      # @param timestamp [Time]
+      # @param user_id [String]
+      # @param request_options [Seerstack::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Seerstack::Models::EventCaptureResponse]
+      #
+      # @see Seerstack::Models::EventCaptureParams
+      def capture(params)
+        parsed, options = Seerstack::EventCaptureParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "capture",
+          body: parsed,
+          model: Seerstack::Models::EventCaptureResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Seerstack::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/seerstack/resources/users.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Seerstack
+  module Resources
+    class Users
+      # Identify a user
+      #
+      # @overload identify(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
+      #
+      # @param user_id [String]
+      # @param attributes [Hash{Symbol=>Object, nil}]
+      # @param email [String]
+      # @param name [String]
+      # @param request_options [Seerstack::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Seerstack::Models::UserIdentifyResponse]
+      #
+      # @see Seerstack::Models::UserIdentifyParams
+      def identify(params)
+        parsed, options = Seerstack::UserIdentifyParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "identify",
+          body: parsed,
+          model: Seerstack::Models::UserIdentifyResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Seerstack::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/seerstack/version.rb

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

data/lib/seerstack.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "seerstack/version"
+require_relative "seerstack/internal/util"
+require_relative "seerstack/internal/type/converter"
+require_relative "seerstack/internal/type/unknown"
+require_relative "seerstack/internal/type/boolean"
+require_relative "seerstack/internal/type/file_input"
+require_relative "seerstack/internal/type/enum"
+require_relative "seerstack/internal/type/union"
+require_relative "seerstack/internal/type/array_of"
+require_relative "seerstack/internal/type/hash_of"
+require_relative "seerstack/internal/type/base_model"
+require_relative "seerstack/internal/type/base_page"
+require_relative "seerstack/internal/type/request_parameters"
+require_relative "seerstack/internal"
+require_relative "seerstack/request_options"
+require_relative "seerstack/file_part"
+require_relative "seerstack/errors"
+require_relative "seerstack/internal/transport/base_client"
+require_relative "seerstack/internal/transport/pooled_net_requester"
+require_relative "seerstack/client"
+require_relative "seerstack/models/event_capture_params"
+require_relative "seerstack/models/event_capture_response"
+require_relative "seerstack/models/user_identify_params"
+require_relative "seerstack/models/user_identify_response"
+require_relative "seerstack/models"
+require_relative "seerstack/resources/events"
+require_relative "seerstack/resources/users"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/seerstack/client.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Seerstack
+  class Client < Seerstack::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    # API key authentication via Bearer token
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(Seerstack::Resources::Events) }
+    attr_reader :events
+
+    sig { returns(Seerstack::Resources::Users) }
+    attr_reader :users
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # API key authentication via Bearer token Defaults to `ENV["SEERSTACK_API_KEY"]`
+      api_key: ENV["SEERSTACK_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["SEERSTACK_BASE_URL"]`
+      base_url: ENV["SEERSTACK_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Seerstack::Client::DEFAULT_MAX_RETRIES,
+      timeout: Seerstack::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Seerstack::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Seerstack::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/seerstack/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module Seerstack
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Seerstack::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < Seerstack::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < Seerstack::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < Seerstack::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < Seerstack::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    end
+
+    class BadRequestError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Seerstack::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end