sitemap_generator 5.1.0 → 5.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmIyNzk0YTc4MDcyODYxZTQ4NTFlMDhhOTk3Y2YzZGViZmM4N2U0OA==
+    NDE5YzhmMzI3Mzk0ZDIxNGExNjk5OTE5MTMxMTZiYzQ1NjY2NzA5NQ==
   data.tar.gz: !binary |-
-    NjJhMjBlNmM3NTJjOTg5MzRiYTJlMjlhMjVmNjc0NzQ2N2ZiYWJhYg==
+    MTY1OTNhMWE4ZWNiN2JjMzU0ZTUzYzAyZjJhNmE5ZTQ4NjM1MDVkYw==
 SHA512:
   metadata.gz: !binary |-
-    YWJiY2QyNDgyN2IwM2M2NzVmMDYwYmY5YzFlY2JmMjFlZWM1NmIzNzQ4YzA5
-    NWYwN2ExZTc4OWIyODJlY2ZmNTZlZDVlMmE1MWM3Njc2NmJiMDlkNTYyYWM5
-    NjcxNTE2ZGE3MDFhMWI2NjFjODA2YzQ3YTFiODhkZTI0ZjY0YzA=
+    N2NhNmU1OWUwMWM3NTMyMDhmZmU3MmI4NDJjMWYyOWZmOGMzNTkxZTBmMzA0
+    Nzk1M2VjZWU2YzdhZmNkOWYwNDZmY2Q5OWQ0MzAxM2MyYTBhMjhkNjczYTZk
+    NzczMzVkNDhmY2I5OTU2MTFlNTNmN2JlYzRiNmJiOTkzOTc4ZWM=
   data.tar.gz: !binary |-
-    YzI5M2E4ZGZjYmFiYWYyZmZhZmM0MzhmYzIzNWE0Y2M0MTFjYzliZDM4ZDkw
-    ZWQ2OTAzZTE3ZDI4ZTQ4ZTg5ZWZmYmM0MjMxMzczZjFkNGI0M2YyOTI1Mjcy
-    OWIyYWI1Y2IzZjg3MWQxOTRmY2YwYjc1YTFiNmE4YWU1YTk1N2M=
+    ZGNiZjJkMzI0ZmViZmM3OTk4MTFmYWQ4YTA5OWY4ODIzMWQyYWMxMzQ3ZmYw
+    OGY2NTdkNzY5YWJkZGJiNTc1MTVkOWFhYTM1MDZjMjczZjI3MWU1ODIwNjZm
+    MjUyNjc4OTRkMWIwMDZjNDBmOGYzZDAzZTgzYjE2NGU3M2E0ZmY=

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (5.1.0)
-      builder
+    sitemap_generator (5.2.0)
+      builder (~> 3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    builder (3.0.0)
+    builder (3.2.2)
     diff-lcs (1.1.3)
     metaclass (0.0.1)
     mocha (0.10.0)
@@ -33,3 +33,6 @@ DEPENDENCIES
   rake
   rspec
   sitemap_generator!
+
+BUNDLED WITH
+   1.12.5

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 Install section.
+This is a simple standalone example.  For Rails installation see the [Rails instructions](#rails) in the [Install](#install) section.
 
 Install:
 
@@ -117,6 +117,7 @@ That's it!  Welcome to the future!
 
 ## Changelog
 
+* v5.2.0: New `SitemapGenerator::AwsSdkAdapter` adapter using the bare aws-sdk gem.  Fix Bing ping url.  Support string option keys passed to `add`.  In Railtie, Load the rake task instead of requiring them.
 * v5.1.0: Require only `fog-aws` instead of `fog` for the `S3Adapter` and support using IAM profile instead of setting access key & secret directly.  Implement `respond_to?` on the `SitemapGenerator::Sitemap` pseudo class.  Make `:lang` optional on alternate links so they can be used for [AppIndexing](https://developers.google.com/app-indexing/reference/deeplinks).  Documented [Mobile Sitemaps](#internal_mobile) `:mobile` option.
 * v5.0.5: Use MIT licence.  Fix deploys with Capistrano 3 ([#163](https://github.com/kjvarga/sitemap_generator/issues/163)).  Allow any Fog storage options for S3 adapter ([#167](https://github.com/kjvarga/sitemap_generator/pull/167)).
 * v5.0.4: Don't include the `media` attribute on alternate links unless it's given
@@ -221,9 +222,7 @@ _If you would prefer to install as a plugin (deprecated) don't do any of the abo
 
 ### Preventing Output
 
-To disable all non-essential output set the environment variable `VERBOSE=false` when calling Rake or running your Ruby script.
-
-Alternatively you can pass the `-s` option to Rake, for example `rake -s sitemap:refresh`.
+To disable all non-essential output you can pass the `-s` option to Rake, for example `rake -s sitemap:refresh`, or set the environment variable `VERBOSE=false` when calling as a Ruby script.
 
 To disable output in-code use the following:
 
@@ -233,7 +232,7 @@ SitemapGenerator.verbose = false
 
 ### Rake Tasks
 
-* `rake sitemap:install` will create a `config/sitemap.rb` file which is your sitemap configuration and contains everything needed to build your sitemap.  See **Sitemap Configuration** below for more information about how to define your sitemap.
+* `rake sitemap:install` will create a `config/sitemap.rb` file which is your sitemap configuration and contains everything needed to build your sitemap.  See [**Sitemap Configuration**](#sitemap-configuration) below for more information about how to define your sitemap.
 * `rake sitemap:refresh` will create or rebuild your sitemap files as needed.  Sitemaps are generated into the `public/` folder and by default are named `sitemap_index.xml.gz`, `sitemap1.xml.gz`, `sitemap2.xml.gz`, etc.  As you can see they are automatically gzip compressed for you.
 * `rake sitemap:refresh` will output information about each sitemap that is written including its location, how many links it contains and the size of the file.
 
@@ -367,6 +366,10 @@ _This section needs better documentation.  Please consider contributing._
 
   Uses `fog-aws` to upload to Amazon S3 storage.
 
+* `SitemapGenerator::AwsSdkAdapter`
+
+  Uses `aws-sdk` to upload to Amazon S3 storage.
+
 * `SitemapGenerator::WaveAdapter`
 
   Uses `carrierwave` to upload to any service supported by CarrierWave.
@@ -772,7 +775,7 @@ The options passed to `group` only apply to the links and sitemaps generated in
 
 The following options are supported.
 
-* `:create_index` - Supported values: `true`, `false`, `:auto`.  Default: `true`. Whether to create a sitemap index file.  If `true` an index file is always created regardless of how many sitemap files are generated.  If `false` an index file is never created.  If `:auto` an index file is created only when you have more than one sitemap file (i.e. you have added more than 50,000 - `SitemapGenerator::MAX_SITEMAP_LINKS` - links).
+* `:create_index` - Supported values: `true`, `false`, `:auto`.  Default: `:auto`. Whether to create a sitemap index file.  If `true` an index file is always created regardless of how many sitemap files are generated.  If `false` an index file is never created.  If `:auto` an index file is created only when you have more than one sitemap file (i.e. you have added more than 50,000 - `SitemapGenerator::MAX_SITEMAP_LINKS` - links).
 
 * `:default_host` - String.  Required.  **Host including protocol** to use when building a link to add to your sitemap.  For example `http://example.com`.  Calling `add '/home'` would then generate the URL `http://example.com/home` and add that to the sitemap.  You can pass a `:host` option in your call to `add` to override this value on a per-link basis.  For example calling `add '/home', :host => 'https://example.com'` would generate the URL `https://example.com/home`, for that link only.
 

data/VERSION

@@ -1 +1 @@
-5.1.0
+5.2.0

data/lib/sitemap_generator.rb

@@ -4,17 +4,17 @@ require 'sitemap_generator/link_set'
 require 'sitemap_generator/templates'
 require 'sitemap_generator/utilities'
 require 'sitemap_generator/application'
-require 'sitemap_generator/adapters'
 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(: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(: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/aws_sdk_adapter.rb

@@ -0,0 +1,45 @@
+begin
+  require 'aws-sdk'
+rescue LoadError
+  raise LoadError.new("Missing required 'aws-sdk'.  Please 'gem install "\
+                      "aws-sdk' and require it in your application, or "\
+                      "add: gem 'aws-sdk' to your Gemfile.")
+end
+
+module SitemapGenerator
+  # Class for uploading the sitemaps to an S3 bucket using the plain AWS SDK gem
+  class AwsSdkAdapter
+    # @param [String] bucket name of the S3 bucket
+    # @param [Hash]   opts   alternate means of configuration other than ENV
+    # @option opts  [String] :aws_access_key_id instead of ENV['AWS_ACCESS_KEY_ID']
+    # @option opts  [String] :aws_region instead of ENV['AWS_REGION']
+    # @option opts  [String] :aws_secret_access_key instead of ENV['AWS_SECRET_ACCESS_KEY']
+    # @option opts  [String] :path use this prefix on the object key instead of 'sitemaps/'
+    def initialize(bucket, opts = {})
+      @bucket = bucket
+
+      @aws_access_key_id = opts[:aws_access_key_id] || ENV['AWS_ACCESS_KEY_ID']
+      @aws_region = opts[:aws_region] || ENV['AWS_REGION']
+      @aws_secret_access_key = opts[:aws_secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
+
+      @path = opts[:path] || 'sitemaps/'
+    end
+
+    # Call with a SitemapLocation and string data
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+
+      credentials = Aws::Credentials.new(@aws_access_key_id, @aws_secret_access_key)
+      s3 = Aws::S3::Resource.new(credentials: credentials, region: @aws_region)
+
+      s3_object_key = "#{@path}#{location.path_in_public}"
+      s3_object = s3.bucket(@bucket).object(s3_object_key)
+
+      content_type = location[:compress] ? 'application/x-gzip' : 'application/xml'
+      s3_object.upload_file(location.path,
+                            acl: 'public-read',
+                            cache_control: 'private, max-age=0, no-cache',
+                            content_type: content_type)
+    end
+  end
+end

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -31,7 +31,7 @@ module SitemapGenerator
       # * +alternate+/+alternates+
       # * +pagemap+
       def initialize(path, options={})
-        options = options.dup
+        options = SitemapGenerator::Utilities.symbolize_keys(options)
         if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
           SitemapGenerator::Utilities.reverse_merge!(options, :host => sitemap.location.host, :lastmod => sitemap.lastmod)
           path = sitemap.location.path_in_public

data/lib/sitemap_generator/link_set.rb

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

data/lib/sitemap_generator/railtie.rb

@@ -1,7 +1,7 @@
 module SitemapGenerator
   class Railtie < Rails::Railtie
     rake_tasks do
-      require File.expand_path('../tasks', __FILE__)
+      load "tasks/sitemap_generator_tasks.rake"
     end
   end
 end

data/spec/sitemap_generator/builder/sitemap_url_spec.rb

@@ -29,6 +29,12 @@ describe SitemapGenerator::Builder::SitemapUrl do
     url[:lastmod].should == lastmod
   end
 
+  it "should support string option keys" do
+    url = new_url('/home', 'host' => 'http://string.com', 'priority' => 1)
+    url[:priority].should == 1
+    url[:host].should == 'http://string.com'
+  end
+
   it "should support subdirectory routing" do
     url = SitemapGenerator::Builder::SitemapUrl.new('/profile', :host => 'http://example.com/subdir/')
     url[:loc].should == 'http://example.com/subdir/profile'

metadata

@@ -2,71 +2,75 @@
 name: sitemap_generator
 version: !ruby/object:Gem::Version
   version: !binary |-
-    NS4xLjA=
+    NS4yLjA=
 platform: ruby
 authors:
 - Karl Varga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2016-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MC4xMC4w
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MC4xMC4w
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          My4w
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          My4w
 description: SitemapGenerator is a framework-agnostic XML Sitemap generator written
   in Ruby with automatic Rails integration.  It supports Video, News, Image, Geo,
   Mobile, PageMap and Alternate Links sitemap extensions and includes Rake tasks for
@@ -85,7 +89,7 @@ files:
 - lib/capistrano/sitemap_generator.rb
 - lib/capistrano/tasks/sitemap_generator.cap
 - lib/sitemap_generator.rb
-- lib/sitemap_generator/adapters.rb
+- 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/s3_adapter.rb