Class: AliyunSDK::OSS::Protocol
- Inherits:
-
Object
- Object
- AliyunSDK::OSS::Protocol
- Includes:
- Common::Logging
- Defined in:
- lib/aliyun_sdk/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.
-
#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_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
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1191 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.
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 577 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) r = @http.post( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers, :body => HTTP::StreamPayload.new(&block)}) 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
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 918 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
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 1176 1177 1178 1179 1180 1181 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1150 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.
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 858 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
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 97 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
489 490 491 492 493 494 495 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 489 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
475 476 477 478 479 480 481 482 483 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 475 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
400 401 402 403 404 405 406 407 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 400 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
205 206 207 208 209 210 211 212 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 205 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
269 270 271 272 273 274 275 276 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 269 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
898 899 900 901 902 903 904 905 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 898 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 |
#get_access_key_id ⇒ String
Get user’s access key id
1364 1365 1366 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1364 def get_access_key_id @config.access_key_id end |
#get_bucket_acl(name) ⇒ String
Get bucket acl
135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 135 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
443 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 443 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
370 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 370 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
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 182 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
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 307 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
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 249 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.
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 734 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 r = @http.get( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:headers => headers} ) { |chunk| yield chunk if block_given? } 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
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 977 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
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1003 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.
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 800 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
1358 1359 1360 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1358 def get_request_url(bucket, object = nil) @http.get_request_url(bucket, object) end |
#get_sts_token ⇒ String
Get user’s STS token
1370 1371 1372 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1370 def get_sts_token @config.sts_token end |
#initiate_multipart_upload(bucket_name, object_name, opts = {}) ⇒ String
Initiate a a multipart uploading transaction
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1048 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.
44 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 44 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.
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1235 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.
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 635 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.
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1306 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
120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 120 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
330 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 330 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
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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 151 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
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 281 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
217 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 217 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.
522 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 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 522 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 r = @http.put( {:bucket => bucket_name, :object => object_name}, {:headers => headers, :body => HTTP::StreamPayload.new(&block)}) if r.code == 203 e = CallbackError.new(r) logger.error(e.to_s) raise e end logger.debug('Done put object') end |
#put_object_acl(bucket_name, object_name, acl) ⇒ Object
Put object acl
959 960 961 962 963 964 965 966 967 968 969 970 971 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 959 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
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 414 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
1377 1378 1379 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1377 def sign(string_to_sign) Util.sign(@config.access_key_secret, string_to_sign) end |
#upload_part(bucket_name, object_name, txn_id, part_no) {|HTTP::StreamWriter| ... } ⇒ Object
Upload a part in a multipart uploading transaction.
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1080 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} r = @http.put( {:bucket => bucket_name, :object => object_name, :sub_res => sub_res}, {:body => HTTP::StreamPayload.new(&block)}) 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.
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 |
# File 'lib/aliyun_sdk/oss/protocol.rb', line 1110 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 |