crowbar-client 1.0.0

data/lib/crowbar/client/filter/subset.rb

@@ -0,0 +1,45 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Crowbar
+  module Client
+    module Filter
+      class Subset < Base
+        def process
+          options[:filter].to_s.split(".").each do |segment|
+            segment = segment.to_i if segment.to_i.to_s == segment
+            options[:values] = subset(segment)
+          end
+
+          options[:values]
+        end
+
+        protected
+
+        def subset(segment)
+          case
+          when options[:values][segment.to_i].present?
+            options[:values][segment.to_i]
+          when options[:values][segment.to_sym].present?
+            options[:values][segment.to_sym]
+          when options[:values][segment.to_s].present?
+            options[:values][segment.to_s]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/formatter.rb

@@ -0,0 +1,33 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Crowbar
+  module Client
+    module Formatter
+      autoload :Array,
+        File.expand_path("../formatter/array", __FILE__)
+
+      autoload :Base,
+        File.expand_path("../formatter/base", __FILE__)
+
+      autoload :Hash,
+        File.expand_path("../formatter/hash", __FILE__)
+
+      autoload :Nested,
+        File.expand_path("../formatter/nested", __FILE__)
+    end
+  end
+end

data/lib/crowbar/client/formatter/array.rb

@@ -0,0 +1,49 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "terminal-table"
+require "json"
+
+module Crowbar
+  module Client
+    module Formatter
+      class Array < Base
+        def empty?
+          options[:values].empty?
+        end
+
+        protected
+
+        def process_table
+          Terminal::Table.new(
+            headings: options[:headings],
+            rows: options[:values].zip
+          )
+        end
+
+        def process_plain
+          options[:values].join("\n")
+        end
+
+        def process_json
+          JSON.pretty_generate(
+            options[:values]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/formatter/base.rb

@@ -0,0 +1,47 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Crowbar
+  module Client
+    module Formatter
+      class Base
+        attr_accessor :options
+
+        def initialize(options = {})
+          self.options = options
+        end
+
+        def result
+          case options[:format].to_sym
+          when :table
+            process_table
+          when :plain
+            process_plain
+          when :json
+            process_json
+          else
+            raise InvalidFormatError,
+              "You requested an invalid format for this resource"
+          end
+        end
+
+        def empty?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/formatter/hash.rb

@@ -0,0 +1,51 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "terminal-table"
+require "json"
+
+module Crowbar
+  module Client
+    module Formatter
+      class Hash < Base
+        def empty?
+          options[:values].empty?
+        end
+
+        protected
+
+        def process_table
+          Terminal::Table.new(
+            rows: options[:values].map(&:values),
+            headings: options[:headings]
+          )
+        end
+
+        def process_plain
+          options[:values].map do |value|
+            value.values.join(" ")
+          end.join("\n")
+        end
+
+        def process_json
+          JSON.pretty_generate(
+            options[:values]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/formatter/nested.rb

@@ -0,0 +1,134 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "terminal-table"
+require "json"
+
+module Crowbar
+  module Client
+    module Formatter
+      class Nested < Base
+        def empty?
+          options[:values].blank?
+        end
+
+        protected
+
+        def process_table
+          case
+          when options[:values].is_a?(::Hash)
+            values = process_hash(
+              options[:values],
+              options[:path],
+              :table
+            )
+          when options[:values].is_a?(::Array)
+            values = [[
+              options[:path],
+              options[:values].join("\n")
+            ]]
+          else
+            values = [[
+              options[:path],
+              options[:values]
+            ]]
+          end
+
+          Terminal::Table.new(
+            headings: options[:headings],
+            rows: values
+          )
+        end
+
+        def process_plain
+          case
+          when options[:values].is_a?(::Hash)
+            values = process_hash(
+              options[:values],
+              options[:path],
+              :plain
+            )
+          when options[:values].is_a?(::Array)
+            values = [].tap do |result|
+              options[:values].each_with_index do |row, index|
+                result.push [
+                  [options[:path], index].join("."),
+                  row
+                ]
+              end
+            end
+          else
+            values = [[
+              options[:path],
+              options[:values]
+            ]]
+          end
+
+          values.map do |value|
+            value.join(" ")
+          end.join("\n")
+        end
+
+        def process_json
+          if options[:values].is_a?(::Hash) || options[:values].is_a?(::Array)
+            JSON.pretty_generate(
+              options[:values]
+            )
+          else
+            options[:values]
+          end
+        end
+
+        def process_hash(values, path = "", type = :table)
+          [].tap do |result|
+            values.map do |key, value|
+              new_path = [path.to_s.dup, key].reject(&:empty?).join(".")
+
+              case
+              when value.is_a?(::Hash)
+                result.concat process_hash(
+                  value,
+                  new_path,
+                  type
+                )
+              when value.is_a?(::Array)
+                case type
+                when :table
+                  result.push [
+                    new_path,
+                    value.join("\n")
+                  ]
+                when :plain
+                  value.each_with_index do |row, index|
+                    result.push [
+                      [new_path, index].join("."),
+                      row
+                    ]
+                  end
+                end
+              else
+                result.push [
+                  new_path,
+                  value
+                ]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/mixin.rb

@@ -0,0 +1,30 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Crowbar
+  module Client
+    module Mixin
+      autoload :Barclamp,
+        File.expand_path("../mixin/barclamp", __FILE__)
+
+      autoload :Format,
+        File.expand_path("../mixin/format", __FILE__)
+
+      autoload :Filter,
+        File.expand_path("../mixin/filter", __FILE__)
+    end
+  end
+end

data/lib/crowbar/client/mixin/barclamp.rb

@@ -0,0 +1,41 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "active_support/concern"
+
+module Crowbar
+  module Client
+    module Mixin
+      module Barclamp
+        extend ActiveSupport::Concern
+
+        included do
+          def validate_barclamp!(barclamp)
+            return if available_barclamps.include? barclamp
+            raise UnavailableBarclampError, barclamp
+          end
+
+          def available_barclamps
+            @available_barclamps ||= Request::Barclamp::List
+              .new
+              .process
+              .keys
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/mixin/filter.rb

@@ -0,0 +1,33 @@
+#
+# Copyright 2015, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "active_support/concern"
+
+module Crowbar
+  module Client
+    module Mixin
+      module Filter
+        extend ActiveSupport::Concern
+
+        included do
+          def provide_filter
+            options[:filter]
+          end
+        end
+      end
+    end
+  end
+end