module SiteMapper

Find all links on domain to domain

Constants

SiteMapper info link

USER_AGENT

SiteMapper User-Agent

VERSION

Gem version

Public Class Methods

map(link, options = {}) { |url| ... } click to toggle source

Map all links on a given site. @return [Array] with links. @param [String] link to domain @param [Hash] options hash @example Collect all URLs from example.com

SiteMapper.map('example.com')

@example Collect all URLs from example.com with custom User-agent

SiteMapper.map('example.com', user_agent: 'MyUserAgent')

@example Collect all URLs from example.com with custom logger class

class MyLogger
  def self.log(msg);     puts msg;end
  def self.err_log(msg); puts msg;end
end
SiteMapper.map('example.com', logger: MyLogger)
# File lib/site_mapper.rb, line 32
def self.map(link, options = {})
  set_logger(options.delete(:logger))
  options = { user_agent: USER_AGENT }.merge(options)
  Crawler.collect_urls(link, options) { |url| yield(url) if block_given? }
end
set_logger(logger) click to toggle source

Set logger. @param [Object] logger @example set system logger

SiteMapper.set_logger(:system)

@example set nil logger

SiteMapper.set_logger(:nil)

@example set your own logger

SiteMapper.set_logger(YourLogger)
# File lib/site_mapper.rb, line 46
def self.set_logger(logger)
  return if logger.nil?
  if logger.is_a?(Symbol)
    Logger.use_logger_type(logger)
  else
    Logger.use_logger(logger)
  end
end