Class: Fog::Storage::AWS::Directory

Inherits:
Model
  • Object
show all
Defined in:
lib/fog/aws/models/storage/directory.rb

Constant Summary collapse

VALID_ACLS = 
['private', 'public-read', 'public-read-write', 'authenticated-read']
INVALID_LOCATIONS =

See docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html

['us-east-1']

Instance Attribute Summary collapse

Attributes inherited from Model

#collection, #connection

Instance Method Summary collapse

Methods inherited from Model

#initialize, #inspect, #reload, #symbolize_keys, #to_json, #wait_for

Methods included from Attributes::ClassMethods

#_load, #aliases, #attribute, #attributes, #identity, #ignore_attributes, #ignored_attributes

Methods included from Attributes::InstanceMethods

#_dump, #attributes, #dup, #identity, #identity=, #merge_attributes, #new_record?, #requires, #requires_one

Constructor Details

This class inherits a constructor from Fog::Model

Instance Attribute Details

#acl ⇒ Object

Returns the value of attribute acl.



15
16
17
 
# File 'lib/fog/aws/models/storage/directory.rb', line 15

def acl
  @acl
end

Instance Method Details

#destroy ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/fog/aws/models/storage/directory.rb', line 29

def destroy
  requires :key
  connection.delete_bucket(key)
  true
rescue Excon::Errors::NotFound
  false
end

#files ⇒ Object 



50
51
52
 
# File 'lib/fog/aws/models/storage/directory.rb', line 50

def files
  @files ||= Fog::Storage::AWS::Files.new(:directory => self, :connection => connection)
end

#location ⇒ Object 



37
38
39
40
 
# File 'lib/fog/aws/models/storage/directory.rb', line 37

def location
  requires :key
  attributes[:location] || bucket_location || self.connection.region
end

#location=(new_location) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/fog/aws/models/storage/directory.rb', line 42

def location=(new_location)
  if INVALID_LOCATIONS.include?(new_location)
    raise ArgumentError, "location must not include any of #{INVALID_LOCATIONS.join(', ')}. See http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html"
  else
    merge_attributes(:location => new_location)
  end
end

#payer ⇒ Object 



54
55
56
57
58
 
# File 'lib/fog/aws/models/storage/directory.rb', line 54

def payer
  requires :key
  data = connection.get_request_payment(key)
  data.body['Payer']
end

#payer=(new_payer) ⇒ Object 



60
61
62
63
64
 
# File 'lib/fog/aws/models/storage/directory.rb', line 60

def payer=(new_payer)
  requires :key
  connection.put_request_payment(key, new_payer)
  @payer = new_payer
end

#public=(new_public) ⇒ Object 



81
82
83
84
 
# File 'lib/fog/aws/models/storage/directory.rb', line 81

def public=(new_public)
  self.acl = new_public ? 'public-read' : 'private'
  new_public
end

#public_url ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/fog/aws/models/storage/directory.rb', line 86

def public_url
  requires :key
  if connection.get_bucket_acl(key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
    if key.to_s =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\-(?![\.])){1,61}[a-z0-9]$/
      "https://#{key}.s3.amazonaws.com"
    else
      "https://s3.amazonaws.com/#{key}"
    end
  else
    nil
  end
end

#save ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/fog/aws/models/storage/directory.rb', line 99

def save
  requires :key

  options = {}

  options['x-amz-acl'] = acl if acl

  if location = attributes[:location] || (self.connection.region != 'us-east-1' && self.connection.region)
    options['LocationConstraint'] = location
  end

  connection.put_bucket(key, options)

  true
end

#versioning=(new_versioning) ⇒ Object 



72
73
74
75
 
# File 'lib/fog/aws/models/storage/directory.rb', line 72

def versioning=(new_versioning)
  requires :key
  connection.put_bucket_versioning(key, new_versioning ? 'Enabled' : 'Suspended')
end

#versioning? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
69
70
 
# File 'lib/fog/aws/models/storage/directory.rb', line 66

def versioning?
  requires :key
  data = connection.get_bucket_versioning(key)
  data.body['VersioningConfiguration']['Status'] == 'Enabled'
end

#versions ⇒ Object 



77
78
79
 
# File 'lib/fog/aws/models/storage/directory.rb', line 77

def versions
  @versions ||= Fog::Storage::AWS::Versions.new(:directory => self, :connection => connection)
end