safeguard 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+.safeguard/

data/LICENSE.GPLv3

@@ -0,0 +1,14 @@
+Copyright © 2011 Matheus Afonso Martins Moreira
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/bin/safeguard

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 require 'safeguard'
 
-puts 'No files specified' or exit if ARGV.empty?
+puts 'No command given' or exit if ARGV.empty?
 
-ARGV.each do |filename|
-  puts "#{Safeguard.file filename} => #{filename}"
-end
+command = ARGV.shift
+Safeguard.run(command, *ARGV)

data/lib/safeguard/command/add.rb

@@ -0,0 +1,32 @@
+require 'safeguard/command'
+
+module Safeguard
+  module Command
+
+    # Adds files to a Repository.
+    module Add
+
+      Command.register self
+
+      # For every argument, try to add it to the Repository in the current
+      # directory.
+      def self.execute(*args)
+        repo = Repository.new Dir.pwd
+        count = 0
+        args.each do |filename|
+          begin
+            puts "Adding #{filename}..."
+            repo.track filename
+            # If an exception is raised, count will not be incremented.
+            count += 1
+          rescue => e
+            puts e.message
+          end
+        end
+        puts "Added #{count} files to repository."
+      end
+
+    end
+
+  end
+end

data/lib/safeguard/command/hash.rb

@@ -0,0 +1,22 @@
+require 'safeguard/command'
+require 'safeguard/digest'
+
+module Safeguard
+  module Command
+
+    # Outputs the SHA1 hash of files.
+    module Hash
+
+      Command.register self
+
+      # For every argument, outputs its SHA1 sum if it exists as a file.
+      def self.execute(*args)
+        args.each do |filename|
+          puts "#{Digest.file filename} => #{filename}" if File.file? filename
+        end
+      end
+
+    end
+
+  end
+end

data/lib/safeguard/command/init.rb

@@ -0,0 +1,26 @@
+require 'safeguard/command'
+require 'safeguard/repository'
+require 'fileutils'
+
+module Safeguard
+  module Command
+
+    # Initializes a Repository in a given directory.
+    module Init
+
+      Command.register self
+
+      # Initializes a Safeguard Repository in a directory, which is either the
+      # current directory, if +args+ is empty, or the directory designated by
+      # the last element in +args+.
+      def self.execute(*args)
+        args << Dir.pwd if args.empty?
+        dir = File.expand_path args.pop
+        repo = Repository.new(dir)
+        puts "Initialized safeguard repository in #{repo.dir}"
+      end
+
+    end
+
+  end
+end

data/lib/safeguard/command/verify.rb

@@ -0,0 +1,34 @@
+require 'safeguard/command'
+
+module Safeguard
+  module Command
+
+    # Verifies the files present in a Repository.
+    module Verify
+
+      Command.register self
+
+      # Verify the files passed as arguments using information from the
+      # Repository in the current directory.
+      def self.execute(*args)
+        repo = Repository.new Dir.pwd
+        if args.empty?
+          repo.verify_all do |filename, result|
+            display_result filename, result
+          end
+        else
+          args.each do |filename|
+            result = repo.verify filename
+            display_result filename, result
+          end
+        end
+      end
+
+      def self.display_result(filename, result)
+        puts "#{filename} => #{result ? 'OK' : 'Mismatch'}"
+      end
+
+    end
+
+  end
+end

data/lib/safeguard/command.rb

@@ -0,0 +1,45 @@
+module Safeguard
+
+  # Manages the commands that may be given to Safeguard.
+  module Command
+
+    instance_eval do
+
+      # Returns a hash that associates command modules by name.
+      def commands
+        @commands ||= {}
+      end
+
+      alias :all :commands
+
+      # Computes a name for the command and associates it with the command's
+      # module.
+      def register(command_module)
+        name = command_module.name.gsub(/^.*::/, '').downcase
+        commands[name] = command_module
+      end
+
+      # Looks up a command by name and returns its module, raising an exception
+      # if there is no match.
+      def find(command_name)
+        name = command_name.to_s.strip.downcase
+        commands[name].tap do |command|
+          raise "unsupported command: #{name}" if command.nil?
+        end
+      end
+
+      # Attempts to find a command by name, and, if successful, invokes it with
+      # the given arguments.
+      def invoke(command_name, *args)
+        find(command_name).execute(*args)
+      end
+
+    end
+
+  end
+end
+
+require 'safeguard/command/add'
+require 'safeguard/command/hash'
+require 'safeguard/command/init'
+require 'safeguard/command/verify'

data/lib/safeguard/digest.rb

@@ -1,10 +1,13 @@
 require 'openssl'
 
 module Safeguard
+
+  # Encapsulates checksum computation for files using a set of hash functions.
   module Digest
 
+    # Compute the SHA1 sum of a file.
     def self.file(filename)
-      OpenSSL::Digest::SHA1.file filename
+      OpenSSL::Digest::SHA1.file(filename).hexdigest
     end
 
   end

data/lib/safeguard/hash_table.rb

@@ -0,0 +1,71 @@
+require 'safeguard/digest'
+require 'yaml'
+
+module Safeguard
+
+  # Holds filename => checksum pairs.
+  class HashTable
+
+    # Initializes an empty HashTable.
+    def initialize
+      @table = {}
+    end
+
+    # Saves the HashTable to a YAML file.
+    def save(filename)
+      File.open("#{filename}.yaml", 'w') do |file|
+        file.puts to_yaml
+      end
+    end
+
+    # Loads the HashTable from a YAML file.
+    def self.load(filename)
+      YAML::load_file "#{filename}.yaml"
+    end
+
+    # Associates the given +filename+ to the computed checksum of the file it
+    # refers to.
+    def <<(filename)
+      @table[filename] = Digest.file filename
+    end
+
+    alias :add :<<
+
+    # Looks up the checksum for the given +filename+.
+    def [](filename)
+      @table[filename]
+    end
+
+    # Recalculates the hash and compares it to the original hash associated with
+    # the given filename.
+    #
+    # If a hash for the given file isn't stored in this table, an exception will
+    # be raised.
+    def verify(filename)
+      hash = @table[filename]
+      raise "File not in repository: #{filename}" unless hash
+      Digest.file(filename) == hash
+    end
+
+    # Verifies all files stored in this table and returns a hash of results
+    # associating a filename with either +true+, when the file's recalculated
+    # hash is equal to the hash stored in this table, or +false+, when
+    # otherwise.
+    #
+    # If a block is given, the filename and the result will be yielded instead.
+    def verify_all
+      files = @table.keys
+      if block_given?
+        files.each { |file| yield file, verify(file) }
+      else
+        {}.tap do |results|
+          files.each do |file|
+            results[file] = verify file
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/safeguard/repository.rb

@@ -0,0 +1,73 @@
+require 'safeguard/hash_table'
+
+module Safeguard
+
+  # Directory which holds file-related data.
+  class Repository
+
+    # Name of the directory in which the Safeguard repository resides.
+    DIRECTORY_NAME = '.safeguard'.freeze
+
+    # Name of the file to which the HashTable is saved.
+    HASH_TABLE_FILE_NAME = 'hash_table'.freeze
+
+    attr_accessor :directory
+    alias :dir :directory
+
+    # Initializes a Safeguard repository in or from the given directory.
+    #
+    # If the given directory does not contain a repository directory, whose name
+    # is defined by the DIRECTORY_NAME constant, it will be created.
+    def initialize(dir)
+      self.directory = Repository.directory_in(dir)
+      FileUtils.mkdir_p directory
+    end
+
+    # Loads this repository's HashTable. Creates a new one if unable to do so.
+    def hash_table
+      HashTable.load hash_table_file_name rescue HashTable.new
+    end
+
+    # Returns the name of the HashTable file relative to this repository.
+    def hash_table_file_name
+      File.join directory, HASH_TABLE_FILE_NAME
+    end
+
+    # Adds a file to this repository's HashTable, and saves it.
+    def track(filename)
+      table = hash_table_file_name
+      file = File.expand_path filename
+      hash_table.instance_eval do
+        add file
+        save table
+      end
+    end
+
+    # Verifies whether or not the file still matches the original version.
+    #
+    # An exception will be raised if the given file isn't in the repository.
+    def verify(filename)
+      hash_table.verify File.expand_path(filename)
+    end
+
+    # Verifies all files present in this repository, and returns a hash of
+    # results associating a filename with either +true+, when the file is the
+    # same as the original version, or +false+, when otherwise.
+    #
+    # If a block is given, the filename and the result will be yielded instead.
+    def verify_all(&block)
+      hash_table.verify_all &block
+    end
+
+    # Returns the path to the repository relative to the given +dir+.
+    def self.directory_in(dir)
+      File.join File.expand_path(dir), DIRECTORY_NAME
+    end
+
+    # Checks whether or not a repository has been created in the given +dir+.
+    def self.initialized?(dir)
+      File.directory? directory_in(dir)
+    end
+
+  end
+end

data/lib/safeguard/version.rb

@@ -1,11 +1,30 @@
 module Safeguard
+
+  # Contains the current version of Safeguard.
   module Version
 
+    # Major version.
+    #
+    # Increments denote backward-incompatible changes and additions.
     MAJOR = 0
+
+    # Minor version.
+    #
+    # Increments denote backward-compatible changes and additions.
     MINOR = 0
-    PATCH = 1
+
+    # Patch version.
+    #
+    # Increments denote changes in implementation.
+    PATCH = 2
+
+    # Build version.
+    #
+    # Used for pre-release versions.
     BUILD = nil
 
+    # Complete version string, which is every individual version number joined
+    # by a dot ('.'), in descending order of prescedence.
     STRING = [ MAJOR, MINOR, PATCH, BUILD ].compact.join '.'
 
   end

data/lib/safeguard.rb

@@ -1,9 +1,11 @@
-require 'safeguard/digest'
+require 'safeguard/command'
 
+# Safeguard module.
 module Safeguard
 
-  def self.file(filename)
-    Digest.file filename
+  # Run a command by name with the given arguments.
+  def self.run(command, *args)
+    Command.invoke(command, *args)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safeguard
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000 Z
+date: 2011-12-15 00:00:00.000000000 Z
 dependencies: []
 description: Hash-based file integrity verification utility
 email: matheus.a.m.moreira@gmail.com
@@ -18,12 +18,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rvmrc
+- LICENSE.GPLv3
 - README.markdown
 - Rakefile
 - bin/safeguard
 - lib/safeguard.rb
+- lib/safeguard/command.rb
+- lib/safeguard/command/add.rb
+- lib/safeguard/command/hash.rb
+- lib/safeguard/command/init.rb
+- lib/safeguard/command/verify.rb
 - lib/safeguard/digest.rb
+- lib/safeguard/hash_table.rb
+- lib/safeguard/repository.rb
 - lib/safeguard/version.rb
 - safeguard.gemspec
 homepage: https://github.com/matheusmoreira/safeguard