ood_appkit 0.3.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850674682fcbe959939aca02f9a20171d4a8571a
-  data.tar.gz: e206532de1309dff2dff6558707c907f41a56db5
+  metadata.gz: 639be3508b4fec095c35a5d4975b786d1ec8b4dd
+  data.tar.gz: 772b0ddc945ae9a38247c68fde45a611627b08f2
 SHA512:
-  metadata.gz: a40fe490ed48c377fa3ec0db0de57b1915d5e44be529f71eac3800316e78a6731698cbaa0b7ed53481b9d07ff1a3b4498ffc65b965fb818f3cfe7f2de4f0027f
-  data.tar.gz: 14f764aca4ebde3697dae62b4dc0661df5264cae9958771990639a837e59a68dca838885483ed0ae1b21ee8738b5fa2ea4d3f8b44f5a8b7df66c3ac86a8a5688
+  metadata.gz: 00d0a0e9c72158520b4a7fa8bf7350134e321fb32fb3baea420d74ec5b912b32988e052c37231aec5bed0585ce8a1d0337e8bf46855982c69dd698b52eff40f2
+  data.tar.gz: 62d4891cac215848b39c1668582360ebe2749edfa224db14453c139d85bf0db61d2cf5b57f0013fbad2fe6130895df5952c146ee0b54d22fe86f418d34d4b880

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2016 Ohio Supercomputer Center
+Copyright (c) 2015-2017 Ohio Supercomputer Center
 
 MIT License
 

data/README.md

@@ -525,11 +525,7 @@ host is done through:
 ```ruby
 # An enumerable list of clusters
 OodAppkit.clusters
-#=> #<OodAppkit::Clusters>
-
-# Create list of cluster titles
-OodAppkit.clusters.map(&:title)
-#=> ["My Cluster", "Tiny Cluster", "Big Cluster"]
+#=> #<OodCore::Clusters>
 
 # Count number of clusters available
 OodAppkit.clusters.count
@@ -545,114 +541,18 @@ 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>
+#=> #<OodCore::Cluster>
 
 # or...
 OodAppkit.clusters["my_cluster"]
-#=> #<OodAppkit::ClusterDecorator>
+#=> #<OodCore::Cluster>
 
 # Trying to access a non-existant cluster
 OodAppkit.clusters[:invalid_cluster]
 #=> nil
 ```
 
-A cluster object comes with some pre-defined helper methods to help you find
-the cluster that meets your needs:
-
-```ruby
-# 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
-
-# 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>
-```
-
-As this object is an `Enumerable` you can create subsets of clusters that your
-app only cares for in an initializer:
-
-```ruby
-# I only want clusters that are valid for the currently running user
-valid_clusters = OodAppkit::Clusters.new(
-  OodAppkit.clusters.select(&:valid?)
-)
-#=> #<OodAppkit::Clusters>
-
-# Create list of cluster titles from these valid clusters
-valid_clusters.map(&:title)
-#=> ["My Cluster"]
-
-# I only want HPC clusters that I can submit solver jobs to
-hpc_clusters = OodAppkit::Clusters.new(
-  OodAppkit.clusters.select(&:hpc_cluster?)
-)
-```
-
-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.
-
-#### Validations
-
-A cluster may support more validations than whether the current user can access
-it. The extra validations are defined in the configuration YAML file as such:
-
-```yaml
-validators:
-  cluster:
-    - type: "OodAppkit::Validators::Groups"
-      data:
-        groups:
-          - "ruby"
-        allow: true
-  rsv_query:
-    - type: "OodAppkit::Validators::Groups"
-      data:
-        groups:
-          - "sysp"
-          - "hpcsoft"
-        allow: false
-```
-
-where the key is used in the `OodAppkit::ClusterDecorator#valid?` method.
-
-One such validation is whether the current user can query their reservation
-information for the given cluster:
-
-```ruby
-# 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
-
-# I am allowed to use it so let's query for user's reservations
-require 'ood_reservations'
-my_rsv_query = OodReservations::Query.build(cluster: my_cluster).reservations
-#=> [ #<OodReservations::Reservation>, ... ]
-```
-
-You can learn more about the reservation query object by visiting
-https://github.com/OSC/ood_reservations.
+You can read more about this cluster object at https://github.com/OSC/ood_core.
 
 #### Configuration
 
@@ -663,7 +563,7 @@ different config file through the environment variable `OOD_CLUSTERS`
 OOD_CLUSTERS="/path/to/my/config.yml"
 ```
 
-Or a directory with aptly named configuration files (name of file is id of
+Or a directory with cluster named configuration files (name of file is id of
 cluster):
 
 ```sh

data/lib/ood_appkit/configuration.rb

@@ -1,5 +1,6 @@
 require 'redcarpet'
 require 'ostruct'
+require 'ood_core'
 
 module OodAppkit
   # An object that stores and adds configuration options.
@@ -12,8 +13,12 @@ module OodAppkit
     attr_writer :dataroot
 
     # Cluster information for local HPC center
-    # @return [OpenStruct] hash of available clusters
-    attr_accessor :clusters
+    # @return [OodCore::Clusters] hash of available clusters
+    def clusters
+      @clusters ||= parse_clusters(ENV['OOD_CLUSTERS'])
+    end
+
+    attr_writer :clusters
 
     # A markdown renderer used when rendering `*.md` or `*.markdown` views
     # @return [Redcarpet::Markdown] the markdown renderer used
@@ -65,17 +70,6 @@ module OodAppkit
       self.dataroot = ENV['OOD_DATAROOT'] || ENV['RAILS_DATAROOT']
       self.dataroot ||= "~/#{ENV['OOD_PORTAL'] || "ondemand"}/data/#{ENV['APP_TOKEN']}" if ENV['APP_TOKEN']
 
-      # Initialize list of available clusters
-      c_config = Pathname.new(ENV['OOD_CLUSTERS'] || '/etc/ood/config/clusters.d')
-      self.clusters = Clusters.new(
-        begin
-          ConfigParser.parse(config: c_config).map { |k, v| ClusterDecorator.new(id: k.to_sym, **v) }
-        rescue ConfigParser::InvalidConfigPath
-          STDERR.puts "Invalid cluster config specified: #{c_config}"
-          []
-        end
-      )
-
       # Add markdown template support
       self.markdown = Redcarpet::Markdown.new(
         Redcarpet::Render::HTML,
@@ -127,5 +121,13 @@ module OodAppkit
 
       self.enable_log_formatter = ::Rails.env.production?
     end
+
+    private
+      # Read in cluster config and parse it
+      def parse_clusters(config)
+        OodCore::Clusters.load_file(config || '/etc/ood/config/clusters.d')
+      rescue OodCore::ConfigurationNotFound
+        OodCore::Clusters.new([])
+      end
   end
 end

data/lib/ood_appkit/version.rb

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

data/lib/ood_appkit.rb

@@ -4,10 +4,6 @@ require 'ood_appkit/url'
 require 'ood_appkit/files_rack_app'
 require 'ood_appkit/markdown_template_handler'
 require 'ood_appkit/log_formatter'
-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
@@ -22,9 +18,4 @@ module OodAppkit
     require 'ood_appkit/urls/files'
     require 'ood_appkit/urls/editor'
   end
-
-  # A namespace for validators used to validate a cluster
-  module Validators
-    require 'ood_appkit/validators/groups'
-  end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ood_appkit
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Franz
+- Jeremy Nicklas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,33 +32,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.7
 - !ruby/object:Gem::Dependency
-  name: ood_support
+  name: ood_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !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'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +106,7 @@ description: Provides an interface to working with other Open OnDemand (OOD) app
   objects for providing branding and documentation within the apps.
 email:
 - efranz@osc.edu
+- jnicklas@osc.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -136,9 +124,6 @@ files:
 - app/views/ood_appkit/wiki/show.html.erb
 - config/routes.rb
 - lib/ood_appkit.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
@@ -150,8 +135,6 @@ files:
 - 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
 - test/dummy/README.rdoc

data/lib/ood_appkit/cluster_decorator.rb

@@ -1,46 +0,0 @@
-require 'ood_cluster'
-
-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
-
-    # 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

@@ -1,24 +0,0 @@
-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

@@ -1,45 +0,0 @@
-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) do
-            hsh = parse_file(f)
-            h[$1.to_sym] = hsh unless hsh.empty?
-          end
-        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)).fetch(YAML_VERSION, {}))).deep_symbolize_keys
-      end
-  end
-end

data/lib/ood_appkit/validator.rb

@@ -1,25 +0,0 @@
-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

@@ -1,38 +0,0 @@
-require 'ood_support'
-
-module OodAppkit
-  module Validators
-    # Class used to determine if user is in valid list of groups
-    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 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