onlyoffice-docs_integration_sdk 0.1.0

data/lib/onlyoffice/docs_integration_sdk/document_server/client/healthcheck.rb

@@ -0,0 +1,101 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: false
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require_relative "response"
+require_relative "service"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        # HealthcheckServing is an interface that describes the methods that
+        # must be implemented to be considered a healthcheck service.
+        #
+        # @since 0.1.0
+        module HealthcheckServing
+          extend T::Sig
+          extend T::Helpers
+          interface!
+
+          sig {abstract.returns(Response)}
+          def do; end
+        end
+
+        # HealthcheckService is an implementation of the {HealthcheckServing}
+        # interface.
+        #
+        # @since 0.1.0
+        class HealthcheckService < Service
+          include HealthcheckServing
+
+          # Error is an enum that represents the possible errors that can occur
+          # when using the healthcheck service.
+          #
+          # @since 0.1.0
+          class Error < T::Enum
+            extend T::Sig
+
+            enums do
+              # @since 0.1.0
+              Failed = new(-1)
+            end
+
+            # description returns the human-readable description of the error.
+            #
+            # @since 0.1.0
+            sig {returns(String)}
+            def description
+              case self
+              when Failed
+                "Healthcheck failed"
+              else
+                # :nocov:
+                # unreachable
+                # :nocov:
+              end
+            end
+          end
+
+          # do makes a healthcheck request to the Document Server.
+          #
+          # @return A response
+          # @since 0.1.0
+          sig {override.returns(Response)}
+          def do
+            c, res = @client.get("healthcheck")
+            if res.error
+              return res
+            end
+
+            if !c.is_a?(TrueClass)
+              res = Response.new(
+                request: res.request,
+                response: res.response,
+                error: Error::Failed,
+              )
+            end
+
+            res
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/healthcheck_test.rb

@@ -0,0 +1,209 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: true
+# frozen_string_literal: true
+
+require "test/unit"
+require_relative "../../jwt"
+require_relative "../../test_test"
+require_relative "../client_test"
+require_relative "healthcheck"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        class HealthcheckService
+          class ErrorTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::DescriptiveEnumMarshalling
+
+            sig {override.returns(T::Array[[Integer, String, Error]])}
+            def cases
+              [
+                [
+                  -1,
+                  "Healthcheck failed",
+                  Error::Failed,
+                ]
+              ]
+            end
+          end
+        end
+
+        class HealthcheckServiceTest < ::Test::Unit::TestCase
+          extend T::Sig
+          include Test::DocumentServer::Client
+
+          def test_do_does
+            t = self
+
+            m = "GET"
+            u = T.cast(URI.parse("http://localhost:8080/"), URI::HTTP)
+            p = T.cast(URI.join(u.to_s, "healthcheck"), URI::HTTP)
+            h = T.let(Net::HTTP.new(u.hostname, u.port), Net::HTTP)
+
+            h.define_singleton_method(:request) do |req, body = nil, &block|
+              t.check_request_basics(m, p, req)
+              t.check_request_headers(m, u, req)
+              t.assert_nil(req.body)
+              t.assert_nil(body)
+              t.assert_nil(block)
+              t.create_ok("true")
+            end
+
+            c = Client.new(base_uri: u, http: h)
+
+            res = c.healthcheck.do
+            assert_nil(res.error)
+
+            assert_equal("true", res.response.body)
+          end
+
+          def test_do_does_with_the_subpath
+            t = self
+
+            m = "GET"
+            u = T.cast(URI.parse("http://localhost:8080/sub/"), URI::HTTP)
+            p = T.cast(URI.join(u.to_s, "healthcheck"), URI::HTTP)
+            h = T.let(Net::HTTP.new(u.hostname, u.port), Net::HTTP)
+
+            h.define_singleton_method(:request) do |req, body = nil, &block|
+              t.check_request_basics(m, p, req)
+              t.check_request_headers(m, u, req)
+              t.assert_nil(req.body)
+              t.assert_nil(body)
+              t.assert_nil(block)
+              t.create_ok("true")
+            end
+
+            c = Client.new(base_uri: u, http: h)
+
+            res = c.healthcheck.do
+            assert_nil(res.error)
+
+            assert_equal("true", res.response.body)
+          end
+
+          def test_do_does_with_the_user_agent
+            t = self
+
+            m = "GET"
+            u = T.cast(URI.parse("http://localhost:8080/"), URI::HTTP)
+            p = T.cast(URI.join(u.to_s, "healthcheck"), URI::HTTP)
+            h = T.let(Net::HTTP.new(u.hostname, u.port), Net::HTTP)
+
+            h.define_singleton_method(:request) do |req, body = nil, &block|
+              t.check_request_basics(m, p, req)
+              t.check_request_headers_with_custom_user_agent(m, u, "my-agent", req)
+              t.assert_nil(req.body)
+              t.assert_nil(body)
+              t.assert_nil(block)
+              t.create_ok("true")
+            end
+
+            c = Client.new(base_uri: u, http: h, user_agent: "my-agent")
+
+            res = c.healthcheck.do
+            assert_nil(res.error)
+
+            assert_equal("true", res.response.body)
+          end
+
+          def test_do_does_with_the_jwt
+            t = self
+
+            w = DocsIntegrationSdk::Jwt.new(secret: "***")
+            m = "GET"
+            u = T.cast(URI.parse("http://localhost:8080/"), URI::HTTP)
+            p = T.cast(URI.join(u.to_s, "healthcheck"), URI::HTTP)
+            h = T.let(Net::HTTP.new(u.hostname, u.port), Net::HTTP)
+
+            h.define_singleton_method(:request) do |req, body = nil, &block|
+              t.check_request_basics(m, p, req)
+              t.check_request_headers(m, u, req)
+              t.assert_nil(req.body)
+              t.assert_nil(body)
+              t.assert_nil(block)
+              t.create_ok("true")
+            end
+
+            j = Jwt.new(jwt: w)
+            c = Client.new(base_uri: u, http: h).with_jwt(j)
+
+            res = c.healthcheck.do
+            assert_nil(res.error)
+
+            assert_equal("true", res.response.body)
+          end
+
+          def test_do_returns_an_error_if_the_response_body_is_invalid_json
+            t = self
+
+            m = "GET"
+            u = T.cast(URI.parse("http://localhost:8080/"), URI::HTTP)
+            p = T.cast(URI.join(u.to_s, "healthcheck"), URI::HTTP)
+            h = T.let(Net::HTTP.new(u.hostname, u.port), Net::HTTP)
+
+            h.define_singleton_method(:request) do |req, body = nil, &block|
+              t.check_request_basics(m, p, req)
+              t.check_request_headers(m, u, req)
+              t.assert_nil(req.body)
+              t.assert_nil(body)
+              t.assert_nil(block)
+              t.create_ok("}")
+            end
+
+            c = Client.new(base_uri: u, http: h)
+
+            res = c.healthcheck.do
+
+            err = T.cast(res.error, JSON::ParserError)
+            assert_equal("unexpected token at '}'", err.message)
+
+            assert_equal("}", res.response.body)
+          end
+
+          def test_do_returns_an_error_if_the_doing_fails
+            t = self
+
+            m = "GET"
+            u = T.cast(URI.parse("http://localhost:8080/"), URI::HTTP)
+            p = T.cast(URI.join(u.to_s, "healthcheck"), URI::HTTP)
+            h = T.let(Net::HTTP.new(u.hostname, u.port), Net::HTTP)
+
+            h.define_singleton_method(:request) do |req, body = nil, &block|
+              t.check_request_basics(m, p, req)
+              t.check_request_headers(m, u, req)
+              t.assert_nil(req.body)
+              t.assert_nil(body)
+              t.assert_nil(block)
+              t.create_ok("false")
+            end
+
+            c = Client.new(base_uri: u, http: h)
+
+            res = c.healthcheck.do
+            assert_equal(HealthcheckService::Error::Failed, res.error)
+
+            assert_equal("false", res.response.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/jwt.rb

@@ -0,0 +1,116 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require_relative "../../jwt"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        # Jwt is a class that represents the JWT token configuration for the
+        # Document Server client.
+        #
+        # @since 0.1.0
+        class Jwt
+          extend T::Sig
+
+          # Location is an enum that represents the location of the JWT token in
+          # the request.
+          #
+          # @since 0.1.0
+          class Location < T::Enum
+            enums do
+              # Header is the location of the JWT token in the request header.
+              #
+              # @since 0.1.0
+              Header = new("header")
+
+              # Body is the location of the JWT token in the request body.
+              #
+              # @since 0.1.0
+              Body = new("body")
+            end
+          end
+
+          # jwt is the JWT token encoding configuration.
+          #
+          # @since 0.1.0
+          sig {returns(JwtEncoding)}
+          attr_reader :jwt
+
+          # locations is the list of locations of the JWT token in the request.
+          #
+          # @since 0.1.0
+          sig {returns(T::Array[Location])}
+          attr_reader :locations
+
+          # header is the header name of the JWT token in the request.
+          #
+          # @example
+          #   req[jwt.header] = "#{jwt.schema} #{jwt.jwt.encode_header(payload)}"
+          #
+          # @since 0.1.0
+          sig {returns(String)}
+          attr_reader :header
+
+          # schema is the schema of the JWT token in the request.
+          #
+          # @example
+          #   req[jwt.header] = "#{jwt.schema} #{jwt.jwt.encode_header(payload)}"
+          #
+          # @since 0.1.0
+          sig {returns(String)}
+          attr_reader :schema
+
+          # initialize initializes a new Jwt instance. It makes a shallow copy
+          # of the locations list.
+          #
+          # @param jwt
+          #   The JWT token encoding configuration.
+          # @param locations
+          #   The list of locations of the JWT token in the request.
+          # @param header
+          #   The header name of the JWT token in the request.
+          # @param schema
+          #   The schema of the JWT token in the request.
+          sig do
+            params(
+              jwt: JwtEncoding,
+              locations: T::Array[Location],
+              header: String,
+              schema: String,
+            ).void
+          end
+          def initialize(
+            jwt:,
+            locations: [Location::Header, Location::Body],
+            header: "Authorization",
+            schema: "Bearer"
+          )
+            @jwt = jwt
+            @locations = T.let(locations.clone, T::Array[Location])
+            @header = header
+            @schema = schema
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/jwt_test.rb

@@ -0,0 +1,70 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: true
+# frozen_string_literal: true
+
+require "test/unit"
+require_relative "../../test_test"
+require_relative "jwt"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        class Jwt
+          class LocationTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::BasicEnumMarshalling
+
+            sig {override.returns(T::Array[[String, Location]])}
+            def cases
+              [
+                ["header", Location::Header],
+                ["body", Location::Body],
+              ]
+            end
+          end
+        end
+
+        class JwtTest < ::Test::Unit::TestCase
+          def test_initialize_initializes_with_default_values
+            w = DocsIntegrationSdk::Jwt.new(secret: "***")
+            j = Jwt.new(jwt: w)
+            assert_equal(w, j.jwt)
+            assert_equal([Jwt::Location::Header, Jwt::Location::Body], j.locations)
+            assert_equal("Authorization", j.header)
+            assert_equal("Bearer", j.schema)
+          end
+
+          def test_initialize_initializes_with_custom_values
+            w = DocsIntegrationSdk::Jwt.new(secret: "***")
+            j = Jwt.new(
+              jwt: w,
+              locations: [Jwt::Location::Body],
+              header: "X-Auth",
+              schema: "Token"
+            )
+            assert_equal(w, j.jwt)
+            assert_equal([Jwt::Location::Body], j.locations)
+            assert_equal("X-Auth", j.header)
+            assert_equal("Token", j.schema)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/response.rb

@@ -0,0 +1,73 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: strict
+# frozen_string_literal: true
+
+require "net/http"
+require "sorbet-runtime"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        # Response is a class that represents the response from the Document
+        # Server.
+        #
+        # @since 0.1.0
+        class Response
+          extend T::Sig
+
+          # request is the request that was sent to the Document Server.
+          #
+          # @since 0.1.0
+          sig {returns(Net::HTTPRequest)}
+          attr_reader :request
+
+          # response is the response from the Document Server.
+          #
+          # @since 0.1.0
+          sig {returns(Net::HTTPResponse)}
+          attr_reader :response
+
+          # error is the error that occurred when sending the request.
+          #
+          # @since 0.1.0
+          sig {returns(T.nilable(Object))}
+          attr_reader :error
+
+          # initialize initializes a new Response instance.
+          #
+          # @param request The request that was sent to the Document Server.
+          # @param response The response from the Document Server.
+          # @param error The error that occurred when sending the request.
+          sig do
+            params(
+              request: Net::HTTPRequest,
+              response: Net::HTTPResponse,
+              error: T.nilable(Object),
+            ).void
+          end
+          def initialize(request:, response:, error: nil)
+            @request = request
+            @response = response
+            @error = error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/response_test.rb

@@ -0,0 +1,49 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: true
+# frozen_string_literal: true
+
+require "test/unit"
+require_relative "response"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        class ResponseTest < ::Test::Unit::TestCase
+          def test_initialize_initializes_with_default_values
+            req = Net::HTTP::Get.new("http://localhost:8080/")
+            res = Net::HTTPResponse.new("1.1", "200", "OK")
+            r = Response.new(request: req, response: res)
+            assert_equal(req, r.request)
+            assert_equal(res, r.response)
+            assert_nil(r.error)
+          end
+
+          def test_initialize_initializes_with_custom_values
+            req = Net::HTTP::Get.new("http://localhost:8080/")
+            res = Net::HTTPResponse.new("1.1", "200", "OK")
+            r = Response.new(request: req, response: res, error: "error")
+            assert_equal(req, r.request)
+            assert_equal(res, r.response)
+            assert_equal("error", r.error)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/service.rb

@@ -0,0 +1,44 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        # Service is a base class for all services.
+        #
+        # @since 0.1.0
+        class Service
+          extend T::Sig
+          extend T::Helpers
+          abstract!
+
+          # @param client The client instance.
+          # @since 0.1.0
+          sig {overridable.params(client: Client).void}
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_server/client/ua.rb

@@ -0,0 +1,31 @@
+#
+# (c) Copyright Ascensio System SIA 2025
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require_relative "../../version"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentServer
+      class Client
+        USER_AGENT = T.let("com.onlyoffice.docs-integration-sdk-ruby #{VERSION}", String)
+      end
+    end
+  end
+end