hast 0.2.2 → 0.3.0

data/CHANGELOG

@@ -0,0 +1,21 @@
+Master branch
+===============================================================================
+
+Added support for finding Postfix domains in a config file instead of a
+database.
+
+Note that the mysql gem therefore isn't a gem dependency anymore. So if you
+plan to use the Postfix database-method, you must manually install the mysql
+gem.
+
+
+Version 0.2.2 - 2010-02-16
+===============================================================================
+
+Added gem dependencies
+
+
+Version 0.2.1 - 2010-02-16
+===============================================================================
+
+First version released

data/README.rdoc

@@ -3,16 +3,17 @@
 HAST stands for 'Hosting Account Status Tool'.
 
 HAST is a tool for fetching domains from Apache configuration files and
-from the Postfix database on a hosting server environment. It will then
-run a report, checking the DNS records for each domain to see if they
-match your server.
+from Postfix on a hosting server environment. It will then run a
+report, checking the DNS records for each domain to see if they match
+your server.
 
 This is important for finding "dead" domains where the domain either
 doesn't exist anymore or where the owner have moved it to another
 hosting provider.
 
-Before you can use HAST, you need to setup a config.yml file. Use
-config.yml.example as a template.
+Before you can use HAST, you need to setup a config.yml file. Run 'hast
+--generate-config > config.yml' to create a sample config file that you
+can modify.
 
 == Note on Patches/Pull Requests
  
@@ -37,7 +38,7 @@ For help use: hast -h
   -v, --version             Display version
   -g, --generate-config     Output a config file template (pipe it to a
                             file for easy use: hast -g > config.yml)
-  -q, --no-dns              Do not lookup any domain names or MX records
+  -q, --disable-lookup      Do not lookup any domain names or MX records
   -y, --yaml                Output as YAML (usefull if you want to pipe:
                             bau.rb > domains.yml)
   -c, --domain-cache FILE   Get the domains from a YAML file

data/Rakefile

@@ -5,26 +5,25 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "hast"
-    gem.summary = %Q{Hosting Account Status Tool - Fetch domains from Apache configuration files and the Postfix database on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.}
+    gem.summary = %Q{Hosting Account Status Tool - Fetch domains from Apache configuration files and Postfix on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.}
     gem.description = <<-EOF
       HAST stands for 'Hosting Account Status Tool'.
 
       HAST is a tool for fetching domains from Apache configuration files and
-      from the Postfix database on a hosting server environment. It will then
-      run a report, checking the DNS records for each domain to see if they
-      match your server.
+      from Postfix on a hosting server environment. It will then run a report,
+      checking the DNS records for each domain to see if they match your server.
 
       This is important for finding "dead" domains where the domain either
       doesn't exist anymore or where the owner have moved it to another
       hosting provider.
 
-      Before you can use HAST, you need to setup a config.yml file. Use
-      config.yml.example as a template.
+      Before you can use HAST, you need to setup a config.yml file. Run 'hast
+      --generate-config > config.yml' to create a sample config file that you
+      can modify.
     EOF
     gem.email = "w@tson.dk"
     gem.homepage = "http://github.com/watson/hast"
     gem.authors = ["Thomas Watson Steen"]
-    gem.add_dependency "mysql", ">= 0"
     gem.add_dependency "net-dns", ">= 0.1"
     gem.add_dependency "deep_merge", ">= 0.1.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/{config.yml.example → config.yml.template}

@@ -44,6 +44,21 @@ postfix:
   #
   ip: '192.168.0.2'
 
+  # Specify the method used for finding Postfix domains. Can either be
+  # 'file' for using a virtual host file or 'database' for usin a MySQL
+  # database.
+  #
+  # Note that if using the database-method, you need the mysql gem. To
+  # install run 'gem install mysql'.
+  #
+  method: file
+
+  # The path for the Postfix vhost file
+  #
+  vhost_file: '/etc/postfix/vhosts.txt'
+
+  # Enable this group when using the Postfix method 'database'
+  #
   # HAST needs access to the Postfix MySQL database to figure out which
   # domains you are hosting mail for.
   #
@@ -51,8 +66,8 @@ postfix:
   # user and password and finally the name of the database used by
   # Postfix.
   #
-  mysql:
-    host: localhost
-    user: postfix
-    password: secret
-    database: postfix
+  #database:
+  #  host: localhost
+  #  user: postfix
+  #  password: secret
+  #  database: postfix

data/hast.gemspec

@@ -5,25 +5,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hast}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Watson Steen"]
-  s.date = %q{2010-02-17}
+  s.date = %q{2010-02-24}
   s.default_executable = %q{hast}
   s.description = %q{      HAST stands for 'Hosting Account Status Tool'.
 
       HAST is a tool for fetching domains from Apache configuration files and
-      from the Postfix database on a hosting server environment. It will then
-      run a report, checking the DNS records for each domain to see if they
-      match your server.
+      from Postfix on a hosting server environment. It will then run a report,
+      checking the DNS records for each domain to see if they match your server.
 
       This is important for finding "dead" domains where the domain either
       doesn't exist anymore or where the owner have moved it to another
       hosting provider.
 
-      Before you can use HAST, you need to setup a config.yml file. Use
-      config.yml.example as a template.
+      Before you can use HAST, you need to setup a config.yml file. Run 'hast
+      --generate-config > config.yml' to create a sample config file that you
+      can modify.
 }
   s.email = %q{w@tson.dk}
   s.executables = ["hast"]
@@ -34,12 +34,13 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "bin/hast",
-     "config.yml.example",
+     "config.yml.template",
      "hast.gemspec",
      "lib/hast.rb",
      "lib/hast/apache.rb",
@@ -49,24 +50,21 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/watson/hast}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Hosting Account Status Tool - Fetch domains from Apache configuration files and the Postfix database on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Hosting Account Status Tool - Fetch domains from Apache configuration files and Postfix on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.}
 
   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_runtime_dependency(%q<mysql>, [">= 0"])
       s.add_runtime_dependency(%q<net-dns>, [">= 0.1"])
       s.add_runtime_dependency(%q<deep_merge>, [">= 0.1.0"])
     else
-      s.add_dependency(%q<mysql>, [">= 0"])
       s.add_dependency(%q<net-dns>, [">= 0.1"])
       s.add_dependency(%q<deep_merge>, [">= 0.1.0"])
     end
   else
-    s.add_dependency(%q<mysql>, [">= 0"])
     s.add_dependency(%q<net-dns>, [">= 0.1"])
     s.add_dependency(%q<deep_merge>, [">= 0.1.0"])
   end

data/lib/hast/postfix.rb

@@ -1,5 +1,3 @@
-require 'mysql'
-
 module HAST
   class Postfix
     attr_reader :domains
@@ -8,10 +6,33 @@ module HAST
       @config = config
       @domains = []
 
-      dbh = Mysql.real_connect(@config['postfix']['mysql']['host'],
-                               @config['postfix']['mysql']['user'],
-                               @config['postfix']['mysql']['password'],
-                               @config['postfix']['mysql']['database'])
+      case @config['postfix']['method']
+      when 'file'
+        vhost_file
+      when 'database'
+        mysql
+      when nil
+        raise "ERROR: Postfix method not specified!"
+      else
+        raise "ERROR: Unknown Postfix method '#{@config['postfix']['method']}'"
+      end
+    end
+
+    private
+
+    def vhost_file
+      File.open(@config['postfix']['vhost_file']) do |f|
+        @domains = f.readlines.compact.map{ |line| line.chomp }.reject{ |line| line.empty? }
+      end
+    end
+
+    def mysql
+      require 'mysql'
+
+      dbh = Mysql.real_connect(@config['postfix']['database']['host'],
+                               @config['postfix']['database']['user'],
+                               @config['postfix']['database']['password'],
+                               @config['postfix']['database']['database'])
 
       results = dbh.query('SELECT domain FROM domain')
       results.each do |row|

data/lib/hast.rb

@@ -41,7 +41,7 @@ class Hast
   end
 
   def output_config_template
-    File.open(File.dirname(__FILE__) + '/../config.yml.example') { |f| puts f.readlines }
+    File.open(File.dirname(__FILE__) + '/../config.yml.template') { |f| puts f.readlines }
   end
 
   def load_config
@@ -69,7 +69,7 @@ class Hast
       opts.on('-g', '--generate-config',
               'Output a config file template',
               '(pipe it to a file for easy use: hast -g > config.yml)') { output_config_template; exit 0 }
-      opts.on('-q', '--no-dns',
+      opts.on('-q', '--disable-lookup',
               'Do not lookup any domain names or MX records')           { @config['dns'] = { 'disable' => true } }
       opts.on('-y', '--yaml',
               'Output as YAML',

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: hast
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Thomas Watson Steen
@@ -9,40 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-17 00:00:00 +01:00
+date: 2010-02-24 00:00:00 +01:00
 default_executable: hast
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: mysql
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: net-dns
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
         version: "0.1"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: deep_merge
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
         version: 0.1.0
-    version: 
-description: "      HAST stands for 'Hosting Account Status Tool'.\n\n      HAST is a tool for fetching domains from Apache configuration files and\n      from the Postfix database on a hosting server environment. It will then\n      run a report, checking the DNS records for each domain to see if they\n      match your server.\n\n      This is important for finding \"dead\" domains where the domain either\n      doesn't exist anymore or where the owner have moved it to another\n      hosting provider.\n\n      Before you can use HAST, you need to setup a config.yml file. Use\n      config.yml.example as a template.\n"
+  type: :runtime
+  version_requirements: *id002
+description: "      HAST stands for 'Hosting Account Status Tool'.\n\n      HAST is a tool for fetching domains from Apache configuration files and\n      from Postfix on a hosting server environment. It will then run a report,\n      checking the DNS records for each domain to see if they match your server.\n\n      This is important for finding \"dead\" domains where the domain either\n      doesn't exist anymore or where the owner have moved it to another\n      hosting provider.\n\n      Before you can use HAST, you need to setup a config.yml file. Run 'hast\n      --generate-config > config.yml' to create a sample config file that you\n      can modify.\n"
 email: w@tson.dk
 executables: 
 - hast
@@ -54,12 +56,13 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - bin/hast
-- config.yml.example
+- config.yml.template
 - hast.gemspec
 - lib/hast.rb
 - lib/hast/apache.rb
@@ -78,20 +81,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Hosting Account Status Tool - Fetch domains from Apache configuration files and the Postfix database on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.
+summary: Hosting Account Status Tool - Fetch domains from Apache configuration files and Postfix on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.
 test_files: []