ood_support 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ab9a0231c41e21de5992f0ae3bcf0be3ed19638
+  data.tar.gz: fce3ab5ef3dc87c42cb8a8af09136aa80705ed7e
+SHA512:
+  metadata.gz: 0611200202ea6a276b89927499a45c130d54a06d5a6eb865bcf2c413ddefa85458ea3cb887f639e3dea7d8b1a8616d5cdf27dec54b05f8a3a834cf8a86f51878
+  data.tar.gz: 98f312e86afbe33ea1b6d1b5d1e9830feb10a28e149d3cfdbe7692744a7280397b2d2911f55b946daea9cc17a6ebc5ba25cf0e27bf8c0f5843261cdb9d8ef38e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ood_support.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2016 Ohio Supercomputer Center
+
+MIT License
+
+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.md

@@ -0,0 +1,165 @@
+# OodSupport
+
+Open OnDemand gem that provides a set of support objects to interface with the
+local OS installed on the HPC Center's web node.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ood_support'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ood_support
+
+## Usage
+
+### User
+
+Provides a simplified system-level user object that can be used to determine
+user's id, groups, shell, home directory...
+
+```ruby
+require 'ood_support'
+
+# Generate OodSupport::User object from user name
+u = OodSupport::User.new 'user1'
+
+# User name
+u.name
+#=> "user1"
+
+# User id
+u.id
+#=> 1000
+
+# User shell
+u.shell
+#=> "/bin/bash"
+
+# Array of groups user is in
+u.groups
+#=> [<OodSupport::Group ...>, <OodSupport::Group ...>, ...]
+
+# Names of groups user is in
+u.groups.map(&:name)
+#=> ["primary_group", "group1", "group2"]
+
+# Name of user's primary group
+u.group.name
+#=> "primary_group"
+
+# Whether user is in group called "group15"
+u.in_group? "group15"
+#=> false
+
+# Use it in a string
+puts "Hello #{u}!"
+#=> "Hello user1!"
+```
+
+You can generate the `OodSupport::User` object from a user name, user id,
+another `OodSupport::User`, or from the running process:
+
+```ruby
+require 'ood_support'
+
+# Generate OodSupport::User object from user name
+u1 = OodSupport::User.new 'user1'
+
+# Generate OodSupport::User object from user id
+u2 = OodSupport::User.new 1000
+
+# Generate OodSupport::User object from another object
+u3 = OodSupport::User.new u1
+
+# Generate OodSupport::User from running process
+me = OodSupport::User.new
+```
+
+### Group
+
+Provides a simplified system-level group object that can be used to determine
+group id and group name.
+
+```ruby
+require 'ood_support'
+
+# Generate OodSupport::Group object from group name
+g = OodSupport::Group.new 'group1'
+
+# Get group id
+g.id
+#=> 100
+
+# Get group name
+g.name
+#=> 'group1'
+
+# Generate OodSupport::User object from user name
+u = OodSupport::User.new 'user1'
+
+# Sort the list of groups user is in
+u.groups.sort.map(&:name)
+#=> ["a_group", "b_group", "c_group"]
+```
+
+You can generate the `OodSupport::Group` object from a group name, group id,
+another `OodSupport::Group` object, or from the running process:
+
+```ruby
+require 'ood_support'
+
+# Generate OodSupport::Group object from group name
+g1 = OodSupport::Group.new 'group1'
+
+# Generate OodSupport::Group object from group id
+g2 = OodSupport::Group.new 100
+
+# Generate OodSupport::Group object from another object
+g3 = OodSupport::Group.new g1
+
+# Generate OodSupport::Group from running process
+me = OodSupport::Group.new
+```
+
+### Process
+
+Provides a simplified interface to the running process that can be used to
+determine owner of the process as well as whether the owner's groups have
+changed since the process started.
+
+```ruby
+require 'ood_support'
+
+# Get owner of process
+OodSupport::Process.user
+#=> <OodSupport::User ...>
+
+# Get primary group of process
+OodSupport::Process.group
+#=> <OodSupport::Group ...>
+
+# Get list of groups process is currently in
+OodSupport::Process.groups
+#=> [<OodSupport::Group ...>, <OodSupport::Group ...>, ...]
+
+# Whether owner's groups changed since process started
+OodSupport::Process.groups_changed?
+#=> false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ood_support/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ood_support.rb

@@ -0,0 +1,9 @@
+require 'ood_support/version'
+require 'ood_support/user'
+require 'ood_support/group'
+require 'ood_support/process'
+
+# The main namespace for ood_support
+module OodSupport
+  # Your code goes here...
+end

data/lib/ood_support/group.rb

@@ -0,0 +1,54 @@
+require 'etc'
+
+module OodSupport
+  # A helper object describing a Unix group's details
+  class Group
+    include Comparable
+
+    # The id of the group
+    # @return [Fixnum] the group id
+    attr_reader :id
+
+    # The name of the group
+    # @return [String] the group name
+    attr_reader :name
+
+    # @param group [Fixnum, #to_s] the group id or name
+    def initialize(group = Process.group)
+      if group.is_a?(Fixnum)
+        @id = group
+        @name = Etc.getgrgid(@id).name
+      else
+        @name = group.to_s
+        @id = Etc.getgrnam(@name).gid
+      end
+    end
+
+    # The comparison operator for sorting values
+    # @param other [Group] group to compare against
+    # @return [Fixnum] how groups compare
+    def <=>(other)
+      name <=> other
+    end
+
+    # Checks whether two Group objects have the same group as well as that the
+    # object is in the Group class
+    # @param other [Group] group to compare against
+    # @return [Boolean] whether same objects
+    def eql?(other)
+      other.is_a?(Group) && id == other.id
+    end
+
+    # Generates a hash value for this object
+    # @return [Fixnum] hash value of object
+    def hash
+      id.hash
+    end
+
+    # Convert object to string using group name as string value
+    # @return [String] the group name
+    def to_s
+      name
+    end
+  end
+end

data/lib/ood_support/process.rb

@@ -0,0 +1,28 @@
+module OodSupport
+  # A helper module that describes the current running process
+  module Process
+    # Owner of current process
+    # @return [User] owner of process
+    def self.user
+      User.new ::Process.uid
+    end
+
+    # Primary group of current process
+    # @return [Group] group of process
+    def self.group
+      Group.new ::Process.gid
+    end
+
+    # List of groups current process is in
+    # @return [Array<Group>] list of groups for process
+    def self.groups
+      ::Process.groups.map {|g| Group.new g}
+    end
+
+    # Whether user's groups changed since running process
+    # @return [Boolean] whether groups changed
+    def self.groups_changed?
+      groups.sort != user.groups.sort
+    end
+  end
+end

data/lib/ood_support/user.rb

@@ -0,0 +1,89 @@
+require 'forwardable'
+require 'etc'
+
+module OodSupport
+  # A helper object used to query information about a system user from the
+  # local host
+  class User
+    include Comparable
+
+    extend Forwardable
+
+    # @!method name
+    #   The user name
+    #   @return [String] the user name
+    # @!method uid
+    #   The user's id
+    #   @return [Integer] the user id
+    # @!method gecos
+    #   The user's real name
+    #   @return [String] the real name
+    # @!method dir
+    #   The user's home directory
+    #   @return [String] the home path
+    # @!method shell
+    #   The user's shell
+    #   @return [String] the shell
+    delegate [:name, :uid, :gecos, :dir, :shell] => :@passwd
+
+    alias_method :id, :uid
+
+    # @param user [Fixnum, #to_s] user id or name
+    def initialize(user = Process.user)
+      @passwd = user.is_a?(Fixnum) ? Etc.getpwuid(user) : Etc.getpwnam(user.to_s)
+    end
+
+    # Determine whether user is part of specified group
+    # @param group [Group] group to check
+    # @return [Boolean] whether user is in group
+    def in_group?(group)
+      groups.include? Group.new(group)
+    end
+
+    # Provide primary group of user
+    # @return [Group] primary group of user
+    def group
+      groups.first
+    end
+
+    # List of all groups that user belongs to
+    # @return [Array<String>] list of groups user is in
+    def groups
+      @groups ||= get_groups
+    end
+
+    # The comparison operator for sorting values
+    # @param other [User] user to compare against
+    # @return [Fixnum] how users compare
+    def <=>(other)
+      name <=> other
+    end
+
+    # Checks whether two User objects have the same user as well as that the
+    # object is in the User class
+    # @param other [User] user to compare against
+    # @return [Boolean] whether same objects
+    def eql?(other)
+      other.is_a?(User) && id == other.id
+    end
+
+    # Generates a hash value for this object
+    # @return [Fixnum] hash value of object
+    def hash
+      id.hash
+    end
+
+    # Convert object to string using user name as string value
+    # @return [String] the user name
+    def to_s
+      name
+    end
+
+    private
+      # Use `id` to get list of groups as the /etc/group file can give
+      # erroneous results
+      def get_groups
+        `id -G #{name}`.split(' ').map {|g| Group.new(g.to_i)}
+      end
+  end
+end

data/lib/ood_support/version.rb

@@ -0,0 +1,4 @@
+module OodSupport
+  # The current version of {OodSupport}
+  VERSION = "0.0.1"
+end

data/ood_support.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ood_support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ood_support"
+  spec.version       = OodSupport::VERSION
+  spec.authors       = ["Jeremy Nicklas"]
+  spec.email         = ["jnicklas@osc.edu"]
+  spec.summary       = %q{Open OnDemand gem that adds useful support methods for an HPC Center.}
+  spec.description   = %q{Provides an interface to working with the local OS installed on the HPC Center's web node.}
+  spec.homepage      = "https://github.com/OSC/ood_support"
+  spec.license       = "MIT"
+
+  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"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: ood_support
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Nicklas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-01 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'
+description: Provides an interface to working with the local OS installed on the HPC
+  Center's web node.
+email:
+- jnicklas@osc.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ood_support.rb
+- lib/ood_support/group.rb
+- lib/ood_support/process.rb
+- lib/ood_support/user.rb
+- lib/ood_support/version.rb
+- ood_support.gemspec
+homepage: https://github.com/OSC/ood_support
+licenses:
+- MIT
+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.5
+signing_key: 
+specification_version: 4
+summary: Open OnDemand gem that adds useful support methods for an HPC Center.
+test_files: []
+has_rdoc: