Class: SitemapGenerator::AwsSdkAdapter

Inherits:
Object
  • Object
show all
Defined in:
lib/sitemap_generator/adapters/aws_sdk_adapter.rb

Overview

Class for uploading sitemaps to an S3 bucket using the AWS SDK gem.

Instance Method Summary collapse

Constructor Details

#initialize(bucket, aws_access_key_id: nil, aws_secret_access_key: nil, aws_session_token: nil, aws_region: nil, aws_endpoint: nil, acl: 'public-read', cache_control: 'private, max-age=0, no-cache', **options) ⇒ AwsSdkAdapter

Specify your AWS bucket name, credentials, and/or region. By default the AWS SDK will auto-detect your credentials and region, but you can use the options to configure them manually.

Requires Aws::S3::Resource and Aws::Credentials to be defined.

Options:

**Deprecated, use :endpoint instead** :aws_endpoint [String] The object storage endpoint,
                                                             if not AWS, e.g. 'https://sfo2.digitaloceanspaces.com'
**Deprecated, use :access_key_id instead** :aws_access_key_id [String] Your AWS access key id
**Deprecated, use :secret_access_key instead** :aws_secret_access_key [String] Your AWS secret access key
**Deprecated, use :region instead** :aws_region [String] Your AWS region
:acl [String] The ACL to apply to the uploaded files.  Defaults to 'public-read'.
:cache_control [String] The cache control headder to apply to the uploaded files.  Defaults to 'private, max-age=0, no-cache'.

All other options you provide are passed directly to the AWS client.
See https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method
for a full list of supported options.

Parameters:

  • bucket (String) —

    Name of the S3 bucket

  • options (Hash) —

    Options passed directly to AWS to control the Resource created. See Options below.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/sitemap_generator/adapters/aws_sdk_adapter.rb', line 32

def initialize(bucket, aws_access_key_id: nil, aws_secret_access_key: nil, aws_session_token: nil, aws_region: nil, aws_endpoint: nil, acl: 'public-read', cache_control: 'private, max-age=0, no-cache', **options)
  @bucket = bucket
  @acl = acl
  @cache_control = cache_control
  @options = options
  set_option_unless_set(:access_key_id, aws_access_key_id)
  set_option_unless_set(:secret_access_key, aws_secret_access_key)
  set_option_unless_set(:session_token, aws_session_token)
  set_option_unless_set(:region, aws_region)
  set_option_unless_set(:endpoint, aws_endpoint)
end

Instance Method Details

#write(location, raw_data) ⇒ Object

Call with a SitemapLocation and string data



46
47
48
49
50
51
52
53
54
 
# File 'lib/sitemap_generator/adapters/aws_sdk_adapter.rb', line 46

def write(location, raw_data)
  SitemapGenerator::FileAdapter.new.write(location, raw_data)
  s3_object = s3_resource.bucket(@bucket).object(location.path_in_public)
  s3_object.upload_file(location.path, {
    acl: @acl,
    cache_control: @cache_control,
    content_type: location[:compress] ? 'application/x-gzip' : 'application/xml'
  }.compact)
end