x_api_scraper 0.1.0

data/lib/xapi_scraper/sdk_hooks/hooks.rb

@@ -0,0 +1,99 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require_relative "./types"
+require_relative "./registration"
+
+module XapiScraper
+  module SDKHooks
+    class Hooks
+      extend T::Sig
+
+      sig { void }
+      def initialize
+        @sdk_init_hooks = T.let([], T::Array[AbstractSDKHook])
+        @before_request_hooks = T.let([], T::Array[AbstractSDKHook])
+        @after_success_hooks = T.let([], T::Array[AbstractSDKHook])
+        @after_error_hooks = T.let([], T::Array[AbstractSDKHook])
+        Registration.init_hooks(self)
+      end
+
+      sig { params(hook: AbstractSDKHook).void }
+      def register_sdk_init_hook(hook)
+        @sdk_init_hooks << hook
+      end
+
+      sig { params(hook: AbstractSDKHook).void }
+      def register_before_request_hook(hook)
+        @before_request_hooks << hook
+      end
+
+      sig { params(hook: AbstractSDKHook).void }
+      def register_after_success_hook(hook)
+        @after_success_hooks << hook
+      end
+
+      sig { params(hook: AbstractSDKHook).void }
+      def register_after_error_hook(hook)
+        @after_error_hooks << hook
+      end
+
+      sig { params(config: SDKConfiguration).returns(SDKConfiguration) }
+      def sdk_init(config:)
+        @sdk_init_hooks.each do |hook|
+          config = hook.sdk_init(config: config)
+        end
+
+        return config
+      end
+
+      sig do
+        params(
+          hook_ctx: BeforeRequestHookContext,
+          request: Faraday::Request
+        )
+          .returns(Faraday::Request)
+      end
+      def before_request(hook_ctx:, request:)
+        @before_request_hooks.each do |hook|
+          request = hook.before_request(hook_ctx: hook_ctx, request: request)
+        end
+
+        request
+      end
+
+      sig do
+        params(
+          hook_ctx: AfterSuccessHookContext,
+          response: Faraday::Response
+        )
+          .returns(Faraday::Response)
+      end
+      def after_success(hook_ctx:, response:)
+        @after_success_hooks.each do |hook|
+          response = hook.after_success(hook_ctx: hook_ctx, response: response)
+        end
+
+        response
+      end
+
+      sig do
+        params(
+          error: T.nilable(StandardError),
+          hook_ctx: AfterErrorHookContext,
+          response: T.nilable(Faraday::Response)
+        )
+          .returns(T.nilable(Faraday::Response))
+      end
+      def after_error(error:, hook_ctx:, response:)
+        @after_error_hooks.each do |hook|
+          response = hook.after_error(error: error, hook_ctx: hook_ctx, response: response)
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/xapi_scraper/sdk_hooks/registration.rb

@@ -0,0 +1,34 @@
+# typed: true
+# frozen_string_literal: true
+
+#
+# This file is only ever generated once on the first generation and then is free to be modified.
+# Any hooks you wish to add should be registered in the init_hooks method.
+#
+# Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance.
+#
+
+require_relative "./types"
+
+module XapiScraper
+  module SDKHooks
+    class Registration
+      extend T::Sig
+
+      sig do
+        params(
+          hooks: Hooks
+        )
+          .void
+      end
+      def self.init_hooks(hooks)
+        # example_hook = ExampleHook.new
+
+        # hooks.register_sdk_init_hook example_hook
+        # hooks.register_before_request_hook example_hook
+        # hooks.register_after_error_hook example_hook
+        # hooks.register_after_success_hook example_hook
+      end
+    end
+  end
+end

data/lib/xapi_scraper/sdk_hooks/types.rb

@@ -0,0 +1,180 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require_relative "../sdkconfiguration"
+
+module XapiScraper
+  module SDKHooks
+    class HookContext
+      extend T::Sig
+
+      sig { returns(SDKConfiguration) }
+      attr_accessor :config
+
+      sig { returns(String) }
+      attr_accessor :base_url
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :oauth2_scopes
+
+      sig { returns(String) }
+      attr_accessor :operation_id
+
+      sig { returns(T.nilable(T.proc.returns(T.untyped))) }
+      attr_accessor :security_source
+
+      sig do
+        params(
+          config: SDKConfiguration,
+          base_url: String,
+          oauth2_scopes: T.nilable(T::Array[String]),
+          operation_id: String,
+          security_source: T.nilable(T.proc.returns(T.untyped))
+        )
+          .void
+      end
+      def initialize(config:, base_url:, oauth2_scopes:, operation_id:, security_source:)
+        @config = T.let(config, SDKConfiguration)
+        @base_url = T.let(base_url, String)
+        @oauth2_scopes = T.let(oauth2_scopes, T.nilable(T::Array[String]))
+        @operation_id = T.let(operation_id, String)
+        @security_source = T.let(security_source, T.nilable(T.proc.returns(T.untyped)))
+      end
+    end
+
+    class BeforeRequestHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        )
+          .void
+      end
+      def initialize(hook_ctx:)
+        super(
+          config: hook_ctx.config,
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    class AfterSuccessHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        )
+          .void
+      end
+      def initialize(hook_ctx:)
+        super(
+          config: hook_ctx.config,
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    class AfterErrorHookContext < HookContext
+      extend T::Sig
+
+      sig do
+        params(
+          hook_ctx: HookContext
+        )
+          .void
+      end
+      def initialize(hook_ctx:)
+        super(
+          config: hook_ctx.config,
+          base_url: hook_ctx.base_url,
+          operation_id: hook_ctx.operation_id,
+          oauth2_scopes: hook_ctx.oauth2_scopes,
+          security_source: hook_ctx.security_source
+        )
+      end
+    end
+
+    module AbstractSDKInitHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig { overridable.params(config: SDKConfiguration).returns(SDKConfiguration) }
+      def sdk_init(config:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    module AbstractBeforeRequestHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        overridable
+          .params(
+            hook_ctx: BeforeRequestHookContext,
+            request: Faraday::Request
+          )
+          .returns(Faraday::Request)
+      end
+      def before_request(hook_ctx:, request:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    module AbstractAfterSuccessHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        overridable
+          .params(
+            hook_ctx: AfterSuccessHookContext,
+            response: Faraday::Response
+          )
+          .returns(Faraday::Response)
+      end
+      def after_success(hook_ctx:, response:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    module AbstractAfterErrorHook
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      sig do
+        overridable
+          .params(
+            error: T.nilable(StandardError),
+            hook_ctx: AfterErrorHookContext,
+            response: T.nilable(Faraday::Response)
+          )
+          .returns(T.nilable(Faraday::Response))
+      end
+      def after_error(error:, hook_ctx:, response:)
+        Kernel.raise NotImplementedError.new
+      end
+    end
+
+    class AbstractSDKHook
+      include AbstractSDKInitHook
+      include AbstractBeforeRequestHook
+      include AbstractAfterSuccessHook
+      include AbstractAfterErrorHook
+    end
+  end
+end

data/lib/xapi_scraper/sdkconfiguration.rb

@@ -0,0 +1,107 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "faraday/retry"
+require "sorbet-runtime"
+
+require_relative "sdk_hooks/hooks"
+require_relative "utils/retries"
+
+module XapiScraper
+  extend T::Sig
+
+  # TwexAPI production API
+  SERVER_PRODUCTION = :production
+  SERVERS = T.let(
+    {
+      production: "https://api.twexapi.io"
+    }.freeze,
+    T::Hash[T.any(String, Symbol), String]
+  )
+  # Contains the list of servers available to the SDK
+
+  class SDKConfiguration
+    extend T::Sig
+
+    sig { returns(T.nilable(Faraday::Connection)) }
+    attr_accessor :client
+
+    sig { returns(::XapiScraper::SDKHooks::Hooks) }
+    attr_accessor :hooks
+
+    sig { returns(T.nilable(::XapiScraper::Utils::RetryConfig)) }
+    attr_accessor :retry_config
+
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    sig { returns(T.nilable(T.proc.returns(T.nilable(Models::Components::Security)))) }
+    attr_accessor :security_source
+
+    sig { returns(T.nilable(String)) }
+    attr_accessor :server_url
+
+    sig { returns(Symbol) }
+    attr_accessor :server
+
+    sig { returns(String) }
+    attr_accessor :language
+
+    sig { returns(String) }
+    attr_accessor :openapi_doc_version
+
+    sig { returns(String) }
+    attr_accessor :sdk_version
+
+    sig { returns(String) }
+    attr_accessor :gen_version
+
+    sig { returns(String) }
+    attr_accessor :user_agent
+
+    sig do
+      params(
+        client: T.nilable(Faraday::Connection),
+        hooks: ::XapiScraper::SDKHooks::Hooks,
+        retry_config: T.nilable(::XapiScraper::Utils::RetryConfig),
+        timeout_ms: T.nilable(Integer),
+        bearer_auth: T.nilable(::String),
+        security_source: T.nilable(T.proc.returns(Models::Components::Security)),
+        server_url: T.nilable(String),
+        server: T.nilable(Symbol)
+      )
+        .void
+    end
+    def initialize(client, hooks, retry_config, timeout_ms, bearer_auth, security_source, server_url, server)
+      @client = client
+      @hooks = hooks
+      @retry_config = retry_config
+      @server_url = server_url
+      @timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      @server = server.nil? ? SERVER_PRODUCTION : server
+      raise StandardError, "Invalid server \"#{server}\"" if !SERVERS.key?(@server)
+      if !security_source.nil?
+        @security_source = security_source
+      elsif !bearer_auth.nil?
+        @security_source = -> { Models::Components::Security.new(bearer_auth: bearer_auth) }
+      end
+
+      @language = "ruby"
+      @openapi_doc_version = "1.0.0"
+      @sdk_version = "0.1.0"
+      @gen_version = "2.932.9"
+      @user_agent = "speakeasy-sdk/ruby 0.1.0 2.932.9 1.0.0 x_api_scraper"
+    end
+
+    sig { returns([String, T::Hash[Symbol, String]]) }
+    def get_server_details
+      return [@server_url.delete_suffix("/"), {}] if !@server_url.nil?
+      @server = T.must(@server)
+      [T.must(SERVERS[@server]), {}]
+    end
+  end
+end

data/lib/xapi_scraper/sdkconfiguration.rbi

@@ -0,0 +1,83 @@
+# typed: true
+
+class XapiScraper::SDKConfiguration
+  extend ::Crystalline::MetadataFields::ClassMethods
+
+  def client
+  end
+
+  def client=(client)
+  end
+
+  def gen_version
+  end
+
+  def gen_version=(gen_version)
+  end
+
+  def hooks
+  end
+
+  def hooks=(hooks)
+  end
+
+  def language
+  end
+
+  def language=(language)
+  end
+
+  def openapi_doc_version
+  end
+
+  def openapi_doc_version=(openapi_doc_version)
+  end
+
+  def retry_config
+  end
+
+  def retry_config=(retry_config)
+  end
+
+  def sdk_version
+  end
+
+  def sdk_version=(sdk_version)
+  end
+
+  def security_source
+  end
+
+  def security_source=(security_source)
+  end
+
+  def server
+  end
+
+  def server=(server)
+  end
+
+  def server_params
+  end
+
+  def server_params=(server_params)
+  end
+
+  def server_url
+  end
+
+  def server_url=(server_url)
+  end
+
+  def timeout
+  end
+
+  def timeout=(timeout)
+  end
+
+  def user_agent
+  end
+
+  def user_agent=(user_agent)
+  end
+end