sitemap_generator 6.0.0 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd5273cdd05ca2424e838c1505a796cb7bb55647
-  data.tar.gz: 05cbb2f7268b6631738b8a6be118ae3319f053da
+SHA256:
+  metadata.gz: 07d190381c5aae66acc3b6eaa43d61444f3280e1ff76fd0dadf49d6c730d9b7a
+  data.tar.gz: dc61f7ff02926247d30ead18d71b16068e14a01ed36bb0694f0615febef6000a
 SHA512:
-  metadata.gz: 7c777c3ea4cbecfdaebbd51ae1d0a8179360d88550cb2b37dfe649cc5f3644edf84494f29caa1b1ccddadd5d84281e6fa15906f825c2824c00145c076e06aeb0
-  data.tar.gz: d96685b4029e704e8320936dc74d63db60527f6846bc7aa4682612c254b1c4e89060c85c45b592c4f89d21c12580f815ef2fcedc067a4283ade468888515e388
+  metadata.gz: ee8f86311c174e2b9b01514d48325f6d824bcabfaf8e5a711ff7e83442bc9f5adf4bbbe1ddc990d292c8ffc73138e7244b840a38aaeccef6f26bb55adee8cae6
+  data.tar.gz: 1049e27acaa1dafee38153d4faa1b51de61e67162a792a525269090e51f85e1c5c919c9755cc301543e6cd97dd8f18f5d914685cc7e3a23c49a494d3abdb21d9

data/CHANGES.md

@@ -1,3 +1,25 @@
+### 6.1.2
+
+* Resolve NoMethodError using URI#open for Ruby less than 2.5.0 [#353](https://github.com/kjvarga/sitemap_generator/pull/353)
+
+### 6.1.1
+
+* Resolve deprecation warning on using Kernel#open in Ruby 2.7 (use URI.open instead) [#342](https://github.com/kjvarga/sitemap_generator/pull/342)
+* Support S3 Endpoints for S3 Compliant Providers like DigitalOcean Spaces [#325](https://github.com/kjvarga/sitemap_generator/pull/325)
+
+### 6.1.0
+
+* Support uploading files to Google Cloud Storage [#326](https://github.com/kjvarga/sitemap_generator/pull/326) and [#340](https://github.com/kjvarga/sitemap_generator/pull/340)
+
+### 6.0.2
+
+* Resolve `BigDecimal.new is deprecated` warnings in Ruby 2.5 [#305](https://github.com/kjvarga/sitemap_generator/pull/305).
+* Resolve `instance variable not initialized`, `File.exists? is deprecated` and `'*' interpreted as argument prefix` warnings [#304](https://github.com/kjvarga/sitemap_generator/pull/304).
+
+### 6.0.1
+
+* Use `yaml_tag` instead of `yaml_as`, which was deprecated in Ruby 2.4, and removed in 2.5 [#298](https://github.com/kjvarga/sitemap_generator/pull/298).
+
 ### 6.0.0
 
 *Backwards incompatible changes*

data/README.md

@@ -20,7 +20,7 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 
 ### Show Me
 
-This is a simple standalone example.  For Rails installation see the [Rails instructions](#rails) in the [Install](#install) section.
+This is a simple standalone example.  For Rails installation see the [Rails instructions](#rails) in the [Install](#installation) section.
 
 Install:
 
@@ -80,6 +80,12 @@ Successful ping of Bing
   + [Sitemaps with no Index File](#sitemaps-with-no-index-file)
   + [Upload Sitemaps to a Remote Host using Adapters](#upload-sitemaps-to-a-remote-host-using-adapters)
     - [Supported Adapters](#supported-adapters)
+      * [`SitemapGenerator::FileAdapter`](#sitemapgeneratorfileadapter)
+      * [`SitemapGenerator::FogAdapter`](#sitemapgeneratorfogadapter)
+      * [`SitemapGenerator::S3Adapter`](#sitemapgenerators3adapter)
+      * [`SitemapGenerator::AwsSdkAdapter`](#sitemapgeneratorawssdkadapter)
+      * [`SitemapGenerator::WaveAdapter`](#sitemapgeneratorwaveadapter)
+      * [`SitemapGenerator::GoogleStorageAdapter`](#sitemapgeneratorgooglestorageadapter)
     - [An Example of Using an Adapter](#an-example-of-using-an-adapter)
   + [Generating Multiple Sitemaps](#generating-multiple-sitemaps)
 * [Sitemap Configuration](#sitemap-configuration)
@@ -158,12 +164,14 @@ Add the gem to your `Gemfile`:
 gem 'sitemap_generator'
 ```
 
-Alternatively, if you are not using a `Gemfile` add the gem to your `config/environment.rb` file config block:
+Alternatively, if you are not using a `Gemfile` add the gem to your `config/application.rb` file config block:
 
 ```ruby
 config.gem 'sitemap_generator'
 ```
 
+Note: SitemapGenerator automatically loads its Rake tasks when used with Rails. You **do not need** to require the `sitemap_generator/tasks` file.
+
 ## Getting Started
 
 ### Preventing Output
@@ -327,29 +335,29 @@ directory.
 
 #### Supported Adapters
 
-* `SitemapGenerator::FileAdapter`
+##### `SitemapGenerator::FileAdapter`
 
   Standard adapter, writes out to a file.
 
-* `SitemapGenerator::FogAdapter`
+##### `SitemapGenerator::FogAdapter`
 
   Uses `Fog::Storage` to upload to any service supported by Fog.
 
   You must `require 'fog'` in your sitemap config before using this adapter,
   or `require` another library that defines `Fog::Storage`.
 
-* `SitemapGenerator::S3Adapter`
+##### `SitemapGenerator::S3Adapter`
 
   Uses `Fog::Storage` to upload to Amazon S3 storage.
 
   You must `require 'fog-aws'` in your sitemap config before using this adapter.
 
-* `SitemapGenerator::AwsSdkAdapter`
+##### `SitemapGenerator::AwsSdkAdapter`
 
   Uses `Aws::S3::Resource` to upload to Amazon S3 storage.  Includes automatic detection of your AWS
   credentials using `Aws::Credentials`.
 
-  You must `require 'aws-sdk'` in your sitemap config before using this adapter,
+  You must `require 'aws-sdk-s3'` in your sitemap config before using this adapter,
   or `require` another library that defines `Aws::S3::Resource` and `Aws::Credentials`.
 
   An example of using this adapter in your sitemap configuration:
@@ -362,7 +370,26 @@ directory.
   )
   ```
 
-* `SitemapGenerator::WaveAdapter`
+##### `SitemapGenerator::AwsSdkAdapter (DigitalOcean Spaces)`
+
+  Uses `Aws::S3::Resource` to upload to Amazon S3 storage.  Includes automatic detection of your AWS
+  credentials using `Aws::Credentials`.
+
+  You must `require 'aws-sdk-s3'` in your sitemap config before using this adapter,
+  or `require` another library that defines `Aws::S3::Resource` and `Aws::Credentials`.
+
+  An example of using this adapter in your sitemap configuration:
+
+  ```ruby
+  SitemapGenerator::Sitemap.adapter = SitemapGenerator::AwsSdkAdapter.new('s3_bucket',
+    aws_access_key_id: 'AKIAI3SW5CRAZBL4WSTA',
+    aws_secret_access_key: 'asdfadsfdsafsadf',
+    aws_region: 'sfo2',
+    aws_endpoint: 'https://sfo2.digitaloceanspaces.com'
+  )
+  ```
+
+##### `SitemapGenerator::WaveAdapter`
 
   Uses `CarrierWave::Uploader::Base` to upload to any service supported by CarrierWave, for example,
   Amazon S3, Rackspace Cloud Files, and MongoDB's GridF.
@@ -372,6 +399,31 @@ directory.
 
   Some documentation exists [on the wiki page][remote_hosts].
 
+##### `SitemapGenerator::GoogleStorageAdapter`
+
+  Uses [`Google::Cloud::Storage`][google_cloud_storage_gem] to upload to Google Cloud storage.
+
+  You must `require 'google/cloud/storage'` in your sitemap config before using this adapter.
+
+  An example of using this adapter in your sitemap configuration with options:
+
+  ```ruby
+  SitemapGenerator::Sitemap.adapter = SitemapGenerator::GoogleStorageAdapter.new(
+    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:
+
+  ```ruby
+  SitemapGenerator::Sitemap.adapter = SitemapGenerator::GoogleStorageAdapter.new(
+    bucket: 'name_of_bucket'
+  )
+  ```
+
+  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.
+
 #### An Example of Using an Adapter
 
 1. Please see [this wiki page][remote_hosts] for more information about setting up SitemapGenerator to upload to a
@@ -1118,3 +1170,6 @@ Copyright (c) Karl Varga released under the MIT license
 [iso_4217]:http://en.wikipedia.org/wiki/ISO_4217
 [media]:https://developers.google.com/webmasters/smartphone-sites/details
 [expires]:https://support.google.com/customsearch/answer/2631051?hl=en
+[google_cloud_storage_gem]:https://rubygems.org/gems/google-cloud-storage
+[google_cloud_storage_authentication]:https://googleapis.dev/ruby/google-cloud-storage/latest/file.AUTHENTICATION.html
+[google_cloud_storage_initializer]:https://github.com/googleapis/google-cloud-ruby/blob/master/google-cloud-storage/lib/google/cloud/storage.rb

data/VERSION

@@ -1 +1 @@
-6.0.0
+6.1.2

data/lib/sitemap_generator.rb

@@ -7,14 +7,15 @@ require 'sitemap_generator/application'
 require 'sitemap_generator/sitemap_location'
 
 module SitemapGenerator
-  autoload(:Interpreter,   'sitemap_generator/interpreter')
-  autoload(:FileAdapter,   'sitemap_generator/adapters/file_adapter')
-  autoload(:S3Adapter,     'sitemap_generator/adapters/s3_adapter')
-  autoload(:AwsSdkAdapter, 'sitemap_generator/adapters/aws_sdk_adapter')
-  autoload(:WaveAdapter,   'sitemap_generator/adapters/wave_adapter')
-  autoload(:FogAdapter,    'sitemap_generator/adapters/fog_adapter')
-  autoload(:BigDecimal,    'sitemap_generator/core_ext/big_decimal')
-  autoload(:Numeric,       'sitemap_generator/core_ext/numeric')
+  autoload(:Interpreter,              'sitemap_generator/interpreter')
+  autoload(:FileAdapter,              'sitemap_generator/adapters/file_adapter')
+  autoload(:S3Adapter,                'sitemap_generator/adapters/s3_adapter')
+  autoload(:AwsSdkAdapter,            'sitemap_generator/adapters/aws_sdk_adapter')
+  autoload(:WaveAdapter,              'sitemap_generator/adapters/wave_adapter')
+  autoload(:FogAdapter,               'sitemap_generator/adapters/fog_adapter')
+  autoload(:GoogleStorageAdapter,     'sitemap_generator/adapters/google_storage_adapter')
+  autoload(:BigDecimal,               'sitemap_generator/core_ext/big_decimal')
+  autoload(:Numeric,                  'sitemap_generator/core_ext/numeric')
 
   SitemapError          = Class.new(StandardError)
   SitemapFullError      = Class.new(SitemapError)
@@ -56,6 +57,7 @@ module SitemapGenerator
     attr_accessor :root, :app, :templates
     attr_writer :yield_sitemap, :verbose
   end
+  @yield_sitemap = nil
 
   # Global default for the verbose setting.
   def self.verbose

data/lib/sitemap_generator/adapters/aws_sdk_adapter.rb

@@ -24,6 +24,7 @@ module SitemapGenerator
       @aws_access_key_id = options[:aws_access_key_id]
       @aws_secret_access_key = options[:aws_secret_access_key]
       @aws_region = options[:aws_region]
+      @aws_endpoint = options[:aws_endpoint]
     end
 
     # Call with a SitemapLocation and string data
@@ -46,6 +47,7 @@ module SitemapGenerator
     def s3_resource_options
       options = {}
       options[:region] = @aws_region if !@aws_region.nil?
+      options[:endpoint] = @aws_endpoint if !@aws_endpoint.nil?
       if !@aws_access_key_id.nil? && !@aws_secret_access_key.nil?
         options[:credentials] = Aws::Credentials.new(
           @aws_access_key_id,

data/lib/sitemap_generator/adapters/file_adapter.rb

@@ -11,7 +11,7 @@ module SitemapGenerator
     def write(location, raw_data)
       # Ensure that the directory exists
       dir = location.directory
-      if !File.exists?(dir)
+      if !File.exist?(dir)
         FileUtils.mkdir_p(dir)
       elsif !File.directory?(dir)
         raise SitemapError.new("#{dir} should be a directory!")

data/lib/sitemap_generator/adapters/google_storage_adapter.rb

@@ -0,0 +1,37 @@
+if !defined?(Google::Cloud::Storage)
+  raise "Error: `Google::Cloud::Storage` is not defined.\n\n"\
+        "Please `require 'google/cloud/storage'` - or another library that defines this class."
+end
+
+module SitemapGenerator
+  # Class for uploading sitemaps to a Google Storage using `google-cloud-storage` gem.
+  class GoogleStorageAdapter
+    # Requires Google::Cloud::Storage to be defined.
+    #
+    # @param [Hash] opts Google::Cloud::Storage configuration options.
+    # @option :bucket [String] Required. Name of Google Storage Bucket where the file is to be uploaded.
+    #
+    # All options other than the `:bucket` option 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.
+    #
+    # Suggested Options:
+    # @option :credentials [String] Path to Google service account JSON file, or JSON contents.
+    # @option :project_id [String] Google Accounts project id where the storage bucket resides.
+    def initialize(opts = {})
+      opts = opts.clone
+      @bucket = opts.delete(:bucket)
+      @storage_options = opts
+    end
+
+    # Call with a SitemapLocation and string data
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+
+      storage = Google::Cloud::Storage.new(@storage_options)
+      bucket = storage.bucket(@bucket)
+      bucket.create_file(location.path, location.path_in_public, acl: 'public')
+    end
+  end
+end

data/lib/sitemap_generator/builder/sitemap_index_file.rb

@@ -30,6 +30,7 @@ module SitemapGenerator
         # Store the URL of the first sitemap added because if create_index is
         # false this is the "index" URL
         @first_sitemap_url = nil
+        @create_index = nil
       end
 
       # Finalize sitemaps as they are added to the index.

data/lib/sitemap_generator/core_ext/big_decimal.rb

@@ -8,11 +8,23 @@ end
 require 'yaml'
 
 # Define our own class rather than modify the global class
-class SitemapGenerator::BigDecimal < BigDecimal
+class SitemapGenerator::BigDecimal
   YAML_TAG = 'tag:yaml.org,2002:float'
   YAML_MAPPING = { 'Infinity' => '.Inf', '-Infinity' => '-.Inf', 'NaN' => '.NaN' }
 
-  yaml_as YAML_TAG
+  yaml_tag YAML_TAG
+
+  def initialize(num)
+    @value = BigDecimal(num)
+  end
+
+  def *(other)
+    other * @value
+  end
+
+  def /(other)
+    SitemapGenerator::BigDecimal === other ? @value / other.instance_variable_get(:@value) : @value / other
+  end
 
   # This emits the number without any scientific notation.
   # This is better than self.to_f.to_s since it doesn't lose precision.
@@ -37,9 +49,7 @@ class SitemapGenerator::BigDecimal < BigDecimal
   end
 
   DEFAULT_STRING_FORMAT = 'F'
-  def to_formatted_s(format = DEFAULT_STRING_FORMAT)
-    _original_to_s(format)
+  def to_s(format = DEFAULT_STRING_FORMAT)
+    @value.to_s(format)
   end
-  alias_method :_original_to_s, :to_s
-  alias_method :to_s, :to_formatted_s
 end

data/lib/sitemap_generator/link_set.rb

@@ -118,6 +118,8 @@ module SitemapGenerator
     # Note: When adding a new option be sure to include it in `options_for_group()` if
     # the option should be inherited by groups.
     def initialize(options={})
+      @default_host, @sitemaps_host, @yield_sitemap, @sitemaps_path, @adapter, @verbose, @protect_index, @sitemap_index, @added_default_links, @created_group, @sitemap = nil
+
       options = SitemapGenerator::Utilities.reverse_merge(options,
         :include_root => true,
         :include_index => false,
@@ -293,7 +295,11 @@ module SitemapGenerator
         name = Utilities.titleize(engine.to_s)
         begin
           Timeout::timeout(10) {
-            open(link)
+            if URI.respond_to?(:open) # Available since Ruby 2.5
+              URI.open(link)
+            else
+              open(link) # using Kernel#open became deprecated since Ruby 2.7. See https://bugs.ruby-lang.org/issues/15893
+            end
           }
           output("  Successful ping of #{name}")
         rescue Timeout::Error, StandardError => e

data/lib/sitemap_generator/templates.rb

@@ -11,7 +11,7 @@ module SitemapGenerator
     }
 
     # Dynamically define accessors for each key defined in <tt>FILES</tt>
-    attr_accessor *FILES.keys
+    attr_accessor(*FILES.keys)
     FILES.keys.each do |name|
       eval <<-END
         define_method(:#{name}) do
@@ -38,4 +38,4 @@ module SitemapGenerator
       File.read(template_path(template))
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.2
 platform: ruby
 authors:
 - Karl Varga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SitemapGenerator is a framework-agnostic XML Sitemap generator written
   in Ruby with automatic Rails integration.  It supports Video, News, Image, Mobile,
   PageMap and Alternate Links sitemap extensions and includes Rake tasks for managing
@@ -141,6 +155,7 @@ files:
 - lib/sitemap_generator/adapters/aws_sdk_adapter.rb
 - lib/sitemap_generator/adapters/file_adapter.rb
 - lib/sitemap_generator/adapters/fog_adapter.rb
+- lib/sitemap_generator/adapters/google_storage_adapter.rb
 - lib/sitemap_generator/adapters/s3_adapter.rb
 - lib/sitemap_generator/adapters/wave_adapter.rb
 - lib/sitemap_generator/application.rb
@@ -184,8 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Easily generate XML Sitemaps