oursprivacy-ingest 0.1.0

data/rbi/oursprivacy_ingest/models/visitor_upsert_response.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module OursprivacyIngest
+  module Models
+    class VisitorUpsertResponse < OursprivacyIngest::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            OursprivacyIngest::Models::VisitorUpsertResponse,
+            OursprivacyIngest::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          OursprivacyIngest::Models::VisitorUpsertResponse::Success::TaggedBoolean
+        )
+      end
+      attr_accessor :success
+
+      sig do
+        params(
+          success:
+            OursprivacyIngest::Models::VisitorUpsertResponse::Success::OrBoolean
+        ).returns(T.attached_class)
+      end
+      def self.new(success:)
+      end
+
+      sig do
+        override.returns(
+          {
+            success:
+              OursprivacyIngest::Models::VisitorUpsertResponse::Success::TaggedBoolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Success
+        extend OursprivacyIngest::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              OursprivacyIngest::Models::VisitorUpsertResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            OursprivacyIngest::Models::VisitorUpsertResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              OursprivacyIngest::Models::VisitorUpsertResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/oursprivacy_ingest/models.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module OursprivacyIngest
+  TrackEventParams = OursprivacyIngest::Models::TrackEventParams
+
+  VisitorUpsertParams = OursprivacyIngest::Models::VisitorUpsertParams
+end

data/rbi/oursprivacy_ingest/request_options.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module OursprivacyIngest
+  # 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 < OursprivacyIngest::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(
+          OursprivacyIngest::RequestOptions,
+          OursprivacyIngest::Internal::AnyHash
+        )
+      end
+
+    # @api private
+    sig { params(opts: OursprivacyIngest::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: OursprivacyIngest::Internal::AnyHash).returns(
+        T.attached_class
+      )
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/oursprivacy_ingest/resources/track.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OursprivacyIngest
+  module Resources
+    class Track
+      # Track events from your server. Please include at least one of: userId,
+      # externalId, or email. These properties help us associate events with existing
+      # users. For all fields, null values unset the property and undefined values do
+      # not unset existing properties.
+      sig do
+        params(
+          token: String,
+          event: String,
+          default_properties:
+            T.nilable(
+              OursprivacyIngest::TrackEventParams::DefaultProperties::OrHash
+            ),
+          distinct_id: T.nilable(String),
+          email: T.nilable(String),
+          event_properties: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+          external_id: T.nilable(String),
+          time: T.nilable(Float),
+          user_id: T.nilable(String),
+          user_properties:
+            T.nilable(
+              OursprivacyIngest::TrackEventParams::UserProperties::OrHash
+            ),
+          request_options: OursprivacyIngest::RequestOptions::OrHash
+        ).returns(OursprivacyIngest::Models::TrackEventResponse)
+      end
+      def event(
+        # The token for your Ours Privacy Source. You can find this in the Ours dashboard.
+        token:,
+        # The name of the event you're tracking. This must be whitelisted in the Ours
+        # dashboard.
+        event:,
+        # These properties are used throughout the Ours app to pass known values onto
+        # destinations
+        default_properties: nil,
+        # A unique identifier for the event. This helps prevent duplicate events.
+        distinct_id: nil,
+        # The email address of a user. We will associate this event with the user or
+        # create a user. Used for lookup if externalId and userId are not included in the
+        # request.
+        email: nil,
+        # Any additional event properties you want to pass along.
+        event_properties: nil,
+        # The externalId (the ID in your system) of a user. We will associate this event
+        # with the user or create a user. If included in the request, email lookup is
+        # ignored.
+        external_id: nil,
+        # The time at which the event occurred in milliseconds since UTC epoch. The time
+        # must be in the past and within the last 7 days.
+        time: nil,
+        # The Ours user id stored in local storage and cookies on your web properties. If
+        # userId is included in the request, we do not lookup the user by email or
+        # externalId.
+        user_id: nil,
+        # Properties to set on the visitor. (optional) You can also update these
+        # properties via the identify endpoint.
+        user_properties: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: OursprivacyIngest::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/oursprivacy_ingest/resources/visitor.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module OursprivacyIngest
+  module Resources
+    class Visitor
+      # Define visitor properties on an existing visitor or create a new visitor. Note:
+      # This does not fire an event. If you want to fire an event, use the track method
+      # and include properties for the visitor.
+      sig do
+        params(
+          token: String,
+          user_properties:
+            OursprivacyIngest::VisitorUpsertParams::UserProperties::OrHash,
+          default_properties:
+            T.nilable(
+              OursprivacyIngest::VisitorUpsertParams::DefaultProperties::OrHash
+            ),
+          email: T.nilable(String),
+          external_id: T.nilable(String),
+          user_id: T.nilable(String),
+          request_options: OursprivacyIngest::RequestOptions::OrHash
+        ).returns(OursprivacyIngest::Models::VisitorUpsertResponse)
+      end
+      def upsert(
+        # The token for your Ours Privacy Source. You can find this in the Ours dashboard.
+        token:,
+        # User properties to associate with this user. The existing user properties will
+        # be updated. And all future events will have these properties associated with
+        # them.
+        user_properties:,
+        # These properties are used throughout the Ours app to pass known values onto
+        # destinations
+        default_properties: nil,
+        # The email address of a user. We will associate this event with the user or
+        # create a user. Used for lookup if externalId and userId are not included in the
+        # request.
+        email: nil,
+        # The externalId (the ID in your system) of a user. We will associate this event
+        # with the user or create a user. If included in the request, email lookup is
+        # ignored.
+        external_id: nil,
+        # The Ours user id stored in local storage and cookies on your web properties. If
+        # userId is included in the request, we do not lookup the user by email or
+        # externalId.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: OursprivacyIngest::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/oursprivacy_ingest/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module OursprivacyIngest
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/oursprivacy_ingest/client.rbs

@@ -0,0 +1,25 @@
+module OursprivacyIngest
+  class Client < OursprivacyIngest::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader track: OursprivacyIngest::Resources::Track
+
+    attr_reader visitor: OursprivacyIngest::Resources::Visitor
+
+    def base_url_overridden?: -> bool
+
+    def initialize: (
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/oursprivacy_ingest/errors.rbs

@@ -0,0 +1,117 @@
+module OursprivacyIngest
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < OursprivacyIngest::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < OursprivacyIngest::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < OursprivacyIngest::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < OursprivacyIngest::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < OursprivacyIngest::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < OursprivacyIngest::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/oursprivacy_ingest/file_part.rbs

@@ -0,0 +1,21 @@
+module OursprivacyIngest
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: (Pathname | String)?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/oursprivacy_ingest/internal/transport/base_client.rbs

@@ -0,0 +1,131 @@
+module OursprivacyIngest
+  module Internal
+    module Transport
+      class BaseClient
+        extend OursprivacyIngest::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: OursprivacyIngest::Internal::Type::Converter::input?,
+            options: OursprivacyIngest::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          OursprivacyIngest::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          OursprivacyIngest::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> OursprivacyIngest::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | OursprivacyIngest::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: OursprivacyIngest::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def user_agent: -> String
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          OursprivacyIngest::Internal::Transport::BaseClient::request_components req,
+          OursprivacyIngest::request_options opts
+        ) -> OursprivacyIngest::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        def send_request: (
+          OursprivacyIngest::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: OursprivacyIngest::Internal::Type::Converter::input?,
+          ?options: OursprivacyIngest::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/oursprivacy_ingest/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,45 @@
+module OursprivacyIngest
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend OursprivacyIngest::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (URI::Generic url) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          OursprivacyIngest::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          OursprivacyIngest::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

data/sig/oursprivacy_ingest/internal/type/array_of.rbs

@@ -0,0 +1,48 @@
+module OursprivacyIngest
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include OursprivacyIngest::Internal::Type::Converter
+        include OursprivacyIngest::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> OursprivacyIngest::Internal::Type::Converter::input
+          | OursprivacyIngest::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> instance
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          ::Array[top] | top value,
+          state: OursprivacyIngest::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: OursprivacyIngest::Internal::Type::Converter::dump_state
+        ) -> (::Array[top] | top)
+
+        def to_sorbet_type: -> top
+
+        def item_type: -> Elem
+
+        def nilable?: -> bool
+
+        def initialize: (
+          ::Hash[Symbol, top]
+          | ^-> OursprivacyIngest::Internal::Type::Converter::input
+          | OursprivacyIngest::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end