Module: AWS::S3::Client::Validators
- Included in:
- AWS::S3::Client, AWS::S3::Client
- Defined in:
- lib/aws/s3/client.rb
Instance Method Summary collapse
-
#dns_compatible_bucket_name?(bucket_name) ⇒ Boolean
Returns true if the given
bucket_name
is DNS compatible. - #json_validation_message(obj) ⇒ Object
-
#path_style_bucket_name?(bucket_name) ⇒ Boolean
Returns true if the bucket name must be used in the request path instead of as a sub-domain when making requests against S3.
- #require_acl!(options) ⇒ Object
- #require_bucket_name!(bucket_name) ⇒ Object
- #require_part_number!(part_number) ⇒ Object
- #require_policy!(policy) ⇒ Object
- #require_upload_id!(upload_id) ⇒ Object
- #set_body_stream_and_content_length(request, options) ⇒ Object
-
#valid_bucket_name?(bucket_name) ⇒ Boolean
Returns true if the given bucket name is valid.
- #validate!(name, value, &block) ⇒ Object
-
#validate_bucket_name!(bucket_name) ⇒ Object
Returns true if the given bucket name is valid.
- #validate_key!(key) ⇒ Object
- #validate_parts!(parts) ⇒ Object
Instance Method Details
#dns_compatible_bucket_name?(bucket_name) ⇒ Boolean
Returns true if the given bucket_name
is DNS compatible.
DNS compatible bucket names may be accessed like:
http://dns.compat.bucket.name.s3.amazonaws.com/
Whereas non-dns compatible bucket names must place the bucket name in the url path, like:
http://s3.amazonaws.com/dns_incompat_bucket_name/
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 |
# File 'lib/aws/s3/client.rb', line 1539 def dns_compatible_bucket_name?(bucket_name) return false if !valid_bucket_name?(bucket_name) or # Bucket names should not contain underscores (_) bucket_name["_"] or # Bucket names should be between 3 and 63 characters long bucket_name.size > 63 or # Bucket names should not end with a dash bucket_name[-1,1] == '-' or # Bucket names cannot contain two, adjacent periods bucket_name['..'] or # Bucket names cannot contain dashes next to periods # (e.g., "my-.bucket.com" and "my.-bucket" are invalid) (bucket_name['-.'] || bucket_name['.-']) true end |
#json_validation_message(obj) ⇒ Object
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 |
# File 'lib/aws/s3/client.rb', line 1700 def (obj) if obj.respond_to?(:to_str) obj = obj.to_str elsif obj.respond_to?(:to_json) obj = obj.to_json end error = nil begin JSON.parse(obj) rescue => e error = e end "contains invalid JSON: #{error}" if error end |
#path_style_bucket_name?(bucket_name) ⇒ Boolean
Returns true if the bucket name must be used in the request path instead of as a sub-domain when making requests against S3.
This can be an issue if the bucket name is DNS compatible but contains ‘.’ (periods). These cause the SSL certificate to become invalid when making authenticated requets over SSL to the bucket name. The solution is to send this as a path argument instead.
1576 1577 1578 1579 1580 1581 1582 |
# File 'lib/aws/s3/client.rb', line 1576 def path_style_bucket_name? bucket_name if dns_compatible_bucket_name?(bucket_name) bucket_name =~ /\./ ? true : false else true end end |
#require_acl!(options) ⇒ Object
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 |
# File 'lib/aws/s3/client.rb', line 1639 def require_acl! = [ :acl, :grant_read, :grant_write, :grant_read_acp, :grant_write_acp, :grant_full_control, :access_control_policy, ] unless .keys.any?{|opt| .include?(opt) } msg = "missing a required ACL option, must provide an ACL " + "via :acl, :grant_* or :access_control_policy" raise ArgumentError, msg end end |
#require_bucket_name!(bucket_name) ⇒ Object
1600 1601 1602 1603 1604 |
# File 'lib/aws/s3/client.rb', line 1600 def require_bucket_name! bucket_name if [nil, ''].include?(bucket_name) raise ArgumentError, "bucket_name may not be blank" end end |
#require_part_number!(part_number) ⇒ Object
1676 1677 1678 1679 1680 |
# File 'lib/aws/s3/client.rb', line 1676 def require_part_number! part_number validate!("part_number", part_number) do "must not be blank" if part_number.to_s.empty? end end |
#require_policy!(policy) ⇒ Object
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 |
# File 'lib/aws/s3/client.rb', line 1628 def require_policy!(policy) validate!('policy', policy) do case when policy.nil? || policy == '' 'may not be blank' else (policy) end end end |
#require_upload_id!(upload_id) ⇒ Object
1670 1671 1672 1673 1674 |
# File 'lib/aws/s3/client.rb', line 1670 def require_upload_id!(upload_id) validate!("upload_id", upload_id) do "must not be blank" if upload_id.to_s.empty? end end |
#set_body_stream_and_content_length(request, options) ⇒ Object
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 |
# File 'lib/aws/s3/client.rb', line 1656 def set_body_stream_and_content_length request, unless [:content_length] msg = "S3 requires a content-length header, unable to determine " msg << "the content length of the data provided, please set " msg << ":content_length" raise ArgumentError, msg end request.headers['content-length'] = [:content_length] request.body_stream = [:data] end |
#valid_bucket_name?(bucket_name) ⇒ Boolean
Returns true if the given bucket name is valid.
1520 1521 1522 |
# File 'lib/aws/s3/client.rb', line 1520 def valid_bucket_name?(bucket_name) validate_bucket_name!(bucket_name) rescue false end |
#validate!(name, value, &block) ⇒ Object
1584 1585 1586 1587 1588 1589 |
# File 'lib/aws/s3/client.rb', line 1584 def validate! name, value, &block if error_msg = yield raise ArgumentError, "#{name} #{error_msg}" end value end |
#validate_bucket_name!(bucket_name) ⇒ Object
Returns true if the given bucket name is valid. If the name is invalid, an ArgumentError is raised.
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 |
# File 'lib/aws/s3/client.rb', line 1608 def validate_bucket_name!(bucket_name) validate!('bucket_name', bucket_name) do case when bucket_name.nil? || bucket_name == '' 'may not be blank' when bucket_name !~ /^[a-z0-9._\-]+$/ 'may only contain lowercase letters, numbers, periods (.), ' + 'underscores (_), and dashes (-)' when bucket_name !~ /^[a-z0-9]/ 'must start with a letter or a number' when !(3..255).include?(bucket_name.size) 'must be between 3 and 255 characters long' when bucket_name =~ /(\d+\.){3}\d+/ 'must not be formatted like an IP address (e.g., 192.168.5.4)' when bucket_name =~ /\n/ 'must not contain a newline character' end end end |
#validate_key!(key) ⇒ Object
1591 1592 1593 1594 1595 1596 1597 1598 |
# File 'lib/aws/s3/client.rb', line 1591 def validate_key!(key) validate!('key', key) do case when key.nil? || key == '' 'may not be blank' end end end |
#validate_parts!(parts) ⇒ Object
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 |
# File 'lib/aws/s3/client.rb', line 1682 def validate_parts!(parts) validate!("parts", parts) do if !parts.kind_of?(Array) "must not be blank" elsif parts.empty? "must contain at least one entry" elsif !parts.all? { |p| p.kind_of?(Hash) } "must be an array of hashes" elsif !parts.all? { |p| p[:part_number] } "must contain part_number for each part" elsif !parts.all? { |p| p[:etag] } "must contain etag for each part" elsif parts.any? { |p| p[:part_number].to_i < 1 } "must not have part numbers less than 1" end end end |