masquerade 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+= Changelog
+
+== Release 0.2.0 - April 13, 2011
+
+* NEW: Support for uid and gid as valid :user and :group values
+* NEW: "as" method returns the result of the code block
+
+== Release 0.1.0 - April 13, 2011
+
+* Initial release

data/Manifest

@@ -1,3 +1,4 @@
+CHANGELOG.rdoc
 Manifest
 README.rdoc
 Rakefile

data/README.rdoc

@@ -13,17 +13,32 @@ To run a block of code as user "roger" and group "developer":
     puts "Hello world"
   end
   
+Alternatively, you can use the uid and gid directly:
+  Masquerade.as :user => 509, :group => 1009 do
+    puts "Hello world"
+  end
+  
 The block of code accepts the user hash as a paramter. So you can do things like:
   Masquerade.as :user => "roger", :group => "developer" do |user_info|
-    puts "Hello world #user_info[:user]"
+    puts "Hello #{user_info[:user]}"
+  end
+  
+Both :user and :group params are optional and you can choose to give one of the two or both:
+  Masquerade.as :user => "roger" do |user_info|
+    puts "Hello #{user_info[:user]}"
   end
   
-Both :user and :group params are optional and you can choose to give one or the two or both.
-
 === Exceptions thrown
 ==== Masquerade::PermissionsError
 
 If the user running the script does not have the privileges to masquerade as the given user.
     
 ==== Masquerade::BadUserOrGroupError
-If the given user or group does not exist
+If the given user or group does not exist
+
+=== Return value
+
+Returns the result of the block call. So you can do:
+  response = Masquerade.as :user => "roger", :group => "developer" do |user_info|
+    "Hello world #{user_info[:user]}"
+  end

data/Rakefile

@@ -2,7 +2,7 @@ require "rubygems"
 require "rake"
 require "echoe"
 
-Echoe.new("masquerade", "0.1.0") do |p|
+Echoe.new("masquerade", "0.2.0") do |p|
   p.description = "A user/group impersonator"
   p.summary = "Run a block of code as another user/group."
   p.url = "http://rubygems.org/gems/masquerade"

data/lib/masquerade.rb

@@ -15,13 +15,21 @@ To run a block of code as user "roger" and group "developer":
     puts "Hello world"
   end
   
+Alternatively, you can use the uid and gid directly:
+  Masquerade.as :user => 509, :group => 1009 do
+    puts "Hello world"
+  end
+  
 The block of code accepts the user hash as a paramter. So you can do things like:
   Masquerade.as :user => "roger", :group => "developer" do |user_info|
-    puts "Hello world #user_info[:user]"
+    puts "Hello #{user_info[:user]}"
+  end
+  
+Both :user and :group params are optional and you can choose to give one of the two or both:
+  Masquerade.as :user => "roger" do |user_info|
+    puts "Hello #{user_info[:user]}"
   end
   
-Both :user and :group params are optional and you can choose to give one or the two or both.
-
 === Exceptions thrown
 ==== Masquerade::PermissionsError
 
@@ -29,31 +37,53 @@ If the user running the script does not have the privileges to masquerade as the
     
 ==== Masquerade::BadUserOrGroupError
 If the given user or group does not exist
+
+=== Return value
+
+Returns the result of the block call. So you can do:
+  response = Masquerade.as :user => "roger", :group => "developer" do |user_info|
+    "Hello world #{user_info[:user]}"
+  end
 =end
 module Masquerade
   def self.as(who, &block)
     begin
       current_uid = Process.uid
       current_gid = Process.gid
-      # get user info by name
       if who.include?(:user)
-        user_struct = Etc.getpwnam(who[:user])
+        user_struct = nil
+        if who[:user].kind_of? String
+          # get user info by name
+          user_struct = Etc.getpwnam(who[:user])
+        elsif who[:user].kind_of? Numeric
+          # get user info by uid
+          user_struct = Etc.getpwuid(who[:user])
+        end
         # set the uid of the current process to that of the chosen user
         Process.uid = user_struct.uid
       end
       if who.include?(:group)
-        group_struct = Etc.getgrnam(who[:group])
+        group_struct = nil
+        if who[:group].kind_of? String
+          # get group info by name
+          group_struct = Etc.getgrnam(who[:group])
+        elsif who[:group].kind_of? Numeric
+          # get group info by gid
+          group_struct = Etc.getgrgid(who[:group])
+        end
+        # set the gid of the current process to that of the chosen group
         Process.gid = group_struct.gid
       end
       # run the block
-      block.call(who)
+      response = block.call(who)
       # restore process uid and gid
       Process.uid = current_uid
       Process.gid = current_gid
+      return response
     rescue Errno::EPERM
       raise PermissionsError, "You do not have permissions to impersonate this user or group"
     rescue ArgumentError
-      raise BadUserOrGroupError, "The user or group name does not exist"
+      raise BadUserOrGroupError, "The user or group does not exist"
     end
   end
   

data/masquerade.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{masquerade}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nitesh Goel"]
   s.date = %q{2011-04-14}
   s.description = %q{A user/group impersonator}
   s.email = %q{nitesh@wikinvest.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/masquerade.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/masquerade.rb", "masquerade.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc", "lib/masquerade.rb"]
+  s.files = ["CHANGELOG.rdoc", "Manifest", "README.rdoc", "Rakefile", "lib/masquerade.rb", "masquerade.gemspec"]
   s.homepage = %q{http://rubygems.org/gems/masquerade}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Masquerade", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: masquerade
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nitesh Goel
@@ -25,9 +25,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG.rdoc
 - README.rdoc
 - lib/masquerade.rb
 files: 
+- CHANGELOG.rdoc
 - Manifest
 - README.rdoc
 - Rakefile