Class: Oss::Api

Inherits:
Object
  • Object
show all
Defined in:
lib/oss/api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint, access_key_id, access_key_secret, bucket = nil) ⇒ Api

Returns a new instance of Api.



13
14
15
16
 
# File 'lib/oss/api.rb', line 13

def initialize(endpoint, access_key_id, access_key_secret, bucket = nil)
  @bucket = bucket
  @client = Client.new(endpoint, access_key_id, access_key_secret)
end

Instance Attribute Details

#bucket ⇒ Object

Returns the value of attribute bucket.



11
12
13
 
# File 'lib/oss/api.rb', line 11

def bucket
  @bucket
end

#client ⇒ Object

Returns the value of attribute client.



11
12
13
 
# File 'lib/oss/api.rb', line 11

def client
  @client
end

Instance Method Details

#abort_multipart_upload(bucket_name, object_name, upload_id) ⇒ Object

params:

  • bucket_name

  • object_name

  • upload_id



293
294
295
 
# File 'lib/oss/api.rb', line 293

def abort_multipart_upload(bucket_name, object_name, upload_id)
  Multipart.new(@client).abort_multipart_upload(bucket_name, object_name, upload_id)
end

#append_object(bucket_name, object_name, file, position, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • file

  • options



202
203
204
 
# File 'lib/oss/api.rb', line 202

def append_object(bucket_name, object_name, file, position, options = {})
  Object.new(@client).append_object(bucket_name, object_name, file, position, options)
end

#complete_multipart_upload(bucket_name, object_name, upload_id, parts) ⇒ Object

params:

  • bucket_name

  • object_name

  • upload_id

  • parts



285
286
287
 
# File 'lib/oss/api.rb', line 285

def complete_multipart_upload(bucket_name, object_name, upload_id, parts)
  Multipart.new(@client).complete_multipart_upload(bucket_name, object_name, upload_id, parts)
end

#copy_object(bucket_name, object, old_bucket, old_object, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • file

  • options



177
178
179
 
# File 'lib/oss/api.rb', line 177

def copy_object(bucket_name, object, old_bucket, old_object, options = {})
  Object.new(@client).copy_object(bucket_name, object, old_bucket, old_object, options)
end

#delete_bucket(bucket_name) ⇒ Object

params:

  • bucket_name



136
137
138
 
# File 'lib/oss/api.rb', line 136

def delete_bucket(bucket_name)
  Bucket.new(@client).delete_bucket(bucket_name)
end

#delete_bucket_cors(bucket_name) ⇒ Object

params:

  • bucket_name

  • rules



334
335
336
 
# File 'lib/oss/api.rb', line 334

def delete_bucket_cors(bucket_name)
  Cors.new(@client).delete_bucket_cors(bucket_name)
end

#delete_bucket_lifecycle(bucket_name) ⇒ Object

params:

  • bucket_name



154
155
156
 
# File 'lib/oss/api.rb', line 154

def delete_bucket_lifecycle(bucket_name)
  Bucket.new(@client).delete_bucket_lifecycle(bucket_name)
end

#delete_bucket_logging(bucket_name) ⇒ Object

params:

  • bucket_name



142
143
144
 
# File 'lib/oss/api.rb', line 142

def delete_bucket_logging(bucket_name)
  Bucket.new(@client).delete_bucket_logging(bucket_name)
end

#delete_bucket_website(bucket_name) ⇒ Object

params:

  • bucket_name



148
149
150
 
# File 'lib/oss/api.rb', line 148

def delete_bucket_website(bucket_name)
  Bucket.new(@client).delete_bucket_website(bucket_name)
end

#delete_multiple_objects(bucket_name, objects) ⇒ Object

params:

  • bucket_name

  • objects



216
217
218
 
# File 'lib/oss/api.rb', line 216

def delete_multiple_objects(bucket_name, objects)
  Object.new(@client).delete_multiple_objects(bucket_name, objects)
end

#delete_object(bucket_name, object_name) ⇒ Object

params:

  • bucket_name

  • object_name



209
210
211
 
# File 'lib/oss/api.rb', line 209

def delete_object(bucket_name, object_name)
  Object.new(@client).delete_object(bucket_name, object_name)
end

#get_bucket(bucket_name, options = {}) ⇒ Object

params:

  • bucket_name

  • options:

    • delimiter

    • prefix

    • marker

    • max_keys

    • encoding_type



94
95
96
 
# File 'lib/oss/api.rb', line 94

def get_bucket(bucket_name, options = {})
  Bucket.new(@client).get_bucket(bucket_name, options)
end

#get_bucket_acl(bucket_name) ⇒ Object

params:

  • bucket_name



100
101
102
 
# File 'lib/oss/api.rb', line 100

def get_bucket_acl(bucket_name)
  Bucket.new(@client).get_bucket_acl(bucket_name)
end

#get_bucket_cors(bucket_name) ⇒ Object

params:

  • bucket_name

  • rules



327
328
329
 
# File 'lib/oss/api.rb', line 327

def get_bucket_cors(bucket_name)
  Cors.new(@client).get_bucket_cors(bucket_name)
end

#get_bucket_lifecycle(bucket_name) ⇒ Object

params:

  • bucket_name



130
131
132
 
# File 'lib/oss/api.rb', line 130

def get_bucket_lifecycle(bucket_name)
  Bucket.new(@client).get_bucket_lifecycle(bucket_name)
end

#get_bucket_location(bucket_name) ⇒ Object

params:

  • bucket_name



106
107
108
 
# File 'lib/oss/api.rb', line 106

def get_bucket_location(bucket_name)
  Bucket.new(@client).get_bucket_location(bucket_name)
end

#get_bucket_logging(bucket_name) ⇒ Object

params:

  • bucket_name



112
113
114
 
# File 'lib/oss/api.rb', line 112

def get_bucket_logging(bucket_name)
  Bucket.new(@client).get_bucket_logging(bucket_name)
end

#get_bucket_referer(bucket_name) ⇒ Object

params:

  • bucket_name



124
125
126
 
# File 'lib/oss/api.rb', line 124

def get_bucket_referer(bucket_name)
  Bucket.new(@client).get_bucket_referer(bucket_name)
end

#get_bucket_website(bucket_name) ⇒ Object

params:

  • bucket_name



118
119
120
 
# File 'lib/oss/api.rb', line 118

def get_bucket_website(bucket_name)
  Bucket.new(@client).get_bucket_website(bucket_name)
end

#get_object(bucket_name, object, options = {}) ⇒ Object

params:

  • bucket_name

  • object

  • options



185
186
187
 
# File 'lib/oss/api.rb', line 185

def get_object(bucket_name, object, options = {})
  Object.new(@client).get_object(bucket_name, object, options)
end

#get_object_url(bucket_name, object, options = {}) ⇒ Object

params:

  • bucket_name

  • object

  • options



193
194
195
 
# File 'lib/oss/api.rb', line 193

def get_object_url(bucket_name, object, options = {})
  Object.new(@client).get_object_url(bucket_name, object, options)
end

#get_service(options = {}) ⇒ Object Also known as: list_bucket

params:

  • options:

    • prefix

    • marker

    • max_keys



28
29
30
 
# File 'lib/oss/api.rb', line 28

def get_service(options = {})
  Service.new(@client).get_service(options)
end

#head_object(bucket_name, object_name) ⇒ Object

params:

  • bucket_name

  • object_name

  • options



224
225
226
 
# File 'lib/oss/api.rb', line 224

def head_object(bucket_name, object_name)
  Object.new(@client).head_object(bucket_name, object_name)
end

#initiate_multipart_upload(bucket_name, object_name, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • options



253
254
255
 
# File 'lib/oss/api.rb', line 253

def initiate_multipart_upload(bucket_name, object_name, options = {})
  Multipart.new(@client).initiate_multipart_upload(bucket_name, object_name, options)
end

#list_multipart_upload(bucket_name, options = {}) ⇒ Object

params:

  • bucket_name

  • options



300
301
302
 
# File 'lib/oss/api.rb', line 300

def list_multipart_upload(bucket_name, options = {})
  Multipart.new(@client).list_multipart_upload(bucket_name, options)
end

#list_parts(bucket_name, object_name, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • options



308
309
310
 
# File 'lib/oss/api.rb', line 308

def list_parts(bucket_name, object_name, options = {})
  Multipart.new(@client).list_parts(bucket_name, object_name, options)
end

#option_object(bucket_name, object_name, origin, request_method, request_headers) ⇒ Object

params:

  • bucket_name

  • object_name

  • origin

  • request_method

  • request_headers



344
345
346
 
# File 'lib/oss/api.rb', line 344

def option_object(bucket_name, object_name, origin, request_method, request_headers)
  Cors.new(@client).option_object(bucket_name, object_name, origin, request_method, request_headers)
end

#post_object(bucket_name, key, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • acl



240
241
242
 
# File 'lib/oss/api.rb', line 240

def post_object(bucket_name, key, options = {})
  Object.new(@client).post_object(bucket_name, key, options)
end

#put_bucket(bucket_name, acl) ⇒ Object

params:

  • bucket_name

  • acl



42
43
44
 
# File 'lib/oss/api.rb', line 42

def put_bucket(bucket_name, acl)
  Bucket.new(@client).put_bucket(bucket_name, acl)
end

#put_bucket_acl(bucket_name, acl) ⇒ Object

params:

  • bucket_name

  • acl



49
50
51
 
# File 'lib/oss/api.rb', line 49

def put_bucket_acl(bucket_name, acl)
  Bucket.new(@client).put_bucket_acl(bucket_name, acl)
end

#put_bucket_cors(bucket_name, rules) ⇒ Object

params:

  • bucket_name

  • rules



320
321
322
 
# File 'lib/oss/api.rb', line 320

def put_bucket_cors(bucket_name, rules)
  Cors.new(@client).put_bucket_cors(bucket_name, rules)
end

#put_bucket_lifecycle(bucket_name, rules = []) ⇒ Object

params:

  • bucket_name

  • allow_empty

  • referer_list



82
83
84
 
# File 'lib/oss/api.rb', line 82

def put_bucket_lifecycle(bucket_name, rules = [])
  Bucket.new(@client).put_bucket_lifecycle(bucket_name, rules)
end

#put_bucket_logging(bucket_name, target_bucket, enable = true, target_prefix = nil) ⇒ Object

params:

  • bucket_name

  • target_bucket

  • enable

  • target_prefix



58
59
60
 
# File 'lib/oss/api.rb', line 58

def put_bucket_logging(bucket_name, target_bucket, enable = true, target_prefix = nil)
  Bucket.new(@client).put_bucket_logging(bucket_name, target_bucket, enable, target_prefix)
end

#put_bucket_referer(bucket_name, allow_empty, referer_list = []) ⇒ Object

params:

  • bucket_name

  • allow_empty

  • referer_list



74
75
76
 
# File 'lib/oss/api.rb', line 74

def put_bucket_referer(bucket_name, allow_empty, referer_list = [])
  Bucket.new(@client).put_bucket_referer(bucket_name, allow_empty, referer_list)
end

#put_bucket_website(bucket_name, index_doc, error_doc) ⇒ Object

params:

  • bucket_name

  • index_doc

  • error_doc



66
67
68
 
# File 'lib/oss/api.rb', line 66

def put_bucket_website(bucket_name, index_doc, error_doc)
  Bucket.new(@client).put_bucket_website(bucket_name, index_doc, error_doc)
end

#put_object(bucket_name, object_name, file, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • file

  • options



168
169
170
 
# File 'lib/oss/api.rb', line 168

def put_object(bucket_name, object_name, file, options = {})
  Object.new(@client).put_object(bucket_name, object_name, file, options)
end

#put_object_acl(bucket_name, object_name, acl) ⇒ Object

params:

  • bucket_name

  • object_name

  • acl



232
233
234
 
# File 'lib/oss/api.rb', line 232

def put_object_acl(bucket_name, object_name, acl)
  Object.new(@client).put_object_acl(bucket_name, object_name, acl)
end

#upload_part(bucket_name, object_name, upload_id, file, part_number = 1, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • upload_id

  • file

  • part_number

  • options



264
265
266
 
# File 'lib/oss/api.rb', line 264

def upload_part(bucket_name, object_name, upload_id, file, part_number = 1, options = {})
  Multipart.new(@client).upload_part(bucket_name, object_name, upload_id, file, part_number, options)
end

#upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {}) ⇒ Object

params:

  • bucket_name

  • object_name

  • upload_id

  • old_bucket

  • old_object

  • part_number

  • options



276
277
278
 
# File 'lib/oss/api.rb', line 276

def upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number = 1, options = {})
  Multipart.new(@client).upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number, options)
end