Narnach-md5_wrapper 0.3.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Wes Oldenbeuving
+
+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,31 @@
+= Md5Wrapper
+
+Md5Wrapper wraps the command line utilities md5sum (Linux) and md5 (Mac).
+Detecting which utility should be used is based on the RUBY_PLATFORM constant.
+It allows obtaining the md5 hexdigest of a file and checking that a file has a specific md5 hexdigest.
+It does not aim to provide all features offered by the md5(sum) utilities, but anyone who needs more features is welcome to add them.
+
+Md5Wrapper can be used as RubyGem or as Rails plugin.
+
+== Installation as Rails plugin
+
+From the Rails project root, execute:
+  script/plugin install git://github.com/Narnach/md5_wrapper.git
+
+== Installation as gem
+
+Install the gem by executing:
+  sudo gem install Narnach-md5_wrapper --remote --source http://gems.github.com
+
+== Example
+
+Get the md5 hexdigest for a file.
+  Md5Wrapper.get_md5sum('foo.txt') #=> 'abcdabcdabcdabcdabcdabcdabcdabcd'
+
+Check the correct md5 hexdigest against a file.
+  Md5Wrapper.check_md5sum('foo.txt', 'abcdabcdabcdabcdabcdabcdabcdabcd') #=> true
+  
+Check an incorrect md5 hexdigest against a file.
+  Md5Wrapper.check_md5sum('foo.txt', 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa') #=> false
+
+Copyright (c) 2008 Wes Oldenbeuving, released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require "rake/gempackagetask"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the md5_wrapper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the md5_wrapper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Md5Wrapper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  # Parse gemspec using the github safety level.
+  data = File.read('md5_wrapper.gemspec')
+  spec = nil
+  Thread.new { spec = eval("$SAFE = 3\n%s" % data)}.join
+
+  # Create the gem tasks
+  Rake::GemPackageTask.new(spec) do |package|
+    package.gem_spec = spec
+  end
+rescue Exception => e
+  printf "WARNING: Error caught (%s): %s\n", e.class.name, e.message
+end
+
+desc 'Package and install the gem for the current version'
+task :install => :gem do
+  system "sudo gem install -l pkg/md5_wrapper-%s.gem" % spec.version
+end

data/init.rb

@@ -0,0 +1 @@
+require 'md5_wrapper'

data/lib/md5_wrapper.rb

@@ -0,0 +1,28 @@
+# Wraps the command line utilities md5sum (Linux) and md5 (Mac).
+class Md5Wrapper
+  class << self
+    # Validate that the file has this md5 hexdigest.
+    def check_md5sum(filename, md5sum)
+      raise ArgumentError, "Invalid md5sum" unless md5sum.size == 32
+      raise ArgumentError, "Invalid file" unless File.exist? filename and File.file? filename and File.readable? filename
+      
+      if RUBY_PLATFORM =~ /darwin/
+        md5 = `md5 #{filename} 2>&1`.strip[-32,32]
+        return md5 == md5sum
+      else # linux
+        cmd = "echo \"#{md5sum} *#{filename}\" | md5sum -c --status 2>&1"
+        return system(cmd)
+      end
+    end
+    
+    # Extract the md5 hexdigest from a file.
+    def get_md5sum(filename)
+      raise ArgumentError, "Invalid file" unless File.exist? filename and File.file? filename and File.readable? filename
+      if RUBY_PLATFORM =~ /darwin/
+        return `md5 #{filename} 2>&1`.strip[-32,32]
+      else # linux
+        return `md5sum -b #{filename} 2>&1`[0,32]
+      end
+    end
+  end
+end

data/md5_wrapper.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  # Project
+  s.name         = 'md5_wrapper'
+  s.summary      = "Md5Wrapper wraps the command line utilities md5sum (Linux) and md5 (Mac)."
+  s.description  = "It allows obtaining the md5 hexdigest of a file and checking that a file has a specific md5 hexdigest."
+  s.version      = '0.3.0'
+  s.date         = '2008-08-05'
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Wes Oldenbeuving"]
+  s.email        = "narnach@gmail.com"
+  s.homepage     = "http://www.github.com/Narnach/md5_wrapper"
+  
+  # Files
+  s.require_path = "lib"
+  s.files        = ['md5_wrapper.gemspec', 'MIT-LICENSE', 'README.rdoc', 'Rakefile', 'init.rb', 'lib/md5_wrapper.rb', 'test/md5_wrapper_test.rb', 'test/fixtures/test.txt']
+  s.test_files   = ['test/md5_wrapper_test.rb']
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README.rdoc MIT-LICENSE]
+  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'README.rdoc'
+
+  # Requirements
+  s.required_ruby_version = ">= 1.8.0"
+end

data/test/fixtures/test.txt

@@ -0,0 +1 @@
+test

data/test/md5_wrapper_test.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'md5_wrapper'
+
+class Md5WrapperTest < Test::Unit::TestCase
+  def setup
+    @fixture = File.expand_path(File.join(File.dirname(__FILE__),'fixtures','test.txt'))
+    @md5sum = 'd8e8fca2dc0f896fd7cb4cb0031ba249'
+  end
+  
+  def test_get_md5sum
+    assert_equal @md5sum, Md5Wrapper.get_md5sum(@fixture)
+  end
+  
+  def test_check_md5sum
+    assert Md5Wrapper.check_md5sum(@fixture, @md5sum)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: Narnach-md5_wrapper
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Wes Oldenbeuving
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: It allows obtaining the md5 hexdigest of a file and checking that a file has a specific md5 hexdigest.
+email: narnach@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- md5_wrapper.gemspec
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/md5_wrapper.rb
+- test/md5_wrapper_test.rb
+- test/fixtures/test.txt
+has_rdoc: true
+homepage: http://www.github.com/Narnach/md5_wrapper
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.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: 2
+summary: Md5Wrapper wraps the command line utilities md5sum (Linux) and md5 (Mac).
+test_files: 
+- test/md5_wrapper_test.rb