ktlacaelel-sitemaps 0.5.0 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/configuration.rb

@@ -2,7 +2,7 @@ module Sitemaps
 
   class Configuration
 
-    attr_reader :generator, :domain, :targets, :dump_dir
+    attr_reader :generator, :domain, :targets, :dump_dir, :generator_port, :generator_timeout
 
     def initialize(yaml_file)
       @yaml_file = yaml_file
@@ -14,6 +14,8 @@ module Sitemaps
     def validate!
       validate_file!
       validate_generator!
+      validate_generator_port!
+      validate_generator_timeout!
       validate_domain!
       validate_dump_dir!
       validate_targets!
@@ -33,6 +35,26 @@ module Sitemaps
       @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')
@@ -40,6 +62,15 @@ module Sitemaps
       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
 

data/lib/generator.rb

@@ -68,8 +68,8 @@ module Sitemaps
 
     def download!
       ensure_dump_dir
-      Net::HTTP.start(@configuration.generator, '3000') do |http|
-        http.read_timeout = 999
+      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

data/sitemaps.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sitemaps}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kazuyoshi tlacaelel"]
@@ -36,11 +36,15 @@ Gem::Specification.new do |s|
      "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",

data/test/configuration_test.rb

@@ -3,13 +3,17 @@ 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'
+    @empty        = 'test/data/empty_configuration_file.yml'
+    @invalid      = 'test/data/invalid_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'
+    @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
 
   # ============================================================================
@@ -17,8 +21,8 @@ class ConfigurationTest < Test::Unit::TestCase
   # ============================================================================
 
   should 'check if configuration file exists' do
-    assert_raise (Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new('a') }
-    assert_raise (Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(nil) }
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new('a') }
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(nil) }
   end
 
   should 'load a configuration file' do
@@ -29,20 +33,44 @@ class ConfigurationTest < Test::Unit::TestCase
   # MISSING PARAMETERS
   # ============================================================================
 
-  should 'throw an error when generator is not given' do
-    assert_raise (Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_generator) }
+  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 'throw an error when domain is not given' do
-    assert_raise (Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_domain) }
+  should 'raise an error when domain is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_domain) }
   end
 
-  should 'throw an error when targets is not given' do
-    assert_raise (Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_targets) }
+  should 'raise an error when targets is not given' do
+    assert_raise(Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_targets) }
   end
 
-  should 'throw an error when dump_dir is not given' do
-    assert_raise (Sitemaps::InvalidConfigurationError) { Sitemaps::Configuration.new(@no_dump_dir) }
+  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
 
   # ============================================================================
@@ -54,7 +82,15 @@ class ConfigurationTest < Test::Unit::TestCase
   end
 
   should 'retrive generator' do
-    assert_equal 'http://localhost:3000', config.generator
+    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

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

@@ -1,6 +1,8 @@
 
 configuration:
-  generator: http://localhost:3000
+  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

@@ -1,6 +1,8 @@
 
 configuration:
-  generator: http://localhost:3000
+  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

@@ -1,6 +1,8 @@
 
 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

@@ -1,6 +1,8 @@
 
 configuration:
-  generator: http://localhost:3000
+  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

@@ -1,16 +1,48 @@
 
 configuration:
 
-  # machine that generates sitemaps in xml format
-  generator: http://localhost:3000
+  # Machine that generates your sitemaps
+  # do not prefix "http://" nor append the port
+  generator: localhost
 
-  # domain from where the sitemaps will be available
+  # 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
+  # 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
+  # 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

@@ -2,7 +2,10 @@
 configuration:
 
   # machine that generates sitemaps in xml format
-  generator: http://xxxxxxxxx
+  generator: xxxxxxxxx
+
+  generator_timeout: 999
+  generator_port: 3000
 
   # domain from where the sitemaps will be available
   domain: http://example.com

data/test/generator_test.rb

@@ -22,7 +22,7 @@ class GeneratorTest < Test::Unit::TestCase
 
   should 'get config' do
     config  = Sitemaps::Generator.new(@config).configuration
-    assert_equal config.generator, 'http://localhost:3000'
+    assert_equal config.generator, 'localhost'
   end
 
   should 'change config' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ktlacaelel-sitemaps
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - kazuyoshi tlacaelel
@@ -56,18 +56,21 @@ files:
 - 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: false
 homepage: http://github.com/ktlacaelel/sitemaps
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -88,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Setup a config yaml file. I will download & compress your sitemaps!