ood_appkit 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eb6d20b4747f2021e1f88650dbccf1128a3783c
-  data.tar.gz: c04296d552fb068865ee30feaee0addba8a6bd76
+  metadata.gz: 3357fbdca016e8208120c92b174b7dbfc9ab40b9
+  data.tar.gz: 06b2d516f3028be6f12531cd7a167caaf7ad6088
 SHA512:
-  metadata.gz: 6ed370c8a4107a89f89ef3cbe0354f39cf762854d064a7d9a7a2177632a77cef1a3be94ad452d2da4ea7be3260506d8602f2b9a0813d185b0bc5f28a5d0eec5b
-  data.tar.gz: 905ca68526ade3d6299a1bcaedf32035c73f9476ea28dcf181203e3820b1423916730c661401f1bccb3381a178b4abfc84841c5a2c0d5bb9d3fb87c28507c96a
+  metadata.gz: 506a025230543001aa94ef4dd3f8f6d58a35025abcb69ccd2b7dc823339a2c7e89e73433c9dd784ac8ed580a7af9ee94414206ec89a8f01d002acab2b71d9e6b
+  data.tar.gz: f1df95d9da1e843a62d2cc49f371f2640efdb90c8baea602e9aca679dd587f27b706d5ff957c20bb27dd55f1912db6f03da745d0fdea50f467f231c1c1afd477

data/README.md

@@ -76,7 +76,7 @@ Or by modifying the configuration in an initializer:
 
 OodAppkit.configure do |config|
   # Defaults
-  config.dashboard = OodAppkit::DashboardUrl.new title: 'Dashboard', base_url: '/pun/sys/dashboard'
+  config.dashboard = OodAppkit::Urls::Dashboard.new title: 'Dashboard', base_url: '/pun/sys/dashboard'
 end
 ```
 
@@ -108,7 +108,7 @@ Or by modifying the configuration in an initializer:
 
 OodAppkit.configure do |config|
   # Defaults
-  config.files = OodAppkit::FilesUrl.new title: 'Files', base_url: '/pun/sys/files'
+  config.files = OodAppkit::Urls::Files.new title: 'Files', base_url: '/pun/sys/files'
 end
 ```
 
@@ -137,7 +137,7 @@ Or by modifying the configuration in an initializer:
 
 OodAppkit.configure do |config|
   # Defaults
-  config.editor = OodAppkit::EditorUrl.new title: 'Editor', base_url: '/pun/sys/file-editor'
+  config.editor = OodAppkit::Urls::Editor.new title: 'Editor', base_url: '/pun/sys/file-editor'
 end
 ```
 
@@ -171,7 +171,7 @@ Or by modifying the configuration in an initializer:
 
 OodAppkit.configure do |config|
   # Defaults
-  config.shell = OodAppkit::ShellUrl.new title: 'Shell', base_url: '/pun/sys/shell'
+  config.shell = OodAppkit::Urls::Shell.new title: 'Shell', base_url: '/pun/sys/shell'
 end
 ```
 
@@ -559,7 +559,7 @@ or by modifying the configuration in an initializer
 # config/initializers/ood_appkit.rb
 
 OodAppkit.configure do |config|
-  config.clusters.all = OodAppkit::Cluster.all(file: "/path/to/my/config.yml")
+  config.clusters.cache = OodAppkit::Cluster.all(file: "/path/to/my/config.yml")
 end
 ```
 

data/config/clusters.yml

@@ -23,7 +23,7 @@ v1:
         segments:
           - 'gweb'
           - 'graph.php'
-        query:
+        req_query:
           c: 'Oakley nodes'
         opt_query:
           h: '%{h}.ten.osc.edu'
@@ -57,11 +57,42 @@ v1:
         segments:
           - 'gweb'
           - 'graph.php'
-        query:
+        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'
+          - 'cons'
+          - '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

data/lib/ood_appkit/configuration.rb

@@ -65,9 +65,16 @@ module OodAppkit
       self.dataroot = ENV['OOD_DATAROOT'] || ENV['RAILS_DATAROOT']
 
       # Initialize list of available clusters
-      c_conf = ENV['OOD_CLUSTERS'] || ( OOD_CONFIG.join('clusters.yml') if OOD_CONFIG.join('clusters.yml').file? )
-      self.clusters = OpenStruct.new
-      clusters.all = OodAppkit::Cluster.all( c_conf ? {file: c_conf} : {} )
+      # 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__)
+        )
+      )
+      def clusters.all
+        cache
+      end
       def clusters.hpc
         all.select {|k,v| v.hpc_cluster?}
       end
@@ -86,23 +93,23 @@ module OodAppkit
       )
 
       # Initialize URL handlers for system apps
-      self.public    = PublicUrl.new(
+      self.public    = Urls::Public.new(
         title:    ENV['OOD_PUBLIC_TITLE'] || 'Public Assets',
         base_url: ENV['OOD_PUBLIC_URL']   || '/public'
       )
-      self.dashboard = DashboardUrl.new(
+      self.dashboard = Urls::Dashboard.new(
         title:    ENV['OOD_DASHBOARD_TITLE'] || 'Dashboard',
         base_url: ENV['OOD_DASHBOARD_URL']   || '/pun/sys/dashboard'
       )
-      self.shell     = ShellUrl.new(
+      self.shell     = Urls::Shell.new(
         title:    ENV['OOD_SHELL_TITLE'] || 'Shell',
         base_url: ENV['OOD_SHELL_URL']   || '/pun/sys/shell'
       )
-      self.files     = FilesUrl.new(
+      self.files     = Urls::Files.new(
         title:    ENV['OOD_FILES_TITLE'] || 'Files',
         base_url: ENV['OOD_FILES_URL']   || '/pun/sys/files'
       )
-      self.editor    = EditorUrl.new(
+      self.editor    = Urls::Editor.new(
         title:    ENV['OOD_EDITOR_TITLE'] || 'Editor',
         base_url: ENV['OOD_EDITOR_URL']   || '/pun/sys/file-editor'
       )

data/lib/ood_appkit/servers/ganglia.rb

@@ -21,13 +21,17 @@ module OodAppkit
 
       # The required query values of the URI
       # @example Required cluster query value
-      #   "my_ganglia.query"
+      #   "my_ganglia.req_query"
       #   #=> {c: "MyCluster"}
       # @return [Hash] required query values of uri
-      attr_reader :query
+      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
 
@@ -36,48 +40,44 @@ module OodAppkit
       attr_reader :version
 
       # @param scheme [String] the scheme used for URI
-      # @param segments [Array<String>] the segments used to
-      #   construct path of URI
-      # @param query [Hash] hash of query values used for
-      #   URI
-      # @param opt_query [Hash] hash of optional query
-      #   values if they exist
+      # @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: [], query: {}, opt_query: {}, version:, **kwargs)
+      def initialize(scheme:, segments: [], req_query: {}, opt_query: {}, version:, **kwargs)
         super(kwargs)
 
         # uri
         @scheme = scheme
         @segments = segments
-        @query = query
+        @req_query = req_query
         @opt_query = opt_query
 
         # version
         @version = version
       end
 
-      # The full hash of query values used to construct URI
-      # @param other_query [Hash] user specified query hash
-      # @return [Hash] full hash of query values
-      def query_values(other_query)
-        query.merge(
-          other_query.each_with_object({}) do |(k, v), h|
-            h[k] = opt_query.has_key?(k) ? (opt_query[k] % query.merge(other_query)) : v
-          end
-        )
-      end
-
       # The URI used to access information about given cluster
-      # @param query_values [Hash] user specified query hash
+      # @param query [Hash] user specified query hash
       # @return [Addressable] the uri for ganglia server
-      def uri(query_values: {})
+      def uri(query: {})
         Addressable::Template.new(TEMPLATE).expand({
           scheme: scheme,
           host: host,
           segments: segments,
-          query: query_values(query_values)
+          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/url.rb

@@ -0,0 +1,32 @@
+require 'addressable'
+
+module OodAppkit
+  # A generic class used to handle URLs for an app
+  class Url
+    # The title for this URL
+    # @return [String] the title of the URL
+    attr_reader :title
+
+    # @param title [#to_s] the title of the URL
+    # @param base_url [#to_s] the base URL used to access this app
+    # @param template [#to_s] the template used to generate URLs for this app
+    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
+    def initialize(title: '', base_url: '/', template: '{/url*}/')
+      @title = title.to_s
+      @template = Addressable::Template.new template.to_s
+      @base_url = parse_url_segments(base_url.to_s)
+    end
+
+    # URL to access this app
+    # @return [Addressable::URI] the url used to access the app
+    def url
+      @template.expand url: @base_url
+    end
+
+    private
+      # Parse URL segments into an array
+      def parse_url_segments(url)
+        url.split('/').reject(&:empty?)
+      end
+  end
+end

data/lib/ood_appkit/urls/dashboard.rb

@@ -0,0 +1,7 @@
+module OodAppkit
+  module Urls
+    # A class used to handle URLs for the system Dashboard app.
+    class Dashboard < Url
+    end
+  end
+end

data/lib/ood_appkit/urls/editor.rb

@@ -0,0 +1,20 @@
+module OodAppkit
+  module Urls
+    # A class used to handle URLs for the system file Editor app.
+    class Editor < Url
+      # @param (see Url#initialize)
+      # @param edit_url [#to_s] the URL used to request the file editor api
+      def initialize(edit_url: '/edit', template: '{/url*}{+path}', **kwargs)
+        super(template: template, **kwargs)
+        @edit_url = parse_url_segments(edit_url.to_s)
+      end
+
+      # URL to access this app's file editor API for a given absolute file path
+      # @param path [#to_s] the absolute path to the file on the filesystem
+      # @return [Addressable::URI] absolute url to access path in file editor api
+      def edit(path: '')
+        @template.expand url: @base_url + @edit_url, path: path.to_s
+      end
+    end
+  end
+end

data/lib/ood_appkit/urls/files.rb

@@ -0,0 +1,29 @@
+module OodAppkit
+  module Urls
+    # A class used to handle URLs for the system Files app.
+    class Files < Url
+      # @param (see Url#initialize)
+      # @param fs_url [#to_s] the URL used to request a filesystem view in the app
+      # @param api_url [#to_s] the URL used to request the app's api
+      def initialize(fs_url: '/fs', api_url: '/api/v1/fs', template: '{/url*}{+path}', **kwargs)
+        super(template: template, **kwargs)
+        @fs_url  = parse_url_segments(fs_url.to_s)
+        @api_url = parse_url_segments(api_url.to_s)
+      end
+
+      # URL to access this app for a given absolute file path
+      # @param path [#to_s] the absolute path to the file on the filesystem
+      # @return [Addressable::URI] absolute url to access path in files app
+      def url(path: '')
+        @template.expand url: @base_url + @fs_url, path: path.to_s
+      end
+
+      # URL to access this app's API for a given absolute file path
+      # @param path [#to_s] the absolute path to the file on the filesystem
+      # @return [Addressable::URI] absolute url to access path in files app api
+      def api(path: '')
+        @template.expand url: @base_url + @api_url, path: path.to_s
+      end
+    end
+  end
+end

data/lib/ood_appkit/urls/public.rb

@@ -0,0 +1,7 @@
+module OodAppkit
+  module Urls
+    # A class used to handle URLs for the publicly available assets.
+    class Public < Url
+    end
+  end
+end

data/lib/ood_appkit/urls/shell.rb

@@ -0,0 +1,21 @@
+module OodAppkit
+  module Urls
+    # A class used to handle URLs for the system Shell app.
+    class Shell < Url
+      # @param (see Url#initialize)
+      # @param ssh_url [#to_s] the ssh URL used to access the terminal
+      def initialize(ssh_url: '/ssh', template: '{/url*}/{host}{+path}', **kwargs)
+        super(template: template, **kwargs)
+        @ssh_url = parse_url_segments(ssh_url.to_s)
+      end
+
+      # URL to access this app for a given host and absolute file path
+      # @param host [#to_s] the host the app will make an ssh connection with
+      # @param path [#to_s] the absolute path to the directory ssh app opens up in
+      # @return [Addressable::URI] the url used to access the app
+      def url(host: 'default', path: '')
+        @template.expand url: @base_url + @ssh_url, host: host.to_s, path: path.to_s
+      end
+    end
+  end
+end

data/lib/ood_appkit/version.rb

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

data/lib/ood_appkit.rb

@@ -2,11 +2,7 @@ require 'addressable'
 
 require 'ood_appkit/version'
 require 'ood_appkit/configuration'
-require 'ood_appkit/public_url'
-require 'ood_appkit/dashboard_url'
-require 'ood_appkit/shell_url'
-require 'ood_appkit/files_url'
-require 'ood_appkit/editor_url'
+require 'ood_appkit/url'
 require 'ood_appkit/files_rack_app'
 require 'ood_appkit/markdown_template_handler'
 require 'ood_appkit/log_formatter'
@@ -15,12 +11,18 @@ require 'ood_appkit/server'
 
 # The main namespace for OodAppkit. Provides a global configuration.
 module OodAppkit
-  # Global OOD config location
-  OOD_CONFIG = Pathname.new '/etc/ood/config'
-
   extend Configuration
   require 'ood_appkit/engine' if defined?(Rails)
 
+  # A namespace to hold all subclasses of {Url}
+  module Urls
+    require 'ood_appkit/urls/public'
+    require 'ood_appkit/urls/dashboard'
+    require 'ood_appkit/urls/shell'
+    require 'ood_appkit/urls/files'
+    require 'ood_appkit/urls/editor'
+  end
+
   # A namespace to hold all subclasses of {Server}
   module Servers
     require 'ood_appkit/servers/torque'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ood_appkit
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Eric Franz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -119,19 +119,20 @@ files:
 - lib/ood_appkit.rb
 - lib/ood_appkit/cluster.rb
 - lib/ood_appkit/configuration.rb
-- lib/ood_appkit/dashboard_url.rb
-- lib/ood_appkit/editor_url.rb
 - lib/ood_appkit/engine.rb
 - lib/ood_appkit/files_rack_app.rb
-- lib/ood_appkit/files_url.rb
 - lib/ood_appkit/log_formatter.rb
 - lib/ood_appkit/markdown_template_handler.rb
-- lib/ood_appkit/public_url.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/shell_url.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/validators/groups.rb
 - lib/ood_appkit/version.rb
 - lib/tasks/ood_appkit_tasks.rake

data/lib/ood_appkit/dashboard_url.rb

@@ -1,26 +0,0 @@
-module OodAppkit
-  # A class used to handle URLs for the system Dashboard app.
-  class DashboardUrl
-    # The title for this URL
-    # @return [String] the title of the URL
-    attr_reader :title
-
-    # @param title [String] the title of the URL
-    # @param base_url [String] the base URL used to access this app
-    # @param template [String] the template used to generate URLs for this app
-    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
-    def initialize(title: '', base_url: '/', template: '{/url*}/')
-      @title = title
-      @template = Addressable::Template.new template
-
-      # Break up into arrays of strings
-      @base_url = base_url.split('/').reject(&:empty?)
-    end
-
-    # URL to access this app
-    # @return [Addressable::URI] the url used to access the app
-    def url
-      @template.expand url: @base_url
-    end
-  end
-end

data/lib/ood_appkit/editor_url.rb

@@ -1,35 +0,0 @@
-module OodAppkit
-  # A class used to handle URLs for the system file Editor app.
-  class EditorUrl
-    # The title for this URL
-    # @return [String] the title of the URL
-    attr_reader :title
-
-    # @param title [String] the title of the URL
-    # @param base_url [String] the base URL used to access this app
-    # @param edit_url [String] the URL used to request the file editor api
-    # @param template [String] the template used to generate URLs for this app
-    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
-    def initialize(title: '', base_url: '/', edit_url: '/edit', template: '{/url*}{+path}')
-      @title = title
-      @template = Addressable::Template.new template
-
-      # Break up into arrays of strings
-      @base_url = base_url.split('/').reject(&:empty?)
-      @edit_url = edit_url.split('/').reject(&:empty?)
-    end
-
-    # URL to access this app
-    # @return [Addressable::URI] absolute url to access app
-    def url
-      @template.expand url: @base_url
-    end
-
-    # URL to access this app's file editor API for a given absolute file path
-    # @param path [String, #to_s] the absolute path to the file on the filesystem
-    # @return [Addressable::URI] absolute url to access path in file editor api
-    def edit(path: '')
-      @template.expand url: @base_url + @edit_url, path: path.to_s
-    end
-  end
-end

data/lib/ood_appkit/files_url.rb

@@ -1,38 +0,0 @@
-module OodAppkit
-  # A class used to handle URLs for the system Files app.
-  class FilesUrl
-    # The title for this URL
-    # @return [String] the title of the URL
-    attr_reader :title
-
-    # @param title [String] the title of the URL
-    # @param base_url [String] the base URL used to access this app
-    # @param fs_url [String] the URL used to request a filesystem view in the app
-    # @param api_url [String] the URL used to request the app's api
-    # @param template [String] the template used to generate URLs for this app
-    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
-    def initialize(title: '', base_url: '/', fs_url: '/fs', api_url: '/api/v1/fs', template: '{/url*}{+path}')
-      @title = title
-      @template = Addressable::Template.new template
-
-      # Break up into arrays of strings
-      @base_url = base_url.split('/').reject(&:empty?)
-      @fs_url   = fs_url.split('/').reject(&:empty?)
-      @api_url  = api_url.split('/').reject(&:empty?)
-    end
-
-    # URL to access this app for a given absolute file path
-    # @param path [String, #to_s] the absolute path to the file on the filesystem
-    # @return [Addressable::URI] absolute url to access path in files app
-    def url(path: '')
-      @template.expand url: @base_url + @fs_url, path: path.to_s
-    end
-
-    # URL to access this app's API for a given absolute file path
-    # @param path [String, #to_s] the absolute path to the file on the filesystem
-    # @return [Addressable::URI] absolute url to access path in files app api
-    def api(path: '')
-      @template.expand url: @base_url + @api_url, path: path.to_s
-    end
-  end
-end

data/lib/ood_appkit/public_url.rb

@@ -1,26 +0,0 @@
-module OodAppkit
-  # A class used to handle URLs for the publicly available assets.
-  class PublicUrl
-    # The title for this URL
-    # @return [String] the title of the URL
-    attr_reader :title
-
-    # @param title [String] the title of the URL
-    # @param base_url [String] the base URL used to access this app
-    # @param template [String] the template used to generate URLs for this app
-    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
-    def initialize(title: '', base_url: '/', template: '{/url*}/')
-      @title = title
-      @template = Addressable::Template.new template
-
-      # Break up into arrays of strings
-      @base_url = base_url.split('/').reject(&:empty?)
-    end
-
-    # URL to access this app
-    # @return [Addressable::URI] the url used to access the app
-    def url
-      @template.expand url: @base_url
-    end
-  end
-end

data/lib/ood_appkit/shell_url.rb

@@ -1,29 +0,0 @@
-module OodAppkit
-  # A class used to handle URLs for the system Shell app.
-  class ShellUrl
-    # The title for this URL
-    # @return [String] the title of the URL
-    attr_reader :title
-
-    # @param title [String] the title of the URL
-    # @param base_url [String] the base URL used to access this app
-    # @param template [String] the template used to generate URLs for this app
-    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
-    def initialize(title: '', base_url: '/', ssh_url: '/ssh', template: '{/url*}/{host}{+path}')
-      @title = title
-      @template = Addressable::Template.new template
-
-      # Break up into arrays of strings
-      @base_url = base_url.split('/').reject(&:empty?)
-      @ssh_url  = ssh_url.split('/').reject(&:empty?)
-    end
-
-    # URL to access this app for a given host and absolute file path
-    # @param host [String] the host the app will make an ssh connection with
-    # @param path [#to_s] the absolute path to the directory ssh app opens up in
-    # @return [Addressable::URI] the url used to access the app
-    def url(host: 'default', path: '')
-      @template.expand url: @base_url + @ssh_url, host: host, path: path.to_s
-    end
-  end
-end