appwrite 30.0.1 → 30.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b6209eb5bb9a474ef36b247e72a8dd4c463cd05d1e476508ca1f65ce56b9af9
-  data.tar.gz: ae13a30f1c64aecbb4b9eb67f09c96b410b21ebb5494c353815f02c3a6df9482
+  metadata.gz: 9c35d8e3c83824afd1e8d35c31bbbfdb33f310a134ff0afbe30fb057e381f2fd
+  data.tar.gz: cdd1bc7c83964371ded48d9cfd0e5c90180f3800afee237a93a51b46355a9a77
 SHA512:
-  metadata.gz: 8f6567262f1bb8996ba8e1bd157706f153bcc650d536930bd6480a6301b7b3af4bcb326db202a080b6d9025a8d58ada7cfdb390031f1d76d5b86f6ec26c25654
-  data.tar.gz: 8bb14ef659726eae5d409cb16c8b57eff7928e2c1cf4221ee19b95c8e613d1d0584231fa576fa7ae6df67778d6266611afbdac386786effdc6fbad01776ef830
+  metadata.gz: c79caca1aae3712262e673ec9783d45ff5b8ae0ebb228f6f72d16c7bb07560dc3175165b360e963e5a5ddab5b788a9b9deee8561e8474cccd22b6c78bcbfc3f6
+  data.tar.gz: f33310aa668ff3bec30525a8d4c9056fb5578c52ae98976113aa2c36ad478f771f343284509b658242b41c454b35dc361bafd50599bce81ebd239eaad18d58c6

data/lib/appwrite/client.rb

@@ -14,8 +14,8 @@ module Appwrite
                 'x-sdk-name' => 'Ruby',
                 'x-sdk-platform' => 'server',
                 'x-sdk-language' => 'ruby',
-                'x-sdk-version' => '30.0.1',
-                'X-Appwrite-Response-Format' => '2.5.0'
+                'x-sdk-version' => '30.1.0',
+                'X-Appwrite-Response-Format' => '2.6.2'
             }
             @endpoint = 'https://cloud.appwrite.io/v1'
             @config = {}
@@ -235,6 +235,21 @@ module Appwrite
             @headers.dup
         end
 
+        # Encode a value as one path segment.
+        #
+        # Every byte but letters, digits and -_.!~*'() is escaped, as
+        # encodeURIComponent does, so a value fills exactly the segment it replaces.
+        #
+        # @param [String] value The path parameter value
+        #
+        # @return [String]
+        def encode_path(value)
+            segment = value.to_s
+            raise Appwrite::Exception.new('Path parameter cannot be "." or ".."') if ['.', '..'].include?(segment)
+
+            segment.b.gsub(/[^A-Za-z0-9\-_.!~*'()]/n) { |byte| format('%%%02X', byte.ord) }
+        end
+
         # Send the HTTP request.
         #
         # @param [String] method The HTTP method for the request
@@ -314,7 +329,7 @@ module Appwrite
                 begin
                     current = call(
                         method: "GET",
-                        path: "#{path}/#{params[id_param_name]}",
+                        path: "#{path}/#{encode_path(upload_id)}",
                         headers: headers,
                         params: {}
                     )
@@ -447,27 +462,26 @@ module Appwrite
             uri,
             headers,
             params,
-            response_type = nil,
-            limit = 5
+            response_type = nil
         )
-            raise ArgumentError, 'Too Many HTTP Redirects' if limit == 0
-
             http = Net::HTTP.new(uri.host, uri.port)
-            http.use_ssl = !@self_signed
+            http.use_ssl = uri.scheme == 'https'
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @self_signed
             payload = ''
 
             headers = @headers.merge(headers)
 
             params.compact!
 
-            @boundary = "----A30#3ad1"
             if method != "GET"
                 case headers[:'content-type']
                 when 'application/json'
                     payload = params.to_json
                 when 'multipart/form-data'
-                    payload = encode_form_data(params) + "--#{@boundary}--\r\n"
-                    headers[:'content-type'] = "multipart/form-data; boundary=#{@boundary}"
+                    # A fixed boundary lets file content end its part and add fields.
+                    boundary = "----#{SecureRandom.hex(16)}"
+                    payload = encode_form_data(params, boundary) + "--#{boundary}--\r\n"
+                    headers[:'content-type'] = "multipart/form-data; boundary=#{boundary}"
                 else
                     payload = encode(params)
                 end
@@ -491,10 +505,10 @@ module Appwrite
                 return location
             end
 
-            # Handle Redirects
-            if (response.class == Net::HTTPRedirection || response.class == Net::HTTPMovedPermanently)
-                uri = URI.parse(uri.scheme + "://" + uri.host + "" + location)
-                return fetch(method, uri, headers, {}, response_type, limit - 1)
+            # A redirect is reported, not followed: it would carry the API key to
+            # wherever it points, possibly another host.
+            if response.is_a?(Net::HTTPRedirection)
+                raise Appwrite::Exception.new("Redirect to #{location} not followed", response.code, nil, response.body)
             end
 
             if response.content_type == 'application/json'
@@ -541,27 +555,27 @@ module Appwrite
             String.new(response.body.to_s, encoding: encoding).encode(Encoding::UTF_8)
         end
 
-        def encode_form_data(value, key = nil)
+        def encode_form_data(value, boundary, key = nil)
             case value
             when Hash
-                return encode_form_data(value.to_json, key) unless key.nil?
+                return encode_form_data(value.to_json, boundary, key) unless key.nil?
 
-                value.map { |k, v| encode_form_data(v, k) }.join
+                value.map { |k, v| encode_form_data(v, boundary, k) }.join
             when Array
-                value.map { |v| encode_form_data(v, "#{key}[]") }.join
+                value.map { |v| encode_form_data(v, boundary, "#{key}[]") }.join
             when nil
                 ''
             else
                 post_body = []
                 if value.instance_of? InputFile
-                    post_body << "--#{@boundary}"
-                    post_body << "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{value.filename}\""
-                    post_body << "Content-Type: #{value.mime_type}"
+                    post_body << "--#{boundary}"
+                    post_body << "Content-Disposition: form-data; name=\"#{escape_form_data_name(key)}\"; filename=\"#{escape_form_data_name(value.filename)}\""
+                    post_body << "Content-Type: #{value.mime_type.to_s.delete("\r\n")}"
                     post_body << ""
                     post_body << value.data
                 else
-                    post_body << "--#{@boundary}"
-                    post_body << "Content-Disposition: form-data; name=\"#{key}\""
+                    post_body << "--#{boundary}"
+                    post_body << "Content-Disposition: form-data; name=\"#{escape_form_data_name(key)}\""
                     post_body << ""
                     post_body << value.to_s
                 end
@@ -569,6 +583,12 @@ module Appwrite
             end
         end
 
+        # Field and file names are quoted in the part headers; escape what would
+        # end the quoted string or the header line, as browsers do.
+        def escape_form_data_name(name)
+            name.to_s.gsub("\r", '%0D').gsub("\n", '%0A').gsub('"', '%22')
+        end
+
         def encode(value, key = nil)
             case value
             when Hash  then value.map { |k, v| encode(v, append_key(key, k)) }.join('&')

data/lib/appwrite/enums/appwrite_migration_resource.rb

@@ -0,0 +1,46 @@
+module Appwrite
+    module Enums
+        module AppwriteMigrationResource
+            USER = 'user'
+            TEAM = 'team'
+            MEMBERSHIP = 'membership'
+            AUTH_METHODS = 'auth-methods'
+            POLICIES = 'policies'
+            OAUTH2_PROVIDER = 'oauth2-provider'
+            DATABASE = 'database'
+            TABLE = 'table'
+            COLUMN = 'column'
+            INDEX = 'index'
+            ROW = 'row'
+            DOCUMENT = 'document'
+            ATTRIBUTE = 'attribute'
+            COLLECTION = 'collection'
+            DOCUMENTSDB = 'documentsdb'
+            VECTORSDB = 'vectorsdb'
+            BUCKET = 'bucket'
+            FILE = 'file'
+            FUNCTION = 'function'
+            DEPLOYMENT = 'deployment'
+            ENVIRONMENT_VARIABLE = 'environment-variable'
+            PROVIDER = 'provider'
+            TOPIC = 'topic'
+            SUBSCRIBER = 'subscriber'
+            MESSAGE = 'message'
+            SITE = 'site'
+            SITE_DEPLOYMENT = 'site-deployment'
+            SITE_VARIABLE = 'site-variable'
+            PLATFORM = 'platform'
+            API_KEY = 'api-key'
+            WEBHOOK = 'webhook'
+            SMTP = 'smtp'
+            BACKUP_POLICY = 'backup-policy'
+            PROJECT_VARIABLE = 'project-variable'
+            PROJECT_PROTOCOLS = 'project-protocols'
+            PROJECT_LABELS = 'project-labels'
+            PROJECT_SERVICES = 'project-services'
+            PROJECT_EMAIL_TEMPLATE = 'project-email-template'
+            PROJECT_ENVIRONMENT = 'project-environment'
+            RULE = 'rule'
+        end
+    end
+end

data/lib/appwrite/enums/build_runtime.rb

@@ -30,6 +30,7 @@ module Appwrite
             PYTHON_3_12 = 'python-3.12'
             PYTHON_3_13 = 'python-3.13'
             PYTHON_3_14 = 'python-3.14'
+            PYTHON_3_15 = 'python-3.15'
             PYTHON_ML_3_11 = 'python-ml-3.11'
             PYTHON_ML_3_12 = 'python-ml-3.12'
             PYTHON_ML_3_13 = 'python-ml-3.13'
@@ -38,6 +39,7 @@ module Appwrite
             DENO_2_0 = 'deno-2.0'
             DENO_2_5 = 'deno-2.5'
             DENO_2_6 = 'deno-2.6'
+            DENO_2_9 = 'deno-2.9'
             DART_2_15 = 'dart-2.15'
             DART_2_16 = 'dart-2.16'
             DART_2_17 = 'dart-2.17'
@@ -85,7 +87,9 @@ module Appwrite
             GO_1_24 = 'go-1.24'
             GO_1_25 = 'go-1.25'
             GO_1_26 = 'go-1.26'
+            GO_1_27 = 'go-1.27'
             RUST_1_83 = 'rust-1.83'
+            RUST_1_99 = 'rust-1.99'
             STATIC_1 = 'static-1'
             FLUTTER_3_24 = 'flutter-3.24'
             FLUTTER_3_27 = 'flutter-3.27'

data/lib/appwrite/enums/environment_resource.rb

@@ -0,0 +1,40 @@
+module Appwrite
+    module Enums
+        module EnvironmentResource
+            USER = 'user'
+            TEAM = 'team'
+            MEMBERSHIP = 'membership'
+            AUTH_METHODS = 'auth-methods'
+            POLICIES = 'policies'
+            OAUTH2_PROVIDER = 'oauth2-provider'
+            DATABASE = 'database'
+            DOCUMENTSDB = 'documentsdb'
+            VECTORSDB = 'vectorsdb'
+            TABLE = 'table'
+            COLLECTION = 'collection'
+            COLUMN = 'column'
+            ATTRIBUTE = 'attribute'
+            INDEX = 'index'
+            ROW = 'row'
+            DOCUMENT = 'document'
+            BUCKET = 'bucket'
+            FILE = 'file'
+            FUNCTION = 'function'
+            ENVIRONMENT_VARIABLE = 'environment-variable'
+            DEPLOYMENT = 'deployment'
+            SITE = 'site'
+            SITE_VARIABLE = 'site-variable'
+            SITE_DEPLOYMENT = 'site-deployment'
+            PROVIDER = 'provider'
+            TOPIC = 'topic'
+            SUBSCRIBER = 'subscriber'
+            PLATFORM = 'platform'
+            SMTP = 'smtp'
+            PROJECT_VARIABLE = 'project-variable'
+            PROJECT_PROTOCOLS = 'project-protocols'
+            PROJECT_LABELS = 'project-labels'
+            PROJECT_SERVICES = 'project-services'
+            PROJECT_EMAIL_TEMPLATE = 'project-email-template'
+        end
+    end
+end

data/lib/appwrite/enums/firebase_migration_resource.rb

@@ -0,0 +1,16 @@
+module Appwrite
+    module Enums
+        module FirebaseMigrationResource
+            USER = 'user'
+            DATABASE = 'database'
+            TABLE = 'table'
+            COLUMN = 'column'
+            ROW = 'row'
+            DOCUMENT = 'document'
+            ATTRIBUTE = 'attribute'
+            COLLECTION = 'collection'
+            BUCKET = 'bucket'
+            FILE = 'file'
+        end
+    end
+end

data/lib/appwrite/enums/n_host_migration_resource.rb

@@ -0,0 +1,17 @@
+module Appwrite
+    module Enums
+        module NHostMigrationResource
+            USER = 'user'
+            DATABASE = 'database'
+            TABLE = 'table'
+            COLUMN = 'column'
+            INDEX = 'index'
+            ROW = 'row'
+            DOCUMENT = 'document'
+            ATTRIBUTE = 'attribute'
+            COLLECTION = 'collection'
+            BUCKET = 'bucket'
+            FILE = 'file'
+        end
+    end
+end

data/lib/appwrite/enums/on_duplicate.rb

@@ -0,0 +1,9 @@
+module Appwrite
+    module Enums
+        module OnDuplicate
+            FAIL = 'fail'
+            SKIP = 'skip'
+            OVERWRITE = 'overwrite'
+        end
+    end
+end

data/lib/appwrite/enums/project_policy_id.rb

@@ -18,6 +18,7 @@ module Appwrite
             DENY_DISPOSABLE_EMAIL = 'deny-disposable-email'
             DENY_FREE_EMAIL = 'deny-free-email'
             DENY_CORPORATE_EMAIL = 'deny-corporate-email'
+            DENY_REALTIME_GUESTS = 'deny-realtime-guests'
             PASSKEY = 'passkey'
         end
     end

data/lib/appwrite/enums/runtime.rb

@@ -30,6 +30,7 @@ module Appwrite
             PYTHON_3_12 = 'python-3.12'
             PYTHON_3_13 = 'python-3.13'
             PYTHON_3_14 = 'python-3.14'
+            PYTHON_3_15 = 'python-3.15'
             PYTHON_ML_3_11 = 'python-ml-3.11'
             PYTHON_ML_3_12 = 'python-ml-3.12'
             PYTHON_ML_3_13 = 'python-ml-3.13'
@@ -38,6 +39,7 @@ module Appwrite
             DENO_2_0 = 'deno-2.0'
             DENO_2_5 = 'deno-2.5'
             DENO_2_6 = 'deno-2.6'
+            DENO_2_9 = 'deno-2.9'
             DART_2_15 = 'dart-2.15'
             DART_2_16 = 'dart-2.16'
             DART_2_17 = 'dart-2.17'
@@ -85,7 +87,9 @@ module Appwrite
             GO_1_24 = 'go-1.24'
             GO_1_25 = 'go-1.25'
             GO_1_26 = 'go-1.26'
+            GO_1_27 = 'go-1.27'
             RUST_1_83 = 'rust-1.83'
+            RUST_1_99 = 'rust-1.99'
             STATIC_1 = 'static-1'
             FLUTTER_3_24 = 'flutter-3.24'
             FLUTTER_3_27 = 'flutter-3.27'

data/lib/appwrite/enums/supabase_migration_resource.rb

@@ -0,0 +1,17 @@
+module Appwrite
+    module Enums
+        module SupabaseMigrationResource
+            USER = 'user'
+            DATABASE = 'database'
+            TABLE = 'table'
+            COLUMN = 'column'
+            INDEX = 'index'
+            ROW = 'row'
+            DOCUMENT = 'document'
+            ATTRIBUTE = 'attribute'
+            COLLECTION = 'collection'
+            BUCKET = 'bucket'
+            FILE = 'file'
+        end
+    end
+end

data/lib/appwrite/models/billing_plan.rb

@@ -31,6 +31,9 @@ module Appwrite
             attr_reader :sites
             attr_reader :executions
             attr_reader :executions_retention_count
+            attr_reader :deployment_retention
+            attr_reader :deployment_retention_max
+            attr_reader :deployments_retention_count
             attr_reader :gb_hours
             attr_reader :realtime
             attr_reader :realtime_messages
@@ -109,6 +112,9 @@ module Appwrite
                 sites:,
                 executions:,
                 executions_retention_count:,
+                deployment_retention: 0,
+                deployment_retention_max: 0,
+                deployments_retention_count: 0,
                 gb_hours:,
                 realtime:,
                 realtime_messages:,
@@ -186,6 +192,9 @@ module Appwrite
                 @sites = sites
                 @executions = executions
                 @executions_retention_count = executions_retention_count
+                @deployment_retention = deployment_retention
+                @deployment_retention_max = deployment_retention_max
+                @deployments_retention_count = deployments_retention_count
                 @gb_hours = gb_hours
                 @realtime = realtime
                 @realtime_messages = realtime_messages
@@ -267,6 +276,9 @@ module Appwrite
                     sites: map["sites"],
                     executions: map["executions"],
                     executions_retention_count: map["executionsRetentionCount"],
+                    deployment_retention: map["deploymentRetention"],
+                    deployment_retention_max: map["deploymentRetentionMax"],
+                    deployments_retention_count: map["deploymentsRetentionCount"],
                     gb_hours: map["GBHours"],
                     realtime: map["realtime"],
                     realtime_messages: map["realtimeMessages"],
@@ -348,6 +360,9 @@ module Appwrite
                     "sites": @sites,
                     "executions": @executions,
                     "executionsRetentionCount": @executions_retention_count,
+                    "deploymentRetention": @deployment_retention,
+                    "deploymentRetentionMax": @deployment_retention_max,
+                    "deploymentsRetentionCount": @deployments_retention_count,
                     "GBHours": @gb_hours,
                     "realtime": @realtime,
                     "realtimeMessages": @realtime_messages,

data/lib/appwrite/models/migration.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class Migration
+            attr_reader :id
+            attr_reader :created_at
+            attr_reader :updated_at
+            attr_reader :status
+            attr_reader :stage
+            attr_reader :source
+            attr_reader :destination
+            attr_reader :resources
+            attr_reader :resource_id
+            attr_reader :resource_internal_id
+            attr_reader :resource_type
+            attr_reader :parent_resource_id
+            attr_reader :parent_resource_internal_id
+            attr_reader :parent_resource_type
+            attr_reader :destination_resource_id
+            attr_reader :destination_resource_internal_id
+            attr_reader :destination_resource_type
+            attr_reader :status_counters
+            attr_reader :resource_data
+            attr_reader :errors
+            attr_reader :options
+
+            def initialize(
+                id:,
+                created_at:,
+                updated_at:,
+                status:,
+                stage:,
+                source:,
+                destination:,
+                resources:,
+                resource_id:,
+                resource_internal_id:,
+                resource_type:,
+                parent_resource_id:,
+                parent_resource_internal_id:,
+                parent_resource_type:,
+                destination_resource_id:,
+                destination_resource_internal_id:,
+                destination_resource_type:,
+                status_counters:,
+                resource_data:,
+                errors:,
+                options:
+            )
+                @id = id
+                @created_at = created_at
+                @updated_at = updated_at
+                @status = status
+                @stage = stage
+                @source = source
+                @destination = destination
+                @resources = resources
+                @resource_id = resource_id
+                @resource_internal_id = resource_internal_id
+                @resource_type = resource_type
+                @parent_resource_id = parent_resource_id
+                @parent_resource_internal_id = parent_resource_internal_id
+                @parent_resource_type = parent_resource_type
+                @destination_resource_id = destination_resource_id
+                @destination_resource_internal_id = destination_resource_internal_id
+                @destination_resource_type = destination_resource_type
+                @status_counters = status_counters
+                @resource_data = resource_data
+                @errors = errors
+                @options = options
+            end
+
+            def self.from(map:)
+                map = { "$id" => "", "$createdAt" => "", "$updatedAt" => "", "status" => "", "stage" => "", "source" => "", "destination" => "Appwrite", "resources" => [], "resourceId" => "", "resourceInternalId" => "", "resourceType" => "", "parentResourceId" => "", "parentResourceInternalId" => "", "parentResourceType" => "", "destinationResourceId" => "", "destinationResourceInternalId" => "", "destinationResourceType" => "", "statusCounters" => {}, "resourceData" => [], "errors" => [], "options" => {} }.merge(map)
+                Migration.new(
+                    id: map["$id"],
+                    created_at: map["$createdAt"],
+                    updated_at: map["$updatedAt"],
+                    status: map["status"],
+                    stage: map["stage"],
+                    source: map["source"],
+                    destination: map["destination"],
+                    resources: map["resources"],
+                    resource_id: map["resourceId"],
+                    resource_internal_id: map["resourceInternalId"],
+                    resource_type: map["resourceType"],
+                    parent_resource_id: map["parentResourceId"],
+                    parent_resource_internal_id: map["parentResourceInternalId"],
+                    parent_resource_type: map["parentResourceType"],
+                    destination_resource_id: map["destinationResourceId"],
+                    destination_resource_internal_id: map["destinationResourceInternalId"],
+                    destination_resource_type: map["destinationResourceType"],
+                    status_counters: map["statusCounters"],
+                    resource_data: map["resourceData"],
+                    errors: map["errors"],
+                    options: map["options"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "$createdAt": @created_at,
+                    "$updatedAt": @updated_at,
+                    "status": @status,
+                    "stage": @stage,
+                    "source": @source,
+                    "destination": @destination,
+                    "resources": @resources,
+                    "resourceId": @resource_id,
+                    "resourceInternalId": @resource_internal_id,
+                    "resourceType": @resource_type,
+                    "parentResourceId": @parent_resource_id,
+                    "parentResourceInternalId": @parent_resource_internal_id,
+                    "parentResourceType": @parent_resource_type,
+                    "destinationResourceId": @destination_resource_id,
+                    "destinationResourceInternalId": @destination_resource_internal_id,
+                    "destinationResourceType": @destination_resource_type,
+                    "statusCounters": @status_counters,
+                    "resourceData": @resource_data,
+                    "errors": @errors,
+                    "options": @options
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/migration_list.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class MigrationList
+            attr_reader :total
+            attr_reader :migrations
+
+            def initialize(
+                total:,
+                migrations:
+            )
+                @total = total
+                @migrations = migrations
+            end
+
+            def self.from(map:)
+                map = { "total" => 0, "migrations" => [] }.merge(map)
+                MigrationList.new(
+                    total: map["total"],
+                    migrations: map["migrations"].map { |it| Migration.from(map: it) }
+                )
+            end
+
+            def to_map
+                {
+                    "total": @total,
+                    "migrations": @migrations.map { |it| it.to_map }
+                }
+            end
+        end
+    end
+end

data/lib/appwrite/models/policy_deny_realtime_guests.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Appwrite
+    module Models
+        class PolicyDenyRealtimeGuests
+            attr_reader :id
+            attr_reader :enabled
+
+            def initialize(
+                id:,
+                enabled:
+            )
+                @id = id
+                @enabled = enabled
+            end
+
+            def self.from(map:)
+                map = { "$id" => "", "enabled" => false }.merge(map)
+                PolicyDenyRealtimeGuests.new(
+                    id: map["$id"],
+                    enabled: map["enabled"]
+                )
+            end
+
+            def to_map
+                {
+                    "$id": @id,
+                    "enabled": @enabled
+                }
+            end
+        end
+    end
+end