windows_error 0.0.1

data/spec/lib/windows_error/error_code_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe WindowsError::ErrorCode do
+
+  subject(:error_code) { described_class.new(name,value,description) }
+  let(:name) { "STATUS_TIMEOUT" }
+  let(:value) { 0x00000102 }
+  let(:description) { "The given Timeout interval expired." }
+
+  context 'with a non-number value' do
+    let(:value) { "Bogus" }
+
+    it 'will raise an ArgumentError' do
+      expect{described_class.new(name,value,description)}.to raise_error ArgumentError,"Invalid Error Code Value!"
+    end
+  end
+
+  context 'with a non-string description' do
+    let(:description) { 42 }
+
+    it 'will raise an ArgumentError' do
+      expect{described_class.new(name,value,description)}.to raise_error ArgumentError,"Invalid Error Description!"
+    end
+  end
+
+  context 'with an empty string description' do
+    let(:description) { '' }
+
+    it 'will raise an ArgumentError' do
+      expect{described_class.new(name,value,description)}.to raise_error ArgumentError,"Invalid Error Description!"
+    end
+  end
+
+  context 'with a non-string name' do
+    let(:name) { 42 }
+
+    it 'will raise an ArgumentError' do
+      expect{described_class.new(name,value,description)}.to raise_error ArgumentError,"Invalid Error Name!"
+    end
+  end
+
+  context 'with an empty string name' do
+    let(:name) { '' }
+
+    it 'will raise an ArgumentError' do
+      expect{described_class.new(name,value,description)}.to raise_error ArgumentError,"Invalid Error Name!"
+    end
+  end
+
+  it 'sets #name based on the initializer' do
+    expect(error_code.name).to eq name
+  end
+
+  it 'sets #value based on the initializer' do
+    expect(error_code.value).to eq value
+  end
+
+  it 'sets #description based on the initializer' do
+    expect(error_code.description).to eq description
+  end
+
+  describe '#==' do
+    let(:invalid_str) { "foo" }
+
+    it 'raises an ArgumentError for an invalid comparison' do
+      expect{ error_code == invalid_str}.to raise_error ArgumentError, "Cannot compare a WindowsError::ErrorCode to a #{invalid_str.class}"
+    end
+
+    context 'when passed a Fixnum' do
+      let(:fixnum_value) { 258 }
+      let(:other_fixnum) { 42 }
+
+      it 'returns true if equal to the #value' do
+        expect(error_code == fixnum_value).to eq true
+      end
+
+      it 'returns false if not equal to the #value' do
+        expect(error_code == other_fixnum).to eq false
+      end
+    end
+
+    context 'when passed another error code' do
+      let(:matching_error_code) { described_class.new(name,value,description) }
+      let(:other_error_code) { described_class.new(name,42,description) }
+
+      it 'returns true when the values match' do
+        expect(error_code == matching_error_code).to eq true
+      end
+
+      it 'returns false when the values do not match' do
+        expect(error_code == other_error_code).to eq false
+      end
+    end
+  end
+
+
+end

data/spec/lib/windows_error/nt_status_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'windows_error/nt_status'
+
+describe WindowsError::NTStatus do
+
+  describe '#find_by_retval' do
+
+    it 'raises an argument error when passed an invalid value' do
+      expect{ WindowsError::NTStatus.find_by_retval("foo") }.to raise_error ArgumentError,"Invalid Return Code!"
+    end
+
+    it 'returns an array with the error_codes for that return value' do
+      expect(WindowsError::NTStatus.find_by_retval(0x00000102)).to match_array([WindowsError::NTStatus::STATUS_TIMEOUT])
+    end
+
+    it 'returns multiple entries if there are more than one match' do
+      expect(WindowsError::NTStatus.find_by_retval(0x00000000)).to match_array([WindowsError::NTStatus::STATUS_SUCCESS,WindowsError::NTStatus::STATUS_WAIT_0])
+    end
+
+    it 'returns an empty array if there is no match' do
+      expect(WindowsError::NTStatus.find_by_retval(0x99999999)).to match_array([])
+    end
+  end
+end

data/spec/lib/windows_error/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe WindowsError::Version do
+  it_should_behave_like 'Metasploit::Version Version Module'
+end

data/spec/lib/windows_error/win32_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'windows_error/win32'
+
+describe WindowsError::Win32 do
+
+  describe '#find_by_retval' do
+
+    it 'raises an argument error when passed an invalid value' do
+      expect{ WindowsError::Win32.find_by_retval("foo") }.to raise_error ArgumentError,"Invalid Return Code!"
+    end
+
+    it 'returns an array with the error_codes for that return value' do
+      expect(WindowsError::Win32.find_by_retval(0x00000008)).to match_array([WindowsError::Win32::ERROR_NOT_ENOUGH_MEMORY])
+    end
+
+    it 'returns an empty array if there is no match' do
+      expect(WindowsError::Win32.find_by_retval(0x99999999)).to match_array([])
+    end
+  end
+end

data/spec/lib/windows_error_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe WindowsError do
+  it_should_behave_like 'Metasploit::Version VERSION constant'
+  it_should_behave_like 'Metasploit::Version GEM_VERSION constant'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+require 'simplecov'
+require 'coveralls'
+
+if ENV['TRAVIS'] == 'true'
+  # don't generate local report as it is inaccessible on travis-ci, which is
+  # why coveralls is being used.
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+else
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+end
+
+require 'rspec'
+require 'windows_error'
+
+# Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+
+Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+  require f
+end
+
+# add project lib directory to load path
+spec_pathname = Pathname.new(__FILE__).dirname
+root_pathname = spec_pathname.join('..').expand_path
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+support_glob = root_pathname.join('spec', 'support', '**', '*.rb')
+
+Dir.glob(support_glob) do |path|
+  require path
+end

data/windows_error.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'windows_error/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "windows_error"
+  spec.version       = WindowsError::VERSION
+  spec.authors       = ["David Maloney"]
+  spec.email         = ["DMaloney@rapid7.com"]
+  spec.summary       = %q{Provides a way to look up Windows NTSTATUS and Win32 Error Codes}
+  spec.description   = %q{The WindowsError gem provides an easily accessible reference for
+                          standard Windows API Error Codes. It allows you to do comparisons
+                          as well as direct lookups of error codes to translate the numerical
+                          value returned by the API, into a meaninful and humand readable message.}
+  spec.homepage      = "https://github.com/rapid7/windows_error"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "fivemat"
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: windows_error
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Maloney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: fivemat
+  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'
+description: |-
+  The WindowsError gem provides an easily accessible reference for
+                            standard Windows API Error Codes. It allows you to do comparisons
+                            as well as direct lookups of error codes to translate the numerical
+                            value returned by the API, into a meaninful and humand readable message.
+email:
+- DMaloney@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/windows_error.rb
+- lib/windows_error/error_code.rb
+- lib/windows_error/nt_status.rb
+- lib/windows_error/version.rb
+- lib/windows_error/win32.rb
+- spec/lib/windows_error/error_code_spec.rb
+- spec/lib/windows_error/nt_status_spec.rb
+- spec/lib/windows_error/version_spec.rb
+- spec/lib/windows_error/win32_spec.rb
+- spec/lib/windows_error_spec.rb
+- spec/spec_helper.rb
+- windows_error.gemspec
+homepage: https://github.com/rapid7/windows_error
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Provides a way to look up Windows NTSTATUS and Win32 Error Codes
+test_files:
+- spec/lib/windows_error/error_code_spec.rb
+- spec/lib/windows_error/nt_status_spec.rb
+- spec/lib/windows_error/version_spec.rb
+- spec/lib/windows_error/win32_spec.rb
+- spec/lib/windows_error_spec.rb
+- spec/spec_helper.rb
+has_rdoc: