Cancel session

Gemfile

@@ -11,7 +11,6 @@ gem "rake", "~> 13.3.1"
 gem "dotenv-rails"
 gem "factory_bot", "~> 6.5.6"
 gem "rspec", "~> 3.13.2"
-gem "vcr", "~> 6.3.1"
 gem "webmock"
 gem "pry-byebug"
 gem "rubocop"

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-chatkit (0.1.9)
+    ruby-chatkit (0.2.0)
       base64
       event_stream_parser
       http
@@ -217,8 +217,6 @@ GEM
     unicode-emoji (4.1.0)
     uri (1.1.1)
     useragent (0.16.11)
-    vcr (6.3.1)
-      base64
     webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -247,7 +245,6 @@ DEPENDENCIES
   rubocop-rspec
   ruby-chatkit!
   shoulda-matchers (~> 7.0.1)
-  vcr (~> 6.3.1)
   webmock
 
 BUNDLED WITH

lib/chatkit/client.rb

@@ -28,11 +28,11 @@ module OpenAI
     # @param timeout [Integer, nil] - optional - The timeout for requests.
     # @param logger [Logger, nil] - optional - The logger instance.
     def initialize(
-      api_key: ChatKit.configuration.api_key, 
+      api_key: ChatKit.configuration.api_key,
       host: ChatKit.configuration.host,
       timeout: ChatKit.configuration.timeout,
       logger: nil
-      )
+    )
       @api_key = api_key
       @host = host
       @timeout = timeout
@@ -70,6 +70,17 @@ def create_session!(user_id:, workflow_id:, chatkit_configuration: nil, expires_
       )
     end
 
+    # Cancels the current session or a specified session by ID.
+    # @param session_id [String] - The ID of the session to cancel.
+    #
+    # @raise [RuntimeError] If no session ID is provided and there is no current session.
+    # @return [Session::Cancel::Response] The response from the cancel operation.
+    def cancel_session!(session_id:)
+      raise "No session ID provided" if session_id.nil?
+
+      Session.cancel!(session_id:, client: self)
+    end
+
     # Sends a message in a conversation, optionally uploading files.
     # @param text [String] The text message to send.
     # @param files [Array<File>] - optional - The files to upload and attach to the message.

lib/chatkit/conversation/response/thread/item.rb

@@ -84,7 +84,7 @@ def from_event(data)
                 inference_options: data["inference_options"] || {},
                 content: data["content"] || [],
                 quoted_text: data["quoted_text"] || "",
-                workflow: parse_workflow_data(data)
+                workflow: Workflow.from_event(data["workflow"])
               )
             end
           end
@@ -118,7 +118,7 @@ def update_from_event!(data)
             if @workflow
               @workflow.update!(data["workflow"])
             else
-              @workflow = parse_workflow_data(data)
+              @workflow = Workflow.from_event(data["workflow"])
             end
           end
 
@@ -138,17 +138,6 @@ def process_update!(update_data)
             end
           end
 
-        protected
-
-          # Parse workflow data from event
-          # @param data [Hash] The event data
-          # @return [Workflow, nil]
-          def parse_workflow_data(data)
-            return nil unless data["workflow"]
-
-            Workflow.from_event(data["workflow"])
-          end
-
         private
 
           # Parse content array into Content objects
@@ -190,6 +179,7 @@ def handle_content_part_added!(update_data)
           # @return [void]
           def handle_text_delta!(update_data)
             delta_text = update_data["delta"]
+
             return unless delta_text
 
             @delta << delta_text

lib/chatkit/conversation/response/thread/item/workflow.rb

@@ -43,6 +43,8 @@ def initialize(type: nil, tasks: nil, summary: nil, expanded: nil, response_item
             # @param data [Hash] The workflow data from the event
             # @return [Workflow]
             def self.from_event(data)
+              return nil if data.nil?
+
               new(
                 type: data["type"],
                 tasks: data["tasks"],

lib/chatkit/request/endpoints.rb

@@ -9,7 +9,8 @@ module Request
     #   etc.
     module Endpoints
       CONVERSATION = "/v1/chatkit/conversation"
-      SESSIONS = "/v1/chatkit/sessions"
+      CREATE_SESSION = "/v1/chatkit/sessions"
+      CANCEL_SESSION = "/v1/chatkit/sessions/%<id>s/cancel"
       FILES = "/v1/chatkit/files"
 
       class << self
@@ -18,8 +19,14 @@ class << self
         #
         # @return [String] The corresponding endpoint string
         ChatKit::Request::Endpoints.constants.each do |const_name|
-          define_method "#{const_name.to_s.downcase}_endpoint" do
-            ChatKit::Request::Endpoints.const_get(const_name)
+          define_method "#{const_name.to_s.downcase}_endpoint" do |path_params = {}|
+            if path_params
+              raise ArgumentError, "Path parameters must be provided as a Hash" unless path_params.is_a?(Hash)
+
+              format(ChatKit::Request::Endpoints.const_get(const_name), **path_params)
+            else
+              ChatKit::Request::Endpoints.const_get(const_name)
+            end
           end
         end
       end

lib/chatkit/session.rb

@@ -17,54 +17,18 @@ module ChatKit
   #    workflow: { id: "wf_68eeb857eaf8819089eb55d32f39a822050622537973ef99" }
   #  )
   class Session
+    class SessionError < StandardError; end
+
     module Defaults
       ENABLED = true
     end
 
-    # @!attribute [rw] user_id
-    #  @return [String] The ID of the user.
-    attr_accessor :user_id
-
-    # @!attribute [rw] workflow
-    #  @return [Workflow] The workflow for the session.
-    attr_accessor :workflow
-
-    # @!attribute [rw] chatkit_configuration
-    #  @return [ChatKitConfiguration] The ChatKit configuration.
-    attr_accessor :chatkit_configuration
-
-    # @!attribute [rw] expires_after
-    #  @return [ExpiresAfter] The expiration time for the session.
-    attr_accessor :expires_after
+    # @!attribute [rw] sesstion
+    #  @return [Session::Create]
+    attr_accessor :session
 
-    # @!attribute [rw] rate_limits
-    #  @return [RateLimits] The rate limits for the session.
-    attr_accessor :rate_limits
-
-    # @!attribute [rw] response
-    #  @return [Response] The session response data.
-    attr_accessor :response
-
-    # @param workflow [Hash] The ID of the session.
-    # @param user_id [String] The ID of the user.
-    # @param chatkit_configuration [Hash, nil] - optional - The ChatKit configuration.
-    # @param expires_after [Hash, nil] - optional - The expiration time for the session.
-    # @param rate_limits [Hash, nil] - optional - The rate limits for the session.
-    # @param client [Ruby::ChatKit::Client] The ChatKit client instance.
-    def initialize(
-      user_id:,
-      workflow:,
-      chatkit_configuration: nil,
-      expires_after: nil,
-      rate_limits: nil,
-      client: Client.new
-    )
-      @client = client
-      @user_id = user_id
-      @workflow = Workflow.build(**workflow.to_h)
-      @chatkit_configuration = ChatKitConfiguration.build(**chatkit_configuration.to_h)
-      @expires_after = ExpiresAfter.build(**expires_after) if expires_after.is_a?(Hash)
-      @rate_limits = RateLimits.build(**rate_limits.to_h)
+    def initialize
+      @session = nil
     end
 
     class << self
@@ -76,103 +40,41 @@ def create!(
         rate_limits: nil,
         client: Client.new
       )
-        new(
-          user_id:,
-          workflow:,
-          chatkit_configuration:,
-          expires_after:,
-          rate_limits:,
-          client:
-        ).create!
+        new.tap do |instance|
+          instance.session = Create.call(
+            user_id:,
+            workflow:,
+            chatkit_configuration:,
+            expires_after:,
+            rate_limits:,
+            client:
+          )
+        end
       end
-    end
-
-    # Creates a new ChatKit session.
-    # @return [Response] The created session data.
-    def create!
-      payload = build_payload
-      response = perform_request(payload)
-
-      handle_response_errors(response)
-
-      @response = parse_response(response)
-
-      self
-    rescue StandardError => e
-      raise SessionError, "Session creation failed: #{e.message}"
-    end
-
-    def refresh!
-      create!
-    end
-
-  private
 
-    # @return [Hash]
-    def build_payload
-      {
-        user: user_id,
-        workflow: workflow.serialize,
-        chatkit_configuration: chatkit_configuration.serialize,
-        expires_after: expires_after&.serialize,
-        rate_limits: rate_limits.serialize,
-      }.compact
-    end
-
-    # Performs the HTTP request to create a session.
-    #
-    # @param payload [Hash] The request payload.
-    # @return [HTTP::Response] The HTTP response.
-    def perform_request(payload)
-      @client.connection.headers(sessions_header).post(sessions_endpoint, json: payload)
-    end
-
-    # Handles HTTP response errors by raising appropriate exceptions.
-    #
-    # @param response [HTTP::Response] The HTTP response to check.
-    # @raise [SessionError] If the response indicates an error.
-    def handle_response_errors(response)
-      return unless response.code >= 300
-
-      error_message = begin
-        response.parse["error"]["message"]
-      rescue StandardError
-        "Unknown error occurred"
+      def cancel!(session_id:, client: Client.new)
+        Cancel.call(session_id:, client:)
       end
-
-      raise SessionError, error_message
     end
 
-    # Parses the HTTP response body.
+    # Cancel the current session.
     #
-    # @param response [HTTP::Response] The HTTP response to parse.
-    # @return [Hash] The parsed response body.
-    def parse_response(response)
-      Response.deserialize(response.parse)
+    # @raise [SessionError] If there is no session to cancel.
+    # @return [void]
+    def cancel!
+      raise SessionError, "No session available to cancel" if @session.nil?
+
+      Cancel.call(session_id: session.response.id)
+    ensure
+      @session = nil
     end
 
-    # Updates the current session with the provided data.
-    #
-    # @param data [Hash] The session data to store.
-    # @return [Response] The updated current session.
-    def update_current_session(session_response)
-      ChatKit.current_info.session = session_response
-    end
-
-    # @param response [HTTP::Response] The HTTP response to parse.
-    #  @return [Hash] The parsed response body.
-    def parse!(response)
-      Response.deserialize(response.parse)
-    end
-
-    # @return [String] The endpoint URL for sessions.
-    def sessions_endpoint
-      Request::Endpoints.sessions_endpoint
-    end
+    # Refresh the current session.
+    #   @return [Session::Create] The refreshed session.
+    def refresh!
+      raise SessionError, "No session available to refresh" if @session.nil?
 
-    # @return [Hash] The headers for session requests.
-    def sessions_header
-      Request::Headers.sessions_header
+      session.call
     end
   end
 end

lib/chatkit/session/response.rb → lib/chatkit/session/base_response.rb

@@ -3,7 +3,7 @@
 module ChatKit
   class Session
     # Represents a session response.
-    class Response
+    class BaseResponse
       # @!attribute [r] id
       #  @return [String]
       attr_accessor :id