Class: Appwrite::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/appwrite/client.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Client

Returns a new instance of Client.



11
12
13
14
15
16
17
18
19
 
# File 'lib/appwrite/client.rb', line 11

def initialize
    @chunk_size = 5*1024*1024
    @headers = {
        'user-agent' => RUBY_PLATFORM + ':ruby-' + RUBY_VERSION,
        'x-sdk-version' => 'appwrite:ruby:6.0.0',                
        'X-Appwrite-Response-Format' => '0.15.0'
    }
    @endpoint = 'https://HOSTNAME/v1'
end

Instance Method Details

#add_header(key, value) ⇒ self

Add Header

Parameters:

  • key (String) —

    The key for the header to add

  • value (String) —

    The value for the header to add

Returns:

  • (self) 


100
101
102
103
104
 
# File 'lib/appwrite/client.rb', line 100

def add_header(key, value)
    @headers[key.downcase] = value

    self
end

#call(method:, path: '', headers: {}, params: {}, response_type: nil) ⇒ self

Send the HTTP request.

Parameters:

  • method (String) —

    The HTTP method for the request

  • path (String) (defaults to: '') —

    The path for the request

  • headers (Hash) (defaults to: {}) —

    The headers to send with the request

  • params (Hash) (defaults to: {}) —

    The parameters to send with the request

  • response_type (Class) (defaults to: nil) —

    The type of response to return

Returns:

  • (self) 


115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/appwrite/client.rb', line 115

def call(
    method:,
    path: '',
    headers: {},
    params: {},
    response_type: nil
)
    uri = URI.parse(@endpoint + path + ((method == "GET" && params.length) ? '?' + encode(params) : ''))

    fetch(method, uri, headers, params, response_type)
end

#chunked_upload(path:, headers:, params:, param_name: '', id_param_name: nil, on_progress: nil, response_type: nil) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/appwrite/client.rb', line 127

def chunked_upload(
    path:,
    headers:,
    params:,
    param_name: '',
    id_param_name: nil,
    on_progress: nil,
    response_type: nil
)
    input_file = params[param_name.to_sym]

    case input_file.source_type
    when 'path'
        size = ::File.size(input_file.path)
    when 'string'
        size = input_file.data.bytesize
    end

    if size < @chunk_size
        if input_file.source_type == 'path'
            input_file.data = IO.read(input_file.path)
        end
        params[param_name.to_sym] = input_file
        return call(
            method: 'POST',
            path: path,
            headers: headers,
            params: params,
            response_type: response_type,
        )
    end

    offset = 0
    id_param_name = id_param_name.to_sym if id_param_name
    if id_param_name&.empty? == false && params[id_param_name] != "unique()"
        # Make a request to check if a file already exists
        current = call(
            method: "GET",
            path: "#{path}/#{params[id_param_name]}",
            headers: headers,
            params: {}
        )
        chunks_uploaded = current['chunksUploaded'].to_i
        offset = [size, (chunks_uploaded * @chunk_size)].min
    end

    while offset < size
        case input_file.source_type
        when 'path'
            string = IO.read(input_file.path, @chunk_size, offset)
        when 'string'
            string = input_file.data.byteslice(offset, [@chunk_size, size - offset].min)
        end

        params[param_name.to_sym] = InputFile::from_string(
            string,
            filename: input_file.filename,
            mime_type: input_file.mime_type
        )

        headers['content-range'] = "bytes #{offset}-#{[offset + @chunk_size - 1, size].min}/#{size}"

        result = call(
            method: 'POST',
            path: path,
            headers: headers,
            params: params,
        )

        offset += @chunk_size

        if defined? result['$id']
            headers['x-Appwrite-id'] = result['$id']
        end

        on_progress.call({
            id: result['$id'],
            progress: ([offset, size].min).to_f/size.to_f * 100.0,
            size_uploaded: [offset, size].min,
            chunks_total: result['chunksTotal'],
            chunks_uploaded: result['chunksUploaded']
        }) unless on_progress.nil?
    end

    return result unless response_type.respond_to?("from")

    response_type.from(map: result)
end

#set_endpoint(endpoint) ⇒ self

Set endpoint.

Parameters:

  • endpoint (String) —

    The endpoint to set

Returns:

  • (self) 


76
77
78
79
80
 
# File 'lib/appwrite/client.rb', line 76

def set_endpoint(endpoint)
    @endpoint = endpoint
    
    self
end

#set_jwt(value) ⇒ self

Set JWT

Your secret JSON Web Token

Parameters:

  • value (String) —

    The value to set for the JWT header

Returns:

  • (self) 


54
55
56
57
58
 
# File 'lib/appwrite/client.rb', line 54

def set_jwt(value)
    add_header('x-appwrite-jwt', value)

    self
end

#set_key(value) ⇒ self

Set Key

Your secret API key

Parameters:

  • value (String) —

    The value to set for the Key header

Returns:

  • (self) 


41
42
43
44
45
 
# File 'lib/appwrite/client.rb', line 41

def set_key(value)
    add_header('x-appwrite-key', value)

    self
end

#set_locale(value) ⇒ self

Set Locale

Parameters:

  • value (String) —

    The value to set for the Locale header

Returns:

  • (self) 


65
66
67
68
69
 
# File 'lib/appwrite/client.rb', line 65

def set_locale(value)
    add_header('x-appwrite-locale', value)

    self
end

#set_project(value) ⇒ self

Set Project

Your project ID

Parameters:

  • value (String) —

    The value to set for the Project header

Returns:

  • (self) 


28
29
30
31
32
 
# File 'lib/appwrite/client.rb', line 28

def set_project(value)
    add_header('x-appwrite-project', value)

    self
end

#set_self_signed(self_signed = true) ⇒ self

Set self signed.

Parameters:

  • self_signed (String) (defaults to: true) —

    Whether to allow self signed certificates.

Returns:

  • (self) 


87
88
89
90
91
 
# File 'lib/appwrite/client.rb', line 87

def set_self_signed(self_signed = true)
    @self_signed = self_signed

    self
end