sitemap_generator 6.2.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6619733ac6e91a00c5a7b194f82f76b68de2c0521dda3c554d28c8315c0e7c29
-  data.tar.gz: 0d73d0acac5b95961d5799a766a5c6af6fac85173420807db5cbc9a630f1841d
+  metadata.gz: bd65e97e0a574eb1d124988e20c38312968548bf8ef8d381e648c54d6766d049
+  data.tar.gz: b9cbf014555cbdfb293c6e780a3e9ab4349db02f8fddbcddc28ab8c743f24657
 SHA512:
-  metadata.gz: 637cc70ee0036b4e9d228abe34abe4b220db7a6647c3e26b1b98e5df20e59d0e9c24f5f8596ef941afb5ea252081ce048cc74e95b7b52a69fc4c5e48774e3c22
-  data.tar.gz: 784183a6a1a1735078734f68aab8e62702b62e474c7602c9360bf2021aeff6492c03405b14a4800d42490bd0b2319c00814541252a3a8f6d4e70becfd87ee6d0
+  metadata.gz: 1ec50b44415503a1d3bce5859cf6b397592212c19827f6dc45019df221f3c08131a04f7e89db98d21172982d6ca212c901638c30882c9b4b08adc107fff67d95
+  data.tar.gz: 3afc709b82309f5c052fb00e8c467554c44cc974d7dc122ae45938d9b80c574236639c74b85058a1251c7fc5a2fd2fe827d8478619612f8c6ee0a5ef514d780f

data/CHANGES.md

@@ -1,3 +1,10 @@
+### 6.3.0
+
+* Remove Bing's deprecated sitemap submission [#400](https://github.com/kjvarga/sitemap_generator/pull/400).
+* `SitemapGenerator::AwsSdkAdapter`: Support configuring ACL and caching on the uploaded files [#409](https://github.com/kjvarga/sitemap_generator/pull/409).
+* `SitemapGenerator::GoogleStorageAdapter`: Support configuring ACL on the uploaded files [#410](https://github.com/kjvarga/sitemap_generator/pull/410).
+* Fix CircleCI specs for Ruby 3 [#407](https://github.com/kjvarga/sitemap_generator/pull/407).
+
 ### 6.2.1
 
 * Bugfix: Improve handling of deprecated options in `AwsSdkAdapter`.  Fixes bug where `:region` was being set to `nil`. [#390](https://github.com/kjvarga/sitemap_generator/pull/390).

data/README.md

@@ -15,7 +15,7 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 * Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
 * Handles millions of links
 * Customizable sitemap compression
-* Notifies search engines (Google, Bing) of new sitemaps
+* Notifies search engines (Google) of new sitemaps
 * Ensures your old sitemaps stay in place if the new sitemap fails to generate
 * Gives you complete control over your sitemap contents and naming scheme
 * Intelligent sitemap indexing
@@ -58,7 +58,6 @@ In /Users/karl/projects/sitemap_generator-test/public/
 Sitemap stats: 3 links / 1 sitemaps / 0m00s
 
 Successful ping of Google
-Successful ping of Bing
 ```
 
 ## Contents
@@ -205,7 +204,7 @@ SitemapGenerator.verbose = false
 
 ### Pinging Search Engines
 
-Using `rake sitemap:refresh` will notify Google and Bing to let them know that a new sitemap
+Using `rake sitemap:refresh` will notify Google to let them know that a new sitemap
 is available.  To generate new sitemaps without notifying search engines, use `rake sitemap:refresh:no_ping`.
 
 If you want to customize the hash of search engines you can access it at:
@@ -387,6 +386,8 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
 
   ```ruby
   SitemapGenerator::Sitemap.adapter = SitemapGenerator::AwsSdkAdapter.new('s3_bucket',
+    acl: 'public-read', # Optional. This is the default.
+    cache_control: 'private, max-age=0, no-cache', # Optional. This is the default.
     access_key_id: 'AKIAI3SW5CRAZBL4WSTA',
     secret_access_key: 'asdfadsfdsafsadf',
     region: 'us-east-1',
@@ -394,11 +395,9 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
   )
   ```
 
-  Where the first argument is the S3 bucket name, and the rest are keyword argument options which
-  are passed directly to the AWS client.
+  Where the first argument is the S3 bucket name, and the rest are keyword argument options.  Options `:acl` and `:cache_control` configure access and caching of the uploaded files; all other options 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.
+  See [the `SitemapGenerator::AwsSdkAdapter` docs](https://github.com/kjvarga/sitemap_generator/blob/master/lib/sitemap_generator/adapters/aws_sdk_adapter.rb), and [https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method](https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method) for the full list of supported options.
 
 ##### `SitemapGenerator::WaveAdapter`
 
@@ -420,9 +419,10 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
 
   ```ruby
   SitemapGenerator::Sitemap.adapter = SitemapGenerator::GoogleStorageAdapter.new(
+    acl: 'public', # Optional.  This is the default value.
+    bucket: 'name_of_bucket'
     credentials: 'path/to/keyfile.json',
     project_id: 'google_account_project_id',
-    bucket: 'name_of_bucket'
   )
   ```
   Also, inline with Google Authentication options, it can also pick credentials from environment variables. All [supported environment variables][google_cloud_storage_authentication] can be used, for example: `GOOGLE_CLOUD_PROJECT` and `GOOGLE_CLOUD_CREDENTIALS`.  An example of using this adapter with the environment variables is:
@@ -433,7 +433,7 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
   )
   ```
 
-  All options other than the `:bucket` option are passed to the `Google::Cloud::Storage.new` initializer giving you maximum configurability.  See the [Google Cloud Storage initializer][google_cloud_storage_initializer] for supported options.
+  All options other than the `:bucket` and `:acl` options are passed to the `Google::Cloud::Storage.new` initializer giving you maximum configurability.  See the [Google Cloud Storage initializer][google_cloud_storage_initializer] for supported options.
 
 #### An Example of Using an Adapter
 

data/VERSION

@@ -1 +1 @@
-6.2.1
+6.3.0

data/lib/sitemap_generator/adapters/aws_sdk_adapter.rb

@@ -18,15 +18,19 @@ module SitemapGenerator
     # 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** :access_key_id [String] Your AWS access key id
+    #   **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.
-    def initialize(bucket, aws_access_key_id: nil, aws_secret_access_key: nil, aws_region: nil, aws_endpoint: nil, **options)
+    def initialize(bucket, aws_access_key_id: nil, aws_secret_access_key: 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)
@@ -39,11 +43,11 @@ module SitemapGenerator
     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: 'public-read',
-        cache_control: 'private, max-age=0, no-cache',
+      s3_object.upload_file(location.path, {
+        acl: @acl,
+        cache_control: @cache_control,
         content_type: location[:compress] ? 'application/x-gzip' : 'application/xml'
-      )
+      }.compact)
     end
 
     private

data/lib/sitemap_generator/adapters/google_storage_adapter.rb

@@ -10,8 +10,9 @@ module SitemapGenerator
     #
     # @param [Hash] opts Google::Cloud::Storage configuration options.
     # @option :bucket [String] Required. Name of Google Storage Bucket where the file is to be uploaded.
+    # @option :acl [String] Optional. Access control which is applied to the uploaded file(s).  Default value is 'public'.
     #
-    # All options other than the `:bucket` option are passed to the `Google::Cloud::Storage.new`
+    # All options other than the `:bucket` and `:acl` options are passed to the `Google::Cloud::Storage.new`
     # initializer.  See https://googleapis.dev/ruby/google-cloud-storage/latest/file.AUTHENTICATION.html
     # for all the supported environment variables and https://github.com/googleapis/google-cloud-ruby/blob/master/google-cloud-storage/lib/google/cloud/storage.rb
     # for supported options.
@@ -22,6 +23,7 @@ module SitemapGenerator
     def initialize(opts = {})
       opts = opts.clone
       @bucket = opts.delete(:bucket)
+      @acl = opts.has_key?(:acl) ? opts.delete(:acl) : 'public'
       @storage_options = opts
     end
 
@@ -31,7 +33,7 @@ module SitemapGenerator
 
       storage = Google::Cloud::Storage.new(**@storage_options)
       bucket = storage.bucket(@bucket)
-      bucket.create_file(location.path, location.path_in_public, acl: 'public')
+      bucket.create_file(location.path, location.path_in_public, acl: @acl)
     end
   end
 end

data/lib/sitemap_generator/link_set.rb

@@ -125,8 +125,7 @@ module SitemapGenerator
         :include_index => false,
         :filename => :sitemap,
         :search_engines => {
-          :google         => "http://www.google.com/webmasters/tools/ping?sitemap=%s",
-          :bing           => "http://www.bing.com/webmaster/ping.aspx?sitemap=%s"
+          :google         => "http://www.google.com/webmasters/tools/ping?sitemap=%s"
         },
         :create_index => :auto,
         :compress => true,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.3.0
 platform: ruby
 authors:
 - Karl Varga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder