crowbar-client 2.4.1 → 2.4.2

data/lib/crowbar/client/request/repository/list.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Repository
+        #
+        # Implementation for the repository list request
+        #
         class List < Base
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :get
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "utils",

data/lib/crowbar/client/request/role.rb

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Request
+      #
+      # Module for the role request implementations
+      #
       module Role
         autoload :List,
           File.expand_path("../role/list", __FILE__)

data/lib/crowbar/client/request/role/list.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Role
+        #
+        # Implementation for the role list request
+        #
         class List < Base
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :get
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "crowbar",

data/lib/crowbar/client/request/role/show.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Role
+        #
+        # Implementation for the role show request
+        #
         class Show < Base
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :get
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "crowbar",

data/lib/crowbar/client/request/server.rb

@@ -17,9 +17,14 @@
 module Crowbar
   module Client
     module Request
+      #
+      # Module for the server request implementations
+      #
       module Server
         autoload :Api,
           File.expand_path("../server/api", __FILE__)
+        autoload :Check,
+          File.expand_path("../server/check", __FILE__)
       end
     end
   end

data/lib/crowbar/client/request/server/api.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Server
+        #
+        # Implementation for the server API request
+        #
         class Api < Base
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :get
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "crowbar",

data/lib/crowbar/client/request/server/check.rb

@@ -0,0 +1,49 @@
+#
+# Copyright 2016, 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 Request
+      module Server
+        #
+        # Implementation for the Server check request
+        #
+        class Check < Base
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
+          def method
+            :post
+          end
+
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
+          def url
+            [
+              "sanity",
+              "check"
+            ].join("/")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crowbar/client/request/virtual_ip.rb

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Request
+      #
+      # Module for the virtual IP request implementations
+      #
       module VirtualIP
         autoload :Allocate,
           File.expand_path("../virtual_ip/allocate", __FILE__)

data/lib/crowbar/client/request/virtual_ip/allocate.rb

@@ -20,7 +20,15 @@ module Crowbar
   module Client
     module Request
       module VirtualIP
+        #
+        # Implementation for the virtual IP allocate request
+        #
         class Allocate < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               name: attrs.service,
@@ -30,10 +38,20 @@ module Crowbar
             )
           end
 
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :post
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "crowbar",

data/lib/crowbar/client/request/virtual_ip/deallocate.rb

@@ -20,7 +20,15 @@ module Crowbar
   module Client
     module Request
       module VirtualIP
+        #
+        # Implementation for the virtual IP deallocate request
+        #
         class Deallocate < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               name: attrs.service,
@@ -28,10 +36,20 @@ module Crowbar
             )
           end
 
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :post
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "crowbar",

data/lib/crowbar/client/util.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for some utilities used within the client
+    #
     module Util
       autoload :Editor,
         File.expand_path("../util/editor", __FILE__)

data/lib/crowbar/client/util/editor.rb

@@ -20,6 +20,9 @@ require "json"
 module Crowbar
   module Client
     module Util
+      #
+      # Launch an editor and return the edited content
+      #
       class Editor
         attr_accessor :content
         attr_accessor :options

data/lib/crowbar/client/util/runner.rb

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Util
+      #
+      # A wrapper around the Crowbar CLI for proper initialization
+      #
       class Runner
         attr_accessor :argv
         attr_accessor :stdin

data/lib/crowbar/client/version.rb

@@ -16,14 +16,36 @@
 
 module Crowbar
   module Client
+    #
+    # A representation of the current Crowbar CLI version
+    #
     class Version
+      #
+      # Major version
+      #
       MAJOR = 2
+
+      #
+      # Minor version
+      #
       MINOR = 4
-      PATCH = 1
 
+      #
+      # Patch version
+      #
+      PATCH = 2
+
+      #
+      # Optional suffix
+      #
       PRE = nil
 
       class << self
+        #
+        # Convert the Crowbar CLI version to a string
+        #
+        # @return [String] the version of Crowbar CLI
+        #
         def to_s
           [MAJOR, MINOR, PATCH, PRE].compact.join(".")
         end

data/spec/crowbar/client/command/backup/create_spec.rb

@@ -19,22 +19,14 @@ require_relative "../../../../spec_helper"
 describe "Crowbar::Client::Command::Backup::Create" do
   include_context "command_context"
 
-  subject do
-    ::Crowbar::Client::Command::Backup::Create.new(
-      stdin,
-      stdout,
-      stderr,
-      name: "test-backup"
-    )
-  end
-
-  it "should always return a request class" do
-    expect(subject.request).to(
-      be_a(
-        ::Crowbar::Client::Request::Backup::Create
+  it_behaves_like "a command class", true do
+    subject do
+      ::Crowbar::Client::Command::Backup::Create.new(
+        stdin,
+        stdout,
+        stderr,
+        name: "test-backup"
       )
-    )
+    end
   end
-
-  pending
 end

data/spec/crowbar/client/command/backup/delete_spec.rb

@@ -19,22 +19,14 @@ require_relative "../../../../spec_helper"
 describe "Crowbar::Client::Command::Backup::Delete" do
   include_context "command_context"
 
-  subject do
-    ::Crowbar::Client::Command::Backup::Delete.new(
-      stdin,
-      stdout,
-      stderr,
-      name: "test-backup"
-    )
-  end
-
-  it "should always return a request class" do
-    expect(subject.request).to(
-      be_a(
-        ::Crowbar::Client::Request::Backup::Delete
+  it_behaves_like "a command class", true do
+    subject do
+      ::Crowbar::Client::Command::Backup::Delete.new(
+        stdin,
+        stdout,
+        stderr,
+        name: "test-backup"
       )
-    )
+    end
   end
-
-  pending
 end

data/spec/crowbar/client/command/backup/download_spec.rb

@@ -19,22 +19,14 @@ require_relative "../../../../spec_helper"
 describe "Crowbar::Client::Command::Backup::Download" do
   include_context "command_context"
 
-  subject do
-    ::Crowbar::Client::Command::Backup::Download.new(
-      stdin,
-      stdout,
-      stderr,
-      name: "foo"
-    )
-  end
-
-  it "should always return a request class" do
-    expect(subject.request).to(
-      be_a(
-        ::Crowbar::Client::Request::Backup::Download
+  it_behaves_like "a command class", true do
+    subject do
+      ::Crowbar::Client::Command::Backup::Download.new(
+        stdin,
+        stdout,
+        stderr,
+        name: "foo"
       )
-    )
+    end
   end
-
-  pending
 end

data/spec/crowbar/client/command/backup/list_spec.rb

@@ -19,21 +19,13 @@ require_relative "../../../../spec_helper"
 describe "Crowbar::Client::Command::Backup::List" do
   include_context "command_context"
 
-  subject do
-    ::Crowbar::Client::Command::Backup::List.new(
-      stdin,
-      stdout,
-      stderr
-    )
-  end
-
-  it "should always return a request class" do
-    expect(subject.request).to(
-      be_a(
-        ::Crowbar::Client::Request::Backup::List
+  it_behaves_like "a command class", true do
+    subject do
+      ::Crowbar::Client::Command::Backup::List.new(
+        stdin,
+        stdout,
+        stderr
       )
-    )
+    end
   end
-
-  pending
 end