userplex 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 329f3d0f92b37bc96fa0b691bb77a5e7a10823402be55206b593bdfd0e94b1ae
-  data.tar.gz: 5f91323be6c17044721c714eb9102c9c289a2acfde1d45ad0fd3ad9cad77397e
+  metadata.gz: ccc461e8d1af92a26c98de1c70db8c715b417e06938ed86cb8f8fb1a44b7b5ad
+  data.tar.gz: 3bce0ceaddbc3900107fc0241c341ab7d5dcfeb6eb1c32973452bfaac1e4ef88
 SHA512:
-  metadata.gz: 56e22d9dd10b8f2240656e54e2527219f989801b6cd483c4cabda7cf48340cb349951ca8322e7253b5b37ed2e06c54b4b6670a8eef596e8826fd644ef847f627
-  data.tar.gz: 54f90f72015492bf7146f1b353606eb1eedb0fffd229144c2f3c2941283a2564275231ff917fd908b986a73d02c976d87555a638c708dc0ceccc92777b0f9cfb
+  metadata.gz: fe33e8b3d4f264cf611171829a4f46b898d73b074e0fdc0279fd48c195436b7ae5f48b029a8c7230e776431a3d26e336dd3fd6d73883cdd7028fe885d7e5d799
+  data.tar.gz: e56c69c304b83299744f3466795320332173db9fabc07b7dcc98f6d4570361da4010a3013f544456186110a4d061638f32bd1e3537ecab0ad5b49ee5b9e36832

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.9.0 (2025-12-23)
+
+Full Changelog: [v0.8.0...v0.9.0](https://github.com/dqnamo/userplex-ruby/compare/v0.8.0...v0.9.0)
+
+### Features
+
+* **api:** manual updates ([5a5e029](https://github.com/dqnamo/userplex-ruby/commit/5a5e0297d519ec2fbbd614f0a7b9835bf2c5a9aa))
+
+## 0.8.0 (2025-12-19)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/dqnamo/userplex-ruby/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** manual updates ([300604c](https://github.com/dqnamo/userplex-ruby/commit/300604ca424ea6571bf0263b236d635847ff8866))
+
 ## 0.7.0 (2025-12-19)
 
 Full Changelog: [v0.6.2...v0.7.0](https://github.com/dqnamo/userplex-ruby/compare/v0.6.2...v0.7.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "userplex", "~> 0.7.0"
+gem "userplex", "~> 0.9.0"
 ```
 
 <!-- x-release-please-end -->
@@ -26,11 +26,9 @@ gem "userplex", "~> 0.7.0"
 require "bundler/setup"
 require "userplex"
 
-userplex = Userplex::Client.new(
-  api_key: ENV["USERPLEX_API_KEY"] # This is the default and can be omitted
-)
+userplex = Userplex::Client.new(api_key: "My API Key")
 
-response = userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
+response = userplex.logs.new(name: "REPLACE_ME")
 
 puts(response.success)
 ```
@@ -41,7 +39,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  user = userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
+  log = userplex.logs.new(name: "REPLACE_ME")
 rescue Userplex::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -80,16 +78,12 @@ You can use the `max_retries` option to configure or disable this:
 ```ruby
 # Configure the default for all requests:
 userplex = Userplex::Client.new(
-  max_retries: 0 # default is 2
+  max_retries: 0, # default is 2
+  api_key: "My API Key"
 )
 
 # Or, configure per-request:
-userplex.users.identify(
-  user_id: "user_id",
-  email: "REPLACE_ME",
-  name: "REPLACE_ME",
-  request_options: {max_retries: 5}
-)
+userplex.logs.new(name: "REPLACE_ME", request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -99,16 +93,12 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 ```ruby
 # Configure the default for all requests:
 userplex = Userplex::Client.new(
-  timeout: nil # default is 60
+  timeout: nil, # default is 60
+  api_key: "My API Key"
 )
 
 # Or, configure per-request:
-userplex.users.identify(
-  user_id: "user_id",
-  email: "REPLACE_ME",
-  name: "REPLACE_ME",
-  request_options: {timeout: 5}
-)
+userplex.logs.new(name: "REPLACE_ME", request_options: {timeout: 5})
 ```
 
 On timeout, `Userplex::Errors::APITimeoutError` is raised.
@@ -139,9 +129,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 
 ```ruby
 response =
-  userplex.users.identify(
-    user_id: "user_id",
-    email: "REPLACE_ME",
+  userplex.logs.new(
     name: "REPLACE_ME",
     request_options: {
       extra_query: {my_query_parameter: value},
@@ -188,18 +176,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
+userplex.logs.new(name: "REPLACE_ME")
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
+userplex.logs.new(name: "REPLACE_ME")
 
 # You can also splat a full Params class:
-params = Userplex::UserIdentifyParams.new(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
-userplex.users.identify(**params)
+params = Userplex::LogNewParams.new(name: "REPLACE_ME")
+userplex.logs.new(**params)
 ```
 
 ## Versioning

data/lib/userplex/client.rb

@@ -22,17 +22,8 @@ module Userplex
     # @return [Userplex::Resources::Users]
     attr_reader :users
 
-    # @return [Userplex::Resources::Events]
-    attr_reader :events
-
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def auth_headers
-      return {} if @api_key.nil?
-
-      {"authorization" => "Bearer #{@api_key}"}
-    end
+    # @return [Userplex::Resources::Logs]
+    attr_reader :logs
 
     # Creates and returns a new client for interacting with the API.
     #
@@ -74,7 +65,7 @@ module Userplex
       )
 
       @users = Userplex::Resources::Users.new(client: self)
-      @events = Userplex::Resources::Events.new(client: self)
+      @logs = Userplex::Resources::Logs.new(client: self)
     end
   end
 end

data/lib/userplex/internal/transport/base_client.rb

@@ -215,11 +215,6 @@ module Userplex
           @max_retry_delay = max_retry_delay
         end
 
-        # @api private
-        #
-        # @return [Hash{String=>String}]
-        private def auth_headers = {}
-
         # @api private
         #
         # @return [String]
@@ -276,7 +271,6 @@ module Userplex
 
           headers = Userplex::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

data/lib/userplex/models/log_batch_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Userplex
+  module Models
+    # @see Userplex::Resources::Logs#batch
+    class LogBatchParams < Userplex::Internal::Type::BaseModel
+      extend Userplex::Internal::Type::RequestParameters::Converter
+      include Userplex::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #   A list of logs to ingest
+      #
+      #   @return [Array<Userplex::Models::LogBatchParams::Body>, nil]
+      optional :body, -> { Userplex::Internal::Type::ArrayOf[Userplex::LogBatchParams::Body] }
+
+      # @!method initialize(body: nil, request_options: {})
+      #   @param body [Array<Userplex::Models::LogBatchParams::Body>] A list of logs to ingest
+      #
+      #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]
+
+      class Body < Userplex::Internal::Type::BaseModel
+        # @!attribute name
+        #   Log name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute data
+        #   Additional log data
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :data, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown]
+
+        # @!attribute timestamp
+        #   Log timestamp (ISO 8601)
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!attribute user_id
+        #   External user ID
+        #
+        #   @return [String, nil]
+        optional :user_id, String
+
+        # @!method initialize(name:, data: nil, timestamp: nil, user_id: nil)
+        #   @param name [String] Log name
+        #
+        #   @param data [Hash{Symbol=>Object}] Additional log data
+        #
+        #   @param timestamp [Time] Log timestamp (ISO 8601)
+        #
+        #   @param user_id [String] External user ID
+      end
+    end
+  end
+end

data/lib/userplex/models/log_batch_response.rb

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

data/lib/userplex/models/log_new_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Userplex
+  module Models
+    # @see Userplex::Resources::Logs#new
+    class LogNewParams < Userplex::Internal::Type::BaseModel
+      extend Userplex::Internal::Type::RequestParameters::Converter
+      include Userplex::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   Log name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute data
+      #   Additional log data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown]
+
+      # @!attribute timestamp
+      #   Log timestamp (ISO 8601)
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!attribute user_id
+      #   External user ID
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
+      #   @param name [String] Log name
+      #
+      #   @param data [Hash{Symbol=>Object}] Additional log data
+      #
+      #   @param timestamp [Time] Log timestamp (ISO 8601)
+      #
+      #   @param user_id [String] External user ID
+      #
+      #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/userplex/models/log_new_response.rb

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

data/lib/userplex/models/user_identify_params.rb

@@ -8,37 +8,37 @@ module Userplex
       include Userplex::Internal::Type::RequestParameters
 
       # @!attribute user_id
-      #   Unique identifier for the user
+      #   External user ID
       #
       #   @return [String]
       required :user_id, String
 
+      # @!attribute attributes
+      #   Additional user attributes
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :attributes, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown]
+
       # @!attribute email
-      #   User email address
+      #   User email
       #
       #   @return [String, nil]
       optional :email, String
 
       # @!attribute name
-      #   User full name
+      #   User name
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!attribute properties
-      #   Additional user properties
-      #
-      #   @return [Hash{Symbol=>Object, nil}, nil]
-      optional :properties, Userplex::Internal::Type::HashOf[Userplex::Internal::Type::Unknown, nil?: true]
-
-      # @!method initialize(user_id:, email: nil, name: nil, properties: nil, request_options: {})
-      #   @param user_id [String] Unique identifier for the user
+      # @!method initialize(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
+      #   @param user_id [String] External user ID
       #
-      #   @param email [String] User email address
+      #   @param attributes [Hash{Symbol=>Object}] Additional user attributes
       #
-      #   @param name [String] User full name
+      #   @param email [String] User email
       #
-      #   @param properties [Hash{Symbol=>Object, nil}] Additional user properties
+      #   @param name [String] User name
       #
       #   @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/userplex/models/user_identify_response.rb

@@ -5,13 +5,12 @@ module Userplex
     # @see Userplex::Resources::Users#identify
     class UserIdentifyResponse < Userplex::Internal::Type::BaseModel
       # @!attribute success
-      #   Operation success status
       #
       #   @return [Boolean]
       required :success, Userplex::Internal::Type::Boolean
 
       # @!method initialize(success:)
-      #   @param success [Boolean] Operation success status
+      #   @param success [Boolean]
     end
   end
 end

data/lib/userplex/models.rb

@@ -39,5 +39,9 @@ module Userplex
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  LogBatchParams = Userplex::Models::LogBatchParams
+
+  LogNewParams = Userplex::Models::LogNewParams
+
   UserIdentifyParams = Userplex::Models::UserIdentifyParams
 end

data/lib/userplex/resources/logs.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Userplex
+  module Resources
+    class Logs
+      # @overload batch(body: nil, request_options: {})
+      #
+      # @param body [Array<Userplex::Models::LogBatchParams::Body>] A list of logs to ingest
+      #
+      # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Userplex::Models::LogBatchResponse]
+      #
+      # @see Userplex::Models::LogBatchParams
+      def batch(params = {})
+        parsed, options = Userplex::LogBatchParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "logs",
+          body: parsed[:body],
+          model: Userplex::Models::LogBatchResponse,
+          options: options
+        )
+      end
+
+      # @overload new(name:, data: nil, timestamp: nil, user_id: nil, request_options: {})
+      #
+      # @param name [String] Log name
+      #
+      # @param data [Hash{Symbol=>Object}] Additional log data
+      #
+      # @param timestamp [Time] Log timestamp (ISO 8601)
+      #
+      # @param user_id [String] External user ID
+      #
+      # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Userplex::Models::LogNewResponse]
+      #
+      # @see Userplex::Models::LogNewParams
+      def new(params)
+        parsed, options = Userplex::LogNewParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "log",
+          body: parsed,
+          model: Userplex::Models::LogNewResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Userplex::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/userplex/resources/users.rb

@@ -3,18 +3,15 @@
 module Userplex
   module Resources
     class Users
-      # Creates or updates an end user in InstantDB with the provided information.
-      # Requires a valid API key for authentication.
+      # @overload identify(user_id:, attributes: nil, email: nil, name: nil, request_options: {})
       #
-      # @overload identify(user_id:, email: nil, name: nil, properties: nil, request_options: {})
+      # @param user_id [String] External user ID
       #
-      # @param user_id [String] Unique identifier for the user
+      # @param attributes [Hash{Symbol=>Object}] Additional user attributes
       #
-      # @param email [String] User email address
+      # @param email [String] User email
       #
-      # @param name [String] User full name
-      #
-      # @param properties [Hash{Symbol=>Object, nil}] Additional user properties
+      # @param name [String] User name
       #
       # @param request_options [Userplex::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -25,7 +22,7 @@ module Userplex
         parsed, options = Userplex::UserIdentifyParams.dump_request(params)
         @client.request(
           method: :post,
-          path: "api/identify",
+          path: "identify",
           body: parsed,
           model: Userplex::Models::UserIdentifyResponse,
           options: options

data/lib/userplex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Userplex
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/userplex.rb

@@ -52,8 +52,12 @@ require_relative "userplex/errors"
 require_relative "userplex/internal/transport/base_client"
 require_relative "userplex/internal/transport/pooled_net_requester"
 require_relative "userplex/client"
+require_relative "userplex/models/log_batch_params"
+require_relative "userplex/models/log_batch_response"
+require_relative "userplex/models/log_new_params"
+require_relative "userplex/models/log_new_response"
 require_relative "userplex/models/user_identify_params"
 require_relative "userplex/models/user_identify_response"
 require_relative "userplex/models"
-require_relative "userplex/resources/events"
+require_relative "userplex/resources/logs"
 require_relative "userplex/resources/users"

data/rbi/userplex/client.rbi

@@ -17,13 +17,8 @@ module Userplex
     sig { returns(Userplex::Resources::Users) }
     attr_reader :users
 
-    sig { returns(Userplex::Resources::Events) }
-    attr_reader :events
-
-    # @api private
-    sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers
-    end
+    sig { returns(Userplex::Resources::Logs) }
+    attr_reader :logs
 
     # Creates and returns a new client for interacting with the API.
     sig do

data/rbi/userplex/internal/transport/base_client.rbi

@@ -171,11 +171,6 @@ module Userplex
         )
         end
 
-        # @api private
-        sig { overridable.returns(T::Hash[String, String]) }
-        private def auth_headers
-        end
-
         # @api private
         sig { returns(String) }
         private def user_agent

data/rbi/userplex/models/log_batch_params.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Userplex
+  module Models
+    class LogBatchParams < Userplex::Internal::Type::BaseModel
+      extend Userplex::Internal::Type::RequestParameters::Converter
+      include Userplex::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Userplex::LogBatchParams, Userplex::Internal::AnyHash)
+        end
+
+      # A list of logs to ingest
+      sig { returns(T.nilable(T::Array[Userplex::LogBatchParams::Body])) }
+      attr_reader :body
+
+      sig do
+        params(body: T::Array[Userplex::LogBatchParams::Body::OrHash]).void
+      end
+      attr_writer :body
+
+      sig do
+        params(
+          body: T::Array[Userplex::LogBatchParams::Body::OrHash],
+          request_options: Userplex::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A list of logs to ingest
+        body: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            body: T::Array[Userplex::LogBatchParams::Body],
+            request_options: Userplex::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Body < Userplex::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Userplex::LogBatchParams::Body, Userplex::Internal::AnyHash)
+          end
+
+        # Log name
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Additional log data
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :data
+
+        sig { params(data: T::Hash[Symbol, T.anything]).void }
+        attr_writer :data
+
+        # Log timestamp (ISO 8601)
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # External user ID
+        sig { returns(T.nilable(String)) }
+        attr_reader :user_id
+
+        sig { params(user_id: String).void }
+        attr_writer :user_id
+
+        sig do
+          params(
+            name: String,
+            data: T::Hash[Symbol, T.anything],
+            timestamp: Time,
+            user_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Log name
+          name:,
+          # Additional log data
+          data: nil,
+          # Log timestamp (ISO 8601)
+          timestamp: nil,
+          # External user ID
+          user_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: String,
+              data: T::Hash[Symbol, T.anything],
+              timestamp: Time,
+              user_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end