chef-win32-api 1.11.0

data/ext/win32/extconf.rb

@@ -0,0 +1,15 @@
+##########################################################################
+# extconf.rb
+#
+# The Windows::API binary should be built using the Rake task, i.e.
+# 'rake build' or 'rake install'.
+##########################################################################
+require 'mkmf'
+
+if RbConfig::CONFIG['host_os'] =~ /mingw/
+  $CFLAGS << ' -fno-omit-frame-pointer'
+end
+
+have_func('strncpy_s')
+
+create_makefile('win32/api')

data/lib/win32/api.rb

@@ -0,0 +1 @@
+require "win32/api.so"

data/test/test_win32_api.rb

@@ -0,0 +1,151 @@
+############################################################################
+# test_win32_api.rb
+#
+# Test case for the Win32::API class. You should run this as Rake task,
+# i.e. 'rake test', instead of running it directly.
+############################################################################
+require 'win32/api'
+require 'test-unit'
+include Win32
+
+class TC_Win32_API < Test::Unit::TestCase
+   def setup
+      @buf = 0.chr * 260
+      @gfa = API.new('GetFileAttributes', 'S', 'L')
+      @gcd = API.new('GetCurrentDirectory', 'LP')
+      @gle = API.new('GetLastError', 'V', 'L')
+      @str = API.new('strstr', 'PP', 'P', 'msvcrt')
+   end
+
+   def test_version
+      assert_equal('1.10.1', API::VERSION)
+   end
+
+   def test_constructor_basic
+      assert_nothing_raised{ API.new('GetCurrentDirectory') }
+      assert_nothing_raised{ API.new('GetCurrentDirectory', 'LP') }
+      assert_nothing_raised{ API.new('GetCurrentDirectory', 'LP', 'L') }
+      assert_nothing_raised{ API.new('GetCurrentDirectory', 'LP', 'L', 'kernel32') }
+   end
+
+   def test_call
+      assert_respond_to(@gcd, :call)
+      assert_nothing_raised{ @gcd.call(@buf.length, @buf) }
+      assert_equal(Dir.pwd.tr('/', "\\"), @buf.strip)
+   end
+
+   def test_call_with_void
+      assert_nothing_raised{ @gle.call }
+      assert_nothing_raised{ @gle.call(nil) }
+   end
+
+   def test_call_return_value_on_failure
+      assert_equal(0xFFFFFFFF, @gfa.call('C:/foobarbazblah'))
+   end
+
+   def test_last_error
+      @gfa.call('C:/foobarbazblah')
+      error_file_not_found = 2
+      assert_equal(error_file_not_found, API.last_error)
+   end
+
+   def test_dll_name
+      assert_respond_to(@gcd, :dll_name)
+      assert_equal('kernel32', @gcd.dll_name)
+   end
+
+   def test_function_name
+      assert_respond_to(@gcd, :function_name)
+      assert_equal('GetCurrentDirectory', @gcd.function_name)
+      assert_equal('strstr', @str.function_name)
+   end
+
+   def test_effective_function_name_default
+      assert_respond_to(@gcd, :effective_function_name)
+      assert_equal('GetCurrentDirectoryA', @gcd.effective_function_name)
+      assert_equal('strstr', @str.effective_function_name)
+   end
+
+   def test_effective_function_name_default_explicit_ansi
+      @gcd = API.new('GetCurrentDirectoryA', 'LP')
+      assert_equal('GetCurrentDirectoryA', @gcd.effective_function_name)
+   end
+
+   def test_effective_function_name_default_explicit_wide
+      @gcd = API.new('GetCurrentDirectoryW', 'LP')
+      assert_equal('GetCurrentDirectoryW', @gcd.effective_function_name)
+   end
+
+   def test_prototype
+      assert_respond_to(@gcd, :prototype)
+      assert_equal(['L', 'P'], @gcd.prototype)
+   end
+
+   def test_return_type
+      assert_respond_to(@gcd, :return_type)
+      assert_equal('L', @gcd.return_type)
+   end
+
+   def test_constructor_high_iteration
+      assert_nothing_raised{
+         1000.times{ API.new('GetUserName', 'P', 'P', 'advapi32') }
+      }
+   end
+
+   def test_constructor_expected_failures
+      assert_raise(ArgumentError){ API.new }
+      assert_raise(ArgumentError){ API.new('GetUserName', ('L' * 21), 'X') }
+      assert_raise(API::LoadLibraryError){ API.new('GetUserName', 'PL', 'I', 'foo') }
+      assert_raise(API::PrototypeError){ API.new('GetUserName', 'X', 'I', 'advapi32') }
+      assert_raise(API::PrototypeError){ API.new('GetUserName', 'PL', 'X', 'advapi32') }
+   end
+
+   test "constructor returns expected error message if function not found" do
+     msg = "Unable to load function "
+     assert_raise_message(msg + "'Zap', 'ZapA', or 'ZapW'"){ API.new('Zap') }
+     assert_raise_message(msg + "'strxxx'"){ API.new('strxxx', 'P', 'L', 'msvcrt') }
+   end
+
+   test "constructor returns expected error message if prototype is invalid" do
+     msg = "Illegal prototype 'X'"
+     assert_raise_message(msg){ API.new('GetUserName', 'X', 'I', 'advapi32') }
+   end
+
+   test "constructor returns expected error message if return type is invalid" do
+     msg = "Illegal return type 'Y'"
+     assert_raise_message(msg){ API.new('GetUserName', 'PL', 'Y', 'advapi32') }
+   end
+
+   test "constructor returns expected error message if too many parameters" do
+     msg = "too many parameters: 25"
+     assert_raise_message(msg){ API.new('GetFileAttributes', 'S' * 25, 'L') }
+   end
+
+   test "call method returns expected error message if too many parameters" do
+     msg = "wrong number of parameters: expected 2, got 3"
+     assert_raise_message(msg){ @str.call('test', 'test', 'test') }
+   end
+
+   def test_call_expected_failures
+      assert_raise(TypeError){ @gcd.call('test', @buf) }
+   end
+
+   def test_error_classes
+      assert_not_nil(Win32::API::Error)
+      assert_not_nil(Win32::API::LoadLibraryError)
+      assert_not_nil(Win32::API::PrototypeError)
+   end
+
+   def test_error_class_relationships
+      assert_kind_of(RuntimeError, Win32::API::Error.new)
+      assert_kind_of(Win32::API::Error, Win32::API::LoadLibraryError.new)
+      assert_kind_of(Win32::API::Error, Win32::API::PrototypeError.new)
+   end
+
+   def teardown
+      @buf = nil
+      @gcd = nil
+      @gle = nil
+      @str = nil
+   end
+end

data/test/test_win32_api_callback.rb

@@ -0,0 +1,75 @@
+############################################################################
+# test_win32_api_callback.rb
+# 
+# Test case for the Win32::API::Callback class. You should run this as Rake
+# task, i.e. 'rake test', instead of running it directly.
+############################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'win32/api'
+require 'test/unit'
+include Win32
+
+class TC_Win32_API_Callback < Test::Unit::TestCase
+  def setup
+    @buffer   = 0.chr * 260
+    @api_ew   = API.new('EnumWindows', 'KP', 'L', 'user32')
+    @api_gwt  = API.new('GetWindowText', 'LPI', 'I', 'user32')
+    @callback = nil
+  end
+   
+  def test_constructor
+    assert_respond_to(API::Callback, :new)
+    assert_nothing_raised{ API::Callback.new('LP', 'I') }
+    assert_nothing_raised{ API::Callback.new('LP', 'I'){} }
+  end
+   
+  def test_prototype
+    assert_nothing_raised{ @callback = API::Callback.new('LP', 'I') }
+    assert_respond_to(@callback, :prototype)
+    assert_equal('LP', @callback.prototype)
+  end
+   
+  def test_return_value
+    assert_nothing_raised{ @callback = API::Callback.new('LP', 'I') }
+    assert_respond_to(@callback, :return_type)
+    assert_equal('I', @callback.return_type)
+  end
+
+  def test_address
+    assert_nothing_raised{ @callback = API::Callback.new('LP', 'I') }
+    assert_respond_to(@callback, :address)
+    assert_kind_of(Integer, @callback.address)
+    assert_true(@callback.address > 0)
+  end
+
+  def test_callback
+    omit "Callback feature is not handled properly for now"
+    assert_nothing_raised{
+      @callback = API::Callback.new('LP', 'I'){ |handle, param|
+       	buf = "\0" * 200
+        @api_gwt.call(handle, buf, 200);
+        buf.index(param).nil? ? true : false
+      }
+    }
+    assert_nothing_raised{ @api_ew.call(@callback, 'UEDIT32') }
+  end
+
+  def test_constructor_expected_errors
+    assert_raise(API::PrototypeError){ API::Callback.new('X') }
+    assert_raise(API::PrototypeError){ API::Callback.new('L', 'Y') }
+  end
+
+  def test_constructor_expected_error_messages
+    assert_raise_message("Illegal prototype 'X'"){ API::Callback.new('X') }
+    assert_raise_message("Illegal return type 'Y'"){ API::Callback.new('L', 'Y') }
+  end
+
+  def teardown
+    @buffer   = nil
+    @api_ew   = nil
+    @api_gwt  = nil
+    @callback = nil
+  end
+end

data/test/test_win32_api_function.rb

@@ -0,0 +1,66 @@
+########################################################################
+# test_win32_api_function.rb
+#
+# Test case for the Win32::API::Function class. You should run these
+# tests via the 'rake test' task.
+########################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'win32/api'
+include Win32
+
+class TC_Win32_API_Function < Test::Unit::TestCase
+   def setup
+      @func = Win32::API::Function.new(123456789, 'LP', 'L')
+   end
+
+   def test_constructor
+      assert_nothing_raised{ Win32::API::Function.new(1) }
+      assert_nothing_raised{ Win32::API::Function.new(1, 'LL') }
+      assert_nothing_raised{ Win32::API::Function.new(1, 'LL', 'I') }
+   end
+   
+   def test_subclass
+      assert_kind_of(Win32::API, @func)
+      assert_respond_to(@func, :call)
+   end
+
+   def test_address
+      assert_respond_to(@func, :address)
+      assert_equal(123456789, @func.address)
+   end
+
+   def test_prototype
+      assert_respond_to(@func, :prototype)
+      assert_equal(['L', 'P'], @func.prototype)
+   end
+
+   def test_return_type
+      assert_respond_to(@func, :return_type)
+      assert_equal('L', @func.return_type)
+   end
+
+   def test_expected_errors_from_arguments
+      assert_raise(ArgumentError){ Win32::API::Function.new }
+      assert_raise(TypeError){ Win32::API::Function.new('L') }
+      assert_raise(Win32::API::PrototypeError){ Win32::API::Function.new(1, 'X') }
+      assert_raise(Win32::API::PrototypeError){ Win32::API::Function.new(1, 'X', 'Y') }
+   end
+
+   def test_expected_error_messages
+      assert_raise_message("Illegal prototype 'X'"){ API::Function.new(1, 'X') }
+      assert_raise_message("Illegal return type 'Y'"){ API::Function.new(1, 'L', 'Y') }
+   end
+
+   def test_expected_errors_from_call
+      assert_raise(ArgumentError){ @func.call }
+      assert_raise(ArgumentError){ @func.call(1) }
+      assert_raise(ArgumentError){ @func.call(1, 'a', 2) }
+   end
+
+   def teardown
+      @func = nil
+   end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: chef-win32-api
+version: !ruby/object:Gem::Version
+  version: 1.11.0
+platform: ruby
+authors:
+- Daniel J. Berger
+- Park Heesob
+- Hiroshi Hatake
+bindir: bin
+cert_chain: []
+date: 2025-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.9
+description: |2
+      The Win32::API library is meant as a replacement for the Win32API
+      library that ships as part of the standard library. It contains several
+      advantages over Win32API, including callback support, raw function
+      pointers, an additional string type, and more.
+email: djberg96@gmail.com
+executables: []
+extensions:
+- ext/win32/extconf.rb
+extra_rdoc_files:
+- CHANGES
+- MANIFEST
+- ext/win32/api.c
+files:
+- CHANGES
+- Dockerfile
+- Dockerfile.trunk
+- Gemfile
+- MANIFEST
+- README.md
+- RELEASE.md
+- Rakefile
+- appveyor.yml
+- build-gem.bat
+- chef-win32-api.gemspec
+- ext/win32/api.c
+- ext/win32/extconf.rb
+- lib/win32/api.rb
+- test/test_win32_api.rb
+- test/test_win32_api_callback.rb
+- test/test_win32_api_function.rb
+homepage: http://github.com/cosmo0920/win32-api
+licenses:
+- Artistic-2.0
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: A superior replacement for Win32API
+test_files:
+- test/test_win32_api.rb
+- test/test_win32_api_callback.rb
+- test/test_win32_api_function.rb