nis-ffi 0.2.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem "ffi", "~> 1.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "shoulda", ">= 0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ffi (1.0.5)
+      rake (>= 0.8.7)
+    ffi (1.0.5-java)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rcov (0.9.9-java)
+    shoulda (2.11.3)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  ffi (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Robin Stocker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= nis-ffi
+
+NIS (YP) library using libc's libnsl through ruby-ffi. It is known to work on
+Ruby 1.8.7, 1.9.2 and JRuby 1.6.0.
+
+Please note that only a few functions have been implemented, so please fork and
+add the ones you need. It's really easy thanks to ffi!
+
+== Usage
+
+  >> require 'nis-ffi'
+  >> NIS.yp_match("nis.example.org", "passwd.byname", "username")
+  => "username:42pwdhashBEEF:1000:1111:Full Name:/home/username:/bin/zsh"
+
+== Contributing to nis-ffi
+ 
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Robin Stocker. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+RDOC_OPTIONS = ['--main', 'README.rdoc']
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "nis-ffi"
+  gem.homepage = "http://github.com/robinst/nis-ffi"
+  gem.license = "MIT"
+  gem.summary = %Q{NIS (YP) library using libc's libnsl through ruby-ffi}
+  gem.description = %Q{Library for NIS (YP) queries using the libnsl library of libc through ruby-ffi.}
+  gem.email = "robin@nibor.org"
+  gem.authors = ["Robin Stocker"]
+  gem.add_dependency 'ffi', '~> 1.0.0'
+  gem.rdoc_options = RDOC_OPTIONS
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nis-ffi #{version}"
+  rdoc.options = RDOC_OPTIONS
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/nis-ffi.rb

@@ -0,0 +1,94 @@
+require 'ffi'
+
+# NIS module providing the yp functions.
+module NIS
+  
+  YPERR_SUCCESS = 0
+  YPERR_BADARGS = 1
+  YPERR_RPC     = 2
+  YPERR_DOMAIN  = 3
+  YPERR_MAP     = 4
+  YPERR_KEY     = 5
+  YPERR_YPERR   = 6
+  YPERR_RESRC   = 7
+  YPERR_NOMORE  = 8
+  YPERR_PMAP    = 9
+  YPERR_YPBIND  = 10
+  YPERR_YPSERV  = 11
+  YPERR_NODOM   = 12
+  YPERR_BADDB   = 13
+  YPERR_VERS    = 14
+  YPERR_ACCESS  = 15
+  YPERR_BUSY    = 16
+
+  # Runtime error for yp functions.
+  #
+  # Can be raised from each function when something goes wrong (when the return
+  # code isn't 0). Includes the error code and a readable message. The code can
+  # be checked against the YPERR constants (e.g. NIS::YPERR_BADARGS).
+  class YPError < RuntimeError
+    attr_reader :code
+
+    def initialize(code, message)
+      super(message)
+      @code = code
+    end
+  end
+
+  module Library
+    extend FFI::Library
+    begin
+      ffi_lib 'nsl'
+    rescue LoadError
+      begin
+        # fall back to libc (Mac OS X is different)
+        ffi_lib 'c'
+      rescue LoadError
+        raise LoadError, "nis-ffi: Neither libnsl nor libc could be loaded, giving up."
+      end
+    end
+    attach_function 'yp_get_default_domain', [:pointer], :int
+    attach_function 'yp_match', [:string, :string, :string, :int, :pointer, :pointer], :int
+    attach_function 'yperr_string', [:int], :string
+  end
+
+  # Get the default domain.
+  def self.yp_get_default_domain
+    domain_ptr = FFI::MemoryPointer.new(:pointer)
+    code = Library.yp_get_default_domain(domain_ptr)
+    raise_on_error(code)
+    str_ptr = domain_ptr.read_pointer
+    str_ptr.read_string
+  end
+
+  # Look up a value with a specified map and key.
+  #
+  # Returns the string value or raises an YPError (even when it's just a key
+  # that doesn't exist).
+  def self.yp_match(domain, map, key)
+    value = FFI::MemoryPointer.new(:pointer)
+    value_len = FFI::MemoryPointer.new(:int)
+
+    code = Library.yp_match(domain, map, key, key.bytesize, value, value_len)
+    raise_on_error(code)
+    
+    str_ptr = value.read_pointer
+    len = value_len.read_int
+    result = str_ptr.read_string(len)
+    result
+  end
+
+  # Returns an error string which describes the error code.
+  def self.yperr_string(code)
+    Library.yperr_string(code)
+  end
+
+  private
+
+  def self.raise_on_error(code)
+    if code != YPERR_SUCCESS
+      message = yperr_string(code)
+      raise YPError.new(code, message)
+    end
+  end
+end

data/nis-ffi.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nis-ffi}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robin Stocker"]
+  s.date = %q{2011-02-18}
+  s.description = %q{Library for NIS (YP) queries using the libnsl library of libc through ruby-ffi.}
+  s.email = %q{robin@nibor.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/nis-ffi.rb",
+    "nis-ffi.gemspec",
+    "test/helper.rb",
+    "test/test_errors.rb",
+    "test/test_server.rb"
+  ]
+  s.homepage = %q{http://github.com/robinst/nis-ffi}
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{NIS (YP) library using libc's libnsl through ruby-ffi}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_errors.rb",
+    "test/test_server.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<ffi>, ["~> 1.0.0"])
+    else
+      s.add_dependency(%q<ffi>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ffi>, ["~> 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<ffi>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ffi>, ["~> 1.0.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'nis-ffi'
+
+class Test::Unit::TestCase
+end

data/test/test_errors.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestErrors < Test::Unit::TestCase
+  should "return error string with yperr_string" do
+    assert_match /^RPC failure/, NIS::yperr_string(NIS::YPERR_RPC)
+    assert_match /error/, NIS::yperr_string(NIS::YPERR_YPERR)
+  end
+
+  should "raise YPError when server doesn't exist" do
+    exception = assert_raise(NIS::YPError) { NIS::yp_match("foo.example.org", "passwd.byname", "foo") }
+    assert [NIS::YPERR_YPERR, NIS::YPERR_DOMAIN].include?(exception.code)
+    assert_equal NIS::yperr_string(exception.code), exception.message
+  end
+end

data/test/test_server.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestServer < Test::Unit::TestCase
+  should "return the default domain" do
+    assert_not_nil NIS::yp_get_default_domain()
+  end
+
+  context "The NIS server (default domain)" do
+    setup do
+      @domain = NIS::yp_get_default_domain()
+    end
+
+    should "return a result on yp_match with the current user" do
+      user = ENV['USER']
+      result = NIS::yp_match(@domain, "passwd.byname", user)
+      assert_not_nil result
+      values = result.split(":")
+      assert_equal user, values[0]
+      assert values.length > 1
+    end
+
+    should "not return a result on yp_match with an inexisting user" do
+      user = "thisisreallynotausernameihope"
+      exception = assert_raise(NIS::YPError) { result = NIS::yp_match(@domain, "passwd.byname", user) }
+      assert_equal NIS::YPERR_KEY, exception.code
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: nis-ffi
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Robin Stocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :runtime
+  version_requirements: *id006
+description: Library for NIS (YP) queries using the libnsl library of libc through ruby-ffi.
+email: robin@nibor.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/nis-ffi.rb
+- nis-ffi.gemspec
+- test/helper.rb
+- test/test_errors.rb
+- test/test_server.rb
+has_rdoc: true
+homepage: http://github.com/robinst/nis-ffi
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: NIS (YP) library using libc's libnsl through ruby-ffi
+test_files: 
+- test/helper.rb
+- test/test_errors.rb
+- test/test_server.rb