sitemaps 0.6.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kazuyoshi tlacaelel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,173 @@
+= Sitemaps
+
+Setup a config yaml file. I will download & compress your sitemaps!
+
+Sitemaps provides an executable that will take a configuration yaml file.
+When runned it will download and gzip-compress your sitemaps ready for production!
+
+Basically the idea is that you do not want your production server to
+compile the xml every single time, and on top of that you do not want
+to (gzip) your sitemap on the fly nor tell your web-server to do that
+for every single request.
+
+So we precompile, the sitemaps and compress them in a "generator"
+machine and store the static gziped-sitemaps on the webserver.
+
+Sitemaps provides a simple way to do this, put the name of your
+'generator-machine' and setup your production domain, subdirectories
+and sitemap-index (sitemap of sitemaps) will be dinamically generated
+for you. so all you have to do is execute and copy to your web-servers!
+
+a sample robots file is also generated for you, you can simply cat
+this and append it to your existing robots.txt file or simply use it
+as a reference if you are generating it dinamically.
+
+By Kazuyoshi Tlacaelel
+
+
+Run..
+
+  $ sitemaps config.yml
+
+Enjoy!
+
+  $ tree sitemaps
+  sitemaps
+  |-- downloads
+  |   `-- communities.xml
+  |-- index.xml
+  |-- index.xml.gz
+  |-- robots.txt
+  `-- sitemaps
+      `-- communities.xml.gz
+
+      2 directories, 5 files
+
+== Dependancies
+
+  # external libraries
+  require 'net/http'
+  require 'yaml'
+  require 'zlib'
+  require 'builder'
+
+== Features
+
+* automatic generation of sitemap indexes ( a sitemap of sitemaps )
+
+    $ cat sitemaps/index.xml
+
+    <?version1.0encodingUTF-8?>
+    <sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+      <sitemap>
+        <loc>http://example.com/sitemaps/communities.xml.gz</loc>
+        <lastmod>2009-09-15</lastmod>
+      </sitemap>
+    </sitemapindex>
+
+* sample robots.txt generation
+
+    Sitemap: http://example.com/sitemaps/index.xml.gz
+
+* download of sitemaps + compression
+
+    $ tree sitemaps
+
+    sitemaps
+    |-- downloads
+    |   `-- communities.xml
+    |-- index.xml
+    |-- index.xml.gz
+    |-- robots.txt
+    `-- sitemaps
+        `-- communities.xml.gz
+
+        2 directories, 5 files
+
+* The config file
+
+    configuration:
+
+      # Machine that generates your sitemaps
+      # do not prefix "http://" nor append the port
+      generator: localhost
+
+      # The http-port of your generator
+      generator_port: 3000
+
+      # The time to wait for each sitemap to be received
+      generator_timeout: 999
+
+      # Domain from where the sitemaps will be available.
+      # It is important that you do not append the last slash
+      # otherwise you may get an error message
+      #
+      # NG
+      # http://example.com/
+      #
+      # OK
+      # http://example.com
+      #
+      domain: http://example.com
+
+      # Path to sitemaps to be compiled on "generator".
+      # For example: if you have the following url
+      #
+      #   http://localhost:3000/sitemap_for/users.xml
+      #
+      # The target must be specified as such
+      #
+      # Note: you can have multiple targets
+      #
+      targets:
+        - /sitemap_for/users.xml
+
+      # Directory where compressed maps will be placed.
+      #
+      # Its a good idea to use a sub-path in your domain.
+      #
+      # For example:
+      # (your dump_dir could be sitemaps for the following url)
+      #
+      #   http://example.com/sitemaps
+      #
+      dump_dir: sitemaps
+
+== Install
+
+    $ gem sources -a http://gems.github.com
+    $ gem install ktlacaelel-sitemaps
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Ruby versions
+
+  ruby 1.8.6 (2008-08-11 patchlevel 287) [universal-darwin9.0]
+  ruby 1.8.7 (2009-06-12 patchlevel 174) [x86_64-linux]
+
+  (havent tried any other let me know if you have any problems)
+
+== Tested under
+
+  # Darwin tlacaelel.local 9.8.0 Darwin Kernel Version 9.8.0: Wed Jul 15 16:55:01 PDT 2009; root:xnu-1228.15.4~1/RELEASE_I386 i386
+  # Linux utopia.local 2.6.28-11-server #42-Ubuntu SMP Fri Apr 17 02:45:36 UTC 2009 x86_64 GNU/Linux
+
+== Tests
+  only the download and compression part have no tests but the api is
+  pretty stable
+
+== Copyright
+
+MIT LICENSE
+
+Copyright (c) 2009 kazuyoshi tlacaelel. See "LICENSE" file for details.
+

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sitemaps"
+    gem.summary = %Q{Setup a config yaml file. I will download & compress your sitemaps!}
+    gem.description = %Q{
+    Sitemaps provides an executable that will take a configuration yaml file.
+    When runned it will download and gzip-compress your sitemaps ready for production!
+    }
+    gem.email = "kazu.dev@gmail.com"
+    gem.homepage = "http://github.com/ktlacaelel/sitemaps"
+    gem.authors = ["kazuyoshi tlacaelel"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('builder', '>=2.1.2')
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sitemaps #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/bin/sitemaps

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'sitemaps'
+
+configuration = Sitemaps::Configuration.new(ARGV[0])
+Sitemaps::Generator.new(configuration).execute!
+

data/lib/configuration.rb

@@ -0,0 +1,109 @@
+module Sitemaps
+
+  class Configuration
+
+    attr_reader :generator, :domain, :targets, :dump_dir, :generator_port, :generator_timeout
+
+    def initialize(yaml_file)
+      @yaml_file = yaml_file
+      validate!
+    end
+
+    protected
+
+    def validate!
+      validate_file!
+      validate_generator!
+      validate_generator_port!
+      validate_generator_timeout!
+      validate_domain!
+      validate_dump_dir!
+      validate_targets!
+    end
+
+    def validate_file!
+      unless @yaml_file.is_a? String
+        raise InvalidConfigurationError.new('Not a valid config filename')
+      end
+      unless File.exist? @yaml_file
+        raise InvalidConfigurationError.new('File not found: %s' % @yaml_file)
+      end
+      @configuration = YAML::load_file(@yaml_file)
+      unless @configuration.is_a? Hash
+        raise InvalidConfigurationError.new('Incorrect yaml-syntax')
+      end
+      @configuration = @configuration['configuration']
+    end
+
+    def validate_generator_timeout!
+      unless @configuration.keys.include? 'generator_timeout'
+        raise InvalidConfigurationError.new('Missing generator timeout in config')
+      end
+      unless @configuration['generator_timeout'].is_a? Fixnum
+        raise InvalidConfigurationError.new('Please specify a generator timeout')
+      end
+      @generator_timeout = @configuration['generator_timeout']
+    end
+
+    def validate_generator_port!
+      unless @configuration.keys.include? 'generator_port'
+        raise InvalidConfigurationError.new('Missing generator port in config')
+      end
+      unless @configuration['generator_port'].is_a? Fixnum
+        raise InvalidConfigurationError.new('Please specify a generator port')
+      end
+      @generator_port = @configuration['generator_port']
+    end
+
+    def validate_generator!
+      unless @configuration.keys.include? 'generator'
+        raise InvalidConfigurationError.new('Missing generator in config')
+      end
+      if @configuration['generator'].nil? || @configuration['generator'] == ''
+        raise InvalidConfigurationError.new('Please specify a generator')
+      end
+      unless @configuration['generator'].is_a? String
+        raise InvalidConfigurationError.new('Generator is not a string')
+      end
+      if @configuration['generator'] =~ /^http/
+        raise InvalidConfigurationError.new('Do not prefix generator with http')
+      end
+      if @configuration['generator'] =~ /:\d+$/
+        raise InvalidConfigurationError.new('Do not sufix generator with port!')
+      end
+      @generator = @configuration['generator']
+    end
+
+    def validate_domain!
+      unless @configuration.keys.include? 'domain'
+        raise InvalidConfigurationError.new('Missing domain in config')
+      end
+      if @configuration['domain'].nil? || @configuration['domain'] == ''
+        raise InvalidConfigurationError.new('Please specify a domain')
+      end
+      @domain = @configuration['domain']
+    end
+
+    def validate_targets!
+      unless @configuration.keys.include? 'targets'
+        raise InvalidConfigurationError.new('Missing targets in config')
+      end
+      if !@configuration['targets'].is_a?(Array) || @configuration['targets'].size == 0
+        raise InvalidConfigurationError.new('Please specify some targets')
+      end
+      @targets = @configuration['targets']
+    end
+
+    def validate_dump_dir!
+      unless @configuration.keys.include? 'dump_dir'
+        raise InvalidConfigurationError.new('Missing dump_dir in config')
+      end
+      if @configuration['dump_dir'].nil? || @configuration['dump_dir'] == ''
+        raise InvalidConfigurationError.new('Please specify a dump_dir')
+      end
+      @dump_dir = @configuration['dump_dir']
+    end
+
+  end
+
+end

data/lib/generator.rb

@@ -0,0 +1,136 @@
+module Sitemaps
+
+  class Generator
+
+    attr_reader :configuration
+
+    def initialize(configuration_object)
+      self.configuration = configuration_object
+    end
+
+    def prepare
+      Dir.mkdir configuration.dump_dir
+    end
+
+    def configuration=(object)
+      unless object.is_a? Configuration
+        raise InvalidConfigurationError.new('Not a sitemap configuration object!')
+      end
+      @configuration = object
+    end
+
+    def execute!
+      download!
+      compress!
+      compile!
+    end
+
+    protected
+
+    def compile!
+      compile_index
+      compile_robots
+    end
+
+    def compile_index
+      output = File.new(sitemaps_index_filename, 'w+')
+      xml = Builder::XmlMarkup.new(:target => output, :indent => 2)
+      xml.instruct! :version => '1.0', :encoding => 'UTF-8'
+      xml.sitemapindex :xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9' do
+        downloaded_maps.each do |map|
+          xml.sitemap do
+            xml.loc get_gzip_url(map)
+            xml.lastmod Time.now.strftime('%Y-%m-%d')
+          end
+        end
+      end
+      output.close
+      compress_file(sitemaps_index_filename, sitemaps_gziped_index_filename)
+    end
+
+    def compile_robots
+      File.open(robots_filename, 'w+') do |rostob|
+        rostob.puts 'Sitemap: %s/%s' % [@configuration.domain, sitemaps_gziped_index_filename]
+      end
+    end
+
+    def robots_filename
+      File.join(@configuration.dump_dir, 'robots.txt')
+    end
+
+    def sitemaps_index_filename
+      File.join(@configuration.dump_dir, 'index.xml')
+    end
+
+    def sitemaps_gziped_index_filename
+      File.join(@configuration.dump_dir, 'index.xml' + '.gz')
+    end
+
+    def download!
+      ensure_dump_dir
+      Net::HTTP.start(@configuration.generator, @configuration.generator_port) do |http|
+        http.read_timeout = @configuration.generator_timeout
+        @configuration.targets.each do |target|
+          store_downloaded_data target, http.get(target).body
+        end
+      end
+    end
+
+    def compress!
+      ensure_compress_dir
+      downloaded_maps.each { |map| compress_file(map, get_gzip_filename(map)) }
+    end
+
+    def compress_file(source, target)
+      Zlib::GzipWriter.open(target) { |gz| gz.write File.read(source) }
+    end
+
+    def downloaded_maps
+      Dir.glob(download_path + '/*')
+    end
+
+    def get_gzip_filename(long_path)
+      File.join(compress_path, File.basename(long_path) + '.gz')
+    end
+
+    def get_gzip_url(long_path)
+      [
+        @configuration.domain,
+        @configuration.dump_dir,
+        File.basename(long_path) + '.gz'
+      ].join('/')
+    end
+
+    def ensure_dump_dir
+      [@configuration.dump_dir, download_path].each do |path|
+        Dir.mkdir path unless File.exist? path
+      end
+    end
+
+    def ensure_compress_dir
+      unless File.exist? compress_path
+        Dir.mkdir compress_path
+      end
+    end
+
+    def store_downloaded_data(target, data)
+      File.open(download_target_for(target), 'w+') do |file|
+        file.write data
+      end
+    end
+
+    def compress_path
+      @compress_path ||= File.join(@configuration.dump_dir, @configuration.dump_dir)
+    end
+
+    def download_target_for(target)
+      File.join(download_path, File.basename(target))
+    end
+
+    def download_path
+      File.join(@configuration.dump_dir, 'downloads')
+    end
+
+  end
+
+end

data/lib/invalid_configuration_error.rb

@@ -0,0 +1,6 @@
+module Sitemaps
+
+  class InvalidConfigurationError < Exception
+  end
+
+end

data/lib/sitemaps.rb

@@ -0,0 +1,12 @@
+
+# external libraries
+require 'net/http'
+require 'yaml'
+require 'zlib'
+require 'builder'
+
+# internal libraries
+require 'configuration'
+require 'invalid_configuration_error'
+require 'generator'
+

data/sitemaps.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sitemaps}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kazuyoshi tlacaelel"]
+  s.date = %q{2009-09-15}
+  s.default_executable = %q{sitemaps}
+  s.description = %q{
+    Sitemaps provides an executable that will take a configuration yaml file.
+    When runned it will download and gzip-compress your sitemaps ready for production!
+    }
+  s.email = %q{kazu.dev@gmail.com}
+  s.executables = ["sitemaps"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/sitemaps",
+     "lib/configuration.rb",
+     "lib/generator.rb",
+     "lib/invalid_configuration_error.rb",
+     "lib/sitemaps.rb",
+     "sitemaps.gemspec",
+     "test/configuration_test.rb",
+     "test/data/empty_configuration_file.yml",
+     "test/data/generator_with_http_configuration_file.yml",
+     "test/data/generator_with_port_configuration_file.yml",
+     "test/data/invalid_configuration_file.yml",
+     "test/data/no_domain_configuration_file.yml",
+     "test/data/no_dump_dir_configuration_file.yml",
+     "test/data/no_generator_configuration_file.yml",
+     "test/data/no_port_configuration_file.yml",
+     "test/data/no_targets_configuration_file.yml",
+     "test/data/no_timeout_configuration_file.yml",
+     "test/data/valid_configuration_file.yml",
+     "test/data/valid_configuration_file2.yml",
+     "test/generator_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ktlacaelel/sitemaps}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Setup a config yaml file. I will download & compress your sitemaps!}
+  s.test_files = [
+    "test/configuration_test.rb",
+     "test/generator_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,108 @@
+require 'test_helper'
+
+class ConfigurationTest < Test::Unit::TestCase
+
+  def setup
+    @empty        = 'test/data/empty_configuration_file.yml'
+    @invalid      = 'test/data/invalid_configuration_file.yml'
+    @no_domain    = 'test/data/no_domain_configuration_file.yml'
+    @no_dump_dir  = 'test/data/no_dump_dir_configuration_file.yml'
+    @no_generator = 'test/data/no_generator_configuration_file.yml'
+    @no_port      = 'test/data/no_port_configuration_file.yml'
+    @no_targets   = 'test/data/no_targets_configuration_file.yml'
+    @no_timeout   = 'test/data/no_timeout_configuration_file.yml'
+    @gen_n_port   = 'test/data/generator_with_port_configuration_file.yml'
+    @gen_n_http   = 'test/data/generator_with_http_configuration_file.yml'
+    @valid        = 'test/data/valid_configuration_file.yml'
+  end
+
+  # ============================================================================
+  # YAML LOADING
+  # ============================================================================
+
+  should 'check if configuration file exists' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new('a') }
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(nil) }
+  end
+
+  should 'load a configuration file' do
+    Sitemaps::Configuration.new(@valid)
+  end
+
+  # ============================================================================
+  # MISSING PARAMETERS
+  # ============================================================================
+
+  should 'raise an error when generator is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_generator) }
+  end
+
+  should 'raise an error when generator port is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_port) }
+  end
+
+  should 'raise an error when generator timeout is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_timeout) }
+  end
+
+  should 'raise an error when domain is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_domain) }
+  end
+
+  should 'raise an error when targets is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_targets) }
+  end
+
+  should 'raise an error when dump_dir is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_dump_dir) }
+  end
+
+  # ============================================================================
+  # INVALID FORMAT
+  # ============================================================================
+
+  should 'raise an error when generator given has port' do
+    assert_raise(Sitemaps::InvalidConfigurationError) do
+      Sitemaps::Configuration.new(@gen_n_port)
+    end
+  end
+
+  should 'raise an error when generator given includes "http://" prefixed' do
+    assert_raise(Sitemaps::InvalidConfigurationError) do
+      Sitemaps::Configuration.new(@gen_n_http)
+    end
+  end
+
+  # ============================================================================
+  # CONFIGURATION ACCESS
+  # ============================================================================
+
+  def config
+    Sitemaps::Configuration.new(@valid)
+  end
+
+  should 'retrive generator' do
+    assert_equal 'localhost', config.generator
+  end
+
+  should 'retrive generator port' do
+    assert_equal 3000, config.generator_port
+  end
+
+  should 'retrive ttl' do
+    assert_equal 999, config.generator_timeout
+  end
+
+  should 'retrive domain' do
+    assert_equal 'http://example.com', config.domain
+  end
+
+  should 'retrive targets' do
+    assert_equal ['/sitemap_for/users.xml'], config.targets
+  end
+
+  should 'retrive dump_dir' do
+    assert_equal 'sitemaps', config.dump_dir
+  end
+
+end

data/test/data/generator_with_http_configuration_file.yml

@@ -0,0 +1,11 @@
+
+configuration:
+
+  generator: http://localhost
+  generator_port: 3000
+  generator_timeout: 999
+  domain: http://example.com
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/generator_with_port_configuration_file.yml

@@ -0,0 +1,11 @@
+
+configuration:
+
+  generator: localhost:3000
+  generator_port: 3000
+  generator_timeout: 999
+  domain: http://example.com
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/no_domain_configuration_file.yml

@@ -0,0 +1,9 @@
+
+configuration:
+  generator: localhost
+  generator_timeout: 999
+  generator_port: 3000
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/no_dump_dir_configuration_file.yml

@@ -0,0 +1,9 @@
+
+configuration:
+  generator: localhost
+  generator_timeout: 999
+  generator_port: 3000
+  domain: http://example.com
+  targets:
+    - /sitemap_for/users.xml
+

data/test/data/no_generator_configuration_file.yml

@@ -0,0 +1,9 @@
+
+configuration:
+  domain: http://example.com
+  generator_timeout: 999
+  generator_port: 3000
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/no_port_configuration_file.yml

@@ -0,0 +1,9 @@
+
+configuration:
+  generator: localhost
+  generator_port: 3000
+  domain: http://example.com
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/no_targets_configuration_file.yml

@@ -0,0 +1,8 @@
+
+configuration:
+  generator: localhost
+  generator_timeout: 999
+  generator_port: 3000
+  domain: http://example.com
+  dump_dir: sitemaps
+

data/test/data/no_timeout_configuration_file.yml

@@ -0,0 +1,8 @@
+
+configuration:
+  generator: localhost
+  generator_timeout: 999
+  domain: http://example.com
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps

data/test/data/valid_configuration_file.yml

@@ -0,0 +1,48 @@
+
+configuration:
+
+  # Machine that generates your sitemaps
+  # do not prefix "http://" nor append the port
+  generator: localhost
+
+  # The http-port of your generator
+  generator_port: 3000
+
+  # The time to wait for each sitemap to be received
+  generator_timeout: 999
+
+  # Domain from where the sitemaps will be available.
+  # It is important that you do not append the last slash
+  # otherwise you may get an error message
+  #
+  # NG
+  # http://example.com/
+  #
+  # OK
+  # http://example.com
+  #
+  domain: http://example.com
+
+  # Path to sitemaps to be compiled on "generator".
+  # For example: if you have the following url
+  #
+  #   http://localhost:3000/sitemap_for/users.xml
+  #
+  # The target must be specified as such
+  #
+  # Note: you can have multiple targets
+  #
+  targets:
+    - /sitemap_for/users.xml
+
+  # Directory where compressed maps will be placed.
+  #
+  # Its a good idea to use a sub-path in your domain.
+  #
+  # For example:
+  # (your dump_dir could be sitemaps for the following url)
+  #
+  #   http://example.com/sitemaps
+  #
+  dump_dir: sitemaps
+

data/test/data/valid_configuration_file2.yml

@@ -0,0 +1,19 @@
+
+configuration:
+
+  # machine that generates sitemaps in xml format
+  generator: xxxxxxxxx
+
+  generator_timeout: 999
+  generator_port: 3000
+
+  # domain from where the sitemaps will be available
+  domain: http://example.com
+
+  # path to sitemaps to be compiled
+  targets:
+    - /sitemap_for/users.xml
+
+  # directory where compressed maps will be placed
+  dump_dir: sitemaps
+

data/test/generator_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class GeneratorTest < Test::Unit::TestCase
+
+  def setup
+    @valid = 'test/data/valid_configuration_file.yml'
+    @valid2 = 'test/data/valid_configuration_file2.yml'
+    @config = Sitemaps::Configuration.new(@valid)
+  end
+
+  should 'check for a sitemap configuration on instantiantion' do
+    assert_raise (Sitemaps::InvalidConfigurationError) do
+      Sitemaps::Generator.new(nil)
+    end
+  end
+
+  should 'prepare dump_dir' do
+    `rm -rf sitemaps`
+    Sitemaps::Generator.new(@config).prepare
+    assert File.exist? 'sitemaps'
+  end
+
+  should 'get config' do
+    config  = Sitemaps::Generator.new(@config).configuration
+    assert_equal config.generator, 'localhost'
+  end
+
+  should 'change config' do
+    generator = Sitemaps::Generator.new(@config)
+    new_config = Sitemaps::Configuration.new(@valid2)
+    generator.configuration = new_config
+    assert_equal new_config, generator.configuration
+  end
+
+  should 'should download sitemaps'
+  should 'should gzip sitemaps'
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sitemaps'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: sitemaps
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- kazuyoshi tlacaelel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 +09:00
+default_executable: sitemaps
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+description: "\n    Sitemaps provides an executable that will take a configuration yaml file.\n    When runned it will download and gzip-compress your sitemaps ready for production!\n    "
+email: kazu.dev@gmail.com
+executables: 
+- sitemaps
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/sitemaps
+- lib/configuration.rb
+- lib/generator.rb
+- lib/invalid_configuration_error.rb
+- lib/sitemaps.rb
+- sitemaps.gemspec
+- test/configuration_test.rb
+- test/data/empty_configuration_file.yml
+- test/data/generator_with_http_configuration_file.yml
+- test/data/generator_with_port_configuration_file.yml
+- test/data/invalid_configuration_file.yml
+- test/data/no_domain_configuration_file.yml
+- test/data/no_dump_dir_configuration_file.yml
+- test/data/no_generator_configuration_file.yml
+- test/data/no_port_configuration_file.yml
+- test/data/no_targets_configuration_file.yml
+- test/data/no_timeout_configuration_file.yml
+- test/data/valid_configuration_file.yml
+- test/data/valid_configuration_file2.yml
+- test/generator_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ktlacaelel/sitemaps
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Setup a config yaml file. I will download & compress your sitemaps!
+test_files: 
+- test/configuration_test.rb
+- test/generator_test.rb
+- test/test_helper.rb