onlyoffice-docs_integration_sdk 0.1.0

data/lib/onlyoffice/docs_integration_sdk/document_server.rb

@@ -0,0 +1,29 @@
+#
+# (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
+    # @since 0.1.0
+    module DocumentServer; end
+  end
+end
+
+require_relative "document_server/client"

data/lib/onlyoffice/docs_integration_sdk/document_storage/callback.rb

@@ -0,0 +1,276 @@
+#
+# (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 DocumentStorage
+      # @since 0.1.0
+      module Callback
+        # @since 0.1.0
+        class Request < T::Struct
+          extend T::Sig
+
+          # @since 0.1.0
+          class Action < T::Struct
+            extend T::Sig
+
+            # @since 0.1.0
+            class Type < T::Enum
+              extend T::Sig
+
+              enums do
+                # @since 0.1.0
+                Disconnect = new(0)
+
+                # @since 0.1.0
+                Connect = new(1)
+
+                # @since 0.1.0
+                ForceSave = new(2)
+              end
+
+              # description returns the human-readable description of the type.
+              #
+              # @since 0.1.0
+              sig {returns(String)}
+              def description
+                case self
+                when Disconnect
+                  "The user disconnects from the document co-editing"
+                when Connect
+                  "The new user connects to the document co-editing"
+                when ForceSave
+                  "The user clicks the forcesave button"
+                else
+                  # :nocov:
+                  # unreachable
+                  # :nocov:
+                end
+              end
+            end
+
+            # @since 0.1.0
+            prop :type, T.nilable(Type), name: "type"
+
+            # @since 0.1.0
+            prop :user_id, T.nilable(String), name: "userid"
+
+            # @since 0.1.0
+            sig {params(hash: T.untyped, strict: T.untyped).returns(Action)}
+            def self.from_hash(hash, strict = nil)
+              super(hash, strict)
+            end
+          end
+
+          # @since 0.1.0
+          class ForceSaveType < T::Enum
+            enums do
+              # @since 0.1.0
+              Command = new(0)
+
+              # @since 0.1.0
+              Save = new(1)
+
+              # @since 0.1.0
+              Time = new(2)
+
+              # @since 0.1.0
+              Submit = new(3)
+            end
+          end
+
+          # @since 0.1.0
+          class FormData < T::Struct
+            extend T::Sig
+
+            # @since 0.1.0
+            class Type < T::Enum
+              enums do
+                # @since 0.1.0
+                Text = new("text")
+
+                # @since 0.1.0
+                CheckBox = new("checkBox")
+
+                # @since 0.1.0
+                Picture = new("picture")
+
+                # @since 0.1.0
+                ComboBox = new("comboBox")
+
+                # @since 0.1.0
+                DropDownList = new("dropDownList")
+
+                # @since 0.1.0
+                DateTime = new("dateTime")
+
+                # @since 0.1.0
+                Radio = new("radio")
+              end
+            end
+
+            # @since 0.1.0
+            prop :key, T.nilable(String), name: "key"
+
+            # @since 0.1.0
+            prop :tag, T.nilable(String), name: "tag"
+
+            # @since 0.1.0
+            prop :value, T.nilable(String), name: "value"
+
+            # @since 0.1.0
+            prop :type, T.nilable(Type), name: "type"
+
+            # @since 0.1.0
+            sig {params(hash: T.untyped, strict: T.untyped).returns(FormData)}
+            def self.from_hash(hash, strict = nil)
+              super(hash, strict)
+            end
+          end
+
+          # @since 0.1.0
+          class History < T::Struct
+            extend T::Sig
+
+            # @since 0.1.0
+            prop :changes, T.nilable(T::Hash[T.untyped, T.untyped]), name: "changes"
+
+            # @since 0.1.0
+            prop :server_version, T.nilable(String), name: "serverVersion"
+
+            # @since 0.1.0
+            sig {params(hash: T.untyped, strict: T.untyped).returns(History)}
+            def self.from_hash(hash, strict = nil)
+              super(hash, strict)
+            end
+          end
+
+          # @since 0.1.0
+          class Status < T::Enum
+            extend T::Sig
+
+            enums do
+              # @since 0.1.0
+              Editing = new(1)
+
+              # @since 0.1.0
+              Save = new(2)
+
+              # @since 0.1.0
+              SaveError = new(3)
+
+              # @since 0.1.0
+              Closed = new(4)
+
+              # @since 0.1.0
+              ForceSave = new(6)
+
+              # @since 0.1.0
+              ForceSaveError = new(7)
+            end
+
+            # description returns the human-readable description of the status.
+            #
+            # @since 0.1.0
+            sig {returns(String)}
+            def description
+              case self
+              when Editing
+                "The document is being edited"
+              when Save
+                "The document is ready to be saved"
+              when SaveError
+                "An error occurred while saving the document"
+              when Closed
+                "The document was closed without changes"
+              when ForceSave
+                "Editing of the document continues, but the current state of the document is saved"
+              when ForceSaveError
+                "An error occurred while forcing the document to be saved"
+              else
+                # :nocov:
+                # unreachable
+                # :nocov:
+              end
+            end
+          end
+
+          # @since 0.1.0
+          prop :actions, T.nilable(T::Array[Action]), name: "actions"
+
+          # @deprecated Use {history} instead. This property is deprecated since Document Server version 4.2.
+          # @since 0.1.0
+          prop :changeshistory, T.nilable(T::Array[T.untyped]), name: "changeshistory"
+
+          # @since 0.1.0
+          prop :changesurl, T.nilable(String), name: "changesurl"
+
+          # @since 0.1.0
+          prop :filetype, T.nilable(String), name: "filetype"
+
+          # @since 0.1.0
+          prop :forcesavetype, T.nilable(ForceSaveType), name: "forcesavetype"
+
+          # @since 0.1.0
+          prop :formsdataurl, T.nilable(String), name: "formsdataurl"
+
+          # @since 0.1.0
+          prop :history, T.nilable(History), name: "history"
+
+          # @since 0.1.0
+          prop :key, T.nilable(String), name: "key"
+
+          # @since 0.1.0
+          prop :status, T.nilable(Status), name: "status"
+
+          # @since 0.1.0
+          prop :url, T.nilable(String), name: "url"
+
+          # @since 0.1.0
+          prop :userdata, T.nilable(String), name: "userdata"
+
+          # @since 0.1.0
+          prop :users, T.nilable(T::Array[String]), name: "users"
+
+          # @since 0.1.0
+          sig {params(hash: T.untyped, strict: T.untyped).returns(Request)}
+          def self.from_hash(hash, strict = nil)
+            super(hash, strict)
+          end
+        end
+
+        # @since 0.1.0
+        class Response < T::Struct
+          extend T::Sig
+
+          # @since 0.1.0
+          prop :error, Integer, name: "error"
+
+          # @since 0.1.0
+          sig {params(hash: T.untyped, strict: T.untyped).returns(Response)}
+          def self.from_hash(hash, strict = nil)
+            super(hash, strict)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_storage/callback_test.rb

@@ -0,0 +1,291 @@
+#
+# (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 "callback"
+
+module Onlyoffice
+  module DocsIntegrationSdk
+    module DocumentStorage
+      module Callback
+        class Request
+          class Action
+            class TypeTest < ::Test::Unit::TestCase
+              extend T::Sig
+              include Test::DescriptiveEnumMarshalling
+
+              sig {override.returns(T::Array[[Integer, String, Type]])}
+              def cases
+                [
+                  [
+                    0,
+                    "The user disconnects from the document co-editing",
+                    Type::Disconnect,
+                  ],
+                  [
+                    1,
+                    "The new user connects to the document co-editing",
+                    Type::Connect,
+                  ],
+                  [
+                    2,
+                    "The user clicks the forcesave button",
+                    Type::ForceSave,
+                  ],
+                ]
+              end
+            end
+          end
+
+          class ActionTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::StructMarshalling
+
+            sig {override.returns(T::Array[[T.untyped, Action]])}
+            def cases
+              [
+                [
+                  {},
+                  Action.new,
+                ],
+                [
+                  {
+                    "type" => 0,
+                    "userid" => "user",
+                  },
+                  Action.new(
+                    type: Action::Type::Disconnect,
+                    user_id: "user",
+                  ),
+                ],
+              ]
+            end
+          end
+
+          class ForceSaveTypeTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::BasicEnumMarshalling
+
+            sig {override.returns(T::Array[[Integer, ForceSaveType]])}
+            def cases
+              [
+                [0, ForceSaveType::Command],
+                [1, ForceSaveType::Save],
+                [2, ForceSaveType::Time],
+                [3, ForceSaveType::Submit],
+              ]
+            end
+          end
+
+          class FormData
+            class TypeTest < ::Test::Unit::TestCase
+              extend T::Sig
+              include Test::BasicEnumMarshalling
+
+              sig {override.returns(T::Array[[String, Type]])}
+              def cases
+                [
+                  ["text", Type::Text],
+                  ["checkBox", Type::CheckBox],
+                  ["picture", Type::Picture],
+                  ["comboBox", Type::ComboBox],
+                  ["dropDownList", Type::DropDownList],
+                  ["dateTime", Type::DateTime],
+                  ["radio", Type::Radio],
+                ]
+              end
+            end
+          end
+
+          class FormDataTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::StructMarshalling
+
+            sig {override.returns(T::Array[[T.untyped, FormData]])}
+            def cases
+              [
+                [
+                  {},
+                  FormData.new,
+                ],
+                [
+                  {
+                    "key" => "text_1",
+                    "tag" => "label",
+                    "value" => "hello",
+                    "type" => "text",
+                  },
+                  FormData.new(
+                    key: "text_1",
+                    tag: "label",
+                    value: "hello",
+                    type: FormData::Type::Text,
+                  ),
+                ],
+              ]
+            end
+          end
+
+          class HistoryTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::StructMarshalling
+
+            sig {override.returns(T::Array[[T.untyped, History]])}
+            def cases
+              [
+                [
+                  {},
+                  History.new,
+                ],
+                [
+                  {
+                    "changes" => {},
+                    "serverVersion" => "1.0",
+                  },
+                  History.new(
+                    changes: {},
+                    server_version: "1.0",
+                  ),
+                ],
+              ]
+            end
+          end
+
+          class StatusTest < ::Test::Unit::TestCase
+            extend T::Sig
+            include Test::DescriptiveEnumMarshalling
+
+            sig {override.returns(T::Array[[Integer, String, Status]])}
+            def cases
+              [
+                [
+                  1,
+                  "The document is being edited",
+                  Status::Editing,
+                ],
+                [
+                  2,
+                  "The document is ready to be saved",
+                  Status::Save,
+                ],
+                [
+                  3,
+                  "An error occurred while saving the document",
+                  Status::SaveError,
+                ],
+                [
+                  4,
+                  "The document was closed without changes",
+                  Status::Closed,
+                ],
+                [
+                  6,
+                  "Editing of the document continues, but the current state of the document is saved",
+                  Status::ForceSave,
+                ],
+                [
+                  7,
+                  "An error occurred while forcing the document to be saved",
+                  Status::ForceSaveError,
+                ],
+              ]
+            end
+          end
+        end
+
+        class RequestTest < ::Test::Unit::TestCase
+          extend T::Sig
+          include Test::StructMarshalling
+
+          sig {override.returns(T::Array[[T.untyped, Request]])}
+          def cases
+            [
+              [
+                {},
+                Request.new,
+              ],
+              [
+                {
+                  "actions" => [
+                    {
+                      "type" => 0,
+                    },
+                  ],
+                  "changeshistory" => [],
+                  "changesurl" => "http://localhost:8080/",
+                  "filetype" => "pdf",
+                  "forcesavetype" => 0,
+                  "formsdataurl" => "http://localhost:8080/",
+                  "history" => {
+                    "changes" => {},
+                  },
+                  "key" => "***",
+                  "status" => 1,
+                  "url" => "http://localhost:8080/",
+                  "userdata" => "data",
+                  "users" => ["user_1"],
+                },
+                Request.new(
+                  actions: [
+                    Request::Action.new(
+                      type: Request::Action::Type::Disconnect,
+                    ),
+                  ],
+                  changeshistory: [],
+                  changesurl: "http://localhost:8080/",
+                  filetype: "pdf",
+                  forcesavetype: Request::ForceSaveType::Command,
+                  formsdataurl: "http://localhost:8080/",
+                  history: Request::History.new(
+                    changes: {},
+                  ),
+                  key: "***",
+                  status: Request::Status::Editing,
+                  url: "http://localhost:8080/",
+                  userdata: "data",
+                  users: ["user_1"],
+                ),
+              ],
+            ]
+          end
+        end
+
+        class ResponseTest < ::Test::Unit::TestCase
+          extend T::Sig
+          include Test::StructMarshalling
+
+          sig {override.returns(T::Array[[T.untyped, Response]])}
+          def cases
+            [
+              [
+                {
+                  "error" => 0,
+                },
+                Response.new(
+                  error: 0,
+                ),
+              ],
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice/docs_integration_sdk/document_storage.rb

@@ -0,0 +1,29 @@
+#
+# (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
+    # @since 0.1.0
+    module DocumentStorage; end
+  end
+end
+
+require_relative "document_storage/callback"