sitemap_generator 6.0.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 526fb81217b6a251f0855ca41062a46c4e891c7ef0b0f205e66150c71971d88e
-  data.tar.gz: 60deb9fca4870f1726a366a8179ce4845e0221a8eb59d59dd44d990f603b1665
+  metadata.gz: 3d08b16f794edd543800c56dd8b2827c6b4ea4fb85721b18e3b675c4a5599a9d
+  data.tar.gz: ce55fb33969d09c5e2d9ca4b841f511b6ecb9a365a64ec20964394266bcee305
 SHA512:
-  metadata.gz: 66d23227adef4509f58d8187f8b41008a1357b558db9c669bb83bba3a28372f23be1958cc22a14bab2be891b4984bfda9360afdb807665ebd137fe45a2e19833
-  data.tar.gz: cedd0f41927cd430a8f3089e71230dcd11f92804b62bb1dad8626925068823e27bce55cb144fc49d2c78010239f4ff350ed877f948291b28b8ff7fd894311d14
+  metadata.gz: 0fe5e90c200a165349a424cfbe919bb11613419acad18d068c8406c8998b22c965b80bb7a16caf20e4c59da44595abeae91f4d7555992f6f249cd4665d036cd4
+  data.tar.gz: 7f9493d43d626dde991e35f3b552541be9154d22c5a94c55820b50f023b647207167a3dccafeff2a5402c57fa2bd0c4cd6bac2f644ecf6b823fdc1d6716b714e

data/CHANGES.md

@@ -1,3 +1,7 @@
+### 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).

data/README.md

@@ -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)
@@ -329,24 +335,24 @@ 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`.
@@ -364,7 +370,7 @@ directory.
   )
   ```
 
-* `SitemapGenerator::WaveAdapter`
+##### `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.
@@ -374,6 +380,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
@@ -1120,3 +1151,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.2
+6.1.0

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)

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Karl Varga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-12-26 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