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

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

Instance Attribute Summary

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 Method Details

#acl=(new_acl) ⇒ Object



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

def acl=(new_acl)
  valid_acls = ['private', 'public-read', 'public-read-write', 'authenticated-read']
  unless valid_acls.include?(new_acl)
    raise ArgumentError.new("acl must be one of [#{valid_acls.join(', ')}]")
  end
  @acl = new_acl
end

#destroyObject



23
24
25
26
27
28
29
# File 'lib/fog/aws/models/storage/directory.rb', line 23

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

#filesObject



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

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

#locationObject



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

def location
  requires :key
  data = connection.get_bucket_location(key)
  data.body['LocationConstraint']
end

#location=(new_location) ⇒ Object



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

def location=(new_location)
  @location = new_location
end

#payerObject



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

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

#payer=(new_payer) ⇒ Object



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

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

#public=(new_public) ⇒ Object



82
83
84
85
86
87
88
89
# File 'lib/fog/aws/models/storage/directory.rb', line 82

def public=(new_public)
  if new_public
    @acl = 'public-read'
  else
    @acl = 'private'
  end
  new_public
end

#public_urlObject



91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/fog/aws/models/storage/directory.rb', line 91

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

#saveObject



104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/fog/aws/models/storage/directory.rb', line 104

def save
  requires :key
  options = {}
  if @acl
    options['x-amz-acl'] = @acl
  end
  lc = @location || self.connection.region
  if lc != 'us-east-1'     # us-east-1 is not valid: See http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html
    options['LocationConstraint'] = lc
  end
  connection.put_bucket(key, options)
  true
end

#versioning=(new_versioning) ⇒ Object



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

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

#versioning?Boolean

Returns:

  • (Boolean)


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

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

#versionsObject



73
74
75
76
77
78
79
80
# File 'lib/fog/aws/models/storage/directory.rb', line 73

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