crowbar-client 2.4.1 → 2.4.2

data/lib/crowbar/client/filter.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for the available filter functionalities
+    #
     module Filter
       autoload :Array,
         File.expand_path("../filter/array", __FILE__)

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Filter
+      #
+      # Filter to reduce an array by a given search clause
+      #
       class Array < Base
         def process
           options[:values].select do |row|

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Filter
+      #
+      # Base that provides methods shared between different filters
+      #
       class Base
         attr_accessor :options
 

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Filter
+      #
+      # Filter to reduce a hash by a given search clause
+      #
       class Hash < Base
         def process
           options[:values].select do |row|

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Filter
+      #
+      # Filter to reduce a hash subset by a given search clause
+      #
       class Subset < Base
         def process
           options[:filter].to_s.split(".").each do |segment|

data/lib/crowbar/client/formatter.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for the available formatter functionalities
+    #
     module Formatter
       autoload :Array,
         File.expand_path("../formatter/array", __FILE__)

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

@@ -20,6 +20,9 @@ require "json"
 module Crowbar
   module Client
     module Formatter
+      #
+      # Formatter to properly print out arrays in different formats
+      #
       class Array < Base
         def empty?
           options[:values].empty?

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Formatter
+      #
+      # Base that provides methods shared between different formatters
+      #
       class Base
         attr_accessor :options
 

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

@@ -20,6 +20,9 @@ require "json"
 module Crowbar
   module Client
     module Formatter
+      #
+      # Formatter to properly print out hashes in different formats
+      #
       class Hash < Base
         def empty?
           options[:values].empty?

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

@@ -20,6 +20,9 @@ require "json"
 module Crowbar
   module Client
     module Formatter
+      #
+      # Formatter to properly print out keys and values in different formats
+      #
       class Nested < Base
         def empty?
           options[:values].blank?

data/lib/crowbar/client/mixin.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for the available mixin functionalities
+    #
     module Mixin
       autoload :Barclamp,
         File.expand_path("../mixin/barclamp", __FILE__)

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

@@ -19,6 +19,9 @@ require "active_support/concern"
 module Crowbar
   module Client
     module Mixin
+      #
+      # A mixin with barclamp related helpers
+      #
       module Barclamp
         extend ActiveSupport::Concern
 

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

@@ -19,6 +19,9 @@ require "active_support/concern"
 module Crowbar
   module Client
     module Mixin
+      #
+      # A mixin with filter related helpers
+      #
       module Filter
         extend ActiveSupport::Concern
 

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

@@ -19,6 +19,9 @@ require "active_support/concern"
 module Crowbar
   module Client
     module Mixin
+      #
+      # A mixin with formatter related helpers
+      #
       module Format
         extend ActiveSupport::Concern
 

data/lib/crowbar/client/request.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for the available request implementations
+    #
     module Request
       autoload :Backup,
         File.expand_path("../request/backup", __FILE__)

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Request
+      #
+      # Module for the backup request implementations
+      #
       module Backup
         autoload :Create,
           File.expand_path("../backup/create", __FILE__)

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

@@ -20,17 +20,35 @@ module Crowbar
   module Client
     module Request
       module Backup
+        #
+        # Implementation for the backup create request
+        #
         class Create < Base
+          #
+          # Override the request content
+          #
+          # @return [Hash] the content for the request
+          #
           def content
             super.easy_merge!(
               name: attrs.name
             )
           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/backup/delete.rb

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Backup
+        #
+        # Implementation for the backup 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
             [
               "utils",

data/lib/crowbar/client/request/backup/download.rb

@@ -20,6 +20,9 @@ module Crowbar
   module Client
     module Request
       module Backup
+        #
+        # Implementation for the backup download request
+        #
         class Download < Base
           def headers
             super.easy_merge!(
@@ -28,10 +31,20 @@ module Crowbar
             )
           end
 
+          #
+          # 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/backup/list.rb

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

@@ -18,11 +18,24 @@ module Crowbar
   module Client
     module Request
       module Backup
+        #
+        # Implementation for the backup restore request
+        #
         class Restore < 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/backup/upload.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Request
       module Backup
+        #
+        # Implementation for the backup upload request
+        #
         class Upload < Base
           def params
             {
@@ -28,10 +31,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/barclamp.rb

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

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

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

@@ -19,6 +19,9 @@ require "hashie"
 module Crowbar
   module Client
     module Request
+      #
+      # Base that provides methods shared between request implementations
+      #
       class Base
         attr_accessor :request
         attr_accessor :attrs
@@ -59,17 +62,9 @@ module Crowbar
             params
           )
 
-          case result.code
-          when 500
-            raise InternalServerError,
-              "An internal error occured"
-          when 401
-            raise NotAuthorizedError,
-              "User is not authorized"
-          when 403
-            raise NotAuthorizedError,
-              "User access is forbidden"
-          end
+          send(
+            errors[result.code]
+          ) if errors[result.code]
 
           if block_given?
             yield result
@@ -77,6 +72,42 @@ module Crowbar
             result
           end
         end
+
+        def errors
+          {
+            401 => :not_authorized,
+            403 => :not_authorized,
+            500 => :internal_server,
+            502 => :bad_gateway,
+            503 => :service_unavailable,
+            504 => :gateway_timeout
+          }
+        end
+
+        def not_authorized
+          raise NotAuthorizedError,
+            "User is not authorized"
+        end
+
+        def internal_server
+          raise InternalServerError,
+            "An internal error occured"
+        end
+
+        def bad_gateway
+          raise BadGatewayError,
+            "Received a bad gateway error"
+        end
+
+        def service_unavailable
+          raise ServiceUnavailableError,
+            "Service is not available"
+        end
+
+        def gateway_timeout
+          raise GatewayTimeoutError,
+            "Received a gateway timeout"
+        end
       end
     end
   end