Class: Aliyun::OSS::Protocol
- Inherits:
-
Object
- Object
- Aliyun::OSS::Protocol
- Includes:
- Common::Logging
- Defined in:
- lib/aliyun/oss/protocol.rb
Overview
Protocol implement the OSS Open API which is low-level. User should refer to Client for normal use.
Constant Summary collapse
- STREAM_CHUNK_SIZE =
16 * 1024
- CALLBACK_HEADER =
'x-oss-callback'
Constants included from Common::Logging
Common::Logging::DEFAULT_LOG_FILE, Common::Logging::MAX_NUM_LOG, Common::Logging::ROTATE_SIZE
Instance Method Summary collapse
-
#abort_multipart_upload(bucket_name, object_name, txn_id) ⇒ Object
Abort a multipart uploading transaction.
-
#append_object(bucket_name, object_name, position, opts = {}) {|HTTP::StreamWriter| ... } ⇒ Integer
Append to an object of a bucket.
-
#batch_delete_objects(bucket_name, object_names, opts = {}) ⇒ Array<String>
Batch delete objects.
-
#complete_multipart_upload(bucket_name, object_name, txn_id, parts, callback = nil) ⇒ Object
Complete a multipart uploading transaction.
-
#copy_object(bucket_name, src_object_name, dst_object_name, opts = {}) ⇒ Hash
Copy an object in the bucket.
-
#create_bucket(name, opts = {}) ⇒ Object
Create a bucket.
-
#delete_bucket(name) ⇒ Object
Delete a bucket.
-
#delete_bucket_cors(name) ⇒ Object
Delete all bucket CORS rules.
-
#delete_bucket_lifecycle(name) ⇒ Object
Delete all lifecycle rules on the bucket.
-
#delete_bucket_logging(name) ⇒ Object
Delete bucket logging settings, a.k.a.
-
#delete_bucket_website(name) ⇒ Object
Delete bucket website settings.
-
#delete_object(bucket_name, object_name) ⇒ Object
Delete an object from the bucket.
-
#download_crc_enable ⇒ Object
Get the download crc status.
-
#get_access_key_id ⇒ String
Get user’s access key id.
-
#get_bucket_acl(name) ⇒ String
Get bucket acl.
-
#get_bucket_cors(name) ⇒ Array<OSS::CORSRule] the CORS rules
Get bucket CORS rules.
-
#get_bucket_lifecycle(name) ⇒ Array<OSS::LifeCycleRule>
Get bucket lifecycle settings.
-
#get_bucket_logging(name) ⇒ BucketLogging
Get bucket logging settings.
-
#get_bucket_referer(name) ⇒ BucketReferer
Get bucket referer.
-
#get_bucket_website(name) ⇒ BucketWebsite
Get bucket website settings.
-
#get_object(bucket_name, object_name, opts = {}) {|String| ... } ⇒ OSS::Object
Get an object from the bucket.
-
#get_object_acl(bucket_name, object_name) ⇒ Object
Get object acl [return] the object’s acl.
-
#get_object_cors(bucket_name, object_name, origin, method, headers = []) ⇒ CORSRule
Get object CORS rule.
-
#get_object_meta(bucket_name, object_name, opts = {}) ⇒ OSS::Object
Get the object meta rather than the whole object.
-
#get_request_url(bucket, object = nil) ⇒ String
Get bucket/object url.
-
#get_sts_token ⇒ String
Get user’s STS token.
-
#initialize(config) ⇒ Protocol
constructor
A new instance of Protocol.
-
#initiate_multipart_upload(bucket_name, object_name, opts = {}) ⇒ String
Initiate a a multipart uploading transaction.
-
#list_buckets(opts = {}) ⇒ Array<Bucket>, Hash
List all the buckets.
-
#list_multipart_uploads(bucket_name, opts = {}) ⇒ Array<Multipart::Transaction>, Hash
Get a list of all the on-going multipart uploading transactions.
-
#list_objects(bucket_name, opts = {}) ⇒ Array<Objects>, Hash
List objects in a bucket.
-
#list_parts(bucket_name, object_name, txn_id, opts = {}) ⇒ Array<Multipart::Part>, Hash
Get a list of parts that are successfully uploaded in a transaction.
-
#put_bucket_acl(name, acl) ⇒ Object
Put bucket acl.
-
#put_bucket_lifecycle(name, rules) ⇒ Object
Put bucket lifecycle settings.
-
#put_bucket_logging(name, logging) ⇒ Object
Put bucket logging settings.
-
#put_bucket_referer(name, referer) ⇒ Object
Put bucket referer.
-
#put_bucket_website(name, website) ⇒ Object
Put bucket website settings.
-
#put_object(bucket_name, object_name, opts = {}) {|HTTP::StreamWriter| ... } ⇒ Object
Put an object to the specified bucket, a block is required to provide the object data.
-
#put_object_acl(bucket_name, object_name, acl) ⇒ Object
Put object acl.
-
#set_bucket_cors(name, rules) ⇒ Object
Set bucket CORS(Cross-Origin Resource Sharing) rules.
-
#sign(string_to_sign) ⇒ String
Sign a string using the stored access key secret.
-
#upload_crc_enable ⇒ Object
Get the upload crc status.
-
#upload_part(bucket_name, object_name, txn_id, part_no) {|HTTP::StreamWriter| ... } ⇒ Object
Upload a part in a multipart uploading transaction.
-
#upload_part_by_copy(bucket_name, object_name, txn_id, part_no, source_object, opts = {}) ⇒ Object
Upload a part in a multipart uploading transaction by copying from an existent object as the part’s content.
Methods included from Common::Logging
#logger, set_log_file, set_log_level
Constructor Details
Instance Method Details
#abort_multipart_upload(bucket_name, object_name, txn_id) ⇒ Object
All the parts are discarded after abort. For some parts being uploaded while the abort happens, they may not be discarded. Call abort_multipart_upload several times for this situation.
Abort a multipart uploading transaction
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'lib/aliyun/oss/protocol.rb', line 1226 def abort_multipart_upload(bucket_name, object_name, txn_id) logger.debug("Begin abort multipart upload, txn id: #{txn_id}") sub_res = {'uploadId' => txn_id} @http.delete( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}) logger.debug("Done abort multipart: #{txn_id}.") end |
#append_object(bucket_name, object_name, position, opts = {}) {|HTTP::StreamWriter| ... } ⇒ Integer
-
Can not append to a “Normal Object”
-
The position must equal to the object’s size before append
-
The :content_type is only used when the object is created
Append to an object of a bucket. Create an “Appendable Object” if the object does not exist. A block is required to provide the appending data.
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 |
# File 'lib/aliyun/oss/protocol.rb', line 584 def append_object(bucket_name, object_name, position, opts = {}, &block) logger.debug("Begin append object, bucket: #{bucket_name}, object: "\ "#{object_name}, position: #{position}, options: #{opts}") sub_res = {'append' => nil, 'position' => position} headers = {'content-type' => opts[:content_type]} headers['x-oss-object-acl'] = opts[:acl] if opts.key?(:acl) to_lower_case(opts[:metas] || {}) .each { |k, v| headers["x-oss-meta-#{k.to_s}"] = v.to_s } headers.merge!(to_lower_case(opts[:headers])) if opts.key?(:headers) payload = HTTP::StreamWriter.new( @config.upload_crc_enable && !opts[:init_crc].nil?, opts[:init_crc], &block) r = @http.post( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers, :body => payload}) if @config.upload_crc_enable && !r.headers[:x_oss_hash_crc64ecma].nil? && !opts[:init_crc].nil? data_crc = payload.data_crc Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'append') end logger.debug('Done append object') wrap(r.headers[:x_oss_next_append_position], &:to_i) || -1 end |
#batch_delete_objects(bucket_name, object_names, opts = {}) ⇒ Array<String>
Batch delete objects
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 |
# File 'lib/aliyun/oss/protocol.rb', line 946 def batch_delete_objects(bucket_name, object_names, opts = {}) logger.debug("Begin batch delete object, bucket: #{bucket_name}, "\ "objects: #{object_names}, options: #{opts}") sub_res = {'delete' => nil} # It may have invisible chars in object key which will corrupt # libxml. So we're constructing xml body manually here. body = '<?xml version="1.0"?>' body << '<Delete>' body << '<Quiet>' << (opts[:quiet]? true : false).to_s << '</Quiet>' object_names.each { |k| body << '<Object><Key>' << CGI.escapeHTML(k) << '</Key></Object>' } body << '</Delete>' query = {} query['encoding-type'] = opts[:encoding] if opts[:encoding] r = @http.post( {:bucket => bucket_name, :sub_res => sub_res}, {:query => query, :body => body}) deleted = [] unless opts[:quiet] doc = parse_xml(r.body) encoding = get_node_text(doc.root, 'EncodingType') doc.css("Deleted").map do |n| deleted << get_node_text(n, 'Key') { |x| decode_key(x, encoding) } end end logger.debug("Done delete object") deleted end |
#complete_multipart_upload(bucket_name, object_name, txn_id, parts, callback = nil) ⇒ Object
Complete a multipart uploading transaction
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 |
# File 'lib/aliyun/oss/protocol.rb', line 1185 def complete_multipart_upload( bucket_name, object_name, txn_id, parts, callback = nil) logger.debug("Begin complete multipart upload, "\ "txn id: #{txn_id}, parts: #{parts.map(&:to_s)}") sub_res = {'uploadId' => txn_id} headers = {} headers[CALLBACK_HEADER] = callback.serialize if callback body = Nokogiri::XML::Builder.new do |xml| xml.CompleteMultipartUpload { parts.each do |p| xml.Part { xml.PartNumber p.number xml.ETag p.etag } end } end.to_xml r = @http.post( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers, :body => body}) if r.code == 203 e = CallbackError.new(r) logger.error(e.to_s) raise e end logger.debug("Done complete multipart upload: #{txn_id}.") end |
#copy_object(bucket_name, src_object_name, dst_object_name, opts = {}) ⇒ Hash
Copy an object in the bucket. The source object and the dest object may be from different buckets of the same region.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 |
# File 'lib/aliyun/oss/protocol.rb', line 886 def copy_object(bucket_name, src_object_name, dst_object_name, opts = {}) logger.debug("Begin copy object, bucket: #{bucket_name}, "\ "source object: #{src_object_name}, dest object: "\ "#{dst_object_name}, options: #{opts}") src_bucket = opts[:src_bucket] || bucket_name headers = { 'x-oss-copy-source' => @http.get_resource_path(src_bucket, src_object_name), 'content-type' => opts[:content_type] } (opts[:metas] || {}) .each { |k, v| headers["x-oss-meta-#{k.to_s}"] = v.to_s } { :acl => 'x-oss-object-acl', :meta_directive => 'x-oss-metadata-directive' }.each { |k, v| headers[v] = opts[k] if opts[k] } headers.merge!(get_copy_conditions(opts[:condition])) if opts[:condition] r = @http.put( {:bucket => bucket_name, :object => dst_object_name}, {:headers => headers}) doc = parse_xml(r.body) copy_result = { :last_modified => get_node_text( doc.root, 'LastModified') { |x| Time.parse(x) }, :etag => get_node_text(doc.root, 'ETag') }.reject { |_, v| v.nil? } logger.debug("Done copy object") copy_result end |
#create_bucket(name, opts = {}) ⇒ Object
Create a bucket
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/aliyun/oss/protocol.rb', line 98 def create_bucket(name, opts = {}) logger.info("Begin create bucket, name: #{name}, opts: #{opts}") location = opts[:location] body = nil if location builder = Nokogiri::XML::Builder.new do |xml| xml.CreateBucketConfiguration { xml.LocationConstraint location } end body = builder.to_xml end @http.put({:bucket => name}, {:body => body}) logger.info("Done create bucket") end |
#delete_bucket(name) ⇒ Object
it will fails if the bucket is not empty (it contains objects)
Delete a bucket
490 491 492 493 494 495 496 |
# File 'lib/aliyun/oss/protocol.rb', line 490 def delete_bucket(name) logger.info("Begin delete bucket: #{name}") @http.delete({:bucket => name}) logger.info("Done delete bucket") end |
#delete_bucket_cors(name) ⇒ Object
this will delete all CORS rules of this bucket
Delete all bucket CORS rules
476 477 478 479 480 481 482 483 484 |
# File 'lib/aliyun/oss/protocol.rb', line 476 def delete_bucket_cors(name) logger.info("Begin delete bucket cors, bucket: #{name}") sub_res = {'cors' => nil} @http.delete({:bucket => name, :sub_res => sub_res}) logger.info("Done delete bucket cors") end |
#delete_bucket_lifecycle(name) ⇒ Object
this will delete all lifecycle rules
Delete all lifecycle rules on the bucket
401 402 403 404 405 406 407 408 |
# File 'lib/aliyun/oss/protocol.rb', line 401 def delete_bucket_lifecycle(name) logger.info("Begin delete bucket lifecycle, name: #{name}") sub_res = {'lifecycle' => nil} @http.delete({:bucket => name, :sub_res => sub_res}) logger.info("Done delete bucket lifecycle") end |
#delete_bucket_logging(name) ⇒ Object
Delete bucket logging settings, a.k.a. disable bucket logging
206 207 208 209 210 211 212 213 |
# File 'lib/aliyun/oss/protocol.rb', line 206 def delete_bucket_logging(name) logger.info("Begin delete bucket logging, name: #{name}") sub_res = {'logging' => nil} @http.delete({:bucket => name, :sub_res => sub_res}) logger.info("Done delete bucket logging") end |
#delete_bucket_website(name) ⇒ Object
Delete bucket website settings
270 271 272 273 274 275 276 277 |
# File 'lib/aliyun/oss/protocol.rb', line 270 def delete_bucket_website(name) logger.info("Begin delete bucket website, name: #{name}") sub_res = {'website' => nil} @http.delete({:bucket => name, :sub_res => sub_res}) logger.info("Done delete bucket website") end |
#delete_object(bucket_name, object_name) ⇒ Object
Delete an object from the bucket
926 927 928 929 930 931 932 933 |
# File 'lib/aliyun/oss/protocol.rb', line 926 def delete_object(bucket_name, object_name) logger.debug("Begin delete object, bucket: #{bucket_name}, "\ "object: #{object_name}") @http.delete({:bucket => bucket_name, :object => object_name}) logger.debug("Done delete object") end |
#download_crc_enable ⇒ Object
Get the download crc status
1418 1419 1420 |
# File 'lib/aliyun/oss/protocol.rb', line 1418 def download_crc_enable @config.download_crc_enable end |
#get_access_key_id ⇒ String
Get user’s access key id
1399 1400 1401 |
# File 'lib/aliyun/oss/protocol.rb', line 1399 def get_access_key_id @config.access_key_id end |
#get_bucket_acl(name) ⇒ String
Get bucket acl
136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/aliyun/oss/protocol.rb', line 136 def get_bucket_acl(name) logger.info("Begin get bucket acl, name: #{name}") sub_res = {'acl' => nil} r = @http.get({:bucket => name, :sub_res => sub_res}) doc = parse_xml(r.body) acl = get_node_text(doc.at_css("AccessControlList"), 'Grant') logger.info("Done get bucket acl") acl end |
#get_bucket_cors(name) ⇒ Array<OSS::CORSRule] the CORS rules
Get bucket CORS rules
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'lib/aliyun/oss/protocol.rb', line 444 def get_bucket_cors(name) logger.info("Begin get bucket cors, bucket: #{name}") sub_res = {'cors' => nil} r = @http.get({:bucket => name, :sub_res => sub_res}) doc = parse_xml(r.body) rules = [] doc.css("CORSRule").map do |n| allowed_origins = n.css("AllowedOrigin").map(&:text) allowed_methods = n.css("AllowedMethod").map(&:text) allowed_headers = n.css("AllowedHeader").map(&:text) expose_headers = n.css("ExposeHeader").map(&:text) max_age_seconds = get_node_text(n, 'MaxAgeSeconds', &:to_i) rules << CORSRule.new( :allowed_origins => allowed_origins, :allowed_methods => allowed_methods, :allowed_headers => allowed_headers, :expose_headers => expose_headers, :max_age_seconds => max_age_seconds) end logger.info("Done get bucket cors") rules end |
#get_bucket_lifecycle(name) ⇒ Array<OSS::LifeCycleRule>
Get bucket lifecycle settings
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/aliyun/oss/protocol.rb', line 371 def get_bucket_lifecycle(name) logger.info("Begin get bucket lifecycle, name: #{name}") sub_res = {'lifecycle' => nil} r = @http.get({:bucket => name, :sub_res => sub_res}) doc = parse_xml(r.body) rules = doc.css("Rule").map do |n| days = n.at_css("Expiration Days") date = n.at_css("Expiration Date") if (days && date) || (!days && !date) fail ClientError, "We can only have one of Date and Days for expiry." end LifeCycleRule.new( :id => get_node_text(n, 'ID'), :prefix => get_node_text(n, 'Prefix'), :enable => get_node_text(n, 'Status') { |x| x == 'Enabled' }, :expiry => days ? days.text.to_i : Date.parse(date.text) ) end logger.info("Done get bucket lifecycle") rules end |
#get_bucket_logging(name) ⇒ BucketLogging
Get bucket logging settings
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/aliyun/oss/protocol.rb', line 183 def get_bucket_logging(name) logger.info("Begin get bucket logging, name: #{name}") sub_res = {'logging' => nil} r = @http.get({:bucket => name, :sub_res => sub_res}) doc = parse_xml(r.body) opts = {:enable => false} logging_node = doc.at_css("LoggingEnabled") opts.update( :target_bucket => get_node_text(logging_node, 'TargetBucket'), :target_prefix => get_node_text(logging_node, 'TargetPrefix') ) opts[:enable] = true if opts[:target_bucket] logger.info("Done get bucket logging") BucketLogging.new(opts) end |
#get_bucket_referer(name) ⇒ BucketReferer
Get bucket referer
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/aliyun/oss/protocol.rb', line 308 def get_bucket_referer(name) logger.info("Begin get bucket referer, name: #{name}") sub_res = {'referer' => nil} r = @http.get({:bucket => name, :sub_res => sub_res}) doc = parse_xml(r.body) opts = { :allow_empty => get_node_text(doc.root, 'AllowEmptyReferer', &:to_bool), :whitelist => doc.css("RefererList Referer").map(&:text) } logger.info("Done get bucket referer") BucketReferer.new(opts) end |
#get_bucket_website(name) ⇒ BucketWebsite
Get bucket website settings
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/aliyun/oss/protocol.rb', line 250 def get_bucket_website(name) logger.info("Begin get bucket website, name: #{name}") sub_res = {'website' => nil} r = @http.get({:bucket => name, :sub_res => sub_res}) opts = {:enable => true} doc = parse_xml(r.body) opts.update( :index => get_node_text(doc.at_css('IndexDocument'), 'Suffix'), :error => get_node_text(doc.at_css('ErrorDocument'), 'Key') ) logger.info("Done get bucket website") BucketWebsite.new(opts) end |
#get_object(bucket_name, object_name, opts = {}) {|String| ... } ⇒ OSS::Object
User can get the whole object or only part of it by specify the bytes range;
User can specify conditions to get the object like: if-modified-since, if-unmodified-since, if-match-etag, if-unmatch-etag. If the object to get fails to meet the conditions, it will not be returned;
User can indicate the server to rewrite the response headers such as content-type, content-encoding when get the object by specify the :rewrite options. The specified headers will be returned instead of the original property of the object.
Get an object from the bucket. A block is required to handle the object data chunks.
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/aliyun/oss/protocol.rb', line 751 def get_object(bucket_name, object_name, opts = {}, &block) logger.debug("Begin get object, bucket: #{bucket_name}, "\ "object: #{object_name}") range = opts[:range] conditions = opts[:condition] rewrites = opts[:rewrite] headers = {} headers['range'] = get_bytes_range(range) if range headers.merge!(get_conditions(conditions)) if conditions headers.merge!(to_lower_case(opts[:headers])) if opts.key?(:headers) sub_res = {} if rewrites [ :content_type, :content_language, :cache_control, :content_disposition, :content_encoding ].each do |k| key = "response-#{k.to_s.sub('_', '-')}" sub_res[key] = rewrites[k] if rewrites.key?(k) end sub_res["response-expires"] = rewrites[:expires].httpdate if rewrites.key?(:expires) end data_crc = opts[:init_crc].nil? ? 0 : opts[:init_crc] r = @http.get( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers} ) do |chunk| if block_given? # crc enable and no range and oss server support crc data_crc = Aliyun::OSS::Util.crc(chunk, data_crc) if @config.download_crc_enable && range.nil? yield chunk end end if @config.download_crc_enable && range.nil? && !r.headers[:x_oss_hash_crc64ecma].nil? Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'get') end h = r.headers = {} = 'x_oss_meta_' h.select { |k, _| k.to_s.start_with?() } .each { |k, v| [k.to_s.sub(, '')] = v.to_s } obj = Object.new( :key => object_name, :type => h[:x_oss_object_type], :size => wrap(h[:content_length], &:to_i), :etag => h[:etag], :metas => , :last_modified => wrap(h[:last_modified]) { |x| Time.parse(x) }, :headers => h) logger.debug("Done get object") obj end |
#get_object_acl(bucket_name, object_name) ⇒ Object
Get object acl
- return
-
the object’s acl. See ACL
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 |
# File 'lib/aliyun/oss/protocol.rb', line 1005 def get_object_acl(bucket_name, object_name) logger.debug("Begin get object acl, bucket: #{bucket_name}, "\ "object: #{object_name}") sub_res = {'acl' => nil} r = @http.get( {bucket: bucket_name, object: object_name, sub_res: sub_res}) doc = parse_xml(r.body) acl = get_node_text(doc.at_css("AccessControlList"), 'Grant') logger.debug("Done get object acl") acl end |
#get_object_cors(bucket_name, object_name, origin, method, headers = []) ⇒ CORSRule
this is usually used by browser to make a “preflight”
Get object CORS rule
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 |
# File 'lib/aliyun/oss/protocol.rb', line 1031 def get_object_cors(bucket_name, object_name, origin, method, headers = []) logger.debug("Begin get object cors, bucket: #{bucket_name}, object: "\ "#{object_name}, origin: #{origin}, method: #{method}, "\ "headers: #{headers.join(',')}") h = { 'origin' => origin, 'access-control-request-method' => method, 'access-control-request-headers' => headers.join(',') } r = @http.( {:bucket => bucket_name, :object => object_name}, {:headers => h}) logger.debug("Done get object cors") CORSRule.new( :allowed_origins => r.headers[:access_control_allow_origin], :allowed_methods => r.headers[:access_control_allow_methods], :allowed_headers => r.headers[:access_control_allow_headers], :expose_headers => r.headers[:access_control_expose_headers], :max_age_seconds => r.headers[:access_control_max_age] ) end |
#get_object_meta(bucket_name, object_name, opts = {}) ⇒ OSS::Object
User can specify conditions to get the object like: if-modified-since, if-unmodified-since, if-match-etag, if-unmatch-etag. If the object to get fails to meet the conditions, it will not be returned.
Get the object meta rather than the whole object.
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 |
# File 'lib/aliyun/oss/protocol.rb', line 828 def (bucket_name, object_name, opts = {}) logger.debug("Begin get object meta, bucket: #{bucket_name}, "\ "object: #{object_name}, options: #{opts}") headers = {} headers.merge!(get_conditions(opts[:condition])) if opts[:condition] r = @http.head( {:bucket => bucket_name, :object => object_name}, {:headers => headers}) h = r.headers = {} = 'x_oss_meta_' h.select { |k, _| k.to_s.start_with?() } .each { |k, v| [k.to_s.sub(, '')] = v.to_s } obj = Object.new( :key => object_name, :type => h[:x_oss_object_type], :size => wrap(h[:content_length], &:to_i), :etag => h[:etag], :metas => , :last_modified => wrap(h[:last_modified]) { |x| Time.parse(x) }, :headers => h) logger.debug("Done get object meta") obj end |
#get_request_url(bucket, object = nil) ⇒ String
Get bucket/object url
1393 1394 1395 |
# File 'lib/aliyun/oss/protocol.rb', line 1393 def get_request_url(bucket, object = nil) @http.get_request_url(bucket, object) end |
#get_sts_token ⇒ String
Get user’s STS token
1405 1406 1407 |
# File 'lib/aliyun/oss/protocol.rb', line 1405 def get_sts_token @config.sts_token end |
#initiate_multipart_upload(bucket_name, object_name, opts = {}) ⇒ String
Initiate a a multipart uploading transaction
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 |
# File 'lib/aliyun/oss/protocol.rb', line 1076 def initiate_multipart_upload(bucket_name, object_name, opts = {}) logger.info("Begin initiate multipart upload, bucket: "\ "#{bucket_name}, object: #{object_name}, options: #{opts}") sub_res = {'uploads' => nil} headers = {'content-type' => opts[:content_type]} to_lower_case(opts[:metas] || {}) .each { |k, v| headers["x-oss-meta-#{k.to_s}"] = v.to_s } headers.merge!(to_lower_case(opts[:headers])) if opts.key?(:headers) r = @http.post( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers}) doc = parse_xml(r.body) txn_id = get_node_text(doc.root, 'UploadId') logger.info("Done initiate multipart upload: #{txn_id}.") txn_id end |
#list_buckets(opts = {}) ⇒ Array<Bucket>, Hash
List all the buckets.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/aliyun/oss/protocol.rb', line 45 def list_buckets(opts = {}) logger.info("Begin list buckets, options: #{opts}") params = { 'prefix' => opts[:prefix], 'marker' => opts[:marker], 'max-keys' => opts[:limit] }.reject { |_, v| v.nil? } r = @http.get( {}, {:query => params}) doc = parse_xml(r.body) buckets = doc.css("Buckets Bucket").map do |node| Bucket.new( { :name => get_node_text(node, "Name"), :location => get_node_text(node, "Location"), :creation_time => get_node_text(node, "CreationDate") { |t| Time.parse(t) } }, self ) end more = { :prefix => 'Prefix', :limit => 'MaxKeys', :marker => 'Marker', :next_marker => 'NextMarker', :truncated => 'IsTruncated' }.reduce({}) { |h, (k, v)| value = get_node_text(doc.root, v) value.nil?? h : h.merge(k => value) } update_if_exists( more, { :limit => ->(x) { x.to_i }, :truncated => ->(x) { x.to_bool } } ) logger.info("Done list buckets, buckets: #{buckets}, more: #{more}") [buckets, more] end |
#list_multipart_uploads(bucket_name, opts = {}) ⇒ Array<Multipart::Transaction>, Hash
Get a list of all the on-going multipart uploading transactions. That is: thoses started and not aborted.
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 |
# File 'lib/aliyun/oss/protocol.rb', line 1270 def list_multipart_uploads(bucket_name, opts = {}) logger.debug("Begin list multipart uploads, "\ "bucket: #{bucket_name}, opts: #{opts}") sub_res = {'uploads' => nil} params = { 'prefix' => opts[:prefix], 'upload-id-marker' => opts[:id_marker], 'key-marker' => opts[:key_marker], 'max-uploads' => opts[:limit], 'encoding-type' => opts[:encoding] }.reject { |_, v| v.nil? } r = @http.get( {:bucket => bucket_name, :sub_res => sub_res}, {:query => params}) doc = parse_xml(r.body) encoding = get_node_text(doc.root, 'EncodingType') txns = doc.css("Upload").map do |node| Multipart::Transaction.new( :id => get_node_text(node, "UploadId"), :object => get_node_text(node, "Key") { |x| decode_key(x, encoding) }, :bucket => bucket_name, :creation_time => get_node_text(node, "Initiated") { |t| Time.parse(t) } ) end || [] more = { :prefix => 'Prefix', :limit => 'MaxUploads', :id_marker => 'UploadIdMarker', :next_id_marker => 'NextUploadIdMarker', :key_marker => 'KeyMarker', :next_key_marker => 'NextKeyMarker', :truncated => 'IsTruncated', :encoding => 'EncodingType' }.reduce({}) { |h, (k, v)| value = get_node_text(doc.root, v) value.nil?? h : h.merge(k => value) } update_if_exists( more, { :limit => ->(x) { x.to_i }, :truncated => ->(x) { x.to_bool }, :key_marker => ->(x) { decode_key(x, encoding) }, :next_key_marker => ->(x) { decode_key(x, encoding) } } ) logger.debug("Done list multipart transactions") [txns, more] end |
#list_objects(bucket_name, opts = {}) ⇒ Array<Objects>, Hash
List objects in a bucket.
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
# File 'lib/aliyun/oss/protocol.rb', line 652 def list_objects(bucket_name, opts = {}) logger.debug("Begin list object, bucket: #{bucket_name}, options: #{opts}") params = { 'prefix' => opts[:prefix], 'delimiter' => opts[:delimiter], 'marker' => opts[:marker], 'max-keys' => opts[:limit], 'encoding-type' => opts[:encoding] }.reject { |_, v| v.nil? } r = @http.get({:bucket => bucket_name}, {:query => params}) doc = parse_xml(r.body) encoding = get_node_text(doc.root, 'EncodingType') objects = doc.css("Contents").map do |node| Object.new( :key => get_node_text(node, "Key") { |x| decode_key(x, encoding) }, :type => get_node_text(node, "Type"), :size => get_node_text(node, "Size", &:to_i), :etag => get_node_text(node, "ETag"), :last_modified => get_node_text(node, "LastModified") { |x| Time.parse(x) } ) end || [] more = { :prefix => 'Prefix', :delimiter => 'Delimiter', :limit => 'MaxKeys', :marker => 'Marker', :next_marker => 'NextMarker', :truncated => 'IsTruncated', :encoding => 'EncodingType' }.reduce({}) { |h, (k, v)| value = get_node_text(doc.root, v) value.nil?? h : h.merge(k => value) } update_if_exists( more, { :limit => ->(x) { x.to_i }, :truncated => ->(x) { x.to_bool }, :delimiter => ->(x) { decode_key(x, encoding) }, :marker => ->(x) { decode_key(x, encoding) }, :next_marker => ->(x) { decode_key(x, encoding) } } ) common_prefixes = [] doc.css("CommonPrefixes Prefix").map do |node| common_prefixes << decode_key(node.text, encoding) end more[:common_prefixes] = common_prefixes unless common_prefixes.empty? logger.debug("Done list object. objects: #{objects}, more: #{more}") [objects, more] end |
#list_parts(bucket_name, object_name, txn_id, opts = {}) ⇒ Array<Multipart::Part>, Hash
Get a list of parts that are successfully uploaded in a transaction.
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 |
# File 'lib/aliyun/oss/protocol.rb', line 1341 def list_parts(bucket_name, object_name, txn_id, opts = {}) logger.debug("Begin list parts, bucket: #{bucket_name}, object: "\ "#{object_name}, txn id: #{txn_id}, options: #{opts}") sub_res = {'uploadId' => txn_id} params = { 'part-number-marker' => opts[:marker], 'max-parts' => opts[:limit], 'encoding-type' => opts[:encoding] }.reject { |_, v| v.nil? } r = @http.get( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:query => params}) doc = parse_xml(r.body) parts = doc.css("Part").map do |node| Multipart::Part.new( :number => get_node_text(node, 'PartNumber', &:to_i), :etag => get_node_text(node, 'ETag'), :size => get_node_text(node, 'Size', &:to_i), :last_modified => get_node_text(node, 'LastModified') { |x| Time.parse(x) }) end || [] more = { :limit => 'MaxParts', :marker => 'PartNumberMarker', :next_marker => 'NextPartNumberMarker', :truncated => 'IsTruncated', :encoding => 'EncodingType' }.reduce({}) { |h, (k, v)| value = get_node_text(doc.root, v) value.nil?? h : h.merge(k => value) } update_if_exists( more, { :limit => ->(x) { x.to_i }, :truncated => ->(x) { x.to_bool } } ) logger.debug("Done list parts, parts: #{parts}, more: #{more}") [parts, more] end |
#put_bucket_acl(name, acl) ⇒ Object
Put bucket acl
121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/aliyun/oss/protocol.rb', line 121 def put_bucket_acl(name, acl) logger.info("Begin put bucket acl, name: #{name}, acl: #{acl}") sub_res = {'acl' => nil} headers = {'x-oss-acl' => acl} @http.put( {:bucket => name, :sub_res => sub_res}, {:headers => headers, :body => nil}) logger.info("Done put bucket acl") end |
#put_bucket_lifecycle(name, rules) ⇒ Object
Put bucket lifecycle settings
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/aliyun/oss/protocol.rb', line 331 def put_bucket_lifecycle(name, rules) logger.info("Begin put bucket lifecycle, name: #{name}, rules: "\ "#{rules.map { |r| r.to_s }}") sub_res = {'lifecycle' => nil} body = Nokogiri::XML::Builder.new do |xml| xml.LifecycleConfiguration { rules.each do |r| xml.Rule { xml.ID r.id if r.id xml.Status r.enabled? ? 'Enabled' : 'Disabled' xml.Prefix r.prefix xml.Expiration { if r.expiry.is_a?(Date) xml.Date Time.utc( r.expiry.year, r.expiry.month, r.expiry.day) .iso8601.sub('Z', '.000Z') elsif r.expiry.is_a?(Fixnum) xml.Days r.expiry else fail ClientError, "Expiry must be a Date or Fixnum." end } } end } end.to_xml @http.put( {:bucket => name, :sub_res => sub_res}, {:body => body}) logger.info("Done put bucket lifecycle") end |
#put_bucket_logging(name, logging) ⇒ Object
Put bucket logging settings
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 |
# File 'lib/aliyun/oss/protocol.rb', line 152 def put_bucket_logging(name, logging) logger.info("Begin put bucket logging, "\ "name: #{name}, logging: #{logging}") if logging.enabled? && !logging.target_bucket fail ClientError, "Must specify target bucket when enabling bucket logging." end sub_res = {'logging' => nil} body = Nokogiri::XML::Builder.new do |xml| xml.BucketLoggingStatus { if logging.enabled? xml.LoggingEnabled { xml.TargetBucket logging.target_bucket xml.TargetPrefix logging.target_prefix if logging.target_prefix } end } end.to_xml @http.put( {:bucket => name, :sub_res => sub_res}, {:body => body}) logger.info("Done put bucket logging") end |
#put_bucket_referer(name, referer) ⇒ Object
Put bucket referer
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/aliyun/oss/protocol.rb', line 282 def put_bucket_referer(name, referer) logger.info("Begin put bucket referer, "\ "name: #{name}, referer: #{referer}") sub_res = {'referer' => nil} body = Nokogiri::XML::Builder.new do |xml| xml.RefererConfiguration { xml.AllowEmptyReferer referer.allow_empty? xml.RefererList { (referer.whitelist or []).each do |r| xml.Referer r end } } end.to_xml @http.put( {:bucket => name, :sub_res => sub_res}, {:body => body}) logger.info("Done put bucket referer") end |
#put_bucket_website(name, website) ⇒ Object
Put bucket website settings
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/aliyun/oss/protocol.rb', line 218 def put_bucket_website(name, website) logger.info("Begin put bucket website, "\ "name: #{name}, website: #{website}") unless website.index fail ClientError, "Must specify index to put bucket website." end sub_res = {'website' => nil} body = Nokogiri::XML::Builder.new do |xml| xml.WebsiteConfiguration { xml.IndexDocument { xml.Suffix website.index } if website.error xml.ErrorDocument { xml.Key website.error } end } end.to_xml @http.put( {:bucket => name, :sub_res => sub_res}, {:body => body}) logger.info("Done put bucket website") end |
#put_object(bucket_name, object_name, opts = {}) {|HTTP::StreamWriter| ... } ⇒ Object
Put an object to the specified bucket, a block is required to provide the object data.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
# File 'lib/aliyun/oss/protocol.rb', line 523 def put_object(bucket_name, object_name, opts = {}, &block) logger.debug("Begin put object, bucket: #{bucket_name}, object: "\ "#{object_name}, options: #{opts}") headers = {'content-type' => opts[:content_type]} headers['x-oss-object-acl'] = opts[:acl] if opts.key?(:acl) to_lower_case(opts[:metas] || {}) .each { |k, v| headers["x-oss-meta-#{k.to_s}"] = v.to_s } headers.merge!(to_lower_case(opts[:headers])) if opts.key?(:headers) if opts.key?(:callback) headers[CALLBACK_HEADER] = opts[:callback].serialize end payload = HTTP::StreamWriter.new(@config.upload_crc_enable, opts[:init_crc], &block) r = @http.put( {:bucket => bucket_name, :object => object_name}, {:headers => headers, :body => payload}) if r.code == 203 e = CallbackError.new(r) logger.error(e.to_s) raise e end if @config.upload_crc_enable && !r.headers[:x_oss_hash_crc64ecma].nil? data_crc = payload.data_crc Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'put') end logger.debug('Done put object') end |
#put_object_acl(bucket_name, object_name, acl) ⇒ Object
Put object acl
987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/aliyun/oss/protocol.rb', line 987 def put_object_acl(bucket_name, object_name, acl) logger.debug("Begin update object acl, bucket: #{bucket_name}, "\ "object: #{object_name}, acl: #{acl}") sub_res = {'acl' => nil} headers = {'x-oss-object-acl' => acl} @http.put( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers}) logger.debug("Done update object acl") end |
#set_bucket_cors(name, rules) ⇒ Object
Set bucket CORS(Cross-Origin Resource Sharing) rules
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/aliyun/oss/protocol.rb', line 415 def set_bucket_cors(name, rules) logger.info("Begin set bucket cors, bucket: #{name}, rules: "\ "#{rules.map { |r| r.to_s }.join(';')}") sub_res = {'cors' => nil} body = Nokogiri::XML::Builder.new do |xml| xml.CORSConfiguration { rules.each do |r| xml.CORSRule { r.allowed_origins.each { |x| xml.AllowedOrigin x } r.allowed_methods.each { |x| xml.AllowedMethod x } r.allowed_headers.each { |x| xml.AllowedHeader x } r.expose_headers.each { |x| xml.ExposeHeader x } xml.MaxAgeSeconds r.max_age_seconds if r.max_age_seconds } end } end.to_xml @http.put( {:bucket => name, :sub_res => sub_res}, {:body => body}) logger.info("Done delete bucket lifecycle") end |
#sign(string_to_sign) ⇒ String
Sign a string using the stored access key secret
1412 1413 1414 |
# File 'lib/aliyun/oss/protocol.rb', line 1412 def sign(string_to_sign) Util.sign(@config.access_key_secret, string_to_sign) end |
#upload_crc_enable ⇒ Object
Get the upload crc status
1424 1425 1426 |
# File 'lib/aliyun/oss/protocol.rb', line 1424 def upload_crc_enable @config.upload_crc_enable end |
#upload_part(bucket_name, object_name, txn_id, part_no) {|HTTP::StreamWriter| ... } ⇒ Object
Upload a part in a multipart uploading transaction.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 |
# File 'lib/aliyun/oss/protocol.rb', line 1108 def upload_part(bucket_name, object_name, txn_id, part_no, &block) logger.debug("Begin upload part, bucket: #{bucket_name}, object: "\ "#{object_name}, txn id: #{txn_id}, part No: #{part_no}") sub_res = {'partNumber' => part_no, 'uploadId' => txn_id} payload = HTTP::StreamWriter.new(@config.upload_crc_enable, &block) r = @http.put( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:body => payload}) if @config.upload_crc_enable && !r.headers[:x_oss_hash_crc64ecma].nil? data_crc = payload.data_crc Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'put') end logger.debug("Done upload part") Multipart::Part.new(:number => part_no, :etag => r.headers[:etag]) end |
#upload_part_by_copy(bucket_name, object_name, txn_id, part_no, source_object, opts = {}) ⇒ Object
Upload a part in a multipart uploading transaction by copying from an existent object as the part’s content. It may copy only part of the object by specifying the bytes range to read.
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 |
# File 'lib/aliyun/oss/protocol.rb', line 1145 def upload_part_by_copy( bucket_name, object_name, txn_id, part_no, source_object, opts = {}) logger.debug("Begin upload part by copy, bucket: #{bucket_name}, "\ "object: #{object_name}, source object: #{source_object}"\ "txn id: #{txn_id}, part No: #{part_no}, options: #{opts}") range = opts[:range] conditions = opts[:condition] if range && (!range.is_a?(Array) || range.size != 2) fail ClientError, "Range must be an array containing 2 Integers." end src_bucket = opts[:src_bucket] || bucket_name headers = { 'x-oss-copy-source' => @http.get_resource_path(src_bucket, source_object) } headers['range'] = get_bytes_range(range) if range headers.merge!(get_copy_conditions(conditions)) if conditions sub_res = {'partNumber' => part_no, 'uploadId' => txn_id} r = @http.put( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers}) logger.debug("Done upload part by copy: #{source_object}.") Multipart::Part.new(:number => part_no, :etag => r.headers[:etag]) end |