mkdtemp 1.0

data/ext/extconf.rb

@@ -0,0 +1,17 @@
+# Copyright 2007 Wincent Colaiuta
+# 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/>.
+
+require 'mkmf'
+create_makefile('mkdtemp')
+

data/ext/mkdtemp.c

@@ -0,0 +1,54 @@
+/* 
+Copyright 2007-2008 Wincent Colaiuta
+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/>.
+*/
+
+#include <ruby.h>
+#include <errno.h>
+#include <unistd.h>
+
+/*
+
+call-seq:
+    Dir.mkdtemp([string])   -> String or nil
+
+This method securely creates temporary directories. It is a wrapper for the mkdtemp() function in the standard C library. It takes
+an optional String parameter as a template describing the desired form of the directory name and overwriting the template in-place;
+if no template is supplied then "/tmp/temp.XXXXXX" is used as a default.
+
+Note that the exact implementation of mkdtemp() may vary depending on the target system. For example, on Mac OS X at the time of
+writing, the man page states that the template may contain "some number" of "Xs" on the end of the string, whereas on Red Hat
+Enterprise Linux it states that the template suffix "must be XXXXXX".
+
+*/
+static VALUE dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
+{
+    VALUE template;
+    char *path;
+    if (rb_scan_args(argc, argv, "01", &template) == 0) /* check for 0 mandatory arguments, 1 optional argument */
+        template = Qnil;                                /* default to nil if no argument passed */
+    if (NIL_P(template))
+        template = rb_str_new2("/tmp/temp.XXXXXX");     /* fallback to this template if passed nil */
+    SafeStringValue(template);                          /* raises if template is tainted and SAFE level > 0 */
+    template = StringValue(template);                   /* duck typing support */
+    path = mkdtemp(RSTRING(template)->ptr);
+    if (path == NULL)
+        rb_raise(rb_eSystemCallError, "mkdtemp failed (error: %d)", errno);
+    return template;
+}
+
+void Init_mkdtemp()
+{
+    rb_define_module_function(rb_cDir, "mkdtemp", dir_mkdtemp_m, -1);
+}

data/lib/mkdtemp/version.rb

@@ -0,0 +1,19 @@
+# Copyright 2008 Wincent Colaiuta
+# 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/>.
+
+class Dir
+  module Mkdtemp
+    VERSION = '1.0'
+  end # module Mkdtemp
+end # class Dir

data/spec/mkdtemp_spec.rb

@@ -0,0 +1,78 @@
+# Copyright 2008 Wincent Colaiuta
+# 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/>.
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'Dir.mkdtemp' do
+  before do
+    if not File.exist? '/tmp'
+      pending "cannot run spec because '/tmp' does not exist"
+    elsif not File.directory? '/tmp'
+      pending "cannot run spec because '/tmp' is not a directory"
+    elsif not File.writable? '/tmp'
+      pending "cannot run spec because '/tmp' is not writeable"
+    end
+  end
+
+  it 'should return the modified template path' do
+    path = Dir.mkdtemp
+    path.should be_kind_of(String)
+    path.should_not == '/tmp/temp.XXXXXX'
+  end
+
+  it 'should create the directory corresponding to the template' do
+    path = Dir.mkdtemp
+    File.exist?(path).should == true
+    File.directory?(path).should == true
+  end
+
+  it 'should create the directory with write permissions' do
+    path = Dir.mkdtemp
+    File.writable?(path).should == true
+  end
+
+  it 'should create the directory with read permissions' do
+    path = Dir.mkdtemp
+    File.readable?(path).should == true
+  end
+
+  it 'should create the directory with secure ownership (same user as caller)' do
+    path = Dir.mkdtemp
+    File.owned?(path).should == true
+  end
+
+  it 'should complain if passed a template that includes non-existentent parent directories' do
+    non_existent_dir = '/temp-which-does-not-exist'
+    if File.exist? non_existent_dir
+      pending "cannot run because '#{non_existent_dir}' exists"
+    end
+    lambda { Dir.mkdtemp "/#{non_existent_dir}/temp.XXXXXX" }.should raise_error(SystemCallError)
+  end
+
+  it 'should use "/tmp/temp.XXXXXX" as a template if passed nil' do
+    path = Dir.mkdtemp
+    path.should match(%r{\A/tmp/temp\..{6}\z})
+    path.should_not == '/tmp/temp.XXXXXX'
+  end
+
+  it 'should use substitute random characters for the trailing "Xs" in the template' do
+    path = Dir.mkdtemp '/tmp/test.XXXXXX'
+    path.should_not == '/tmp/test.XXXXXX'
+  end
+
+  it 'should leave the prefix portion of the template unchanged' do
+    path = Dir.mkdtemp '/tmp/test.XXXXXX'
+    path.should match(%r{\A/tmp/test\..{6}\z})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# Copyright 2008 Wincent Colaiuta
+# 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/>.
+
+require 'pathname'
+require 'rubygems'
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'ext', 'mkdtemp')

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: mkdtemp
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Wincent Colaiuta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-18 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: mkdtemp is a C extension that wraps the Standard C Library function of the same name to make secure creation of temporary directories easily available from within Ruby.
+email: win@wincent.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- lib/mkdtemp
+- lib/mkdtemp/version.rb
+- spec/mkdtemp_spec.rb
+- spec/spec_helper.rb
+- ext/mkdtemp.c
+- ext/extconf.rb
+has_rdoc: true
+homepage: http://mkdtemp.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- ext
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: mkdtemp
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Secure creation of temporary directories
+test_files: []
+