ktlacaelel-sitemaps 0.2.0

data/.document

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

data/.gitignore

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

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,18 @@
+= sitemaps
+
+Description goes here.
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2009 kazuyoshi tlacaelel. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sitemaps"
+    gem.summary = %Q{SEO Sitemap Generator}
+    gem.description = %Q{Setup a config file & execute. I will download and compress your sitemaps!}
+    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
+  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.2.0

data/lib/cli.rb

@@ -0,0 +1,6 @@
+module Sitemaps
+
+  class Cli
+  end
+
+end

data/lib/configuration.rb

@@ -0,0 +1,78 @@
+module Sitemaps
+
+  class Configuration
+
+    attr_reader :generator, :domain, :targets, :dump_dir
+
+    def initialize(yaml_file)
+      @yaml_file = yaml_file
+      validate!
+    end
+
+    protected
+
+    def validate!
+      validate_file!
+      validate_generator!
+      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!
+      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
+      @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,6 @@
+module Sitemaps
+
+  class Generator
+  end
+
+end

data/lib/invalid_configuration_error.rb

@@ -0,0 +1,2 @@
+class InvalidConfigurationError < Exception
+end

data/lib/sitemaps.rb

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

data/sitemaps.gemspec

@@ -0,0 +1,68 @@
+# 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.2.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-10}
+  s.description = %q{Setup a config file & execute. I will download and compress your sitemaps!}
+  s.email = %q{kazu.dev@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/cli.rb",
+     "lib/configuration.rb",
+     "lib/generator.rb",
+     "lib/invalid_configuration_error.rb",
+     "lib/sitemaps.rb",
+     "sitemaps.gemspec",
+     "test/cli_test.rb",
+     "test/configuration_test.rb",
+     "test/data/empty_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_targets_configuration_file.yml",
+     "test/data/valid_configuration_file.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{SEO Sitemap Generator}
+  s.test_files = [
+    "test/cli_test.rb",
+     "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"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/cli_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class CliTest < Test::Unit::TestCase
+end

data/test/configuration_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class ConfigurationTest < Test::Unit::TestCase
+
+  def setup
+    @valid = 'test/data/valid_configuration_file.yml'
+    @invalid = 'test/data/invalid_configuration_file.yml'
+    @empty = 'test/data/empty_configuration_file.yml'
+    @no_generator = 'test/data/no_generator_configuration_file.yml'
+    @no_domain    = 'test/data/no_domain_configuration_file.yml'
+    @no_targets   = 'test/data/no_targets_configuration_file.yml'
+    @no_dump_dir  = 'test/data/no_dump_dir_configuration_file.yml'
+  end
+
+  # ============================================================================
+  # YAML LOADING
+  # ============================================================================
+
+  should 'check if configuration file exists' do
+    assert_raise (InvalidConfigurationError) { Sitemaps::Configuration.new('a') }
+    assert_raise (InvalidConfigurationError) { Sitemaps::Configuration.new(nil) }
+  end
+
+  should 'load a configuration file' do
+    Sitemaps::Configuration.new(@valid)
+  end
+
+  # ============================================================================
+  # MISSING PARAMETERS
+  # ============================================================================
+
+  should 'throw an error when generator is not given' do
+    assert_raise (InvalidConfigurationError) { Sitemaps::Configuration.new(@no_generator) }
+  end
+
+  should 'throw an error when domain is not given' do
+    assert_raise (InvalidConfigurationError) { Sitemaps::Configuration.new(@no_domain) }
+  end
+
+  should 'throw an error when targets is not given' do
+    assert_raise (InvalidConfigurationError) { Sitemaps::Configuration.new(@no_targets) }
+  end
+
+  should 'throw an error when dump_dir is not given' do
+    assert_raise (InvalidConfigurationError) { Sitemaps::Configuration.new(@no_dump_dir) }
+  end
+
+  # ============================================================================
+  # CONFIGURATION ACCESS
+  # ============================================================================
+
+  def config
+    Sitemaps::Configuration.new(@valid)
+  end
+
+  should 'retrive generator' do
+    assert_equal 'http://localhost:3000', config.generator
+  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/no_domain_configuration_file.yml

@@ -0,0 +1,7 @@
+
+configuration:
+  generator: http://localhost:3000
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/no_dump_dir_configuration_file.yml

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

data/test/data/no_generator_configuration_file.yml

@@ -0,0 +1,7 @@
+
+configuration:
+  domain: http://example.com
+  targets:
+    - /sitemap_for/users.xml
+  dump_dir: sitemaps
+

data/test/data/no_targets_configuration_file.yml

@@ -0,0 +1,6 @@
+
+configuration:
+  generator: http://localhost:3000
+  domain: http://example.com
+  dump_dir: sitemaps
+

data/test/data/valid_configuration_file.yml

@@ -0,0 +1,16 @@
+
+configuration:
+
+  # machine that generates sitemaps in xml format
+  generator: http://localhost: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,36 @@
+require 'test_helper'
+
+class GeneratorTest < Test::Unit::TestCase
+
+  def setup
+    @valid = 'test/data/valid_configuration_file.yml'
+    @config = Sitemaps::Configuration.new(@valid)
+  end
+
+  should 'check for a sitemap configuration on instantiantion' do
+    assert_raise (InvalidConfigurationError) do
+      Sitemaps::Generator.new(nil)
+    end
+  end
+
+  should 'prepare dump_dir' do
+    Sitemaps::Generator.new(@config).prepare
+    assert File.exist? 'sitemaps'
+  end
+
+  should 'get config' do
+    config  = Sitemaps::Generator.new(@config).configuration
+    assert_equal config.generator, 'http://localhost:3000'
+  end
+
+  should 'change config' do
+    generator = Sitemaps::Generator.new(@config)
+    @config.stub(:generator).returns('changed!')
+    generator.change_config @config
+    assert_equal generator.configuration.generator, 'changed!'
+  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,88 @@
+--- !ruby/object:Gem::Specification 
+name: ktlacaelel-sitemaps
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- kazuyoshi tlacaelel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-10 00:00:00 -07:00
+default_executable: 
+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: 
+description: Setup a config file & execute. I will download and compress your sitemaps!
+email: kazu.dev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/cli.rb
+- lib/configuration.rb
+- lib/generator.rb
+- lib/invalid_configuration_error.rb
+- lib/sitemaps.rb
+- sitemaps.gemspec
+- test/cli_test.rb
+- test/configuration_test.rb
+- test/data/empty_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_targets_configuration_file.yml
+- test/data/valid_configuration_file.yml
+- test/generator_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/ktlacaelel/sitemaps
+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.2.0
+signing_key: 
+specification_version: 3
+summary: SEO Sitemap Generator
+test_files: 
+- test/cli_test.rb
+- test/configuration_test.rb
+- test/generator_test.rb
+- test/test_helper.rb