win32-file-security 1.0.3 → 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0cbba9bdb2c474a89f0c9a7bfd316d11f5340ed
+  data.tar.gz: fe8f1a9b21770c3adefd4753bd1dde13e3b126ed
+SHA512:
+  metadata.gz: ed0b4e85d4864cace4bd070483b4c7efbfd131c15a9c35236494ca1142d4b4cd674f31a2d2dd46f06970a8b6bb73f83b204737dab63f5775ef2ebfea1f5120d4
+  data.tar.gz: 31d4bec21d22a52d3f889c8631b1cf63eb61cc52317ee5356ca1816195a0b11dbdab1c379dab25d29496afe5a960a78b4d0611ecb212fbb373f971ea4f212e86

data/CHANGES

@@ -1,3 +1,9 @@
+= 1.0.4 - 2-May-2014
+* All methods that accept a filename argument now honor objects that implement
+  either to_str or to_path.
+* Added some pathname tests.
+* Updated the gem:create Rakefile task.
+
 = 1.0.3 - 15-Apr-2013
 * Added the File.group method.
 * Added a working implementation of File.grpowned?

data/README

@@ -35,7 +35,7 @@
   Artistic 2.0
 
 == Copyright
-  (C) 2003-2013, Daniel J. Berger, All Rights Reserved
+  (C) 2003-2014, Daniel J. Berger, All Rights Reserved
 
 == Warranty
   This package is provided "as is" and without any express or

data/Rakefile

@@ -8,13 +8,18 @@ namespace :gem do
   desc 'Build the win32-file-security gem'
   task :create => [:clean] do
     spec = eval(IO.read('win32-file-security.gemspec'))
-    Gem::Builder.new(spec).build
+    if Gem::VERSION < "2.0"
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
   end
 
   desc "Install the win32-file-security gem"
   task :install => [:create] do
     file = Dir["*.gem"].first
-    sh "gem install #{file}"
+    sh "gem install -l #{file}"
   end
 end
 

data/lib/win32/file/security.rb

@@ -1,7 +1,7 @@
-require File.join(File.dirname(__FILE__), 'security', 'constants')
-require File.join(File.dirname(__FILE__), 'security', 'structs')
-require File.join(File.dirname(__FILE__), 'security', 'functions')
-require File.join(File.dirname(__FILE__), 'security', 'helper')
+require_relative 'security/constants'
+require_relative 'security/structs'
+require_relative 'security/functions'
+require_relative 'security/helper'
 require 'socket'
 
 class File
@@ -12,7 +12,7 @@ class File
   extend Windows::File::Functions
 
   # The version of the win32-file library
-  WIN32_FILE_SECURITY_VERSION = '1.0.3'
+  WIN32_FILE_SECURITY_VERSION = '1.0.4'
 
   class << self
     remove_method(:chown)
@@ -31,7 +31,7 @@ class File
     # * unknown
     #
     def encryption_status(file)
-      wide_file  = file.wincode
+      wide_file  = string_check(file).wincode
       status_ptr = FFI::MemoryPointer.new(:ulong)
 
       unless FileEncryptionStatusW(wide_file, status_ptr)
@@ -77,7 +77,7 @@ class File
       flags_ptr = FFI::MemoryPointer.new(:ulong)
 
       if file
-        file = File.expand_path(file)
+        file = File.expand_path(string_check(file))
         wide_file = file.wincode
 
         if !PathIsRootW(wide_file)
@@ -114,7 +114,7 @@ class File
     # file is compressed the file will be decompressed before encrypting it.
     #
     def encrypt(file)
-      unless EncryptFileW(file.wincode)
+      unless EncryptFileW(string_check(file).wincode)
         raise SystemCallError.new("EncryptFile", FFI.errno)
       end
       self
@@ -131,7 +131,7 @@ class File
     # is NOT raised, it's simply a no-op.
     #
     def decrypt(file)
-      unless DecryptFileW(file.wincode, 0)
+      unless DecryptFileW(string_check(file).wincode, 0)
         raise SystemCallError.new("DecryptFile", FFI.errno)
       end
       self
@@ -159,12 +159,12 @@ class File
     #   }
     #
     def get_permissions(file, host=nil)
+      wide_file = string_check(file).wincode
+      wide_host = host ? host.wincode : nil
+
       size_needed_ptr = FFI::MemoryPointer.new(:ulong)
       security_ptr    = FFI::MemoryPointer.new(:ulong)
 
-      wide_file = file.wincode
-      wide_host = host ? host.wincode : nil
-
       # First pass, get the size needed
       bool = GetFileSecurityW(
         wide_file,
@@ -262,8 +262,8 @@ class File
           raise SystemCallError.new("LookupAccountSid", FFI.errno) unless bool
 
           # The x2 multiplier is necessary due to wide char strings.
-          name = name.read_string(name_size.read_ulong * 2).delete(0.chr)
-          domain = domain.read_string(domain_size.read_ulong * 2).delete(0.chr)
+          name = name.read_string(name_size.read_ulong * 2).wstrip
+          domain = domain.read_string(domain_size.read_ulong * 2).wstrip
 
           unless domain.empty?
             name = domain + '\\' + name
@@ -321,11 +321,9 @@ class File
     #   File.set_permissions(file, "host\\userid" => File::GENERIC_ALL)
     #
     def set_permissions(file, perms)
-      raise TypeError unless file.is_a?(String)
+      wide_file = string_check(file).wincode
       raise TypeError unless perms.kind_of?(Hash)
 
-      wide_file = file.wincode
-
       account_rights = 0
       sec_desc = FFI::MemoryPointer.new(:pointer, SECURITY_DESCRIPTOR_MIN_LENGTH)
 
@@ -478,8 +476,9 @@ class File
     # This method was redefined for MS Windows.
     #
     def owned?(file)
+      wide_file = string_check(file).wincode
+
       return_value = false
-      wide_file = file.wincode
       size_needed_ptr = FFI::MemoryPointer.new(:ulong)
 
       # First pass, get the size needed
@@ -626,7 +625,7 @@ class File
         end
 
         files.each{ |file|
-          wfile = file.wincode
+          wfile = string_check(file).wincode
 
           size = FFI::MemoryPointer.new(:ulong)
           sec  = FFI::MemoryPointer.new(:ulong)
@@ -673,11 +672,12 @@ class File
     #   p File.owner('some_file.txt') # => "your_domain\\some_user"
     #
     def owner(file)
+      file = string_check(file).wincode
       size_needed = FFI::MemoryPointer.new(:ulong)
 
       # First pass, get the size needed
       bool = GetFileSecurityW(
-        file.wincode,
+        file,
         OWNER_SECURITY_INFORMATION,
         nil,
         0,
@@ -688,7 +688,7 @@ class File
 
       # Second pass, this time with the appropriately sized security pointer
       bool = GetFileSecurityW(
-        file.wincode,
+        file,
         OWNER_SECURITY_INFORMATION,
         security,
         security.size,
@@ -723,8 +723,8 @@ class File
         raise SystemCallError.new("LookupAccountSid", FFI.errno)
       end
 
-      name = name.read_string(name.size).tr(0.chr, '').strip
-      domain = dom.read_string(dom.size).tr(0.chr, '').strip
+      name = name.read_string(name.size).wstrip
+      domain = dom.read_string(dom.size).wstrip
 
       domain << "\\" << name
     end
@@ -736,11 +736,12 @@ class File
     #   p File.group('some_file.txt') # => "your_domain\\some_group"
     #
     def group(file)
+      file = string_check(file).wincode
       size_needed = FFI::MemoryPointer.new(:ulong)
 
       # First pass, get the size needed
       bool = GetFileSecurityW(
-        file.wincode,
+        file,
         GROUP_SECURITY_INFORMATION,
         nil,
         0,
@@ -751,7 +752,7 @@ class File
 
       # Second pass, this time with the appropriately sized security pointer
       bool = GetFileSecurityW(
-        file.wincode,
+        file,
         GROUP_SECURITY_INFORMATION,
         security,
         security.size,
@@ -786,8 +787,8 @@ class File
         raise SystemCallError.new("LookupAccountSid", FFI.errno)
       end
 
-      name = name.read_string(name.size).tr(0.chr, '').strip
-      domain = dom.read_string(dom.size).tr(0.chr, '').strip
+      name = name.read_string(name.size).wstrip
+      domain = dom.read_string(dom.size).wstrip
 
       domain << "\\" << name
     end
@@ -803,8 +804,9 @@ class File
     # This method was redefined for MS Windows.
     #
     def grpowned?(file)
+      wide_file = string_check(file).wincode
+
       return_value = false
-      wide_file = file.wincode
       size_needed_ptr = FFI::MemoryPointer.new(:ulong)
 
       # First pass, get the size needed
@@ -880,5 +882,15 @@ class File
 
       return_value
     end
+
+    private
+
+    # Simulate MRI's contortions for a stringiness check.
+    def string_check(arg)
+      return arg if arg.is_a?(String)
+      return arg.send(:to_str) if arg.respond_to?(:to_str, true) # MRI honors it, even if private
+      return arg.to_path if arg.respond_to?(:to_path)
+      raise TypeError
+    end
   end
 end

data/lib/win32/file/security/functions.rb

@@ -3,16 +3,14 @@ require 'ffi'
 module Windows
   module File
     module Functions
+      extend FFI::Library
 
-      # Make FFI functions private
-      module FFI::Library
-        def attach_pfunc(*args)
-          attach_function(*args)
-          private args[0]
-        end
-      end
+      private
 
-      extend FFI::Library
+      def self.attach_pfunc(*args)
+        attach_function(*args)
+        private args[0]
+      end
 
       # For convenience
       typedef :pointer, :ptr

data/lib/win32/file/security/helper.rb

@@ -4,4 +4,10 @@ class String
   def wincode
     (self.tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
   end
+
+  # Read a wide character string up until the first double null, and delete
+  # any remaining null characters.
+  def wstrip
+    self.force_encoding('UTF-16LE').encode('UTF-8',:invalid=>:replace,:undef=>:replace).split("\x00")[0].encode(Encoding.default_external)
+  end
 end

data/test/test_win32_file_security_ownership.rb

@@ -9,12 +9,12 @@ require 'sys/admin'
 require 'test-unit'
 require 'win32/security'
 require 'win32/file/security'
+require 'pathname'
 
 class TC_Win32_File_Security_Ownership < Test::Unit::TestCase
   def self.startup
     Dir.chdir(File.dirname(File.expand_path(File.basename(__FILE__))))
     @@file = File.join(Dir.pwd, 'ownership_test.txt')
-    File.open(@@file, 'w'){ |fh| fh.puts "This is an ownership test." }
 
     @@host  = Socket.gethostname
     @@temp  = "Temp"
@@ -27,6 +27,7 @@ class TC_Win32_File_Security_Ownership < Test::Unit::TestCase
 
   def setup
     @elevated = Win32::Security.elevated_security?
+    File.open(@@file, 'w'){ |fh| fh.puts "This is an ownership test." }
   end
 
   test "owned? method basic functionality" do
@@ -69,6 +70,10 @@ class TC_Win32_File_Security_Ownership < Test::Unit::TestCase
     assert_raise(ArgumentError){ File.owner(@@file, @@file) }
   end
 
+  test "owner allows a pathname object" do
+    assert_nothing_raised{ File.owner(Pathname.new(@@file)) }
+  end
+
   test "grpowned? method basic functionality" do
     assert_respond_to(File, :grpowned?)
     assert_nothing_raised{ File.grpowned?(@@file) }
@@ -104,6 +109,15 @@ class TC_Win32_File_Security_Ownership < Test::Unit::TestCase
     assert_equal(expected, File.group(@@file))
   end
 
+  test "group method allows a pathname object" do
+    assert_nothing_raised{ File.group(Pathname.new(@@file)) }
+  end
+
+  test "group method requires a stringy argument" do
+    assert_raise(TypeError){ File.group(nil) }
+    assert_raise(TypeError){ File.group([]) }
+  end
+
   test "chown method basic functionality" do
     assert_respond_to(File, :chown)
   end
@@ -131,11 +145,11 @@ class TC_Win32_File_Security_Ownership < Test::Unit::TestCase
 
   def teardown
     @elevated = nil
+    File.delete(@@file) if File.exists?(@@file)
   end
 
   def self.shutdown
     Sys::Admin.delete_user(@@temp) if Win32::Security.elevated_security?
-    File.delete(@@file) if File.exists?(@@file)
     @@file = nil
     @@login = nil
     @@host = nil

data/test/test_win32_file_security_version.rb

@@ -8,6 +8,6 @@ require 'win32/file/security'
 
 class TC_Win32_File_Security_Version < Test::Unit::TestCase
   test "version is set to expected value" do
-    assert_equal('1.0.3', File::WIN32_FILE_SECURITY_VERSION)
+    assert_equal('1.0.4', File::WIN32_FILE_SECURITY_VERSION)
   end
 end

data/win32-file-security.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-file-security'
-  spec.version    = '1.0.3'
+  spec.version    = '1.0.4'
   spec.authors    = ['Daniel J. Berger', 'Park Heesob']
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-file-security
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 1.0.4
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -10,75 +9,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: win32-security
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sys-admin
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    The win32-file-security library adds security related methods
-  to the\n    core File class for MS Windows. This includes the ability to get or\n
-  \   set permissions, as well as encrypt or decrypt files.\n"
+description: |2
+      The win32-file-security library adds security related methods to the
+      core File class for MS Windows. This includes the ability to get or
+      set permissions, as well as encrypt or decrypt files.
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -88,14 +80,14 @@ extra_rdoc_files:
 - MANIFEST
 files:
 - CHANGES
+- MANIFEST
+- README
+- Rakefile
+- lib/win32/file/security.rb
 - lib/win32/file/security/constants.rb
 - lib/win32/file/security/functions.rb
 - lib/win32/file/security/helper.rb
 - lib/win32/file/security/structs.rb
-- lib/win32/file/security.rb
-- MANIFEST
-- Rakefile
-- README
 - test/test_win32_file_security_constants.rb
 - test/test_win32_file_security_encryption.rb
 - test/test_win32_file_security_ffi.rb
@@ -106,27 +98,26 @@ files:
 homepage: http://github.com/djberg96/win32-file-security
 licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: File security methods for the File class on MS Windows
 test_files:
 - test/test_win32_file_security_constants.rb