crowbar-client 2.4.1 → 2.4.2

data/lib/crowbar/client/request/node/transition.rb

@@ -20,7 +20,15 @@ module Crowbar
   module Client
     module Request
       module Node
+        #
+        # Implementation for the node transition request
+        #
         class Transition < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               name: attrs.name,
@@ -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/request/party.rb

@@ -19,6 +19,9 @@ require "httmultiparty"
 module Crowbar
   module Client
     module Request
+      #
+      # Client for executing the HTTP API requests
+      #
       class Party
         include HTTMultiParty
 

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Request
+      #
+      # Module for the proposal request implementations
+      #
       module Proposal
         autoload :Commit,
           File.expand_path("../proposal/commit", __FILE__)

data/lib/crowbar/client/request/proposal/commit.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal commit request
+        #
         class Commit < 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
             [
               "crowbar",

data/lib/crowbar/client/request/proposal/create.rb

@@ -20,17 +20,35 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal create request
+        #
         class Create < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               attrs.payload
             )
           end
 
+          #
+          # HTTP method that gets used by the request
+          #
+          # @return [Symbol] the method for the request
+          #
           def method
             :put
           end
 
+          #
+          # Path to the API endpoint for the request
+          #
+          # @return [String] path to the API endpoint
+          #
           def url
             [
               "crowbar",

data/lib/crowbar/client/request/proposal/delete.rb

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

data/lib/crowbar/client/request/proposal/dequeue.rb

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

data/lib/crowbar/client/request/proposal/edit.rb

@@ -20,17 +20,35 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal edit request
+        #
         class Edit < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               attrs.payload
             )
           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/proposal/list.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal 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/proposal/reset.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal reset request
+        #
         class Reset < 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
             [
               "crowbar",

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

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal 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/proposal/template.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Proposal
+        #
+        # Implementation for the proposal template request
+        #
         class Template < 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/repository.rb

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Request
+      #
+      # Module for the repository request implementations
+      #
       module Repository
         autoload :Activate,
           File.expand_path("../repository/activate", __FILE__)

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

@@ -20,7 +20,15 @@ module Crowbar
   module Client
     module Request
       module Repository
+        #
+        # Implementation for the repository activate request
+        #
         class Activate < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               platform: attrs.platform,
@@ -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
             [
               "utils",

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

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Repository
+        #
+        # Implementation for the repository activate all request
+        #
         class ActivateAll < 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
             [
               "utils",

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

@@ -20,7 +20,15 @@ module Crowbar
   module Client
     module Request
       module Repository
+        #
+        # Implementation for the repository deactivate request
+        #
         class Deactivate < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               platform: attrs.platform,
@@ -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
             [
               "utils",

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

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Repository
+        #
+        # Implementation for the repository deactivate all request
+        #
         class DeactivateAll < 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
             [
               "utils",