ood_appkit 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a1328957b24d5ff03aaab0577ec558ad693c160
-  data.tar.gz: 876a61e1e54f9cd39b7b9dc8cf9a10ef7e2084a5
+  metadata.gz: b6fbe94cce7c92a5b9ccf234d59a65c42a25af6d
+  data.tar.gz: 48b20a943231ce1ddcd150d482a9c84ede36a22d
 SHA512:
-  metadata.gz: 12a2d748aaa83712d0124093127f076488004eb84b5512f5eaa86d1ba2a4a739fe46e13c3c2f87285870e4b50199627e8fe5bc885f1ca5986c3ad8f831ba415e
-  data.tar.gz: 099456dd100204ef4bee14eda20537af1962b3c72ff54f6360ac4979cabc7f939ddc7fa6c69e5bb82d39ece628b883b4ad5a1162d1bae8ead38078bf23d74fd6
+  metadata.gz: e2b6601dbd55a03f526802e8c88e9104dbf43939b49fc10c09b649e5d23143d858c5b2520e6b3993f743fe33fdc394f55f0b6582304ce3d28fd45bee0e3355a0
+  data.tar.gz: f4052ec287e187c7c7469309c60aa7a40193538cf1b0306bedb0ac9efc7caf23fc42f1a8a1cd0824470d4a596946587f8d70682f7ad9829d4ae72ec18cc32dde

data/README.md

@@ -448,119 +448,141 @@ breadcrumbs style will resemble the `navbar-brand` style.
 
 ### Cluster Information
 
-A hash of available clusters is accessible from this gem through:
+Access to a list of clusters defined by the system administrator on a given
+host is done through:
 
 ```ruby
-# Hash of all available clusters
-OodAppkit.clusters.all
-#=> {
-#     cluster1: <OodAppkit::Cluster ...>,
-#     cluster2: <OodAppkit::Cluster ...>,
-#     ...
-#   }
-
-# Hash of all available High Performance Computing (hpc) clusters
-OodAppkit.clusters.hpc
-#=> {
-#     cluster1: <OodAppkit::Cluster ...>,
-#     cluster2: <OodAppkit::Cluster ...>,
-#     ...
-#   }
-
-# Hash of all available Low Performance Computing (hpc) clusters
-# NB: A low performance computing cluster expects jobs that request a single
-#     core and use minimal resources (e.g., a desktop for file browsing/editing,
-#     a web server that submits jobs to an HPC cluster, visualization software)
-OodAppkit.clusters.lpc
-#=> {
-#     cluster3: <OodAppkit::Cluster ...>,
-#     cluster4: <OodAppkit::Cluster ...>,
-#     ...
-#   }
-```
+# An enumerable list of clusters
+OodAppkit.clusters
+#=> #<OodAppkit::Clusters>
 
-Each cluster object will have servers that the developer can communicate with
-or link to:
+# Create list of cluster titles
+OodAppkit.clusters.map(&:title)
+#=> ["My Cluster", "Tiny Cluster", "Big Cluster"]
 
-```ruby
-# Choose cluster from available list
-my_cluster = OodAppkit.clusters.hpc[:cluster1]
+# Count number of clusters available
+OodAppkit.clusters.count
+#=> 3
 
-# Check if it has a login server
-my_cluster.login_server?
+# Check if cluster called "tiny_cluster" exists
+OodAppkit.clusters.include? :tiny_cluster
 #=> true
+```
 
-# View all available servers
-my_cluster.servers
-#=> {
-#     login: <OodAppkit::Server ...>,
-#     resource_mgr: <OodAppkit::Servers::Torque ...>,
-#     scheduler: <OodAppkit::Servers::Moab ...>,
-#     ...
-#   }
+You can access a given cluster with id `my_cluster` by:
+
+```ruby
+# Get object describing my HPC center's `my_cluster`
+OodAppkit.clusters[:my_cluster]
+#=> #<OodAppkit::ClusterDecorator>
 
-# Choose a particular server
-login_server = my_cluster.login_server
+# or...
+OodAppkit.clusters["my_cluster"]
+#=> #<OodAppkit::ClusterDecorator>
+
+# Trying to access a non-existant cluster
+OodAppkit.clusters[:invalid_cluster]
+#=> nil
 ```
 
-Depending on the type of server chosen, different helper methods will be
-available to the developer. For all servers the `host` will be available:
+A cluster object comes with some pre-defined helper methods to help you find
+the cluster that meets your needs:
 
 ```ruby
-# Choose a particular server
-login_server = my_cluster.login_server
+# Get the cluster of our choosing
+my_cluster = OodAppkit.clusters[:my_cluster]
+
+# Is this cluster valid (can I the user access the servers provided by it?)
+my_cluster.valid?
+#=> true
+
+# Is this cluster considered a High Performance Computing (hpc) cluster?
+# NB: A low performance computing cluster expects jobs that request a single
+#     core and use minimal resources (e.g., a desktop for file browsing/editing,
+#     a web server that submits jobs to an HPC cluster, visualization software)
+my_cluster.hpc_cluster?
+#=> false
 
-# Get host for this server
-login_server.host
-#=> "my_cluster.hpc_center.edu"
+# ID of cluster object to find again in OodAppkit.clusters
+my_cluster.id #=> :my_cluster
+
+# URL of cluster
+my_cluster.url #=> "https://hpc.center.edu/clusters/my_cluster"
+
+# Check if it has a login server
+my_cluster.login_server? #=> true
+
+# Access login server object
+my_cluster.login_server
+#=> #<OodCluster::Servers::Ssh>
 ```
 
-The Torque/Moab servers will also supply information for the clients used to
-communicate with the servers
+As this object is an `Enumerable` you can create subsets of clusters that your
+app only cares for in an initializer:
 
 ```ruby
-# Get the Resource Manager server (known to be Torque at your HPC center)
-torque_server = my_cluster.resource_mgr_server
+# I only want clusters that are valid for the currently running user
+valid_clusters = OodAppkit::Clusters.new(
+  OodAppkit.clusters.select(&:valid?)
+)
+#=> #<OodAppkit::Clusters>
 
-# Get the path to the client library
-torque_server.lib.to_s
-#=> "/usr/local/torque/x.x.x/lib"
+# Create list of cluster titles from these valid clusters
+valid_clusters.map(&:title)
+#=> ["My Cluster"]
 
-# Get the path to the client binaries
-torque_server.bin.to_s
-#=> "/usr/local/torque/x.x.x/bin"
+# I only want HPC clusters that I can submit solver jobs to
+hpc_clusters = OodAppkit::Clusters.new(
+  OodAppkit.clusters.select(&:hpc_cluster?)
+)
 ```
 
-Web servers will have a URI method to access the server
+Depending on the type of server chosen, different helper methods will be
+available to the developer. You can find more details on this at
+https://github.com/OSC/ood_cluster.
+
+#### Reservations
+
+If reservations are supported for the chosen cluster, then a cluster object can
+be used to query reservation information for the current user:
 
 ```ruby
-# Get the Ganglia web server
-ganglia_server = my_cluster.ganglia_server
+# Check if reservation query object is valid (am I allowed to use it)
+# NB: Definitely use this as some users may be privileged and have access to
+#     view ALL reservations. This can cause the app to hang.
+my_cluster.valid?(:rsv_query) #=> true
+
+# Get reservation query object
+my_rsv_query = my_cluster.rsv_query
+#=> #<OodReservations::Queries::TorqueMoab>
 
-# Get URI used to access this web server
-ganglia_server.uri.to_s
-#=> "https://www.ganglia.com/gweb/graph.php?c=MyCluster"
+# Try to get reservation query object from cluster that doesn't support
+# reservations
+cluster_with_no_rsvs.rsv_query
+#=> nil
 
-# To add query values as options for the server
-ganglia_server.uri(query_values: {g: 'cpu_report'}).to_s
-#=> "https://www.ganglia.com/gweb/graph.php?c=MyCluster&g=cpu_report"
+# Get all reservations I have on this cluster
+my_rsv_query.reservations
+#=> [ #<OodReservations::Reservation>, ... ]
 ```
 
-The hash of clusters generated by OodAppkit can be modified by supplying a
+You can learn more about the reservation query object by visiting
+https://github.com/OSC/ood_reservations.
+
+#### Configuration
+
+The list of clusters generated by OodAppkit can be modified by supplying a
 different config file through the environment variable `OOD_CLUSTERS`
 
-```
+```sh
 OOD_CLUSTERS="/path/to/my/config.yml"
 ```
 
-or by modifying the configuration in an initializer
-
-```ruby
-# config/initializers/ood_appkit.rb
+Or a directory with aptly named configuration files (name of file is id of
+cluster):
 
-OodAppkit.configure do |config|
-  config.clusters.cache = OodAppkit::Cluster.all(file: "/path/to/my/config.yml")
-end
+```sh
+OOD_CLUSTERS="/path/to/configs.d"
 ```
 
 ## Develop

data/lib/ood_appkit/cluster_decorator.rb

@@ -0,0 +1,53 @@
+require 'ood_cluster'
+require 'ood_reservations'
+
+module OodAppkit
+  # A decorator that adds a presentation layer to the {OodCluster::Cluster} object
+  class ClusterDecorator < SimpleDelegator
+    # The identifier used as the key in the OodAppkit clusters hash (used for
+    # reverse searching)
+    # @return [Symbol] the clusters hash key for this object
+    attr_reader :id
+
+    # The title used to describe this cluster to users
+    # @return [String] the cluster title
+    attr_reader :title
+
+    # The URL for this cluster that users can use to view more information
+    # @return [String] the cluster url
+    attr_reader :url
+
+    # @param cluster [OodCluster::Cluster] cluster object
+    # @param id [#to_sym] id used in clusters hash of OodAppkit
+    # @param title [#to_s] title of cluster
+    # @param url [#to_s] url of cluster
+    # @param validators [Hash{#to_sym=>Array<Validator>}] hash of validators
+    def initialize(cluster:, id:, title: "", url: "", validators: {}, **_)
+      super(cluster)
+      @id         = id.to_sym
+      @title      = title.to_s
+      @url        = url.to_s
+      @validators = validators.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+    end
+
+    # Whether the given method is valid (i.e., passes all supplied validators)
+    # @param method [#to_sym] method to check if valid
+    # @return [Boolean] whether this method is valid
+    def valid?(method = :cluster)
+      @validators.fetch(method.to_sym, []).all? { |v| v.success? }
+    end
+
+    # A reservation query object used to query reservations for current user
+    # @return [OodReservations::Query,nil] reservation query object
+    def rsv_query
+      OodReservations::Query.build(cluster: self)
+    end
+
+    # The comparison operator
+    # @param other [#to_sym] object to compare against
+    # @return [Boolean] whether objects are equivalent
+    def ==(other)
+      id == other.to_sym
+    end
+  end
+end

data/lib/ood_appkit/clusters.rb

@@ -0,0 +1,24 @@
+module OodAppkit
+  # An enumerable that holds a list of {ClusterDecorator} objects
+  class Clusters
+    include Enumerable
+
+    # @param clusters [Array<ClusterDecorator>] list of cluster decorator objects
+    def initialize(clusters = [])
+      @clusters = clusters
+    end
+
+    # Find object in list from object's id
+    # @param id [Object] id of cluster decorator object
+    # @return [ClusterDecorator, nil] object if found
+    def [](id)
+      @clusters.detect { |v| v == id }
+    end
+
+    # Iterate over each of the clusters
+    # @yield [obj] cluster decorator objects
+    def each(&block)
+      @clusters.each(&block)
+    end
+  end
+end

data/lib/ood_appkit/config_parser.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+require 'json'
+
+module OodAppkit
+  # Helper methods for parsing/deserializing yml configuration files
+  module ConfigParser
+    # Specific version hash in the yaml file to parse
+    YAML_VERSION = 'v1'
+
+    # Identifier used to distinguish class names when deserializing
+    CLASS_ID = 'type'
+
+    # Exception raise when unable to access config file or directory
+    class InvalidConfigPath < StandardError; end
+
+    # Parse/deserialize a configuration file or a set of configuration files
+    # @param config [#to_s] configuration file or directory
+    # @raise [InvalidConfigPath] if config path is inaccessible
+    # @return [Hash] hash of deserialized config file
+    def self.parse(config:)
+      # use 'type' to distinguish class name in yaml file
+      JSON.create_id = CLASS_ID
+
+      config = Pathname.new(config.to_s).expand_path
+      if config.file?
+        parse_file config
+      elsif config.directory?
+        config.children.each_with_object({}) do |f, h|
+          /^(.+)\.yml$/.match(f.basename.to_s) { h[$1.to_sym] = parse_file(f) }
+        end
+      else
+        raise InvalidConfigPath, "invalid config path: #{config}"
+      end
+    end
+
+    private
+      # Parse a single yaml file
+      def self.parse_file(file)
+        JSON.load(JSON.dump(YAML.load(File.read(file.to_s))[YAML_VERSION])).deep_symbolize_keys
+      end
+  end
+end

data/lib/ood_appkit/configuration.rb

@@ -65,22 +65,11 @@ module OodAppkit
       self.dataroot = ENV['OOD_DATAROOT'] || ENV['RAILS_DATAROOT']
 
       # Initialize list of available clusters
-      # FIXME: use "/etc/ood/config/..." in the future
-      # FIXME: use `ood_cluster` gem instead in the future
-      self.clusters = OpenStruct.new(
-        cache: OodAppkit::Cluster.all(
-          file: ENV['OOD_CLUSTERS'] || File.expand_path('../../../config/clusters.yml', __FILE__)
-        )
+      self.clusters = Clusters.new(
+        ConfigParser.parse(
+          config: ENV['OOD_CLUSTERS'] || Pathname.new('/etc/ood/config/clusters.d')
+        ).map { |k, v| ClusterDecorator.new(id: k.to_sym, **v) }
       )
-      def clusters.all
-        cache
-      end
-      def clusters.hpc
-        all.select {|k,v| v.hpc_cluster?}
-      end
-      def clusters.lpc
-        all.reject {|k,v| v.hpc_cluster?}
-      end
 
       # Add markdown template support
       self.markdown = Redcarpet::Markdown.new(

data/lib/ood_appkit/validator.rb

@@ -0,0 +1,25 @@
+module OodAppkit
+  class Validator
+    # Deserialize a validator object from JSON
+    # @param object [Hash{#to_sym=>Object}] hash used defining context
+    # @return [self] deserialized object
+    def self.json_create(object)
+      new object["data"].each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+    end
+
+    def initialize(**_)
+    end
+
+    # Whether this validation was successful
+    # @return [Boolean] whether successful
+    def success?
+      true
+    end
+
+    # Whether this validation was a failure
+    # @return [Boolean] whether failure
+    def failure?
+      !success?
+    end
+  end
+end

data/lib/ood_appkit/validators/groups.rb

@@ -3,17 +3,36 @@ require 'ood_support'
 module OodAppkit
   module Validators
     # Class used to determine if user is in valid list of groups
-    class Groups
-      # @param groups [Array<String>] list of groups
-      def initialize(groups:, **_)
-        @groups = [*groups].map {|g| OodSupport::Group.new g}
+    class Groups < Validator
+      # @param groups [Array<#to_s>] list of groups
+      # @param allow [Boolean] whether these groups are allowed access
+      def initialize(groups: [], allow: true, **kwargs)
+        super(kwargs)
+        @groups = groups.map(&:to_s)
+        @allow = allow
       end
 
-      # Whether user is in a valid group
-      # @return [Boolean] whether in a valid group
-      def valid?
-        !(@groups & OodSupport::User.new.groups).empty?
+      # Whether this validation was successful
+      # @return [Boolean] whether successful
+      def success?
+        @allow ? in_user_groups?(@groups) : not_in_user_groups?(@groups)
       end
+
+      private
+        # List of groups user is in
+        def user_groups
+          OodSupport::User.new.groups.map(&:to_s)
+        end
+
+        # Whether any groups match user's groups
+        def in_user_groups?(groups)
+          !(groups & user_groups).empty?
+        end
+
+        # Whether groups don't correspond with any user group
+        def not_in_user_groups?(groups)
+          !in_user_groups?(groups)
+        end
     end
   end
 end

data/lib/ood_appkit/version.rb

@@ -1,4 +1,4 @@
 module OodAppkit
   # The current version of OodAppkit
-  VERSION = "0.2.8"
+  VERSION = "0.3.0"
 end

data/lib/ood_appkit.rb

@@ -1,13 +1,13 @@
-require 'addressable'
-
 require 'ood_appkit/version'
 require 'ood_appkit/configuration'
 require 'ood_appkit/url'
 require 'ood_appkit/files_rack_app'
 require 'ood_appkit/markdown_template_handler'
 require 'ood_appkit/log_formatter'
-require 'ood_appkit/cluster'
-require 'ood_appkit/server'
+require 'ood_appkit/config_parser'
+require 'ood_appkit/cluster_decorator'
+require 'ood_appkit/clusters'
+require 'ood_appkit/validator'
 
 # The main namespace for OodAppkit. Provides a global configuration.
 module OodAppkit
@@ -23,13 +23,6 @@ module OodAppkit
     require 'ood_appkit/urls/editor'
   end
 
-  # A namespace to hold all subclasses of {Server}
-  module Servers
-    require 'ood_appkit/servers/torque'
-    require 'ood_appkit/servers/moab'
-    require 'ood_appkit/servers/ganglia'
-  end
-
   # A namespace for validators used to validate a cluster
   module Validators
     require 'ood_appkit/validators/groups'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ood_appkit
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Eric Franz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.7
 - !ruby/object:Gem::Dependency
   name: ood_support
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +44,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ood_cluster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ood_reservations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -114,25 +148,23 @@ files:
 - app/controllers/concerns/ood_appkit/wiki_page.rb
 - app/controllers/ood_appkit/wiki_controller.rb
 - app/views/ood_appkit/wiki/show.html.erb
-- config/clusters.yml
 - config/routes.rb
 - lib/ood_appkit.rb
-- lib/ood_appkit/cluster.rb
+- lib/ood_appkit/cluster_decorator.rb
+- lib/ood_appkit/clusters.rb
+- lib/ood_appkit/config_parser.rb
 - lib/ood_appkit/configuration.rb
 - lib/ood_appkit/engine.rb
 - lib/ood_appkit/files_rack_app.rb
 - lib/ood_appkit/log_formatter.rb
 - lib/ood_appkit/markdown_template_handler.rb
-- lib/ood_appkit/server.rb
-- lib/ood_appkit/servers/ganglia.rb
-- lib/ood_appkit/servers/moab.rb
-- lib/ood_appkit/servers/torque.rb
 - lib/ood_appkit/url.rb
 - lib/ood_appkit/urls/dashboard.rb
 - lib/ood_appkit/urls/editor.rb
 - lib/ood_appkit/urls/files.rb
 - lib/ood_appkit/urls/public.rb
 - lib/ood_appkit/urls/shell.rb
+- lib/ood_appkit/validator.rb
 - lib/ood_appkit/validators/groups.rb
 - lib/ood_appkit/version.rb
 - lib/tasks/ood_appkit_tasks.rake
@@ -184,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/config/clusters.yml

@@ -1,112 +0,0 @@
-v1:
-  oakley:
-    title: 'Oakley'
-    servers:
-      login:
-        type: 'OodAppkit::Server'
-        host: 'oakley.osc.edu'
-      resource_mgr:
-        type: 'OodAppkit::Servers::Torque'
-        host: 'oak-batch.osc.edu'
-        prefix: '/usr/local/torque/5.1.1-1_fba25d92'
-        version: '5.1.1'
-      scheduler:
-        type: 'OodAppkit::Servers::Moab'
-        host: 'oak-batch.osc.edu'
-        prefix: '/usr/local/moab/8.1.1.2-2015080516-eb28ad0-el6'
-        version: '8.1.1'
-        moabhomedir: '/var/spool/batch/moab'
-      ganglia:
-        type: 'OodAppkit::Servers::Ganglia'
-        host: 'cts05.osc.edu'
-        scheme: 'https://'
-        segments:
-          - 'gweb'
-          - 'graph.php'
-        req_query:
-          c: 'Oakley nodes'
-        opt_query:
-          h: '%{h}.ten.osc.edu'
-        version: '3'
-  ruby:
-    title: 'Ruby'
-    validators:
-      in_valid_groups:
-        type: 'OodAppkit::Validators::Groups'
-        groups:
-          - 'ruby'
-    servers:
-      login:
-        type: 'OodAppkit::Server'
-        host: 'ruby.osc.edu'
-      resource_mgr:
-        type: 'OodAppkit::Servers::Torque'
-        host: 'ruby-batch.osc.edu'
-        prefix: '/usr/local/torque/5.1.1-1_fba25d92'
-        version: '5.1.1'
-      scheduler:
-        type: 'OodAppkit::Servers::Moab'
-        host: 'ruby-batch.osc.edu'
-        prefix: '/usr/local/moab/8.1.1.2-2015080516-eb28ad0-el6'
-        version: '8.1.1'
-        moabhomedir: '/var/spool/batch/moab'
-      ganglia:
-        type: 'OodAppkit::Servers::Ganglia'
-        host: 'cts05.osc.edu'
-        scheme: 'https://'
-        segments:
-          - 'gweb'
-          - 'graph.php'
-        req_query:
-          c: 'Ruby'
-        opt_query:
-          h: '%{h}.ten.osc.edu'
-        version: '3'
-  owens:
-    title: 'Owens'
-    validators:
-      in_valid_groups:
-        type: 'OodAppkit::Validators::Groups'
-        groups:
-          - 'owens'
-          - 'oscsys'
-          - 'hpcsys'
-          - 'sysp'
-          - 'appl'
-          - 'oscgen'
-          - 'hpcsoft'
-          - 'oscadm'
-    servers:
-      login:
-        type: 'OodAppkit::Server'
-        host: 'owens.hpc.osc.edu'
-      ganglia:
-        type: 'OodAppkit::Servers::Ganglia'
-        host: 'cts05.osc.edu'
-        scheme: 'https://'
-        segments:
-          - 'gweb'
-          - 'graph.php'
-        req_query:
-          c: 'Owens'
-        opt_query:
-          h: '%{h}.ten.osc.edu'
-        version: '3'
-  quick:
-    title: 'Quick'
-    hpc_cluster: false
-    servers:
-      resource_mgr:
-        type: 'OodAppkit::Servers::Torque'
-        host: 'quick-batch.osc.edu'
-        prefix: '/usr/local/torque/5.1.1-1_fba25d92'
-        version: '5.1.1'
-        sub_cluster:
-          - 'ruby'
-          - 'oakley'
-      scheduler:
-        type: 'OodAppkit::Servers::Moab'
-        host: 'quick-batch.osc.edu'
-        prefix: '/usr/local/moab/8.1.1.2-2015080516-eb28ad0-el6'
-        version: '8.1.1'
-        moabhomedir: '/var/spool/batch/moab'

data/lib/ood_appkit/cluster.rb

@@ -1,102 +0,0 @@
-require 'yaml'
-
-module OodAppkit
-  # An object that describes a given cluster of nodes used by an HPC center
-  class Cluster
-    # YAML configuration version
-    VERSION = :v1
-
-    # Unique ID of the cluster
-    # @return [Symbol] id of cluster
-    attr_reader :id
-
-    # Title of the cluster
-    # @return [String] title of cluster
-    attr_reader :title
-
-    # Hash of validators this cluster validates against
-    # @return [Hash<#valid?>] hash of validators
-    attr_reader :validators
-
-    # Hash of servers this cluster supports
-    # @return [Hash<Server>] hash of servers
-    attr_reader :servers
-
-    # A list of accessible clusters for the currently running user
-    # @param file [String] yaml file with cluster configurations
-    # @param force [Boolean] whether we force invalid clusters to be included as well
-    # @return [Hash<Cluster>] list of clusters user has access to
-    def self.all(file: File.expand_path('../../../config/clusters.yml', __FILE__), force: false)
-      parse_config(file).each_with_object({}) do |(k, v), h|
-        c = Cluster.new v.merge(id: k)
-        h[k] = c if c.valid? || force
-      end
-    end
-
-    # @param id [Symbol] id of cluster
-    # @param title [String] title of cluster
-    # @param validators [Hash] hash of validations that describe the validators
-    # @param servers [Hash] hash of servers with corresponding server info
-    # @param hpc_cluster [Boolean] whether this is an hpc-style cluster
-    def initialize(id:, title:, validators: {}, servers: {}, hpc_cluster: true)
-      # Set id & title of cluster
-      @id = id
-      @title = title
-
-      # Generate hash of validations
-      @validators = validators.each_with_object({}) do |(k, v), h|
-        h[k] = v[:type].constantize.new(v)
-      end
-
-      # Generate hash of servers
-      @servers = servers.each_with_object({}) do |(k, v), h|
-        h[k] = v[:type].constantize.new(v)
-      end
-
-      # Is this an hpc-style cluster?
-      @hpc_cluster = hpc_cluster
-    end
-
-    # Whether this is a valid cluster
-    # @example Whether I have access to this cluster
-    #   my_cluster.valid?
-    #   #=> true
-    # @return [Boolean] whether user has access to this cluster
-    def valid?
-      !@validators.any? {|name, validator| !validator.valid?}
-    end
-
-    # Whether this is an hpc-style cluster (i.e., meant for heavy computation)
-    # @return [Boolean] whether this an hpc-style cluster
-    def hpc_cluster?
-      @hpc_cluster
-    end
-
-    # Grab object from {@servers} hash or check if it exists
-    # @param method_name the method name called
-    # @param arguments the arguments to the call
-    # @param block an optional block for the call
-    def method_missing(method_name, *arguments, &block)
-      if /^(.+)_server$/ =~ method_name.to_s
-        @servers.fetch($1.to_sym, nil)
-      elsif /^(.+)_server\?$/ =~ method_name.to_s
-        @servers.has_key? $1.to_sym
-      else
-        super
-      end
-    end
-
-    # Check if method ends with custom *_server or *_server?
-    # @param method_name the method name to check
-    # @return [Boolean]
-    def respond_to_missing?(method_name, include_private = false)
-      method_name.to_s.end_with?('_server', '_server?') || super
-    end
-
-    private
-      # Parse the config file
-      def self.parse_config(file)
-        YAML.load(File.read(file)).deep_symbolize_keys.fetch(VERSION, {})
-      end
-  end
-end

data/lib/ood_appkit/server.rb

@@ -1,15 +0,0 @@
-module OodAppkit
-  # An object that describes a server hosted by a given cluster
-  class Server
-    # The host information for this server object
-    # @example Host information for login node
-    #   "my_server.host" #=> "oakley.osc.edu"
-    # @return [String] the host for this server
-    attr_reader :host
-
-    # @param host [String] host info
-    def initialize(host:, **_)
-      @host = host
-    end
-  end
-end

data/lib/ood_appkit/servers/ganglia.rb

@@ -1,83 +0,0 @@
-module OodAppkit
-  module Servers
-    # This defines a Ganglia server and defining parameters
-    class Ganglia < Server
-      # Template used to describe URI
-      # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
-      TEMPLATE = '{+scheme}{host}{/segments*}{?query*}'
-
-      # The scheme of the URI
-      # @example Scheme of SSL protocol
-      #   "my_ganglia.scheme" #=> "https://"
-      # @return [String] scheme of uri
-      attr_reader :scheme
-
-      # The segments used to describe the path of the URI
-      # @example Segments for URI with path "/ganglia/gweb.php"
-      #   "my_ganglia.segments"
-      #   #=> ["ganglia", "gweb.php"]
-      # @return [Array<String>] segments of uri
-      attr_reader :segments
-
-      # The required query values of the URI
-      # @example Required cluster query value
-      #   "my_ganglia.req_query"
-      #   #=> {c: "MyCluster"}
-      # @return [Hash] required query values of uri
-      attr_reader :req_query
-
-      # Optional query values of the URI, these query values are
-      # only defined if specified
-      # NB: All optional values will be evaluated for string interpolations
-      # @example Optional host query value
-      #   "my_ganglia.opt_query"
-      #   #=> {h: "%{h}.ten.osc.edu"}
-      # @return [Hash] optional query values of uri
-      attr_reader :opt_query
-
-      # The version of this software
-      # @return [String] version of software
-      attr_reader :version
-
-      # @param scheme [String] the scheme used for URI
-      # @param segments [Array<String>] the segments used to construct path of URI
-      # @param req_query [Hash] hash of required query values used for URI
-      # @param opt_query [Hash] hash of optional query values if they exist
-      # @param version [String] version of server software
-      def initialize(scheme:, segments: [], req_query: {}, opt_query: {}, version:, **kwargs)
-        super(kwargs)
-
-        # uri
-        @scheme = scheme
-        @segments = segments
-        @req_query = req_query
-        @opt_query = opt_query
-
-        # version
-        @version = version
-      end
-
-      # The URI used to access information about given cluster
-      # @param query [Hash] user specified query hash
-      # @return [Addressable] the uri for ganglia server
-      def uri(query: {})
-        Addressable::Template.new(TEMPLATE).expand({
-          scheme: scheme,
-          host: host,
-          segments: segments,
-          query: query_hash(query)
-        })
-      end
-
-      private
-        # The full hash of query values used to construct URI
-        def query_hash(query)
-          req_query.merge(
-            query.each_with_object({}) do |(k, v), h|
-              h[k] = opt_query.has_key?(k) ? (opt_query[k] % req_query.merge(query)) : v
-            end
-          )
-        end
-    end
-  end
-end

data/lib/ood_appkit/servers/moab.rb

@@ -1,54 +0,0 @@
-module OodAppkit
-  module Servers
-    # This defines a Moab server / client software installation
-    class Moab < Server
-      # The path to the installation location for this software
-      # @return [Pathname] the path to software installation location
-      attr_reader :prefix
-
-      # The version of this software
-      # @return [String] version of software
-      attr_reader :version
-
-      # The required Moab environment variable
-      # @return [Pathname] require moab env var
-      attr_reader :moabhomedir
-
-      # @param prefix [String] installation path of client software
-      # @param version [String] version of client software
-      # @param moabhomedir [String] required moab env var
-      def initialize(prefix:, version:, moabhomedir:, **kwargs)
-        super(kwargs)
-
-        # installation path
-        @prefix = Pathname.new prefix
-        raise ArgumentError, "prefix path doesn't exist (#{@prefix})" unless @prefix.exist?
-        raise ArgumentError, "prefix not valid directory (#{@prefix})" unless @prefix.directory?
-
-        # version number
-        @version = version
-
-        # required moab env var
-        @moabhomedir = Pathname.new moabhomedir
-        raise ArgumentError, "moabhomedir path doesn't exist (#{@moabhomedir})" unless @moabhomedir.exist?
-        raise ArgumentError, "moabhomedir not valid directory (#{@moabhomedir})" unless @moabhomedir.directory?
-      end
-
-      # The path to Torque software library
-      # @example Locally installed Torque v5.1.1
-      #   "my_software.lib" #=> "/usr/local/torque/5.1.1/lib"
-      # @return [Pathname] path to libraries
-      def lib
-        prefix.join('lib')
-      end
-
-      # The path to Torque software binaries
-      # @example Locally installed Torque v5.1.1
-      #   "my_software.lib" #=> "/usr/local/torque/5.1.1/bin"
-      # @return [Pathname] path to binaries
-      def bin
-        prefix.join('bin')
-      end
-    end
-  end
-end

data/lib/ood_appkit/servers/torque.rb

@@ -1,44 +0,0 @@
-module OodAppkit
-  module Servers
-    # This defines a Torque server / client software installation
-    class Torque < Server
-      # The path to the installation location for this software
-      # @return [Pathname] the path to software installation location
-      attr_reader :prefix
-
-      # The version of this software
-      # @return [String] version of software
-      attr_reader :version
-
-      # @param prefix [String] installation path of client software
-      # @param version [String] version of client software
-      def initialize(prefix:, version:, **kwargs)
-        super(kwargs)
-
-        # installation path
-        @prefix = Pathname.new prefix
-        raise ArgumentError, "prefix path doesn't exist (#{@prefix})" unless @prefix.exist?
-        raise ArgumentError, "prefix not valid directory (#{@prefix})" unless @prefix.directory?
-
-        # version number
-        @version = version
-      end
-
-      # The path to Torque software library
-      # @example Locally installed Torque v5.1.1
-      #   "my_software.lib" #=> "/usr/local/torque/5.1.1/lib"
-      # @return [Pathname] path to libraries
-      def lib
-        prefix.join('lib')
-      end
-
-      # The path to Torque software binaries
-      # @example Locally installed Torque v5.1.1
-      #   "my_software.lib" #=> "/usr/local/torque/5.1.1/bin"
-      # @return [Pathname] path to binaries
-      def bin
-        prefix.join('bin')
-      end
-    end
-  end
-end