ood_appkit 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d9dd72dd897997eadf63e025a8e085a6ae842b7
-  data.tar.gz: 8db16a0e7b2c3e010412967a1c015288780dd212
+  metadata.gz: 8eb6d20b4747f2021e1f88650dbccf1128a3783c
+  data.tar.gz: c04296d552fb068865ee30feaee0addba8a6bd76
 SHA512:
-  metadata.gz: 35aad26d17cf8df49f4399b55f138c9959b795e4d16e6054593a6066ab364d0754ba25a24adfb3a35a9ebadaefe71d20aaed70bab2200612276789fc03c88cab
-  data.tar.gz: ecdf518bfded907f0faf195c4468d82f82e7ba3433cef67a64ba71dfffa87ebb4882b343c5f56c1bab0916048029c495f220130383e7b1cb740c1a402f793870
+  metadata.gz: 6ed370c8a4107a89f89ef3cbe0354f39cf762854d064a7d9a7a2177632a77cef1a3be94ad452d2da4ea7be3260506d8602f2b9a0813d185b0bc5f28a5d0eec5b
+  data.tar.gz: 905ca68526ade3d6299a1bcaedf32035c73f9476ea28dcf181203e3820b1423916730c661401f1bccb3381a178b4abfc84841c5a2c0d5bb9d3fb87c28507c96a

data/README.md

@@ -542,7 +542,7 @@ ganglia_server.uri.to_s
 #=> "https://www.ganglia.com/gweb/graph.php?c=MyCluster"
 
 # To add query values as options for the server
-ganglia_server.merge_query_values(g: 'cpu_report').to_s
+ganglia_server.uri(query_values: {g: 'cpu_report'}).to_s
 #=> "https://www.ganglia.com/gweb/graph.php?c=MyCluster&g=cpu_report"
 ```
 

data/config/clusters.yml

@@ -19,10 +19,14 @@ v1:
       ganglia:
         type: 'OodAppkit::Servers::Ganglia'
         host: 'cts05.osc.edu'
-        scheme: 'https'
-        path: '/gweb/graph.php'
-        query_values:
+        scheme: 'https://'
+        segments:
+          - 'gweb'
+          - 'graph.php'
+        query:
           c: 'Oakley nodes'
+        opt_query:
+          h: '%{h}.ten.osc.edu'
         version: '3'
   ruby:
     title: 'Ruby'
@@ -49,10 +53,14 @@ v1:
       ganglia:
         type: 'OodAppkit::Servers::Ganglia'
         host: 'cts05.osc.edu'
-        scheme: 'https'
-        path: '/gweb/graph.php'
-        query_values:
+        scheme: 'https://'
+        segments:
+          - 'gweb'
+          - 'graph.php'
+        query:
           c: 'Ruby'
+        opt_query:
+          h: '%{h}.ten.osc.edu'
         version: '3'
   quick:
     title: 'Quick'

data/lib/ood_appkit/configuration.rb

@@ -65,8 +65,9 @@ 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( ENV['OOD_CLUSTERS'] ? {file: ENV['OOD_CLUSTERS']} : {} )
+      clusters.all = OodAppkit::Cluster.all( c_conf ? {file: c_conf} : {} )
       def clusters.hpc
         all.select {|k,v| v.hpc_cluster?}
       end

data/lib/ood_appkit/servers/ganglia.rb

@@ -2,41 +2,81 @@ module OodAppkit
   module Servers
     # This defines a Ganglia server and defining parameters
     class Ganglia < Server
-      # The URI used to access information about given cluster
-      # @return [Addressable] the uri for ganglia server
-      attr_reader :uri
+      # 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.query"
+      #   #=> {c: "MyCluster"}
+      # @return [Hash] required query values of uri
+      attr_reader :query
+
+      # Optional query values of the URI, these query values are
+      # only defined if specified
+      # @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] scheme component of URI
-      # @param path [String] path component of URI
-      # @param query_values [Hash<String>] hash of query values
+      # @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 version [String] version of server software
-      def initialize(scheme:, path:, query_values: {}, version:, **kwargs)
+      def initialize(scheme:, segments: [], query: {}, opt_query: {}, version:, **kwargs)
         super(kwargs)
 
         # uri
-        @uri = Addressable::URI.new({
-          scheme: scheme,
-          host: host,
-          path: path,
-          query_values: query_values
-        })
+        @scheme = scheme
+        @segments = segments
+        @query = query
+        @opt_query = opt_query
 
-        # version number
+        # version
         @version = version
       end
 
-      # Merge a hash of query values into this URI
-      # NB: This doesn't alter the original URI
-      # @param new_query_values [Hash] hash of query values
-      # @return [Addressable] new uri with merged query values
-      def merge_query_values(new_query_values)
-        uri.dup.tap do |u|
-          u.query_values = (uri.query_values || {}).merge(new_query_values)
-        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
+      # @return [Addressable] the uri for ganglia server
+      def uri(query_values: {})
+        Addressable::Template.new(TEMPLATE).expand({
+          scheme: scheme,
+          host: host,
+          segments: segments,
+          query: query_values(query_values)
+        })
       end
     end
   end

data/lib/ood_appkit/version.rb

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

data/lib/ood_appkit.rb

@@ -15,6 +15,9 @@ 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)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ood_appkit
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Eric Franz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails