rkerberos 0.2.2 → 0.3.0

data/spec/policy_spec.rb

@@ -1,10 +1,11 @@
 # spec/policy_spec.rb
 # RSpec tests for Kerberos::Kadm5::Policy
 
-require 'rkerberos'
+require 'spec_helper'
 
-RSpec.describe Kerberos::Kadm5::Policy do
-  subject(:policy) { described_class.new(name: 'test', max_life: 10000) }
+RSpec.describe 'Kerberos::Kadm5::Policy', :kadm5 do
+  subject(:klass){ Kerberos::Kadm5::Policy }
+  let(:policy) { klass.new(name: 'test', max_life: 10000) }
 
   describe 'name' do
     it 'responds to policy' do
@@ -15,10 +16,14 @@ RSpec.describe Kerberos::Kadm5::Policy do
       expect(policy.method(:name)).to eq(policy.method(:policy))
     end
     it 'must be a string' do
-      expect { described_class.new(name: 1) }.to raise_error(TypeError)
+      expect { klass.new(name: 1) }.to raise_error(TypeError)
     end
     it 'must be present' do
-      expect { described_class.new(max_life: 10000) }.to raise_error(ArgumentError)
+      expect { klass.new(max_life: 10000) }.to raise_error(ArgumentError)
+    end
+    it 'rejects positional option hashes and unknown keywords' do
+      expect { klass.new({name: 'test'}) }.to raise_error(ArgumentError)
+      expect { klass.new(name: 'test', unknown: true) }.to raise_error(ArgumentError, /unknown keyword/)
     end
   end
 
@@ -28,7 +33,7 @@ RSpec.describe Kerberos::Kadm5::Policy do
       expect { policy.min_life }.not_to raise_error
     end
     it 'must be a number if not nil' do
-      expect { described_class.new(name: 'test', min_life: 'test') }.to raise_error(TypeError)
+      expect { klass.new(name: 'test', min_life: 'test') }.to raise_error(TypeError)
     end
   end
 
@@ -38,7 +43,7 @@ RSpec.describe Kerberos::Kadm5::Policy do
       expect { policy.max_life }.not_to raise_error
     end
     it 'must be a number if not nil' do
-      expect { described_class.new(name: 'test', max_life: 'test') }.to raise_error(TypeError)
+      expect { klass.new(name: 'test', max_life: 'test') }.to raise_error(TypeError)
     end
   end
 

data/spec/principal_spec.rb

@@ -5,12 +5,61 @@ require 'rkerberos'
 
 RSpec.describe Kerberos::Krb5::Principal do
   let(:name) { 'Jon' }
-  subject(:princ) { described_class.new(name) }
+  subject(:princ) { described_class.new(name: name) }
 
   describe 'constructor' do
-    it 'requires a string argument' do
-      expect { described_class.new(1) }.to raise_error(TypeError)
-      expect { described_class.new(true) }.to raise_error(TypeError)
+    it 'requires name to be a string' do
+      expect { described_class.new(name: 1) }.to raise_error(TypeError)
+      expect { described_class.new(name: true) }.to raise_error(TypeError)
+    end
+
+    it 'accepts no arguments' do
+      expect{ described_class.new }.not_to raise_error
+    end
+
+    it 'works as expected with no name argument' do
+      expect(described_class.new.principal).to be_nil
+    end
+
+    it 'rejects positional arguments' do
+      expect { described_class.new('Jon') }.to raise_error(ArgumentError)
+    end
+
+    it 'accepts a context keyword argument' do
+      ctx = Kerberos::Krb5::Context.new
+      expect { described_class.new(name: 'Jon', context: ctx) }.not_to raise_error
+    end
+
+    it 'rejects positional option hashes and unknown keywords' do
+      expect { described_class.new({name: 'Jon'}) }.to raise_error(ArgumentError)
+      expect { described_class.new(unknown: true) }.to raise_error(ArgumentError, /unknown keyword/)
+    end
+
+    it 'uses the same realm when a context is provided' do
+      ctx = Kerberos::Krb5::Context.new
+      p1 = described_class.new(name: 'Jon')
+      p2 = described_class.new(name: 'Jon', context: ctx)
+      expect(p2.realm).to eq(p1.realm)
+    end
+
+    it 'raises TypeError for non-Context context argument' do
+      expect { described_class.new(name: 'Jon', context: "bad") }.to raise_error(TypeError)
+    end
+
+    it 'raises error for a closed context' do
+      ctx = Kerberos::Krb5::Context.new
+      ctx.close
+      expect { described_class.new(name: 'Jon', context: ctx) }.to raise_error(Kerberos::Krb5::Exception)
+    end
+  end
+
+  describe '#realm' do
+    it 'returns the expected value' do
+      expect(subject.realm).to eq('EXAMPLE.COM')
+    end
+
+    it 'raises an error if no name was provided' do
+      expect{ described_class.new.realm }.to raise_error(Kerberos::Krb5::Exception, /no principal/)
     end
   end
 
@@ -65,4 +114,53 @@ RSpec.describe Kerberos::Krb5::Principal do
       expect { princ.mod_date }.not_to raise_error
     end
   end
+
+  describe '#principal_type' do
+    it 'returns an integer for a named principal' do
+      p = described_class.new(name: 'user@EXAMPLE.COM')
+      expect(p.principal_type).to be_a(Integer)
+    end
+
+    it 'returns KRB5_NT_PRINCIPAL (1) for a simple name' do
+      p = described_class.new(name: 'user@EXAMPLE.COM')
+      expect(p.principal_type).to eq(1)
+    end
+
+    it 'raises an error when no principal has been established' do
+      p = described_class.new
+      expect { p.principal_type }.to raise_error(Kerberos::Krb5::Exception, /no principal/)
+    end
+  end
+
+  describe '#components' do
+    it 'responds to components' do
+      expect(princ).to respond_to(:components)
+    end
+
+    it 'returns an array of strings' do
+      result = princ.components
+      expect(result).to be_a(Array)
+      result.each { |c| expect(c).to be_a(String) }
+    end
+
+    it 'returns one component for a simple principal' do
+      p = described_class.new(name: 'user@EXAMPLE.COM')
+      expect(p.components).to eq(['user'])
+    end
+
+    it 'returns multiple components for a compound principal' do
+      p = described_class.new(name: 'admin/instance@EXAMPLE.COM')
+      expect(p.components).to eq(['admin', 'instance'])
+    end
+
+    it 'returns three components for a three-part principal' do
+      p = described_class.new(name: 'a/b/c@EXAMPLE.COM')
+      expect(p.components).to eq(['a', 'b', 'c'])
+    end
+
+    it 'raises an error when no principal has been established' do
+      p = described_class.new
+      expect { p.components }.to raise_error(Kerberos::Krb5::Exception, /no principal/)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rkerberos'
+require 'rspec'
+require 'etc'
+require 'tmpdir'
+
+RSpec.configure do |config|
+  config.filter_run_excluding :kadm5 => true unless defined?(Kerberos::Kadm5::Config)
+  config.filter_run_excluding :unix => true if File::ALT_SEPARATOR
+
+  krb5_conf = ENV['KRB5_CONFIG']
+  krb5_cc_name = ENV['KRB5CCNAME']
+  login = Etc.getlogin || ENV['USER'] || (Etc.getpwuid(Process.uid).name rescue nil)
+
+  if File::ALT_SEPARATOR
+    krb5_conf ||= 'C:\\ProgramData\\MIT\\Kerberos5\\krb5.ini'
+    krb5_cc_name ||= File.join(ENV['USERPROFILE'], 'krb5cache')
+  else
+    krb5_conf ||= '/etc/krb5.conf'
+    krb5_cc_name ||= File.join(Dir.tmpdir, "krb5cc_#{Etc.getpwnam(login).uid}")
+  end
+
+  config.add_setting :krb5_conf
+  config.krb5_conf = krb5_conf
+
+  config.add_setting :krb5_cc_name
+  config.krb5_cc_name = krb5_cc_name
+
+  config.add_setting :login
+  config.login = login
+
+  unless File.exist?(krb5_conf)
+    config.filter_run_excluding :krb5_config => true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rkerberos
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Berger
@@ -66,6 +66,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - CHANGES.md
+- EXAMPLES.md
 - Gemfile
 - LICENSE
 - MANIFEST.md
@@ -92,17 +93,18 @@ files:
 - spec/krb5_spec.rb
 - spec/policy_spec.rb
 - spec/principal_spec.rb
-homepage: http://github.com/rkerberos/rkerberos
+- spec/spec_helper.rb
+homepage: https://github.com/rkerberos/rkerberos
 licenses:
 - Artistic-2.0
 metadata:
-  homepage_uri: https://github.com/rkerberos/rkerberos
   bug_tracker_uri: https://github.com/rkerberos/rkerberos/issues
-  changelog_uri: https://github.com/rkerberos/rkerberos/blob/main/CHANGES.md
+  changelog_uri: https://github.com/rkerberos/rkerberos/blob/master/CHANGES.md
   documentation_uri: https://github.com/rkerberos/rkerberos/wiki
+  homepage_uri: https://github.com/rkerberos/rkerberos
   source_code_uri: https://github.com/rkerberos/rkerberos
   wiki_uri: https://github.com/rkerberos/rkerberos/wiki
-  github_repo: https://github.com/djberg96/rkerberos
+  github_repo: https://github.com/rkerberos/rkerberos
   funding_uri: https://github.com/sponsors/rkerberos
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -112,16 +114,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.18
 specification_version: 4
-summary: A Ruby interface for the the Kerberos library
+summary: A Ruby interface for the Kerberos library
 test_files:
 - spec/config_spec.rb
 - spec/context_spec.rb